s3:winbindd: make use of the "winbind sealed pipes" option for all connections
[Samba.git] / source3 / winbindd / winbindd.h
blobafde6857f0a5b8d98bb6b5a7c520024161e3e617
1 /*
2 Unix SMB/CIFS implementation.
4 Winbind daemon for ntdom nss module
6 Copyright (C) Tim Potter 2000
7 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
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.
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.
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/>.
23 #ifndef _WINBINDD_H
24 #define _WINBINDD_H
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/wbint.h"
31 #include "talloc_dict.h"
33 #include "../lib/util/tevent_ntstatus.h"
35 #ifdef HAVE_LIBNSCD
36 #include <libnscd.h>
37 #endif
39 #ifdef HAVE_SYS_MMAN_H
40 #include <sys/mman.h>
41 #endif
43 #undef DBGC_CLASS
44 #define DBGC_CLASS DBGC_WINBIND
46 #define WB_REPLACE_CHAR '_'
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;
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' */
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 bool getpwent_initialized; /* Has getpwent_state been
71 * initialized? */
72 bool getgrent_initialized; /* Has getgrent_state been
73 * initialized? */
75 struct getpwent_state *pwent_state; /* State for getpwent() */
76 struct getgrent_state *grent_state; /* State for getgrent() */
79 struct getpwent_state {
80 struct winbindd_domain *domain;
81 int next_user;
82 int num_users;
83 struct wbint_userinfo *users;
86 struct getgrent_state {
87 struct winbindd_domain *domain;
88 int next_group;
89 int num_groups;
90 struct wbint_Principal *groups;
93 /* Storage for cached getpwent() user entries */
95 struct getpwent_user {
96 fstring name; /* Account name */
97 fstring gecos; /* User information */
98 fstring homedir; /* User Home Directory */
99 fstring shell; /* User Login Shell */
100 struct dom_sid user_sid; /* NT user and primary group SIDs */
101 struct dom_sid group_sid;
104 /* Our connection to the DC */
106 struct winbindd_cm_conn {
107 struct cli_state *cli;
109 enum dcerpc_AuthLevel auth_level;
111 struct rpc_pipe_client *samr_pipe;
112 struct policy_handle sam_connect_handle, sam_domain_handle;
114 struct rpc_pipe_client *lsa_pipe;
115 struct rpc_pipe_client *lsa_pipe_tcp;
116 struct policy_handle lsa_policy;
118 struct rpc_pipe_client *netlogon_pipe;
121 /* Async child */
123 struct winbindd_domain;
125 struct winbindd_child_dispatch_table {
126 const char *name;
127 enum winbindd_cmd struct_cmd;
128 enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
129 struct winbindd_cli_state *state);
132 struct winbindd_child {
133 struct winbindd_child *next, *prev;
135 pid_t pid;
136 struct winbindd_domain *domain;
137 char *logfilename;
139 int sock;
140 struct tevent_queue *queue;
141 struct dcerpc_binding_handle *binding_handle;
143 struct tevent_timer *lockout_policy_event;
144 struct tevent_timer *machine_password_change_event;
146 const struct winbindd_child_dispatch_table *table;
149 /* Structures to hold per domain information */
151 struct winbindd_domain {
152 char *name; /* Domain name (NetBIOS) */
153 char *alt_name; /* alt Domain name, if any (FQDN for ADS) */
154 char *forest_name; /* Name of the AD forest we're in */
155 struct dom_sid sid; /* SID for this domain */
156 uint32 domain_flags; /* Domain flags from netlogon.h */
157 uint32 domain_type; /* Domain type from netlogon.h */
158 uint32 domain_trust_attribs; /* Trust attribs from netlogon.h */
159 bool initialized; /* Did we already ask for the domain mode? */
160 bool native_mode; /* is this a win2k domain in native mode ? */
161 bool active_directory; /* is this a win2k active directory ? */
162 bool primary; /* is this our primary domain ? */
163 bool internal; /* BUILTIN and member SAM */
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 ? */
168 bool can_do_samlogon_ex; /* Due to the lack of finer control what type
169 * of DC we have, let us try to do a
170 * credential-chain less samlogon_ex call
171 * with AD and schannel. If this fails with
172 * DCERPC_FAULT_OP_RNG_ERROR, then set this
173 * to False. This variable is around so that
174 * we don't have to try _ex every time. */
176 bool can_do_ncacn_ip_tcp;
177 bool can_do_validation6;
179 /* Lookup methods for this domain (LDAP or RPC) */
180 struct winbindd_methods *methods;
182 /* the backend methods are used by the cache layer to find the right
183 backend */
184 struct winbindd_methods *backend;
186 /* Private data for the backends (used for connection cache) */
188 void *private_data;
191 * idmap config settings, used to tell the idmap child which
192 * special domain config to use for a mapping
194 bool have_idmap_config;
195 uint32_t id_range_low, id_range_high;
197 /* A working DC */
198 pid_t dc_probe_pid; /* Child we're using to detect the DC. */
199 char *dcname;
200 struct sockaddr_storage dcaddr;
202 /* Sequence number stuff */
204 time_t last_seq_check;
205 uint32 sequence_number;
206 NTSTATUS last_status;
208 /* The smb connection */
210 struct winbindd_cm_conn conn;
212 /* The child pid we're talking to */
214 struct winbindd_child *children;
216 /* Callback we use to try put us back online. */
218 uint32 check_online_timeout;
219 struct tevent_timer *check_online_event;
221 /* Linked list info */
223 struct winbindd_domain *prev, *next;
226 struct wb_acct_info {
227 fstring acct_name; /* account name */
228 fstring acct_desc; /* account name */
229 uint32_t rid; /* domain-relative RID */
232 /* per-domain methods. This is how LDAP vs RPC is selected
234 struct winbindd_methods {
235 /* does this backend provide a consistent view of the data? (ie. is the primary group
236 always correct) */
237 bool consistent;
239 /* get a list of users, returning a wbint_userinfo for each one */
240 NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
241 TALLOC_CTX *mem_ctx,
242 uint32 *num_entries,
243 struct wbint_userinfo **info);
245 /* get a list of domain groups */
246 NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
247 TALLOC_CTX *mem_ctx,
248 uint32 *num_entries,
249 struct wb_acct_info **info);
251 /* get a list of domain local groups */
252 NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
253 TALLOC_CTX *mem_ctx,
254 uint32 *num_entries,
255 struct wb_acct_info **info);
257 /* convert one user or group name to a sid */
258 NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
259 TALLOC_CTX *mem_ctx,
260 const char *domain_name,
261 const char *name,
262 uint32_t flags,
263 struct dom_sid *sid,
264 enum lsa_SidType *type);
266 /* convert a sid to a user or group name */
267 NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
268 TALLOC_CTX *mem_ctx,
269 const struct dom_sid *sid,
270 char **domain_name,
271 char **name,
272 enum lsa_SidType *type);
274 NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
275 TALLOC_CTX *mem_ctx,
276 const struct dom_sid *domain_sid,
277 uint32 *rids,
278 size_t num_rids,
279 char **domain_name,
280 char ***names,
281 enum lsa_SidType **types);
283 /* lookup user info for a given SID */
284 NTSTATUS (*query_user)(struct winbindd_domain *domain,
285 TALLOC_CTX *mem_ctx,
286 const struct dom_sid *user_sid,
287 struct wbint_userinfo *user_info);
289 /* lookup all groups that a user is a member of. The backend
290 can also choose to lookup by username or rid for this
291 function */
292 NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
293 TALLOC_CTX *mem_ctx,
294 const struct dom_sid *user_sid,
295 uint32 *num_groups, struct dom_sid **user_gids);
297 /* Lookup all aliases that the sids delivered are member of. This is
298 * to implement 'domain local groups' correctly */
299 NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
300 TALLOC_CTX *mem_ctx,
301 uint32 num_sids,
302 const struct dom_sid *sids,
303 uint32 *num_aliases,
304 uint32 **alias_rids);
306 /* find all members of the group with the specified group_rid */
307 NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
308 TALLOC_CTX *mem_ctx,
309 const struct dom_sid *group_sid,
310 enum lsa_SidType type,
311 uint32 *num_names,
312 struct dom_sid **sid_mem, char ***names,
313 uint32 **name_types);
315 /* return the current global sequence number */
316 NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
318 /* return the lockout policy */
319 NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
320 TALLOC_CTX *mem_ctx,
321 struct samr_DomInfo12 *lockout_policy);
323 /* return the lockout policy */
324 NTSTATUS (*password_policy)(struct winbindd_domain *domain,
325 TALLOC_CTX *mem_ctx,
326 struct samr_DomInfo1 *password_policy);
328 /* enumerate trusted domains */
329 NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
330 TALLOC_CTX *mem_ctx,
331 struct netr_DomainTrustList *trusts);
334 /* Filled out by IDMAP backends */
335 struct winbindd_idmap_methods {
336 /* Called when backend is first loaded */
337 bool (*init)(void);
339 bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
340 bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
342 bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
343 bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
345 /* Called when backend is unloaded */
346 bool (*close)(void);
347 /* Called to dump backend status */
348 void (*status)(void);
351 /* Data structures for dealing with the trusted domain cache */
353 struct winbindd_tdc_domain {
354 const char *domain_name;
355 const char *dns_name;
356 struct dom_sid sid;
357 uint32 trust_flags;
358 uint32 trust_attribs;
359 uint32 trust_type;
362 /* Switch for listing users or groups */
363 enum ent_type {
364 LIST_USERS = 0,
365 LIST_GROUPS,
368 struct WINBINDD_MEMORY_CREDS {
369 struct WINBINDD_MEMORY_CREDS *next, *prev;
370 const char *username; /* lookup key. */
371 uid_t uid;
372 int ref_count;
373 size_t len;
374 uint8_t *nt_hash; /* Base pointer for the following 2 */
375 uint8_t *lm_hash;
376 char *pass;
379 struct WINBINDD_CCACHE_ENTRY {
380 struct WINBINDD_CCACHE_ENTRY *next, *prev;
381 const char *principal_name;
382 const char *ccname;
383 const char *service;
384 const char *username;
385 const char *realm;
386 struct WINBINDD_MEMORY_CREDS *cred_ptr;
387 int ref_count;
388 uid_t uid;
389 time_t create_time;
390 time_t renew_until;
391 time_t refresh_time;
392 struct tevent_timer *event;
395 #include "winbindd/winbindd_proto.h"
397 #define WINBINDD_ESTABLISH_LOOP 30
398 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
399 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
400 #define DOM_SEQUENCE_NONE ((uint32)-1)
402 #endif /* _WINBINDD_H */