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