winbind: Use one queue for all domain children
[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 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         struct tevent_req *io_req; /* wb_req_read_* or wb_resp_write_* */
69
70         struct getpwent_state *pwent_state; /* State for getpwent() */
71         struct getgrent_state *grent_state; /* State for getgrent() */
72 };
73
74 struct getpwent_state {
75         struct winbindd_domain *domain;
76         uint32_t next_user;
77         struct wbint_RidArray rids;
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 /* Our connection to the DC */
88
89 struct winbindd_cm_conn {
90         struct cli_state *cli;
91
92         enum dcerpc_AuthLevel auth_level;
93
94         struct rpc_pipe_client *samr_pipe;
95         struct policy_handle sam_connect_handle, sam_domain_handle;
96
97         struct rpc_pipe_client *lsa_pipe;
98         struct rpc_pipe_client *lsa_pipe_tcp;
99         struct policy_handle lsa_policy;
100
101         struct rpc_pipe_client *netlogon_pipe;
102         struct netlogon_creds_cli_context *netlogon_creds_ctx;
103         bool netlogon_force_reauth;
104 };
105
106 /* Async child */
107
108 struct winbindd_domain;
109
110 struct winbindd_child_dispatch_table {
111         const char *name;
112         enum winbindd_cmd struct_cmd;
113         enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
114                                           struct winbindd_cli_state *state);
115 };
116
117 struct winbindd_child {
118         struct winbindd_child *next, *prev;
119
120         pid_t pid;
121         struct winbindd_domain *domain;
122         char *logfilename;
123
124         int sock;
125         struct tevent_queue *queue;
126         struct dcerpc_binding_handle *binding_handle;
127
128         struct tevent_timer *lockout_policy_event;
129         struct tevent_timer *machine_password_change_event;
130
131         const struct winbindd_child_dispatch_table *table;
132 };
133
134 /* Structures to hold per domain information */
135
136 struct winbindd_domain {
137         char *name;                            /* Domain name (NetBIOS) */
138         char *alt_name;                        /* alt Domain name, if any (FQDN for ADS) */
139         char *forest_name;                     /* Name of the AD forest we're in */
140         struct dom_sid sid;                           /* SID for this domain */
141         enum netr_SchannelType secure_channel_type;
142         uint32_t domain_flags;                   /* Domain flags from netlogon.h */
143         uint32_t domain_type;                    /* Domain type from netlogon.h */
144         uint32_t domain_trust_attribs;           /* Trust attribs from netlogon.h */
145         struct winbindd_domain *routing_domain;
146         bool initialized;                      /* Did we already ask for the domain mode? */
147         bool native_mode;                      /* is this a win2k domain in native mode ? */
148         bool active_directory;                 /* is this a win2k active directory ? */
149         bool primary;                          /* is this our primary domain ? */
150         bool internal;                         /* BUILTIN and member SAM */
151         bool rodc;                             /* Are we an RODC for this AD domain? (do some operations locally) */
152         bool online;                           /* is this domain available ? */
153         time_t startup_time;                   /* When we set "startup" true. monotonic clock */
154         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
155
156         bool can_do_ncacn_ip_tcp;
157
158         /*
159          * Lookup methods for this domain (LDAP or RPC). The backend
160          * methods are used by the cache layer.
161          */
162         struct winbindd_methods *backend;
163
164         /* Private data for the backends (used for connection cache) */
165
166         void *private_data;
167
168         /* A working DC */
169         pid_t dc_probe_pid; /* Child we're using to detect the DC. */
170         char *dcname;
171         struct sockaddr_storage dcaddr;
172
173         /* Sequence number stuff */
174
175         time_t last_seq_check;
176         uint32_t sequence_number;
177         NTSTATUS last_status;
178
179         /* The smb connection */
180
181         struct winbindd_cm_conn conn;
182
183         /* The child pid we're talking to */
184
185         struct winbindd_child *children;
186
187         struct tevent_queue *queue;
188         struct dcerpc_binding_handle *binding_handle;
189
190         /* Callback we use to try put us back online. */
191
192         uint32_t check_online_timeout;
193         struct tevent_timer *check_online_event;
194
195         /* Linked list info */
196
197         struct winbindd_domain *prev, *next;
198 };
199
200 struct wb_acct_info {
201         fstring acct_name; /* account name */
202         fstring acct_desc; /* account name */
203         uint32_t rid; /* domain-relative RID */
204 };
205
206 /* per-domain methods. This is how LDAP vs RPC is selected
207  */
208 struct winbindd_methods {
209         /* does this backend provide a consistent view of the data? (ie. is the primary group
210            always correct) */
211         bool consistent;
212
213         /* get a list of users, returning a wbint_userinfo for each one */
214         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
215                                    TALLOC_CTX *mem_ctx,
216                                    uint32_t **rids);
217
218         /* get a list of domain groups */
219         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
220                                     TALLOC_CTX *mem_ctx,
221                                     uint32_t *num_entries,
222                                     struct wb_acct_info **info);
223
224         /* get a list of domain local groups */
225         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
226                                     TALLOC_CTX *mem_ctx,
227                                     uint32_t *num_entries,
228                                     struct wb_acct_info **info);
229
230         /* convert one user or group name to a sid */
231         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
232                                 TALLOC_CTX *mem_ctx,
233                                 const char *domain_name,
234                                 const char *name,
235                                 uint32_t flags,
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         /* return the current global sequence number */
283         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32_t *seq);
284
285         /* return the lockout policy */
286         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
287                                    TALLOC_CTX *mem_ctx,
288                                    struct samr_DomInfo12 *lockout_policy);
289
290         /* return the lockout policy */
291         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
292                                     TALLOC_CTX *mem_ctx,
293                                     struct samr_DomInfo1 *password_policy);
294
295         /* enumerate trusted domains */
296         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
297                                     TALLOC_CTX *mem_ctx,
298                                     struct netr_DomainTrustList *trusts);
299 };
300
301 /* Filled out by IDMAP backends */
302 struct winbindd_idmap_methods {
303   /* Called when backend is first loaded */
304   bool (*init)(void);
305
306   bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
307   bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
308
309   bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
310   bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
311
312   /* Called when backend is unloaded */
313   bool (*close)(void);
314   /* Called to dump backend status */
315   void (*status)(void);
316 };
317
318 /* Data structures for dealing with the trusted domain cache */
319
320 struct winbindd_tdc_domain {
321         const char *domain_name;
322         const char *dns_name;
323         struct dom_sid sid;
324         uint32_t trust_flags;
325         uint32_t trust_attribs;
326         uint32_t trust_type;
327 };
328
329 struct WINBINDD_MEMORY_CREDS {
330         struct WINBINDD_MEMORY_CREDS *next, *prev;
331         const char *username; /* lookup key. */
332         uid_t uid;
333         int ref_count;
334         size_t len;
335         uint8_t *nt_hash; /* Base pointer for the following 2 */
336         uint8_t *lm_hash;
337         char *pass;
338 };
339
340 struct WINBINDD_CCACHE_ENTRY {
341         struct WINBINDD_CCACHE_ENTRY *next, *prev;
342         const char *principal_name;
343         const char *ccname;
344         const char *service;
345         const char *username;
346         const char *realm;
347         struct WINBINDD_MEMORY_CREDS *cred_ptr;
348         int ref_count;
349         uid_t uid;
350         time_t create_time;
351         time_t renew_until;
352         time_t refresh_time;
353         struct tevent_timer *event;
354 };
355
356 #include "winbindd/winbindd_proto.h"
357
358 #define WINBINDD_ESTABLISH_LOOP 30
359 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
360 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
361 #define DOM_SEQUENCE_NONE ((uint32_t)-1)
362
363 #endif /* _WINBINDD_H */