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