2 * Copyright 2000, International Business Machines Corporation and others.
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
17 * afs_get_pag_from_groups
18 * afs_get_groups_from_pag
22 #include <afsconfig.h>
23 #include "afs/param.h"
26 #include "afs/sysincludes.h" /* Standard vendor system headers */
27 #include "afsincludes.h" /* Afs-based standard headers */
28 #include "afs/afs_stats.h" /* statistics */
29 #include "afs/afs_cbqueue.h"
30 #include "afs/nfsclient.h"
31 #include "afs/afs_osidnlc.h"
34 /* Imported variables */
35 extern int afs_shuttingdown;
37 /* Exported variables */
39 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
40 afs_uint32 pagCounter = 1;
42 afs_uint32 pagCounter = 0;
43 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
45 #ifdef AFS_LINUX26_ONEGROUP_ENV
46 #define NUMPAGGROUPS 1
48 #define NUMPAGGROUPS 2
53 * Pags are implemented as follows: the set of groups whose long
54 * representation is '41XXXXXX' hex are used to represent the pags.
55 * Being a member of such a group means you are authenticated as pag
56 * XXXXXX (0x41 == 'A', for Andrew). You are never authenticated as
57 * multiple pags at once.
59 * The function afs_InitReq takes a credential field and formats the
60 * corresponding venus request structure. The uid field in the
61 * vrequest structure is set to the *pag* you are authenticated as, or
62 * the uid, if you aren't authenticated with a pag.
64 * The basic motivation behind pags is this: just because your unix
65 * uid is N doesn't mean that you should have the same privileges as
66 * anyone logged in on the machine as user N, since this would enable
67 * the superuser on the machine to sneak in and make use of anyone's
68 * authentication info, even that which is only accidentally left
69 * behind when someone leaves a public workstation.
71 * AFS doesn't use the unix uid for anything except
72 * a handle with which to find the actual authentication tokens
73 * anyway, so the pag is an alternative handle which is somewhat more
74 * secure (although of course not absolutely secure).
76 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
81 #ifdef AFS_LINUX20_ENV
82 /* Ensure unique PAG's (mod 200 days) when reloading the client. */
83 return (('A' << 24) + ((pag_epoch + pagCounter++) & 0xffffff));
84 #else /* AFS_LINUX20_ENV */
85 return (('A' << 24) + (pagCounter++ & 0xffffff));
86 #endif /* AFS_LINUX20_ENV */
93 #ifdef AFS_LINUX20_ENV
94 /* Ensure unique PAG's (mod 200 days) when reloading the client. */
95 return (('A' << 24) + ((pag_epoch + pagCounter) & 0xffffff));
97 return (('A' << 24) + (pagCounter & 0xffffff));
103 /* Web enhancement: we don't need to restrict pags to 41XXXXXX since
104 * we are not sharing the space with anyone. So we use the full 32 bits. */
110 #ifdef AFS_LINUX20_ENV
111 return (pag_epoch + pagCounter++);
113 return (pagCounter++);
114 #endif /* AFS_LINUX20_ENV */
121 #ifdef AFS_LINUX20_ENV
122 /* Ensure unique PAG's (mod 200 days) when reloading the client. */
123 return (pag_epoch + pagCounter);
128 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
130 /* used to require 10 seconds between each setpag to guarantee that
131 * PAGs never wrap - which would be a security hole. If we presume
132 * that in ordinary operation, the average rate of PAG allocation
133 * will not exceed one per second, the 24 bits provided will be
134 * sufficient for ~200 days. Unfortunately, if we merely assume that,
135 * there will be an opportunity for attack. So we must enforce it.
136 * If we need to increase the average rate of PAG allocation, we
137 * should increase the number of bits in a PAG, and/or reduce our
138 * window in which we guarantee that the PAG counter won't wrap.
139 * By permitting an average of one new PAG per second, new PAGs can
140 * be allocated VERY frequently over a short period relative to total uptime.
141 * Of course, there's only an issue here if one user stays logged (and re-
142 * activates tokens repeatedly) for that entire period.
145 static int afs_pag_sleepcnt = 0;
146 static int afs_pag_timewarn = 0;
149 afs_pag_sleep(afs_ucred_t **acred)
153 if (!afs_suser(acred)) {
154 if(osi_Time() - pag_epoch < pagCounter) {
157 if (rv && (osi_Time() < pag_epoch)) {
158 if (!afs_pag_timewarn) {
159 afs_pag_timewarn = 1;
160 printf("clock went backwards, not PAG throttling");
170 afs_pag_wait(afs_ucred_t **acred)
172 if (afs_pag_sleep(acred)) {
173 if (!afs_pag_sleepcnt) {
174 printf("%s() PAG throttling triggered, pid %d... sleeping. sleepcnt %d\n",
175 "afs_pag_wait", osi_getpid(), afs_pag_sleepcnt);
181 /* XXX spins on EINTR */
182 afs_osi_Wait(1000, (struct afs_osi_WaitHandle *)0, 0);
183 } while (afs_pag_sleep(acred));
192 #if defined(AFS_SUN5_ENV)
193 afs_setpag(afs_ucred_t **credpp)
194 #elif defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
195 afs_setpag(afs_proc_t *p, void *args, int *retval)
201 #if defined(AFS_SUN5_ENV)
202 afs_ucred_t **acred = *credpp;
203 #elif defined(AFS_OBSD_ENV)
204 afs_ucred_t **acred = &p->p_ucred;
206 afs_ucred_t **acred = NULL;
211 #if defined(AFS_SGI53_ENV) && defined(MP)
212 /* This is our first chance to get the global lock. */
214 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
216 AFS_STATCNT(afs_setpag);
221 #if defined(AFS_SUN5_ENV)
222 code = AddPag(genpag(), credpp);
223 #elif defined(AFS_OSF_ENV) || defined(AFS_XBSD_ENV)
224 code = AddPag(p, genpag(), &p->p_rcred);
225 #elif defined(AFS_AIX41_ENV)
228 struct ucred *credp0;
232 code = AddPag(genpag(), &credp);
233 /* If AddPag() didn't make a new cred, then free our cred ref */
234 if (credp == credp0) {
238 #elif defined(AFS_HPUX110_ENV)
240 struct ucred *credp = p_cred(u.u_procp);
241 code = AddPag(genpag(), &credp);
243 #elif defined(AFS_SGI_ENV)
246 credp = OSI_GET_CURRENT_CRED();
247 code = AddPag(genpag(), &credp);
249 #elif defined(AFS_LINUX20_ENV)
251 afs_ucred_t *credp = crref();
252 code = AddPag(genpag(), &credp);
255 #elif defined(AFS_DARWIN80_ENV)
257 afs_ucred_t *credp = kauth_cred_proc_ref(p);
258 code = AddPag(p, genpag(), &credp);
261 #elif defined(AFS_DARWIN_ENV)
263 afs_ucred_t *credp = crdup(p->p_cred->pc_ucred);
264 code = AddPag(p, genpag(), &credp);
268 code = AddPag(genpag(), &u.u_cred);
271 afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
273 #if defined(KERNEL_HAVE_UERROR)
278 #if defined(AFS_SGI53_ENV) && defined(MP)
280 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
285 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
288 * This function is like setpag but sets the current thread's pag id to a
289 * caller-provided value instead of calling genpag(). This implements a
290 * form of token caching since the caller can recall a particular pag value
291 * for the thread to restore tokens, rather than reauthenticating.
294 #if defined(AFS_SUN5_ENV)
295 afs_setpag_val(afs_ucred_t **credpp, int pagval)
296 #elif defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
297 afs_setpag_val(afs_proc_t *p, void *args, int *retval, int pagval)
299 afs_setpag_val(int pagval)
303 #if defined(AFS_SUN5_ENV)
304 afs_ucred_t **acred = *credp;
305 #elif defined(AFS_OBSD_ENV)
306 afs_ucred_t **acred = &p->p_ucred;
308 afs_ucred_t **acred = NULL;
313 #if defined(AFS_SGI53_ENV) && defined(MP)
314 /* This is our first chance to get the global lock. */
316 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
318 AFS_STATCNT(afs_setpag);
322 #if defined(AFS_SUN5_ENV)
323 code = AddPag(pagval, credpp);
324 #elif defined(AFS_OSF_ENV) || defined(AFS_XBSD_ENV)
325 code = AddPag(p, pagval, &p->p_rcred);
326 #elif defined(AFS_AIX41_ENV)
329 struct ucred *credp0;
333 code = AddPag(pagval, &credp);
334 /* If AddPag() didn't make a new cred, then free our cred ref */
335 if (credp == credp0) {
339 #elif defined(AFS_HPUX110_ENV)
341 struct ucred *credp = p_cred(u.u_procp);
342 code = AddPag(pagval, &credp);
344 #elif defined(AFS_SGI_ENV)
347 credp = OSI_GET_CURRENT_CRED();
348 code = AddPag(pagval, &credp);
350 #elif defined(AFS_LINUX20_ENV)
352 afs_ucred_t *credp = crref();
353 code = AddPag(pagval, &credp);
356 #elif defined(AFS_DARWIN_ENV)
358 struct ucred *credp = crdup(p->p_cred->pc_ucred);
359 code = AddPag(p, pagval, &credp);
363 code = AddPag(pagval, &u.u_cred);
366 afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
367 #if defined(KERNEL_HAVE_UERROR)
371 #if defined(AFS_SGI53_ENV) && defined(MP)
373 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
377 #ifndef AFS_LINUX26_ONEGROUP_ENV
382 afs_ucred_t *credp = u.u_cred;
383 gid_t gidset0, gidset1;
384 #ifdef AFS_SUN510_ENV
387 gids = crgetgroups(*credp);
391 gidset0 = credp->cr_groups[0];
392 gidset1 = credp->cr_groups[1];
394 pagvalue = afs_get_pag_from_groups(gidset0, gidset1);
398 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
401 /* Note - needs to be available on AIX, others can be static - rework this */
402 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
404 AddPag(afs_proc_t *p, afs_int32 aval, afs_ucred_t **credpp)
407 AddPag(afs_int32 aval, afs_ucred_t **credpp)
414 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
415 if ((code = setpag(p, credpp, aval, &newpag, 0)))
417 if ((code = setpag(credpp, aval, &newpag, 0)))
419 #if defined(KERNEL_HAVE_UERROR)
420 return (setuerror(code), code);
429 afs_InitReq(register struct vrequest *av, afs_ucred_t *acred)
431 #if defined(AFS_LINUX26_ENV) && !defined(AFS_NONFSTRANS)
435 AFS_STATCNT(afs_InitReq);
436 memset(av, 0, sizeof(*av));
437 if (afs_shuttingdown)
440 #ifdef AFS_LINUX26_ENV
441 #if !defined(AFS_NONFSTRANS)
442 if (osi_linux_nfs_initreq(av, acred, &code))
447 av->uid = PagInCred(acred);
448 if (av->uid == NOPAG) {
449 /* Afs doesn't use the unix uid for anuthing except a handle
450 * with which to find the actual authentication tokens so I
451 * think it's ok to use the real uid to make setuid
452 * programs (without setpag) to work properly.
454 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
456 av->uid = -2; /* XXX nobody... ? */
458 av->uid = acred->cr_uid; /* bsd creds don't have ruid */
459 #elif defined(AFS_SUN510_ENV)
460 av->uid = crgetruid(acred);
462 av->uid = acred->cr_ruid; /* default when no pag is set */
469 #ifdef AFS_LINUX26_ONEGROUP_ENV
471 afs_get_pag_from_groups(struct group_info *group_info)
476 AFS_STATCNT(afs_get_pag_from_groups);
477 for (i = 0; (i < group_info->ngroups &&
478 (g0 = GROUP_AT(group_info, i)) != (gid_t) NOGROUP); i++) {
479 if (((g0 >> 24) & 0xff) == 'A')
486 afs_get_pag_from_groups(gid_t g0a, gid_t g1a)
490 afs_uint32 h, l, ret;
492 AFS_STATCNT(afs_get_pag_from_groups);
496 if (g0 < 0xc000 && g1 < 0xc000) {
497 l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
499 h = (g1 >> 14) + h + h + h;
500 ret = ((h << 28) | l);
501 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
504 /* Additional testing */
505 if (((ret >> 24) & 0xff) == 'A')
507 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
514 afs_get_groups_from_pag(afs_uint32 pag, gid_t * g0p, gid_t * g1p)
516 #ifndef AFS_LINUX26_ONEGROUP_ENV
517 unsigned short g0, g1;
521 AFS_STATCNT(afs_get_groups_from_pag);
522 #ifdef AFS_LINUX26_ONEGROUP_ENV
526 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
528 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
529 g0 = 0x3fff & (pag >> 14);
531 g0 |= ((pag >> 28) / 3) << 14;
532 g1 |= ((pag >> 28) % 3) << 14;
540 PagInCred(afs_ucred_t *cred)
543 #if !defined(AFS_LINUX26_ONEGROUP_ENV)
546 #if defined(AFS_SUN510_ENV)
551 AFS_STATCNT(PagInCred);
552 if (cred == NULL || cred == afs_osi_credp) {
555 #if defined(AFS_SUN510_ENV)
556 gids = crgetgroups(cred);
557 ngroups = crgetngroups(cred);
559 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
560 if (cred == NOCRED || cred == FSCRED) {
563 if (cred->cr_ngroups < 3)
565 /* gid is stored in cr_groups[0] */
566 g0 = cred->cr_groups[1];
567 g1 = cred->cr_groups[2];
569 #if defined(AFS_AIX_ENV)
570 if (cred->cr_ngrps < 2) {
573 #elif defined(AFS_LINUX26_ENV)
574 if (cred->cr_group_info->ngroups < NUMPAGGROUPS) {
578 #elif defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DUX40_ENV) || defined(AFS_LINUX20_ENV) || defined(AFS_XBSD_ENV)
579 #if defined(AFS_SUN510_ENV)
582 if (cred->cr_ngroups < 2) {
588 #if defined(AFS_AIX51_ENV)
589 g0 = cred->cr_groupset.gs_union.un_groups[0];
590 g1 = cred->cr_groupset.gs_union.un_groups[1];
591 #elif defined(AFS_LINUX26_ONEGROUP_ENV)
592 #elif defined(AFS_LINUX26_ENV)
593 g0 = GROUP_AT(cred->cr_group_info, 0);
594 g1 = GROUP_AT(cred->cr_group_info, 1);
595 #elif defined(AFS_SUN510_ENV)
599 g0 = cred->cr_groups[0];
600 g1 = cred->cr_groups[1];
603 #if defined(AFS_LINUX26_ONEGROUP_ENV)
604 pag = (afs_int32) afs_get_pag_from_groups(cred->cr_group_info);
606 pag = (afs_int32) afs_get_pag_from_groups(g0, g1);
608 #if defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DUX40_ENV) || defined(AFS_LINUX20_ENV) || defined(AFS_XBSD_ENV)
611 #if defined(AFS_LINUX26_ENV) && defined(LINUX_KEYRING_SUPPORT)
612 if (pag == NOPAG && cred->cr_rgid != NFSXLATOR_CRED) {
614 afs_uint32 upag, newpag;
616 key = request_key(&key_type_afs_pag, "_pag", NULL);
618 if (key_validate(key) == 0 && key->uid == 0) { /* also verify in the session keyring? */
619 upag = (afs_uint32) key->payload.value;
620 if (((upag >> 24) & 0xff) == 'A') {
621 __setpag(&cred, upag, &newpag, 0);
622 pag = (afs_int32) upag;