libcli/security/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    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2005
  10    Copyright (C) Andrew Bartlett                2010
  11
  12    This program is free software; you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation; either version 3 of the License, or
  15    (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 #include "includes.h"
  27 #include "../librpc/gen_ndr/ndr_security.h"
  28 #include "../librpc/gen_ndr/netlogon.h"
  29 #include "../libcli/security/security.h"
  30
  31 /*
  32  * Some useful sids, more well known sids can be found at
  33  * http://support.microsoft.com/kb/243330/EN-US/
  34  */
  35
  36
  37 const struct dom_sid global_sid_World_Domain =               /* Everyone domain */
  38 { 1, 0, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  39 const struct dom_sid global_sid_World =                      /* Everyone */
  40 { 1, 1, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  41 const struct dom_sid global_sid_Local_Authority =            /* Local Authority */
  42 { 1, 0, {0,0,0,0,0,2}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  43 const struct dom_sid global_sid_Creator_Owner_Domain =       /* Creator Owner domain */
  44 { 1, 0, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  45 const struct dom_sid global_sid_NT_Authority =                  /* NT Authority */
  46 { 1, 0, {0,0,0,0,0,5}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  47 const struct dom_sid global_sid_System =                        /* System */
  48 { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  49 const struct dom_sid global_sid_NULL =                          /* NULL sid */
  50 { 1, 1, {0,0,0,0,0,0}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  51 const struct dom_sid global_sid_Authenticated_Users =   /* All authenticated rids */
  52 { 1, 1, {0,0,0,0,0,5}, {11,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  53 #if 0
  54 /* for documentation */
  55 const struct dom_sid global_sid_Restriced =                     /* Restriced Code */
  56 { 1, 1, {0,0,0,0,0,5}, {12,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  57 #endif
  58 const struct dom_sid global_sid_Network =                       /* Network rids */
  59 { 1, 1, {0,0,0,0,0,5}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  60
  61 const struct dom_sid global_sid_Creator_Owner =         /* Creator Owner */
  62 { 1, 1, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  63 const struct dom_sid global_sid_Creator_Group =         /* Creator Group */
  64 { 1, 1, {0,0,0,0,0,3}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  65 const struct dom_sid global_sid_Owner_Rights =          /* Owner Rights */
  66 { 1, 1, {0,0,0,0,0,3}, {4,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  67 const struct dom_sid global_sid_Anonymous =                     /* Anonymous login */
  68 { 1, 1, {0,0,0,0,0,5}, {7,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  69 const struct dom_sid global_sid_Enterprise_DCs =                /* Enterprise DCs */
  70 { 1, 1, {0,0,0,0,0,5}, {9,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  71 const struct dom_sid global_sid_Builtin =                       /* Local well-known domain */
  72 { 1, 1, {0,0,0,0,0,5}, {32,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  73 const struct dom_sid global_sid_Builtin_Administrators =        /* Builtin administrators */
  74 { 1, 2, {0,0,0,0,0,5}, {32,544,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  75 const struct dom_sid global_sid_Builtin_Users =         /* Builtin users */
  76 { 1, 2, {0,0,0,0,0,5}, {32,545,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  77 const struct dom_sid global_sid_Builtin_Guests =                /* Builtin guest users */
  78 { 1, 2, {0,0,0,0,0,5}, {32,546,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  79 const struct dom_sid global_sid_Builtin_Power_Users =   /* Builtin power users */
  80 { 1, 2, {0,0,0,0,0,5}, {32,547,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  81 const struct dom_sid global_sid_Builtin_Account_Operators =     /* Builtin account operators */
  82 { 1, 2, {0,0,0,0,0,5}, {32,548,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  83 const struct dom_sid global_sid_Builtin_Server_Operators =      /* Builtin server operators */
  84 { 1, 2, {0,0,0,0,0,5}, {32,549,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  85 const struct dom_sid global_sid_Builtin_Print_Operators =       /* Builtin print operators */
  86 { 1, 2, {0,0,0,0,0,5}, {32,550,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  87 const struct dom_sid global_sid_Builtin_Backup_Operators =      /* Builtin backup operators */
  88 { 1, 2, {0,0,0,0,0,5}, {32,551,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  89 const struct dom_sid global_sid_Builtin_Replicator =            /* Builtin replicator */
  90 { 1, 2, {0,0,0,0,0,5}, {32,552,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  91 const struct dom_sid global_sid_Builtin_PreWin2kAccess =        /* Builtin pre win2k access */
  92 { 1, 2, {0,0,0,0,0,5}, {32,554,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  93
  94 const struct dom_sid global_sid_Unix_Users =                    /* Unmapped Unix users */
  95 { 1, 1, {0,0,0,0,0,22}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  96 const struct dom_sid global_sid_Unix_Groups =                   /* Unmapped Unix groups */
  97 { 1, 1, {0,0,0,0,0,22}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  98
  99 /*
 100  * http://technet.microsoft.com/en-us/library/hh509017(v=ws.10).aspx
 101  */
 102 const struct dom_sid global_sid_Unix_NFS =             /* MS NFS and Apple style */
 103 { 1, 1, {0,0,0,0,0,5}, {88,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
 104 const struct dom_sid global_sid_Unix_NFS_Users =                /* Unix uid, MS NFS and Apple style */
 105 { 1, 2, {0,0,0,0,0,5}, {88,1,0,0,0,0,0,0,0,0,0,0,0,0,0}};
 106 const struct dom_sid global_sid_Unix_NFS_Groups =               /* Unix gid, MS NFS and Apple style */
 107 { 1, 2, {0,0,0,0,0,5}, {88,2,0,0,0,0,0,0,0,0,0,0,0,0,0}};
 108 const struct dom_sid global_sid_Unix_NFS_Mode =                 /* Unix mode */
 109 { 1, 2, {0,0,0,0,0,5}, {88,3,0,0,0,0,0,0,0,0,0,0,0,0,0}};
 110 /* Unused, left here for documentary purposes */
 111 #if 0
 112 const struct dom_sid global_sid_Unix_NFS_Other =                /* Unix other, MS NFS and Apple style */
 113 { 1, 2, {0,0,0,0,0,5}, {88,4,0,0,0,0,0,0,0,0,0,0,0,0,0}};
 114 #endif
 115
 116 /* Unused, left here for documentary purposes */
 117 #if 0
 118 #define SECURITY_NULL_SID_AUTHORITY    0
 119 #define SECURITY_WORLD_SID_AUTHORITY   1
 120 #define SECURITY_LOCAL_SID_AUTHORITY   2
 121 #define SECURITY_CREATOR_SID_AUTHORITY 3
 122 #define SECURITY_NT_AUTHORITY          5
 123 #endif
 124
 125 static struct dom_sid system_sid_array[1] =
 126 { { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}} };
 127 static const struct security_token system_token = {
 128         .num_sids       = ARRAY_SIZE(system_sid_array),
 129         .sids           = system_sid_array,
 130         .privilege_mask = SE_ALL_PRIVS
 131 };
 132
 133 /****************************************************************************
 134  Lookup string names for SID types.
 135 ****************************************************************************/
 136
 137 static const struct {
 138         enum lsa_SidType sid_type;
 139         const char *string;
 140 } sid_name_type[] = {
 141         {SID_NAME_USE_NONE, "None"},
 142         {SID_NAME_USER, "User"},
 143         {SID_NAME_DOM_GRP, "Domain Group"},
 144         {SID_NAME_DOMAIN, "Domain"},
 145         {SID_NAME_ALIAS, "Local Group"},
 146         {SID_NAME_WKN_GRP, "Well-known Group"},
 147         {SID_NAME_DELETED, "Deleted Account"},
 148         {SID_NAME_INVALID, "Invalid Account"},
 149         {SID_NAME_UNKNOWN, "UNKNOWN"},
 150         {SID_NAME_COMPUTER, "Computer"}
 151 };
 152
 153 const char *sid_type_lookup(uint32_t sid_type)
 154 {
 155         int i;
 156
 157         /* Look through list */
 158         for (i=0; i < ARRAY_SIZE(sid_name_type); i++) {
 159                 if (sid_name_type[i].sid_type == sid_type) {
 160                         return sid_name_type[i].string;
 161                 }
 162         }
 163
 164         /* Default return */
 165         return "SID *TYPE* is INVALID";
 166 }
 167
 168 /**************************************************************************
 169  Create the SYSTEM token.
 170 ***************************************************************************/
 171
 172 const struct security_token *get_system_token(void)
 173 {
 174         return &system_token;
 175 }
 176
 177 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32_t rid)
 178 {
 179         sid_copy(dst, domain_sid);
 180         return sid_append_rid(dst, rid);
 181 }
 182
 183 /*****************************************************************
 184  Removes the last rid from the end of a sid
 185 *****************************************************************/
 186
 187 bool sid_split_rid(struct dom_sid *sid, uint32_t *rid)
 188 {
 189         if (sid->num_auths > 0) {
 190                 sid->num_auths--;
 191                 if (rid != NULL) {
 192                         *rid = sid->sub_auths[sid->num_auths];
 193                 }
 194                 return true;
 195         }
 196         return false;
 197 }
 198
 199 /*****************************************************************
 200  Return the last rid from the end of a sid
 201 *****************************************************************/
 202
 203 bool sid_peek_rid(const struct dom_sid *sid, uint32_t *rid)
 204 {
 205         if (!sid || !rid)
 206                 return false;
 207
 208         if (sid->num_auths > 0) {
 209                 *rid = sid->sub_auths[sid->num_auths - 1];
 210                 return true;
 211         }
 212         return false;
 213 }
 214
 215 /*****************************************************************
 216  Return the last rid from the end of a sid
 217  and check the sid against the exp_dom_sid
 218 *****************************************************************/
 219
 220 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32_t *rid)
 221 {
 222         if (!exp_dom_sid || !sid || !rid)
 223                 return false;
 224
 225         if (sid->num_auths != (exp_dom_sid->num_auths+1)) {
 226                 return false;
 227         }
 228
 229         if (sid_compare_domain(exp_dom_sid, sid)!=0){
 230                 *rid=(-1);
 231                 return false;
 232         }
 233
 234         return sid_peek_rid(sid, rid);
 235 }
 236
 237 /*****************************************************************
 238  Copies a sid
 239 *****************************************************************/
 240
 241 void sid_copy(struct dom_sid *dst, const struct dom_sid *src)
 242 {
 243         int i;
 244
 245         *dst = (struct dom_sid) {
 246                 .sid_rev_num = src->sid_rev_num,
 247                 .num_auths = src->num_auths,
 248         };
 249
 250         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
 251
 252         for (i = 0; i < src->num_auths; i++)
 253                 dst->sub_auths[i] = src->sub_auths[i];
 254 }
 255
 256 /*****************************************************************
 257  Parse a on-the-wire SID (in a DATA_BLOB) to a struct dom_sid.
 258 *****************************************************************/
 259
 260 bool sid_blob_parse(DATA_BLOB in, struct dom_sid *sid)
 261 {
 262         enum ndr_err_code ndr_err;
 263         ndr_err = ndr_pull_struct_blob_all(&in, NULL, sid,
 264                                            (ndr_pull_flags_fn_t)ndr_pull_dom_sid);
 265         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 266                 return false;
 267         }
 268         return true;
 269 }
 270
 271 /*****************************************************************
 272  Parse a on-the-wire SID to a struct dom_sid.
 273 *****************************************************************/
 274
 275 bool sid_parse(const char *inbuf, size_t len, struct dom_sid *sid)
 276 {
 277         DATA_BLOB in = data_blob_const(inbuf, len);
 278         return sid_blob_parse(in, sid);
 279 }
 280
 281 /*****************************************************************
 282  See if 2 SIDs are in the same domain
 283  this just compares the leading sub-auths
 284 *****************************************************************/
 285
 286 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2)
 287 {
 288         int n, i;
 289
 290         n = MIN(sid1->num_auths, sid2->num_auths);
 291
 292         for (i = n-1; i >= 0; --i)
 293                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
 294                         return sid1->sub_auths[i] - sid2->sub_auths[i];
 295
 296         return dom_sid_compare_auth(sid1, sid2);
 297 }
 298
 299 /********************************************************************
 300  Add SID to an array SIDs
 301 ********************************************************************/
 302
 303 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 304                           struct dom_sid **sids, uint32_t *num)
 305 {
 306         *sids = talloc_realloc(mem_ctx, *sids, struct dom_sid,
 307                                (*num)+1);
 308         if (*sids == NULL) {
 309                 *num = 0;
 310                 return NT_STATUS_NO_MEMORY;
 311         }
 312
 313         sid_copy(&((*sids)[*num]), sid);
 314         *num += 1;
 315
 316         return NT_STATUS_OK;
 317 }
 318
 319
 320 /********************************************************************
 321  Add SID to an array SIDs ensuring that it is not already there
 322 ********************************************************************/
 323
 324 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 325                                  struct dom_sid **sids, uint32_t *num_sids)
 326 {
 327         uint32_t i;
 328
 329         for (i=0; i<(*num_sids); i++) {
 330                 if (dom_sid_compare(sid, &(*sids)[i]) == 0)
 331                         return NT_STATUS_OK;
 332         }
 333
 334         return add_sid_to_array(mem_ctx, sid, sids, num_sids);
 335 }
 336
 337 /********************************************************************
 338  Remove SID from an array
 339 ********************************************************************/
 340
 341 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids,
 342                         uint32_t *num)
 343 {
 344         struct dom_sid *sid_list = *sids;
 345         uint32_t i;
 346
 347         for ( i=0; i<*num; i++ ) {
 348
 349                 /* if we find the SID, then decrement the count
 350                    and break out of the loop */
 351
 352                 if (dom_sid_equal(sid, &sid_list[i])) {
 353                         *num -= 1;
 354                         break;
 355                 }
 356         }
 357
 358         /* This loop will copy the remainder of the array
 359            if i < num of sids in the array */
 360
 361         for ( ; i<*num; i++ ) {
 362                 sid_copy( &sid_list[i], &sid_list[i+1] );
 363         }
 364
 365         return;
 366 }
 367
 368 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
 369                              uint32_t rid, uint32_t **pp_rids, size_t *p_num)
 370 {
 371         size_t i;
 372
 373         for (i=0; i<*p_num; i++) {
 374                 if ((*pp_rids)[i] == rid)
 375                         return true;
 376         }
 377
 378         *pp_rids = talloc_realloc(mem_ctx, *pp_rids, uint32_t, *p_num+1);
 379
 380         if (*pp_rids == NULL) {
 381                 *p_num = 0;
 382                 return false;
 383         }
 384
 385         (*pp_rids)[*p_num] = rid;
 386         *p_num += 1;
 387         return true;
 388 }
 389
 390 bool is_null_sid(const struct dom_sid *sid)
 391 {
 392         static const struct dom_sid null_sid = {0};
 393         return dom_sid_equal(sid, &null_sid);
 394 }