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