Merge branch 'master' of git://git.samba.org/samba
[samba.git] / source3 / winbindd / winbindd.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Winbind daemon for ntdom nss module
5
6    Copyright (C) Tim Potter 2000
7    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
8
9    This library is free software; you can redistribute it and/or
10    modify it under the terms of the GNU Lesser General Public
11    License as published by the Free Software Foundation; either
12    version 3 of the License, or (at your option) any later version.
13
14    This library is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17    Library General Public License for more details.
18
19    You should have received a copy of the GNU Lesser General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef _WINBINDD_H
24 #define _WINBINDD_H
25
26 #include "nsswitch/winbind_struct_protocol.h"
27 #include "nsswitch/libwbclient/wbclient.h"
28 #include "librpc/gen_ndr/wbint.h"
29
30 #ifdef HAVE_LIBNSCD
31 #include <libnscd.h>
32 #endif
33
34 #ifdef HAVE_SYS_MMAN_H
35 #include <sys/mman.h>
36 #endif
37
38 #undef DBGC_CLASS
39 #define DBGC_CLASS DBGC_WINBIND
40
41 #define WB_REPLACE_CHAR         '_'
42
43 struct sid_ctr {
44         DOM_SID *sid;
45         bool finished;
46         const char *domain;
47         const char *name;
48         enum lsa_SidType type;
49 };
50
51 struct winbindd_cli_state {
52         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
53         int sock;                                 /* Open socket from client */
54         pid_t pid;                                /* pid of client */
55         time_t last_access;                       /* Time of last access (read or write) */
56         bool privileged;                           /* Is the client 'privileged' */
57
58         TALLOC_CTX *mem_ctx;                      /* memory per request */
59         NTSTATUS (*recv_fn)(struct tevent_req *req,
60                             struct winbindd_response *presp);
61         struct winbindd_request *request;         /* Request from client */
62         struct tevent_queue *out_queue;
63         struct winbindd_response *response;        /* Respose to client */
64         bool getpwent_initialized;                /* Has getpwent_state been
65                                                    * initialized? */
66         bool getgrent_initialized;                /* Has getgrent_state been
67                                                    * initialized? */
68
69         struct getpwent_state *pwent_state; /* State for getpwent() */
70         struct getgrent_state *grent_state; /* State for getgrent() */
71 };
72
73 struct getpwent_state {
74         struct winbindd_domain *domain;
75         int next_user;
76         int num_users;
77         struct wbint_userinfo *users;
78 };
79
80 struct getgrent_state {
81         struct winbindd_domain *domain;
82         int next_group;
83         int num_groups;
84         struct wbint_Principal *groups;
85 };
86
87 /* Storage for cached getpwent() user entries */
88
89 struct getpwent_user {
90         fstring name;                        /* Account name */
91         fstring gecos;                       /* User information */
92         fstring homedir;                     /* User Home Directory */
93         fstring shell;                       /* User Login Shell */
94         DOM_SID user_sid;                    /* NT user and primary group SIDs */
95         DOM_SID group_sid;
96 };
97
98 /* Our connection to the DC */
99
100 struct winbindd_cm_conn {
101         struct cli_state *cli;
102
103         struct rpc_pipe_client *samr_pipe;
104         struct policy_handle sam_connect_handle, sam_domain_handle;
105
106         struct rpc_pipe_client *lsa_pipe;
107         struct rpc_pipe_client *lsa_pipe_tcp;
108         struct policy_handle lsa_policy;
109
110         struct rpc_pipe_client *netlogon_pipe;
111 };
112
113 /* Async child */
114
115 struct winbindd_domain;
116
117 struct winbindd_child_dispatch_table {
118         const char *name;
119         enum winbindd_cmd struct_cmd;
120         enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
121                                           struct winbindd_cli_state *state);
122 };
123
124 struct winbindd_child {
125         struct winbindd_child *next, *prev;
126
127         pid_t pid;
128         struct winbindd_domain *domain;
129         char *logfilename;
130
131         int sock;
132         struct tevent_queue *queue;
133         struct rpc_pipe_client *rpccli;
134
135         struct timed_event *lockout_policy_event;
136         struct timed_event *machine_password_change_event;
137
138         const struct winbindd_child_dispatch_table *table;
139 };
140
141 /* Structures to hold per domain information */
142
143 struct winbindd_domain {
144         fstring name;                          /* Domain name (NetBIOS) */
145         fstring alt_name;                      /* alt Domain name, if any (FQDN for ADS) */
146         fstring forest_name;                   /* Name of the AD forest we're in */
147         DOM_SID sid;                           /* SID for this domain */
148         uint32 domain_flags;                   /* Domain flags from netlogon.h */
149         uint32 domain_type;                    /* Domain type from netlogon.h */
150         uint32 domain_trust_attribs;           /* Trust attribs from netlogon.h */
151         bool initialized;                      /* Did we already ask for the domain mode? */
152         bool native_mode;                      /* is this a win2k domain in native mode ? */
153         bool active_directory;                 /* is this a win2k active directory ? */
154         bool primary;                          /* is this our primary domain ? */
155         bool internal;                         /* BUILTIN and member SAM */
156         bool online;                           /* is this domain available ? */
157         time_t startup_time;                   /* When we set "startup" true. */
158         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
159
160         bool can_do_samlogon_ex; /* Due to the lack of finer control what type
161                                   * of DC we have, let us try to do a
162                                   * credential-chain less samlogon_ex call
163                                   * with AD and schannel. If this fails with
164                                   * DCERPC_FAULT_OP_RNG_ERROR, then set this
165                                   * to False. This variable is around so that
166                                   * we don't have to try _ex every time. */
167
168         bool can_do_ncacn_ip_tcp;
169
170         /* Lookup methods for this domain (LDAP or RPC) */
171         struct winbindd_methods *methods;
172
173         /* the backend methods are used by the cache layer to find the right
174            backend */
175         struct winbindd_methods *backend;
176
177         /* Private data for the backends (used for connection cache) */
178
179         void *private_data;
180
181         /*
182          * idmap config settings, used to tell the idmap child which
183          * special domain config to use for a mapping
184          */
185         bool have_idmap_config;
186         uint32_t id_range_low, id_range_high;
187
188         /* A working DC */
189         pid_t dc_probe_pid; /* Child we're using to detect the DC. */
190         fstring dcname;
191         struct sockaddr_storage dcaddr;
192
193         /* Sequence number stuff */
194
195         time_t last_seq_check;
196         uint32 sequence_number;
197         NTSTATUS last_status;
198
199         /* The smb connection */
200
201         struct winbindd_cm_conn conn;
202
203         /* The child pid we're talking to */
204
205         struct winbindd_child child;
206
207         /* Callback we use to try put us back online. */
208
209         uint32 check_online_timeout;
210         struct timed_event *check_online_event;
211
212         /* Linked list info */
213
214         struct winbindd_domain *prev, *next;
215 };
216
217 /* per-domain methods. This is how LDAP vs RPC is selected
218  */
219 struct winbindd_methods {
220         /* does this backend provide a consistent view of the data? (ie. is the primary group
221            always correct) */
222         bool consistent;
223
224         /* get a list of users, returning a wbint_userinfo for each one */
225         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
226                                    TALLOC_CTX *mem_ctx,
227                                    uint32 *num_entries, 
228                                    struct wbint_userinfo **info);
229
230         /* get a list of domain groups */
231         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
232                                     TALLOC_CTX *mem_ctx,
233                                     uint32 *num_entries, 
234                                     struct acct_info **info);
235
236         /* get a list of domain local groups */
237         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
238                                     TALLOC_CTX *mem_ctx,
239                                     uint32 *num_entries, 
240                                     struct acct_info **info);
241
242         /* convert one user or group name to a sid */
243         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
244                                 TALLOC_CTX *mem_ctx,
245                                 const char *domain_name,
246                                 const char *name,
247                                 uint32_t flags,
248                                 DOM_SID *sid,
249                                 enum lsa_SidType *type);
250
251         /* convert a sid to a user or group name */
252         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
253                                 TALLOC_CTX *mem_ctx,
254                                 const DOM_SID *sid,
255                                 char **domain_name,
256                                 char **name,
257                                 enum lsa_SidType *type);
258
259         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
260                                   TALLOC_CTX *mem_ctx,
261                                   const DOM_SID *domain_sid,
262                                   uint32 *rids,
263                                   size_t num_rids,
264                                   char **domain_name,
265                                   char ***names,
266                                   enum lsa_SidType **types);
267
268         /* lookup user info for a given SID */
269         NTSTATUS (*query_user)(struct winbindd_domain *domain, 
270                                TALLOC_CTX *mem_ctx, 
271                                const DOM_SID *user_sid,
272                                struct wbint_userinfo *user_info);
273
274         /* lookup all groups that a user is a member of. The backend
275            can also choose to lookup by username or rid for this
276            function */
277         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
278                                       TALLOC_CTX *mem_ctx,
279                                       const DOM_SID *user_sid,
280                                       uint32 *num_groups, DOM_SID **user_gids);
281
282         /* Lookup all aliases that the sids delivered are member of. This is
283          * to implement 'domain local groups' correctly */
284         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
285                                        TALLOC_CTX *mem_ctx,
286                                        uint32 num_sids,
287                                        const DOM_SID *sids,
288                                        uint32 *num_aliases,
289                                        uint32 **alias_rids);
290
291         /* find all members of the group with the specified group_rid */
292         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
293                                     TALLOC_CTX *mem_ctx,
294                                     const DOM_SID *group_sid,
295                                     enum lsa_SidType type,
296                                     uint32 *num_names, 
297                                     DOM_SID **sid_mem, char ***names, 
298                                     uint32 **name_types);
299
300         /* return the current global sequence number */
301         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
302
303         /* return the lockout policy */
304         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
305                                    TALLOC_CTX *mem_ctx,
306                                    struct samr_DomInfo12 *lockout_policy);
307
308         /* return the lockout policy */
309         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
310                                     TALLOC_CTX *mem_ctx,
311                                     struct samr_DomInfo1 *password_policy);
312
313         /* enumerate trusted domains */
314         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
315                                     TALLOC_CTX *mem_ctx,
316                                     struct netr_DomainTrustList *trusts);
317 };
318
319 /* Filled out by IDMAP backends */
320 struct winbindd_idmap_methods {
321   /* Called when backend is first loaded */
322   bool (*init)(void);
323
324   bool (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
325   bool (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
326
327   bool (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
328   bool (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
329
330   /* Called when backend is unloaded */
331   bool (*close)(void);
332   /* Called to dump backend status */
333   void (*status)(void);
334 };
335
336 /* Data structures for dealing with the trusted domain cache */
337
338 struct winbindd_tdc_domain {
339         const char *domain_name;
340         const char *dns_name;
341         DOM_SID sid;
342         uint32 trust_flags;
343         uint32 trust_attribs;
344         uint32 trust_type;
345 };
346
347 /* Switch for listing users or groups */
348 enum ent_type {
349         LIST_USERS = 0,
350         LIST_GROUPS,
351 };
352
353 struct WINBINDD_MEMORY_CREDS {
354         struct WINBINDD_MEMORY_CREDS *next, *prev;
355         const char *username; /* lookup key. */
356         uid_t uid;
357         int ref_count;
358         size_t len;
359         uint8_t *nt_hash; /* Base pointer for the following 2 */
360         uint8_t *lm_hash;
361         char *pass;
362 };
363
364 struct WINBINDD_CCACHE_ENTRY {
365         struct WINBINDD_CCACHE_ENTRY *next, *prev;
366         const char *principal_name;
367         const char *ccname;
368         const char *service;
369         const char *username;
370         const char *realm;
371         struct WINBINDD_MEMORY_CREDS *cred_ptr;
372         int ref_count;
373         uid_t uid;
374         time_t create_time;
375         time_t renew_until;
376         time_t refresh_time;
377         struct timed_event *event;
378 };
379
380 #include "winbindd/winbindd_proto.h"
381
382 #define WINBINDD_ESTABLISH_LOOP 30
383 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
384 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
385 #define DOM_SEQUENCE_NONE ((uint32)-1)
386
387 #endif /* _WINBINDD_H */