Removed global_myworkgroup, global_myname, global_myscope. Added liberal
[samba.git] / source3 / nsswitch / winbindd_util.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Winbind daemon for ntdom nss module
5
6    Copyright (C) Tim Potter 2000-2001
7    Copyright (C) 2001 by Martin Pool <mbp@samba.org>
8    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13    
14    This program 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
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 #include "winbindd.h"
25
26 #undef DBGC_CLASS
27 #define DBGC_CLASS DBGC_WINBIND
28
29 /**
30  * @file winbindd_util.c
31  *
32  * Winbind daemon for NT domain authentication nss module.
33  **/
34
35
36 /**
37  * Used to clobber name fields that have an undefined value.
38  *
39  * Correct code should never look at a field that has this value.
40  **/
41
42 static const fstring name_deadbeef = "<deadbeef>";
43
44 /* The list of trusted domains.  Note that the list can be deleted and
45    recreated using the init_domain_list() function so pointers to
46    individual winbindd_domain structures cannot be made.  Keep a copy of
47    the domain name instead. */
48
49 static struct winbindd_domain *_domain_list;
50
51 struct winbindd_domain *domain_list(void)
52 {
53         /* Initialise list */
54
55         if (!_domain_list)
56                 init_domain_list();
57
58         return _domain_list;
59 }
60
61 /* Free all entries in the trusted domain list */
62
63 void free_domain_list(void)
64 {
65         struct winbindd_domain *domain = _domain_list;
66
67         while(domain) {
68                 struct winbindd_domain *next = domain->next;
69                 
70                 DLIST_REMOVE(_domain_list, domain);
71                 SAFE_FREE(domain);
72                 domain = next;
73         }
74 }
75
76
77 /* Add a trusted domain to our list of domains */
78 static struct winbindd_domain *add_trusted_domain(const char *domain_name, const char *alt_name,
79                                                   struct winbindd_methods *methods,
80                                                   DOM_SID *sid)
81 {
82         struct winbindd_domain *domain;
83         
84         /* We can't call domain_list() as this function is called from
85            init_domain_list() and we'll get stuck in a loop. */
86         for (domain = _domain_list; domain; domain = domain->next) {
87                 if (strcasecmp(domain_name, domain->name) == 0 ||
88                     strcasecmp(domain_name, domain->alt_name) == 0) {
89                         return domain;
90                 }
91                 if (alt_name && *alt_name) {
92                         if (strcasecmp(alt_name, domain->name) == 0 ||
93                             strcasecmp(alt_name, domain->alt_name) == 0) {
94                                 return domain;
95                         }
96                 }
97         }
98         
99         /* Create new domain entry */
100
101         if ((domain = (struct winbindd_domain *)
102              malloc(sizeof(*domain))) == NULL)
103                 return NULL;
104
105         /* Fill in fields */
106         
107         ZERO_STRUCTP(domain);
108
109         /* prioritise the short name */
110         if (strchr_m(domain_name, '.') && alt_name && *alt_name) {
111                 fstrcpy(domain->name, alt_name);
112                 fstrcpy(domain->alt_name, domain_name);
113         } else {
114         fstrcpy(domain->name, domain_name);
115                 if (alt_name) {
116                         fstrcpy(domain->alt_name, alt_name);
117                 }
118         }
119
120         domain->methods = methods;
121         domain->sequence_number = DOM_SEQUENCE_NONE;
122         domain->last_seq_check = 0;
123         if (sid) {
124                 sid_copy(&domain->sid, sid);
125         }
126         
127         /* see if this is a native mode win2k domain, but only for our own domain */
128            
129         if ( strequal( lp_workgroup(), domain_name) )   {
130                 domain->native_mode = cm_check_for_native_mode_win2k( domain_name );
131                 DEBUG(3,("add_trusted_domain: %s is a %s mode domain\n", domain_name,
132                                         domain->native_mode ? "native" : "mixed" ));
133         }       
134
135         /* Link to domain list */
136         DLIST_ADD(_domain_list, domain);
137         
138         DEBUG(1,("Added domain %s %s %s\n", 
139                  domain->name, domain->alt_name,
140                  sid?sid_string_static(&domain->sid):""));
141         
142         return domain;
143 }
144
145
146 /*
147   rescan our domains looking for new trusted domains
148  */
149 void rescan_trusted_domains(void)
150 {
151         struct winbindd_domain *domain;
152         TALLOC_CTX *mem_ctx;
153         static time_t last_scan;
154         time_t t = time(NULL);
155
156         /* trusted domains might be disabled */
157         if (!lp_allow_trusted_domains()) {
158                 return;
159         }
160         
161         /* ony rescan every few minutes */
162         if ((unsigned)(t - last_scan) < WINBINDD_RESCAN_FREQ) {
163                 return;
164         }
165         last_scan = t;
166
167         DEBUG(1, ("scanning trusted domain list\n"));
168
169         if (!(mem_ctx = talloc_init_named("init_domain_list")))
170                 return;
171
172         for (domain = _domain_list; domain; domain = domain->next) {
173                 NTSTATUS result;
174                 char **names;
175                 char **alt_names;
176                 int num_domains = 0;
177                 DOM_SID *dom_sids;
178                 int i;
179
180                 result = domain->methods->trusted_domains(domain, mem_ctx, &num_domains,
181                                                           &names, &alt_names, &dom_sids);
182                 if (!NT_STATUS_IS_OK(result)) {
183                         continue;
184                 }
185
186                 /* Add each domain to the trusted domain list. Each domain inherits
187                    the access methods of its parent */
188                 for(i = 0; i < num_domains; i++) {
189                         DEBUG(10,("Found domain %s\n", names[i]));
190                         add_trusted_domain(names[i], 
191                                            alt_names?alt_names[i]:NULL, 
192                                            domain->methods, &dom_sids[i]);
193                 }
194         }
195
196         talloc_destroy(mem_ctx);
197 }
198
199 /* Look up global info for the winbind daemon */
200 BOOL init_domain_list(void)
201 {
202         NTSTATUS result;
203         extern struct winbindd_methods cache_methods;
204         struct winbindd_domain *domain;
205
206         /* Free existing list */
207         free_domain_list();
208
209         /* Add ourselves as the first entry */
210         domain = add_trusted_domain(lp_workgroup(), NULL, &cache_methods, NULL);
211
212         /* Now we *must* get the domain sid for our primary domain. Go into
213            a holding pattern until that is available */
214
215         result = cache_methods.domain_sid(domain, &domain->sid);
216         while (!NT_STATUS_IS_OK(result)) {
217
218                 sleep(10);
219                 DEBUG(1,("Retrying startup domain sid fetch for %s\n",
220                          domain->name));
221                 result = cache_methods.domain_sid(domain, &domain->sid);
222
223                 /* If we don't call lp_talloc_free() here we end up 
224                    accumulating memory in the "global" lp_talloc in
225                    param/loadparm.c */
226
227                 lp_talloc_free();
228         }
229        
230         /* get any alternate name for the primary domain */
231         cache_methods.alternate_name(domain);
232
233         /* do an initial scan for trusted domains */
234         rescan_trusted_domains();
235
236         return True;
237 }
238
239 /* Given a domain name, return the struct winbindd domain info for it 
240    if it is actually working. */
241
242 struct winbindd_domain *find_domain_from_name(const char *domain_name)
243 {
244         struct winbindd_domain *domain;
245
246         /* Search through list */
247
248         for (domain = domain_list(); domain != NULL; domain = domain->next) {
249                 if (strequal(domain_name, domain->name) ||
250                     (domain->alt_name[0] && strequal(domain_name, domain->alt_name)))
251                         return domain;
252         }
253
254         /* Not found */
255
256         return NULL;
257 }
258
259 /* Given a domain sid, return the struct winbindd domain info for it */
260
261 struct winbindd_domain *find_domain_from_sid(DOM_SID *sid)
262 {
263         struct winbindd_domain *domain;
264
265         /* Search through list */
266
267         for (domain = domain_list(); domain != NULL; domain = domain->next) {
268                 if (sid_compare_domain(sid, &domain->sid) == 0)
269                         return domain;
270         }
271
272         /* Not found */
273
274         return NULL;
275 }
276
277 /* Lookup a sid in a domain from a name */
278
279 BOOL winbindd_lookup_sid_by_name(struct winbindd_domain *domain, 
280                                  const char *name, DOM_SID *sid, 
281                                  enum SID_NAME_USE *type)
282 {
283         NTSTATUS result;
284         
285         /* Don't bother with machine accounts */
286         
287         if (name[strlen(name) - 1] == '$')
288                 return False;
289
290         /* Lookup name */
291         result = domain->methods->name_to_sid(domain, name, sid, type);
292         
293         /* Return rid and type if lookup successful */
294         if (!NT_STATUS_IS_OK(result)) {
295                 *type = SID_NAME_UNKNOWN;
296         }
297
298         return NT_STATUS_IS_OK(result);
299 }
300
301 /**
302  * @brief Lookup a name in a domain from a sid.
303  *
304  * @param sid Security ID you want to look up.
305  *
306  * @param name On success, set to the name corresponding to @p sid.
307  * 
308  * @param dom_name On success, set to the 'domain name' corresponding to @p sid.
309  * 
310  * @param type On success, contains the type of name: alias, group or
311  * user.
312  *
313  * @retval True if the name exists, in which case @p name and @p type
314  * are set, otherwise False.
315  **/
316 BOOL winbindd_lookup_name_by_sid(DOM_SID *sid,
317                                  fstring dom_name,
318                                  fstring name,
319                                  enum SID_NAME_USE *type)
320 {
321         char *names;
322         NTSTATUS result;
323         TALLOC_CTX *mem_ctx;
324         BOOL rv = False;
325         struct winbindd_domain *domain;
326
327         domain = find_domain_from_sid(sid);
328
329         if (!domain) {
330                 DEBUG(1,("Can't find domain from sid\n"));
331                 return False;
332         }
333
334         /* Lookup name */
335
336         if (!(mem_ctx = talloc_init_named("winbindd_lookup_name_by_sid")))
337                 return False;
338         
339         result = domain->methods->sid_to_name(domain, mem_ctx, sid, &names, type);
340
341         /* Return name and type if successful */
342         
343         if ((rv = NT_STATUS_IS_OK(result))) {
344                 fstrcpy(dom_name, domain->name);
345                 fstrcpy(name, names);
346         } else {
347                 *type = SID_NAME_UNKNOWN;
348                 fstrcpy(name, name_deadbeef);
349         }
350         
351         talloc_destroy(mem_ctx);
352
353         return rv;
354 }
355
356
357 /* Free state information held for {set,get,end}{pw,gr}ent() functions */
358
359 void free_getent_state(struct getent_state *state)
360 {
361         struct getent_state *temp;
362
363         /* Iterate over state list */
364
365         temp = state;
366
367         while(temp != NULL) {
368                 struct getent_state *next;
369
370                 /* Free sam entries then list entry */
371
372                 SAFE_FREE(state->sam_entries);
373                 DLIST_REMOVE(state, state);
374                 next = temp->next;
375
376                 SAFE_FREE(temp);
377                 temp = next;
378         }
379 }
380
381 /* Parse winbindd related parameters */
382
383 BOOL winbindd_param_init(void)
384 {
385         /* Parse winbind uid and winbind_gid parameters */
386
387         if (!lp_winbind_uid(&server_state.uid_low, &server_state.uid_high)) {
388                 DEBUG(0, ("winbind uid range missing or invalid\n"));
389                 return False;
390         }
391         
392         if (!lp_winbind_gid(&server_state.gid_low, &server_state.gid_high)) {
393                 DEBUG(0, ("winbind gid range missing or invalid\n"));
394                 return False;
395         }
396         
397         return True;
398 }
399
400 /* Check if a domain is present in a comma-separated list of domains */
401
402 BOOL check_domain_env(char *domain_env, char *domain)
403 {
404         fstring name;
405         const char *tmp = domain_env;
406
407         while(next_token(&tmp, name, ",", sizeof(fstring))) {
408                 if (strequal(name, domain))
409                         return True;
410         }
411
412         return False;
413 }
414
415 /* Parse a string of the form DOMAIN/user into a domain and a user */
416
417 BOOL parse_domain_user(const char *domuser, fstring domain, fstring user)
418 {
419         char *p = strchr(domuser,*lp_winbind_separator());
420
421         if (!(p || lp_winbind_use_default_domain()))
422                 return False;
423         
424         if(!p && lp_winbind_use_default_domain()) {
425                 fstrcpy(user, domuser);
426                 fstrcpy(domain, lp_workgroup());
427         } else {
428                 fstrcpy(user, p+1);
429                 fstrcpy(domain, domuser);
430                 domain[PTR_DIFF(p, domuser)] = 0;
431         }
432         strupper(domain);
433         return True;
434 }
435
436 /*
437     Fill DOMAIN\\USERNAME entry accounting 'winbind use default domain' and
438     'winbind separator' options.
439     This means:
440         - omit DOMAIN when 'winbind use default domain = true' and DOMAIN is
441         lp_workgroup
442          
443 */
444 void fill_domain_username(fstring name, const char *domain, const char *user)
445 {
446         if(lp_winbind_use_default_domain() &&
447             !strcmp(lp_workgroup(), domain)) {
448                 strlcpy(name, user, sizeof(fstring));
449         } else {
450                 slprintf(name, sizeof(fstring) - 1, "%s%s%s",
451                          domain, lp_winbind_separator(),
452                          user);
453         }
454 }
455
456 /*
457  * Winbindd socket accessor functions
458  */
459
460 /* Open the winbindd socket */
461
462 static int _winbindd_socket = -1;
463
464 int open_winbindd_socket(void)
465 {
466         if (_winbindd_socket == -1) {
467                 _winbindd_socket = create_pipe_sock(
468                         WINBINDD_SOCKET_DIR, WINBINDD_SOCKET_NAME, 0755);
469                 DEBUG(10, ("open_winbindd_socket: opened socket fd %d\n",
470                            _winbindd_socket));
471         }
472
473         return _winbindd_socket;
474 }
475
476 /* Close the winbindd socket */
477
478 void close_winbindd_socket(void)
479 {
480         if (_winbindd_socket != -1) {
481                 DEBUG(10, ("close_winbindd_socket: closing socket fd %d\n",
482                            _winbindd_socket));
483                 close(_winbindd_socket);
484                 _winbindd_socket = -1;
485         }
486 }
487
488 /*
489  * Client list accessor functions
490  */
491
492 static struct winbindd_cli_state *_client_list;
493 static int _num_clients;
494
495 /* Return list of all connected clients */
496
497 struct winbindd_cli_state *winbindd_client_list(void)
498 {
499         return _client_list;
500 }
501
502 /* Add a connection to the list */
503
504 void winbindd_add_client(struct winbindd_cli_state *cli)
505 {
506         DLIST_ADD(_client_list, cli);
507         _num_clients++;
508 }
509
510 /* Remove a client from the list */
511
512 void winbindd_remove_client(struct winbindd_cli_state *cli)
513 {
514         DLIST_REMOVE(_client_list, cli);
515         _num_clients--;
516 }
517
518 /* Close all open clients */
519
520 void winbindd_kill_all_clients(void)
521 {
522         struct winbindd_cli_state *cl = winbindd_client_list();
523
524         DEBUG(10, ("winbindd_kill_all_clients: going postal\n"));
525
526         while (cl) {
527                 struct winbindd_cli_state *next;
528                 
529                 next = cl->next;
530                 winbindd_remove_client(cl);
531                 cl = next;
532         }
533 }
534
535 /* Return number of open clients */
536
537 int winbindd_num_clients(void)
538 {
539         return _num_clients;
540 }