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
  27 extern int DEBUGLEVEL;
  28 DOM_SID global_sam_sid;
  29 extern pstring global_myname;
  30 extern fstring global_myworkgroup;
  31
  32 /*
  33  * Some useful sids
  34  */
  35
  36 DOM_SID global_sid_Builtin;                             /* Local well-known domain */
  37 DOM_SID global_sid_World_Domain;                /* Everyone domain */
  38 DOM_SID global_sid_World;                               /* Everyone */
  39 DOM_SID global_sid_Creator_Owner_Domain;    /* Creator Owner domain */
  40 DOM_SID global_sid_Creator_Owner;               /* Creator Owner */
  41 DOM_SID global_sid_NT_Authority;                /* NT Authority */
  42 DOM_SID global_sid_NULL;                        /* NULL sid */
  43 DOM_SID global_sid_Builtin_Guests;                      /* Builtin guest users */
  44 DOM_SID global_sid_Authenticated_Users;         /* All authenticated rids */
  45 DOM_SID global_sid_Network;                                     /* Network rids */
  46 DOM_SID global_sid_Anonymous;                           /* Anonymous login */
  47
  48 const DOM_SID *global_sid_everyone = &global_sid_World;
  49
  50 typedef struct _known_sid_users {
  51         uint32 rid;
  52         enum SID_NAME_USE sid_name_use;
  53         char *known_user_name;
  54 } known_sid_users;
  55
  56 /* static known_sid_users no_users[] = {{0, 0, NULL}}; */
  57
  58 static known_sid_users everyone_users[] = {
  59         { 0, SID_NAME_WKN_GRP, "Everyone" },
  60         {0, (enum SID_NAME_USE)0, NULL}};
  61
  62 static known_sid_users creator_owner_users[] = {
  63         { 0, SID_NAME_ALIAS, "Creator Owner" },
  64         {0, (enum SID_NAME_USE)0, NULL}};
  65
  66 static known_sid_users nt_authority_users[] = {
  67         {  1, SID_NAME_ALIAS, "Dialup" },
  68         {  2, SID_NAME_ALIAS, "Network"},
  69         {  3, SID_NAME_ALIAS, "Batch"},
  70         {  4, SID_NAME_ALIAS, "Interactive"},
  71         {  6, SID_NAME_ALIAS, "Service"},
  72         {  7, SID_NAME_ALIAS, "AnonymousLogon"},
  73         {  8, SID_NAME_ALIAS, "Proxy"},
  74         {  9, SID_NAME_ALIAS, "ServerLogon"},
  75         { 11, SID_NAME_ALIAS, "Authenticated Users"},
  76         { 18, SID_NAME_ALIAS, "SYSTEM"},
  77         {  0, (enum SID_NAME_USE)0, NULL}};
  78
  79 static known_sid_users builtin_groups[] = {
  80         { BUILTIN_ALIAS_RID_ADMINS, SID_NAME_ALIAS, "Administrators" },
  81         { BUILTIN_ALIAS_RID_USERS, SID_NAME_ALIAS, "Users" },
  82         { BUILTIN_ALIAS_RID_GUESTS, SID_NAME_ALIAS, "Guests" },
  83         { BUILTIN_ALIAS_RID_ACCOUNT_OPS, SID_NAME_ALIAS, "Account Operators" },
  84         { BUILTIN_ALIAS_RID_SYSTEM_OPS, SID_NAME_ALIAS, "Server Operators" },
  85         { BUILTIN_ALIAS_RID_PRINT_OPS, SID_NAME_ALIAS, "Print Operators" },
  86         { BUILTIN_ALIAS_RID_BACKUP_OPS, SID_NAME_ALIAS, "Backup Operators" },
  87         {  0, (enum SID_NAME_USE)0, NULL}};
  88
  89 #define MAX_SID_NAMES   7
  90
  91 static struct sid_name_map_info
  92 {
  93         DOM_SID *sid;
  94         char *name;
  95         known_sid_users *known_users;
  96 } sid_name_map[MAX_SID_NAMES];
  97
  98 static BOOL sid_name_map_initialized = False;
  99
 100 /*
 101  * An NT compatible anonymous token.
 102  */
 103
 104 static DOM_SID anon_sid_array[3];
 105
 106 NT_USER_TOKEN anonymous_token = {
 107     3,
 108     anon_sid_array
 109 };
 110
 111 /**************************************************************************
 112  quick init function
 113  *************************************************************************/
 114 static void init_sid_name_map (void)
 115 {
 116         int i = 0;
 117
 118         if (sid_name_map_initialized) return;
 119
 120
 121         if ((lp_security() == SEC_USER) && lp_domain_logons()) {
 122                 sid_name_map[i].sid = &global_sam_sid;
 123                 sid_name_map[i].name = global_myworkgroup;
 124                 sid_name_map[i].known_users = NULL;
 125                 i++;
 126                 sid_name_map[i].sid = &global_sam_sid;
 127                 sid_name_map[i].name = global_myname;
 128                 sid_name_map[i].known_users = NULL;
 129                 i++;
 130         }
 131         else {
 132                 sid_name_map[i].sid = &global_sam_sid;
 133                 sid_name_map[i].name = global_myname;
 134                 sid_name_map[i].known_users = NULL;
 135                 i++;
 136         }
 137
 138         sid_name_map[i].sid = &global_sid_Builtin;
 139         sid_name_map[i].name = "BUILTIN";
 140         sid_name_map[i].known_users = &builtin_groups[0];
 141         i++;
 142
 143         sid_name_map[i].sid = &global_sid_World_Domain;
 144         sid_name_map[i].name = "";
 145         sid_name_map[i].known_users = &everyone_users[0];
 146         i++;
 147
 148         sid_name_map[i].sid = &global_sid_Creator_Owner_Domain;
 149         sid_name_map[i].name = "";
 150         sid_name_map[i].known_users = &creator_owner_users[0];
 151         i++;
 152
 153         sid_name_map[i].sid = &global_sid_NT_Authority;
 154         sid_name_map[i].name = "NT Authority";
 155         sid_name_map[i].known_users = &nt_authority_users[0];
 156         i++;
 157
 158
 159         /* end of array */
 160         sid_name_map[i].sid = NULL;
 161         sid_name_map[i].name = NULL;
 162         sid_name_map[i].known_users = NULL;
 163
 164         sid_name_map_initialized = True;
 165
 166         return;
 167
 168 }
 169
 170 /****************************************************************************
 171  Creates some useful well known sids
 172 ****************************************************************************/
 173
 174 void generate_wellknown_sids(void)
 175 {
 176         string_to_sid(&global_sid_Builtin, "S-1-5-32");
 177         string_to_sid(&global_sid_Builtin_Guests, "S-1-5-32-546");
 178         string_to_sid(&global_sid_World_Domain, "S-1-1");
 179         string_to_sid(&global_sid_World, "S-1-1-0");
 180         string_to_sid(&global_sid_Creator_Owner_Domain, "S-1-3");
 181         string_to_sid(&global_sid_Creator_Owner, "S-1-3-0");
 182         string_to_sid(&global_sid_NT_Authority, "S-1-5");
 183         string_to_sid(&global_sid_NULL, "S-1-0-0");
 184         string_to_sid(&global_sid_Authenticated_Users, "S-1-5-11");
 185         string_to_sid(&global_sid_Network, "S-1-5-2");
 186         string_to_sid(&global_sid_Anonymous, "S-1-5-7");
 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, char *sidstr)
 366 {
 367   pstring tok;
 368   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   DEBUG(7,("string_to_sid: converted SID %s ok\n", sidstr));
 416
 417   return True;
 418 }
 419
 420 /*****************************************************************
 421  Add a rid to the end of a sid
 422 *****************************************************************/
 423
 424 BOOL sid_append_rid(DOM_SID *sid, uint32 rid)
 425 {
 426         if (sid->num_auths < MAXSUBAUTHS) {
 427                 sid->sub_auths[sid->num_auths++] = rid;
 428                 return True;
 429         }
 430         return False;
 431 }
 432
 433 /*****************************************************************
 434  Removes the last rid from the end of a sid
 435 *****************************************************************/
 436
 437 BOOL sid_split_rid(DOM_SID *sid, uint32 *rid)
 438 {
 439         if (sid->num_auths > 0) {
 440                 sid->num_auths--;
 441                 *rid = sid->sub_auths[sid->num_auths];
 442                 return True;
 443         }
 444         return False;
 445 }
 446
 447 /*****************************************************************
 448  Return the last rid from the end of a sid
 449 *****************************************************************/
 450
 451 BOOL sid_peek_rid(DOM_SID *sid, uint32 *rid)
 452 {
 453         if (sid->num_auths > 0) {
 454                 *rid = sid->sub_auths[sid->num_auths - 1];
 455                 return True;
 456         }
 457         return False;
 458 }
 459
 460 /*****************************************************************
 461  Copies a sid
 462 *****************************************************************/
 463
 464 void sid_copy(DOM_SID *dst, const DOM_SID *src)
 465 {
 466         int i;
 467
 468         memset((char *)dst, '\0', sizeof(DOM_SID));
 469
 470         dst->sid_rev_num = src->sid_rev_num;
 471         dst->num_auths = src->num_auths;
 472
 473         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
 474
 475         for (i = 0; i < src->num_auths; i++)
 476                 dst->sub_auths[i] = src->sub_auths[i];
 477 }
 478
 479 /*****************************************************************
 480  Duplicates a sid - mallocs the target.
 481 *****************************************************************/
 482
 483 DOM_SID *sid_dup(DOM_SID *src)
 484 {
 485   DOM_SID *dst;
 486
 487   if(!src)
 488     return NULL;
 489
 490   if((dst = malloc(sizeof(DOM_SID))) != NULL) {
 491         memset(dst, '\0', sizeof(DOM_SID));
 492         sid_copy( dst, src);
 493   }
 494
 495   return dst;
 496 }
 497
 498 /*****************************************************************
 499  Write a sid out into on-the-wire format.
 500 *****************************************************************/
 501
 502 BOOL sid_linearize(char *outbuf, size_t len, DOM_SID *sid)
 503 {
 504         size_t i;
 505
 506         if(len < sid_size(sid))
 507                 return False;
 508
 509         SCVAL(outbuf,0,sid->sid_rev_num);
 510         SCVAL(outbuf,1,sid->num_auths);
 511         memcpy(&outbuf[2], sid->id_auth, 6);
 512         for(i = 0; i < sid->num_auths; i++)
 513                 SIVAL(outbuf, 8 + (i*4), sid->sub_auths[i]);
 514
 515         return True;
 516 }
 517
 518 /*****************************************************************
 519  Compare two sids.
 520 *****************************************************************/
 521 int sid_compare(const DOM_SID *sid1, const DOM_SID *sid2)
 522 {
 523         int i;
 524
 525         if (sid1 == sid2) return 0;
 526         if (!sid1) return -1;
 527         if (!sid2) return 1;
 528
 529         /* compare most likely different rids, first: i.e start at end */
 530         for (i = sid1->num_auths-1; i >= 0; --i)
 531                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
 532                         return sid1->sub_auths[i] - sid2->sub_auths[i];
 533
 534         if (sid1->num_auths != sid2->num_auths)
 535                 return sid1->num_auths - sid2->num_auths;
 536
 537         if (sid1->sid_rev_num != sid2->sid_rev_num)
 538                 return sid1->sid_rev_num - sid2->sid_rev_num;
 539
 540         for (i = 0; i < 6; i++)
 541                 if (sid1->id_auth[i] != sid2->id_auth[i])
 542                         return sid1->id_auth[i] - sid2->id_auth[i];
 543
 544         return 0;
 545 }
 546
 547
 548 /*****************************************************************
 549  Compare two sids.
 550 *****************************************************************/
 551
 552 BOOL sid_equal(const DOM_SID *sid1, const DOM_SID *sid2)
 553 {
 554         return sid_compare(sid1, sid2) == 0;
 555 }
 556
 557
 558 /*****************************************************************
 559  Calculates size of a sid.
 560 *****************************************************************/
 561
 562 size_t sid_size(DOM_SID *sid)
 563 {
 564         if (sid == NULL)
 565                 return 0;
 566
 567         return sid->num_auths * sizeof(uint32) + 8;
 568 }