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 */
40 afs_uint32 pagCounter = 1;
42 afs_uint32 pagCounter = 0;
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).
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);
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 afs_warn("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 afs_warn("%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_FBSD_ENV)
195 afs_setpag(struct thread *td, void *args)
196 #elif defined(AFS_NBSD_ENV)
197 afs_setpag(afs_proc_t *p, const void *args, register_t *retval)
198 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
199 afs_setpag(afs_proc_t *p, void *args, int *retval)
205 #if defined(AFS_SUN5_ENV)
206 afs_ucred_t **acred = *credpp;
207 #elif defined(AFS_OBSD_ENV)
208 afs_ucred_t **acred = &p->p_ucred;
210 afs_ucred_t **acred = NULL;
215 #if defined(AFS_SGI53_ENV) && defined(MP)
216 /* This is our first chance to get the global lock. */
218 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
220 AFS_STATCNT(afs_setpag);
225 #if defined(AFS_SUN5_ENV)
226 code = AddPag(genpag(), credpp);
227 #elif defined(AFS_FBSD_ENV)
228 code = AddPag(td, genpag(), &td->td_ucred);
229 #elif defined(AFS_NBSD40_ENV)
230 code = AddPag(p, genpag(), &p->l_proc->p_cred);
231 #elif defined(AFS_XBSD_ENV)
232 code = AddPag(p, genpag(), &p->p_rcred);
233 #elif defined(AFS_AIX41_ENV)
236 struct ucred *credp0;
240 code = AddPag(genpag(), &credp);
241 /* If AddPag() didn't make a new cred, then free our cred ref */
242 if (credp == credp0) {
246 #elif defined(AFS_HPUX110_ENV)
248 struct ucred *credp = p_cred(u.u_procp);
249 code = AddPag(genpag(), &credp);
251 #elif defined(AFS_SGI_ENV)
254 credp = OSI_GET_CURRENT_CRED();
255 code = AddPag(genpag(), &credp);
257 #elif defined(AFS_LINUX20_ENV)
259 afs_ucred_t *credp = crref();
260 code = AddPag(genpag(), &credp);
263 #elif defined(AFS_DARWIN80_ENV)
265 afs_ucred_t *credp = kauth_cred_proc_ref(p);
266 code = AddPag(p, genpag(), &credp);
269 #elif defined(AFS_DARWIN_ENV)
271 afs_ucred_t *credp = crdup(p->p_cred->pc_ucred);
272 code = AddPag(p, genpag(), &credp);
275 #elif defined(UKERNEL)
276 code = AddPag(genpag(), &(get_user_struct()->u_cred));
278 code = AddPag(genpag(), &u.u_cred);
281 afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
283 #if defined(KERNEL_HAVE_UERROR)
288 #if defined(AFS_SGI53_ENV) && defined(MP)
290 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
298 * This function is like setpag but sets the current thread's pag id to a
299 * caller-provided value instead of calling genpag(). This implements a
300 * form of token caching since the caller can recall a particular pag value
301 * for the thread to restore tokens, rather than reauthenticating.
304 #if defined(AFS_SUN5_ENV)
305 afs_setpag_val(afs_ucred_t **credpp, int pagval)
306 #elif defined(AFS_FBSD_ENV)
307 afs_setpag_val(struct thread *td, void *args, int pagval)
308 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
309 afs_setpag_val(afs_proc_t *p, void *args, int *retval, int pagval)
311 afs_setpag_val(int pagval)
315 #if defined(AFS_SUN5_ENV)
316 afs_ucred_t **acred = *credp;
317 #elif defined(AFS_OBSD_ENV)
318 afs_ucred_t **acred = &p->p_ucred;
320 afs_ucred_t **acred = NULL;
325 #if defined(AFS_SGI53_ENV) && defined(MP)
326 /* This is our first chance to get the global lock. */
328 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
330 AFS_STATCNT(afs_setpag);
334 #if defined(AFS_SUN5_ENV)
335 code = AddPag(pagval, credpp);
336 #elif defined(AFS_FBSD_ENV)
337 code = AddPag(td, pagval, &td->td_ucred);
338 #elif defined(AFS_XBSD_ENV)
339 code = AddPag(p, pagval, &p->p_rcred);
340 #elif defined(AFS_AIX41_ENV)
343 struct ucred *credp0;
347 code = AddPag(pagval, &credp);
348 /* If AddPag() didn't make a new cred, then free our cred ref */
349 if (credp == credp0) {
353 #elif defined(AFS_HPUX110_ENV)
355 struct ucred *credp = p_cred(u.u_procp);
356 code = AddPag(pagval, &credp);
358 #elif defined(AFS_SGI_ENV)
361 credp = OSI_GET_CURRENT_CRED();
362 code = AddPag(pagval, &credp);
364 #elif defined(AFS_LINUX20_ENV)
366 afs_ucred_t *credp = crref();
367 code = AddPag(pagval, &credp);
370 #elif defined(AFS_DARWIN_ENV)
372 struct ucred *credp = crdup(p->p_cred->pc_ucred);
373 code = AddPag(p, pagval, &credp);
376 #elif defined(UKERNEL)
377 code = AddPag(pagval, &(get_user_struct()->u_cred));
379 code = AddPag(pagval, &u.u_cred);
382 afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
383 #if defined(KERNEL_HAVE_UERROR)
387 #if defined(AFS_SGI53_ENV) && defined(MP)
389 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
393 #ifndef AFS_LINUX26_ONEGROUP_ENV
399 afs_ucred_t *credp = get_user_struct()->u_cred;
401 afs_ucred_t *credp = u.u_cred;
403 gid_t gidset0, gidset1;
404 #ifdef AFS_SUN510_ENV
407 gids = crgetgroups(*credp);
411 gidset0 = credp->cr_groups[0];
412 gidset1 = credp->cr_groups[1];
414 pagvalue = afs_get_pag_from_groups(gidset0, gidset1);
421 /* Note - needs to be available on AIX, others can be static - rework this */
423 #if defined(AFS_FBSD_ENV)
424 AddPag(struct thread *p, afs_int32 aval, afs_ucred_t **credpp)
425 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
426 AddPag(afs_proc_t *p, afs_int32 aval, afs_ucred_t **credpp)
428 AddPag(afs_int32 aval, afs_ucred_t **credpp)
435 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
436 if ((code = setpag(p, credpp, aval, &newpag, 0)))
438 if ((code = setpag(credpp, aval, &newpag, 0)))
440 #if defined(KERNEL_HAVE_UERROR)
441 return (setuerror(code), code);
450 afs_InitReq(struct vrequest *av, afs_ucred_t *acred)
452 #if defined(AFS_LINUX26_ENV) && !defined(AFS_NONFSTRANS)
456 AFS_STATCNT(afs_InitReq);
457 memset(av, 0, sizeof(*av));
458 if (afs_shuttingdown)
461 #ifdef AFS_LINUX26_ENV
462 #if !defined(AFS_NONFSTRANS)
463 if (osi_linux_nfs_initreq(av, acred, &code))
468 av->uid = PagInCred(acred);
469 if (av->uid == NOPAG) {
470 /* Afs doesn't use the unix uid for anuthing except a handle
471 * with which to find the actual authentication tokens so I
472 * think it's ok to use the real uid to make setuid
473 * programs (without setpag) to work properly.
475 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
477 av->uid = -2; /* XXX nobody... ? */
479 av->uid = afs_cr_uid(acred); /* bsd creds don't have ruid */
480 #elif defined(AFS_SUN510_ENV)
481 av->uid = crgetruid(acred);
483 av->uid = afs_cr_uid(acred); /* default when no pag is set */
489 #ifndef AFS_LINUX26_ONEGROUP_ENV
491 afs_get_pag_from_groups(gid_t g0a, gid_t g1a)
495 afs_uint32 h, l, ret;
497 AFS_STATCNT(afs_get_pag_from_groups);
501 if (g0 < 0xc000 && g1 < 0xc000) {
502 l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
504 h = (g1 >> 14) + h + h + h;
505 ret = ((h << 28) | l);
506 # if defined(UKERNEL)
509 /* Additional testing */
510 if (((ret >> 24) & 0xff) == 'A')
512 # endif /* UKERNEL */
518 afs_get_groups_from_pag(afs_uint32 pag, gid_t * g0p, gid_t * g1p)
520 unsigned short g0, g1;
522 AFS_STATCNT(afs_get_groups_from_pag);
525 # if !defined(UKERNEL)
527 # endif /* UKERNEL */
528 g0 = 0x3fff & (pag >> 14);
530 g0 |= ((pag >> 28) / 3) << 14;
531 g1 |= ((pag >> 28) % 3) << 14;
536 void afs_get_groups_from_pag(afs_uint32 pag, gid_t *g0p, gid_t *g1p)
538 AFS_STATCNT(afs_get_groups_from_pag);
544 #if !defined(AFS_LINUX26_ENV) && !defined(AFS_DARWIN110_ENV)
546 osi_get_group_pag(afs_ucred_t *cred)
548 afs_int32 pag = NOPAG;
550 #if defined(AFS_SUN510_ENV)
555 #if defined(AFS_SUN510_ENV)
556 gids = crgetgroups(cred);
557 ngroups = crgetngroups(cred);
559 #if defined(AFS_NBSD40_ENV)
560 if (cred == NOCRED || cred == FSCRED)
562 if (osi_crngroups(cred) < 3)
564 g0 = osi_crgroupbyid(cred, 1);
565 g1 = osi_crgroupbyid(cred, 2);
566 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
567 if (cred == NOCRED || cred == FSCRED)
569 if (cred->cr_ngroups < 3)
571 /* gid is stored in cr_groups[0] */
572 g0 = cred->cr_groups[1];
573 g1 = cred->cr_groups[2];
575 # if defined(AFS_AIX_ENV)
576 if (cred->cr_ngrps < 2)
578 # elif defined(AFS_LINUX26_ENV)
579 if (afs_cr_group_info(cred)->ngroups < NUMPAGGROUPS)
581 # elif defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_LINUX20_ENV) || defined(AFS_XBSD_ENV)
582 # if defined(AFS_SUN510_ENV)
585 if (cred->cr_ngroups < 2) {
590 # if defined(AFS_AIX51_ENV)
591 g0 = cred->cr_groupset.gs_union.un_groups[0];
592 g1 = cred->cr_groupset.gs_union.un_groups[1];
593 #elif defined(AFS_SUN510_ENV)
597 g0 = cred->cr_groups[0];
598 g1 = cred->cr_groups[1];
601 pag = (afs_int32) afs_get_pag_from_groups(g0, g1);
608 PagInCred(afs_ucred_t *cred)
610 afs_int32 pag = NOPAG;
612 AFS_STATCNT(PagInCred);
613 if (cred == NULL || cred == afs_osi_credp) {
616 #ifndef AFS_DARWIN110_ENV
617 #if defined(AFS_LINUX26_ENV) && defined(LINUX_KEYRING_SUPPORT)
619 * If linux keyrings are in use and we carry the session keyring in our credentials
620 * structure, they should be the only criteria for determining
621 * if we're in a PAG. Groups are updated for legacy reasons only for now,
622 * and should not be used to infer PAG membership
623 * With keyrings but no kernel credentials, look at groups first and fall back
624 * to looking at the keyrings.
626 # if !defined(STRUCT_TASK_STRUCT_HAS_CRED)
627 pag = osi_get_group_pag(cred);
630 pag = osi_get_keyring_pag(cred);
631 #elif defined(AFS_AIX51_ENV)
632 if (kcred_getpag(cred, PAG_AFS, &pag) < 0 || pag == 0)
635 pag = osi_get_group_pag(cred);