[GLUE] Rsync SAMBA_3_2_0 SVN r25598 in order to create the v3-2-test branch.
[sfrench/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         /* Lookup methods for this domain (LDAP or RPC) */
169         struct winbindd_methods *methods;
170
171         /* the backend methods are used by the cache layer to find the right
172            backend */
173         struct winbindd_methods *backend;
174
175         /* Private data for the backends (used for connection cache) */
176
177         void *private_data; 
178
179         /* A working DC */
180         fstring dcname;
181         struct sockaddr_in dcaddr;
182
183         /* Sequence number stuff */
184
185         time_t last_seq_check;
186         uint32 sequence_number;
187         NTSTATUS last_status;
188
189         /* The smb connection */
190
191         struct winbindd_cm_conn conn;
192
193         /* The child pid we're talking to */
194
195         struct winbindd_child child;
196
197         /* Callback we use to try put us back online. */
198
199         uint32 check_online_timeout;
200         struct timed_event *check_online_event;
201
202         /* Linked list info */
203
204         struct winbindd_domain *prev, *next;
205 };
206
207 /* per-domain methods. This is how LDAP vs RPC is selected
208  */
209 struct winbindd_methods {
210         /* does this backend provide a consistent view of the data? (ie. is the primary group
211            always correct) */
212         BOOL consistent;
213
214         /* get a list of users, returning a WINBIND_USERINFO for each one */
215         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
216                                    TALLOC_CTX *mem_ctx,
217                                    uint32 *num_entries, 
218                                    WINBIND_USERINFO **info);
219
220         /* get a list of domain groups */
221         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
222                                     TALLOC_CTX *mem_ctx,
223                                     uint32 *num_entries, 
224                                     struct acct_info **info);
225
226         /* get a list of domain local groups */
227         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
228                                     TALLOC_CTX *mem_ctx,
229                                     uint32 *num_entries, 
230                                     struct acct_info **info);
231                                     
232         /* convert one user or group name to a sid */
233         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
234                                 TALLOC_CTX *mem_ctx,
235                                 enum winbindd_cmd orig_cmd,
236                                 const char *domain_name,
237                                 const char *name,
238                                 DOM_SID *sid,
239                                 enum lsa_SidType *type);
240
241         /* convert a sid to a user or group name */
242         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
243                                 TALLOC_CTX *mem_ctx,
244                                 const DOM_SID *sid,
245                                 char **domain_name,
246                                 char **name,
247                                 enum lsa_SidType *type);
248
249         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
250                                   TALLOC_CTX *mem_ctx,
251                                   const DOM_SID *domain_sid,
252                                   uint32 *rids,
253                                   size_t num_rids,
254                                   char **domain_name,
255                                   char ***names,
256                                   enum lsa_SidType **types);
257
258         /* lookup user info for a given SID */
259         NTSTATUS (*query_user)(struct winbindd_domain *domain, 
260                                TALLOC_CTX *mem_ctx, 
261                                const DOM_SID *user_sid,
262                                WINBIND_USERINFO *user_info);
263
264         /* lookup all groups that a user is a member of. The backend
265            can also choose to lookup by username or rid for this
266            function */
267         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
268                                       TALLOC_CTX *mem_ctx,
269                                       const DOM_SID *user_sid,
270                                       uint32 *num_groups, DOM_SID **user_gids);
271
272         /* Lookup all aliases that the sids delivered are member of. This is
273          * to implement 'domain local groups' correctly */
274         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
275                                        TALLOC_CTX *mem_ctx,
276                                        uint32 num_sids,
277                                        const DOM_SID *sids,
278                                        uint32 *num_aliases,
279                                        uint32 **alias_rids);
280
281         /* find all members of the group with the specified group_rid */
282         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
283                                     TALLOC_CTX *mem_ctx,
284                                     const DOM_SID *group_sid,
285                                     uint32 *num_names, 
286                                     DOM_SID **sid_mem, char ***names, 
287                                     uint32 **name_types);
288
289         /* return the current global sequence number */
290         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
291
292         /* return the lockout policy */
293         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain, 
294                                    TALLOC_CTX *mem_ctx,
295                                    SAM_UNK_INFO_12 *lockout_policy);
296  
297         /* return the lockout policy */
298         NTSTATUS (*password_policy)(struct winbindd_domain *domain, 
299                                     TALLOC_CTX *mem_ctx,
300                                     SAM_UNK_INFO_1 *password_policy);
301  
302         /* enumerate trusted domains */
303         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
304                                     TALLOC_CTX *mem_ctx,
305                                     uint32 *num_domains,
306                                     char ***names,
307                                     char ***alt_names,
308                                     DOM_SID **dom_sids);
309 };
310
311 /* Used to glue a policy handle and cli_state together */
312
313 typedef struct {
314         struct cli_state *cli;
315         POLICY_HND pol;
316 } CLI_POLICY_HND;
317
318 /* Filled out by IDMAP backends */
319 struct winbindd_idmap_methods {
320   /* Called when backend is first loaded */
321   BOOL (*init)(void);
322
323   BOOL (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
324   BOOL (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
325
326   BOOL (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
327   BOOL (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
328
329   /* Called when backend is unloaded */
330   BOOL (*close)(void);
331   /* Called to dump backend status */
332   void (*status)(void);
333 };
334
335 /* Data structures for dealing with the trusted domain cache */
336
337 struct winbindd_tdc_domain {
338         const char *domain_name;
339         const char *dns_name;
340         DOM_SID sid;
341         uint32 trust_flags;
342         uint32 trust_attribs;
343         uint32 trust_type;
344 };
345
346
347 #include "winbindd/winbindd_proto.h"
348
349 #define WINBINDD_ESTABLISH_LOOP 30
350 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
351 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
352 #define DOM_SEQUENCE_NONE ((uint32)-1)
353
354 #define IS_DOMAIN_OFFLINE(x) ( lp_winbind_offline_logon() && \
355                                ( get_global_winbindd_state_offline() \
356                                  || !(x)->online ) )
357 #endif /* _WINBINDD_H */