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