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
10 /* ticket caching code */
12 #include <afsconfig.h>
14 #include "afs/param.h"
16 #include <afs/param.h>
21 #include "afs/sysincludes.h"
22 #include "afsincludes.h"
24 #include "afs/pthread_glock.h"
27 #include "afs/venus.h"
28 #include "afs/pthread_glock.h"
29 #include "afs/dirpath.h"
33 #define min(a,b) ((a)<(b)?(a):(b))
34 #endif /* !defined(min) */
36 #else /* defined(UKERNEL) */
44 #include <afs/pthread_glock.h>
45 #include <sys/types.h>
50 #include <sys/ioctl.h>
51 #include <netinet/in.h>
55 #include <sys/lockf.h>
67 #include <afs/venus.h>
68 #include <afs/afsutil.h>
69 #include <afs/sys_prototypes.h>
71 #endif /* defined(UKERNEL) */
78 /* AFS_KERBEROS_ENV is now conditionally defined in the Makefile */
79 #define AFS_KERBEROS_ENV
82 #ifdef AFS_KERBEROS_ENV
85 #include <afs/cellconfig.h>
86 static char lcell[MAXCELLCHARS];
88 #define TKT_ROOT "/tmp/tkt"
93 /* Definitions for ticket file utilities */
97 /* Error codes returned by ticket file utilities */
98 #define NO_TKT_FIL 76 /* No ticket file found */
99 #define TKT_FIL_ACC 77 /* Couldn't access tkt file */
100 #define TKT_FIL_LCK 78 /* Couldn't lock ticket file */
101 #define TKT_FIL_FMT 79 /* Bad ticket file format */
102 #define TKT_FIL_INI 80 /* afs_tf_init not called first */
104 /* Values returned by get_credentials */
105 #define RET_TKFIL 21 /* Can't read ticket file */
114 #if defined(AFS_AIX_ENV) || defined(AFS_SUN5_ENV)
115 static struct flock fileWlock = { F_WRLCK, 0, 0, 0, 0, 0 };
116 static struct flock fileRlock = { F_RDLCK, 0, 0, 0, 0, 0 };
117 static struct flock fileUlock = { F_UNLCK, 0, 0, 0, 0, 0 };
120 static struct flock fileWlock = { F_WRLCK, 0, 0, 0, 0 };
121 static struct flock fileRlock = { F_RDLCK, 0, 0, 0, 0 };
122 static struct flock fileUlock = { F_UNLCK, 0, 0, 0, 0 };
129 /* the following routines aren't static anymore on behalf of the kerberos IV
130 * compatibility library built in subtree krb.
132 int afs_tf_init(char *, int);
133 int afs_tf_get_pname(char *);
134 int afs_tf_get_pinst(char *);
135 int afs_tf_get_cred(struct ktc_principal *, struct ktc_token *);
136 int afs_tf_save_cred(struct ktc_principal *, struct ktc_token *,
137 struct ktc_principal *);
138 int afs_tf_close(void);
139 int afs_tf_create(char *, char *);
140 int afs_tf_dest_tkt(void);
141 static void ktc_LocalCell(void);
142 #endif /* AFS_KERBEROS_ENV */
145 #define PIOCTL afs_pioctl
146 #elif defined(UKERNEL)
147 #define PIOCTL(A,B,C,D) call_syscall(AFSCALL_PIOCTL,A,B,C,D)
149 #define PIOCTL pioctl
153 #ifdef KERNEL_KTC_COMPAT
156 #define KTC_SYSCALL 32
159 /* Kernel call opcode definitions */
160 #define KTC_OPCODE_BASE 4300
161 #define KTC_NO_OP (0+KTC_OPCODE_BASE)
162 #define KTC_SETTOKEN_OP (1+KTC_OPCODE_BASE)
163 #define KTC_GETTOKEN_OP (2+KTC_OPCODE_BASE)
164 #define KTC_LISTTOKENS_OP (3+KTC_OPCODE_BASE)
165 #define KTC_FORGETTOKEN_OP (4+KTC_OPCODE_BASE)
166 #define KTC_FORGETALLTOKENS_OP (5+KTC_OPCODE_BASE)
167 #define KTC_STATUS_OP (6+KTC_OPCODE_BASE)
168 #define KTC_GC_OP (7+KTC_OPCODE_BASE)
170 #define KTC_INTERFACE_VERSION 3
172 /* We have to determine if the kernel supports the ktc system call. To do so
173 * we attempt to execute its noop function. If this is successful we use the
174 * kernel calls in the future otherwise we let the old code run. */
176 /* To safely check to see whether a system call exists we have to intercept the
177 * SIGSYS signal which is caused by executing a non-existant system call. If
178 * it is ignored the syscall routine returns EINVAL. The SIGSYS is reset to
179 * its old value after the return from syscall. */
181 static int kernelKTC = 0;
183 #ifdef AFS_DECOSF_ENV
185 * SIGSYS semantics are broken on Dec AXP OSF/1 v1.2 systems. You need
186 * to ignore SIGTRAP too. It is claimed to be fixed under v1.3, but...
189 #define CHECK_KERNEL \
190 if (kernelKTC == 0) { \
194 old = (int (*)())signal(SIGSYS, SIG_IGN); \
195 old_t = (int (*)())signal(SIGTRAP, SIG_IGN); \
196 code = syscall (KTC_SYSCALL, KTC_NO_OP, 0,0,0,0,0); \
198 signal(SIGSYS, old); \
199 signal(SIGTRAP, old_t); \
200 if (code == 0) kernelKTC = 1; \
201 else kernelKTC = 2; \
202 /* printf ("returned from KTC_NO_OP kernelKTC <= %d; code=%d, errno=%d\n", kernelKTC, code, errno); */\
205 #else /* AFS_DECOSF_ENV */
207 #define CHECK_KERNEL \
208 if (kernelKTC == 0) { \
211 old = (int (*)())signal(SIGSYS, SIG_IGN); \
212 code = syscall (KTC_SYSCALL, KTC_NO_OP, 0,0,0,0,0); \
214 signal(SIGSYS, old); \
215 if (code == 0) kernelKTC = 1; \
216 else kernelKTC = 2; \
217 /* printf ("returned from KTC_NO_OP kernelKTC <= %d; code=%d, errno=%d\n", kernelKTC, code, errno); */\
219 #endif /* AFS_DECOSF_ENV */
221 #define TRY_KERNEL(cmd,a1,a2,a3,a4) \
223 if (kernelKTC == 1) \
224 return syscall (KTC_SYSCALL, cmd, \
225 KTC_INTERFACE_VERSION, a1,a2,a3,a4); \
229 #define TRY_KERNEL(cmd,a1,a2,a3,a4)
230 #endif /* KERNEL_KTC_COMPAT */
232 #if !defined(UKERNEL)
233 /* this is a structure used to communicate with the afs cache mgr, but is
234 * otherwise irrelevant */
236 afs_int32 AuthHandle;
237 char HandShakeKey[8];
239 afs_int32 BeginTimestamp;
240 afs_int32 EndTimestamp;
242 #endif /* !defined(UKERNEL) */
244 #define MAXLOCALTOKENS 4
248 struct ktc_principal server;
249 struct ktc_principal client;
250 struct ktc_token token;
251 } local_tokens[MAXLOCALTOKENS] = { {
257 /* new interface routines to the ticket cache. Only handle afs service right
261 NewSetToken(struct ktc_principal *aserver,
262 struct ktc_token *atoken,
263 struct ktc_principal *aclient,
266 TRY_KERNEL(KTC_SETTOKEN_OP, aserver, aclient, atoken,
267 sizeof(struct ktc_token));
268 /* no kernel ticket cache */
272 #define MAXPIOCTLTOKENLEN \
273 (3*sizeof(afs_int32)+MAXKTCTICKETLEN+sizeof(struct ClearToken)+MAXKTCREALMLEN)
276 OldSetToken(struct ktc_principal *aserver, struct ktc_token *atoken,
277 struct ktc_principal *aclient, afs_int32 flags)
279 struct ViceIoctl iob;
280 char tbuffer[MAXPIOCTLTOKENLEN];
282 struct ClearToken ct;
283 register afs_int32 code;
286 if (strcmp(aserver->name, "afs") != 0) {
289 for (i = 0; i < MAXLOCALTOKENS; i++)
290 if (local_tokens[i].valid) {
291 if ((strcmp(local_tokens[i].server.name, aserver->name) == 0)
294 (local_tokens[i].server.instance,
295 aserver->instance) == 0)
296 && (strcmp(local_tokens[i].server.cell, aserver->cell) ==
298 found = i; /* replace existing entry */
300 } else /* valid, but no match */
303 found = i; /* remember this empty slot */
306 memcpy(&local_tokens[found].token, atoken, sizeof(struct ktc_token));
307 local_tokens[found].server = *aserver;
308 local_tokens[found].client = *aclient;
309 local_tokens[found].valid = 1;
312 tp = tbuffer; /* start copying here */
313 if ((atoken->ticketLen < MINKTCTICKETLEN)
314 || (atoken->ticketLen > MAXKTCTICKETLEN))
316 memcpy(tp, &atoken->ticketLen, sizeof(afs_int32)); /* copy in ticket length */
317 tp += sizeof(afs_int32);
318 memcpy(tp, atoken->ticket, atoken->ticketLen); /* copy in ticket */
319 tp += atoken->ticketLen;
320 /* next, copy in the "clear token", describing who we are */
321 ct.AuthHandle = atoken->kvno; /* hide auth handle here */
322 memcpy(ct.HandShakeKey, &atoken->sessionKey, 8);
324 ct.BeginTimestamp = atoken->startTime;
325 ct.EndTimestamp = atoken->endTime;
326 if (ct.BeginTimestamp == 0)
327 ct.BeginTimestamp = 1;
329 if ((strlen(aclient->name) > strlen("AFS ID "))
330 && (aclient->instance[0] == 0)) {
332 afs_int32 viceId = 0;
333 char *cp = aclient->name + strlen("AFS ID ");
340 viceId = viceId * 10 + (int)(*cp - '0');
345 ct.ViceId = viceId * sign; /* OK to let any value here? */
346 if (((ct.EndTimestamp - ct.BeginTimestamp) & 1) == 0)
347 ct.BeginTimestamp++; /* force lifetime to be odd */
350 ct.ViceId = getuid(); /* wrong, but works in primary cell */
351 if (((ct.EndTimestamp - ct.BeginTimestamp) & 1) == 1)
352 ct.BeginTimestamp++; /* force lifetime to be even */
357 * Information needed by the user space cache manager
359 u.u_expiration = ct.EndTimestamp;
360 u.u_viceid = ct.ViceId;
363 temp = sizeof(struct ClearToken);
364 memcpy(tp, &temp, sizeof(afs_int32));
365 tp += sizeof(afs_int32);
366 memcpy(tp, &ct, sizeof(struct ClearToken));
367 tp += sizeof(struct ClearToken);
369 /* next copy in primary flag */
373 * The following means that setpag will happen inside afs just before
374 * the authentication to prevent the setpag/klog race condition.
376 * The following means that setpag will affect the parent process as
377 * well as the current process.
379 if (flags & AFS_SETTOK_SETPAG)
382 memcpy(tp, &temp, sizeof(afs_int32));
383 tp += sizeof(afs_int32);
385 /* finally copy in the cell name */
386 temp = strlen(aserver->cell);
387 if (temp >= MAXKTCREALMLEN)
389 strcpy(tp, aserver->cell);
392 /* now setup for the pioctl */
394 iob.in_size = tp - tbuffer;
396 iob.out_size = sizeof(tbuffer);
398 #if defined(NO_AFS_CLIENT)
402 if ((tkfile = getenv("TKTFILE"))
405 open(tkfile, O_WRONLY | O_APPEND | O_TRUNC | O_CREAT,
407 printf("Writing ticket to: %s\n", tkfile);
408 code = (write(fd, iob.in, iob.in_size) != iob.in_size);
411 code = KTC_PIOCTLFAIL;
413 #else /* NO_AFS_CLIENT */
414 code = PIOCTL(0, VIOCSETTOK, &iob, 0);
415 #endif /* NO_AFS_CLIENT */
417 return KTC_PIOCTLFAIL;
422 ktc_SetToken(struct ktc_principal *aserver,
423 struct ktc_token *atoken,
424 struct ktc_principal *aclient,
430 #ifdef AFS_KERBEROS_ENV
434 if ( /*!strcmp(aclient->cell, lcell) && this would only store local creds */
435 (strcmp(aserver->name, "AuthServer")
436 || strcmp(aserver->instance, "Admin"))) {
437 if (strcmp(aserver->name, "krbtgt") == 0) {
438 static char lrealm[MAXKTCREALMLEN];
441 ucstring(lrealm, lcell, MAXKTCREALMLEN);
442 if (strcmp(aserver->instance, lrealm) == 0) {
443 afs_tf_create(aclient->name, aclient->instance);
447 ncode = afs_tf_init(ktc_tkt_string(), W_TKT_FIL);
448 if (ncode == NO_TKT_FIL) {
449 (void)afs_tf_create(aclient->name, aclient->instance);
450 ncode = afs_tf_init(ktc_tkt_string(), W_TKT_FIL);
454 afs_tf_save_cred(aserver, atoken, aclient);
460 #endif /* NO_AFS_CLIENT */
464 #ifndef NO_AFS_CLIENT
465 ncode = NewSetToken(aserver, atoken, aclient, flags);
466 if (ncode || /* new style failed */
467 (strcmp(aserver->name, "afs") == 0)) { /* for afs tokens do both */
468 ocode = OldSetToken(aserver, atoken, aclient, flags);
471 if (ncode && ocode) {
475 else if (ocode == KTC_PIOCTLFAIL)
483 return KTC_PIOCTLFAIL;
485 #endif /* NO_AFS_CLIENT */
490 /* get token, given server we need and token buffer. aclient will eventually
491 * be set to our identity to the server.
494 ktc_GetToken(struct ktc_principal *aserver, struct ktc_token *atoken,
495 int atokenLen, struct ktc_principal *aclient)
497 struct ViceIoctl iob;
498 char tbuffer[MAXPIOCTLTOKENLEN];
499 register afs_int32 code = 0;
501 char *stp, *cellp; /* secret token ptr */
502 struct ClearToken ct;
505 int maxLen; /* biggest ticket we can copy */
506 int tktLen; /* server ticket length */
507 #ifdef AFS_KERBEROS_ENV
512 #ifndef NO_AFS_CLIENT
513 TRY_KERNEL(KTC_GETTOKEN_OP, aserver, aclient, atoken, atokenLen);
514 #endif /* NO_AFS_CLIENT */
516 #ifdef AFS_KERBEROS_ENV
520 #ifndef NO_AFS_CLIENT
521 if (strcmp(aserver->name, "afs") != 0)
522 #endif /* NO_AFS_CLIENT */
525 /* try the local tokens */
526 for (i = 0; i < MAXLOCALTOKENS; i++)
527 if (local_tokens[i].valid
528 && (strcmp(local_tokens[i].server.name, aserver->name) == 0)
529 && (strcmp(local_tokens[i].server.instance, aserver->instance)
531 && (strcmp(local_tokens[i].server.cell, aserver->cell) == 0)) {
532 memcpy(atoken, &local_tokens[i].token,
533 min(atokenLen, sizeof(struct ktc_token)));
535 *aclient = local_tokens[i].client;
539 #ifdef AFS_KERBEROS_ENV
540 if (!afs_tf_init(ktc_tkt_string(), R_TKT_FIL)) {
542 if (!afs_tf_get_pname(aclient->name)
543 && !afs_tf_get_pinst(aclient->instance))
546 char tmpstring[MAXHOSTCHARS];
547 afs_tf_get_pname(tmpstring);
548 afs_tf_get_pinst(tmpstring);
553 struct ktc_principal cprincipal;
554 struct ktc_token ctoken;
556 while (!afs_tf_get_cred(&cprincipal, &ctoken)) {
557 if (strcmp(cprincipal.name, aserver->name) == 0
558 && strcmp(cprincipal.instance, aserver->instance) == 0
559 && strcmp(cprincipal.cell, aserver->cell) == 0) {
562 strcpy(aclient->cell, lcell);
563 memcpy(atoken, &ctoken,
564 min(atokenLen, sizeof(struct ktc_token)));
577 #ifndef NO_AFS_CLIENT
578 for (index = 0; index < 200; index++) { /* sanity check in case pioctl fails */
579 iob.in = (char *)&index;
580 iob.in_size = sizeof(afs_int32);
582 iob.out_size = sizeof(tbuffer);
584 code = PIOCTL(0, VIOCGETTOK, &iob, 0);
587 /* failed to retrieve specified token */
588 if (code < 0 && errno == EDOM) {
593 /* token retrieved; parse buffer */
596 /* get ticket length */
597 memcpy(&temp, tp, sizeof(afs_int32));
599 tp += sizeof(afs_int32);
601 /* remember where ticket is and skip over it */
605 /* get size of clear token and verify */
606 memcpy(&temp, tp, sizeof(afs_int32));
607 if (temp != sizeof(struct ClearToken)) {
611 tp += sizeof(afs_int32);
613 /* copy clear token */
614 memcpy(&ct, tp, temp);
617 /* skip over primary flag */
618 tp += sizeof(afs_int32);
620 /* remember where cell name is */
623 if ((strcmp(cellp, aserver->cell) == 0)
624 #ifdef AFS_KERBEROS_ENV
625 || (*aserver->cell == '\0' && strcmp(cellp, lcell) == 0)
628 /* got token for cell; check that it will fit */
630 atokenLen - sizeof(struct ktc_token) + MAXKTCTICKETLEN;
631 if (maxLen < tktLen) {
636 /* set return values */
637 memcpy(atoken->ticket, stp, tktLen);
638 atoken->startTime = ct.BeginTimestamp;
639 atoken->endTime = ct.EndTimestamp;
640 if (ct.AuthHandle == -1) {
643 atoken->kvno = ct.AuthHandle;
644 memcpy(&atoken->sessionKey, ct.HandShakeKey,
645 sizeof(struct ktc_encryptionKey));
646 atoken->ticketLen = tktLen;
649 strcpy(aclient->cell, cellp);
650 aclient->instance[0] = 0;
652 if ((atoken->kvno == 999) || /* old style bcrypt ticket */
653 (ct.BeginTimestamp && /* new w/ prserver lookup */
654 (((ct.EndTimestamp - ct.BeginTimestamp) & 1) == 1))) {
655 sprintf(aclient->name, "AFS ID %d", ct.ViceId);
657 sprintf(aclient->name, "Unix UID %d", ct.ViceId);
665 #endif /* NO_AFS_CLIENT */
668 if ((code < 0) && (errno == EINVAL))
670 return KTC_PIOCTLFAIL; /* probable cause */
674 * Forget tokens for this server and the calling user.
675 * NOT IMPLEMENTED YET!
677 #ifndef NO_AFS_CLIENT
679 ktc_ForgetToken(struct ktc_principal *aserver)
684 TRY_KERNEL(KTC_FORGETTOKEN_OP, aserver, 0, 0, 0);
686 rc = ktc_ForgetAllTokens(); /* bogus, but better */
690 #endif /* NO_AFS_CLIENT */
692 /* ktc_ListTokens - list all tokens. start aprevIndex at 0, it returns the
693 * next rock in (*aindex). (*aserver) is set to the relevant ticket on
697 ktc_ListTokens(int aprevIndex,
699 struct ktc_principal *aserver)
701 struct ViceIoctl iob;
702 char tbuffer[MAXPIOCTLTOKENLEN];
703 register afs_int32 code = 0 ;
705 afs_int32 temp, index;
707 memset(tbuffer, 0, sizeof(tbuffer));
710 #ifndef NO_AFS_CLIENT
711 TRY_KERNEL(KTC_LISTTOKENS_OP, aserver, aprevIndex, aindex, 0);
712 #endif /* NO_AFS_CLIENT */
718 #endif /* NO_AFS_CLIENT */
719 #ifdef AFS_KERBEROS_ENV
722 struct ktc_principal cprincipal;
723 struct ktc_token ctoken;
725 if (afs_tf_init(ktc_tkt_string(), R_TKT_FIL)
726 || afs_tf_get_pname(tbuffer) || afs_tf_get_pinst(tbuffer)) {
732 for (i = 214; i < index; i++) {
733 if (afs_tf_get_cred(&cprincipal, &ctoken)) {
741 if (afs_tf_get_cred(&cprincipal, &ctoken)) {
748 #ifndef NO_AFS_CLIENT
749 if (!strcmp(cprincipal.name, "afs") && cprincipal.instance[0] == 0) {
752 #endif /* NO_AFS_CLIENT */
754 for (i = 0; i < MAXLOCALTOKENS; i++) {
755 if (!strcmp(cprincipal.name, local_tokens[i].server.name)
756 && !strcmp(cprincipal.instance,
757 local_tokens[i].server.instance)
758 && !strcmp(cprincipal.cell, local_tokens[i].server.cell)) {
763 *aserver = cprincipal;
771 #ifndef NO_AFS_CLIENT
772 if (index >= 123) { /* special hack for returning TCS */
773 while (index - 123 < MAXLOCALTOKENS) {
774 if (local_tokens[index - 123].valid) {
775 *aserver = local_tokens[index - 123].server;
783 #ifdef AFS_KERBEROS_ENV
784 return ktc_ListTokens(214, aindex, aserver);
790 /* get tokens from the kernel */
791 while (index < 200) { /* sanity check in case pioctl fails */
792 iob.in = (char *)&index;
793 iob.in_size = sizeof(afs_int32);
795 iob.out_size = sizeof(tbuffer);
796 code = PIOCTL(0, VIOCGETTOK, &iob, 0);
797 if (code < 0 && errno == EDOM) {
800 rc = ktc_ListTokens(123, aindex, aserver);
809 break; /* got a ticket */
810 /* otherwise we should skip this ticket slot */
817 return KTC_PIOCTLFAIL;
823 /* next iterator determined by earlier loop */
826 memcpy(&temp, tp, sizeof(afs_int32)); /* get size of secret token */
827 tp += sizeof(afs_int32);
828 tp += temp; /* skip ticket for now */
829 memcpy(&temp, tp, sizeof(afs_int32)); /* get size of clear token */
830 if (temp != sizeof(struct ClearToken)) {
834 tp += sizeof(afs_int32); /* skip length */
835 tp += temp; /* skip clear token itself */
836 tp += sizeof(afs_int32); /* skip primary flag */
837 /* tp now points to the cell name */
838 strcpy(aserver->cell, tp);
839 aserver->instance[0] = 0;
840 strcpy(aserver->name, "afs");
841 #endif /* NO_AFS_CLIENT */
846 /* discard all tokens from this user's cache */
851 #ifndef NO_AFS_CLIENT
852 TRY_KERNEL(KTC_FORGETALLTOKENS_OP, 0, 0, 0, 0);
853 #endif /* NO_AFS_CLIENT */
860 struct ViceIoctl iob;
861 register afs_int32 code;
864 for (i = 0; i < MAXLOCALTOKENS; i++)
865 local_tokens[i].valid = 0;
871 #ifndef NO_AFS_CLIENT
872 code = PIOCTL(0, VIOCUNPAG, &iob, 0);
874 return KTC_PIOCTLFAIL;
875 #endif /* NO_AFS_CLIENT */
880 ktc_ForgetAllTokens(void)
885 #ifdef AFS_KERBEROS_ENV
886 (void)afs_tf_dest_tkt();
889 ncode = NewForgetAll();
890 ocode = OldForgetAll();
891 if (ncode && ocode) {
894 else if (ocode == KTC_PIOCTLFAIL)
899 return KTC_PIOCTLFAIL;
905 /* ktc_OldPioctl - returns a boolean true if the kernel supports only the old
906 * pioctl interface for delivering AFS tickets to the cache manager. */
913 #ifdef KERNEL_KTC_COMPAT
915 rc = (kernelKTC != 1); /* old style interface */
927 struct ViceIoctl iob;
930 /* now setup for the pioctl */
934 iob.out_size = sizeof(afs_int32);
936 code = PIOCTL(0, VIOC_GETPAG, &iob, 0);
938 #if defined(AFS_AIX52_ENV)
939 code = getpagvalue("afs");
940 if (code < 0 && errno == EINVAL)
943 #elif defined(AFS_AIX51_ENV)
946 gid_t groups[NGROUPS_MAX];
948 afs_uint32 h, l, ret;
950 if (getgroups(sizeof groups / sizeof groups[0], groups) < 2)
953 g0 = groups[0] & 0xffff;
954 g1 = groups[1] & 0xffff;
957 if (g0 < 0xc000 && g1 < 0xc000) {
958 l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
960 h = (g1 >> 14) + h + h + h;
961 ret = ((h << 28) | l);
962 /* Additional testing */
963 if (((ret >> 24) & 0xff) == 'A')
975 #ifdef AFS_KERBEROS_ENV
977 * Copyright 1987, 1988 by the Massachusetts Institute of Technology.
979 * For copying and distribution information, please see the file
986 #include <sys/types.h>
987 #include <sys/stat.h>
988 #include <sys/file.h>
993 #define TF_LCK_RETRY ((unsigned)2) /* seconds to sleep before
994 * retry if ticket file is
998 * fd must be initialized to something that won't ever occur as a real
999 * file descriptor. Since open(2) returns only non-negative numbers as
1000 * valid file descriptors, and afs_tf_init always stuffs the return value
1001 * from open in here even if it is an error flag, we must
1002 * a. Initialize fd to a negative number, to indicate that it is
1003 * not initially valid.
1004 * b. When checking for a valid fd, assume that negative values
1005 * are invalid (ie. when deciding whether afs_tf_init has been
1007 * c. In tf_close, be sure it gets reinitialized to a negative
1011 static int curpos; /* Position in tfbfr */
1012 static int lastpos; /* End of tfbfr */
1013 static char tfbfr[BUFSIZ]; /* Buffer for ticket data */
1015 static int tf_gets(char *, int);
1016 static int tf_read(char *, int);
1019 * This file contains routines for manipulating the ticket cache file.
1021 * The ticket file is in the following format:
1023 * principal's name (null-terminated string)
1024 * principal's instance (null-terminated string)
1031 * Where "CREDENTIAL_x" consists of the following fixed-length
1032 * fields from the CREDENTIALS structure (see "krb.h"):
1034 * char service[MAXKTCNAMELEN]
1035 * char instance[MAXKTCNAMELEN]
1036 * char realm[REALM_SZ]
1040 * KTEXT_ST ticket_st
1041 * afs_int32 issue_date
1043 * Short description of routines:
1045 * afs_tf_init() opens the ticket file and locks it.
1047 * afs_tf_get_pname() returns the principal's name.
1049 * afs_tf_get_pinst() returns the principal's instance (may be null).
1051 * afs_tf_get_cred() returns the next CREDENTIALS record.
1053 * afs_tf_save_cred() appends a new CREDENTIAL record to the ticket file.
1055 * afs_tf_close() closes the ticket file and releases the lock.
1057 * tf_gets() returns the next null-terminated string. It's an internal
1058 * routine used by afs_tf_get_pname(), afs_tf_get_pinst(), and
1059 * afs_tf_get_cred().
1061 * tf_read() reads a given number of bytes. It's an internal routine
1062 * used by afs_tf_get_cred().
1066 * afs_tf_init() should be called before the other ticket file routines.
1067 * It takes the name of the ticket file to use, "tf_name", and a
1068 * read/write flag "rw" as arguments.
1070 * It tries to open the ticket file, checks the mode, and if everything
1071 * is okay, locks the file. If it's opened for reading, the lock is
1072 * shared. If it's opened for writing, the lock is exclusive.
1074 * Returns 0 if all went well, otherwise one of the following:
1076 * NO_TKT_FIL - file wasn't there
1077 * TKT_FIL_ACC - file was in wrong mode, etc.
1078 * TKT_FIL_LCK - couldn't lock the file, even after a retry
1082 afs_tf_init(char *tf_name, int rw)
1086 struct stat stat_buf;
1098 if (lstat(tf_name, &stat_buf) < 0)
1106 if ((stat_buf.st_uid != me && me != 0)
1107 || ((stat_buf.st_mode & S_IFMT) != S_IFREG))
1111 * If "wflag" is set, open the ticket file in append-writeonly mode
1112 * and lock the ticket file in exclusive mode. If unable to lock
1113 * the file, sleep and try again. If we fail again, return with the
1114 * proper error message.
1117 curpos = sizeof(tfbfr);
1120 fd = open(tf_name, O_RDWR, 0600);
1124 #if defined(AFS_AIX_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_SUN5_ENV)
1125 if (fcntl(fd, F_SETLK, &fileWlock) == -1) {
1126 sleep(TF_LCK_RETRY);
1127 if (fcntl(fd, F_SETLK, &fileWlock) == -1) {
1129 if (flock(fd, LOCK_EX | LOCK_NB) < 0) {
1130 sleep(TF_LCK_RETRY);
1131 if (flock(fd, LOCK_EX | LOCK_NB) < 0) {
1141 * Otherwise "wflag" is not set and the ticket file should be opened
1142 * for read-only operations and locked for shared access.
1145 fd = open(tf_name, O_RDONLY, 0600);
1149 #if defined(AFS_AIX_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_SUN5_ENV)
1150 if (fcntl(fd, F_SETLK, &fileRlock) == -1) {
1151 sleep(TF_LCK_RETRY);
1152 if (fcntl(fd, F_SETLK, &fileRlock) == -1) {
1154 if (flock(fd, LOCK_SH | LOCK_NB) < 0) {
1155 sleep(TF_LCK_RETRY);
1156 if (flock(fd, LOCK_SH | LOCK_NB) < 0) {
1167 * afs_tf_get_pname() reads the principal's name from the ticket file. It
1168 * should only be called after afs_tf_init() has been called. The
1169 * principal's name is filled into the "p" parameter. If all goes well,
1170 * 0 is returned. If afs_tf_init() wasn't called, TKT_FIL_INI is
1171 * returned. If the name was null, or EOF was encountered, or the name
1172 * was longer than MAXKTCNAMELEN, TKT_FIL_FMT is returned.
1176 afs_tf_get_pname(char *p)
1181 if (tf_gets(p, MAXKTCNAMELEN) < 2) /* can't be just a null */
1187 * afs_tf_get_pinst() reads the principal's instance from a ticket file.
1188 * It should only be called after afs_tf_init() and afs_tf_get_pname() have
1189 * been called. The instance is filled into the "inst" parameter. If all
1190 * goes well, 0 is returned. If afs_tf_init() wasn't called,
1191 * TKT_FIL_INI is returned. If EOF was encountered, or the instance
1192 * was longer than MAXKTCNAMELEN, TKT_FIL_FMT is returned. Note that the
1193 * instance may be null.
1197 afs_tf_get_pinst(char *inst)
1202 if (tf_gets(inst, MAXKTCNAMELEN) < 1)
1208 * afs_tf_get_cred() reads a CREDENTIALS record from a ticket file and fills
1209 * in the given structure "c". It should only be called after afs_tf_init(),
1210 * afs_tf_get_pname(), and afs_tf_get_pinst() have been called. If all goes
1211 * well, 0 is returned. Possible error codes are:
1213 * TKT_FIL_INI - afs_tf_init wasn't called first
1214 * TKT_FIL_FMT - bad format
1215 * EOF - end of file encountered
1219 afs_tf_get_cred(struct ktc_principal *principal, struct ktc_token *token)
1223 long mit_compat; /* MIT Kerberos 5 with Krb4 uses a "long" for issue_date */
1228 if ((k_errno = tf_gets(principal->name, MAXKTCNAMELEN)) < 2)
1231 case 1: /* can't be just a null */
1236 if ((k_errno = tf_gets(principal->instance, MAXKTCNAMELEN)) < 1)
1243 if ((k_errno = tf_gets(principal->cell, MAXKTCREALMLEN)) < 2)
1246 case 1: /* can't be just a null */
1251 lcstring(principal->cell, principal->cell, MAXKTCREALMLEN);
1252 if (tf_read((char *)&(token->sessionKey), 8) < 1
1253 || tf_read((char *)&(lifetime), sizeof(lifetime)) < 1
1254 || tf_read((char *)&(kvno), sizeof(kvno)) < 1
1255 || tf_read((char *)&(token->ticketLen), sizeof(token->ticketLen))
1257 /* don't try to read a silly amount into ticket->dat */
1258 token->ticketLen > MAXKTCTICKETLEN
1259 || tf_read((char *)(token->ticket), token->ticketLen) < 1
1260 || tf_read((char *)&mit_compat, sizeof(mit_compat)) < 1) {
1263 token->startTime = mit_compat;
1264 token->endTime = life_to_time(token->startTime, lifetime);
1270 * tf_close() closes the ticket file and sets "fd" to -1. If "fd" is
1271 * not a valid file descriptor, it just returns. It also clears the
1272 * buffer used to read tickets.
1274 * The return value is not defined.
1281 #if defined(AFS_AIX_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_SUN5_ENV)
1282 (void)fcntl(fd, F_SETLK, &fileUlock);
1284 (void)flock(fd, LOCK_UN);
1287 fd = -1; /* see declaration of fd above */
1289 memset(tfbfr, 0, sizeof(tfbfr));
1294 * tf_gets() is an internal routine. It takes a string "s" and a count
1295 * "n", and reads from the file until either it has read "n" characters,
1296 * or until it reads a null byte. When finished, what has been read exists
1299 * Possible return values are:
1301 * n the number of bytes read (including null terminator)
1302 * when all goes well
1304 * 0 end of file or read error
1306 * TOO_BIG if "count" characters are read and no null is
1307 * encountered. This is an indication that the ticket
1308 * file is seriously ill.
1312 tf_gets(register char *s, int n)
1319 for (count = n - 1; count > 0; --count) {
1320 if (curpos >= sizeof(tfbfr)) {
1321 lastpos = read(fd, tfbfr, sizeof(tfbfr));
1324 if (curpos == lastpos) {
1327 *s = tfbfr[curpos++];
1335 * tf_read() is an internal routine. It takes a string "s" and a count
1336 * "n", and reads from the file until "n" bytes have been read. When
1337 * finished, what has been read exists in "s".
1339 * Possible return values are:
1341 * n the number of bytes read when all goes well
1343 * 0 on end of file or read error
1347 tf_read(register char *s, register int n)
1351 for (count = n; count > 0; --count) {
1352 if (curpos >= sizeof(tfbfr)) {
1353 lastpos = read(fd, tfbfr, sizeof(tfbfr));
1356 if (curpos == lastpos) {
1359 *s++ = tfbfr[curpos++];
1365 * afs_tf_save_cred() appends an incoming ticket to the end of the ticket
1366 * file. You must call afs_tf_init() before calling afs_tf_save_cred().
1368 * The "service", "instance", and "realm" arguments specify the
1369 * server's name; "aticket" contains the credential.
1371 * Returns 0 if all goes well, TKT_FIL_INI if afs_tf_init() wasn't
1372 * called previously, and KFAILURE for anything else that went wrong.
1376 afs_tf_save_cred(struct ktc_principal *aserver,
1377 struct ktc_token *atoken,
1378 struct ktc_principal *aclient)
1380 char realm[MAXKTCREALMLEN + 1];
1381 char junk[MAXKTCNAMELEN];
1382 struct ktc_principal principal;
1383 struct ktc_token token;
1387 int count; /* count for write */
1388 long mit_compat; /* MIT Kerberos 5 with Krb4 uses a "long" for issue_date */
1390 if (fd < 0) { /* fd is ticket file as set by afs_tf_init */
1394 ucstring(realm, aserver->cell, MAXKTCREALMLEN);
1395 realm[MAXKTCREALMLEN] = '\0';
1397 /* Look for a duplicate ticket */
1398 (void)lseek(fd, (off_t) 0L, 0);
1399 curpos = sizeof(tfbfr);
1401 if (afs_tf_get_pname(junk) || strcmp(junk, aclient->name)
1402 || afs_tf_get_pinst(junk) || strcmp(junk, aclient->instance))
1406 start = lseek(fd, (off_t) 0L, 1) - lastpos + curpos;
1407 status = afs_tf_get_cred(&principal, &token);
1408 } while (status == 0
1409 && (strcmp(aserver->name, principal.name) != 0
1410 || strcmp(aserver->instance, principal.instance) != 0
1411 || strcmp(aserver->cell, principal.cell) != 0));
1414 * Two tickets for the same user authenticating to the same service
1415 * should be the same length, but we check here just to make sure.
1417 if (status == 0 && token.ticketLen != atoken->ticketLen)
1419 if (status && status != EOF)
1422 /* Position over the credential we just matched (or the EOF) */
1423 lseek(fd, start, 0);
1424 curpos = lastpos = sizeof(tfbfr);
1426 /* Write the ticket and associated data */
1428 count = strlen(aserver->name) + 1;
1429 if (write(fd, aserver->name, count) != count)
1432 count = strlen(aserver->instance) + 1;
1433 if (write(fd, aserver->instance, count) != count)
1436 count = strlen(realm) + 1;
1437 if (write(fd, realm, count) != count)
1440 if (write(fd, (char *)&atoken->sessionKey, 8) != 8)
1443 lifetime = time_to_life(atoken->startTime, atoken->endTime);
1444 if (write(fd, (char *)&lifetime, sizeof(int)) != sizeof(int))
1447 kvno = atoken->kvno;
1448 if (write(fd, (char *)&kvno, sizeof(int)) != sizeof(int))
1451 if (write(fd, (char *)&(atoken->ticketLen), sizeof(int)) != sizeof(int))
1454 count = atoken->ticketLen;
1455 if (write(fd, atoken->ticket, count) != count)
1458 mit_compat = atoken->startTime;
1459 if (write(fd, (char *)&mit_compat, sizeof(mit_compat))
1460 != sizeof(mit_compat))
1463 /* Actually, we should check each write for success */
1470 * Copyright 1985, 1986, 1987, 1988 by the Massachusetts Institute
1473 * For copying and distribution information, please see the file
1474 * <mit-copyright.h>.
1478 * This routine is used to generate the name of the file that holds
1479 * the user's cache of server tickets and associated session keys.
1481 * If it is set, krb_ticket_string contains the ticket file name.
1482 * Otherwise, the filename is constructed as follows:
1484 * If it is set, the environment variable "KRBTKFILE" will be used as
1485 * the ticket file name. Otherwise TKT_ROOT (defined in "krb.h") and
1486 * the user's uid are concatenated to produce the ticket file name
1487 * (e.g., "/tmp/tkt123"). A pointer to the string containing the ticket
1488 * file name is returned.
1491 static char krb_ticket_string[4096] = "";
1494 ktc_tkt_string(void)
1496 return ktc_tkt_string_uid(getuid());
1500 ktc_tkt_string_uid(afs_uint32 uid)
1505 if (!*krb_ticket_string) {
1506 if ((env = getenv("KRBTKFILE"))) {
1507 (void)strncpy(krb_ticket_string, env,
1508 sizeof(krb_ticket_string) - 1);
1509 krb_ticket_string[sizeof(krb_ticket_string) - 1] = '\0';
1511 /* 32 bits of signed integer will always fit in 11 characters
1512 * (including the sign), so no need to worry about overflow */
1513 (void)sprintf(krb_ticket_string, "%s%d", TKT_ROOT, uid);
1516 UNLOCK_GLOBAL_MUTEX;
1517 return krb_ticket_string;
1521 * This routine is used to set the name of the file that holds the user's
1522 * cache of server tickets and associated session keys.
1524 * The value passed in is copied into local storage.
1526 * NOTE: This routine should be called during initialization, before other
1527 * Kerberos routines are called; otherwise tkt_string() above may be called
1528 * and return an undesired ticket file name until this routine is called.
1532 ktc_set_tkt_string(char * val)
1536 (void)strncpy(krb_ticket_string, val, sizeof(krb_ticket_string) - 1);
1537 krb_ticket_string[sizeof(krb_ticket_string) - 1] = '\0';
1538 UNLOCK_GLOBAL_MUTEX;
1543 * tf_create() is used to initialize the ticket store. It creates the
1544 * file to contain the tickets and writes the given user's name "pname"
1545 * and instance "pinst" in the file. in_tkt() returns KSUCCESS on
1546 * success, or KFAILURE if something goes wrong.
1550 afs_tf_create(char *pname, char *pinst)
1555 char *file = ktc_tkt_string();
1564 if (lstat(file, &sbuf) == 0) {
1565 if ((sbuf.st_uid != me && me != 0)
1566 || ((sbuf.st_mode & S_IFMT) != S_IFREG) || sbuf.st_mode & 077) {
1569 /* file already exists, and permissions appear ok, so nuke it */
1570 if ((fd = open(file, O_RDWR, 0)) < 0)
1571 goto out; /* can't zero it, but we can still try truncating it */
1573 memset(zerobuf, 0, sizeof(zerobuf));
1575 for (i = 0; i < sbuf.st_size; i += sizeof(zerobuf))
1576 if (write(fd, zerobuf, sizeof(zerobuf)) != sizeof(zerobuf)) {
1587 /* arrange so the file is owned by the ruid
1588 * (swap real & effective uid if necessary).
1589 * This isn't a security problem, since the ticket file, if it already
1590 * exists, has the right uid (== ruid) and mode. */
1592 if (setreuid(metoo, me) < 0) {
1596 tktfile = creat(file, 0600);
1598 if (setreuid(me, metoo) < 0) {
1599 /* can't switch??? fail! */
1606 count = strlen(pname) + 1;
1607 if (write(tktfile, pname, count) != count) {
1608 (void)close(tktfile);
1611 count = strlen(pinst) + 1;
1612 if (write(tktfile, pinst, count) != count) {
1613 (void)close(tktfile);
1616 (void)close(tktfile);
1621 * dest_tkt() is used to destroy the ticket store upon logout.
1622 * If the ticket file does not exist, dest_tkt() returns RET_TKFIL.
1623 * Otherwise the function returns 0 on success, KFAILURE on
1628 afs_tf_dest_tkt(void)
1630 char *file = ktc_tkt_string();
1636 if (lstat(file, &statb) < 0)
1639 if (!(statb.st_mode & S_IFREG))
1642 if ((fd = open(file, O_RDWR, 0)) < 0)
1645 memset(buf, 0, BUFSIZ);
1647 for (i = 0; i < statb.st_size; i += BUFSIZ)
1648 if (write(fd, buf, BUFSIZ) != BUFSIZ) {
1660 if (errno == ENOENT)
1662 else if (errno != 0)
1670 extern char **environ;
1674 char fname[256], *prefix = "/ticket/";
1675 char fname5[256], *prefix5 = "FILE:/ticket/krb5cc_";
1677 char **newenv, **senv, **denv;
1680 if (stat("/ticket", &sbuf) == -1) {
1681 prefix = "/tmp/tkt";
1682 prefix5 = "FILE:/tmp/krb5cc_";
1685 pag = ktc_curpag() & 0xffffffff;
1687 sprintf(fname, "%s%d", prefix, getuid());
1688 sprintf(fname5, "%s%d", prefix5, getuid());
1690 sprintf(fname, "%sp%lu", prefix, afs_printable_uint32_lu(pag));
1691 sprintf(fname5, "%sp%lud", prefix5, afs_printable_uint32_lu(pag));
1693 ktc_set_tkt_string(fname);
1695 for (senv = environ, numenv = 0; *senv; senv++)
1697 newenv = (char **)malloc((numenv + 2) * sizeof(char *));
1699 for (senv = environ, denv = newenv; *senv; senv++) {
1700 if (strncmp(*senv, "KRBTKFILE=", 10) != 0 &&
1701 strncmp(*senv, "KRB5CCNAME=", 11) != 0)
1705 *denv = malloc(10+11 + strlen(fname) + strlen(fname5) + 2);
1706 strcpy(*denv, "KRBTKFILE=");
1707 strcat(*denv, fname);
1708 *(denv+1) = *denv + strlen(*denv) + 1;
1710 strcpy(*denv, "KRB5CCNAME=");
1711 strcat(*denv, fname5);
1714 UNLOCK_GLOBAL_MUTEX;
1719 * BLETCH! We have to invoke the entire afsconf package just to
1720 * find out what the local cell is.
1726 struct afsconf_dir *conf;
1728 if ((conf = afsconf_Open(AFSDIR_CLIENT_ETC_DIRPATH))
1729 || (conf = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH))) {
1730 code = afsconf_GetLocalCell(conf, lcell, sizeof(lcell));
1731 afsconf_Close(conf);
1733 if (!conf || code) {
1734 printf("** Can't determine local cell name!\n");