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