Fixup JF's weird SID return :-).
[ira/wip.git] / source3 / lib / util_sid.c
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    Samba utility functions
5    Copyright (C) Andrew Tridgell 1992-1998
6    Copyright (C) Luke Kenneth Caseson Leighton 1998-1999
7    Copyright (C) Jeremy Allison  1999
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 "includes.h"
25
26 DOM_SID global_sam_sid;
27 extern pstring global_myname;
28 extern fstring global_myworkgroup;
29
30 /*
31  * Some useful sids
32  */
33
34 DOM_SID global_sid_Builtin;                             /* Local well-known domain */
35 DOM_SID global_sid_World_Domain;                /* Everyone domain */
36 DOM_SID global_sid_World;                               /* Everyone */
37 DOM_SID global_sid_Creator_Owner_Domain;    /* Creator Owner domain */
38 DOM_SID global_sid_Creator_Owner;               /* Creator Owner */
39 DOM_SID global_sid_NT_Authority;                /* NT Authority */
40 DOM_SID global_sid_NULL;                        /* NULL sid */
41 DOM_SID global_sid_Builtin_Guests;                      /* Builtin guest users */
42 DOM_SID global_sid_Authenticated_Users;         /* All authenticated rids */
43 DOM_SID global_sid_Network;                                     /* Network rids */
44 DOM_SID global_sid_Anonymous;                           /* Anonymous login */
45 DOM_SID global_sid_nonexistent;                 /* S-0-0. Used in Lsa level 3. */
46
47 const DOM_SID *global_sid_everyone = &global_sid_World;
48
49 typedef struct _known_sid_users {
50         uint32 rid;
51         enum SID_NAME_USE sid_name_use;
52         char *known_user_name;
53 } known_sid_users;
54
55 /* static known_sid_users no_users[] = {{0, 0, NULL}}; */
56
57 static known_sid_users everyone_users[] = {
58         { 0, SID_NAME_WKN_GRP, "Everyone" },
59         {0, (enum SID_NAME_USE)0, NULL}};
60
61 static known_sid_users creator_owner_users[] = {
62         { 0, SID_NAME_ALIAS, "Creator Owner" },
63         {0, (enum SID_NAME_USE)0, NULL}};
64
65 static known_sid_users nt_authority_users[] = {
66         {  1, SID_NAME_ALIAS, "Dialup" },
67         {  2, SID_NAME_ALIAS, "Network"},
68         {  3, SID_NAME_ALIAS, "Batch"},
69         {  4, SID_NAME_ALIAS, "Interactive"},
70         {  6, SID_NAME_ALIAS, "Service"},
71         {  7, SID_NAME_ALIAS, "AnonymousLogon"},
72         {  8, SID_NAME_ALIAS, "Proxy"},
73         {  9, SID_NAME_ALIAS, "ServerLogon"},
74         { 11, SID_NAME_ALIAS, "Authenticated Users"},
75         { 18, SID_NAME_ALIAS, "SYSTEM"},
76         {  0, (enum SID_NAME_USE)0, NULL}};
77
78 static known_sid_users builtin_groups[] = {
79         { BUILTIN_ALIAS_RID_ADMINS, SID_NAME_ALIAS, "Administrators" },
80         { BUILTIN_ALIAS_RID_USERS, SID_NAME_ALIAS, "Users" },
81         { BUILTIN_ALIAS_RID_GUESTS, SID_NAME_ALIAS, "Guests" },
82         { BUILTIN_ALIAS_RID_ACCOUNT_OPS, SID_NAME_ALIAS, "Account Operators" },
83         { BUILTIN_ALIAS_RID_SYSTEM_OPS, SID_NAME_ALIAS, "Server Operators" },
84         { BUILTIN_ALIAS_RID_PRINT_OPS, SID_NAME_ALIAS, "Print Operators" },
85         { BUILTIN_ALIAS_RID_BACKUP_OPS, SID_NAME_ALIAS, "Backup Operators" },
86         {  0, (enum SID_NAME_USE)0, NULL}};
87
88 #define MAX_SID_NAMES   7
89
90 static struct sid_name_map_info
91 {
92         DOM_SID *sid;
93         char *name;
94         known_sid_users *known_users;
95 } sid_name_map[MAX_SID_NAMES];
96
97 static BOOL sid_name_map_initialized = False;
98
99 /*
100  * An NT compatible anonymous token.
101  */
102
103 static DOM_SID anon_sid_array[3];
104
105 NT_USER_TOKEN anonymous_token = {
106     3,
107     anon_sid_array
108 };
109
110 /**************************************************************************
111  quick init function
112  *************************************************************************/
113 static void init_sid_name_map (void)
114 {
115         int i = 0;
116         
117         if (sid_name_map_initialized) return;
118         
119
120         if ((lp_security() == SEC_USER) && lp_domain_logons()) {
121                 sid_name_map[i].sid = &global_sam_sid;
122                 sid_name_map[i].name = global_myworkgroup;
123                 sid_name_map[i].known_users = NULL;
124                 i++;
125                 sid_name_map[i].sid = &global_sam_sid;
126                 sid_name_map[i].name = global_myname;
127                 sid_name_map[i].known_users = NULL;
128                 i++;
129         }
130         else {
131                 sid_name_map[i].sid = &global_sam_sid;
132                 sid_name_map[i].name = global_myname;
133                 sid_name_map[i].known_users = NULL;
134                 i++;
135         }
136
137         sid_name_map[i].sid = &global_sid_Builtin;
138         sid_name_map[i].name = "BUILTIN";
139         sid_name_map[i].known_users = &builtin_groups[0];
140         i++;
141         
142         sid_name_map[i].sid = &global_sid_World_Domain;
143         sid_name_map[i].name = "";
144         sid_name_map[i].known_users = &everyone_users[0];
145         i++;
146
147         sid_name_map[i].sid = &global_sid_Creator_Owner_Domain;
148         sid_name_map[i].name = "";
149         sid_name_map[i].known_users = &creator_owner_users[0];
150         i++;
151                 
152         sid_name_map[i].sid = &global_sid_NT_Authority;
153         sid_name_map[i].name = "NT Authority";
154         sid_name_map[i].known_users = &nt_authority_users[0];
155         i++;
156                 
157
158         /* end of array */
159         sid_name_map[i].sid = NULL;
160         sid_name_map[i].name = NULL;
161         sid_name_map[i].known_users = NULL;
162         
163         sid_name_map_initialized = True;
164                 
165         return;
166
167 }
168
169 /****************************************************************************
170  Creates some useful well known sids
171 ****************************************************************************/
172
173 void generate_wellknown_sids(void)
174 {
175         string_to_sid(&global_sid_Builtin, "S-1-5-32");
176         string_to_sid(&global_sid_Builtin_Guests, "S-1-5-32-546");
177         string_to_sid(&global_sid_World_Domain, "S-1-1");
178         string_to_sid(&global_sid_World, "S-1-1-0");
179         string_to_sid(&global_sid_Creator_Owner_Domain, "S-1-3");
180         string_to_sid(&global_sid_Creator_Owner, "S-1-3-0");
181         string_to_sid(&global_sid_NT_Authority, "S-1-5");
182         string_to_sid(&global_sid_NULL, "S-1-0-0");
183         string_to_sid(&global_sid_Authenticated_Users, "S-1-5-11");
184         string_to_sid(&global_sid_Network, "S-1-5-2");
185         string_to_sid(&global_sid_Anonymous, "S-1-5-7");
186         string_to_sid(&global_sid_nonexistent, "S-0-0"); /* Used in Lsa level 3. */
187
188         /* Create the anon token. */
189         sid_copy( &anonymous_token.user_sids[0], &global_sid_World);
190         sid_copy( &anonymous_token.user_sids[1], &global_sid_Network);
191         sid_copy( &anonymous_token.user_sids[2], &global_sid_Anonymous);
192 }
193
194 /**************************************************************************
195  Turns a domain SID into a name, returned in the nt_domain argument.
196 ***************************************************************************/
197
198 BOOL map_domain_sid_to_name(DOM_SID *sid, char *nt_domain)
199 {
200         fstring sid_str;
201         int i = 0;
202         
203         sid_to_string(sid_str, sid);
204
205         if (!sid_name_map_initialized) 
206                 init_sid_name_map();
207
208         DEBUG(5,("map_domain_sid_to_name: %s\n", sid_str));
209
210         if (nt_domain == NULL)
211                 return False;
212
213         while (sid_name_map[i].sid != NULL) {
214                 sid_to_string(sid_str, sid_name_map[i].sid);
215                 DEBUG(5,("map_domain_sid_to_name: compare: %s\n", sid_str));
216                 if (sid_equal(sid_name_map[i].sid, sid)) {              
217                         fstrcpy(nt_domain, sid_name_map[i].name);
218                         DEBUG(5,("map_domain_sid_to_name: found '%s'\n", nt_domain));
219                         return True;
220                 }
221                 i++;
222         }
223
224         DEBUG(5,("map_domain_sid_to_name: mapping for %s not found\n", sid_str));
225
226     return False;
227 }
228
229 /**************************************************************************
230  Looks up a known username from one of the known domains.
231 ***************************************************************************/
232
233 BOOL lookup_known_rid(DOM_SID *sid, uint32 rid, char *name, enum SID_NAME_USE *psid_name_use)
234 {
235         int i = 0;
236         struct sid_name_map_info *psnm;
237
238         if (!sid_name_map_initialized) 
239                 init_sid_name_map();
240
241         for(i = 0; sid_name_map[i].sid != NULL; i++) {
242                 psnm = &sid_name_map[i];
243                 if(sid_equal(psnm->sid, sid)) {
244                         int j;
245                         for(j = 0; psnm->known_users && psnm->known_users[j].known_user_name != NULL; j++) {
246                                 if(rid == psnm->known_users[j].rid) {
247                                         DEBUG(5,("lookup_builtin_rid: rid = %u, domain = '%s', user = '%s'\n",
248                                                 (unsigned int)rid, psnm->name, psnm->known_users[j].known_user_name ));
249                                         fstrcpy( name, psnm->known_users[j].known_user_name);
250                                         *psid_name_use = psnm->known_users[j].sid_name_use;
251                                         return True;
252                                 }
253                         }
254                 }
255         }
256
257         return False;
258 }
259
260 /**************************************************************************
261  Turns a domain name into a SID.
262  *** side-effect: if the domain name is NULL, it is set to our domain ***
263 ***************************************************************************/
264
265 BOOL map_domain_name_to_sid(DOM_SID *sid, char *nt_domain)
266 {
267         int i = 0;
268
269         if (nt_domain == NULL) {
270                 DEBUG(5,("map_domain_name_to_sid: mapping NULL domain to our SID.\n"));
271                 sid_copy(sid, &global_sam_sid);
272                 return True;
273         }
274
275         if (nt_domain[0] == 0) {
276                 fstrcpy(nt_domain, global_myname);
277                 DEBUG(5,("map_domain_name_to_sid: overriding blank name to %s\n", nt_domain));
278                 sid_copy(sid, &global_sam_sid);
279                 return True;
280         }
281
282         DEBUG(5,("map_domain_name_to_sid: %s\n", nt_domain));
283
284         if (!sid_name_map_initialized) 
285                 init_sid_name_map();
286
287         while (sid_name_map[i].name != NULL) {
288                 DEBUG(5,("map_domain_name_to_sid: compare: %s\n", sid_name_map[i].name));
289                 if (strequal(sid_name_map[i].name, nt_domain)) {
290                         fstring sid_str;
291                         sid_copy(sid, sid_name_map[i].sid);
292                         sid_to_string(sid_str, sid_name_map[i].sid);
293                         DEBUG(5,("map_domain_name_to_sid: found %s\n", sid_str));
294                         return True;
295                 }
296                 i++;
297         }
298
299         DEBUG(0,("map_domain_name_to_sid: mapping to %s not found.\n", nt_domain));
300         return False;
301 }
302
303 /**************************************************************************
304  Splits a name of format \DOMAIN\name or name into its two components.
305  Sets the DOMAIN name to global_myname if it has not been specified.
306 ***************************************************************************/
307
308 void split_domain_name(const char *fullname, char *domain, char *name)
309 {
310         pstring full_name;
311         char *p, *sep;
312
313         sep = lp_winbind_separator();
314
315         *domain = *name = '\0';
316
317         if (fullname[0] == sep[0] || fullname[0] == '\\')
318                 fullname++;
319
320         pstrcpy(full_name, fullname);
321         p = strchr_m(full_name+1, '\\');
322         if (!p) p = strchr_m(full_name+1, sep[0]);
323
324         if (p != NULL) {
325                 *p = 0;
326                 fstrcpy(domain, full_name);
327                 fstrcpy(name, p+1);
328         } else {
329                 fstrcpy(domain, global_myname);
330                 fstrcpy(name, full_name);
331         }
332
333         DEBUG(10,("split_domain_name:name '%s' split into domain :'%s' and user :'%s'\n",
334                         fullname, domain, name));
335 }
336
337 /*****************************************************************
338  Convert a SID to an ascii string.
339 *****************************************************************/
340
341 char *sid_to_string(fstring sidstr_out, DOM_SID *sid)
342 {
343   char subauth[16];
344   int i;
345   /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
346   uint32 ia = (sid->id_auth[5]) +
347               (sid->id_auth[4] << 8 ) +
348               (sid->id_auth[3] << 16) +
349               (sid->id_auth[2] << 24);
350
351   slprintf(sidstr_out, sizeof(fstring) - 1, "S-%u-%lu", (unsigned int)sid->sid_rev_num, (unsigned long)ia);
352
353   for (i = 0; i < sid->num_auths; i++) {
354     slprintf(subauth, sizeof(subauth)-1, "-%lu", (unsigned long)sid->sub_auths[i]);
355     fstrcat(sidstr_out, subauth);
356   }
357
358   return sidstr_out;
359 }
360
361 /*****************************************************************
362  Convert a string to a SID. Returns True on success, False on fail.
363 *****************************************************************/  
364    
365 BOOL string_to_sid(DOM_SID *sidout, const char *sidstr)
366 {
367   pstring tok;
368   const char *p = sidstr;
369   /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
370   uint32 ia;
371
372   memset((char *)sidout, '\0', sizeof(DOM_SID));
373
374   if (StrnCaseCmp( sidstr, "S-", 2)) {
375     DEBUG(0,("string_to_sid: Sid %s does not start with 'S-'.\n", sidstr));
376     return False;
377   }
378
379   p += 2;
380   if (!next_token(&p, tok, "-", sizeof(tok))) {
381     DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
382     return False;
383   }
384
385   /* Get the revision number. */
386   sidout->sid_rev_num = (uint8)strtoul(tok, NULL, 10);
387
388   if (!next_token(&p, tok, "-", sizeof(tok))) {
389     DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
390     return False;
391   }
392
393   /* identauth in decimal should be <  2^32 */
394   ia = (uint32)strtoul(tok, NULL, 10);
395
396   /* NOTE - the ia value is in big-endian format. */
397   sidout->id_auth[0] = 0;
398   sidout->id_auth[1] = 0;
399   sidout->id_auth[2] = (ia & 0xff000000) >> 24;
400   sidout->id_auth[3] = (ia & 0x00ff0000) >> 16;
401   sidout->id_auth[4] = (ia & 0x0000ff00) >> 8;
402   sidout->id_auth[5] = (ia & 0x000000ff);
403
404   sidout->num_auths = 0;
405
406   while(next_token(&p, tok, "-", sizeof(tok)) && 
407         sidout->num_auths < MAXSUBAUTHS) {
408     /* 
409      * NOTE - the subauths are in native machine-endian format. They
410      * are converted to little-endian when linearized onto the wire.
411      */
412         sid_append_rid(sidout, (uint32)strtoul(tok, NULL, 10));
413   }
414
415   return True;
416 }
417
418 /*****************************************************************
419  Add a rid to the end of a sid
420 *****************************************************************/  
421
422 BOOL sid_append_rid(DOM_SID *sid, uint32 rid)
423 {
424         if (sid->num_auths < MAXSUBAUTHS) {
425                 sid->sub_auths[sid->num_auths++] = rid;
426                 return True;
427         }
428         return False;
429 }
430
431 /*****************************************************************
432  Removes the last rid from the end of a sid
433 *****************************************************************/  
434
435 BOOL sid_split_rid(DOM_SID *sid, uint32 *rid)
436 {
437         if (sid->num_auths > 0) {
438                 sid->num_auths--;
439                 *rid = sid->sub_auths[sid->num_auths];
440                 return True;
441         }
442         return False;
443 }
444
445 /*****************************************************************
446  Return the last rid from the end of a sid
447 *****************************************************************/  
448
449 BOOL sid_peek_rid(DOM_SID *sid, uint32 *rid)
450 {
451         if (sid->num_auths > 0) {
452                 *rid = sid->sub_auths[sid->num_auths - 1];
453                 return True;
454         }
455         return False;
456 }
457
458 /*****************************************************************
459  Copies a sid
460 *****************************************************************/  
461
462 void sid_copy(DOM_SID *dst, const DOM_SID *src)
463 {
464         int i;
465
466         memset((char *)dst, '\0', sizeof(DOM_SID));
467
468         dst->sid_rev_num = src->sid_rev_num;
469         dst->num_auths = src->num_auths;
470
471         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
472
473         for (i = 0; i < src->num_auths; i++)
474                 dst->sub_auths[i] = src->sub_auths[i];
475 }
476
477 /*****************************************************************
478  Duplicates a sid - mallocs the target.
479 *****************************************************************/
480
481 DOM_SID *sid_dup(DOM_SID *src)
482 {
483   DOM_SID *dst;
484
485   if(!src)
486     return NULL;
487
488   if((dst = malloc(sizeof(DOM_SID))) != NULL) {
489         memset(dst, '\0', sizeof(DOM_SID));
490         sid_copy( dst, src);
491   }
492
493   return dst;
494 }
495
496 /*****************************************************************
497  Write a sid out into on-the-wire format.
498 *****************************************************************/  
499 BOOL sid_linearize(char *outbuf, size_t len, DOM_SID *sid)
500 {
501         size_t i;
502
503         if (len < sid_size(sid))
504                 return False;
505
506         SCVAL(outbuf,0,sid->sid_rev_num);
507         SCVAL(outbuf,1,sid->num_auths);
508         memcpy(&outbuf[2], sid->id_auth, 6);
509         for(i = 0; i < sid->num_auths; i++)
510                 SIVAL(outbuf, 8 + (i*4), sid->sub_auths[i]);
511
512         return True;
513 }
514
515 /*****************************************************************
516  parse a on-the-wire SID to a DOM_SID
517 *****************************************************************/  
518 BOOL sid_parse(char *inbuf, size_t len, DOM_SID *sid)
519 {
520         int i;
521         if (len < 8) return False;
522         sid->sid_rev_num = CVAL(inbuf, 0);
523         sid->num_auths = CVAL(inbuf, 1);
524         memcpy(sid->id_auth, inbuf+2, 6);
525         if (len < 8 + sid->num_auths*4) return False;
526         for (i=0;i<sid->num_auths;i++) {
527                 sid->sub_auths[i] = IVAL(inbuf, 8+i*4);
528         }
529         return True;
530 }
531
532
533 /*****************************************************************
534  Compare the domain portion of two sids.
535 *****************************************************************/  
536 int sid_compare_domain(const DOM_SID *sid1, const DOM_SID *sid2)
537 {
538         int i;
539
540         if (sid1 == sid2) return 0;
541         if (!sid1) return -1;
542         if (!sid2) return 1;
543
544         if (sid1->sid_rev_num != sid2->sid_rev_num)
545                 return sid1->sid_rev_num - sid2->sid_rev_num;
546
547         for (i = 0; i < 6; i++)
548                 if (sid1->id_auth[i] != sid2->id_auth[i])
549                         return sid1->id_auth[i] - sid2->id_auth[i];
550
551         return 0;
552 }
553
554 /*****************************************************************
555  Compare two sids.
556 *****************************************************************/  
557 int sid_compare(const DOM_SID *sid1, const DOM_SID *sid2)
558 {
559         int i;
560
561         if (sid1 == sid2) return 0;
562         if (!sid1) return -1;
563         if (!sid2) return 1;
564
565         /* compare most likely different rids, first: i.e start at end */
566         if (sid1->num_auths != sid2->num_auths)
567                 return sid1->num_auths - sid2->num_auths;
568
569         for (i = sid1->num_auths-1; i >= 0; --i)
570                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
571                         return sid1->sub_auths[i] - sid2->sub_auths[i];
572
573         return sid_compare_domain(sid1, sid2);
574 }
575
576
577 /*****************************************************************
578  Compare two sids.
579 *****************************************************************/  
580 BOOL sid_equal(const DOM_SID *sid1, const DOM_SID *sid2)
581 {
582         return sid_compare(sid1, sid2) == 0;
583 }
584
585
586 /*****************************************************************
587  Check if the SID is our domain SID (S-1-5-21-x-y-z).
588 *****************************************************************/  
589 BOOL sid_check_is_domain(const DOM_SID *sid)
590 {
591         return sid_equal(sid, &global_sam_sid);
592 }
593
594
595 /*****************************************************************
596  Check if the SID is the builtin SID (S-1-5-32).
597 *****************************************************************/  
598 BOOL sid_check_is_builtin(const DOM_SID *sid)
599 {
600         return sid_equal(sid, &global_sid_Builtin);
601 }
602
603
604 /*****************************************************************
605  Check if the SID is our domain SID (S-1-5-21-x-y-z).
606 *****************************************************************/  
607 BOOL sid_check_is_in_our_domain(const DOM_SID *sid)
608 {
609         DOM_SID dom_sid;
610         uint32 rid;
611
612         sid_copy(&dom_sid, sid);
613         sid_split_rid(&dom_sid, &rid);
614         
615         return sid_equal(&dom_sid, &global_sam_sid);
616 }
617
618 /*****************************************************************
619  Check if the SID is our domain SID (S-1-5-21-x-y-z).
620 *****************************************************************/  
621 BOOL sid_check_is_in_builtin(const DOM_SID *sid)
622 {
623         DOM_SID dom_sid;
624         uint32 rid;
625
626         sid_copy(&dom_sid, sid);
627         sid_split_rid(&dom_sid, &rid);
628         
629         return sid_equal(&dom_sid, &global_sid_Builtin);
630 }
631
632
633 /*****************************************************************
634  Calculates size of a sid.
635 *****************************************************************/  
636
637 size_t sid_size(DOM_SID *sid)
638 {
639         if (sid == NULL)
640                 return 0;
641
642         return sid->num_auths * sizeof(uint32) + 8;
643 }
644
645 /*****************************************************************
646  Returns true if SID is internal (and non-mappable).
647 *****************************************************************/
648
649 BOOL non_mappable_sid(DOM_SID *sid)
650 {
651         DOM_SID dom;
652         uint32 rid;
653
654         sid_copy(&dom, sid);
655         sid_split_rid(&dom, &rid);
656
657         if (sid_equal(&dom, &global_sid_Builtin))
658                 return True;
659
660         if (sid_equal(&dom, &global_sid_Creator_Owner_Domain))
661                 return True;
662  
663         if (sid_equal(&dom, &global_sid_NT_Authority))
664                 return True;
665
666         return False;
667 }
668
669 /*
670   return the binary string representation of a DOM_SID
671   caller must free
672 */
673 char *sid_binstring(DOM_SID *sid)
674 {
675         char *buf, *s;
676         int len = sid_size(sid);
677         buf = malloc(len);
678         if (!buf) return NULL;
679         sid_linearize(buf, len, sid);
680         s = binary_string(buf, len);
681         free(buf);
682         return s;
683 }
684