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