Linux: Rework PAG to group conversions
[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
23 #include "afs/sysincludes.h"
24 #include "afsincludes.h"
25 #include "afs/afs_stats.h"      /* statistics */
26 #include "afs/nfsclient.h"
27 #include "osi_compat.h"
28
29 #include <linux/smp_lock.h>
30
31 #ifdef AFS_LINUX26_ONEGROUP_ENV
32 # define NUMPAGGROUPS 1
33
34 static afs_uint32
35 afs_linux_pag_from_groups(struct group_info *group_info) {
36     afs_uint32 g0 = 0;
37     afs_uint32 i;
38
39     if (group_info->ngroups < NUMPAGGROUPS)
40         return NOPAG;
41
42     for (i = 0; (i < group_info->ngroups &&
43                  (g0 = GROUP_AT(group_info, i)) != (gid_t) NOGROUP); i++) {
44         if (((g0 >> 24) & 0xff) == 'A')
45             return g0;
46     }
47     return NOPAG;
48 }
49
50 static inline void
51 afs_linux_pag_to_groups(afs_uint32 newpag,
52                         struct group_info *old, struct group_info **new) {
53     int need_space = 0;
54     int i;
55     int j;
56
57     if (afs_linux_pag_from_groups(old) == NOPAG)
58         need_space = NUMPAGGROUPS;
59
60     *new = groups_alloc(old->ngroups + need_space);
61
62     for (i = 0, j = 0; i < old->ngroups; ++i) {
63         int ths = GROUP_AT(old, i);
64         int last = i > 0 ? GROUP_AT(old, i-1) : 0;
65         if ((ths >> 24) == 'A')
66             continue;
67         if (last <= newpag && ths > newpag) {
68            GROUP_AT(*new, j) = newpag;
69            j++;
70         }
71         GROUP_AT(*new, j) = ths;
72         j++;
73     }
74     if (j != i + need_space)
75         GROUP_AT(*new, j) = newpag;
76 }
77
78 #else
79 # define NUMPAGGROUPS 2
80
81 static inline afs_uint32
82 afs_linux_pag_from_groups(struct group_info *group_info) {
83
84     if (group_info->ngroups < NUMPAGGROUPS)
85         return NOPAG;
86
87     return afs_get_pag_from_groups(GROUP_AT(group_info, 0), GROUP_AT(group_info, 1));
88 }
89
90 static inline void
91 afs_linux_pag_to_groups(afs_uint32 newpag,
92                         struct group_info *old, struct group_info *new) {
93     int need_space = 0;
94     int i;
95     gid_t g0;
96     gid_t g1;
97
98     if (afs_linux_pag_from_groups(old) == NOPAG)
99         need_space = NUMPAGGGROUPS;
100
101     *new = groups_alloc(old->ngroups + need_space);
102
103     for (i = 0; i < old->ngroups; ++i)
104           GROUP_AT(new, i + need_space) = GROUP_AT(old, i);
105
106     afs_get_groups_from_pag(newpag, &g0, g1);
107     GROUP_AT(new, 0) = g0;
108     GROUP_AT(new, 1) = g1;
109 }
110 #endif
111
112 afs_int32
113 osi_get_group_pag(afs_ucred_t *cred) {
114     return afs_linux_pag_from_groups(afs_cr_group_info(cred));
115 }
116
117
118 static int
119 afs_setgroups(cred_t **cr, struct group_info *group_info, int change_parent)
120 {
121     struct group_info *old_info;
122
123     AFS_STATCNT(afs_setgroups);
124
125     old_info = afs_cr_group_info(*cr);
126     get_group_info(group_info);
127     afs_set_cr_group_info(*cr, group_info);
128     put_group_info(old_info);
129
130     crset(*cr);
131
132 #if defined(STRUCT_TASK_STRUCT_HAS_PARENT) && !defined(STRUCT_TASK_HAS_CRED)
133     if (change_parent) {
134         old_info = current->parent->group_info;
135         get_group_info(group_info);
136         current->parent->group_info = group_info;
137         put_group_info(old_info);
138     }
139 #endif
140
141     return (0);
142 }
143
144 int
145 __setpag(cred_t **cr, afs_uint32 pagvalue, afs_uint32 *newpag,
146          int change_parent)
147 {
148     struct group_info *group_info;
149     struct group_info *tmp;
150
151     get_group_info(afs_cr_group_info(*cr));
152     group_info = afs_cr_group_info(*cr);
153
154     *newpag = (pagvalue == -1 ? genpag() : pagvalue);
155     afs_linux_pag_to_groups(*newpag, group_info, &tmp);
156
157     put_group_info(group_info);
158     group_info = tmp;
159
160     afs_setgroups(cr, group_info, change_parent);
161
162     put_group_info(group_info);
163
164     return 0;
165 }
166
167 #ifdef LINUX_KEYRING_SUPPORT
168 extern struct key_type key_type_keyring __attribute__((weak));
169 static struct key_type *__key_type_keyring = &key_type_keyring;
170
171 static int
172 install_session_keyring(struct key *keyring)
173 {
174     struct key *old;
175     char desc[20];
176     int code = -EINVAL;
177
178     if (!__key_type_keyring)
179         return code;
180
181     if (!keyring) {
182
183         /* create an empty session keyring */
184         sprintf(desc, "_ses.%u", current->tgid);
185
186         keyring = afs_linux_key_alloc(
187                             __key_type_keyring, desc,
188                             current_uid(), current_gid(),
189                             (KEY_POS_ALL & ~KEY_POS_SETATTR) | KEY_USR_ALL,
190                             KEY_ALLOC_IN_QUOTA);
191
192         if (IS_ERR(keyring)) {
193             code = PTR_ERR(keyring);
194             goto out;
195         }
196     }
197
198     code = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
199     if (code < 0) {
200         key_put(keyring);
201         goto out;
202     }
203
204     /* install the keyring */
205     spin_lock_irq(&current->sighand->siglock);
206     old = task_session_keyring(current);
207     smp_wmb();
208     task_session_keyring(current) = keyring;
209     spin_unlock_irq(&current->sighand->siglock);
210
211     if (old)
212             key_put(old);
213
214 out:
215     return code;
216 }
217 #endif /* LINUX_KEYRING_SUPPORT */
218
219 int
220 setpag(cred_t **cr, afs_uint32 pagvalue, afs_uint32 *newpag,
221        int change_parent)
222 {
223     int code;
224
225     AFS_STATCNT(setpag);
226
227     code = __setpag(cr, pagvalue, newpag, change_parent);
228
229 #ifdef LINUX_KEYRING_SUPPORT
230     if (code == 0 && afs_cr_rgid(*cr) != NFSXLATOR_CRED) {
231         (void) install_session_keyring(NULL);
232
233         if (current_session_keyring()) {
234             struct key *key;
235             key_perm_t perm;
236
237             perm = KEY_POS_VIEW | KEY_POS_SEARCH;
238             perm |= KEY_USR_VIEW | KEY_USR_SEARCH;
239
240             key = afs_linux_key_alloc(&key_type_afs_pag, "_pag", 0, 0, perm, 1);
241
242             if (!IS_ERR(key)) {
243                 key_instantiate_and_link(key, (void *) newpag, sizeof(afs_uint32),
244                                          current_session_keyring(), NULL);
245                 key_put(key);
246             }
247         }
248     }
249 #endif /* LINUX_KEYRING_SUPPORT */
250
251     return code;
252 }
253
254
255 /* Intercept the standard system call. */
256 extern asmlinkage long (*sys_setgroupsp) (int gidsetsize, gid_t * grouplist);
257 asmlinkage long
258 afs_xsetgroups(int gidsetsize, gid_t * grouplist)
259 {
260     long code;
261     cred_t *cr = crref();
262     afs_uint32 junk;
263     int old_pag;
264
265     lock_kernel();
266     old_pag = PagInCred(cr);
267     crfree(cr);
268     unlock_kernel();
269
270     code = (*sys_setgroupsp) (gidsetsize, grouplist);
271     if (code) {
272         return code;
273     }
274
275     lock_kernel();
276     cr = crref();
277     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
278         /* re-install old pag if there's room. */
279         code = __setpag(&cr, old_pag, &junk, 0);
280     }
281     crfree(cr);
282     unlock_kernel();
283
284     /* Linux syscall ABI returns errno as negative */
285     return (-code);
286 }
287
288 /* Intercept the standard uid32 system call. */
289 extern asmlinkage long (*sys_setgroups32p) (int gidsetsize, gid_t * grouplist);
290 asmlinkage long
291 afs_xsetgroups32(int gidsetsize, gid_t * grouplist)
292 {
293     long code;
294     cred_t *cr = crref();
295     afs_uint32 junk;
296     int old_pag;
297
298     lock_kernel();
299     old_pag = PagInCred(cr);
300     crfree(cr);
301     unlock_kernel();
302
303     code = (*sys_setgroups32p) (gidsetsize, grouplist);
304
305     if (code) {
306         return code;
307     }
308
309     lock_kernel();
310     cr = crref();
311     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
312         /* re-install old pag if there's room. */
313         code = __setpag(&cr, old_pag, &junk, 0);
314     }
315     crfree(cr);
316     unlock_kernel();
317
318     /* Linux syscall ABI returns errno as negative */
319     return (-code);
320 }
321
322 #if defined(AFS_PPC64_LINUX20_ENV)
323 /* Intercept the uid16 system call as used by 32bit programs. */
324 extern long (*sys32_setgroupsp)(int gidsetsize, gid_t *grouplist);
325 asmlinkage long afs32_xsetgroups(int gidsetsize, gid_t *grouplist)
326 {
327     long code;
328     cred_t *cr = crref();
329     afs_uint32 junk;
330     int old_pag;
331     
332     lock_kernel();
333     old_pag = PagInCred(cr);
334     crfree(cr);
335     unlock_kernel();
336     
337     code = (*sys32_setgroupsp)(gidsetsize, grouplist);
338     if (code) {
339         return code;
340     }
341     
342     lock_kernel();
343     cr = crref();
344     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
345         /* re-install old pag if there's room. */
346         code = __setpag(&cr, old_pag, &junk, 0);
347     }
348     crfree(cr);
349     unlock_kernel();
350     
351     /* Linux syscall ABI returns errno as negative */
352     return (-code);
353 }
354 #endif
355
356 #if defined(AFS_SPARC64_LINUX20_ENV) || defined(AFS_AMD64_LINUX20_ENV)
357 /* Intercept the uid16 system call as used by 32bit programs. */
358 extern long (*sys32_setgroupsp) (int gidsetsize, u16 * grouplist);
359 asmlinkage long
360 afs32_xsetgroups(int gidsetsize, u16 * grouplist)
361 {
362     long code;
363     cred_t *cr = crref();
364     afs_uint32 junk;
365     int old_pag;
366     
367     lock_kernel();
368     old_pag = PagInCred(cr);
369     crfree(cr);
370     unlock_kernel();
371     
372     code = (*sys32_setgroupsp) (gidsetsize, grouplist);
373     if (code) {
374         return code;
375     }
376     
377     lock_kernel();
378     cr = crref();
379     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
380         /* re-install old pag if there's room. */
381         code = __setpag(&cr, old_pag, &junk, 0);
382     }
383     crfree(cr);
384     unlock_kernel();
385     
386     /* Linux syscall ABI returns errno as negative */
387     return (-code);
388 }
389
390 /* Intercept the uid32 system call as used by 32bit programs. */
391 extern long (*sys32_setgroups32p) (int gidsetsize, gid_t * grouplist);
392 asmlinkage long
393 afs32_xsetgroups32(int gidsetsize, gid_t * grouplist)
394 {
395     long code;
396     cred_t *cr = crref();
397     afs_uint32 junk;
398     int old_pag;
399
400     lock_kernel();
401     old_pag = PagInCred(cr);
402     crfree(cr);
403     unlock_kernel();
404
405     code = (*sys32_setgroups32p) (gidsetsize, grouplist);
406     if (code) {
407         return code;
408     }
409
410     lock_kernel();
411     cr = crref();
412     if (old_pag != NOPAG && PagInCred(cr) == NOPAG) {
413         /* re-install old pag if there's room. */
414         code = __setpag(&cr, old_pag, &junk, 0);
415     }
416     crfree(cr);
417     unlock_kernel();
418
419     /* Linux syscall ABI returns errno as negative */
420     return (-code);
421 }
422 #endif
423
424
425 #ifdef LINUX_KEYRING_SUPPORT
426 static void afs_pag_describe(const struct key *key, struct seq_file *m)
427 {
428     seq_puts(m, key->description);
429
430     seq_printf(m, ": %u", key->datalen);
431 }
432
433 static int afs_pag_instantiate(struct key *key, const void *data, size_t datalen)
434 {
435     int code;
436     afs_uint32 *userpag, pag = NOPAG;
437
438     if (key->uid != 0 || key->gid != 0)
439         return -EPERM;
440
441     code = -EINVAL;
442     get_group_info(current_group_info());
443
444     if (datalen != sizeof(afs_uint32) || !data)
445         goto error;
446
447     /* ensure key being set matches current pag */
448     pag = afs_linux_pag_from_groups(current_group_info());
449
450     if (pag == NOPAG)
451         goto error;
452
453     userpag = (afs_uint32 *) data;
454     if (*userpag != pag)
455         goto error;
456
457     key->payload.value = (unsigned long) *userpag;
458     key->datalen = sizeof(afs_uint32);
459     code = 0;
460
461 error:
462     put_group_info(current_group_info());
463     return code;
464 }
465
466 static int afs_pag_match(const struct key *key, const void *description)
467 {
468         return strcmp(key->description, description) == 0;
469 }
470
471 static void afs_pag_destroy(struct key *key)
472 {
473     afs_uint32 pag = key->payload.value;
474     struct unixuser *pu;
475     int locked = ISAFS_GLOCK();
476
477     if (!locked)
478         AFS_GLOCK();
479     pu = afs_FindUser(pag, -1, READ_LOCK);
480     if (pu) {
481         pu->ct.EndTimestamp = 0;
482         pu->tokenTime = 0;
483         afs_PutUser(pu, READ_LOCK);
484     }
485     if (!locked)
486         AFS_GUNLOCK();
487 }
488
489 struct key_type key_type_afs_pag =
490 {
491     .name        = "afs_pag",
492     .describe    = afs_pag_describe,
493     .instantiate = afs_pag_instantiate,
494     .match       = afs_pag_match,
495     .destroy     = afs_pag_destroy,
496 };
497
498 #ifdef EXPORTED_TASKLIST_LOCK
499 extern rwlock_t tasklist_lock __attribute__((weak));
500 #endif
501
502 void osi_keyring_init(void)
503 {
504 #if !defined(EXPORTED_KEY_TYPE_KEYRING)
505     struct task_struct *p;
506
507     /* If we can't lock the tasklist, either with its explicit lock,
508      * or by using the RCU lock, then we can't safely work out the 
509      * type of a keyring. So, we have to rely on the weak reference. 
510      * If that's not available, then keyring based PAGs won't work.
511      */
512     
513 #if defined(EXPORTED_TASKLIST_LOCK) || (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16) && defined(EXPORTED_RCU_READ_LOCK))
514     if (__key_type_keyring == NULL) {
515 # ifdef EXPORTED_TASKLIST_LOCK
516         if (&tasklist_lock)
517             read_lock(&tasklist_lock);
518 # endif
519 # if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16) && defined(EXPORTED_RCU_READ_LOCK))
520 #  ifdef EXPORTED_TASKLIST_LOCK
521         else
522 #  endif
523             rcu_read_lock();
524 # endif
525 #if defined(EXPORTED_FIND_TASK_BY_PID)
526         p = find_task_by_pid(1);
527 #else
528         p = find_task_by_vpid(1);
529 #endif
530         if (p && task_user(p)->session_keyring)
531             __key_type_keyring = task_user(p)->session_keyring->type;
532 # ifdef EXPORTED_TASKLIST_LOCK
533         if (&tasklist_lock)
534             read_unlock(&tasklist_lock);
535 # endif
536 # if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16) && defined(EXPORTED_RCU_READ_LOCK))
537 #  ifdef EXPORTED_TASKLIST_LOCK
538         else
539 #  endif
540             rcu_read_unlock();
541 # endif
542     }
543 #endif
544 #endif
545
546     register_key_type(&key_type_afs_pag);
547 }
548
549 void osi_keyring_shutdown(void)
550 {
551     unregister_key_type(&key_type_afs_pag);
552 }
553
554 afs_int32
555 osi_get_keyring_pag(afs_ucred_t *cred)
556 {
557     struct key *key;
558     afs_uint32 newpag;
559     afs_int32 keyring_pag = NOPAG;
560
561     if (afs_cr_rgid(cred) != NFSXLATOR_CRED) {
562         key = afs_linux_search_keyring(cred, &key_type_afs_pag);
563
564         if (!IS_ERR(key)) {
565             if (key_validate(key) == 0 && key->uid == 0) {      /* also verify in the session keyring? */
566                 keyring_pag = key->payload.value;
567                 /* Only set PAG in groups if needed,
568                  * and the creds are from the current process */
569                 if (afs_linux_cred_is_current(cred) &&
570                     ((keyring_pag >> 24) & 0xff) == 'A' &&
571                     keyring_pag != afs_linux_pag_from_groups(current_group_info())) {
572                         __setpag(&cred, keyring_pag, &newpag, 0);
573                 }
574             }
575             key_put(key);
576         }
577     }
578     return keyring_pag;
579 }
580
581 #else
582 void osi_keyring_init(void)
583 {
584         return;
585 }
586
587 void osi_keyring_shutdown(void)
588 {
589         return;
590 }
591 #endif