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 /* Local variables */
  48
  49 /*
  50  * Pags are implemented as follows: the set of groups whose long
  51  * representation is '41XXXXXX' hex are used to represent the pags.
  52  * Being a member of such a group means you are authenticated as pag
  53  * XXXXXX (0x41 == 'A', for Andrew).  You are never authenticated as
  54  * multiple pags at once.
  55  *
  56  * The function afs_InitReq takes a credential field and formats the
  57  * corresponding venus request structure.  The uid field in the
  58  * vrequest structure is set to the *pag* you are authenticated as, or
  59  * the uid, if you aren't authenticated with a pag.
  60  *
  61  * The basic motivation behind pags is this: just because your unix
  62  * uid is N doesn't mean that you should have the same privileges as
  63  * anyone logged in on the machine as user N, since this would enable
  64  * the superuser on the machine to sneak in and make use of anyone's
  65  * authentication info, even that which is only accidentally left
  66  * behind when someone leaves a public workstation.
  67  *
  68  * AFS doesn't use the unix uid for anything except
  69  * a handle with which to find the actual authentication tokens
  70  * anyway, so the pag is an alternative handle which is somewhat more
  71  * secure (although of course not absolutely secure).
  72 */
  73 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
  74 afs_uint32
  75 genpag(void)
  76 {
  77     AFS_STATCNT(genpag);
  78 #ifdef AFS_LINUX20_ENV
  79     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
  80     return (('A' << 24) + ((pag_epoch + pagCounter++) & 0xffffff));
  81 #else /* AFS_LINUX20_ENV */
  82     return (('A' << 24) + (pagCounter++ & 0xffffff));
  83 #endif /* AFS_LINUX20_ENV */
  84 }
  85
  86 afs_uint32
  87 getpag(void)
  88 {
  89     AFS_STATCNT(getpag);
  90 #ifdef AFS_LINUX20_ENV
  91     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
  92     return (('A' << 24) + ((pag_epoch + pagCounter) & 0xffffff));
  93 #else
  94     return (('A' << 24) + (pagCounter & 0xffffff));
  95 #endif
  96 }
  97
  98 #else
  99
 100 /* Web enhancement: we don't need to restrict pags to 41XXXXXX since
 101  * we are not sharing the space with anyone.  So we use the full 32 bits. */
 102
 103 afs_uint32
 104 genpag(void)
 105 {
 106     AFS_STATCNT(genpag);
 107 #ifdef AFS_LINUX20_ENV
 108     return (pag_epoch + pagCounter++);
 109 #else
 110     return (pagCounter++);
 111 #endif /* AFS_LINUX20_ENV */
 112 }
 113
 114 afs_uint32
 115 getpag(void)
 116 {
 117     AFS_STATCNT(getpag);
 118 #ifdef AFS_LINUX20_ENV
 119     /* Ensure unique PAG's (mod 200 days) when reloading the client. */
 120     return (pag_epoch + pagCounter);
 121 #else
 122     return (pagCounter);
 123 #endif
 124 }
 125 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
 126
 127 /* used to require 10 seconds between each setpag to guarantee that
 128  * PAGs never wrap - which would be a security hole.  If we presume
 129  * that in ordinary operation, the average rate of PAG allocation
 130  * will not exceed one per second, the 24 bits provided will be
 131  * sufficient for ~200 days.  Unfortunately, if we merely assume that,
 132  * there will be an opportunity for attack.  So we must enforce it.
 133  * If we need to increase the average rate of PAG allocation, we
 134  * should increase the number of bits in a PAG, and/or reduce our
 135  * window in which we guarantee that the PAG counter won't wrap.
 136  * By permitting an average of one new PAG per second, new PAGs can
 137  * be allocated VERY frequently over a short period relative to total uptime.
 138  * Of course, there's only an issue here if one user stays logged (and re-
 139  * activates tokens repeatedly) for that entire period.
 140  */
 141
 142 static int afs_pag_sleepcnt = 0;
 143
 144 static int
 145 afs_pag_sleep(struct AFS_UCRED **acred)
 146 {
 147     int rv = 0;
 148
 149     if (!afs_suser(acred)) {
 150         if(osi_Time() - pag_epoch < pagCounter) {
 151             rv = 1;
 152         }
 153     }
 154
 155     return rv;
 156 }
 157
 158 static int
 159 afs_pag_wait(struct AFS_UCRED **acred)
 160 {
 161     if (afs_pag_sleep(acred)) {
 162         if (!afs_pag_sleepcnt) {
 163             printf("%s() PAG throttling triggered, pid %d... sleeping.  sleepcnt %d\n",
 164                    "afs_pag_wait", osi_getpid(), afs_pag_sleepcnt);
 165         }
 166
 167         afs_pag_sleepcnt++;
 168
 169         do {
 170             /* XXX spins on EINTR */
 171             afs_osi_Wait(1000, (struct afs_osi_WaitHandle *)0, 0);
 172         } while (afs_pag_sleep(acred));
 173
 174         afs_pag_sleepcnt--;
 175     }
 176
 177     return 0;
 178 }
 179
 180 int
 181 #if     defined(AFS_SUN5_ENV)
 182 afs_setpag(struct AFS_UCRED **credpp)
 183 #elif  defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 184 afs_setpag(struct proc *p, void *args, int *retval)
 185 #else
 186 afs_setpag(void)
 187 #endif
 188 {
 189
 190 #if     defined(AFS_SUN5_ENV)
 191     struct AFS_UCRED **acred = *credpp;
 192 #elif  defined(AFS_OBSD_ENV)
 193     struct AFS_UCRED **acred = &p->p_ucred;
 194 #else
 195     struct AFS_UCRED **acred = NULL;
 196 #endif
 197
 198     int code = 0;
 199
 200 #if defined(AFS_SGI53_ENV) && defined(MP)
 201     /* This is our first chance to get the global lock. */
 202     AFS_GLOCK();
 203 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
 204
 205     AFS_STATCNT(afs_setpag);
 206
 207     afs_pag_wait(acred);
 208
 209
 210 #if     defined(AFS_SUN5_ENV)
 211     code = AddPag(genpag(), credpp);
 212 #elif   defined(AFS_OSF_ENV) || defined(AFS_XBSD_ENV)
 213     code = AddPag(p, genpag(), &p->p_rcred);
 214 #elif   defined(AFS_AIX41_ENV)
 215     {
 216         struct ucred *credp;
 217         struct ucred *credp0;
 218
 219         credp = crref();
 220         credp0 = credp;
 221         code = AddPag(genpag(), &credp);
 222         /* If AddPag() didn't make a new cred, then free our cred ref */
 223         if (credp == credp0) {
 224             crfree(credp);
 225         }
 226     }
 227 #elif   defined(AFS_HPUX110_ENV)
 228     {
 229         struct ucred *credp = p_cred(u.u_procp);
 230         code = AddPag(genpag(), &credp);
 231     }
 232 #elif   defined(AFS_SGI_ENV)
 233     {
 234         cred_t *credp;
 235         credp = OSI_GET_CURRENT_CRED();
 236         code = AddPag(genpag(), &credp);
 237     }
 238 #elif   defined(AFS_LINUX20_ENV)
 239     {
 240         struct AFS_UCRED *credp = crref();
 241         code = AddPag(genpag(), &credp);
 242         crfree(credp);
 243     }
 244 #elif defined(AFS_DARWIN_ENV)
 245     {
 246         struct ucred *credp = crdup(p->p_cred->pc_ucred);
 247         code = AddPag(p, genpag(), &credp);
 248         crfree(credp);
 249     }
 250 #else
 251     code = AddPag(genpag(), &u.u_cred);
 252 #endif
 253
 254     afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
 255
 256 #if defined(KERNEL_HAVE_UERROR)
 257     if (!getuerror())
 258         setuerror(code);
 259 #endif
 260
 261 #if defined(AFS_SGI53_ENV) && defined(MP)
 262     AFS_GUNLOCK();
 263 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
 264
 265     return (code);
 266 }
 267
 268 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
 269 /*
 270  * afs_setpag_val
 271  * This function is like setpag but sets the current thread's pag id to a
 272  * caller-provided value instead of calling genpag().  This implements a
 273  * form of token caching since the caller can recall a particular pag value
 274  * for the thread to restore tokens, rather than reauthenticating.
 275  */
 276 int
 277 #if     defined(AFS_SUN5_ENV)
 278 afs_setpag_val(struct AFS_UCRED **credpp, int pagval)
 279 #elif  defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 280 afs_setpag_val(struct proc *p, void *args, int *retval, int pagval)
 281 #else
 282 afs_setpag_val(int pagval)
 283 #endif
 284 {
 285
 286 #if     defined(AFS_SUN5_ENV)
 287     struct AFS_UCRED **acred = *credp;
 288 #elif  defined(AFS_OBSD_ENV)
 289     struct AFS_UCRED **acred = &p->p_ucred;
 290 #else
 291     struct AFS_UCRED **acred = NULL;
 292 #endif
 293
 294     int code = 0;
 295
 296 #if defined(AFS_SGI53_ENV) && defined(MP)
 297     /* This is our first chance to get the global lock. */
 298     AFS_GLOCK();
 299 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
 300
 301     AFS_STATCNT(afs_setpag);
 302
 303     afs_pag_wait(acred);
 304
 305 #if     defined(AFS_SUN5_ENV)
 306     code = AddPag(pagval, credpp);
 307 #elif   defined(AFS_OSF_ENV) || defined(AFS_XBSD_ENV)
 308     code = AddPag(p, pagval, &p->p_rcred);
 309 #elif   defined(AFS_AIX41_ENV)
 310     {
 311         struct ucred *credp;
 312         struct ucred *credp0;
 313
 314         credp = crref();
 315         credp0 = credp;
 316         code = AddPag(pagval, &credp);
 317         /* If AddPag() didn't make a new cred, then free our cred ref */
 318         if (credp == credp0) {
 319             crfree(credp);
 320         }
 321     }
 322 #elif   defined(AFS_HPUX110_ENV)
 323     {
 324         struct ucred *credp = p_cred(u.u_procp);
 325         code = AddPag(pagval, &credp);
 326     }
 327 #elif   defined(AFS_SGI_ENV)
 328     {
 329         cred_t *credp;
 330         credp = OSI_GET_CURRENT_CRED();
 331         code = AddPag(pagval, &credp);
 332     }
 333 #elif   defined(AFS_LINUX20_ENV)
 334     {
 335         struct AFS_UCRED *credp = crref();
 336         code = AddPag(pagval, &credp);
 337         crfree(credp);
 338     }
 339 #elif defined(AFS_DARWIN_ENV)
 340     {
 341         struct ucred *credp = crdup(p->p_cred->pc_ucred);
 342         code = AddPag(p, pagval, &credp);
 343         crfree(credp);
 344     }
 345 #else
 346     code = AddPag(pagval, &u.u_cred);
 347 #endif
 348
 349     afs_Trace1(afs_iclSetp, CM_TRACE_SETPAG, ICL_TYPE_INT32, code);
 350 #if defined(KERNEL_HAVE_UERROR)
 351     if (!getuerror())
 352         setuerror(code);
 353 #endif
 354 #if defined(AFS_SGI53_ENV) && defined(MP)
 355     AFS_GUNLOCK();
 356 #endif /* defined(AFS_SGI53_ENV) && defined(MP) */
 357     return (code);
 358 }
 359
 360 int
 361 afs_getpag_val()
 362 {
 363     int pagvalue;
 364     struct AFS_UCRED *credp = u.u_cred;
 365     int gidset0, gidset1;
 366
 367     gidset0 = credp->cr_groups[0];
 368     gidset1 = credp->cr_groups[1];
 369     pagvalue = afs_get_pag_from_groups(gidset0, gidset1);
 370     return pagvalue;
 371 }
 372 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
 373
 374
 375 /* Note - needs to be available on AIX, others can be static - rework this */
 376 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 377 int
 378 AddPag(struct proc *p, afs_int32 aval, struct AFS_UCRED **credpp)
 379 #else
 380 int
 381 AddPag(afs_int32 aval, struct AFS_UCRED **credpp)
 382 #endif
 383 {
 384     afs_int32 newpag, code;
 385
 386     AFS_STATCNT(AddPag);
 387 #if defined(AFS_OSF_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 388     if ((code = setpag(p, credpp, aval, &newpag, 0)))
 389 #else
 390     if ((code = setpag(credpp, aval, &newpag, 0)))
 391 #endif
 392 #if defined(KERNEL_HAVE_UERROR)
 393         return (setuerror(code), code);
 394 #else
 395         return (code);
 396 #endif
 397     return 0;
 398 }
 399
 400
 401 int
 402 afs_InitReq(register struct vrequest *av, struct AFS_UCRED *acred)
 403 {
 404     AFS_STATCNT(afs_InitReq);
 405     if (afs_shuttingdown)
 406         return EIO;
 407     av->uid = PagInCred(acred);
 408     if (av->uid == NOPAG) {
 409         /* Afs doesn't use the unix uid for anuthing except a handle
 410          * with which to find the actual authentication tokens so I
 411          * think it's ok to use the real uid to make setuid
 412          * programs (without setpag) to work properly.
 413          */
 414 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 415         if (acred == NOCRED)
 416             av->uid = -2;       /* XXX nobody... ? */
 417         else
 418             av->uid = acred->cr_uid;    /* bsd creds don't have ruid */
 419 #else
 420         av->uid = acred->cr_ruid;       /* default when no pag is set */
 421 #endif
 422     }
 423     av->initd = 0;
 424     return 0;
 425 }
 426
 427
 428
 429 afs_uint32
 430 afs_get_pag_from_groups(gid_t g0a, gid_t g1a)
 431 {
 432     afs_uint32 g0 = g0a;
 433     afs_uint32 g1 = g1a;
 434     afs_uint32 h, l, ret;
 435
 436     AFS_STATCNT(afs_get_pag_from_groups);
 437     g0 -= 0x3f00;
 438     g1 -= 0x3f00;
 439     if (g0 < 0xc000 && g1 < 0xc000) {
 440         l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
 441         h = (g0 >> 14);
 442         h = (g1 >> 14) + h + h + h;
 443         ret = ((h << 28) | l);
 444 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
 445         return ret;
 446 #else
 447         /* Additional testing */
 448         if (((ret >> 24) & 0xff) == 'A')
 449             return ret;
 450         else
 451             return NOPAG;
 452 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
 453     }
 454     return NOPAG;
 455 }
 456
 457
 458 void
 459 afs_get_groups_from_pag(afs_uint32 pag, gid_t * g0p, gid_t * g1p)
 460 {
 461     unsigned short g0, g1;
 462
 463
 464     AFS_STATCNT(afs_get_groups_from_pag);
 465 #if !defined(UKERNEL) || !defined(AFS_WEB_ENHANCEMENTS)
 466     pag &= 0x7fffffff;
 467 #endif /* UKERNEL && AFS_WEB_ENHANCEMENTS */
 468     g0 = 0x3fff & (pag >> 14);
 469     g1 = 0x3fff & pag;
 470     g0 |= ((pag >> 28) / 3) << 14;
 471     g1 |= ((pag >> 28) % 3) << 14;
 472     *g0p = g0 + 0x3f00;
 473     *g1p = g1 + 0x3f00;
 474 }
 475
 476
 477 afs_int32
 478 PagInCred(const struct AFS_UCRED *cred)
 479 {
 480     afs_int32 pag;
 481     gid_t g0, g1;
 482
 483     AFS_STATCNT(PagInCred);
 484     if (cred == NULL) {
 485         return NOPAG;
 486     }
 487 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
 488     if (cred == NOCRED || cred == FSCRED) {
 489         return NOPAG;
 490     }
 491     if (cred->cr_ngroups < 3)
 492         return NOPAG;
 493     /* gid is stored in cr_groups[0] */
 494     g0 = cred->cr_groups[1];
 495     g1 = cred->cr_groups[2];
 496 #else
 497 #if defined(AFS_AIX51_ENV)
 498     if (kcred_getpag(cred, PAG_AFS, &pag) < 0 || pag == 0)
 499         pag = NOPAG;
 500     return pag;
 501 #elif defined(AFS_AIX_ENV)
 502     if (cred->cr_ngrps < 2) {
 503         return NOPAG;
 504     }
 505 #elif defined(AFS_LINUX26_ENV)
 506     if (cred->cr_group_info->ngroups < 2)
 507         return NOPAG;
 508 #elif defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DUX40_ENV) || defined(AFS_LINUX20_ENV) || defined(AFS_XBSD_ENV)
 509     if (cred->cr_ngroups < 2)
 510         return NOPAG;
 511 #endif
 512 #if defined(AFS_AIX51_ENV)
 513     g0 = cred->cr_groupset.gs_union.un_groups[0];
 514     g1 = cred->cr_groupset.gs_union.un_groups[1];
 515 #elif defined(AFS_LINUX26_ENV)
 516     g0 = GROUP_AT(cred->cr_group_info, 0);
 517     g1 = GROUP_AT(cred->cr_group_info, 1);
 518 #else
 519     g0 = cred->cr_groups[0];
 520     g1 = cred->cr_groups[1];
 521 #endif
 522 #endif
 523     pag = (afs_int32) afs_get_pag_from_groups(g0, g1);
 524     return pag;
 525 }