Tidy up args to DEBUG Statements - found by gcc on Solaris.
[tprouty/samba.git] / source / smbd / sec_ctx.c
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    uid/user handling
5    Copyright (C) Tim Potter 2000
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #include "includes.h"
23
24 extern int DEBUGLEVEL;
25 extern struct current_user current_user;
26
27 struct sec_ctx {
28         uid_t uid;
29         uid_t gid;
30         int ngroups;
31         gid_t *groups;
32         NT_USER_TOKEN *token;
33 };
34
35 /* A stack of security contexts.  We include the current context as being
36    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
37
38 static struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
39 static int sec_ctx_stack_ndx;
40
41 /****************************************************************************
42  Become the specified uid.
43 ****************************************************************************/
44
45 static BOOL become_uid(uid_t uid)
46 {
47         /* Check for dodgy uid values */
48
49         if (uid == (uid_t)-1 || 
50             ((sizeof(uid_t) == 2) && (uid == (uid_t)65535))) {
51                 static int done;
52  
53                 if (!done) {
54                         DEBUG(1,("WARNING: using uid %d is a security risk\n",
55                                  (int)uid));
56                         done = 1;
57                 }
58         }
59
60         /* Set effective user id */
61
62         set_effective_uid(uid);
63         current_user.uid = uid;
64
65         DO_PROFILE_INC(uid_changes);
66
67         return True;
68 }
69
70 /****************************************************************************
71  Become the specified gid.
72 ****************************************************************************/
73
74 static BOOL become_gid(gid_t gid)
75 {
76         /* Check for dodgy gid values */
77
78         if (gid == (gid_t)-1 || ((sizeof(gid_t) == 2) && 
79                                  (gid == (gid_t)65535))) {
80                 static int done;
81                 
82                 if (!done) {
83                         DEBUG(1,("WARNING: using gid %d is a security risk\n",
84                                  (int)gid));  
85                         done = 1;
86                 }
87         }
88   
89         /* Set effective group id */
90
91         set_effective_gid(gid);
92         current_user.gid = gid;
93         
94         return True;
95 }
96
97 /****************************************************************************
98  Become the specified uid and gid.
99 ****************************************************************************/
100
101 static BOOL become_id(uid_t uid, gid_t gid)
102 {
103         return become_gid(gid) && become_uid(uid);
104 }
105
106 /****************************************************************************
107  Drop back to root privileges in order to change to another user.
108 ****************************************************************************/
109
110 static void gain_root(void)
111 {
112         if (geteuid() != 0) {
113                 set_effective_uid(0);
114
115                 if (geteuid() != 0) {
116                         DEBUG(0,
117                               ("Warning: You appear to have a trapdoor "
118                                "uid system\n"));
119                 }
120         }
121
122         if (getegid() != 0) {
123                 set_effective_gid(0);
124
125                 if (getegid() != 0) {
126                         DEBUG(0,
127                               ("Warning: You appear to have a trapdoor "
128                                "gid system\n"));
129                 }
130         }
131 }
132
133 /****************************************************************************
134  Get the list of current groups.
135 ****************************************************************************/
136
137 int get_current_groups(int *p_ngroups, gid_t **p_groups)
138 {
139         int i;
140         gid_t grp;
141         int ngroups = sys_getgroups(0,&grp);
142         gid_t *groups;
143
144         (*p_ngroups) = 0;
145         (*p_groups) = NULL;
146
147         if (ngroups <= 0)
148                 return -1;
149
150         if((groups = (gid_t *)malloc(sizeof(gid_t)*ngroups)) == NULL) {
151                 DEBUG(0,("setup_groups malloc fail !\n"));
152                 return -1;
153         }
154
155         if ((ngroups = sys_getgroups(ngroups,groups)) == -1)
156                 return -1;
157
158         (*p_ngroups) = ngroups;
159         (*p_groups) = groups;
160
161         DEBUG( 3, ( "get_current_groups: uid %u is in %u groups: ", (unsigned int)getuid() , ngroups ) );
162         for (i = 0; i < ngroups; i++ ) {
163                 DEBUG( 3, ( "%s%d", (i ? ", " : ""), (int)groups[i] ) );
164         }
165         DEBUG( 3, ( "\n" ) );
166
167     return ngroups;
168 }
169
170 /****************************************************************************
171  Delete a SID token.
172 ****************************************************************************/
173
174 void delete_nt_token(NT_USER_TOKEN **pptoken)
175 {
176     if (*pptoken) {
177                 NT_USER_TOKEN *ptoken = *pptoken;
178         safe_free( ptoken->user_sids );
179         ZERO_STRUCTP(ptoken);
180     }
181     safe_free(*pptoken);
182         *pptoken = NULL;
183 }
184
185 /****************************************************************************
186  Duplicate a SID token.
187 ****************************************************************************/
188
189 NT_USER_TOKEN *dup_nt_token(NT_USER_TOKEN *ptoken)
190 {
191         NT_USER_TOKEN *token;
192
193         if (!ptoken)
194                 return NULL;
195
196     if ((token = (NT_USER_TOKEN *)malloc( sizeof(NT_USER_TOKEN) ) ) == NULL)
197         return NULL;
198
199     ZERO_STRUCTP(token);
200
201     if ((token->user_sids = (DOM_SID *)memdup( ptoken->user_sids, sizeof(DOM_SID) * ptoken->num_sids )) == NULL) {
202         free(token);
203         return NULL;
204     }
205
206     token->num_sids = ptoken->num_sids;
207
208         return token;
209 }
210
211 /****************************************************************************
212  Initialize the groups a user belongs to.
213 ****************************************************************************/
214
215 BOOL initialise_groups(char *user, uid_t uid, gid_t gid)
216 {
217         struct sec_ctx *prev_ctx_p;
218         BOOL result = True;
219
220         become_root();
221
222         /* Call initgroups() to get user groups */
223
224         if (winbind_initgroups(user,gid) == -1) {
225                 DEBUG(0,("Unable to initgroups. Error was %s\n", strerror(errno) ));
226                 if (getuid() == 0) {
227                         if (gid < 0 || gid > 32767 || uid < 0 || uid > 32767) {
228                                 DEBUG(0,("This is probably a problem with the account %s\n", user));
229                         }
230                 }
231                 result = False;
232                 goto done;
233         }
234
235         /* Store groups in previous user's security context.  This will
236            always work as the become_root() call increments the stack
237            pointer. */
238
239         prev_ctx_p = &sec_ctx_stack[sec_ctx_stack_ndx - 1];
240
241         safe_free(prev_ctx_p->groups);
242         prev_ctx_p->groups = NULL;
243         prev_ctx_p->ngroups = 0;
244
245         get_current_groups(&prev_ctx_p->ngroups, &prev_ctx_p->groups);
246
247  done:
248         unbecome_root();
249
250         return result;
251 }
252
253 /****************************************************************************
254  Create a new security context on the stack.  It is the same as the old
255  one.  User changes are done using the set_sec_ctx() function.
256 ****************************************************************************/
257
258 BOOL push_sec_ctx(void)
259 {
260         struct sec_ctx *ctx_p;
261
262         /* Check we don't overflow our stack */
263
264         if (sec_ctx_stack_ndx == MAX_SEC_CTX_DEPTH) {
265                 DEBUG(0, ("Security context stack overflow!\n"));
266                 smb_panic("Security context stack overflow!\n");
267         }
268
269         /* Store previous user context */
270
271         sec_ctx_stack_ndx++;
272
273         ctx_p = &sec_ctx_stack[sec_ctx_stack_ndx];
274
275         ctx_p->uid = geteuid();
276         ctx_p->gid = getegid();
277
278         DEBUG(3, ("push_sec_ctx(%u, %u) : sec_ctx_stack_ndx = %d\n", 
279                   (unsigned int)ctx_p->uid, (unsigned int)ctx_p->gid, sec_ctx_stack_ndx ));
280
281         ctx_p->token = dup_nt_token(sec_ctx_stack[sec_ctx_stack_ndx-1].token);
282
283         ctx_p->ngroups = sys_getgroups(0, NULL);
284
285         if (ctx_p->ngroups != 0) {
286                 if (!(ctx_p->groups = malloc(ctx_p->ngroups * sizeof(gid_t)))) {
287                         DEBUG(0, ("Out of memory in push_sec_ctx()\n"));
288                         delete_nt_token(&ctx_p->token);
289                         return False;
290                 }
291
292                 sys_getgroups(ctx_p->ngroups, ctx_p->groups);
293         } else {
294                 ctx_p->groups = NULL;
295         }
296
297         return True;
298 }
299
300 /****************************************************************************
301  Set the current security context to a given user.
302 ****************************************************************************/
303
304 void set_sec_ctx(uid_t uid, gid_t gid, int ngroups, gid_t *groups, NT_USER_TOKEN *token)
305 {
306         struct sec_ctx *ctx_p = &sec_ctx_stack[sec_ctx_stack_ndx];
307         
308         /* Set the security context */
309
310         DEBUG(3, ("setting sec ctx (%u, %u) - sec_ctx_stack_ndx = %d\n", 
311                 (unsigned int)uid, (unsigned int)gid, sec_ctx_stack_ndx));
312
313         if (ngroups) {
314                 int i;
315
316                 DEBUG(3, ("%d user groups: \n", ngroups));
317                 for (i = 0; i < ngroups; i++) {
318                         DEBUGADD(3, ("%u ", (unsigned int)groups[i]));
319                 }
320
321                 DEBUG(3, ("\n"));
322         }
323         
324
325         gain_root();
326
327 #ifdef HAVE_SETGROUPS
328         sys_setgroups(ngroups, groups);
329 #endif
330
331         ctx_p->ngroups = ngroups;
332
333         safe_free(ctx_p->groups);
334         if (token && (token == ctx_p->token))
335                 smb_panic("DUPLICATE_TOKEN");
336
337         delete_nt_token(&ctx_p->token);
338         
339         ctx_p->groups = memdup(groups, sizeof(gid_t) * ngroups);
340         ctx_p->token = dup_nt_token(token);
341
342         become_id(uid, gid);
343
344         ctx_p->uid = uid;
345         ctx_p->gid = gid;
346
347         /* Update current_user stuff */
348
349         current_user.uid = uid;
350         current_user.gid = gid;
351         current_user.ngroups = ngroups;
352         current_user.groups = groups;
353         current_user.nt_user_token = token;
354 }
355
356 /****************************************************************************
357  Become root context.
358 ****************************************************************************/
359
360 void set_root_sec_ctx(void)
361 {
362         /* May need to worry about supplementary groups at some stage */
363
364         set_sec_ctx(0, 0, 0, NULL, NULL);
365 }
366
367 /****************************************************************************
368  Pop a security context from the stack.
369 ****************************************************************************/
370
371 BOOL pop_sec_ctx(void)
372 {
373         struct sec_ctx *ctx_p;
374         struct sec_ctx *prev_ctx_p;
375
376         /* Check for stack underflow */
377
378         if (sec_ctx_stack_ndx == 0) {
379                 DEBUG(0, ("Security context stack underflow!\n"));
380                 smb_panic("Security context stack underflow!\n");
381         }
382
383         ctx_p = &sec_ctx_stack[sec_ctx_stack_ndx];
384
385         /* Clear previous user info */
386
387         ctx_p->uid = (uid_t)-1;
388         ctx_p->gid = (gid_t)-1;
389
390         safe_free(ctx_p->groups);
391         ctx_p->ngroups = 0;
392
393         delete_nt_token(&ctx_p->token);
394
395         /* Pop back previous user */
396
397         sec_ctx_stack_ndx--;
398
399         gain_root();
400
401         prev_ctx_p = &sec_ctx_stack[sec_ctx_stack_ndx];
402
403 #ifdef HAVE_SETGROUPS
404         sys_setgroups(prev_ctx_p->ngroups, prev_ctx_p->groups);
405 #endif
406
407         become_id(prev_ctx_p->uid, prev_ctx_p->gid);
408
409         /* Update current_user stuff */
410
411         current_user.uid = prev_ctx_p->uid;
412         current_user.gid = prev_ctx_p->gid;
413         current_user.ngroups = prev_ctx_p->ngroups;
414         current_user.groups = prev_ctx_p->groups;
415         current_user.nt_user_token = prev_ctx_p->token;
416
417         DEBUG(3, ("pop_sec_ctx (%u, %u) - sec_ctx_stack_ndx = %d\n", 
418                 (unsigned int)geteuid(), (unsigned int)getegid(), sec_ctx_stack_ndx));
419
420         return True;
421 }
422
423 /* Initialise the security context system */
424
425 void init_sec_ctx(void)
426 {
427         int i;
428         struct sec_ctx *ctx_p;
429
430         /* Initialise security context stack */
431
432         memset(sec_ctx_stack, 0, sizeof(struct sec_ctx) * MAX_SEC_CTX_DEPTH);
433
434         for (i = 0; i < MAX_SEC_CTX_DEPTH; i++) {
435                 sec_ctx_stack[i].uid = (uid_t)-1;
436                 sec_ctx_stack[i].gid = (gid_t)-1;
437         }
438
439         /* Initialise first level of stack.  It is the current context */
440         ctx_p = &sec_ctx_stack[0];
441
442         ctx_p->uid = geteuid();
443         ctx_p->gid = getegid();
444
445         get_current_groups(&ctx_p->ngroups, &ctx_p->groups);
446
447         ctx_p->token = NULL; /* Maps to guest user. */
448
449         /* Initialise current_user global */
450
451         current_user.uid = ctx_p->uid;
452         current_user.gid = ctx_p->gid;
453         current_user.ngroups = ctx_p->ngroups;
454         current_user.groups = ctx_p->groups;
455
456         /* The conn and vuid are usually taken care of by other modules.
457            We initialise them here. */
458
459         current_user.conn = NULL;
460         current_user.vuid = UID_FIELD_INVALID;
461         current_user.nt_user_token = NULL;
462 }