r25152: fix headers used in wbinfo.c
[nivanova/samba-autobuild/.git] / source3 / winbindd / winbindd.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Winbind daemon for ntdom nss module
5
6    Copyright (C) Tim Potter 2000
7    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
8    
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.
13    
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.
18    
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/>.
21 */
22
23 #ifndef _WINBINDD_H
24 #define _WINBINDD_H
25
26 #include "nsswitch/winbind_struct_protocol.h"
27
28 #ifdef HAVE_LIBNSCD
29 #include <libnscd.h>
30 #endif
31
32 #ifdef HAVE_SYS_MMAN_H
33 #include <sys/mman.h>
34 #endif
35
36 #undef DBGC_CLASS
37 #define DBGC_CLASS DBGC_WINBIND
38
39 #define WB_REPLACE_CHAR         '_'
40
41 /* bits for fd_event.flags */
42 #define EVENT_FD_READ 1
43 #define EVENT_FD_WRITE 2
44
45 struct fd_event {
46         struct fd_event *next, *prev;
47         int fd;
48         int flags; /* see EVENT_FD_* flags */
49         void (*handler)(struct fd_event *fde, int flags);
50         void *data;
51         size_t length, done;
52         void (*finished)(void *private_data, BOOL success);
53         void *private_data;
54 };
55
56 struct sid_ctr {
57         DOM_SID *sid;
58         BOOL finished;
59         const char *domain;
60         const char *name;
61         enum lsa_SidType type;
62 };
63
64 struct winbindd_cli_state {
65         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
66         int sock;                                 /* Open socket from client */
67         struct fd_event fd_event;
68         pid_t pid;                                /* pid of client */
69         BOOL finished;                            /* Can delete from list */
70         BOOL write_extra_data;                    /* Write extra_data field */
71         time_t last_access;                       /* Time of last access (read or write) */
72         BOOL privileged;                           /* Is the client 'privileged' */
73
74         TALLOC_CTX *mem_ctx;                      /* memory per request */
75         struct winbindd_request request;          /* Request from client */
76         struct winbindd_response response;        /* Respose to client */
77         BOOL getpwent_initialized;                /* Has getpwent_state been
78                                                    * initialized? */
79         BOOL getgrent_initialized;                /* Has getgrent_state been
80                                                    * initialized? */
81         struct getent_state *getpwent_state;      /* State for getpwent() */
82         struct getent_state *getgrent_state;      /* State for getgrent() */
83 };
84
85 /* State between get{pw,gr}ent() calls */
86
87 struct getent_state {
88         struct getent_state *prev, *next;
89         void *sam_entries;
90         uint32 sam_entry_index, num_sam_entries;
91         BOOL got_sam_entries;
92         fstring domain_name;
93 };
94
95 /* Storage for cached getpwent() user entries */
96
97 struct getpwent_user {
98         fstring name;                        /* Account name */
99         fstring gecos;                       /* User information */
100         fstring homedir;                     /* User Home Directory */
101         fstring shell;                       /* User Login Shell */
102         DOM_SID user_sid;                    /* NT user and primary group SIDs */
103         DOM_SID group_sid;
104 };
105
106 /* Server state structure */
107
108 typedef struct {
109         char *acct_name;
110         char *full_name;
111         char *homedir;
112         char *shell;
113         gid_t primary_gid;                   /* allow the nss_info
114                                                 backend to set the primary group */
115         DOM_SID user_sid;                    /* NT user and primary group SIDs */
116         DOM_SID group_sid;
117 } WINBIND_USERINFO;
118
119 /* Our connection to the DC */
120
121 struct winbindd_cm_conn {
122         struct cli_state *cli;
123
124         struct rpc_pipe_client *samr_pipe;
125         POLICY_HND sam_connect_handle, sam_domain_handle;
126
127         struct rpc_pipe_client *lsa_pipe;
128         POLICY_HND lsa_policy;
129
130         struct rpc_pipe_client *netlogon_pipe;
131 };
132
133 struct winbindd_async_request;
134
135 /* Async child */
136
137 struct winbindd_child {
138         struct winbindd_child *next, *prev;
139
140         pid_t pid;
141         struct winbindd_domain *domain;
142         pstring logfilename;
143
144         struct fd_event event;
145         struct timed_event *lockout_policy_event;
146         struct winbindd_async_request *requests;
147 };
148
149 /* Structures to hold per domain information */
150
151 struct winbindd_domain {
152         fstring name;                          /* Domain name (NetBIOS) */
153         fstring alt_name;                      /* alt Domain name, if any (FQDN for ADS) */
154         fstring forest_name;                   /* Name of the AD forest we're in */
155         DOM_SID sid;                           /* SID for this domain */
156         uint32 domain_flags;                   /* Domain flags from rpc_ds.h */ 
157         uint32 domain_type;                    /* Domain type from rpc_ds.h */  
158         uint32 domain_trust_attribs;           /* Trust attribs from rpc_ds.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 online;                           /* is this domain available ? */
165         time_t startup_time;                   /* When we set "startup" true. */
166         BOOL startup;                          /* are we in the first 30 seconds after startup_time ? */
167
168         BOOL can_do_samlogon_ex; /* Due to the lack of finer control what type
169                                   * of DC we have, let us try to do a
170                                   * credential-chain less samlogon_ex call
171                                   * with AD and schannel. If this fails with
172                                   * DCERPC_FAULT_OP_RNG_ERROR, then set this
173                                   * to False. This variable is around so that
174                                   * we don't have to try _ex every time. */
175
176         /* Lookup methods for this domain (LDAP or RPC) */
177         struct winbindd_methods *methods;
178
179         /* the backend methods are used by the cache layer to find the right
180            backend */
181         struct winbindd_methods *backend;
182
183         /* Private data for the backends (used for connection cache) */
184
185         void *private_data; 
186
187         /* A working DC */
188         fstring dcname;
189         struct sockaddr_in dcaddr;
190
191         /* Sequence number stuff */
192
193         time_t last_seq_check;
194         uint32 sequence_number;
195         NTSTATUS last_status;
196
197         /* The smb connection */
198
199         struct winbindd_cm_conn conn;
200
201         /* The child pid we're talking to */
202
203         struct winbindd_child child;
204
205         /* Callback we use to try put us back online. */
206
207         uint32 check_online_timeout;
208         struct timed_event *check_online_event;
209
210         /* Linked list info */
211
212         struct winbindd_domain *prev, *next;
213 };
214
215 /* per-domain methods. This is how LDAP vs RPC is selected
216  */
217 struct winbindd_methods {
218         /* does this backend provide a consistent view of the data? (ie. is the primary group
219            always correct) */
220         BOOL consistent;
221
222         /* get a list of users, returning a WINBIND_USERINFO for each one */
223         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
224                                    TALLOC_CTX *mem_ctx,
225                                    uint32 *num_entries, 
226                                    WINBIND_USERINFO **info);
227
228         /* get a list of domain groups */
229         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
230                                     TALLOC_CTX *mem_ctx,
231                                     uint32 *num_entries, 
232                                     struct acct_info **info);
233
234         /* get a list of domain local groups */
235         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
236                                     TALLOC_CTX *mem_ctx,
237                                     uint32 *num_entries, 
238                                     struct acct_info **info);
239                                     
240         /* convert one user or group name to a sid */
241         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
242                                 TALLOC_CTX *mem_ctx,
243                                 enum winbindd_cmd orig_cmd,
244                                 const char *domain_name,
245                                 const char *name,
246                                 DOM_SID *sid,
247                                 enum lsa_SidType *type);
248
249         /* convert a sid to a user or group name */
250         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
251                                 TALLOC_CTX *mem_ctx,
252                                 const DOM_SID *sid,
253                                 char **domain_name,
254                                 char **name,
255                                 enum lsa_SidType *type);
256
257         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
258                                   TALLOC_CTX *mem_ctx,
259                                   const DOM_SID *domain_sid,
260                                   uint32 *rids,
261                                   size_t num_rids,
262                                   char **domain_name,
263                                   char ***names,
264                                   enum lsa_SidType **types);
265
266         /* lookup user info for a given SID */
267         NTSTATUS (*query_user)(struct winbindd_domain *domain, 
268                                TALLOC_CTX *mem_ctx, 
269                                const DOM_SID *user_sid,
270                                WINBIND_USERINFO *user_info);
271
272         /* lookup all groups that a user is a member of. The backend
273            can also choose to lookup by username or rid for this
274            function */
275         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
276                                       TALLOC_CTX *mem_ctx,
277                                       const DOM_SID *user_sid,
278                                       uint32 *num_groups, DOM_SID **user_gids);
279
280         /* Lookup all aliases that the sids delivered are member of. This is
281          * to implement 'domain local groups' correctly */
282         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
283                                        TALLOC_CTX *mem_ctx,
284                                        uint32 num_sids,
285                                        const DOM_SID *sids,
286                                        uint32 *num_aliases,
287                                        uint32 **alias_rids);
288
289         /* find all members of the group with the specified group_rid */
290         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
291                                     TALLOC_CTX *mem_ctx,
292                                     const DOM_SID *group_sid,
293                                     uint32 *num_names, 
294                                     DOM_SID **sid_mem, char ***names, 
295                                     uint32 **name_types);
296
297         /* return the current global sequence number */
298         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
299
300         /* return the lockout policy */
301         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain, 
302                                    TALLOC_CTX *mem_ctx,
303                                    SAM_UNK_INFO_12 *lockout_policy);
304  
305         /* return the lockout policy */
306         NTSTATUS (*password_policy)(struct winbindd_domain *domain, 
307                                     TALLOC_CTX *mem_ctx,
308                                     SAM_UNK_INFO_1 *password_policy);
309  
310         /* enumerate trusted domains */
311         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
312                                     TALLOC_CTX *mem_ctx,
313                                     uint32 *num_domains,
314                                     char ***names,
315                                     char ***alt_names,
316                                     DOM_SID **dom_sids);
317 };
318
319 /* Used to glue a policy handle and cli_state together */
320
321 typedef struct {
322         struct cli_state *cli;
323         POLICY_HND pol;
324 } CLI_POLICY_HND;
325
326 /* Filled out by IDMAP backends */
327 struct winbindd_idmap_methods {
328   /* Called when backend is first loaded */
329   BOOL (*init)(void);
330
331   BOOL (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
332   BOOL (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
333
334   BOOL (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
335   BOOL (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
336
337   /* Called when backend is unloaded */
338   BOOL (*close)(void);
339   /* Called to dump backend status */
340   void (*status)(void);
341 };
342
343 /* Data structures for dealing with the trusted domain cache */
344
345 struct winbindd_tdc_domain {
346         const char *domain_name;
347         const char *dns_name;
348         DOM_SID sid;
349         uint32 trust_flags;
350         uint32 trust_attribs;
351         uint32 trust_type;
352 };
353
354
355 #include "winbindd/winbindd_proto.h"
356
357 #define WINBINDD_ESTABLISH_LOOP 30
358 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
359 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
360 #define DOM_SEQUENCE_NONE ((uint32)-1)
361
362 #define IS_DOMAIN_OFFLINE(x) ( lp_winbind_offline_logon() && \
363                                ( get_global_winbindd_state_offline() \
364                                  || !(x)->online ) )
365 #endif /* _WINBINDD_H */