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