s4-messaging: Add helpful comments
[Samba.git] / source3 / winbindd / winbindd.h
blob1c7e4e9326781511c77b68990df8a7e9e43d2606
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/winbind.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 struct tevent_req *io_req; /* wb_req_read_* or wb_resp_write_* */
72 struct getpwent_state *pwent_state; /* State for getpwent() */
73 struct getgrent_state *grent_state; /* State for getgrent() */
76 struct getpwent_state {
77 struct winbindd_domain *domain;
78 uint32_t next_user;
79 struct wbint_RidArray rids;
82 struct getgrent_state {
83 struct winbindd_domain *domain;
84 int next_group;
85 int num_groups;
86 struct wbint_Principal *groups;
89 /* Our connection to the DC */
91 struct winbindd_cm_conn {
92 struct cli_state *cli;
94 enum dcerpc_AuthLevel auth_level;
96 struct rpc_pipe_client *samr_pipe;
97 struct policy_handle sam_connect_handle, sam_domain_handle;
99 struct rpc_pipe_client *lsa_pipe;
100 struct rpc_pipe_client *lsa_pipe_tcp;
101 struct policy_handle lsa_policy;
103 struct rpc_pipe_client *netlogon_pipe;
104 struct netlogon_creds_cli_context *netlogon_creds;
105 uint32_t netlogon_flags;
106 bool netlogon_force_reauth;
109 /* Async child */
111 struct winbindd_domain;
113 struct winbindd_child_dispatch_table {
114 const char *name;
115 enum winbindd_cmd struct_cmd;
116 enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
117 struct winbindd_cli_state *state);
120 struct winbindd_child {
121 struct winbindd_child *next, *prev;
123 pid_t pid;
124 struct winbindd_domain *domain;
125 char *logfilename;
127 int sock;
128 struct tevent_queue *queue;
129 struct dcerpc_binding_handle *binding_handle;
131 struct tevent_timer *lockout_policy_event;
132 struct tevent_timer *machine_password_change_event;
134 const struct winbindd_child_dispatch_table *table;
137 /* Structures to hold per domain information */
139 struct winbindd_domain {
140 char *name; /* Domain name (NetBIOS) */
141 char *alt_name; /* alt Domain name, if any (FQDN for ADS) */
142 char *forest_name; /* Name of the AD forest we're in */
143 struct dom_sid sid; /* SID for this domain */
144 uint32_t domain_flags; /* Domain flags from netlogon.h */
145 uint32_t domain_type; /* Domain type from netlogon.h */
146 uint32_t domain_trust_attribs; /* Trust attribs from netlogon.h */
147 bool initialized; /* Did we already ask for the domain mode? */
148 bool native_mode; /* is this a win2k domain in native mode ? */
149 bool active_directory; /* is this a win2k active directory ? */
150 bool primary; /* is this our primary domain ? */
151 bool internal; /* BUILTIN and member SAM */
152 bool rodc; /* Are we an RODC for this AD domain? (do some operations locally) */
153 bool online; /* is this domain available ? */
154 time_t startup_time; /* When we set "startup" true. monotonic clock */
155 bool startup; /* are we in the first 30 seconds after startup_time ? */
157 bool can_do_ncacn_ip_tcp;
160 * Lookup methods for this domain (LDAP or RPC). The backend
161 * methods are used by the cache layer.
163 struct winbindd_methods *backend;
165 /* Private data for the backends (used for connection cache) */
167 void *private_data;
169 /* A working DC */
170 pid_t dc_probe_pid; /* Child we're using to detect the DC. */
171 char *dcname;
172 struct sockaddr_storage dcaddr;
174 /* Sequence number stuff */
176 time_t last_seq_check;
177 uint32_t sequence_number;
178 NTSTATUS last_status;
180 /* The smb connection */
182 struct winbindd_cm_conn conn;
184 /* The child pid we're talking to */
186 struct winbindd_child *children;
188 /* Callback we use to try put us back online. */
190 uint32_t check_online_timeout;
191 struct tevent_timer *check_online_event;
193 /* Linked list info */
195 struct winbindd_domain *prev, *next;
198 struct wb_acct_info {
199 fstring acct_name; /* account name */
200 fstring acct_desc; /* account name */
201 uint32_t rid; /* domain-relative RID */
204 /* per-domain methods. This is how LDAP vs RPC is selected
206 struct winbindd_methods {
207 /* does this backend provide a consistent view of the data? (ie. is the primary group
208 always correct) */
209 bool consistent;
211 /* get a list of users, returning a wbint_userinfo for each one */
212 NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
213 TALLOC_CTX *mem_ctx,
214 uint32_t **rids);
216 /* get a list of domain groups */
217 NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
218 TALLOC_CTX *mem_ctx,
219 uint32_t *num_entries,
220 struct wb_acct_info **info);
222 /* get a list of domain local groups */
223 NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
224 TALLOC_CTX *mem_ctx,
225 uint32_t *num_entries,
226 struct wb_acct_info **info);
228 /* convert one user or group name to a sid */
229 NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
230 TALLOC_CTX *mem_ctx,
231 const char *domain_name,
232 const char *name,
233 uint32_t flags,
234 struct dom_sid *sid,
235 enum lsa_SidType *type);
237 /* convert a sid to a user or group name */
238 NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
239 TALLOC_CTX *mem_ctx,
240 const struct dom_sid *sid,
241 char **domain_name,
242 char **name,
243 enum lsa_SidType *type);
245 NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
246 TALLOC_CTX *mem_ctx,
247 const struct dom_sid *domain_sid,
248 uint32_t *rids,
249 size_t num_rids,
250 char **domain_name,
251 char ***names,
252 enum lsa_SidType **types);
254 /* lookup all groups that a user is a member of. The backend
255 can also choose to lookup by username or rid for this
256 function */
257 NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
258 TALLOC_CTX *mem_ctx,
259 const struct dom_sid *user_sid,
260 uint32_t *num_groups, struct dom_sid **user_gids);
262 /* Lookup all aliases that the sids delivered are member of. This is
263 * to implement 'domain local groups' correctly */
264 NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
265 TALLOC_CTX *mem_ctx,
266 uint32_t num_sids,
267 const struct dom_sid *sids,
268 uint32_t *num_aliases,
269 uint32_t **alias_rids);
271 /* find all members of the group with the specified group_rid */
272 NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
273 TALLOC_CTX *mem_ctx,
274 const struct dom_sid *group_sid,
275 enum lsa_SidType type,
276 uint32_t *num_names,
277 struct dom_sid **sid_mem, char ***names,
278 uint32_t **name_types);
280 /* return the current global sequence number */
281 NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32_t *seq);
283 /* return the lockout policy */
284 NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
285 TALLOC_CTX *mem_ctx,
286 struct samr_DomInfo12 *lockout_policy);
288 /* return the lockout policy */
289 NTSTATUS (*password_policy)(struct winbindd_domain *domain,
290 TALLOC_CTX *mem_ctx,
291 struct samr_DomInfo1 *password_policy);
293 /* enumerate trusted domains */
294 NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
295 TALLOC_CTX *mem_ctx,
296 struct netr_DomainTrustList *trusts);
299 /* Filled out by IDMAP backends */
300 struct winbindd_idmap_methods {
301 /* Called when backend is first loaded */
302 bool (*init)(void);
304 bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
305 bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
307 bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
308 bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
310 /* Called when backend is unloaded */
311 bool (*close)(void);
312 /* Called to dump backend status */
313 void (*status)(void);
316 /* Data structures for dealing with the trusted domain cache */
318 struct winbindd_tdc_domain {
319 const char *domain_name;
320 const char *dns_name;
321 struct dom_sid sid;
322 uint32_t trust_flags;
323 uint32_t trust_attribs;
324 uint32_t trust_type;
327 struct WINBINDD_MEMORY_CREDS {
328 struct WINBINDD_MEMORY_CREDS *next, *prev;
329 const char *username; /* lookup key. */
330 uid_t uid;
331 int ref_count;
332 size_t len;
333 uint8_t *nt_hash; /* Base pointer for the following 2 */
334 uint8_t *lm_hash;
335 char *pass;
338 struct WINBINDD_CCACHE_ENTRY {
339 struct WINBINDD_CCACHE_ENTRY *next, *prev;
340 const char *principal_name;
341 const char *ccname;
342 const char *service;
343 const char *username;
344 const char *realm;
345 struct WINBINDD_MEMORY_CREDS *cred_ptr;
346 int ref_count;
347 uid_t uid;
348 time_t create_time;
349 time_t renew_until;
350 time_t refresh_time;
351 struct tevent_timer *event;
354 #include "winbindd/winbindd_proto.h"
356 #define WINBINDD_ESTABLISH_LOOP 30
357 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
358 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
359 #define DOM_SEQUENCE_NONE ((uint32_t)-1)
361 #endif /* _WINBINDD_H */