DEVEL15-linux-warning-reduction-20090318
[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 RCSID
26     ("$Header$");
27
28 #include "afs/sysincludes.h"    /* Standard vendor system headers */
29 #include "afsincludes.h"        /* Afs-based standard headers */
30 #include "afs/afs_stats.h"      /* statistics */
31 #include "afs/afs_cbqueue.h"
32 #include "afs/nfsclient.h"
33 #include "afs/afs_osidnlc.h"
34
35
36 /* Imported variables */
37 extern int afs_shuttingdown;
38
39 /* Exported variables */
40 afs_uint32 pag_epoch;
41 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
42 afs_uint32 pagCounter = 1;
43 #else
44 afs_uint32 pagCounter = 0;
45 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
46
47 #ifdef AFS_LINUX26_ONEGROUP_ENV
48 #define NUMPAGGROUPS 1
49 #else
50 #define NUMPAGGROUPS 2
51 #endif
52 /* Local variables */
53
54 /*
55  * Pags are implemented as follows: the set of groups whose long
56  * representation is '41XXXXXX' hex are used to represent the pags.
57  * Being a member of such a group means you are authenticated as pag
58  * XXXXXX (0x41 == 'A', for Andrew).  You are never authenticated as
59  * multiple pags at once.
60  *
61  * The function afs_InitReq takes a credential field and formats the
62  * corresponding venus request structure.  The uid field in the
63  * vrequest structure is set to the *pag* you are authenticated as, or
64  * the uid, if you aren't authenticated with a pag.
65  *
66  * The basic motivation behind pags is this: just because your unix
67  * uid is N doesn't mean that you should have the same privileges as
68  * anyone logged in on the machine as user N, since this would enable
69  * the superuser on the machine to sneak in and make use of anyone's
70  * authentication info, even that which is only accidentally left
71  * behind when someone leaves a public workstation.
72  *
73  * AFS doesn't use the unix uid for anything except
74  * a handle with which to find the actual authentication tokens
75  * anyway, so the pag is an alternative handle which is somewhat more
76  * secure (although of course not absolutely secure).
77 */
78 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
79 afs_uint32
80 genpag(void)
81 {
82     AFS_STATCNT(genpag);
83 #ifdef AFS_LINUX20_ENV
84     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
85     return (('A' << 24) + ((pag_epoch + pagCounter++) & 0xffffff));
86 #else /* AFS_LINUX20_ENV */
87     return (('A' << 24) + (pagCounter++ & 0xffffff));
88 #endif /* AFS_LINUX20_ENV */
89 }
90
91 afs_uint32
92 getpag(void)
93 {
94     AFS_STATCNT(getpag);
95 #ifdef AFS_LINUX20_ENV
96     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
97     return (('A' << 24) + ((pag_epoch + pagCounter) & 0xffffff));
98 #else
99     return (('A' << 24) + (pagCounter & 0xffffff));
100 #endif
101 }
102
103 #else
104
105 /* Web enhancement: we don't need to restrict pags to 41XXXXXX since
106  * we are not sharing the space with anyone.  So we use the full 32 bits. */
107
108 afs_uint32
109 genpag(void)
110 {
111     AFS_STATCNT(genpag);
112 #ifdef AFS_LINUX20_ENV
113     return (pag_epoch + pagCounter++);
114 #else
115     return (pagCounter++);
116 #endif /* AFS_LINUX20_ENV */
117 }
118
119 afs_uint32
120 getpag(void)
121 {
122     AFS_STATCNT(getpag);
123 #ifdef AFS_LINUX20_ENV
124     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
125     return (pag_epoch + pagCounter);
126 #else
127     return (pagCounter);
128 #endif
129 }
130 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
131
132 /* used to require 10 seconds between each setpag to guarantee that
133  * PAGs never wrap - which would be a security hole.  If we presume
134  * that in ordinary operation, the average rate of PAG allocation
135  * will not exceed one per second, the 24 bits provided will be
136  * sufficient for ~200 days.  Unfortunately, if we merely assume that,
137  * there will be an opportunity for attack.  So we must enforce it.
138  * If we need to increase the average rate of PAG allocation, we
139  * should increase the number of bits in a PAG, and/or reduce our
140  * window in which we guarantee that the PAG counter won't wrap.
141  * By permitting an average of one new PAG per second, new PAGs can
142  * be allocated VERY frequently over a short period relative to total uptime.
143  * Of course, there's only an issue here if one user stays logged (and re-
144  * activates tokens repeatedly) for that entire period.
145  */
146
147 static int afs_pag_sleepcnt = 0;
148 static int afs_pag_timewarn = 0;
149
150 static int
151 afs_pag_sleep(struct AFS_UCRED **acred)
152 {
153     int rv = 0;
154
155     if (!afs_suser(acred)) {
156         if(osi_Time() - pag_epoch < pagCounter) {
157             rv = 1;
158         }
159         if (rv && (osi_Time() < pag_epoch)) {
160             if (!afs_pag_timewarn) {
161                 afs_pag_timewarn = 1;
162                 printf("clock went backwards, not PAG throttling");
163             }
164             rv = 0;
165         }
166     }
167
168     return rv;
169 }
170
171 static int
172 afs_pag_wait(struct AFS_UCRED **acred)
173 {
174     if (afs_pag_sleep(acred)) {
175         if (!afs_pag_sleepcnt) {
176             printf("%s() PAG throttling triggered, pid %d... sleeping.  sleepcnt %d\n",
177                    "afs_pag_wait", osi_getpid(), afs_pag_sleepcnt);
178         }
179
180         afs_pag_sleepcnt++;
181
182         do {
183             /* XXX spins on EINTR */
184             afs_osi_Wait(1000, (struct afs_osi_WaitHandle *)0, 0);
185         } while (afs_pag_sleep(acred));
186
187         afs_pag_sleepcnt--;
188     }
189
190     return 0;
191 }
192
193 int
194 #if     defined(AFS_SUN5_ENV)
195 afs_setpag(struct AFS_UCRED **credpp)
196 #elif  defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
197 afs_setpag(struct proc *p, void *args, int *retval)
198 #else
199 afs_setpag(void)
200 #endif
201 {
202
203 #if     defined(AFS_SUN5_ENV)
204     struct AFS_UCRED **acred = *credpp;
205 #elif  defined(AFS_OBSD_ENV)
206     struct AFS_UCRED **acred = &p->p_ucred;
207 #else
208     struct AFS_UCRED **acred = NULL;
209 #endif
210
211     int code = 0;
212
213 #if defined(AFS_SGI53_ENV) && defined(MP)
214     /* This is our first chance to get the global lock. */
215     AFS_GLOCK();
216 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
217
218     AFS_STATCNT(afs_setpag);
219
220     afs_pag_wait(acred);
221
222
223 #if     defined(AFS_SUN5_ENV)
224     code = AddPag(genpag(), credpp);
225 #elif   defined(AFS_OSF_ENV) || defined(AFS_XBSD_ENV)
226     code = AddPag(p, genpag(), &p->p_rcred);
227 #elif   defined(AFS_AIX41_ENV)
228     {
229         struct ucred *credp;
230         struct ucred *credp0;
231
232         credp = crref();
233         credp0 = credp;
234         code = AddPag(genpag(), &credp);
235         /* If AddPag() didn't make a new cred, then free our cred ref */
236         if (credp == credp0) {
237             crfree(credp);
238         }
239     }
240 #elif   defined(AFS_HPUX110_ENV)
241     {
242         struct ucred *credp = p_cred(u.u_procp);
243         code = AddPag(genpag(), &credp);
244     }
245 #elif   defined(AFS_SGI_ENV)
246     {
247         cred_t *credp;
248         credp = OSI_GET_CURRENT_CRED();
249         code = AddPag(genpag(), &credp);
250     }
251 #elif   defined(AFS_LINUX20_ENV)
252     {
253         struct AFS_UCRED *credp = crref();
254         code = AddPag(genpag(), &credp);
255         crfree(credp);
256     }
257 #elif defined(AFS_DARWIN80_ENV)
258     {
259         struct ucred *credp = kauth_cred_proc_ref(p);
260         code = AddPag(p, genpag(), &credp);
261         kauth_cred_rele(credp);
262     }
263 #elif defined(AFS_DARWIN_ENV)
264     {
265         struct ucred *credp = crdup(p->p_cred->pc_ucred);
266         code = AddPag(p, genpag(), &credp);
267         crfree(credp);
268     }
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(struct AFS_UCRED **credpp, int pagval)
298 #elif  defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
299 afs_setpag_val(struct proc *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     struct AFS_UCRED **acred = *credp;
307 #elif  defined(AFS_OBSD_ENV)
308     struct AFS_UCRED **acred = &p->p_ucred;
309 #else
310     struct AFS_UCRED **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_OSF_ENV) || 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         struct AFS_UCRED *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 #else
365     code = AddPag(pagval, &u.u_cred);
366 #endif
367
368     afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
369 #if defined(KERNEL_HAVE_UERROR)
370     if (!getuerror())
371         setuerror(code);
372 #endif
373 #if defined(AFS_SGI53_ENV) && defined(MP)
374     AFS_GUNLOCK();
375 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
376     return (code);
377 }
378
379 #ifndef AFS_LINUX26_ONEGROUP_ENV
380 int
381 afs_getpag_val()
382 {
383     int pagvalue;
384     struct AFS_UCRED *credp = u.u_cred;
385     gid_t gidset0, gidset1;
386 #ifdef AFS_SUN510_ENV
387     const gid_t *gids;
388
389     gids = crgetgroups(*credp);
390     gidset0 = gids[0];
391     gidset1 = gids[1];
392 #else
393     gidset0 = credp->cr_groups[0];
394     gidset1 = credp->cr_groups[1];
395 #endif
396     pagvalue = afs_get_pag_from_groups(gidset0, gidset1);
397     return pagvalue;
398 }
399 #endif
400 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
401
402
403 /* Note - needs to be available on AIX, others can be static - rework this */
404 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
405 int
406 AddPag(struct proc *p, afs_int32 aval, struct AFS_UCRED **credpp)
407 #else
408 int
409 AddPag(afs_int32 aval, struct AFS_UCRED **credpp)
410 #endif
411 {
412     afs_int32 newpag, code;
413
414     AFS_STATCNT(AddPag);
415 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
416     if ((code = setpag(p, credpp, aval, &newpag, 0)))
417 #else
418     if ((code = setpag(credpp, aval, &newpag, 0)))
419 #endif
420 #if defined(KERNEL_HAVE_UERROR)
421         return (setuerror(code), code);
422 #else
423         return (code);
424 #endif
425     return 0;
426 }
427
428
429 int
430 afs_InitReq(register struct vrequest *av, struct AFS_UCRED *acred)
431 {
432     int code;
433     int i = 0;
434
435     AFS_STATCNT(afs_InitReq);
436     memset(av, 0, sizeof(*av));
437     if (afs_shuttingdown)
438         return EIO;
439
440     av->idleError = 0;
441     av->tokenError = 0;
442     while (i < MAXHOSTS) {
443       av->skipserver[i] = 0;
444       i++;
445     }
446 #ifdef AFS_LINUX26_ENV
447 #if !defined(AFS_NONFSTRANS)
448     if (osi_linux_nfs_initreq(av, acred, &code))
449         return code;
450 #endif
451 #endif
452
453     av->uid = PagInCred(acred);
454     if (av->uid == NOPAG) {
455         /* Afs doesn't use the unix uid for anuthing except a handle
456          * with which to find the actual authentication tokens so I
457          * think it's ok to use the real uid to make setuid
458          * programs (without setpag) to work properly.
459          */
460 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
461         if (acred == NOCRED)
462             av->uid = -2;       /* XXX nobody... ? */
463         else
464             av->uid = acred->cr_uid;    /* bsd creds don't have ruid */
465 #elif defined(AFS_SUN510_ENV)
466         av->uid = crgetruid(acred);
467 #else
468         av->uid = acred->cr_ruid;       /* default when no pag is set */
469 #endif
470     }
471     av->initd = 0;
472     return 0;
473 }
474
475
476 #ifdef AFS_LINUX26_ONEGROUP_ENV
477 afs_uint32
478 afs_get_pag_from_groups(struct group_info *group_info)
479 {
480     afs_uint32 g0 = 0;
481     afs_uint32 i;
482
483     AFS_STATCNT(afs_get_pag_from_groups);
484     for (i = 0; (i < group_info->ngroups && 
485                  (g0 = GROUP_AT(group_info, i)) != (gid_t) NOGROUP); i++) {
486         if (((g0 >> 24) & 0xff) == 'A')
487             return g0;
488     }
489     return NOPAG;
490 }
491 #else
492 afs_uint32
493 afs_get_pag_from_groups(gid_t g0a, gid_t g1a)
494 {
495     afs_uint32 g0 = g0a;
496     afs_uint32 g1 = g1a;
497     afs_uint32 h, l, ret;
498
499     AFS_STATCNT(afs_get_pag_from_groups);
500
501     g0 -= 0x3f00;
502     g1 -= 0x3f00;
503     if (g0 < 0xc000 && g1 < 0xc000) {
504         l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
505         h = (g0 >> 14);
506         h = (g1 >> 14) + h + h + h;
507         ret = ((h << 28) | l);
508 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
509         return ret;
510 #else
511         /* Additional testing */
512         if (((ret >> 24) & 0xff) == 'A')
513             return ret;
514 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
515     }
516     return NOPAG;
517 }
518 #endif
519
520 void
521 afs_get_groups_from_pag(afs_uint32 pag, gid_t * g0p, gid_t * g1p)
522 {
523 #ifndef AFS_LINUX26_ONEGROUP_ENV
524     unsigned short g0, g1;
525 #endif
526
527
528     AFS_STATCNT(afs_get_groups_from_pag);
529 #ifdef AFS_LINUX26_ONEGROUP_ENV
530     *g0p = pag;
531     *g1p = 0;
532 #else
533 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
534     pag &= 0x7fffffff;
535 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
536     g0 = 0x3fff & (pag >> 14);
537     g1 = 0x3fff & pag;
538     g0 |= ((pag >> 28) / 3) << 14;
539     g1 |= ((pag >> 28) % 3) << 14;
540     *g0p = g0 + 0x3f00;
541     *g1p = g1 + 0x3f00;
542 #endif
543 }
544
545
546 afs_int32
547 PagInCred(struct AFS_UCRED *cred)
548 {
549     afs_int32 pag;
550 #if !defined(AFS_LINUX26_ONEGROUP_ENV)
551     gid_t g0, g1;
552 #endif
553 #if defined(AFS_SUN510_ENV)
554     const gid_t *gids;
555     int ngroups;
556 #endif
557
558     AFS_STATCNT(PagInCred);
559     if (cred == NULL || cred == afs_osi_credp) {
560         return NOPAG;
561     }
562 #if defined(AFS_SUN510_ENV)
563     gids = crgetgroups(cred);
564     ngroups = crgetngroups(cred);
565 #endif
566 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
567     if (cred == NOCRED || cred == FSCRED) {
568         return NOPAG;
569     }
570     if (cred->cr_ngroups < 3)
571         return NOPAG;
572     /* gid is stored in cr_groups[0] */
573     g0 = cred->cr_groups[1];
574     g1 = cred->cr_groups[2];
575 #else
576 #if defined(AFS_AIX_ENV)
577     if (cred->cr_ngrps < 2) {
578         return NOPAG;
579     }
580 #elif defined(AFS_LINUX26_ENV)
581     if (cred->cr_group_info->ngroups < NUMPAGGROUPS) {
582         pag = NOPAG;
583         goto out;
584     }
585 #elif defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DUX40_ENV) || defined(AFS_LINUX20_ENV) || defined(AFS_XBSD_ENV)
586 #if defined(AFS_SUN510_ENV)
587     if (ngroups < 2) {
588 #else
589     if (cred->cr_ngroups < 2) {
590 #endif
591         pag = NOPAG;
592         goto out;
593     }
594 #endif
595 #if defined(AFS_AIX51_ENV)
596     g0 = cred->cr_groupset.gs_union.un_groups[0];
597     g1 = cred->cr_groupset.gs_union.un_groups[1];
598 #elif defined(AFS_LINUX26_ONEGROUP_ENV)
599 #elif defined(AFS_LINUX26_ENV)
600     g0 = GROUP_AT(cred->cr_group_info, 0);
601     g1 = GROUP_AT(cred->cr_group_info, 1);
602 #elif defined(AFS_SUN510_ENV)
603     g0 = gids[0];
604     g1 = gids[1];
605 #else
606     g0 = cred->cr_groups[0];
607     g1 = cred->cr_groups[1];
608 #endif
609 #endif
610 #if defined(AFS_LINUX26_ONEGROUP_ENV)
611     pag = (afs_int32) afs_get_pag_from_groups(cred->cr_group_info);
612 #else
613     pag = (afs_int32) afs_get_pag_from_groups(g0, g1);
614 #endif
615 out:
616 #if defined(AFS_LINUX26_ENV) && defined(LINUX_KEYRING_SUPPORT)
617     if (pag == NOPAG && cred->cr_rgid != NFSXLATOR_CRED) {
618         struct key *key;
619         afs_uint32 upag, newpag;
620
621         key = request_key(&key_type_afs_pag, "_pag", NULL);
622         if (!IS_ERR(key)) {
623             if (key_validate(key) == 0 && key->uid == 0) {      /* also verify in the session keyring? */
624                 upag = (afs_uint32) key->payload.value;
625                 if (((upag >> 24) & 0xff) == 'A') {
626                     __setpag(&cred, upag, &newpag, 0);
627                     pag = (afs_int32) upag;
628                 }
629             }
630             key_put(key);
631         } 
632     }
633 #endif
634     return pag;
635 }