ed7516c673fd7334b06436738ad135a9ef9bed7b
[openafs.git] / src / afs / LINUX / osi_groups.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * Implements:
12  * setgroups (syscall)
13  * setpag
14  *
15  */
16 #include <afsconfig.h>
17 #include "afs/param.h"
18 #ifdef LINUX_KEYRING_SUPPORT
19 #include <linux/seq_file.h>
20 #endif
21
22 RCSID
23     ("$Header$");
24
25 #include "afs/sysincludes.h"
26 #include "afsincludes.h"
27 #include "afs/afs_stats.h"      /* statistics */
28 #include "afs/nfsclient.h"
29 #ifdef AFS_LINUX22_ENV
30 #include "h/smp_lock.h"
31 #endif
32
33 #ifdef AFS_LINUX26_ONEGROUP_ENV
34 #define NUMPAGGROUPS 1
35 #else
36 #define NUMPAGGROUPS 2
37 #endif
38
39 #if defined(AFS_LINUX26_ENV)
40 static int
41 afs_setgroups(cred_t **cr, struct group_info *group_info, int change_parent)
42 {
43     struct group_info *old_info;
44
45     AFS_STATCNT(afs_setgroups);
46
47     old_info = (*cr)->cr_group_info;
48     get_group_info(group_info);
49     (*cr)->cr_group_info = group_info;
50     put_group_info(old_info);
51
52     crset(*cr);
53
54     if (change_parent) {
55         old_info = current->parent->group_info;
56         get_group_info(group_info);
57         current->parent->group_info = group_info;
58         put_group_info(old_info);
59     }
60
61     return (0);
62 }
63 #else
64 static int
65 afs_setgroups(cred_t **cr, int ngroups, gid_t * gidset, int change_parent)
66 {
67     int ngrps;
68     int i;
69     gid_t *gp;
70
71     AFS_STATCNT(afs_setgroups);
72
73     if (ngroups > NGROUPS)
74         return EINVAL;
75
76     gp = (*cr)->cr_groups;
77     if (ngroups < NGROUPS)
78         gp[ngroups] = (gid_t) NOGROUP;
79
80     for (i = ngroups; i > 0; i--) {
81         *gp++ = *gidset++;
82     }
83
84     (*cr)->cr_ngroups = ngroups;
85     crset(*cr);
86     return (0);
87 }
88 #endif
89
90 #if defined(AFS_LINUX26_ENV)
91 static struct group_info *
92 afs_getgroups(cred_t * cr)
93 {
94     AFS_STATCNT(afs_getgroups);
95
96     get_group_info(cr->cr_group_info);
97     return cr->cr_group_info;
98 }
99 #else
100 /* Returns number of groups. And we trust groups to be large enough to
101  * hold all the groups.
102  */
103 static int
104 afs_getgroups(cred_t *cr, gid_t *groups)
105 {
106     int i;
107     int n;
108     gid_t *gp;
109
110     AFS_STATCNT(afs_getgroups);
111
112     gp = cr->cr_groups;
113     n = cr->cr_ngroups;
114
115     for (i = 0; (i < n) && (*gp != (gid_t) NOGROUP); i++)
116         *groups++ = *gp++;
117     return i;
118 }
119 #endif
120
121 #if !defined(AFS_LINUX26_ENV)
122 /* Only propogate the PAG to the parent process. Unix's propogate to 
123  * all processes sharing the cred.
124  */
125 int
126 set_pag_in_parent(int pag, int g0, int g1)
127 {
128     int i;
129 #ifdef STRUCT_TASK_STRUCT_HAS_PARENT
130     gid_t *gp = current->parent->groups;
131     int ngroups = current->parent->ngroups;
132 #else
133     gid_t *gp = current->p_pptr->groups;
134     int ngroups = current->p_pptr->ngroups;
135 #endif
136
137     if ((ngroups < 2) || (afs_get_pag_from_groups(gp[0], gp[1]) == NOPAG)) {
138         /* We will have to shift grouplist to make room for pag */
139         if (ngroups + 2 > NGROUPS) {
140             return EINVAL;
141         }
142         for (i = ngroups - 1; i >= 0; i--) {
143             gp[i + 2] = gp[i];
144         }
145         ngroups += 2;
146     }
147     gp[0] = g0;
148     gp[1] = g1;
149     if (ngroups < NGROUPS)
150         gp[ngroups] = NOGROUP;
151
152 #ifdef STRUCT_TASK_STRUCT_HAS_PARENT
153     current->parent->ngroups = ngroups;
154 #else
155     current->p_pptr->ngroups = ngroups;
156 #endif
157     return 0;
158 }
159 #endif
160
161 #if defined(AFS_LINUX26_ENV)
162 int
163 __setpag(cred_t **cr, afs_uint32 pagvalue, afs_uint32 *newpag,
164          int change_parent)
165 {
166     struct group_info *group_info;
167     gid_t g0, g1;
168     struct group_info *tmp;
169     int i;
170 #ifdef AFS_LINUX26_ONEGROUP_ENV
171     int j;
172 #endif
173     int need_space = 0;
174
175     group_info = afs_getgroups(*cr);
176     if (group_info->ngroups < NUMPAGGROUPS
177         ||  afs_get_pag_from_groups(
178 #ifdef AFS_LINUX26_ONEGROUP_ENV
179             group_info
180 #else
181             GROUP_AT(group_info, 0) ,GROUP_AT(group_info, 1)
182 #endif
183                                     ) == NOPAG) 
184         /* We will have to make sure group_info is big enough for pag */
185         need_space = NUMPAGGROUPS;
186
187     tmp = groups_alloc(group_info->ngroups + need_space);
188     
189     *newpag = (pagvalue == -1 ? genpag() : pagvalue);
190 #ifdef AFS_LINUX26_ONEGROUP_ENV
191     for (i = 0, j = 0; i < group_info->ngroups; ++i) {
192         int ths = GROUP_AT(group_info, i);
193         int last = i > 0 ? GROUP_AT(group_info, i-1) : 0;
194         if ((ths >> 24) == 'A')
195             continue;
196         if (last <= *newpag && ths > *newpag) {
197            GROUP_AT(tmp, j) = *newpag;
198            j++;
199         }
200         GROUP_AT(tmp, j) = ths;
201         j++;
202     }
203     if (j != i + need_space)
204         GROUP_AT(tmp, j) = *newpag;
205 #else
206     for (i = 0; i < group_info->ngroups; ++i)
207       GROUP_AT(tmp, i + need_space) = GROUP_AT(group_info, i);
208 #endif
209     put_group_info(group_info);
210     group_info = tmp;
211
212 #ifndef AFS_LINUX26_ONEGROUP_ENV
213     afs_get_groups_from_pag(*newpag, &g0, &g1);
214     GROUP_AT(group_info, 0) = g0;
215     GROUP_AT(group_info, 1) = g1;
216 #endif
217
218     afs_setgroups(cr, group_info, change_parent);
219
220     put_group_info(group_info);
221
222     return 0;
223 }
224
225 #ifdef LINUX_KEYRING_SUPPORT
226 static struct key_type *__key_type_keyring;
227
228 static int
229 install_session_keyring(struct task_struct *task, struct key *keyring)
230 {
231     struct key *old;
232     char desc[20];
233     unsigned long not_in_quota;
234     int code = -EINVAL;
235
236     if (!__key_type_keyring)
237         return code;
238
239     if (!keyring) {
240
241         /* create an empty session keyring */
242         not_in_quota = KEY_ALLOC_IN_QUOTA;
243         sprintf(desc, "_ses.%u", task->tgid);
244
245 #ifdef KEY_ALLOC_NEEDS_STRUCT_TASK
246         keyring = key_alloc(__key_type_keyring, desc,
247                             task->uid, task->gid, task,
248                             (KEY_POS_ALL & ~KEY_POS_SETATTR) | KEY_USR_ALL,
249                             not_in_quota);
250 #else
251         keyring = key_alloc(__key_type_keyring, desc,
252                             task->uid, task->gid,
253                             (KEY_POS_ALL & ~KEY_POS_SETATTR) | KEY_USR_ALL,
254                             not_in_quota);
255 #endif
256         if (IS_ERR(keyring)) {
257             code = PTR_ERR(keyring);
258             goto out;
259         }
260     }
261
262     code = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
263     if (code < 0) {
264         key_put(keyring);
265         goto out;
266     }
267
268     /* install the keyring */
269     spin_lock_irq(&task->sighand->siglock);
270     old = task->signal->session_keyring;
271     smp_wmb();
272     task->signal->session_keyring = keyring;
273     spin_unlock_irq(&task->sighand->siglock);
274
275     if (old)
276             key_put(old);
277
278 out:
279     return code;
280 }
281 #endif /* LINUX_KEYRING_SUPPORT */
282
283 #else
284 int
285 __setpag(cred_t **cr, afs_uint32 pagvalue, afs_uint32 *newpag,
286          int change_parent)
287 {
288     gid_t *gidset;
289     afs_int32 ngroups, code = 0;
290     int j;
291
292     gidset = (gid_t *) osi_Alloc(NGROUPS * sizeof(gidset[0]));
293     ngroups = afs_getgroups(*cr, gidset);
294
295     if (afs_get_pag_from_groups(gidset[0], gidset[1]) == NOPAG) {
296         /* We will have to shift grouplist to make room for pag */
297         if (ngroups + 2 > NGROUPS) {
298             osi_Free((char *)gidset, NGROUPS * sizeof(int));
299             return EINVAL;
300         }
301         for (j = ngroups - 1; j >= 0; j--) {
302             gidset[j + 2] = gidset[j];
303         }
304         ngroups += 2;
305     }
306     *newpag = (pagvalue == -1 ? genpag() : pagvalue);
307     afs_get_groups_from_pag(*newpag, &gidset[0], &gidset[1]);
308     code = afs_setgroups(cr, ngroups, gidset, change_parent);
309
310     /* If change_parent is set, then we should set the pag in the parent as
311      * well.
312      */
313     if (change_parent && !code) {
314         code = set_pag_in_parent(*newpag, gidset[0], gidset[1]);
315     }
316
317     osi_Free((char *)gidset, NGROUPS * sizeof(int));
318     return code;
319 }
320 #endif
321
322
323 int
324 setpag(cred_t **cr, afs_uint32 pagvalue, afs_uint32 *newpag,
325        int change_parent)
326 {
327     int code;
328
329     AFS_STATCNT(setpag);
330
331     code = __setpag(cr, pagvalue, newpag, change_parent);
332
333 #ifdef LINUX_KEYRING_SUPPORT
334     if (code == 0 && (*cr)->cr_rgid != NFSXLATOR_CRED) {
335         (void) install_session_keyring(current, NULL);
336
337         if (current->signal->session_keyring) {
338             struct key *key;
339             key_perm_t perm;
340
341             perm = KEY_POS_VIEW | KEY_POS_SEARCH;
342             perm |= KEY_USR_VIEW | KEY_USR_SEARCH;
343
344 #ifdef KEY_ALLOC_NEEDS_STRUCT_TASK
345             key = key_alloc(&key_type_afs_pag, "_pag", 0, 0, current, perm, 1);
346 #else
347             key = key_alloc(&key_type_afs_pag, "_pag", 0, 0, perm, 1);
348 #endif
349
350             if (!IS_ERR(key)) {
351                 key_instantiate_and_link(key, (void *) newpag, sizeof(afs_uint32),
352                                          current->signal->session_keyring, NULL);
353                 key_put(key);
354             }
355         }
356     }
357 #endif /* LINUX_KEYRING_SUPPORT */
358
359     return code;
360 }
361
362
363 /* Intercept the standard system call. */
364 extern asmlinkage long (*sys_setgroupsp) (int gidsetsize, gid_t * grouplist);
365 asmlinkage long
366 afs_xsetgroups(int gidsetsize, gid_t * grouplist)
367 {
368     long code;
369     cred_t *cr = crref();
370     afs_uint32 junk;
371     int old_pag;
372
373     lock_kernel();
374     old_pag = PagInCred(cr);
375     crfree(cr);
376     unlock_kernel();
377
378     code = (*sys_setgroupsp) (gidsetsize, grouplist);
379     if (code) {
380         return code;
381     }
382
383     lock_kernel();
384     cr = crref();
385     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
386         /* re-install old pag if there's room. */
387         code = __setpag(&cr, old_pag, &junk, 0);
388     }
389     crfree(cr);
390     unlock_kernel();
391
392     /* Linux syscall ABI returns errno as negative */
393     return (-code);
394 }
395
396 #if defined(AFS_LINUX24_ENV)
397 /* Intercept the standard uid32 system call. */
398 extern asmlinkage long (*sys_setgroups32p) (int gidsetsize, gid_t * grouplist);
399 asmlinkage long
400 afs_xsetgroups32(int gidsetsize, gid_t * grouplist)
401 {
402     long code;
403     cred_t *cr = crref();
404     afs_uint32 junk;
405     int old_pag;
406
407     lock_kernel();
408     old_pag = PagInCred(cr);
409     crfree(cr);
410     unlock_kernel();
411
412     code = (*sys_setgroups32p) (gidsetsize, grouplist);
413
414     if (code) {
415         return code;
416     }
417
418     lock_kernel();
419     cr = crref();
420     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
421         /* re-install old pag if there's room. */
422         code = __setpag(&cr, old_pag, &junk, 0);
423     }
424     crfree(cr);
425     unlock_kernel();
426
427     /* Linux syscall ABI returns errno as negative */
428     return (-code);
429 }
430 #endif
431
432 #if defined(AFS_PPC64_LINUX20_ENV)
433 /* Intercept the uid16 system call as used by 32bit programs. */
434 extern long (*sys32_setgroupsp)(int gidsetsize, gid_t *grouplist);
435 asmlinkage long afs32_xsetgroups(int gidsetsize, gid_t *grouplist)
436 {
437     long code;
438     cred_t *cr = crref();
439     afs_uint32 junk;
440     int old_pag;
441     
442     lock_kernel();
443     old_pag = PagInCred(cr);
444     crfree(cr);
445     unlock_kernel();
446     
447     code = (*sys32_setgroupsp)(gidsetsize, grouplist);
448     if (code) {
449         return code;
450     }
451     
452     lock_kernel();
453     cr = crref();
454     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
455         /* re-install old pag if there's room. */
456         code = __setpag(&cr, old_pag, &junk, 0);
457     }
458     crfree(cr);
459     unlock_kernel();
460     
461     /* Linux syscall ABI returns errno as negative */
462     return (-code);
463 }
464 #endif
465
466 #if defined(AFS_SPARC64_LINUX20_ENV) || defined(AFS_AMD64_LINUX20_ENV)
467 /* Intercept the uid16 system call as used by 32bit programs. */
468 extern long (*sys32_setgroupsp) (int gidsetsize, u16 * grouplist);
469 asmlinkage long
470 afs32_xsetgroups(int gidsetsize, u16 * grouplist)
471 {
472     long code;
473     cred_t *cr = crref();
474     afs_uint32 junk;
475     int old_pag;
476     
477     lock_kernel();
478     old_pag = PagInCred(cr);
479     crfree(cr);
480     unlock_kernel();
481     
482     code = (*sys32_setgroupsp) (gidsetsize, grouplist);
483     if (code) {
484         return code;
485     }
486     
487     lock_kernel();
488     cr = crref();
489     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
490         /* re-install old pag if there's room. */
491         code = __setpag(&cr, old_pag, &junk, 0);
492     }
493     crfree(cr);
494     unlock_kernel();
495     
496     /* Linux syscall ABI returns errno as negative */
497     return (-code);
498 }
499
500 #ifdef AFS_LINUX24_ENV
501 /* Intercept the uid32 system call as used by 32bit programs. */
502 extern long (*sys32_setgroups32p) (int gidsetsize, gid_t * grouplist);
503 asmlinkage long
504 afs32_xsetgroups32(int gidsetsize, gid_t * grouplist)
505 {
506     long code;
507     cred_t *cr = crref();
508     afs_uint32 junk;
509     int old_pag;
510
511     lock_kernel();
512     old_pag = PagInCred(cr);
513     crfree(cr);
514     unlock_kernel();
515
516     code = (*sys32_setgroups32p) (gidsetsize, grouplist);
517     if (code) {
518         return code;
519     }
520
521     lock_kernel();
522     cr = crref();
523     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
524         /* re-install old pag if there's room. */
525         code = __setpag(&cr, old_pag, &junk, 0);
526     }
527     crfree(cr);
528     unlock_kernel();
529
530     /* Linux syscall ABI returns errno as negative */
531     return (-code);
532 }
533 #endif
534 #endif
535
536
537 #ifdef LINUX_KEYRING_SUPPORT
538 static void afs_pag_describe(const struct key *key, struct seq_file *m)
539 {
540     seq_puts(m, key->description);
541
542     seq_printf(m, ": %u", key->datalen);
543 }
544
545 static int afs_pag_instantiate(struct key *key, const void *data, size_t datalen)
546 {
547     int code;
548     afs_uint32 *userpag, pag = NOPAG;
549     int g0, g1;
550
551     if (key->uid != 0 || key->gid != 0)
552         return -EPERM;
553
554     code = -EINVAL;
555     get_group_info(current->group_info);
556
557     if (datalen != sizeof(afs_uint32) || !data)
558         goto error;
559
560     if (current->group_info->ngroups < NUMPAGGROUPS)
561         goto error;
562
563     /* ensure key being set matches current pag */
564 #ifdef AFS_LINUX26_ONEGROUP_ENV
565     pag = afs_get_pag_from_groups(current->group_info);
566 #else
567     g0 = GROUP_AT(current->group_info, 0);
568     g1 = GROUP_AT(current->group_info, 1);
569
570     pag = afs_get_pag_from_groups(g0, g1);
571 #endif
572     if (pag == NOPAG)
573         goto error;
574
575     userpag = (afs_uint32 *) data;
576     if (*userpag != pag)
577         goto error;
578
579     key->payload.value = (unsigned long) *userpag;
580     key->datalen = sizeof(afs_uint32);
581     code = 0;
582
583 error:
584     put_group_info(current->group_info);
585     return code;
586 }
587
588 static int afs_pag_match(const struct key *key, const void *description)
589 {
590         return strcmp(key->description, description) == 0;
591 }
592
593 static void afs_pag_destroy(struct key *key)
594 {
595     afs_uint32 pag = key->payload.value;
596     struct unixuser *pu;
597     int locked = ISAFS_GLOCK();
598
599     if (!locked)
600         AFS_GLOCK();
601     pu = afs_FindUser(pag, -1, READ_LOCK);
602     if (pu) {
603         pu->ct.EndTimestamp = 0;
604         pu->tokenTime = 0;
605         afs_PutUser(pu, READ_LOCK);
606     }
607     if (!locked)
608         AFS_GUNLOCK();
609 }
610
611 struct key_type key_type_afs_pag =
612 {
613     .name        = "afs_pag",
614     .describe    = afs_pag_describe,
615     .instantiate = afs_pag_instantiate,
616     .match       = afs_pag_match,
617     .destroy     = afs_pag_destroy,
618 };
619
620 #ifdef EXPORTED_TASKLIST_LOCK
621 extern rwlock_t tasklist_lock __attribute__((weak));
622 #endif
623
624 void osi_keyring_init(void)
625 {
626     struct task_struct *p;
627 #ifdef EXPORTED_TASKLIST_LOCK
628     if (&tasklist_lock)
629       read_lock(&tasklist_lock);
630 #endif
631 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
632 #ifdef EXPORTED_TASKLIST_LOCK
633     else
634 #endif
635       rcu_read_lock();
636 #endif
637     p = find_task_by_pid(1);
638     if (p && p->user->session_keyring)
639         __key_type_keyring = p->user->session_keyring->type;
640 #ifdef EXPORTED_TASKLIST_LOCK
641     if (&tasklist_lock)
642        read_unlock(&tasklist_lock);
643 #endif
644 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
645 #ifdef EXPORTED_TASKLIST_LOCK
646     else
647 #endif
648       rcu_read_unlock();
649 #endif
650
651     register_key_type(&key_type_afs_pag);
652 }
653
654 void osi_keyring_shutdown(void)
655 {
656     unregister_key_type(&key_type_afs_pag);
657 }
658
659 #else
660 void osi_keyring_init(void)
661 {
662         return;
663 }
664
665 void osi_keyring_shutdown(void)
666 {
667         return;
668 }
669 #endif