Change all uint32/16/8 to 32_t/16_t/8_t in winbindd.
[Samba.git] / source3 / winbindd / winbindd.h
blob8fc9eca5fd9d689bcd54c5da811009c4a3737aa6
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 */
71 struct getpwent_state *pwent_state; /* State for getpwent() */
72 struct getgrent_state *grent_state; /* State for getgrent() */
75 struct getpwent_state {
76 struct winbindd_domain *domain;
77 int next_user;
78 int num_users;
79 struct wbint_userinfo *users;
82 struct getgrent_state {
83 struct winbindd_domain *domain;
84 int next_group;
85 int num_groups;
86 struct wbint_Principal *groups;
89 /* Storage for cached getpwent() user entries */
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;
100 /* Our connection to the DC */
102 struct winbindd_cm_conn {
103 struct cli_state *cli;
105 enum dcerpc_AuthLevel auth_level;
107 struct rpc_pipe_client *samr_pipe;
108 struct policy_handle sam_connect_handle, sam_domain_handle;
110 struct rpc_pipe_client *lsa_pipe;
111 struct rpc_pipe_client *lsa_pipe_tcp;
112 struct policy_handle lsa_policy;
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;
120 /* Async child */
122 struct winbindd_domain;
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);
131 struct winbindd_child {
132 struct winbindd_child *next, *prev;
134 pid_t pid;
135 struct winbindd_domain *domain;
136 char *logfilename;
138 int sock;
139 struct tevent_queue *queue;
140 struct dcerpc_binding_handle *binding_handle;
142 struct tevent_timer *lockout_policy_event;
143 struct tevent_timer *machine_password_change_event;
145 const struct winbindd_child_dispatch_table *table;
148 /* Structures to hold per domain information */
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 ? */
168 bool can_do_ncacn_ip_tcp;
170 /* Lookup methods for this domain (LDAP or RPC) */
171 struct winbindd_methods *methods;
173 /* the backend methods are used by the cache layer to find the right
174 backend */
175 struct winbindd_methods *backend;
177 /* Private data for the backends (used for connection cache) */
179 void *private_data;
182 * idmap config settings, used to tell the idmap child which
183 * special domain config to use for a mapping
185 bool have_idmap_config;
186 uint32_t id_range_low, id_range_high;
188 /* A working DC */
189 pid_t dc_probe_pid; /* Child we're using to detect the DC. */
190 char *dcname;
191 struct sockaddr_storage dcaddr;
193 /* Sequence number stuff */
195 time_t last_seq_check;
196 uint32_t sequence_number;
197 NTSTATUS last_status;
199 /* The smb connection */
201 struct winbindd_cm_conn conn;
203 /* The child pid we're talking to */
205 struct winbindd_child *children;
207 /* Callback we use to try put us back online. */
209 uint32_t check_online_timeout;
210 struct tevent_timer *check_online_event;
212 /* Linked list info */
214 struct winbindd_domain *prev, *next;
217 struct wb_acct_info {
218 fstring acct_name; /* account name */
219 fstring acct_desc; /* account name */
220 uint32_t rid; /* domain-relative RID */
223 /* per-domain methods. This is how LDAP vs RPC is selected
225 struct winbindd_methods {
226 /* does this backend provide a consistent view of the data? (ie. is the primary group
227 always correct) */
228 bool consistent;
230 /* get a list of users, returning a wbint_userinfo for each one */
231 NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
232 TALLOC_CTX *mem_ctx,
233 uint32_t *num_entries,
234 struct wbint_userinfo **info);
236 /* get a list of domain groups */
237 NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
238 TALLOC_CTX *mem_ctx,
239 uint32_t *num_entries,
240 struct wb_acct_info **info);
242 /* get a list of domain local groups */
243 NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
244 TALLOC_CTX *mem_ctx,
245 uint32_t *num_entries,
246 struct wb_acct_info **info);
248 /* convert one user or group name to a sid */
249 NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
250 TALLOC_CTX *mem_ctx,
251 const char *domain_name,
252 const char *name,
253 uint32_t flags,
254 struct dom_sid *sid,
255 enum lsa_SidType *type);
257 /* convert a sid to a user or group name */
258 NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
259 TALLOC_CTX *mem_ctx,
260 const struct dom_sid *sid,
261 char **domain_name,
262 char **name,
263 enum lsa_SidType *type);
265 NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
266 TALLOC_CTX *mem_ctx,
267 const struct dom_sid *domain_sid,
268 uint32_t *rids,
269 size_t num_rids,
270 char **domain_name,
271 char ***names,
272 enum lsa_SidType **types);
274 /* lookup user info for a given SID */
275 NTSTATUS (*query_user)(struct winbindd_domain *domain,
276 TALLOC_CTX *mem_ctx,
277 const struct dom_sid *user_sid,
278 struct wbint_userinfo *user_info);
280 /* lookup all groups that a user is a member of. The backend
281 can also choose to lookup by username or rid for this
282 function */
283 NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
284 TALLOC_CTX *mem_ctx,
285 const struct dom_sid *user_sid,
286 uint32_t *num_groups, struct dom_sid **user_gids);
288 /* Lookup all aliases that the sids delivered are member of. This is
289 * to implement 'domain local groups' correctly */
290 NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
291 TALLOC_CTX *mem_ctx,
292 uint32_t num_sids,
293 const struct dom_sid *sids,
294 uint32_t *num_aliases,
295 uint32_t **alias_rids);
297 /* find all members of the group with the specified group_rid */
298 NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
299 TALLOC_CTX *mem_ctx,
300 const struct dom_sid *group_sid,
301 enum lsa_SidType type,
302 uint32_t *num_names,
303 struct dom_sid **sid_mem, char ***names,
304 uint32_t **name_types);
306 /* return the current global sequence number */
307 NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32_t *seq);
309 /* return the lockout policy */
310 NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
311 TALLOC_CTX *mem_ctx,
312 struct samr_DomInfo12 *lockout_policy);
314 /* return the lockout policy */
315 NTSTATUS (*password_policy)(struct winbindd_domain *domain,
316 TALLOC_CTX *mem_ctx,
317 struct samr_DomInfo1 *password_policy);
319 /* enumerate trusted domains */
320 NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
321 TALLOC_CTX *mem_ctx,
322 struct netr_DomainTrustList *trusts);
325 /* Filled out by IDMAP backends */
326 struct winbindd_idmap_methods {
327 /* Called when backend is first loaded */
328 bool (*init)(void);
330 bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
331 bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
333 bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
334 bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
336 /* Called when backend is unloaded */
337 bool (*close)(void);
338 /* Called to dump backend status */
339 void (*status)(void);
342 /* Data structures for dealing with the trusted domain cache */
344 struct winbindd_tdc_domain {
345 const char *domain_name;
346 const char *dns_name;
347 struct dom_sid sid;
348 uint32_t trust_flags;
349 uint32_t trust_attribs;
350 uint32_t trust_type;
353 /* Switch for listing users or groups */
354 enum ent_type {
355 LIST_USERS = 0,
356 LIST_GROUPS,
359 struct WINBINDD_MEMORY_CREDS {
360 struct WINBINDD_MEMORY_CREDS *next, *prev;
361 const char *username; /* lookup key. */
362 uid_t uid;
363 int ref_count;
364 size_t len;
365 uint8_t *nt_hash; /* Base pointer for the following 2 */
366 uint8_t *lm_hash;
367 char *pass;
370 struct WINBINDD_CCACHE_ENTRY {
371 struct WINBINDD_CCACHE_ENTRY *next, *prev;
372 const char *principal_name;
373 const char *ccname;
374 const char *service;
375 const char *username;
376 const char *realm;
377 struct WINBINDD_MEMORY_CREDS *cred_ptr;
378 int ref_count;
379 uid_t uid;
380 time_t create_time;
381 time_t renew_until;
382 time_t refresh_time;
383 struct tevent_timer *event;
386 #include "winbindd/winbindd_proto.h"
388 #define WINBINDD_ESTABLISH_LOOP 30
389 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
390 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
391 #define DOM_SEQUENCE_NONE ((uint32)-1)
393 #endif /* _WINBINDD_H */