Replace sid_string_static by sid_string_dbg in DEBUGs
[tprouty/samba.git] / 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    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2005
10       
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 3 of the License, or
14    (at your option) any later version.
15    
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20    
21    You should have received a copy of the GNU General Public License
22    along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 */
24
25 #include "includes.h"
26
27 /*
28  * Some useful sids, more well known sids can be found at
29  * http://support.microsoft.com/kb/243330/EN-US/
30  */
31
32
33 const DOM_SID global_sid_World_Domain =               /* Everyone domain */
34 { 1, 0, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
35 const DOM_SID global_sid_World =                      /* Everyone */
36 { 1, 1, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
37 const DOM_SID global_sid_Creator_Owner_Domain =       /* Creator Owner domain */
38 { 1, 0, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
39 const DOM_SID global_sid_NT_Authority =                 /* NT Authority */
40 { 1, 0, {0,0,0,0,0,5}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
41 const DOM_SID global_sid_System =                       /* System */
42 { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
43 const DOM_SID global_sid_NULL =                         /* NULL sid */
44 { 1, 1, {0,0,0,0,0,0}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
45 const DOM_SID global_sid_Authenticated_Users =  /* All authenticated rids */
46 { 1, 1, {0,0,0,0,0,5}, {11,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
47 #if 0
48 /* for documentation */
49 const DOM_SID global_sid_Restriced =                    /* Restriced Code */
50 { 1, 1, {0,0,0,0,0,5}, {12,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
51 #endif
52 const DOM_SID global_sid_Network =                      /* Network rids */
53 { 1, 1, {0,0,0,0,0,5}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
54
55 const DOM_SID global_sid_Creator_Owner =                /* Creator Owner */
56 { 1, 1, {0,0,0,0,0,3}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
57 const DOM_SID global_sid_Creator_Group =                /* Creator Group */
58 { 1, 1, {0,0,0,0,0,3}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
59 const DOM_SID global_sid_Anonymous =                    /* Anonymous login */
60 { 1, 1, {0,0,0,0,0,5}, {7,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
61
62 const DOM_SID global_sid_Builtin =                      /* Local well-known domain */
63 { 1, 1, {0,0,0,0,0,5}, {32,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
64 const DOM_SID global_sid_Builtin_Administrators =       /* Builtin administrators */
65 { 1, 2, {0,0,0,0,0,5}, {32,544,0,0,0,0,0,0,0,0,0,0,0,0,0}};
66 const DOM_SID global_sid_Builtin_Users =                /* Builtin users */
67 { 1, 2, {0,0,0,0,0,5}, {32,545,0,0,0,0,0,0,0,0,0,0,0,0,0}};
68 const DOM_SID global_sid_Builtin_Guests =               /* Builtin guest users */
69 { 1, 2, {0,0,0,0,0,5}, {32,546,0,0,0,0,0,0,0,0,0,0,0,0,0}};
70 const DOM_SID global_sid_Builtin_Power_Users =  /* Builtin power users */
71 { 1, 2, {0,0,0,0,0,5}, {32,547,0,0,0,0,0,0,0,0,0,0,0,0,0}};
72 const DOM_SID global_sid_Builtin_Account_Operators =    /* Builtin account operators */
73 { 1, 2, {0,0,0,0,0,5}, {32,548,0,0,0,0,0,0,0,0,0,0,0,0,0}};
74 const DOM_SID global_sid_Builtin_Server_Operators =     /* Builtin server operators */
75 { 1, 2, {0,0,0,0,0,5}, {32,549,0,0,0,0,0,0,0,0,0,0,0,0,0}};
76 const DOM_SID global_sid_Builtin_Print_Operators =      /* Builtin print operators */
77 { 1, 2, {0,0,0,0,0,5}, {32,550,0,0,0,0,0,0,0,0,0,0,0,0,0}};
78 const DOM_SID global_sid_Builtin_Backup_Operators =     /* Builtin backup operators */
79 { 1, 2, {0,0,0,0,0,5}, {32,551,0,0,0,0,0,0,0,0,0,0,0,0,0}};
80 const DOM_SID global_sid_Builtin_Replicator =           /* Builtin replicator */
81 { 1, 2, {0,0,0,0,0,5}, {32,552,0,0,0,0,0,0,0,0,0,0,0,0,0}};
82 const DOM_SID global_sid_Builtin_PreWin2kAccess =       /* Builtin pre win2k access */
83 { 1, 2, {0,0,0,0,0,5}, {32,554,0,0,0,0,0,0,0,0,0,0,0,0,0}};
84
85 const DOM_SID global_sid_Unix_Users =                   /* Unmapped Unix users */
86 { 1, 1, {0,0,0,0,0,22}, {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
87 const DOM_SID global_sid_Unix_Groups =                  /* Unmapped Unix groups */
88 { 1, 1, {0,0,0,0,0,22}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}};
89
90 /* Unused, left here for documentary purposes */
91 #if 0
92 #define SECURITY_NULL_SID_AUTHORITY    0
93 #define SECURITY_WORLD_SID_AUTHORITY   1
94 #define SECURITY_LOCAL_SID_AUTHORITY   2
95 #define SECURITY_CREATOR_SID_AUTHORITY 3
96 #define SECURITY_NT_AUTHORITY          5
97 #endif
98
99 /*
100  * An NT compatible anonymous token.
101  */
102
103 static DOM_SID anon_sid_array[3] =
104 { { 1, 1, {0,0,0,0,0,1}, {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}},
105   { 1, 1, {0,0,0,0,0,5}, {2,0,0,0,0,0,0,0,0,0,0,0,0,0,0}},
106   { 1, 1, {0,0,0,0,0,5}, {7,0,0,0,0,0,0,0,0,0,0,0,0,0,0}} };
107 NT_USER_TOKEN anonymous_token = { 3, anon_sid_array, SE_NONE };
108
109 static DOM_SID system_sid_array[1] =
110 { { 1, 1, {0,0,0,0,0,5}, {18,0,0,0,0,0,0,0,0,0,0,0,0,0,0}} };
111 NT_USER_TOKEN system_token = { 1, system_sid_array, SE_ALL_PRIVS };
112
113 /****************************************************************************
114  Lookup string names for SID types.
115 ****************************************************************************/
116
117 static const struct {
118         enum lsa_SidType sid_type;
119         const char *string;
120 } sid_name_type[] = {
121         {SID_NAME_USER, "User"},
122         {SID_NAME_DOM_GRP, "Domain Group"},
123         {SID_NAME_DOMAIN, "Domain"},
124         {SID_NAME_ALIAS, "Local Group"},
125         {SID_NAME_WKN_GRP, "Well-known Group"},
126         {SID_NAME_DELETED, "Deleted Account"},
127         {SID_NAME_INVALID, "Invalid Account"},
128         {SID_NAME_UNKNOWN, "UNKNOWN"},
129         {SID_NAME_COMPUTER, "Computer"},
130
131         {(enum lsa_SidType)0, NULL}
132 };
133
134 const char *sid_type_lookup(uint32 sid_type) 
135 {
136         int i = 0;
137
138         /* Look through list */
139         while(sid_name_type[i].sid_type != 0) {
140                 if (sid_name_type[i].sid_type == sid_type)
141                         return sid_name_type[i].string;
142                 i++;
143         }
144
145         /* Default return */
146         return "SID *TYPE* is INVALID";
147 }
148
149 /**************************************************************************
150  Create the SYSTEM token.
151 ***************************************************************************/
152
153 NT_USER_TOKEN *get_system_token(void) 
154 {
155         return &system_token;
156 }
157
158 /******************************************************************
159  get the default domain/netbios name to be used when dealing 
160  with our passdb list of accounts
161 ******************************************************************/
162
163 const char *get_global_sam_name(void) 
164 {
165         if ((lp_server_role() == ROLE_DOMAIN_PDC) || (lp_server_role() == ROLE_DOMAIN_BDC)) {
166                 return lp_workgroup();
167         }
168         return global_myname();
169 }
170
171 /*****************************************************************
172  Convert a SID to an ascii string.
173 *****************************************************************/
174
175 char *sid_to_string(fstring sidstr_out, const DOM_SID *sid)
176 {
177         char subauth[16];
178         int i;
179         uint32 ia;
180   
181         if (!sid) {
182                 fstrcpy(sidstr_out, "(NULL SID)");
183                 return sidstr_out;
184         }
185
186         /*
187          * BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 
188          * in a range of 2^48.
189          */
190         ia = (sid->id_auth[5]) +
191                 (sid->id_auth[4] << 8 ) +
192                 (sid->id_auth[3] << 16) +
193                 (sid->id_auth[2] << 24);
194
195         slprintf(sidstr_out, sizeof(fstring) - 1, "S-%u-%lu", (unsigned int)sid->sid_rev_num, (unsigned long)ia);
196
197         for (i = 0; i < sid->num_auths; i++) {
198                 slprintf(subauth, sizeof(subauth)-1, "-%lu", (unsigned long)sid->sub_auths[i]);
199                 fstrcat(sidstr_out, subauth);
200         }
201
202         return sidstr_out;
203 }
204
205 /*****************************************************************
206  Useful function for debug lines.
207 *****************************************************************/  
208
209 const char *sid_string_static(const DOM_SID *sid)
210 {
211         static fstring sid_str;
212         sid_to_string(sid_str, sid);
213         return sid_str;
214 }
215
216 char *sid_string_talloc(TALLOC_CTX *mem_ctx, const DOM_SID *sid)
217 {
218         fstring sid_str;
219         char *result;
220         sid_to_string(sid_str, sid);
221         result = talloc_strdup(mem_ctx, sid_str);
222         SMB_ASSERT(result != NULL);
223         return result;
224 }
225
226 char *sid_string_dbg(const DOM_SID *sid)
227 {
228         return sid_string_talloc(debug_ctx(), sid);
229 }
230
231 char *sid_string_tos(const DOM_SID *sid)
232 {
233         return sid_string_talloc(talloc_tos(), sid);
234 }
235
236 /*****************************************************************
237  Convert a string to a SID. Returns True on success, False on fail.
238 *****************************************************************/  
239    
240 bool string_to_sid(DOM_SID *sidout, const char *sidstr)
241 {
242         const char *p;
243         char *q;
244         /* BIG NOTE: this function only does SIDS where the identauth is not >= 2^32 */
245         uint32 conv;
246   
247         if ((sidstr[0] != 'S' && sidstr[0] != 's') || sidstr[1] != '-') {
248                 DEBUG(3,("string_to_sid: Sid %s does not start with 'S-'.\n", sidstr));
249                 return False;
250         }
251
252         ZERO_STRUCTP(sidout);
253
254         /* Get the revision number. */
255         p = sidstr + 2;
256         conv = (uint32) strtoul(p, &q, 10);
257         if (!q || (*q != '-')) {
258                 DEBUG(3,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
259                 return False;
260         }
261         sidout->sid_rev_num = (uint8) conv;
262         q++;
263
264         /* get identauth */
265         conv = (uint32) strtoul(q, &q, 10);
266         if (!q || (*q != '-')) {
267                 DEBUG(0,("string_to_sid: Sid %s is not in a valid format.\n", sidstr));
268                 return False;
269         }
270         /* identauth in decimal should be <  2^32 */
271         /* NOTE - the conv value is in big-endian format. */
272         sidout->id_auth[0] = 0;
273         sidout->id_auth[1] = 0;
274         sidout->id_auth[2] = (conv & 0xff000000) >> 24;
275         sidout->id_auth[3] = (conv & 0x00ff0000) >> 16;
276         sidout->id_auth[4] = (conv & 0x0000ff00) >> 8;
277         sidout->id_auth[5] = (conv & 0x000000ff);
278
279         q++;
280         sidout->num_auths = 0;
281
282         for(conv = (uint32) strtoul(q, &q, 10);
283             q && (*q =='-' || *q =='\0') && (sidout->num_auths < MAXSUBAUTHS);
284             conv = (uint32) strtoul(q, &q, 10)) {
285                 sid_append_rid(sidout, conv);
286                 if (*q == '\0')
287                         break;
288                 q++;
289         }
290                 
291         return True;
292 }
293
294 DOM_SID *string_sid_talloc(TALLOC_CTX *mem_ctx, const char *sidstr)
295 {
296         DOM_SID *result = TALLOC_P(mem_ctx, DOM_SID);
297
298         if (result == NULL)
299                 return NULL;
300
301         if (!string_to_sid(result, sidstr))
302                 return NULL;
303
304         return result;
305 }
306
307 /*****************************************************************
308  Add a rid to the end of a sid
309 *****************************************************************/  
310
311 bool sid_append_rid(DOM_SID *sid, uint32 rid)
312 {
313         if (sid->num_auths < MAXSUBAUTHS) {
314                 sid->sub_auths[sid->num_auths++] = rid;
315                 return True;
316         }
317         return False;
318 }
319
320 bool sid_compose(DOM_SID *dst, const DOM_SID *domain_sid, uint32 rid)
321 {
322         sid_copy(dst, domain_sid);
323         return sid_append_rid(dst, rid);
324 }
325
326 /*****************************************************************
327  Removes the last rid from the end of a sid
328 *****************************************************************/  
329
330 bool sid_split_rid(DOM_SID *sid, uint32 *rid)
331 {
332         if (sid->num_auths > 0) {
333                 sid->num_auths--;
334                 *rid = sid->sub_auths[sid->num_auths];
335                 return True;
336         }
337         return False;
338 }
339
340 /*****************************************************************
341  Return the last rid from the end of a sid
342 *****************************************************************/  
343
344 bool sid_peek_rid(const DOM_SID *sid, uint32 *rid)
345 {
346         if (!sid || !rid)
347                 return False;           
348         
349         if (sid->num_auths > 0) {
350                 *rid = sid->sub_auths[sid->num_auths - 1];
351                 return True;
352         }
353         return False;
354 }
355
356 /*****************************************************************
357  Return the last rid from the end of a sid
358  and check the sid against the exp_dom_sid  
359 *****************************************************************/  
360
361 bool sid_peek_check_rid(const DOM_SID *exp_dom_sid, const DOM_SID *sid, uint32 *rid)
362 {
363         if (!exp_dom_sid || !sid || !rid)
364                 return False;
365                         
366         if (sid->num_auths != (exp_dom_sid->num_auths+1)) {
367                 return False;
368         }
369
370         if (sid_compare_domain(exp_dom_sid, sid)!=0){
371                 *rid=(-1);
372                 return False;
373         }
374         
375         return sid_peek_rid(sid, rid);
376 }
377
378 /*****************************************************************
379  Copies a sid
380 *****************************************************************/  
381
382 void sid_copy(DOM_SID *dst, const DOM_SID *src)
383 {
384         int i;
385
386         ZERO_STRUCTP(dst);
387
388         dst->sid_rev_num = src->sid_rev_num;
389         dst->num_auths = src->num_auths;
390
391         memcpy(&dst->id_auth[0], &src->id_auth[0], sizeof(src->id_auth));
392
393         for (i = 0; i < src->num_auths; i++)
394                 dst->sub_auths[i] = src->sub_auths[i];
395 }
396
397 /*****************************************************************
398  Write a sid out into on-the-wire format.
399 *****************************************************************/  
400
401 bool sid_linearize(char *outbuf, size_t len, const DOM_SID *sid)
402 {
403         size_t i;
404
405         if (len < sid_size(sid))
406                 return False;
407
408         SCVAL(outbuf,0,sid->sid_rev_num);
409         SCVAL(outbuf,1,sid->num_auths);
410         memcpy(&outbuf[2], sid->id_auth, 6);
411         for(i = 0; i < sid->num_auths; i++)
412                 SIVAL(outbuf, 8 + (i*4), sid->sub_auths[i]);
413
414         return True;
415 }
416
417 /*****************************************************************
418  Parse a on-the-wire SID to a DOM_SID.
419 *****************************************************************/  
420
421 bool sid_parse(const char *inbuf, size_t len, DOM_SID *sid)
422 {
423         int i;
424         if (len < 8)
425                 return False;
426
427         ZERO_STRUCTP(sid);
428
429         sid->sid_rev_num = CVAL(inbuf, 0);
430         sid->num_auths = CVAL(inbuf, 1);
431         memcpy(sid->id_auth, inbuf+2, 6);
432         if (len < 8 + sid->num_auths*4)
433                 return False;
434         for (i=0;i<sid->num_auths;i++)
435                 sid->sub_auths[i] = IVAL(inbuf, 8+i*4);
436         return True;
437 }
438
439 /*****************************************************************
440  Compare the auth portion of two sids.
441 *****************************************************************/  
442
443 static int sid_compare_auth(const DOM_SID *sid1, const DOM_SID *sid2)
444 {
445         int i;
446
447         if (sid1 == sid2)
448                 return 0;
449         if (!sid1)
450                 return -1;
451         if (!sid2)
452                 return 1;
453
454         if (sid1->sid_rev_num != sid2->sid_rev_num)
455                 return sid1->sid_rev_num - sid2->sid_rev_num;
456
457         for (i = 0; i < 6; i++)
458                 if (sid1->id_auth[i] != sid2->id_auth[i])
459                         return sid1->id_auth[i] - sid2->id_auth[i];
460
461         return 0;
462 }
463
464 /*****************************************************************
465  Compare two sids.
466 *****************************************************************/  
467
468 int sid_compare(const DOM_SID *sid1, const DOM_SID *sid2)
469 {
470         int i;
471
472         if (sid1 == sid2)
473                 return 0;
474         if (!sid1)
475                 return -1;
476         if (!sid2)
477                 return 1;
478
479         /* Compare most likely different rids, first: i.e start at end */
480         if (sid1->num_auths != sid2->num_auths)
481                 return sid1->num_auths - sid2->num_auths;
482
483         for (i = sid1->num_auths-1; i >= 0; --i)
484                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
485                         return sid1->sub_auths[i] - sid2->sub_auths[i];
486
487         return sid_compare_auth(sid1, sid2);
488 }
489
490 /*****************************************************************
491  See if 2 SIDs are in the same domain
492  this just compares the leading sub-auths
493 *****************************************************************/  
494
495 int sid_compare_domain(const DOM_SID *sid1, const DOM_SID *sid2)
496 {
497         int n, i;
498
499         n = MIN(sid1->num_auths, sid2->num_auths);
500
501         for (i = n-1; i >= 0; --i)
502                 if (sid1->sub_auths[i] != sid2->sub_auths[i])
503                         return sid1->sub_auths[i] - sid2->sub_auths[i];
504
505         return sid_compare_auth(sid1, sid2);
506 }
507
508 /*****************************************************************
509  Compare two sids.
510 *****************************************************************/  
511
512 bool sid_equal(const DOM_SID *sid1, const DOM_SID *sid2)
513 {
514         return sid_compare(sid1, sid2) == 0;
515 }
516
517 /*****************************************************************
518  Calculates size of a sid.
519 *****************************************************************/  
520
521 size_t sid_size(const DOM_SID *sid)
522 {
523         if (sid == NULL)
524                 return 0;
525
526         return sid->num_auths * sizeof(uint32) + 8;
527 }
528
529 /*****************************************************************
530  Returns true if SID is internal (and non-mappable).
531 *****************************************************************/
532
533 bool non_mappable_sid(DOM_SID *sid)
534 {
535         DOM_SID dom;
536         uint32 rid;
537
538         sid_copy(&dom, sid);
539         sid_split_rid(&dom, &rid);
540
541         if (sid_equal(&dom, &global_sid_Builtin))
542                 return True;
543
544         if (sid_equal(&dom, &global_sid_NT_Authority))
545                 return True;
546
547         return False;
548 }
549
550 /*****************************************************************
551  Return the binary string representation of a DOM_SID.
552  Caller must free.
553 *****************************************************************/
554
555 char *sid_binstring(const DOM_SID *sid)
556 {
557         char *buf, *s;
558         int len = sid_size(sid);
559         buf = (char *)SMB_MALLOC(len);
560         if (!buf)
561                 return NULL;
562         sid_linearize(buf, len, sid);
563         s = binary_string_rfc2254(buf, len);
564         free(buf);
565         return s;
566 }
567
568 /*****************************************************************
569  Return the binary string representation of a DOM_SID.
570  Caller must free.
571 *****************************************************************/
572
573 char *sid_binstring_hex(const DOM_SID *sid)
574 {
575         char *buf, *s;
576         int len = sid_size(sid);
577         buf = (char *)SMB_MALLOC(len);
578         if (!buf)
579                 return NULL;
580         sid_linearize(buf, len, sid);
581         s = binary_string(buf, len);
582         free(buf);
583         return s;
584 }
585
586 /*******************************************************************
587  Tallocs a duplicate SID. 
588 ********************************************************************/ 
589
590 DOM_SID *sid_dup_talloc(TALLOC_CTX *ctx, const DOM_SID *src)
591 {
592         DOM_SID *dst;
593         
594         if(!src)
595                 return NULL;
596         
597         if((dst = TALLOC_ZERO_P(ctx, DOM_SID)) != NULL) {
598                 sid_copy( dst, src);
599         }
600         
601         return dst;
602 }
603
604 /********************************************************************
605  Add SID to an array SIDs
606 ********************************************************************/
607
608 bool add_sid_to_array(TALLOC_CTX *mem_ctx, const DOM_SID *sid, 
609                       DOM_SID **sids, size_t *num)
610 {
611         *sids = TALLOC_REALLOC_ARRAY(mem_ctx, *sids, DOM_SID,
612                                              (*num)+1);
613         if (*sids == NULL) {
614                 *num = 0;
615                 return False;
616         }
617
618         sid_copy(&((*sids)[*num]), sid);
619         *num += 1;
620
621         return True;
622 }
623
624
625 /********************************************************************
626  Add SID to an array SIDs ensuring that it is not already there
627 ********************************************************************/
628
629 bool add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const DOM_SID *sid,
630                              DOM_SID **sids, size_t *num_sids)
631 {
632         size_t i;
633
634         for (i=0; i<(*num_sids); i++) {
635                 if (sid_compare(sid, &(*sids)[i]) == 0)
636                         return True;
637         }
638
639         return add_sid_to_array(mem_ctx, sid, sids, num_sids);
640 }
641
642 /********************************************************************
643  Remove SID from an array
644 ********************************************************************/
645
646 void del_sid_from_array(const DOM_SID *sid, DOM_SID **sids, size_t *num)
647 {
648         DOM_SID *sid_list = *sids;
649         size_t i;
650
651         for ( i=0; i<*num; i++ ) {
652
653                 /* if we find the SID, then decrement the count
654                    and break out of the loop */
655
656                 if ( sid_equal(sid, &sid_list[i]) ) {
657                         *num -= 1;
658                         break;
659                 }
660         }
661
662         /* This loop will copy the remainder of the array 
663            if i < num of sids ni the array */
664
665         for ( ; i<*num; i++ ) 
666                 sid_copy( &sid_list[i], &sid_list[i+1] );
667         
668         return;
669 }
670
671 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
672                                     uint32 rid, uint32 **pp_rids, size_t *p_num)
673 {
674         size_t i;
675
676         for (i=0; i<*p_num; i++) {
677                 if ((*pp_rids)[i] == rid)
678                         return True;
679         }
680         
681         *pp_rids = TALLOC_REALLOC_ARRAY(mem_ctx, *pp_rids, uint32, *p_num+1);
682
683         if (*pp_rids == NULL) {
684                 *p_num = 0;
685                 return False;
686         }
687
688         (*pp_rids)[*p_num] = rid;
689         *p_num += 1;
690         return True;
691 }
692
693 bool is_null_sid(const DOM_SID *sid)
694 {
695         static const DOM_SID null_sid = {0};
696         return sid_equal(sid, &null_sid);
697 }
698
699 NTSTATUS sid_array_from_info3(TALLOC_CTX *mem_ctx,
700                               const NET_USER_INFO_3 *info3,
701                               DOM_SID **user_sids,
702                               size_t *num_user_sids,
703                               bool include_user_group_rid)
704 {
705         DOM_SID sid;
706         DOM_SID *sid_array = NULL;
707         size_t num_sids = 0;
708         int i;
709
710         if (include_user_group_rid) {
711
712                 if (!sid_compose(&sid, &(info3->dom_sid.sid),
713                                  info3->user_rid)
714                     || !add_sid_to_array(mem_ctx, &sid,
715                                          &sid_array, &num_sids)) {
716                         DEBUG(3,("could not add user SID from rid 0x%x\n",
717                                  info3->user_rid));                     
718                         return NT_STATUS_INVALID_PARAMETER;
719                 }
720
721                 if (!sid_compose(&sid, &(info3->dom_sid.sid),
722                                  info3->group_rid)
723                     || !add_sid_to_array(mem_ctx, &sid, 
724                                          &sid_array, &num_sids)) {
725                         DEBUG(3,("could not append additional group rid 0x%x\n",
726                                  info3->group_rid));                    
727                         
728                         return NT_STATUS_INVALID_PARAMETER;
729                 }
730         }
731
732         for (i = 0; i < info3->num_groups2; i++) {
733                 if (!sid_compose(&sid, &(info3->dom_sid.sid),
734                                  info3->gids[i].g_rid)
735                     || !add_sid_to_array(mem_ctx, &sid,
736                                          &sid_array, &num_sids)) {
737                         DEBUG(3,("could not append additional group rid 0x%x\n",
738                                  info3->gids[i].g_rid));        
739                         return NT_STATUS_INVALID_PARAMETER;
740                 }
741         }
742
743         /* Copy 'other' sids.  We need to do sid filtering here to
744            prevent possible elevation of privileges.  See:
745
746            http://www.microsoft.com/windows2000/techinfo/administration/security/sidfilter.asp
747          */
748
749         for (i = 0; i < info3->num_other_sids; i++) {
750                 if (!add_sid_to_array(mem_ctx, &info3->other_sids[i].sid,
751                                       &sid_array, &num_sids)) {
752                         DEBUG(3, ("could not add SID to array: %s\n",
753                                   sid_string_dbg(&info3->other_sids[i].sid)));
754                         return NT_STATUS_NO_MEMORY;
755                 }
756         }
757
758         *user_sids = sid_array;
759         *num_user_sids = num_sids;
760
761         return NT_STATUS_OK;
762 }