b1043ebfc23b2e10e043cb7034d80c4c083a997e
[openafs.git] / src / afs / afs_osi_pag.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  * genpag
13  * getpag
14  * afs_setpag
15  * AddPag
16  * afs_InitReq
17  * afs_get_pag_from_groups
18  * afs_get_groups_from_pag
19  * PagInCred
20  */
21
22 #include <afsconfig.h>
23 #include "afs/param.h"
24
25
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"
32
33
34 /* Imported variables */
35 extern int afs_shuttingdown;
36
37 /* Exported variables */
38 afs_uint32 pag_epoch;
39 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
40 afs_uint32 pagCounter = 1;
41 #else
42 afs_uint32 pagCounter = 0;
43 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
44
45 #ifdef AFS_LINUX26_ONEGROUP_ENV
46 #define NUMPAGGROUPS 1
47 #else
48 #define NUMPAGGROUPS 2
49 #endif
50 /* Local variables */
51
52 /*
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.
58  *
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.
63  *
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.
70  *
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).
75 */
76 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
77 afs_uint32
78 genpag(void)
79 {
80     AFS_STATCNT(genpag);
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 */
87 }
88
89 afs_uint32
90 getpag(void)
91 {
92     AFS_STATCNT(getpag);
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));
96 #else
97     return (('A' << 24) + (pagCounter & 0xffffff));
98 #endif
99 }
100
101 #else
102
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. */
105
106 afs_uint32
107 genpag(void)
108 {
109     AFS_STATCNT(genpag);
110 #ifdef AFS_LINUX20_ENV
111     return (pag_epoch + pagCounter++);
112 #else
113     return (pagCounter++);
114 #endif /* AFS_LINUX20_ENV */
115 }
116
117 afs_uint32
118 getpag(void)
119 {
120     AFS_STATCNT(getpag);
121 #ifdef AFS_LINUX20_ENV
122     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
123     return (pag_epoch + pagCounter);
124 #else
125     return (pagCounter);
126 #endif
127 }
128 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
129
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.
143  */
144
145 static int afs_pag_sleepcnt = 0;
146 static int afs_pag_timewarn = 0;
147
148 static int
149 afs_pag_sleep(afs_ucred_t **acred)
150 {
151     int rv = 0;
152
153     if (!afs_suser(acred)) {
154         if(osi_Time() - pag_epoch < pagCounter) {
155             rv = 1;
156         }
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");
161             }
162             rv = 0;
163         }
164     }
165
166     return rv;
167 }
168
169 static int
170 afs_pag_wait(afs_ucred_t **acred)
171 {
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);
176         }
177
178         afs_pag_sleepcnt++;
179
180         do {
181             /* XXX spins on EINTR */
182             afs_osi_Wait(1000, (struct afs_osi_WaitHandle *)0, 0);
183         } while (afs_pag_sleep(acred));
184
185         afs_pag_sleepcnt--;
186     }
187
188     return 0;
189 }
190
191 int
192 #if     defined(AFS_SUN5_ENV)
193 afs_setpag(afs_ucred_t **credpp)
194 #elif  defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
195 afs_setpag(afs_proc_t *p, void *args, int *retval)
196 #else
197 afs_setpag(void)
198 #endif
199 {
200
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;
205 #else
206     afs_ucred_t **acred = NULL;
207 #endif
208
209     int code = 0;
210
211 #if defined(AFS_SGI53_ENV) && defined(MP)
212     /* This is our first chance to get the global lock. */
213     AFS_GLOCK();
214 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
215
216     AFS_STATCNT(afs_setpag);
217
218     afs_pag_wait(acred);
219
220
221 #if     defined(AFS_SUN5_ENV)
222     code = AddPag(genpag(), credpp);
223 #elif   defined(AFS_XBSD_ENV)
224     code = AddPag(p, genpag(), &p->p_rcred);
225 #elif   defined(AFS_AIX41_ENV)
226     {
227         struct ucred *credp;
228         struct ucred *credp0;
229
230         credp = crref();
231         credp0 = credp;
232         code = AddPag(genpag(), &credp);
233         /* If AddPag() didn't make a new cred, then free our cred ref */
234         if (credp == credp0) {
235             crfree(credp);
236         }
237     }
238 #elif   defined(AFS_HPUX110_ENV)
239     {
240         struct ucred *credp = p_cred(u.u_procp);
241         code = AddPag(genpag(), &credp);
242     }
243 #elif   defined(AFS_SGI_ENV)
244     {
245         cred_t *credp;
246         credp = OSI_GET_CURRENT_CRED();
247         code = AddPag(genpag(), &credp);
248     }
249 #elif   defined(AFS_LINUX20_ENV)
250     {
251         afs_ucred_t *credp = crref();
252         code = AddPag(genpag(), &credp);
253         crfree(credp);
254     }
255 #elif defined(AFS_DARWIN80_ENV)
256     {
257         afs_ucred_t *credp = kauth_cred_proc_ref(p);
258         code = AddPag(p, genpag(), &credp);
259         crfree(credp);
260     }
261 #elif defined(AFS_DARWIN_ENV)
262     {
263         afs_ucred_t *credp = crdup(p->p_cred->pc_ucred);
264         code = AddPag(p, genpag(), &credp);
265         crfree(credp);
266     }
267 #elif defined(UKERNEL)
268     code = AddPag(genpag(), &(get_user_struct()->u_cred));
269 #else
270     code = AddPag(genpag(), &u.u_cred);
271 #endif
272
273     afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
274
275 #if defined(KERNEL_HAVE_UERROR)
276     if (!getuerror())
277         setuerror(code);
278 #endif
279
280 #if defined(AFS_SGI53_ENV) && defined(MP)
281     AFS_GUNLOCK();
282 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
283
284     return (code);
285 }
286
287 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
288 /*
289  * afs_setpag_val
290  * This function is like setpag but sets the current thread's pag id to a
291  * caller-provided value instead of calling genpag().  This implements a
292  * form of token caching since the caller can recall a particular pag value
293  * for the thread to restore tokens, rather than reauthenticating.
294  */
295 int
296 #if     defined(AFS_SUN5_ENV)
297 afs_setpag_val(afs_ucred_t **credpp, int pagval)
298 #elif  defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
299 afs_setpag_val(afs_proc_t *p, void *args, int *retval, int pagval)
300 #else
301 afs_setpag_val(int pagval)
302 #endif
303 {
304
305 #if     defined(AFS_SUN5_ENV)
306     afs_ucred_t **acred = *credp;
307 #elif  defined(AFS_OBSD_ENV)
308     afs_ucred_t **acred = &p->p_ucred;
309 #else
310     afs_ucred_t **acred = NULL;
311 #endif
312
313     int code = 0;
314
315 #if defined(AFS_SGI53_ENV) && defined(MP)
316     /* This is our first chance to get the global lock. */
317     AFS_GLOCK();
318 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
319
320     AFS_STATCNT(afs_setpag);
321
322     afs_pag_wait(acred);
323
324 #if     defined(AFS_SUN5_ENV)
325     code = AddPag(pagval, credpp);
326 #elif   defined(AFS_XBSD_ENV)
327     code = AddPag(p, pagval, &p->p_rcred);
328 #elif   defined(AFS_AIX41_ENV)
329     {
330         struct ucred *credp;
331         struct ucred *credp0;
332
333         credp = crref();
334         credp0 = credp;
335         code = AddPag(pagval, &credp);
336         /* If AddPag() didn't make a new cred, then free our cred ref */
337         if (credp == credp0) {
338             crfree(credp);
339         }
340     }
341 #elif   defined(AFS_HPUX110_ENV)
342     {
343         struct ucred *credp = p_cred(u.u_procp);
344         code = AddPag(pagval, &credp);
345     }
346 #elif   defined(AFS_SGI_ENV)
347     {
348         cred_t *credp;
349         credp = OSI_GET_CURRENT_CRED();
350         code = AddPag(pagval, &credp);
351     }
352 #elif   defined(AFS_LINUX20_ENV)
353     {
354         afs_ucred_t *credp = crref();
355         code = AddPag(pagval, &credp);
356         crfree(credp);
357     }
358 #elif defined(AFS_DARWIN_ENV)
359     {
360         struct ucred *credp = crdup(p->p_cred->pc_ucred);
361         code = AddPag(p, pagval, &credp);
362         crfree(credp);
363     }
364 #elif defined(UKERNEL)
365     code = AddPag(pagval, &(get_user_struct()->u_cred));
366 #else
367     code = AddPag(pagval, &u.u_cred);
368 #endif
369
370     afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
371 #if defined(KERNEL_HAVE_UERROR)
372     if (!getuerror())
373         setuerror(code);
374 #endif
375 #if defined(AFS_SGI53_ENV) && defined(MP)
376     AFS_GUNLOCK();
377 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
378     return (code);
379 }
380
381 #ifndef AFS_LINUX26_ONEGROUP_ENV
382 int
383 afs_getpag_val(void)
384 {
385     int pagvalue;
386 #ifdef UKERNEL
387     afs_ucred_t *credp = get_user_struct()->u_cred;
388 #else
389     afs_ucred_t *credp = u.u_cred;
390 #endif
391     gid_t gidset0, gidset1;
392 #ifdef AFS_SUN510_ENV
393     const gid_t *gids;
394
395     gids = crgetgroups(*credp);
396     gidset0 = gids[0];
397     gidset1 = gids[1];
398 #else
399     gidset0 = credp->cr_groups[0];
400     gidset1 = credp->cr_groups[1];
401 #endif
402     pagvalue = afs_get_pag_from_groups(gidset0, gidset1);
403     return pagvalue;
404 }
405 #endif
406 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
407
408
409 /* Note - needs to be available on AIX, others can be static - rework this */
410 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
411 int
412 AddPag(afs_proc_t *p, afs_int32 aval, afs_ucred_t **credpp)
413 #else
414 int
415 AddPag(afs_int32 aval, afs_ucred_t **credpp)
416 #endif
417 {
418     afs_int32 code;
419     afs_uint32 newpag;
420
421     AFS_STATCNT(AddPag);
422 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
423     if ((code = setpag(p, credpp, aval, &newpag, 0)))
424 #else
425     if ((code = setpag(credpp, aval, &newpag, 0)))
426 #endif
427 #if defined(KERNEL_HAVE_UERROR)
428         return (setuerror(code), code);
429 #else
430         return (code);
431 #endif
432     return 0;
433 }
434
435
436 int
437 afs_InitReq(register struct vrequest *av, afs_ucred_t *acred)
438 {
439 #if defined(AFS_LINUX26_ENV) && !defined(AFS_NONFSTRANS)
440     int code;
441 #endif
442
443     AFS_STATCNT(afs_InitReq);
444     memset(av, 0, sizeof(*av));
445     if (afs_shuttingdown)
446         return EIO;
447
448 #ifdef AFS_LINUX26_ENV
449 #if !defined(AFS_NONFSTRANS)
450     if (osi_linux_nfs_initreq(av, acred, &code))
451         return code;
452 #endif
453 #endif
454
455     av->uid = PagInCred(acred);
456     if (av->uid == NOPAG) {
457         /* Afs doesn't use the unix uid for anuthing except a handle
458          * with which to find the actual authentication tokens so I
459          * think it's ok to use the real uid to make setuid
460          * programs (without setpag) to work properly.
461          */
462 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
463         if (acred == NOCRED)
464             av->uid = -2;       /* XXX nobody... ? */
465         else
466             av->uid = afs_cr_uid(acred);        /* bsd creds don't have ruid */
467 #elif defined(AFS_SUN510_ENV)
468         av->uid = crgetruid(acred);
469 #else
470         av->uid = afs_cr_uid(acred);    /* default when no pag is set */
471 #endif
472     }
473     return 0;
474 }
475
476 #ifndef AFS_LINUX26_ONEGROUP_ENV
477 afs_uint32
478 afs_get_pag_from_groups(gid_t g0a, gid_t g1a)
479 {
480     afs_uint32 g0 = g0a;
481     afs_uint32 g1 = g1a;
482     afs_uint32 h, l, ret;
483
484     AFS_STATCNT(afs_get_pag_from_groups);
485
486     g0 -= 0x3f00;
487     g1 -= 0x3f00;
488     if (g0 < 0xc000 && g1 < 0xc000) {
489         l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
490         h = (g0 >> 14);
491         h = (g1 >> 14) + h + h + h;
492         ret = ((h << 28) | l);
493 # if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
494         return ret;
495 # else
496         /* Additional testing */
497         if (((ret >> 24) & 0xff) == 'A')
498             return ret;
499 # endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
500     }
501     return NOPAG;
502 }
503
504 void
505 afs_get_groups_from_pag(afs_uint32 pag, gid_t * g0p, gid_t * g1p)
506 {
507     unsigned short g0, g1;
508
509     AFS_STATCNT(afs_get_groups_from_pag);
510     *g0p = pag;
511     *g1p = 0;
512 # if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
513     pag &= 0x7fffffff;
514 # endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
515     g0 = 0x3fff & (pag >> 14);
516     g1 = 0x3fff & pag;
517     g0 |= ((pag >> 28) / 3) << 14;
518     g1 |= ((pag >> 28) % 3) << 14;
519     *g0p = g0 + 0x3f00;
520     *g1p = g1 + 0x3f00;
521 }
522 #else
523 void afs_get_groups_from_pag(afs_uint32 pag, gid_t *g0p, gid_t *g1p)
524 {
525     AFS_STATCNT(afs_get_groups_from_pag);
526     *g0p = pag;
527     *g1p = 0;
528 }
529 #endif
530
531 #ifndef AFS_LINUX26_ENV
532 static afs_int32
533 osi_get_group_pag(afs_ucred_t *cred)
534 {
535     afs_int32 pag = NOPAG;
536     gid_t g0, g1;
537 #if defined(AFS_SUN510_ENV)
538     const gid_t *gids;
539     int ngroups;
540 #endif
541
542 #if defined(AFS_SUN510_ENV)
543     gids = crgetgroups(cred);
544     ngroups = crgetngroups(cred);
545 #endif
546 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
547     if (cred == NOCRED || cred == FSCRED)
548         return NOPAG;
549     if (cred->cr_ngroups < 3)
550         return NOPAG;
551     /* gid is stored in cr_groups[0] */
552     g0 = cred->cr_groups[1];
553     g1 = cred->cr_groups[2];
554 #else
555 # if defined(AFS_AIX_ENV)
556     if (cred->cr_ngrps < 2)
557         return NOPAG;
558 # elif defined(AFS_LINUX26_ENV)
559     if (afs_cr_group_info(cred)->ngroups < NUMPAGGROUPS)
560         return NOPAG;
561 # elif defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_LINUX20_ENV) || defined(AFS_XBSD_ENV)
562 #  if defined(AFS_SUN510_ENV)
563     if (ngroups < 2) {
564 #  else
565     if (cred->cr_ngroups < 2) {
566 #  endif
567         return NOPAG;
568     }
569 # endif
570 # if defined(AFS_AIX51_ENV)
571     g0 = cred->cr_groupset.gs_union.un_groups[0];
572     g1 = cred->cr_groupset.gs_union.un_groups[1];
573 #elif defined(AFS_SUN510_ENV)
574     g0 = gids[0];
575     g1 = gids[1];
576 #else
577     g0 = cred->cr_groups[0];
578     g1 = cred->cr_groups[1];
579 #endif
580 #endif
581     pag = (afs_int32) afs_get_pag_from_groups(g0, g1);
582     return pag;
583 }
584 #endif
585
586
587 afs_int32
588 PagInCred(afs_ucred_t *cred)
589 {
590     afs_int32 pag = NOPAG;
591
592     AFS_STATCNT(PagInCred);
593     if (cred == NULL || cred == afs_osi_credp) {
594         return NOPAG;
595     }
596 #if defined(AFS_LINUX26_ENV) && defined(LINUX_KEYRING_SUPPORT)
597     /*
598      * If linux keyrings are in use and we carry the session keyring in our credentials
599      * structure, they should be the only criteria for determining
600      * if we're in a PAG.  Groups are updated for legacy reasons only for now,
601      * and should not be used to infer PAG membership
602      * With keyrings but no kernel credentials, look at groups first and fall back
603      * to looking at the keyrings.
604      */
605 # if !defined(STRUCT_TASK_HAS_CRED)
606     pag = osi_get_group_pag(cred);
607 # endif
608     if (pag == NOPAG)
609         pag = osi_get_keyring_pag(cred);
610 #else
611     pag = osi_get_group_pag(cred);
612 #endif
613     return pag;
614 }