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 */
  38 DOM_SID global_sid_World;    /* everyone */
  39 DOM_SID global_sid_Creator_Owner_Domain;    /* Creator Owner */
  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;
  44
  45 const DOM_SID *global_sid_everyone = &global_sid_World;
  46
  47 typedef struct _known_sid_users {
  48         uint32 rid;
  49         enum SID_NAME_USE sid_name_use;
  50         char *known_user_name;
  51 } known_sid_users;
  52
  53 /* static known_sid_users no_users[] = {{0, 0, NULL}}; */
  54 static known_sid_users everyone_users[] = {
  55         { 0, SID_NAME_WKN_GRP, "Everyone" },
  56         {0, (enum SID_NAME_USE)0, NULL}};
  57 static known_sid_users creator_owner_users[] = {
  58         { 0, SID_NAME_ALIAS, "Creator Owner" },
  59         {0, (enum SID_NAME_USE)0, NULL}};
  60 static known_sid_users nt_authority_users[] = {
  61         {  1, SID_NAME_ALIAS, "Dialup" },
  62         {  2, SID_NAME_ALIAS, "Network"},
  63         {  3, SID_NAME_ALIAS, "Batch"},
  64         {  4, SID_NAME_ALIAS, "Interactive"},
  65         {  6, SID_NAME_ALIAS, "Service"},
  66         {  7, SID_NAME_ALIAS, "AnonymousLogon"},
  67         {  8, SID_NAME_ALIAS, "Proxy"},
  68         {  9, SID_NAME_ALIAS, "ServerLogon"},
  69         { 11, SID_NAME_ALIAS, "Authenticated Users"},
  70         { 18, SID_NAME_ALIAS, "SYSTEM"},
  71         {  0, (enum SID_NAME_USE)0, NULL}};
  72
  73 static struct sid_name_map_info
  74 {
  75         DOM_SID *sid;
  76         char *name;
  77         known_sid_users *known_users;
  78 }
  79 sid_name_map[] =
  80 {
  81         { &global_sam_sid, global_myname, NULL},
  82         { &global_sam_sid, global_myworkgroup, NULL},
  83         { &global_sid_Builtin, "BUILTIN", NULL},
  84         { &global_sid_World_Domain, "", &everyone_users[0] },
  85         { &global_sid_Creator_Owner_Domain, "", &creator_owner_users[0] },
  86         { &global_sid_NT_Authority, "NT Authority", &nt_authority_users[0] },
  87         { NULL, NULL, NULL}
  88 };
  89
  90 /****************************************************************************
  91  Creates some useful well known sids
  92 ****************************************************************************/
  93
  94 void generate_wellknown_sids(void)
  95 {
  96         string_to_sid(&global_sid_Builtin, "S-1-5-32");
  97         string_to_sid(&global_sid_Builtin_Guests, "S-1-5-32-546");
  98         string_to_sid(&global_sid_World_Domain, "S-1-1");
  99         string_to_sid(&global_sid_World, "S-1-1-0");
 100         string_to_sid(&global_sid_Creator_Owner_Domain, "S-1-3");
 101         string_to_sid(&global_sid_Creator_Owner, "S-1-3-0");
 102         string_to_sid(&global_sid_NT_Authority, "S-1-5");
 103         string_to_sid(&global_sid_NULL, "S-1-0-0");
 104 }
 105
 106 /**************************************************************************
 107  Turns a domain SID into a name, returned in the nt_domain argument.
 108 ***************************************************************************/
 109
 110 BOOL map_domain_sid_to_name(DOM_SID *sid, char *nt_domain)
 111 {
 112         fstring sid_str;
 113         int i = 0;
 114         sid_to_string(sid_str, sid);
 115
 116         DEBUG(5,("map_domain_sid_to_name: %s\n", sid_str));
 117
 118         if (nt_domain == NULL)
 119                 return False;
 120
 121         while (sid_name_map[i].sid != NULL) {
 122                 sid_to_string(sid_str, sid_name_map[i].sid);
 123                 DEBUG(5,("map_domain_sid_to_name: compare: %s\n", sid_str));
 124                 if (sid_equal(sid_name_map[i].sid, sid)) {
 125                         fstrcpy(nt_domain, sid_name_map[i].name);
 126                         DEBUG(5,("map_domain_sid_to_name: found '%s'\n", nt_domain));
 127                         return True;
 128                 }
 129                 i++;
 130         }
 131
 132         DEBUG(5,("map_domain_sid_to_name: mapping for %s not found\n", sid_str));
 133
 134     return False;
 135 }
 136
 137 /**************************************************************************
 138  Looks up a known username from one of the known domains.
 139 ***************************************************************************/
 140
 141 BOOL lookup_known_rid(DOM_SID *sid, uint32 rid, char *name, enum SID_NAME_USE *psid_name_use)
 142 {
 143         int i = 0;
 144         struct sid_name_map_info *psnm;
 145
 146         for(i = 0; sid_name_map[i].sid != NULL; i++) {
 147                 psnm = &sid_name_map[i];
 148                 if(sid_equal(psnm->sid, sid)) {
 149                         int j;
 150                         for(j = 0; psnm->known_users && psnm->known_users[j].known_user_name != NULL; j++) {
 151                                 if(rid == psnm->known_users[j].rid) {
 152                                         DEBUG(5,("lookup_builtin_rid: rid = %u, domain = '%s', user = '%s'\n",
 153                                                 (unsigned int)rid, psnm->name, psnm->known_users[j].known_user_name ));
 154                                         fstrcpy( name, psnm->known_users[j].known_user_name);
 155                                         *psid_name_use = psnm->known_users[j].sid_name_use;
 156                                         return True;
 157                                 }
 158                         }
 159                 }
 160         }
 161
 162         return False;
 163 }
 164
 165 /**************************************************************************
 166  Turns a domain name into a SID.
 167  *** side-effect: if the domain name is NULL, it is set to our domain ***
 168 ***************************************************************************/
 169
 170 BOOL map_domain_name_to_sid(DOM_SID *sid, char *nt_domain)
 171 {
 172         int i = 0;
 173
 174         if (nt_domain == NULL) {
 175                 DEBUG(5,("map_domain_name_to_sid: mapping NULL domain to our SID.\n"));
 176                 sid_copy(sid, &global_sam_sid);
 177                 return True;
 178         }
 179
 180         if (nt_domain[0] == 0) {
 181                 fstrcpy(nt_domain, global_myname);
 182                 DEBUG(5,("map_domain_name_to_sid: overriding blank name to %s\n", nt_domain));
 183                 sid_copy(sid, &global_sam_sid);
 184                 return True;
 185     }
 186
 187         DEBUG(5,("map_domain_name_to_sid: %s\n", nt_domain));
 188
 189         while (sid_name_map[i].name != NULL) {
 190                 DEBUG(5,("map_domain_name_to_sid: compare: %s\n", sid_name_map[i].name));
 191                 if (strequal(sid_name_map[i].name, nt_domain)) {
 192                         fstring sid_str;
 193                         sid_copy(sid, sid_name_map[i].sid);
 194                         sid_to_string(sid_str, sid_name_map[i].sid);
 195                         DEBUG(5,("map_domain_name_to_sid: found %s\n", sid_str));
 196                         return True;
 197                 }
 198                 i++;
 199         }
 200
 201         DEBUG(0,("map_domain_name_to_sid: mapping to %s not found.\n", nt_domain));
 202         return False;
 203 }
 204
 205 /**************************************************************************
 206  Splits a name of format \DOMAIN\name or name into its two components.
 207  Sets the DOMAIN name to global_myname if it has not been specified.
 208 ***************************************************************************/
 209
 210 void split_domain_name(const char *fullname, char *domain, char *name)
 211 {
 212         pstring full_name;
 213         char *p;
 214
 215         *domain = *name = '\0';
 216
 217         if (fullname[0] == '\\')
 218                 fullname++;
 219
 220         pstrcpy(full_name, fullname);
 221         p = strchr(full_name+1, '\\');
 222
 223         if (p != NULL) {
 224                 *p = 0;
 225                 fstrcpy(domain, full_name);
 226                 fstrcpy(name, p+1);
 227         } else {
 228                 fstrcpy(domain, global_myname);
 229                 fstrcpy(name, full_name);
 230         }
 231
 232         DEBUG(10,("split_domain_name:name '%s' split into domain :'%s' and user :'%s'\n",
 233                         fullname, domain, name));
 234 }
 235
 236 /*****************************************************************
 237  Convert a SID to an ascii string.
 238 *****************************************************************/
 239
 240 char *sid_to_string(fstring sidstr_out, DOM_SID *sid)
 241 {
 242   char subauth[16];
 243   int i;
 244   /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
 245   uint32 ia = (sid->id_auth[5]) +
 246               (sid->id_auth[4] << 8 ) +
 247               (sid->id_auth[3] << 16) +
 248               (sid->id_auth[2] << 24);
 249
 250   slprintf(sidstr_out, sizeof(fstring) - 1, "S-%u-%lu", (unsigned int)sid->sid_rev_num, (unsigned long)ia);
 251
 252   for (i = 0; i < sid->num_auths; i++) {
 253     slprintf(subauth, sizeof(subauth)-1, "-%lu", (unsigned long)sid->sub_auths[i]);
 254     fstrcat(sidstr_out, subauth);
 255   }
 256
 257   return sidstr_out;
 258 }
 259
 260 /*****************************************************************
 261  Convert a string to a SID. Returns True on success, False on fail.
 262 *****************************************************************/
 263
 264 BOOL string_to_sid(DOM_SID *sidout, char *sidstr)
 265 {
 266   pstring tok;
 267   char *p = sidstr;
 268   /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
 269   uint32 ia;
 270
 271   memset((char *)sidout, '\0', sizeof(DOM_SID));
 272
 273   if (StrnCaseCmp( sidstr, "S-", 2)) {
 274     DEBUG(0,("string_to_sid: Sid %s does not start with 'S-'.\n", sidstr));
 275     return False;
 276   }
 277
 278   p += 2;
 279   if (!next_token(&p, tok, "-", sizeof(tok))) {
 280     DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
 281     return False;
 282   }
 283
 284   /* Get the revision number. */
 285   sidout->sid_rev_num = (uint8)strtoul(tok, NULL, 10);
 286
 287   if (!next_token(&p, tok, "-", sizeof(tok))) {
 288     DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
 289     return False;
 290   }
 291
 292   /* identauth in decimal should be <  2^32 */
 293   ia = (uint32)strtoul(tok, NULL, 10);
 294
 295   /* NOTE - the ia value is in big-endian format. */
 296   sidout->id_auth[0] = 0;
 297   sidout->id_auth[1] = 0;
 298   sidout->id_auth[2] = (ia & 0xff000000) >> 24;
 299   sidout->id_auth[3] = (ia & 0x00ff0000) >> 16;
 300   sidout->id_auth[4] = (ia & 0x0000ff00) >> 8;
 301   sidout->id_auth[5] = (ia & 0x000000ff);
 302
 303   sidout->num_auths = 0;
 304
 305   while(next_token(&p, tok, "-", sizeof(tok)) &&
 306         sidout->num_auths < MAXSUBAUTHS) {
 307     /*
 308      * NOTE - the subauths are in native machine-endian format. They
 309      * are converted to little-endian when linearized onto the wire.
 310      */
 311         sid_append_rid(sidout, (uint32)strtoul(tok, NULL, 10));
 312   }
 313
 314   DEBUG(7,("string_to_sid: converted SID %s ok\n", sidstr));
 315
 316   return True;
 317 }
 318
 319 /*****************************************************************
 320  Add a rid to the end of a sid
 321 *****************************************************************/
 322
 323 BOOL sid_append_rid(DOM_SID *sid, uint32 rid)
 324 {
 325         if (sid->num_auths < MAXSUBAUTHS) {
 326                 sid->sub_auths[sid->num_auths++] = rid;
 327                 return True;
 328         }
 329         return False;
 330 }
 331
 332 /*****************************************************************
 333  Removes the last rid from the end of a sid
 334 *****************************************************************/
 335
 336 BOOL sid_split_rid(DOM_SID *sid, uint32 *rid)
 337 {
 338         if (sid->num_auths > 0) {
 339                 sid->num_auths--;
 340                 *rid = sid->sub_auths[sid->num_auths];
 341                 return True;
 342         }
 343         return False;
 344 }
 345
 346 /*****************************************************************
 347  Copies a sid
 348 *****************************************************************/
 349
 350 void sid_copy(DOM_SID *dst, const DOM_SID *src)
 351 {
 352         int i;
 353
 354         memset((char *)dst, '\0', sizeof(DOM_SID));
 355
 356         dst->sid_rev_num = src->sid_rev_num;
 357         dst->num_auths = src->num_auths;
 358
 359         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
 360
 361         for (i = 0; i < src->num_auths; i++)
 362                 dst->sub_auths[i] = src->sub_auths[i];
 363 }
 364
 365 /*****************************************************************
 366  Duplicates a sid - mallocs the target.
 367 *****************************************************************/
 368
 369 DOM_SID *sid_dup(DOM_SID *src)
 370 {
 371   DOM_SID *dst;
 372
 373   if(!src)
 374     return NULL;
 375
 376   if((dst = malloc(sizeof(DOM_SID))) != NULL) {
 377         memset(dst, '\0', sizeof(DOM_SID));
 378         sid_copy( dst, src);
 379   }
 380
 381   return dst;
 382 }
 383
 384 /*****************************************************************
 385  Write a sid out into on-the-wire format.
 386 *****************************************************************/
 387
 388 BOOL sid_linearize(char *outbuf, size_t len, DOM_SID *sid)
 389 {
 390         size_t i;
 391
 392         if(len < sid_size(sid))
 393                 return False;
 394
 395         SCVAL(outbuf,0,sid->sid_rev_num);
 396         SCVAL(outbuf,1,sid->num_auths);
 397         memcpy(&outbuf[2], sid->id_auth, 6);
 398         for(i = 0; i < sid->num_auths; i++)
 399                 SIVAL(outbuf, 8 + (i*4), sid->sub_auths[i]);
 400
 401         return True;
 402 }
 403
 404 /*****************************************************************
 405  Compare two sids.
 406 *****************************************************************/
 407
 408 BOOL sid_equal(const DOM_SID *sid1, const DOM_SID *sid2)
 409 {
 410         int i;
 411
 412         if (sid1 == sid2) return True;
 413         if (!sid1 || !sid2) return False;
 414
 415         /* compare most likely different rids, first: i.e start at end */
 416         for (i = sid1->num_auths-1; i >= 0; --i)
 417                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
 418                         return False;
 419
 420         if (sid1->num_auths != sid2->num_auths)
 421                 return False;
 422         if (sid1->sid_rev_num != sid2->sid_rev_num)
 423                 return False;
 424
 425         for (i = 0; i < 6; i++)
 426                 if (sid1->id_auth[i] != sid2->id_auth[i])
 427                         return False;
 428
 429         return True;
 430 }
 431
 432
 433 /*****************************************************************
 434  Calculates size of a sid.
 435 *****************************************************************/
 436
 437 size_t sid_size(DOM_SID *sid)
 438 {
 439         if (sid == NULL)
 440                 return 0;
 441
 442         return sid->num_auths * sizeof(uint32) + 8;
 443 }