s3:libsmb: allow store_cldap_reply() to work with a ipv6 response
[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/dcerpc.h"
29 #include "librpc/gen_ndr/winbind.h"
30
31 #include "../lib/util/tevent_ntstatus.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 winbind_internal_pipes;
47 struct ads_struct;
48
49 struct winbindd_cli_state {
50         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
51         int sock;                                 /* Open socket from client */
52         pid_t pid;                                /* pid of client */
53         char client_name[32];                     /* The process name of the client */
54         time_t last_access;                       /* Time of last access (read or write) */
55         bool privileged;                           /* Is the client 'privileged' */
56
57         TALLOC_CTX *mem_ctx;                      /* memory per request */
58         const char *cmd_name;
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;        /* Response to client */
64         struct tevent_req *io_req; /* wb_req_read_* or wb_resp_write_* */
65
66         struct getpwent_state *pwent_state; /* State for getpwent() */
67         struct getgrent_state *grent_state; /* State for getgrent() */
68 };
69
70 struct getpwent_state {
71         struct winbindd_domain *domain;
72         uint32_t next_user;
73         struct wbint_RidArray rids;
74 };
75
76 struct getgrent_state {
77         struct winbindd_domain *domain;
78         uint32_t next_group;
79         uint32_t num_groups;
80         struct wbint_Principal *groups;
81 };
82
83 /* Our connection to the DC */
84
85 struct winbindd_cm_conn {
86         struct cli_state *cli;
87
88         enum dcerpc_AuthLevel auth_level;
89
90         struct rpc_pipe_client *samr_pipe;
91         struct policy_handle sam_connect_handle, sam_domain_handle;
92
93         struct rpc_pipe_client *lsa_pipe;
94         struct rpc_pipe_client *lsa_pipe_tcp;
95         struct policy_handle lsa_policy;
96
97         struct rpc_pipe_client *netlogon_pipe;
98         struct netlogon_creds_cli_context *netlogon_creds_ctx;
99         bool netlogon_force_reauth;
100 };
101
102 /* Async child */
103
104 struct winbindd_domain;
105
106 struct winbindd_child {
107         pid_t pid;
108         struct winbindd_domain *domain;
109         char *logfilename;
110
111         int sock;
112         struct tevent_fd *monitor_fde; /* Watch for dead children/sockets */
113         struct tevent_queue *queue;
114         struct dcerpc_binding_handle *binding_handle;
115
116         struct tevent_timer *lockout_policy_event;
117         struct tevent_timer *machine_password_change_event;
118 };
119
120 /* Structures to hold per domain information */
121
122 struct winbindd_domain {
123         char *name;                            /* Domain name (NetBIOS) */
124         char *alt_name;                        /* alt Domain name, if any (FQDN for ADS) */
125         char *forest_name;                     /* Name of the AD forest we're in */
126         struct dom_sid sid;                           /* SID for this domain */
127         enum netr_SchannelType secure_channel_type;
128         uint32_t domain_flags;                   /* Domain flags from netlogon.h */
129         uint32_t domain_type;                    /* Domain type from netlogon.h */
130         uint32_t domain_trust_attribs;           /* Trust attribs from netlogon.h */
131         struct winbindd_domain *routing_domain;
132         bool initialized;                      /* Did we already ask for the domain mode? */
133         bool native_mode;                      /* is this a win2k domain in native mode ? */
134         bool active_directory;                 /* is this a win2k active directory ? */
135         bool primary;                          /* is this our primary domain ? */
136         bool internal;                         /* BUILTIN and member SAM */
137         bool rodc;                             /* Are we an RODC for this AD domain? (do some operations locally) */
138         bool online;                           /* is this domain available ? */
139         time_t startup_time;                   /* When we set "startup" true. monotonic clock */
140         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
141
142         bool can_do_ncacn_ip_tcp;
143
144         /*
145          * Lookup methods for this domain (LDAP or RPC). The backend
146          * methods are used by the cache layer.
147          */
148         struct winbindd_methods *backend;
149
150         struct {
151                 struct winbind_internal_pipes *samr_pipes;
152                 struct ads_struct *ads_conn;
153         } backend_data;
154
155         /* A working DC */
156         bool force_dc;
157         char *dcname;
158         const char *ping_dcname;
159         struct sockaddr_storage dcaddr;
160
161         /* Sequence number stuff */
162
163         time_t last_seq_check;
164         uint32_t sequence_number;
165         NTSTATUS last_status;
166
167         /* The smb connection */
168
169         struct winbindd_cm_conn conn;
170
171         /* The child pid we're talking to */
172
173         struct winbindd_child *children;
174
175         struct tevent_queue *queue;
176         struct dcerpc_binding_handle *binding_handle;
177
178         struct tevent_req *check_online_event;
179
180         /* Linked list info */
181
182         struct winbindd_domain *prev, *next;
183 };
184
185 struct wb_parent_idmap_config_dom {
186         unsigned low_id;
187         unsigned high_id;
188         const char *name;
189         struct dom_sid sid;
190 };
191
192 struct wb_parent_idmap_config {
193         struct tevent_queue *queue;
194         uint32_t num_doms;
195         bool initialized;
196         struct wb_parent_idmap_config_dom *doms;
197 };
198
199 struct wb_acct_info {
200         const char *acct_name; /* account name */
201         const char *acct_desc; /* account name */
202         uint32_t rid; /* domain-relative RID */
203 };
204
205 /* per-domain methods. This is how LDAP vs RPC is selected
206  */
207 struct winbindd_methods {
208         /* does this backend provide a consistent view of the data? (ie. is the primary group
209            always correct) */
210         bool consistent;
211
212         /* get a list of users, returning a wbint_userinfo for each one */
213         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
214                                    TALLOC_CTX *mem_ctx,
215                                    uint32_t **rids);
216
217         /* get a list of domain groups */
218         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
219                                     TALLOC_CTX *mem_ctx,
220                                     uint32_t *num_entries,
221                                     struct wb_acct_info **info);
222
223         /* get a list of domain local groups */
224         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
225                                     TALLOC_CTX *mem_ctx,
226                                     uint32_t *num_entries,
227                                     struct wb_acct_info **info);
228
229         /* convert one user or group name to a sid */
230         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
231                                 TALLOC_CTX *mem_ctx,
232                                 const char *domain_name,
233                                 const char *name,
234                                 uint32_t flags,
235                                 const char **pdom_name,
236                                 struct dom_sid *sid,
237                                 enum lsa_SidType *type);
238
239         /* convert a sid to a user or group name */
240         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
241                                 TALLOC_CTX *mem_ctx,
242                                 const struct dom_sid *sid,
243                                 char **domain_name,
244                                 char **name,
245                                 enum lsa_SidType *type);
246
247         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
248                                   TALLOC_CTX *mem_ctx,
249                                   const struct dom_sid *domain_sid,
250                                   uint32_t *rids,
251                                   size_t num_rids,
252                                   char **domain_name,
253                                   char ***names,
254                                   enum lsa_SidType **types);
255
256         /* lookup all groups that a user is a member of. The backend
257            can also choose to lookup by username or rid for this
258            function */
259         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
260                                       TALLOC_CTX *mem_ctx,
261                                       const struct dom_sid *user_sid,
262                                       uint32_t *num_groups, struct dom_sid **user_gids);
263
264         /* Lookup all aliases that the sids delivered are member of. This is
265          * to implement 'domain local groups' correctly */
266         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
267                                        TALLOC_CTX *mem_ctx,
268                                        uint32_t num_sids,
269                                        const struct dom_sid *sids,
270                                        uint32_t *num_aliases,
271                                        uint32_t **alias_rids);
272
273         /* find all members of the group with the specified group_rid */
274         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
275                                     TALLOC_CTX *mem_ctx,
276                                     const struct dom_sid *group_sid,
277                                     enum lsa_SidType type,
278                                     uint32_t *num_names,
279                                     struct dom_sid **sid_mem, char ***names,
280                                     uint32_t **name_types);
281
282         /* find all members of the alias with the specified alias_sid */
283         NTSTATUS (*lookup_aliasmem)(struct winbindd_domain *domain,
284                                     TALLOC_CTX *mem_ctx,
285                                     const struct dom_sid *alias_sid,
286                                     enum lsa_SidType type,
287                                     uint32_t *num_sids,
288                                     struct dom_sid **sid_mem);
289
290         /* return the lockout policy */
291         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
292                                    TALLOC_CTX *mem_ctx,
293                                    struct samr_DomInfo12 *lockout_policy);
294
295         /* return the lockout policy */
296         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
297                                     TALLOC_CTX *mem_ctx,
298                                     struct samr_DomInfo1 *password_policy);
299
300         /* enumerate trusted domains */
301         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
302                                     TALLOC_CTX *mem_ctx,
303                                     struct netr_DomainTrustList *trusts);
304 };
305
306 /* Filled out by IDMAP backends */
307 struct winbindd_idmap_methods {
308   /* Called when backend is first loaded */
309   bool (*init)(void);
310
311   bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
312   bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
313
314   bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
315   bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
316
317   /* Called when backend is unloaded */
318   bool (*close)(void);
319   /* Called to dump backend status */
320   void (*status)(void);
321 };
322
323 /* Data structures for dealing with the trusted domain cache */
324
325 struct winbindd_tdc_domain {
326         const char *domain_name;
327         const char *dns_name;
328         struct dom_sid sid;
329         uint32_t trust_flags;
330         uint32_t trust_attribs;
331         uint32_t trust_type;
332 };
333
334 struct WINBINDD_MEMORY_CREDS {
335         struct WINBINDD_MEMORY_CREDS *next, *prev;
336         const char *username; /* lookup key. */
337         uid_t uid;
338         int ref_count;
339         size_t len;
340         uint8_t *nt_hash; /* Base pointer for the following 2 */
341         uint8_t *lm_hash;
342         char *pass;
343 };
344
345 struct WINBINDD_CCACHE_ENTRY {
346         struct WINBINDD_CCACHE_ENTRY *next, *prev;
347         const char *principal_name;
348         const char *ccname;
349         const char *service;
350         const char *username;
351         const char *realm;
352         const char *canon_principal;
353         const char *canon_realm;
354         struct WINBINDD_MEMORY_CREDS *cred_ptr;
355         int ref_count;
356         uid_t uid;
357         time_t create_time;
358         time_t renew_until;
359         time_t refresh_time;
360         struct tevent_timer *event;
361 };
362
363 #include "winbindd/winbindd_proto.h"
364
365 #define WINBINDD_ESTABLISH_LOOP 30
366 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
367 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
368 #define DOM_SEQUENCE_NONE ((uint32_t)-1)
369
370 #endif /* _WINBINDD_H */