s3-printing: Document the printer list functions.
[Samba/bjacke.git] / source3 / winbindd / winbindd.h
blob1ba24b5d0a6ed6ce0b113920486e3e677ba70277
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/wbint.h"
30 #include "talloc_dict.h"
32 #ifdef HAVE_LIBNSCD
33 #include <libnscd.h>
34 #endif
36 #ifdef HAVE_SYS_MMAN_H
37 #include <sys/mman.h>
38 #endif
40 #undef DBGC_CLASS
41 #define DBGC_CLASS DBGC_WINBIND
43 #define WB_REPLACE_CHAR '_'
45 struct sid_ctr {
46 struct dom_sid *sid;
47 bool finished;
48 const char *domain;
49 const char *name;
50 enum lsa_SidType type;
53 struct winbindd_cli_state {
54 struct winbindd_cli_state *prev, *next; /* Linked list pointers */
55 int sock; /* Open socket from client */
56 pid_t pid; /* pid of client */
57 time_t last_access; /* Time of last access (read or write) */
58 bool privileged; /* Is the client 'privileged' */
60 TALLOC_CTX *mem_ctx; /* memory per request */
61 const char *cmd_name;
62 NTSTATUS (*recv_fn)(struct tevent_req *req,
63 struct winbindd_response *presp);
64 struct winbindd_request *request; /* Request from client */
65 struct tevent_queue *out_queue;
66 struct winbindd_response *response; /* Respose to client */
67 bool getpwent_initialized; /* Has getpwent_state been
68 * initialized? */
69 bool getgrent_initialized; /* Has getgrent_state been
70 * initialized? */
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 struct rpc_pipe_client *samr_pipe;
107 struct policy_handle sam_connect_handle, sam_domain_handle;
109 struct rpc_pipe_client *lsa_pipe;
110 struct rpc_pipe_client *lsa_pipe_tcp;
111 struct policy_handle lsa_policy;
113 struct rpc_pipe_client *netlogon_pipe;
116 /* Async child */
118 struct winbindd_domain;
120 struct winbindd_child_dispatch_table {
121 const char *name;
122 enum winbindd_cmd struct_cmd;
123 enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
124 struct winbindd_cli_state *state);
127 struct winbindd_child {
128 struct winbindd_child *next, *prev;
130 pid_t pid;
131 struct winbindd_domain *domain;
132 char *logfilename;
134 int sock;
135 struct tevent_queue *queue;
136 struct dcerpc_binding_handle *binding_handle;
138 struct timed_event *lockout_policy_event;
139 struct timed_event *machine_password_change_event;
141 const struct winbindd_child_dispatch_table *table;
144 /* Structures to hold per domain information */
146 struct winbindd_domain {
147 fstring name; /* Domain name (NetBIOS) */
148 fstring alt_name; /* alt Domain name, if any (FQDN for ADS) */
149 fstring forest_name; /* Name of the AD forest we're in */
150 struct dom_sid sid; /* SID for this domain */
151 uint32 domain_flags; /* Domain flags from netlogon.h */
152 uint32 domain_type; /* Domain type from netlogon.h */
153 uint32 domain_trust_attribs; /* Trust attribs from netlogon.h */
154 bool initialized; /* Did we already ask for the domain mode? */
155 bool native_mode; /* is this a win2k domain in native mode ? */
156 bool active_directory; /* is this a win2k active directory ? */
157 bool primary; /* is this our primary domain ? */
158 bool internal; /* BUILTIN and member SAM */
159 bool online; /* is this domain available ? */
160 time_t startup_time; /* When we set "startup" true. monotonic clock */
161 bool startup; /* are we in the first 30 seconds after startup_time ? */
163 bool can_do_samlogon_ex; /* Due to the lack of finer control what type
164 * of DC we have, let us try to do a
165 * credential-chain less samlogon_ex call
166 * with AD and schannel. If this fails with
167 * DCERPC_FAULT_OP_RNG_ERROR, then set this
168 * to False. This variable is around so that
169 * we don't have to try _ex every time. */
171 bool can_do_ncacn_ip_tcp;
173 /* Lookup methods for this domain (LDAP or RPC) */
174 struct winbindd_methods *methods;
176 /* the backend methods are used by the cache layer to find the right
177 backend */
178 struct winbindd_methods *backend;
180 /* Private data for the backends (used for connection cache) */
182 void *private_data;
185 * idmap config settings, used to tell the idmap child which
186 * special domain config to use for a mapping
188 bool have_idmap_config;
189 uint32_t id_range_low, id_range_high;
191 /* A working DC */
192 pid_t dc_probe_pid; /* Child we're using to detect the DC. */
193 fstring dcname;
194 struct sockaddr_storage dcaddr;
196 /* Sequence number stuff */
198 time_t last_seq_check;
199 uint32 sequence_number;
200 NTSTATUS last_status;
202 /* The smb connection */
204 struct winbindd_cm_conn conn;
206 /* The child pid we're talking to */
208 struct winbindd_child child;
210 /* Callback we use to try put us back online. */
212 uint32 check_online_timeout;
213 struct timed_event *check_online_event;
215 /* Linked list info */
217 struct winbindd_domain *prev, *next;
220 /* per-domain methods. This is how LDAP vs RPC is selected
222 struct winbindd_methods {
223 /* does this backend provide a consistent view of the data? (ie. is the primary group
224 always correct) */
225 bool consistent;
227 /* get a list of users, returning a wbint_userinfo for each one */
228 NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
229 TALLOC_CTX *mem_ctx,
230 uint32 *num_entries,
231 struct wbint_userinfo **info);
233 /* get a list of domain groups */
234 NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
235 TALLOC_CTX *mem_ctx,
236 uint32 *num_entries,
237 struct acct_info **info);
239 /* get a list of domain local groups */
240 NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
241 TALLOC_CTX *mem_ctx,
242 uint32 *num_entries,
243 struct acct_info **info);
245 /* convert one user or group name to a sid */
246 NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
247 TALLOC_CTX *mem_ctx,
248 const char *domain_name,
249 const char *name,
250 uint32_t flags,
251 struct dom_sid *sid,
252 enum lsa_SidType *type);
254 /* convert a sid to a user or group name */
255 NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
256 TALLOC_CTX *mem_ctx,
257 const struct dom_sid *sid,
258 char **domain_name,
259 char **name,
260 enum lsa_SidType *type);
262 NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
263 TALLOC_CTX *mem_ctx,
264 const struct dom_sid *domain_sid,
265 uint32 *rids,
266 size_t num_rids,
267 char **domain_name,
268 char ***names,
269 enum lsa_SidType **types);
271 /* lookup user info for a given SID */
272 NTSTATUS (*query_user)(struct winbindd_domain *domain,
273 TALLOC_CTX *mem_ctx,
274 const struct dom_sid *user_sid,
275 struct wbint_userinfo *user_info);
277 /* lookup all groups that a user is a member of. The backend
278 can also choose to lookup by username or rid for this
279 function */
280 NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
281 TALLOC_CTX *mem_ctx,
282 const struct dom_sid *user_sid,
283 uint32 *num_groups, struct dom_sid **user_gids);
285 /* Lookup all aliases that the sids delivered are member of. This is
286 * to implement 'domain local groups' correctly */
287 NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
288 TALLOC_CTX *mem_ctx,
289 uint32 num_sids,
290 const struct dom_sid *sids,
291 uint32 *num_aliases,
292 uint32 **alias_rids);
294 /* find all members of the group with the specified group_rid */
295 NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
296 TALLOC_CTX *mem_ctx,
297 const struct dom_sid *group_sid,
298 enum lsa_SidType type,
299 uint32 *num_names,
300 struct dom_sid **sid_mem, char ***names,
301 uint32 **name_types);
303 /* return the current global sequence number */
304 NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
306 /* return the lockout policy */
307 NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
308 TALLOC_CTX *mem_ctx,
309 struct samr_DomInfo12 *lockout_policy);
311 /* return the lockout policy */
312 NTSTATUS (*password_policy)(struct winbindd_domain *domain,
313 TALLOC_CTX *mem_ctx,
314 struct samr_DomInfo1 *password_policy);
316 /* enumerate trusted domains */
317 NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
318 TALLOC_CTX *mem_ctx,
319 struct netr_DomainTrustList *trusts);
322 /* Filled out by IDMAP backends */
323 struct winbindd_idmap_methods {
324 /* Called when backend is first loaded */
325 bool (*init)(void);
327 bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
328 bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
330 bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
331 bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
333 /* Called when backend is unloaded */
334 bool (*close)(void);
335 /* Called to dump backend status */
336 void (*status)(void);
339 /* Data structures for dealing with the trusted domain cache */
341 struct winbindd_tdc_domain {
342 const char *domain_name;
343 const char *dns_name;
344 struct dom_sid sid;
345 uint32 trust_flags;
346 uint32 trust_attribs;
347 uint32 trust_type;
350 /* Switch for listing users or groups */
351 enum ent_type {
352 LIST_USERS = 0,
353 LIST_GROUPS,
356 struct WINBINDD_MEMORY_CREDS {
357 struct WINBINDD_MEMORY_CREDS *next, *prev;
358 const char *username; /* lookup key. */
359 uid_t uid;
360 int ref_count;
361 size_t len;
362 uint8_t *nt_hash; /* Base pointer for the following 2 */
363 uint8_t *lm_hash;
364 char *pass;
367 struct WINBINDD_CCACHE_ENTRY {
368 struct WINBINDD_CCACHE_ENTRY *next, *prev;
369 const char *principal_name;
370 const char *ccname;
371 const char *service;
372 const char *username;
373 const char *realm;
374 struct WINBINDD_MEMORY_CREDS *cred_ptr;
375 int ref_count;
376 uid_t uid;
377 time_t create_time;
378 time_t renew_until;
379 time_t refresh_time;
380 struct timed_event *event;
383 #include "winbindd/winbindd_proto.h"
385 #define WINBINDD_ESTABLISH_LOOP 30
386 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
387 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
388 #define DOM_SEQUENCE_NONE ((uint32)-1)
390 #define winbind_event_context server_event_context
391 #define winbind_messaging_context server_messaging_context
393 #endif /* _WINBINDD_H */