source/lib/util_sid.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Andrew Tridgell                1992-1998
   5    Copyright (C) Luke Kenneth Caseson Leighton  1998-1999
   6    Copyright (C) Jeremy Allison                 1999
   7    Copyright (C) Stefan (metze) Metzmacher      2002
   8    Copyright (C) Simo Sorce                     2002
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 #include "includes.h"
  26
  27 /*
  28  * Some useful sids
  29  */
  30
  31 DOM_SID global_sid_World_Domain;                /* Everyone domain */
  32 DOM_SID global_sid_World;                               /* Everyone */
  33 DOM_SID global_sid_Creator_Owner_Domain;    /* Creator Owner domain */
  34 DOM_SID global_sid_NT_Authority;                /* NT Authority */
  35 DOM_SID global_sid_System;              /* System */
  36 DOM_SID global_sid_NULL;                        /* NULL sid */
  37 DOM_SID global_sid_Authenticated_Users;         /* All authenticated rids */
  38 DOM_SID global_sid_Network;                     /* Network rids */
  39
  40 DOM_SID global_sid_Creator_Owner;       /* Creator Owner */
  41 DOM_SID global_sid_Creator_Group;       /* Creator Group */
  42 DOM_SID global_sid_Anonymous;           /* Anonymous login */
  43
  44 DOM_SID global_sid_Builtin;                     /* Local well-known domain */
  45 DOM_SID global_sid_Builtin_Administrators;      /* Builtin administrators */
  46 DOM_SID global_sid_Builtin_Users;               /* Builtin users */
  47 DOM_SID global_sid_Builtin_Guests;              /* Builtin guest users */
  48 DOM_SID global_sid_Builtin_Power_Users;         /* Builtin power users */
  49 DOM_SID global_sid_Builtin_Account_Operators;   /* Builtin account operators */
  50 DOM_SID global_sid_Builtin_Server_Operators;    /* Builtin server operators */
  51 DOM_SID global_sid_Builtin_Print_Operators;     /* Builtin print operators */
  52 DOM_SID global_sid_Builtin_Backup_Operators;    /* Builtin backup operators */
  53 DOM_SID global_sid_Builtin_Replicator;          /* Builtin replicator */
  54
  55 #define SECURITY_NULL_SID_AUTHORITY    0
  56 #define SECURITY_WORLD_SID_AUTHORITY   1
  57 #define SECURITY_LOCAL_SID_AUTHORITY   2
  58 #define SECURITY_CREATOR_SID_AUTHORITY 3
  59 #define SECURITY_NT_AUTHORITY          5
  60
  61 /*
  62  * An NT compatible anonymous token.
  63  */
  64
  65 static DOM_SID anon_sid_array[3];
  66
  67 NT_USER_TOKEN anonymous_token = {
  68         3,
  69         anon_sid_array
  70 };
  71
  72 static DOM_SID system_sid_array[4];
  73 NT_USER_TOKEN system_token = {
  74         1,
  75         system_sid_array
  76 };
  77
  78 /****************************************************************************
  79  Lookup string names for SID types.
  80 ****************************************************************************/
  81
  82 static const struct {
  83         enum SID_NAME_USE sid_type;
  84         const char *string;
  85 } sid_name_type[] = {
  86         {SID_NAME_USER, "User"},
  87         {SID_NAME_DOM_GRP, "Domain Group"},
  88         {SID_NAME_DOMAIN, "Domain"},
  89         {SID_NAME_ALIAS, "Local Group"},
  90         {SID_NAME_WKN_GRP, "Well-known Group"},
  91         {SID_NAME_DELETED, "Deleted Account"},
  92         {SID_NAME_INVALID, "Invalid Account"},
  93         {SID_NAME_UNKNOWN, "UNKNOWN"},
  94         {SID_NAME_COMPUTER, "Computer"},
  95
  96         {(enum SID_NAME_USE)0, NULL}
  97 };
  98
  99 const char *sid_type_lookup(uint32 sid_type)
 100 {
 101         int i = 0;
 102
 103         /* Look through list */
 104         while(sid_name_type[i].sid_type != 0) {
 105                 if (sid_name_type[i].sid_type == sid_type)
 106                         return sid_name_type[i].string;
 107                 i++;
 108         }
 109
 110         /* Default return */
 111         return "SID *TYPE* is INVALID";
 112 }
 113
 114 /****************************************************************************
 115  Creates some useful well known sids
 116 ****************************************************************************/
 117
 118 void generate_wellknown_sids(void)
 119 {
 120         static BOOL initialised = False;
 121
 122         if (initialised)
 123                 return;
 124
 125         /* SECURITY_NULL_SID_AUTHORITY */
 126         string_to_sid(&global_sid_NULL, "S-1-0-0");
 127
 128         /* SECURITY_WORLD_SID_AUTHORITY */
 129         string_to_sid(&global_sid_World_Domain, "S-1-1");
 130         string_to_sid(&global_sid_World, "S-1-1-0");
 131
 132         /* SECURITY_CREATOR_SID_AUTHORITY */
 133         string_to_sid(&global_sid_Creator_Owner_Domain, "S-1-3");
 134         string_to_sid(&global_sid_Creator_Owner, "S-1-3-0");
 135         string_to_sid(&global_sid_Creator_Group, "S-1-3-1");
 136
 137         /* SECURITY_NT_AUTHORITY */
 138         string_to_sid(&global_sid_NT_Authority, "S-1-5");
 139         string_to_sid(&global_sid_Network, "S-1-5-2");
 140         string_to_sid(&global_sid_Anonymous, "S-1-5-7");
 141         string_to_sid(&global_sid_Authenticated_Users, "S-1-5-11");
 142         string_to_sid(&global_sid_System, "S-1-5-18");
 143
 144         /* SECURITY_BUILTIN_DOMAIN_RID */
 145         string_to_sid(&global_sid_Builtin, "S-1-5-32");
 146         string_to_sid(&global_sid_Builtin_Administrators, "S-1-5-32-544");
 147         string_to_sid(&global_sid_Builtin_Users, "S-1-5-32-545");
 148         string_to_sid(&global_sid_Builtin_Guests, "S-1-5-32-546");
 149         string_to_sid(&global_sid_Builtin_Power_Users, "S-1-5-32-547");
 150         string_to_sid(&global_sid_Builtin_Account_Operators, "S-1-5-32-548");
 151         string_to_sid(&global_sid_Builtin_Server_Operators, "S-1-5-32-549");
 152         string_to_sid(&global_sid_Builtin_Print_Operators, "S-1-5-32-550");
 153         string_to_sid(&global_sid_Builtin_Backup_Operators, "S-1-5-32-551");
 154         string_to_sid(&global_sid_Builtin_Replicator, "S-1-5-32-552");
 155
 156         /* Create the anon token. */
 157         sid_copy( &anonymous_token.user_sids[0], &global_sid_World);
 158         sid_copy( &anonymous_token.user_sids[1], &global_sid_Network);
 159         sid_copy( &anonymous_token.user_sids[2], &global_sid_Anonymous);
 160
 161         /* Create the system token. */
 162         sid_copy( &system_token.user_sids[0], &global_sid_System);
 163
 164         initialised = True;
 165 }
 166
 167 /**************************************************************************
 168  Create the SYSTEM token.
 169 ***************************************************************************/
 170
 171 NT_USER_TOKEN *get_system_token(void)
 172 {
 173         generate_wellknown_sids(); /* The token is initialised here */
 174         return &system_token;
 175 }
 176
 177 /**************************************************************************
 178  Splits a name of format \DOMAIN\name or name into its two components.
 179  Sets the DOMAIN name to global_myname() if it has not been specified.
 180 ***************************************************************************/
 181
 182 void split_domain_name(const char *fullname, char *domain, char *name)
 183 {
 184         pstring full_name;
 185         const char *sep;
 186         char *p;
 187
 188         sep = lp_winbind_separator();
 189
 190         *domain = *name = '\0';
 191
 192         if (fullname[0] == sep[0] || fullname[0] == '\\')
 193                 fullname++;
 194
 195         pstrcpy(full_name, fullname);
 196         p = strchr_m(full_name+1, '\\');
 197         if (!p) p = strchr_m(full_name+1, sep[0]);
 198
 199         if (p != NULL) {
 200                 *p = 0;
 201                 fstrcpy(domain, full_name);
 202                 fstrcpy(name, p+1);
 203         } else {
 204                 if(!lp_domain_logons()) {
 205                         fstrcpy(domain, global_myname());
 206                         fstrcpy(name, full_name);
 207                 } else {
 208                         fstrcpy(domain, lp_workgroup());
 209                         fstrcpy(name, full_name);
 210                 }
 211                 fstrcpy(domain, global_myname());
 212                 fstrcpy(name, full_name);
 213         }
 214
 215         DEBUG(10,("split_domain_name:name '%s' split into domain :'%s' and user :'%s'\n",
 216                         fullname, domain, name));
 217 }
 218
 219 /****************************************************************************
 220  Test if a SID is wellknown and resolvable.
 221 ****************************************************************************/
 222
 223 BOOL resolvable_wellknown_sid(DOM_SID *sid)
 224 {
 225         uint32 ia = (sid->id_auth[5]) +
 226                         (sid->id_auth[4] << 8 ) +
 227                         (sid->id_auth[3] << 16) +
 228                         (sid->id_auth[2] << 24);
 229
 230         if (sid->sid_rev_num != SEC_DESC_REVISION || sid->num_auths < 1)
 231                 return False;
 232
 233         return (ia == SECURITY_WORLD_SID_AUTHORITY ||
 234                 ia == SECURITY_CREATOR_SID_AUTHORITY);
 235 }
 236
 237 /*****************************************************************
 238  Convert a SID to an ascii string.
 239 *****************************************************************/
 240
 241 char *sid_to_string(fstring sidstr_out, const DOM_SID *sid)
 242 {
 243         char subauth[16];
 244         int i;
 245         uint32 ia;
 246
 247         if (!sid) {
 248                 fstrcpy(sidstr_out, "(NULL SID)");
 249                 return sidstr_out;
 250         }
 251
 252         /*
 253          * BIG NOTE: this function only does SIDS where the identauth is not >= 2^32
 254          * in a range of 2^48.
 255          */
 256         ia = (sid->id_auth[5]) +
 257                 (sid->id_auth[4] << 8 ) +
 258                 (sid->id_auth[3] << 16) +
 259                 (sid->id_auth[2] << 24);
 260
 261         slprintf(sidstr_out, sizeof(fstring) - 1, "S-%u-%lu", (unsigned int)sid->sid_rev_num, (unsigned long)ia);
 262
 263         for (i = 0; i < sid->num_auths; i++) {
 264                 slprintf(subauth, sizeof(subauth)-1, "-%lu", (unsigned long)sid->sub_auths[i]);
 265                 fstrcat(sidstr_out, subauth);
 266         }
 267
 268         return sidstr_out;
 269 }
 270
 271 /*****************************************************************
 272  Useful function for debug lines.
 273 *****************************************************************/
 274
 275 const char *sid_string_static(const DOM_SID *sid)
 276 {
 277         static fstring sid_str;
 278         sid_to_string(sid_str, sid);
 279         return sid_str;
 280 }
 281
 282 /*****************************************************************
 283  Convert a string to a SID. Returns True on success, False on fail.
 284 *****************************************************************/
 285
 286 BOOL string_to_sid(DOM_SID *sidout, const char *sidstr)
 287 {
 288         pstring tok;
 289         char *q;
 290         const char *p;
 291         /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
 292         uint32 ia;
 293
 294         if (StrnCaseCmp( sidstr, "S-", 2)) {
 295                 DEBUG(0,("string_to_sid: Sid %s does not start with 'S-'.\n", sidstr));
 296                 return False;
 297         }
 298
 299         memset((char *)sidout, '\0', sizeof(DOM_SID));
 300
 301         p = q = strdup(sidstr + 2);
 302         if (p == NULL) {
 303                 DEBUG(0, ("string_to_sid: out of memory!\n"));
 304                 return False;
 305         }
 306
 307         if (!next_token(&p, tok, "-", sizeof(tok))) {
 308                 DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
 309                 SAFE_FREE(q);
 310                 return False;
 311         }
 312
 313         /* Get the revision number. */
 314         sidout->sid_rev_num = (uint8)strtoul(tok, NULL, 10);
 315
 316         if (!next_token(&p, tok, "-", sizeof(tok))) {
 317                 DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
 318                 SAFE_FREE(q);
 319                 return False;
 320         }
 321
 322         /* identauth in decimal should be <  2^32 */
 323         ia = (uint32)strtoul(tok, NULL, 10);
 324
 325         /* NOTE - the ia value is in big-endian format. */
 326         sidout->id_auth[0] = 0;
 327         sidout->id_auth[1] = 0;
 328         sidout->id_auth[2] = (ia & 0xff000000) >> 24;
 329         sidout->id_auth[3] = (ia & 0x00ff0000) >> 16;
 330         sidout->id_auth[4] = (ia & 0x0000ff00) >> 8;
 331         sidout->id_auth[5] = (ia & 0x000000ff);
 332
 333         sidout->num_auths = 0;
 334
 335         while(next_token(&p, tok, "-", sizeof(tok)) &&
 336                 sidout->num_auths < MAXSUBAUTHS) {
 337                 /*
 338                  * NOTE - the subauths are in native machine-endian format. They
 339                  * are converted to little-endian when linearized onto the wire.
 340                  */
 341                 sid_append_rid(sidout, (uint32)strtoul(tok, NULL, 10));
 342         }
 343
 344         SAFE_FREE(q);
 345         return True;
 346 }
 347
 348 /*****************************************************************
 349  Add a rid to the end of a sid
 350 *****************************************************************/
 351
 352 BOOL sid_append_rid(DOM_SID *sid, uint32 rid)
 353 {
 354         if (sid->num_auths < MAXSUBAUTHS) {
 355                 sid->sub_auths[sid->num_auths++] = rid;
 356                 return True;
 357         }
 358         return False;
 359 }
 360
 361 /*****************************************************************
 362  Removes the last rid from the end of a sid
 363 *****************************************************************/
 364
 365 BOOL sid_split_rid(DOM_SID *sid, uint32 *rid)
 366 {
 367         if (sid->num_auths > 0) {
 368                 sid->num_auths--;
 369                 *rid = sid->sub_auths[sid->num_auths];
 370                 return True;
 371         }
 372         return False;
 373 }
 374
 375 /*****************************************************************
 376  Return the last rid from the end of a sid
 377 *****************************************************************/
 378
 379 BOOL sid_peek_rid(const DOM_SID *sid, uint32 *rid)
 380 {
 381         if (!sid || !rid)
 382                 return False;
 383
 384         if (sid->num_auths > 0) {
 385                 *rid = sid->sub_auths[sid->num_auths - 1];
 386                 return True;
 387         }
 388         return False;
 389 }
 390
 391 /*****************************************************************
 392  Return the last rid from the end of a sid
 393  and check the sid against the exp_dom_sid
 394 *****************************************************************/
 395
 396 BOOL sid_peek_check_rid(const DOM_SID *exp_dom_sid, const DOM_SID *sid, uint32 *rid)
 397 {
 398         if (!exp_dom_sid || !sid || !rid)
 399                 return False;
 400
 401         if (sid->num_auths != (exp_dom_sid->num_auths+1)) {
 402                 return False;
 403         }
 404
 405         if (sid_compare_domain(exp_dom_sid, sid)!=0){
 406                 *rid=(-1);
 407                 return False;
 408         }
 409
 410         return sid_peek_rid(sid, rid);
 411 }
 412
 413 /*****************************************************************
 414  Copies a sid
 415 *****************************************************************/
 416
 417 void sid_copy(DOM_SID *dst, const DOM_SID *src)
 418 {
 419         int i;
 420
 421         ZERO_STRUCTP(dst);
 422
 423         dst->sid_rev_num = src->sid_rev_num;
 424         dst->num_auths = src->num_auths;
 425
 426         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
 427
 428         for (i = 0; i < src->num_auths; i++)
 429                 dst->sub_auths[i] = src->sub_auths[i];
 430 }
 431
 432 /*****************************************************************
 433  Write a sid out into on-the-wire format.
 434 *****************************************************************/
 435
 436 BOOL sid_linearize(char *outbuf, size_t len, const DOM_SID *sid)
 437 {
 438         size_t i;
 439
 440         if (len < sid_size(sid))
 441                 return False;
 442
 443         SCVAL(outbuf,0,sid->sid_rev_num);
 444         SCVAL(outbuf,1,sid->num_auths);
 445         memcpy(&outbuf[2], sid->id_auth, 6);
 446         for(i = 0; i < sid->num_auths; i++)
 447                 SIVAL(outbuf, 8 + (i*4), sid->sub_auths[i]);
 448
 449         return True;
 450 }
 451
 452 /*****************************************************************
 453  Parse a on-the-wire SID to a DOM_SID.
 454 *****************************************************************/
 455
 456 BOOL sid_parse(const char *inbuf, size_t len, DOM_SID *sid)
 457 {
 458         int i;
 459         if (len < 8)
 460                 return False;
 461
 462         ZERO_STRUCTP(sid);
 463
 464         sid->sid_rev_num = CVAL(inbuf, 0);
 465         sid->num_auths = CVAL(inbuf, 1);
 466         memcpy(sid->id_auth, inbuf+2, 6);
 467         if (len < 8 + sid->num_auths*4)
 468                 return False;
 469         for (i=0;i<sid->num_auths;i++)
 470                 sid->sub_auths[i] = IVAL(inbuf, 8+i*4);
 471         return True;
 472 }
 473
 474 /*****************************************************************
 475  Compare the auth portion of two sids.
 476 *****************************************************************/
 477
 478 static int sid_compare_auth(const DOM_SID *sid1, const DOM_SID *sid2)
 479 {
 480         int i;
 481
 482         if (sid1 == sid2)
 483                 return 0;
 484         if (!sid1)
 485                 return -1;
 486         if (!sid2)
 487                 return 1;
 488
 489         if (sid1->sid_rev_num != sid2->sid_rev_num)
 490                 return sid1->sid_rev_num - sid2->sid_rev_num;
 491
 492         for (i = 0; i < 6; i++)
 493                 if (sid1->id_auth[i] != sid2->id_auth[i])
 494                         return sid1->id_auth[i] - sid2->id_auth[i];
 495
 496         return 0;
 497 }
 498
 499 /*****************************************************************
 500  Compare two sids.
 501 *****************************************************************/
 502
 503 int sid_compare(const DOM_SID *sid1, const DOM_SID *sid2)
 504 {
 505         int i;
 506
 507         if (sid1 == sid2)
 508                 return 0;
 509         if (!sid1)
 510                 return -1;
 511         if (!sid2)
 512                 return 1;
 513
 514         /* Compare most likely different rids, first: i.e start at end */
 515         if (sid1->num_auths != sid2->num_auths)
 516                 return sid1->num_auths - sid2->num_auths;
 517
 518         for (i = sid1->num_auths-1; i >= 0; --i)
 519                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
 520                         return sid1->sub_auths[i] - sid2->sub_auths[i];
 521
 522         return sid_compare_auth(sid1, sid2);
 523 }
 524
 525 /*****************************************************************
 526  See if 2 SIDs are in the same domain
 527  this just compares the leading sub-auths
 528 *****************************************************************/
 529
 530 int sid_compare_domain(const DOM_SID *sid1, const DOM_SID *sid2)
 531 {
 532         int n, i;
 533
 534         n = MIN(sid1->num_auths, sid2->num_auths);
 535
 536         for (i = n-1; i >= 0; --i)
 537                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
 538                         return sid1->sub_auths[i] - sid2->sub_auths[i];
 539
 540         return sid_compare_auth(sid1, sid2);
 541 }
 542
 543 /*****************************************************************
 544  Compare two sids.
 545 *****************************************************************/
 546
 547 BOOL sid_equal(const DOM_SID *sid1, const DOM_SID *sid2)
 548 {
 549         return sid_compare(sid1, sid2) == 0;
 550 }
 551
 552 /*****************************************************************
 553  Check if the SID is the builtin SID (S-1-5-32).
 554 *****************************************************************/
 555
 556 BOOL sid_check_is_builtin(const DOM_SID *sid)
 557 {
 558         return sid_equal(sid, &global_sid_Builtin);
 559 }
 560
 561 /*****************************************************************
 562  Check if the SID is one of the builtin SIDs (S-1-5-32-a).
 563 *****************************************************************/
 564
 565 BOOL sid_check_is_in_builtin(const DOM_SID *sid)
 566 {
 567         DOM_SID dom_sid;
 568         uint32 rid;
 569
 570         sid_copy(&dom_sid, sid);
 571         sid_split_rid(&dom_sid, &rid);
 572
 573         return sid_equal(&dom_sid, &global_sid_Builtin);
 574 }
 575
 576 /*****************************************************************
 577  Calculates size of a sid.
 578 *****************************************************************/
 579
 580 size_t sid_size(const DOM_SID *sid)
 581 {
 582         if (sid == NULL)
 583                 return 0;
 584
 585         return sid->num_auths * sizeof(uint32) + 8;
 586 }
 587
 588 /*****************************************************************
 589  Returns true if SID is internal (and non-mappable).
 590 *****************************************************************/
 591
 592 BOOL non_mappable_sid(DOM_SID *sid)
 593 {
 594         DOM_SID dom;
 595         uint32 rid;
 596
 597         sid_copy(&dom, sid);
 598         sid_split_rid(&dom, &rid);
 599
 600         if (sid_equal(&dom, &global_sid_Builtin))
 601                 return True;
 602
 603         if (sid_equal(&dom, &global_sid_NT_Authority))
 604                 return True;
 605
 606         return False;
 607 }
 608
 609 /*****************************************************************
 610  Return the binary string representation of a DOM_SID.
 611  Caller must free.
 612 *****************************************************************/
 613
 614 char *sid_binstring(const DOM_SID *sid)
 615 {
 616         char *buf, *s;
 617         int len = sid_size(sid);
 618         buf = malloc(len);
 619         if (!buf)
 620                 return NULL;
 621         sid_linearize(buf, len, sid);
 622         s = binary_string(buf, len);
 623         free(buf);
 624         return s;
 625 }
 626
 627 /*******************************************************************
 628  Tallocs a duplicate SID.
 629 ********************************************************************/
 630
 631 DOM_SID *sid_dup_talloc(TALLOC_CTX *ctx, const DOM_SID *src)
 632 {
 633         DOM_SID *dst;
 634
 635         if(!src)
 636                 return NULL;
 637
 638         if((dst = talloc_zero(ctx, sizeof(DOM_SID))) != NULL) {
 639                 sid_copy( dst, src);
 640         }
 641
 642         return dst;
 643 }