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_Anonymous =                     /* Anonymous login */
  66 { 1, 1, {0,0,0,0,0,5}, {7,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  67 const struct dom_sid global_sid_Enterprise_DCs =                /* Enterprise DCs */
  68 { 1, 1, {0,0,0,0,0,5}, {9,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  69 const struct dom_sid global_sid_Builtin =                       /* Local well-known domain */
  70 { 1, 1, {0,0,0,0,0,5}, {32,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  71 const struct dom_sid global_sid_Builtin_Administrators =        /* Builtin administrators */
  72 { 1, 2, {0,0,0,0,0,5}, {32,544,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  73 const struct dom_sid global_sid_Builtin_Users =         /* Builtin users */
  74 { 1, 2, {0,0,0,0,0,5}, {32,545,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  75 const struct dom_sid global_sid_Builtin_Guests =                /* Builtin guest users */
  76 { 1, 2, {0,0,0,0,0,5}, {32,546,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  77 const struct dom_sid global_sid_Builtin_Power_Users =   /* Builtin power users */
  78 { 1, 2, {0,0,0,0,0,5}, {32,547,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  79 const struct dom_sid global_sid_Builtin_Account_Operators =     /* Builtin account operators */
  80 { 1, 2, {0,0,0,0,0,5}, {32,548,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  81 const struct dom_sid global_sid_Builtin_Server_Operators =      /* Builtin server operators */
  82 { 1, 2, {0,0,0,0,0,5}, {32,549,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  83 const struct dom_sid global_sid_Builtin_Print_Operators =       /* Builtin print operators */
  84 { 1, 2, {0,0,0,0,0,5}, {32,550,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  85 const struct dom_sid global_sid_Builtin_Backup_Operators =      /* Builtin backup operators */
  86 { 1, 2, {0,0,0,0,0,5}, {32,551,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  87 const struct dom_sid global_sid_Builtin_Replicator =            /* Builtin replicator */
  88 { 1, 2, {0,0,0,0,0,5}, {32,552,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  89 const struct dom_sid global_sid_Builtin_PreWin2kAccess =        /* Builtin pre win2k access */
  90 { 1, 2, {0,0,0,0,0,5}, {32,554,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  91
  92 const struct dom_sid global_sid_Unix_Users =                    /* Unmapped Unix users */
  93 { 1, 1, {0,0,0,0,0,22}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  94 const struct dom_sid global_sid_Unix_Groups =                   /* Unmapped Unix groups */
  95 { 1, 1, {0,0,0,0,0,22}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
  96
  97 /* Unused, left here for documentary purposes */
  98 #if 0
  99 #define SECURITY_NULL_SID_AUTHORITY    0
 100 #define SECURITY_WORLD_SID_AUTHORITY   1
 101 #define SECURITY_LOCAL_SID_AUTHORITY   2
 102 #define SECURITY_CREATOR_SID_AUTHORITY 3
 103 #define SECURITY_NT_AUTHORITY          5
 104 #endif
 105
 106 static struct dom_sid system_sid_array[1] =
 107 { { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}} };
 108 static const struct security_token system_token = {
 109         .num_sids       = ARRAY_SIZE(system_sid_array),
 110         .sids           = system_sid_array,
 111         .privilege_mask = SE_ALL_PRIVS
 112 };
 113
 114 /****************************************************************************
 115  Lookup string names for SID types.
 116 ****************************************************************************/
 117
 118 static const struct {
 119         enum lsa_SidType sid_type;
 120         const char *string;
 121 } sid_name_type[] = {
 122         {SID_NAME_USE_NONE, "None"},
 123         {SID_NAME_USER, "User"},
 124         {SID_NAME_DOM_GRP, "Domain Group"},
 125         {SID_NAME_DOMAIN, "Domain"},
 126         {SID_NAME_ALIAS, "Local Group"},
 127         {SID_NAME_WKN_GRP, "Well-known Group"},
 128         {SID_NAME_DELETED, "Deleted Account"},
 129         {SID_NAME_INVALID, "Invalid Account"},
 130         {SID_NAME_UNKNOWN, "UNKNOWN"},
 131         {SID_NAME_COMPUTER, "Computer"}
 132 };
 133
 134 const char *sid_type_lookup(uint32_t sid_type)
 135 {
 136         int i;
 137
 138         /* Look through list */
 139         for (i=0; i < ARRAY_SIZE(sid_name_type); i++) {
 140                 if (sid_name_type[i].sid_type == sid_type) {
 141                         return sid_name_type[i].string;
 142                 }
 143         }
 144
 145         /* Default return */
 146         return "SID *TYPE* is INVALID";
 147 }
 148
 149 /**************************************************************************
 150  Create the SYSTEM token.
 151 ***************************************************************************/
 152
 153 const struct security_token *get_system_token(void)
 154 {
 155         return &system_token;
 156 }
 157
 158 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32_t rid)
 159 {
 160         sid_copy(dst, domain_sid);
 161         return sid_append_rid(dst, rid);
 162 }
 163
 164 /*****************************************************************
 165  Removes the last rid from the end of a sid
 166 *****************************************************************/
 167
 168 bool sid_split_rid(struct dom_sid *sid, uint32_t *rid)
 169 {
 170         if (sid->num_auths > 0) {
 171                 sid->num_auths--;
 172                 if (rid != NULL) {
 173                         *rid = sid->sub_auths[sid->num_auths];
 174                 }
 175                 return true;
 176         }
 177         return false;
 178 }
 179
 180 /*****************************************************************
 181  Return the last rid from the end of a sid
 182 *****************************************************************/
 183
 184 bool sid_peek_rid(const struct dom_sid *sid, uint32_t *rid)
 185 {
 186         if (!sid || !rid)
 187                 return false;
 188
 189         if (sid->num_auths > 0) {
 190                 *rid = sid->sub_auths[sid->num_auths - 1];
 191                 return true;
 192         }
 193         return false;
 194 }
 195
 196 /*****************************************************************
 197  Return the last rid from the end of a sid
 198  and check the sid against the exp_dom_sid
 199 *****************************************************************/
 200
 201 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32_t *rid)
 202 {
 203         if (!exp_dom_sid || !sid || !rid)
 204                 return false;
 205
 206         if (sid->num_auths != (exp_dom_sid->num_auths+1)) {
 207                 return false;
 208         }
 209
 210         if (sid_compare_domain(exp_dom_sid, sid)!=0){
 211                 *rid=(-1);
 212                 return false;
 213         }
 214
 215         return sid_peek_rid(sid, rid);
 216 }
 217
 218 /*****************************************************************
 219  Copies a sid
 220 *****************************************************************/
 221
 222 void sid_copy(struct dom_sid *dst, const struct dom_sid *src)
 223 {
 224         int i;
 225
 226         ZERO_STRUCTP(dst);
 227
 228         dst->sid_rev_num = src->sid_rev_num;
 229         dst->num_auths = src->num_auths;
 230
 231         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
 232
 233         for (i = 0; i < src->num_auths; i++)
 234                 dst->sub_auths[i] = src->sub_auths[i];
 235 }
 236
 237 /*****************************************************************
 238  Parse a on-the-wire SID (in a DATA_BLOB) to a struct dom_sid.
 239 *****************************************************************/
 240
 241 bool sid_blob_parse(DATA_BLOB in, struct dom_sid *sid)
 242 {
 243         enum ndr_err_code ndr_err;
 244         ndr_err = ndr_pull_struct_blob_all(&in, NULL, sid,
 245                                            (ndr_pull_flags_fn_t)ndr_pull_dom_sid);
 246         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 247                 return false;
 248         }
 249         return true;
 250 }
 251
 252 /*****************************************************************
 253  Parse a on-the-wire SID to a struct dom_sid.
 254 *****************************************************************/
 255
 256 bool sid_parse(const char *inbuf, size_t len, struct dom_sid *sid)
 257 {
 258         DATA_BLOB in = data_blob_const(inbuf, len);
 259         return sid_blob_parse(in, sid);
 260 }
 261
 262 /*****************************************************************
 263  See if 2 SIDs are in the same domain
 264  this just compares the leading sub-auths
 265 *****************************************************************/
 266
 267 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2)
 268 {
 269         int n, i;
 270
 271         n = MIN(sid1->num_auths, sid2->num_auths);
 272
 273         for (i = n-1; i >= 0; --i)
 274                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
 275                         return sid1->sub_auths[i] - sid2->sub_auths[i];
 276
 277         return dom_sid_compare_auth(sid1, sid2);
 278 }
 279
 280 /********************************************************************
 281  Add SID to an array SIDs
 282 ********************************************************************/
 283
 284 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 285                           struct dom_sid **sids, uint32_t *num)
 286 {
 287         *sids = talloc_realloc(mem_ctx, *sids, struct dom_sid,
 288                                (*num)+1);
 289         if (*sids == NULL) {
 290                 *num = 0;
 291                 return NT_STATUS_NO_MEMORY;
 292         }
 293
 294         sid_copy(&((*sids)[*num]), sid);
 295         *num += 1;
 296
 297         return NT_STATUS_OK;
 298 }
 299
 300
 301 /********************************************************************
 302  Add SID to an array SIDs ensuring that it is not already there
 303 ********************************************************************/
 304
 305 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 306                                  struct dom_sid **sids, uint32_t *num_sids)
 307 {
 308         uint32_t i;
 309
 310         for (i=0; i<(*num_sids); i++) {
 311                 if (dom_sid_compare(sid, &(*sids)[i]) == 0)
 312                         return NT_STATUS_OK;
 313         }
 314
 315         return add_sid_to_array(mem_ctx, sid, sids, num_sids);
 316 }
 317
 318 /********************************************************************
 319  Remove SID from an array
 320 ********************************************************************/
 321
 322 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids,
 323                         uint32_t *num)
 324 {
 325         struct dom_sid *sid_list = *sids;
 326         uint32_t i;
 327
 328         for ( i=0; i<*num; i++ ) {
 329
 330                 /* if we find the SID, then decrement the count
 331                    and break out of the loop */
 332
 333                 if (dom_sid_equal(sid, &sid_list[i])) {
 334                         *num -= 1;
 335                         break;
 336                 }
 337         }
 338
 339         /* This loop will copy the remainder of the array
 340            if i < num of sids in the array */
 341
 342         for ( ; i<*num; i++ ) {
 343                 sid_copy( &sid_list[i], &sid_list[i+1] );
 344         }
 345
 346         return;
 347 }
 348
 349 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
 350                              uint32_t rid, uint32_t **pp_rids, size_t *p_num)
 351 {
 352         size_t i;
 353
 354         for (i=0; i<*p_num; i++) {
 355                 if ((*pp_rids)[i] == rid)
 356                         return true;
 357         }
 358
 359         *pp_rids = talloc_realloc(mem_ctx, *pp_rids, uint32_t, *p_num+1);
 360
 361         if (*pp_rids == NULL) {
 362                 *p_num = 0;
 363                 return false;
 364         }
 365
 366         (*pp_rids)[*p_num] = rid;
 367         *p_num += 1;
 368         return true;
 369 }
 370
 371 bool is_null_sid(const struct dom_sid *sid)
 372 {
 373         static const struct dom_sid null_sid = {0};
 374         return dom_sid_equal(sid, &null_sid);
 375 }