docs-xml: change http://samba.org to https://www.samba.org
[Samba.git] / source3 / winbindd / winbindd.h
blobfce2e46debd14360a8f42a86493819b39b75f7d1
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 int next_user;
79 int num_users;
80 struct wbint_userinfo *users;
83 struct getgrent_state {
84 struct winbindd_domain *domain;
85 int next_group;
86 int num_groups;
87 struct wbint_Principal *groups;
90 /* Storage for cached getpwent() user entries */
92 struct getpwent_user {
93 fstring name; /* Account name */
94 fstring gecos; /* User information */
95 fstring homedir; /* User Home Directory */
96 fstring shell; /* User Login Shell */
97 struct dom_sid user_sid; /* NT user and primary group SIDs */
98 struct dom_sid group_sid;
101 /* Our connection to the DC */
103 struct winbindd_cm_conn {
104 struct cli_state *cli;
106 enum dcerpc_AuthLevel auth_level;
108 struct rpc_pipe_client *samr_pipe;
109 struct policy_handle sam_connect_handle, sam_domain_handle;
111 struct rpc_pipe_client *lsa_pipe;
112 struct rpc_pipe_client *lsa_pipe_tcp;
113 struct policy_handle lsa_policy;
115 struct rpc_pipe_client *netlogon_pipe;
116 struct netlogon_creds_cli_context *netlogon_creds;
117 uint32_t netlogon_flags;
118 bool netlogon_force_reauth;
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_t domain_flags; /* Domain flags from netlogon.h */
157 uint32_t domain_type; /* Domain type from netlogon.h */
158 uint32_t 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 rodc; /* Are we an RODC for this AD domain? (do some operations locally) */
165 bool online; /* is this domain available ? */
166 time_t startup_time; /* When we set "startup" true. monotonic clock */
167 bool startup; /* are we in the first 30 seconds after startup_time ? */
169 bool can_do_ncacn_ip_tcp;
172 * Lookup methods for this domain (LDAP or RPC). The backend
173 * methods are used by the cache layer.
175 struct winbindd_methods *backend;
177 /* Private data for the backends (used for connection cache) */
179 void *private_data;
181 /* A working DC */
182 pid_t dc_probe_pid; /* Child we're using to detect the DC. */
183 char *dcname;
184 struct sockaddr_storage dcaddr;
186 /* Sequence number stuff */
188 time_t last_seq_check;
189 uint32_t sequence_number;
190 NTSTATUS last_status;
192 /* The smb connection */
194 struct winbindd_cm_conn conn;
196 /* The child pid we're talking to */
198 struct winbindd_child *children;
200 /* Callback we use to try put us back online. */
202 uint32_t check_online_timeout;
203 struct tevent_timer *check_online_event;
205 /* Linked list info */
207 struct winbindd_domain *prev, *next;
210 struct wb_acct_info {
211 fstring acct_name; /* account name */
212 fstring acct_desc; /* account name */
213 uint32_t rid; /* domain-relative RID */
216 /* per-domain methods. This is how LDAP vs RPC is selected
218 struct winbindd_methods {
219 /* does this backend provide a consistent view of the data? (ie. is the primary group
220 always correct) */
221 bool consistent;
223 /* get a list of users, returning a wbint_userinfo for each one */
224 NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
225 TALLOC_CTX *mem_ctx,
226 uint32_t *num_entries,
227 struct wbint_userinfo **info);
229 /* get a list of domain groups */
230 NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
231 TALLOC_CTX *mem_ctx,
232 uint32_t *num_entries,
233 struct wb_acct_info **info);
235 /* get a list of domain local groups */
236 NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
237 TALLOC_CTX *mem_ctx,
238 uint32_t *num_entries,
239 struct wb_acct_info **info);
241 /* convert one user or group name to a sid */
242 NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
243 TALLOC_CTX *mem_ctx,
244 const char *domain_name,
245 const char *name,
246 uint32_t flags,
247 struct dom_sid *sid,
248 enum lsa_SidType *type);
250 /* convert a sid to a user or group name */
251 NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
252 TALLOC_CTX *mem_ctx,
253 const struct dom_sid *sid,
254 char **domain_name,
255 char **name,
256 enum lsa_SidType *type);
258 NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
259 TALLOC_CTX *mem_ctx,
260 const struct dom_sid *domain_sid,
261 uint32_t *rids,
262 size_t num_rids,
263 char **domain_name,
264 char ***names,
265 enum lsa_SidType **types);
267 /* lookup user info for a given SID */
268 NTSTATUS (*query_user)(struct winbindd_domain *domain,
269 TALLOC_CTX *mem_ctx,
270 const struct dom_sid *user_sid,
271 struct wbint_userinfo *user_info);
273 /* lookup all groups that a user is a member of. The backend
274 can also choose to lookup by username or rid for this
275 function */
276 NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
277 TALLOC_CTX *mem_ctx,
278 const struct dom_sid *user_sid,
279 uint32_t *num_groups, struct dom_sid **user_gids);
281 /* Lookup all aliases that the sids delivered are member of. This is
282 * to implement 'domain local groups' correctly */
283 NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
284 TALLOC_CTX *mem_ctx,
285 uint32_t num_sids,
286 const struct dom_sid *sids,
287 uint32_t *num_aliases,
288 uint32_t **alias_rids);
290 /* find all members of the group with the specified group_rid */
291 NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
292 TALLOC_CTX *mem_ctx,
293 const struct dom_sid *group_sid,
294 enum lsa_SidType type,
295 uint32_t *num_names,
296 struct dom_sid **sid_mem, char ***names,
297 uint32_t **name_types);
299 /* return the current global sequence number */
300 NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32_t *seq);
302 /* return the lockout policy */
303 NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
304 TALLOC_CTX *mem_ctx,
305 struct samr_DomInfo12 *lockout_policy);
307 /* return the lockout policy */
308 NTSTATUS (*password_policy)(struct winbindd_domain *domain,
309 TALLOC_CTX *mem_ctx,
310 struct samr_DomInfo1 *password_policy);
312 /* enumerate trusted domains */
313 NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
314 TALLOC_CTX *mem_ctx,
315 struct netr_DomainTrustList *trusts);
318 /* Filled out by IDMAP backends */
319 struct winbindd_idmap_methods {
320 /* Called when backend is first loaded */
321 bool (*init)(void);
323 bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
324 bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
326 bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
327 bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
329 /* Called when backend is unloaded */
330 bool (*close)(void);
331 /* Called to dump backend status */
332 void (*status)(void);
335 /* Data structures for dealing with the trusted domain cache */
337 struct winbindd_tdc_domain {
338 const char *domain_name;
339 const char *dns_name;
340 struct dom_sid sid;
341 uint32_t trust_flags;
342 uint32_t trust_attribs;
343 uint32_t trust_type;
346 struct WINBINDD_MEMORY_CREDS {
347 struct WINBINDD_MEMORY_CREDS *next, *prev;
348 const char *username; /* lookup key. */
349 uid_t uid;
350 int ref_count;
351 size_t len;
352 uint8_t *nt_hash; /* Base pointer for the following 2 */
353 uint8_t *lm_hash;
354 char *pass;
357 struct WINBINDD_CCACHE_ENTRY {
358 struct WINBINDD_CCACHE_ENTRY *next, *prev;
359 const char *principal_name;
360 const char *ccname;
361 const char *service;
362 const char *username;
363 const char *realm;
364 struct WINBINDD_MEMORY_CREDS *cred_ptr;
365 int ref_count;
366 uid_t uid;
367 time_t create_time;
368 time_t renew_until;
369 time_t refresh_time;
370 struct tevent_timer *event;
373 #include "winbindd/winbindd_proto.h"
375 #define WINBINDD_ESTABLISH_LOOP 30
376 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
377 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
378 #define DOM_SEQUENCE_NONE ((uint32_t)-1)
380 #endif /* _WINBINDD_H */