idmap_ad: Pass tldap debug messages on to DEBUG()
[Samba.git] / source3 / winbindd / winbindd.h
bloba72d6aa7830a738d76f63442fb6a7b86ecd79c0e
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 char client_name[32]; /* The process name of the client */
51 time_t last_access; /* Time of last access (read or write) */
52 bool privileged; /* Is the client 'privileged' */
54 TALLOC_CTX *mem_ctx; /* memory per request */
55 const char *cmd_name;
56 NTSTATUS (*recv_fn)(struct tevent_req *req,
57 struct winbindd_response *presp);
58 struct winbindd_request *request; /* Request from client */
59 struct tevent_queue *out_queue;
60 struct winbindd_response *response; /* Respose to client */
61 struct tevent_req *io_req; /* wb_req_read_* or wb_resp_write_* */
63 struct getpwent_state *pwent_state; /* State for getpwent() */
64 struct getgrent_state *grent_state; /* State for getgrent() */
67 struct getpwent_state {
68 struct winbindd_domain *domain;
69 uint32_t next_user;
70 struct wbint_RidArray rids;
73 struct getgrent_state {
74 struct winbindd_domain *domain;
75 int next_group;
76 int num_groups;
77 struct wbint_Principal *groups;
80 /* Our connection to the DC */
82 struct winbindd_cm_conn {
83 struct cli_state *cli;
85 enum dcerpc_AuthLevel auth_level;
87 struct rpc_pipe_client *samr_pipe;
88 struct policy_handle sam_connect_handle, sam_domain_handle;
90 struct rpc_pipe_client *lsa_pipe;
91 struct rpc_pipe_client *lsa_pipe_tcp;
92 struct policy_handle lsa_policy;
94 struct rpc_pipe_client *netlogon_pipe;
95 struct netlogon_creds_cli_context *netlogon_creds_ctx;
96 bool netlogon_force_reauth;
99 /* Async child */
101 struct winbindd_domain;
103 struct winbindd_child_dispatch_table {
104 const char *name;
105 enum winbindd_cmd struct_cmd;
106 enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
107 struct winbindd_cli_state *state);
110 struct winbindd_child {
111 pid_t pid;
112 struct winbindd_domain *domain;
113 char *logfilename;
115 int sock;
116 struct tevent_fd *monitor_fde; /* Watch for dead children/sockets */
117 struct tevent_queue *queue;
118 struct dcerpc_binding_handle *binding_handle;
120 struct tevent_timer *lockout_policy_event;
121 struct tevent_timer *machine_password_change_event;
123 const struct winbindd_child_dispatch_table *table;
126 /* Structures to hold per domain information */
128 struct winbindd_domain {
129 char *name; /* Domain name (NetBIOS) */
130 char *alt_name; /* alt Domain name, if any (FQDN for ADS) */
131 char *forest_name; /* Name of the AD forest we're in */
132 struct dom_sid sid; /* SID for this domain */
133 enum netr_SchannelType secure_channel_type;
134 uint32_t domain_flags; /* Domain flags from netlogon.h */
135 uint32_t domain_type; /* Domain type from netlogon.h */
136 uint32_t domain_trust_attribs; /* Trust attribs from netlogon.h */
137 struct winbindd_domain *routing_domain;
138 bool initialized; /* Did we already ask for the domain mode? */
139 bool native_mode; /* is this a win2k domain in native mode ? */
140 bool active_directory; /* is this a win2k active directory ? */
141 bool primary; /* is this our primary domain ? */
142 bool internal; /* BUILTIN and member SAM */
143 bool rodc; /* Are we an RODC for this AD domain? (do some operations locally) */
144 bool online; /* is this domain available ? */
145 time_t startup_time; /* When we set "startup" true. monotonic clock */
146 bool startup; /* are we in the first 30 seconds after startup_time ? */
148 bool can_do_ncacn_ip_tcp;
151 * Lookup methods for this domain (LDAP or RPC). The backend
152 * methods are used by the cache layer.
154 struct winbindd_methods *backend;
156 /* Private data for the backends (used for connection cache) */
158 void *private_data;
160 /* A working DC */
161 pid_t dc_probe_pid; /* Child we're using to detect the DC. */
162 char *dcname;
163 struct sockaddr_storage dcaddr;
165 /* Sequence number stuff */
167 time_t last_seq_check;
168 uint32_t sequence_number;
169 NTSTATUS last_status;
171 /* The smb connection */
173 struct winbindd_cm_conn conn;
175 /* The child pid we're talking to */
177 struct winbindd_child *children;
179 struct tevent_queue *queue;
180 struct dcerpc_binding_handle *binding_handle;
182 /* Callback we use to try put us back online. */
184 uint32_t check_online_timeout;
185 struct tevent_timer *check_online_event;
187 /* Linked list info */
189 struct winbindd_domain *prev, *next;
192 struct wb_acct_info {
193 const char *acct_name; /* account name */
194 const char *acct_desc; /* account name */
195 uint32_t rid; /* domain-relative RID */
198 /* per-domain methods. This is how LDAP vs RPC is selected
200 struct winbindd_methods {
201 /* does this backend provide a consistent view of the data? (ie. is the primary group
202 always correct) */
203 bool consistent;
205 /* get a list of users, returning a wbint_userinfo for each one */
206 NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
207 TALLOC_CTX *mem_ctx,
208 uint32_t **rids);
210 /* get a list of domain groups */
211 NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
212 TALLOC_CTX *mem_ctx,
213 uint32_t *num_entries,
214 struct wb_acct_info **info);
216 /* get a list of domain local groups */
217 NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
218 TALLOC_CTX *mem_ctx,
219 uint32_t *num_entries,
220 struct wb_acct_info **info);
222 /* convert one user or group name to a sid */
223 NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
224 TALLOC_CTX *mem_ctx,
225 const char *domain_name,
226 const char *name,
227 uint32_t flags,
228 const char **pdom_name,
229 struct dom_sid *sid,
230 enum lsa_SidType *type);
232 /* convert a sid to a user or group name */
233 NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
234 TALLOC_CTX *mem_ctx,
235 const struct dom_sid *sid,
236 char **domain_name,
237 char **name,
238 enum lsa_SidType *type);
240 NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
241 TALLOC_CTX *mem_ctx,
242 const struct dom_sid *domain_sid,
243 uint32_t *rids,
244 size_t num_rids,
245 char **domain_name,
246 char ***names,
247 enum lsa_SidType **types);
249 /* lookup all groups that a user is a member of. The backend
250 can also choose to lookup by username or rid for this
251 function */
252 NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
253 TALLOC_CTX *mem_ctx,
254 const struct dom_sid *user_sid,
255 uint32_t *num_groups, struct dom_sid **user_gids);
257 /* Lookup all aliases that the sids delivered are member of. This is
258 * to implement 'domain local groups' correctly */
259 NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
260 TALLOC_CTX *mem_ctx,
261 uint32_t num_sids,
262 const struct dom_sid *sids,
263 uint32_t *num_aliases,
264 uint32_t **alias_rids);
266 /* find all members of the group with the specified group_rid */
267 NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
268 TALLOC_CTX *mem_ctx,
269 const struct dom_sid *group_sid,
270 enum lsa_SidType type,
271 uint32_t *num_names,
272 struct dom_sid **sid_mem, char ***names,
273 uint32_t **name_types);
275 /* return the current global sequence number */
276 NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32_t *seq);
278 /* return the lockout policy */
279 NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
280 TALLOC_CTX *mem_ctx,
281 struct samr_DomInfo12 *lockout_policy);
283 /* return the lockout policy */
284 NTSTATUS (*password_policy)(struct winbindd_domain *domain,
285 TALLOC_CTX *mem_ctx,
286 struct samr_DomInfo1 *password_policy);
288 /* enumerate trusted domains */
289 NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
290 TALLOC_CTX *mem_ctx,
291 struct netr_DomainTrustList *trusts);
294 /* Filled out by IDMAP backends */
295 struct winbindd_idmap_methods {
296 /* Called when backend is first loaded */
297 bool (*init)(void);
299 bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
300 bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
302 bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
303 bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
305 /* Called when backend is unloaded */
306 bool (*close)(void);
307 /* Called to dump backend status */
308 void (*status)(void);
311 /* Data structures for dealing with the trusted domain cache */
313 struct winbindd_tdc_domain {
314 const char *domain_name;
315 const char *dns_name;
316 struct dom_sid sid;
317 uint32_t trust_flags;
318 uint32_t trust_attribs;
319 uint32_t trust_type;
322 struct WINBINDD_MEMORY_CREDS {
323 struct WINBINDD_MEMORY_CREDS *next, *prev;
324 const char *username; /* lookup key. */
325 uid_t uid;
326 int ref_count;
327 size_t len;
328 uint8_t *nt_hash; /* Base pointer for the following 2 */
329 uint8_t *lm_hash;
330 char *pass;
333 struct WINBINDD_CCACHE_ENTRY {
334 struct WINBINDD_CCACHE_ENTRY *next, *prev;
335 const char *principal_name;
336 const char *ccname;
337 const char *service;
338 const char *username;
339 const char *realm;
340 struct WINBINDD_MEMORY_CREDS *cred_ptr;
341 int ref_count;
342 uid_t uid;
343 time_t create_time;
344 time_t renew_until;
345 time_t refresh_time;
346 struct tevent_timer *event;
349 #include "winbindd/winbindd_proto.h"
351 #define WINBINDD_ESTABLISH_LOOP 30
352 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
353 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
354 #define DOM_SEQUENCE_NONE ((uint32_t)-1)
356 #endif /* _WINBINDD_H */