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>
13 #include <afs/param.h>
16 #include "afsincludes.h"
25 #include <afs/pthread_glock.h>
26 #include <sys/types.h>
31 #include <sys/ioctl.h>
32 #include <netinet/in.h>
36 #include <sys/lockf.h>
44 #ifdef HAVE_CRT_EXTERNS_H
45 #include <crt_externs.h>
51 #include <afs/venus.h>
52 #include <afs/afsutil.h>
55 #include <afs/sys_prototypes.h>
58 #if defined(LINUX_KEYRING_SUPPORT) && defined(HAVE_SESSION_TO_PARENT)
59 #include <sys/syscall.h>
60 #define KEYCTL_SESSION_TO_PARENT 18
68 /* AFS_KERBEROS_ENV is now conditionally defined in the Makefile */
69 #define AFS_KERBEROS_ENV
72 #ifdef AFS_KERBEROS_ENV
75 #include <afs/cellconfig.h>
76 static char lcell[MAXCELLCHARS];
78 #define TKT_ROOT "/tmp/tkt"
83 /* Definitions for ticket file utilities */
87 /* Error codes returned by ticket file utilities */
88 #define NO_TKT_FIL 76 /* No ticket file found */
89 #define TKT_FIL_ACC 77 /* Couldn't access tkt file */
90 #define TKT_FIL_LCK 78 /* Couldn't lock ticket file */
91 #define TKT_FIL_FMT 79 /* Bad ticket file format */
92 #define TKT_FIL_INI 80 /* afs_tf_init not called first */
94 /* Values returned by get_credentials */
95 #define RET_TKFIL 21 /* Can't read ticket file */
104 #if defined(AFS_AIX_ENV) || defined(AFS_SUN5_ENV)
105 static struct flock fileWlock = { F_WRLCK, 0, 0, 0, 0, 0 };
106 static struct flock fileRlock = { F_RDLCK, 0, 0, 0, 0, 0 };
107 static struct flock fileUlock = { F_UNLCK, 0, 0, 0, 0, 0 };
110 static struct flock fileWlock = { F_WRLCK, 0, 0, 0, 0 };
111 static struct flock fileRlock = { F_RDLCK, 0, 0, 0, 0 };
112 static struct flock fileUlock = { F_UNLCK, 0, 0, 0, 0 };
119 /* the following routines aren't static anymore on behalf of the kerberos IV
120 * compatibility library built in subtree krb.
122 int afs_tf_init(char *, int);
123 int afs_tf_get_pname(char *);
124 int afs_tf_get_pinst(char *);
125 int afs_tf_get_cred(struct ktc_principal *, struct ktc_token *);
126 int afs_tf_save_cred(struct ktc_principal *, struct ktc_token *,
127 struct ktc_principal *);
128 int afs_tf_close(void);
129 int afs_tf_create(char *, char *);
130 int afs_tf_dest_tkt(void);
131 static void ktc_LocalCell(void);
132 #endif /* AFS_KERBEROS_ENV */
135 #define PIOCTL afs_pioctl
136 #elif defined(UKERNEL)
137 #define PIOCTL(A,B,C,D) call_syscall(AFSCALL_PIOCTL,A,B,C,D)
139 #define PIOCTL pioctl
142 #if !defined(UKERNEL)
143 /* this is a structure used to communicate with the afs cache mgr, but is
144 * otherwise irrelevant */
146 afs_int32 AuthHandle;
147 char HandShakeKey[8];
149 afs_int32 BeginTimestamp;
150 afs_int32 EndTimestamp;
152 #endif /* !defined(UKERNEL) */
154 #define MAXLOCALTOKENS 4
158 struct ktc_principal server;
159 struct ktc_principal client;
160 struct ktc_token token;
161 } local_tokens[MAXLOCALTOKENS] = { {
168 #define MAXPIOCTLTOKENLEN \
169 (3*sizeof(afs_int32)+MAXKTCTICKETLEN+sizeof(struct ClearToken)+MAXKTCREALMLEN)
172 SetToken(struct ktc_principal *aserver, struct ktc_token *atoken,
173 struct ktc_principal *aclient, afs_int32 flags)
175 struct ViceIoctl iob;
176 char tbuffer[MAXPIOCTLTOKENLEN];
178 struct ClearToken ct;
182 if (strcmp(aserver->name, "afs") != 0) {
185 for (i = 0; i < MAXLOCALTOKENS; i++)
186 if (local_tokens[i].valid) {
187 if ((strcmp(local_tokens[i].server.name, aserver->name) == 0)
190 (local_tokens[i].server.instance,
191 aserver->instance) == 0)
192 && (strcmp(local_tokens[i].server.cell, aserver->cell) ==
194 found = i; /* replace existing entry */
196 } else /* valid, but no match */
199 found = i; /* remember this empty slot */
202 memcpy(&local_tokens[found].token, atoken, sizeof(struct ktc_token));
203 local_tokens[found].server = *aserver;
204 local_tokens[found].client = *aclient;
205 local_tokens[found].valid = 1;
208 tp = tbuffer; /* start copying here */
209 if ((atoken->ticketLen < MINKTCTICKETLEN)
210 || (atoken->ticketLen > MAXKTCTICKETLEN))
212 memcpy(tp, &atoken->ticketLen, sizeof(afs_int32)); /* copy in ticket length */
213 tp += sizeof(afs_int32);
214 memcpy(tp, atoken->ticket, atoken->ticketLen); /* copy in ticket */
215 tp += atoken->ticketLen;
216 /* next, copy in the "clear token", describing who we are */
217 ct.AuthHandle = atoken->kvno; /* hide auth handle here */
218 memcpy(ct.HandShakeKey, &atoken->sessionKey, 8);
220 ct.BeginTimestamp = atoken->startTime;
221 ct.EndTimestamp = atoken->endTime;
222 if (ct.BeginTimestamp == 0)
223 ct.BeginTimestamp = 1;
225 if ((strlen(aclient->name) > strlen("AFS ID "))
226 && (aclient->instance[0] == 0)) {
228 afs_int32 viceId = 0;
229 char *cp = aclient->name + strlen("AFS ID ");
236 viceId = viceId * 10 + (int)(*cp - '0');
241 ct.ViceId = viceId * sign; /* OK to let any value here? */
242 if (((ct.EndTimestamp - ct.BeginTimestamp) & 1) == 0)
243 ct.BeginTimestamp++; /* force lifetime to be odd */
246 ct.ViceId = getuid(); /* wrong, but works in primary cell */
247 if (((ct.EndTimestamp - ct.BeginTimestamp) & 1) == 1)
248 ct.BeginTimestamp++; /* force lifetime to be even */
253 * Information needed by the user space cache manager
255 get_user_struct()->u_expiration = ct.EndTimestamp;
256 get_user_struct()->u_viceid = ct.ViceId;
259 temp = sizeof(struct ClearToken);
260 memcpy(tp, &temp, sizeof(afs_int32));
261 tp += sizeof(afs_int32);
262 memcpy(tp, &ct, sizeof(struct ClearToken));
263 tp += sizeof(struct ClearToken);
265 /* next copy in primary flag */
269 * The following means that setpag will happen inside afs just before
270 * the authentication to prevent the setpag/klog race condition.
272 * The following means that setpag will affect the parent process as
273 * well as the current process.
275 if (flags & AFS_SETTOK_SETPAG)
278 memcpy(tp, &temp, sizeof(afs_int32));
279 tp += sizeof(afs_int32);
281 /* finally copy in the cell name */
282 temp = strlen(aserver->cell);
283 if (temp >= MAXKTCREALMLEN)
285 strcpy(tp, aserver->cell);
288 /* now setup for the pioctl */
290 iob.in_size = tp - tbuffer;
292 iob.out_size = sizeof(tbuffer);
294 #if defined(NO_AFS_CLIENT)
298 if ((tkfile = getenv("TKTFILE"))
301 open(tkfile, O_WRONLY | O_APPEND | O_TRUNC | O_CREAT,
303 printf("Writing ticket to: %s\n", tkfile);
304 code = (write(fd, iob.in, iob.in_size) != iob.in_size);
307 code = KTC_PIOCTLFAIL;
309 #else /* NO_AFS_CLIENT */
310 code = PIOCTL(0, VIOCSETTOK, &iob, 0);
311 #if defined(LINUX_KEYRING_SUPPORT) && defined(HAVE_SESSION_TO_PARENT)
313 * If we're using keyring based PAGs and the SESSION_TO_PARENT keyctl
314 * is available, use it to copy the session keyring to the parent process
316 if (flags & AFS_SETTOK_SETPAG)
317 syscall(SYS_keyctl, KEYCTL_SESSION_TO_PARENT);
319 #endif /* NO_AFS_CLIENT */
321 return KTC_PIOCTLFAIL;
326 ktc_SetToken(struct ktc_principal *aserver,
327 struct ktc_token *atoken,
328 struct ktc_principal *aclient,
334 #ifdef AFS_KERBEROS_ENV
338 if ( /*!strcmp(aclient->cell, lcell) && this would only store local creds */
339 (strcmp(aserver->name, "AuthServer")
340 || strcmp(aserver->instance, "Admin"))) {
341 if (strcmp(aserver->name, "krbtgt") == 0) {
342 static char lrealm[MAXKTCREALMLEN];
345 ucstring(lrealm, lcell, MAXKTCREALMLEN);
346 if (strcmp(aserver->instance, lrealm) == 0) {
347 afs_tf_create(aclient->name, aclient->instance);
351 code = afs_tf_init(ktc_tkt_string(), W_TKT_FIL);
352 if (code == NO_TKT_FIL) {
353 (void)afs_tf_create(aclient->name, aclient->instance);
354 code = afs_tf_init(ktc_tkt_string(), W_TKT_FIL);
358 afs_tf_save_cred(aserver, atoken, aclient);
364 #endif /* NO_AFS_CLIENT */
368 #ifndef NO_AFS_CLIENT
369 code = SetToken(aserver, atoken, aclient, flags);
374 else if (code == KTC_PIOCTLFAIL)
382 return KTC_PIOCTLFAIL;
384 #endif /* NO_AFS_CLIENT */
389 /* get token, given server we need and token buffer. aclient will eventually
390 * be set to our identity to the server.
393 ktc_GetToken(struct ktc_principal *aserver, struct ktc_token *atoken,
394 int atokenLen, struct ktc_principal *aclient)
396 struct ViceIoctl iob;
397 char tbuffer[MAXPIOCTLTOKENLEN];
400 char *stp, *cellp; /* secret token ptr */
401 struct ClearToken ct;
404 int maxLen; /* biggest ticket we can copy */
405 int tktLen; /* server ticket length */
406 #ifdef AFS_KERBEROS_ENV
412 #ifdef AFS_KERBEROS_ENV
416 #ifndef NO_AFS_CLIENT
417 if (strcmp(aserver->name, "afs") != 0)
418 #endif /* NO_AFS_CLIENT */
421 /* try the local tokens */
422 for (i = 0; i < MAXLOCALTOKENS; i++)
423 if (local_tokens[i].valid
424 && (strcmp(local_tokens[i].server.name, aserver->name) == 0)
425 && (strcmp(local_tokens[i].server.instance, aserver->instance)
427 && (strcmp(local_tokens[i].server.cell, aserver->cell) == 0)) {
428 memcpy(atoken, &local_tokens[i].token,
429 min(atokenLen, sizeof(struct ktc_token)));
431 *aclient = local_tokens[i].client;
435 #ifdef AFS_KERBEROS_ENV
436 if (!afs_tf_init(ktc_tkt_string(), R_TKT_FIL)) {
438 if (!afs_tf_get_pname(aclient->name)
439 && !afs_tf_get_pinst(aclient->instance))
442 char tmpstring[MAXHOSTCHARS];
443 afs_tf_get_pname(tmpstring);
444 afs_tf_get_pinst(tmpstring);
449 struct ktc_principal cprincipal;
450 struct ktc_token ctoken;
452 while (!afs_tf_get_cred(&cprincipal, &ctoken)) {
453 if (strcmp(cprincipal.name, aserver->name) == 0
454 && strcmp(cprincipal.instance, aserver->instance) == 0
455 && strcmp(cprincipal.cell, aserver->cell) == 0) {
458 strcpy(aclient->cell, lcell);
459 memcpy(atoken, &ctoken,
460 min(atokenLen, sizeof(struct ktc_token)));
473 #ifndef NO_AFS_CLIENT
474 for (index = 0; index < 200; index++) { /* sanity check in case pioctl fails */
475 iob.in = (char *)&index;
476 iob.in_size = sizeof(afs_int32);
478 iob.out_size = sizeof(tbuffer);
480 code = PIOCTL(0, VIOCGETTOK, &iob, 0);
483 /* failed to retrieve specified token */
484 if (code < 0 && errno == EDOM) {
489 /* token retrieved; parse buffer */
492 /* get ticket length */
493 memcpy(&temp, tp, sizeof(afs_int32));
495 tp += sizeof(afs_int32);
497 /* remember where ticket is and skip over it */
501 /* get size of clear token and verify */
502 memcpy(&temp, tp, sizeof(afs_int32));
503 if (temp != sizeof(struct ClearToken)) {
507 tp += sizeof(afs_int32);
509 /* copy clear token */
510 memcpy(&ct, tp, temp);
513 /* skip over primary flag */
514 tp += sizeof(afs_int32);
516 /* remember where cell name is */
519 if ((strcmp(cellp, aserver->cell) == 0)
520 #ifdef AFS_KERBEROS_ENV
521 || (*aserver->cell == '\0' && strcmp(cellp, lcell) == 0)
524 /* got token for cell; check that it will fit */
526 atokenLen - sizeof(struct ktc_token) + MAXKTCTICKETLEN;
527 if (maxLen < tktLen) {
532 /* set return values */
533 memcpy(atoken->ticket, stp, tktLen);
534 atoken->startTime = ct.BeginTimestamp;
535 atoken->endTime = ct.EndTimestamp;
536 if (ct.AuthHandle == -1) {
539 atoken->kvno = ct.AuthHandle;
540 memcpy(&atoken->sessionKey, ct.HandShakeKey,
541 sizeof(struct ktc_encryptionKey));
542 atoken->ticketLen = tktLen;
545 strcpy(aclient->cell, cellp);
546 aclient->instance[0] = 0;
548 if ((atoken->kvno == 999) || /* old style bcrypt ticket */
549 (ct.BeginTimestamp && /* new w/ prserver lookup */
550 (((ct.EndTimestamp - ct.BeginTimestamp) & 1) == 1))) {
551 sprintf(aclient->name, "AFS ID %d", ct.ViceId);
553 sprintf(aclient->name, "Unix UID %d", ct.ViceId);
561 #endif /* NO_AFS_CLIENT */
564 if ((code < 0) && (errno == EINVAL))
566 return KTC_PIOCTLFAIL; /* probable cause */
570 * Forget tokens for this server and the calling user.
571 * NOT IMPLEMENTED YET!
573 #ifndef NO_AFS_CLIENT
575 ktc_ForgetToken(struct ktc_principal *aserver)
580 rc = ktc_ForgetAllTokens(); /* bogus, but better */
584 #endif /* NO_AFS_CLIENT */
586 /* ktc_ListTokens - list all tokens. start aprevIndex at 0, it returns the
587 * next rock in (*aindex). (*aserver) is set to the relevant ticket on
591 ktc_ListTokens(int aprevIndex,
593 struct ktc_principal *aserver)
595 struct ViceIoctl iob;
596 char tbuffer[MAXPIOCTLTOKENLEN];
599 afs_int32 temp, index;
601 memset(tbuffer, 0, sizeof(tbuffer));
609 #endif /* NO_AFS_CLIENT */
610 #ifdef AFS_KERBEROS_ENV
613 struct ktc_principal cprincipal;
614 struct ktc_token ctoken;
616 if (afs_tf_init(ktc_tkt_string(), R_TKT_FIL)
617 || afs_tf_get_pname(tbuffer) || afs_tf_get_pinst(tbuffer)) {
623 for (i = 214; i < index; i++) {
624 if (afs_tf_get_cred(&cprincipal, &ctoken)) {
632 if (afs_tf_get_cred(&cprincipal, &ctoken)) {
639 #ifndef NO_AFS_CLIENT
640 if (!strcmp(cprincipal.name, "afs") && cprincipal.instance[0] == 0) {
643 #endif /* NO_AFS_CLIENT */
645 for (i = 0; i < MAXLOCALTOKENS; i++) {
646 if (!strcmp(cprincipal.name, local_tokens[i].server.name)
647 && !strcmp(cprincipal.instance,
648 local_tokens[i].server.instance)
649 && !strcmp(cprincipal.cell, local_tokens[i].server.cell)) {
654 *aserver = cprincipal;
662 #ifndef NO_AFS_CLIENT
663 if (index >= 123) { /* special hack for returning TCS */
664 while (index - 123 < MAXLOCALTOKENS) {
665 if (local_tokens[index - 123].valid) {
666 *aserver = local_tokens[index - 123].server;
674 #ifdef AFS_KERBEROS_ENV
675 return ktc_ListTokens(214, aindex, aserver);
681 /* get tokens from the kernel */
682 while (index < 200) { /* sanity check in case pioctl fails */
683 iob.in = (char *)&index;
684 iob.in_size = sizeof(afs_int32);
686 iob.out_size = sizeof(tbuffer);
687 code = PIOCTL(0, VIOCGETTOK, &iob, 0);
688 if (code < 0 && errno == EDOM) {
691 rc = ktc_ListTokens(123, aindex, aserver);
700 break; /* got a ticket */
701 /* otherwise we should skip this ticket slot */
708 return KTC_PIOCTLFAIL;
714 /* next iterator determined by earlier loop */
717 memcpy(&temp, tp, sizeof(afs_int32)); /* get size of secret token */
718 tp += sizeof(afs_int32);
719 tp += temp; /* skip ticket for now */
720 memcpy(&temp, tp, sizeof(afs_int32)); /* get size of clear token */
721 if (temp != sizeof(struct ClearToken)) {
725 tp += sizeof(afs_int32); /* skip length */
726 tp += temp; /* skip clear token itself */
727 tp += sizeof(afs_int32); /* skip primary flag */
728 /* tp now points to the cell name */
729 strcpy(aserver->cell, tp);
730 aserver->instance[0] = 0;
731 strcpy(aserver->name, "afs");
732 #endif /* NO_AFS_CLIENT */
740 struct ViceIoctl iob;
744 for (i = 0; i < MAXLOCALTOKENS; i++)
745 local_tokens[i].valid = 0;
751 #ifndef NO_AFS_CLIENT
752 code = PIOCTL(0, VIOCUNPAG, &iob, 0);
754 return KTC_PIOCTLFAIL;
755 #endif /* NO_AFS_CLIENT */
760 ktc_ForgetAllTokens(void)
765 #ifdef AFS_KERBEROS_ENV
766 (void)afs_tf_dest_tkt();
773 else if (ocode == KTC_PIOCTLFAIL)
778 return KTC_PIOCTLFAIL;
784 /* ktc_OldPioctl - returns a boolean true if the kernel supports only the old
785 * pioctl interface for delivering AFS tickets to the cache manager. */
797 struct ViceIoctl iob;
800 /* now setup for the pioctl */
803 iob.out = (caddr_t) &pag;
804 iob.out_size = sizeof(afs_uint32);
806 code = PIOCTL(0, VIOC_GETPAG, &iob, 0);
808 #if defined(AFS_AIX52_ENV)
809 code = getpagvalue("afs");
810 if (code < 0 && errno == EINVAL)
813 #elif defined(AFS_AIX51_ENV)
816 gid_t groups[NGROUPS_MAX];
818 afs_uint32 h, l, ret;
820 #ifdef AFS_LINUX26_ENV
824 ngroups = getgroups(sizeof groups / sizeof groups[0], groups);
826 #ifdef AFS_LINUX26_ENV
827 /* check for AFS_LINUX26_ONEGROUP_ENV PAGs */
828 for (i = 0; i < ngroups; i++) {
829 if (((groups[i] >> 24) & 0xff) == 'A') {
838 g0 = groups[0] & 0xffff;
839 g1 = groups[1] & 0xffff;
842 if (g0 < 0xc000 && g1 < 0xc000) {
843 l = ((g0 & 0x3fff) << 14) | (g1 & 0x3fff);
845 h = (g1 >> 14) + h + h + h;
846 ret = ((h << 28) | l);
847 /* Additional testing */
848 if (((ret >> 24) & 0xff) == 'A')
860 #ifdef AFS_KERBEROS_ENV
862 * Copyright 1987, 1988 by the Massachusetts Institute of Technology.
864 * For copying and distribution information, please see the file
871 #include <sys/types.h>
872 #include <sys/stat.h>
873 #include <sys/file.h>
878 #define TF_LCK_RETRY ((unsigned)2) /* seconds to sleep before
879 * retry if ticket file is
883 * fd must be initialized to something that won't ever occur as a real
884 * file descriptor. Since open(2) returns only non-negative numbers as
885 * valid file descriptors, and afs_tf_init always stuffs the return value
886 * from open in here even if it is an error flag, we must
887 * a. Initialize fd to a negative number, to indicate that it is
888 * not initially valid.
889 * b. When checking for a valid fd, assume that negative values
890 * are invalid (ie. when deciding whether afs_tf_init has been
892 * c. In tf_close, be sure it gets reinitialized to a negative
896 static int curpos; /* Position in tfbfr */
897 static int lastpos; /* End of tfbfr */
898 static char tfbfr[BUFSIZ]; /* Buffer for ticket data */
900 static int tf_gets(char *, int);
901 static int tf_read(char *, int);
904 * This file contains routines for manipulating the ticket cache file.
906 * The ticket file is in the following format:
908 * principal's name (null-terminated string)
909 * principal's instance (null-terminated string)
916 * Where "CREDENTIAL_x" consists of the following fixed-length
917 * fields from the CREDENTIALS structure (see "krb.h"):
919 * char service[MAXKTCNAMELEN]
920 * char instance[MAXKTCNAMELEN]
921 * char realm[REALM_SZ]
926 * afs_int32 issue_date
928 * Short description of routines:
930 * afs_tf_init() opens the ticket file and locks it.
932 * afs_tf_get_pname() returns the principal's name.
934 * afs_tf_get_pinst() returns the principal's instance (may be null).
936 * afs_tf_get_cred() returns the next CREDENTIALS record.
938 * afs_tf_save_cred() appends a new CREDENTIAL record to the ticket file.
940 * afs_tf_close() closes the ticket file and releases the lock.
942 * tf_gets() returns the next null-terminated string. It's an internal
943 * routine used by afs_tf_get_pname(), afs_tf_get_pinst(), and
946 * tf_read() reads a given number of bytes. It's an internal routine
947 * used by afs_tf_get_cred().
951 * afs_tf_init() should be called before the other ticket file routines.
952 * It takes the name of the ticket file to use, "tf_name", and a
953 * read/write flag "rw" as arguments.
955 * It tries to open the ticket file, checks the mode, and if everything
956 * is okay, locks the file. If it's opened for reading, the lock is
957 * shared. If it's opened for writing, the lock is exclusive.
959 * Returns 0 if all went well, otherwise one of the following:
961 * NO_TKT_FIL - file wasn't there
962 * TKT_FIL_ACC - file was in wrong mode, etc.
963 * TKT_FIL_LCK - couldn't lock the file, even after a retry
967 afs_tf_init(char *tf_name, int rw)
971 struct stat stat_buf;
983 if (lstat(tf_name, &stat_buf) < 0)
991 if ((stat_buf.st_uid != me && me != 0)
992 || ((stat_buf.st_mode & S_IFMT) != S_IFREG))
996 * If "wflag" is set, open the ticket file in append-writeonly mode
997 * and lock the ticket file in exclusive mode. If unable to lock
998 * the file, sleep and try again. If we fail again, return with the
999 * proper error message.
1002 curpos = sizeof(tfbfr);
1005 fd = open(tf_name, O_RDWR, 0600);
1009 #if defined(AFS_AIX_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_SUN5_ENV)
1010 if (fcntl(fd, F_SETLK, &fileWlock) == -1) {
1011 sleep(TF_LCK_RETRY);
1012 if (fcntl(fd, F_SETLK, &fileWlock) == -1) {
1014 if (flock(fd, LOCK_EX | LOCK_NB) < 0) {
1015 sleep(TF_LCK_RETRY);
1016 if (flock(fd, LOCK_EX | LOCK_NB) < 0) {
1026 * Otherwise "wflag" is not set and the ticket file should be opened
1027 * for read-only operations and locked for shared access.
1030 fd = open(tf_name, O_RDONLY, 0600);
1034 #if defined(AFS_AIX_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_SUN5_ENV)
1035 if (fcntl(fd, F_SETLK, &fileRlock) == -1) {
1036 sleep(TF_LCK_RETRY);
1037 if (fcntl(fd, F_SETLK, &fileRlock) == -1) {
1039 if (flock(fd, LOCK_SH | LOCK_NB) < 0) {
1040 sleep(TF_LCK_RETRY);
1041 if (flock(fd, LOCK_SH | LOCK_NB) < 0) {
1052 * afs_tf_get_pname() reads the principal's name from the ticket file. It
1053 * should only be called after afs_tf_init() has been called. The
1054 * principal's name is filled into the "p" parameter. If all goes well,
1055 * 0 is returned. If afs_tf_init() wasn't called, TKT_FIL_INI is
1056 * returned. If the name was null, or EOF was encountered, or the name
1057 * was longer than MAXKTCNAMELEN, TKT_FIL_FMT is returned.
1061 afs_tf_get_pname(char *p)
1066 if (tf_gets(p, MAXKTCNAMELEN) < 2) /* can't be just a null */
1072 * afs_tf_get_pinst() reads the principal's instance from a ticket file.
1073 * It should only be called after afs_tf_init() and afs_tf_get_pname() have
1074 * been called. The instance is filled into the "inst" parameter. If all
1075 * goes well, 0 is returned. If afs_tf_init() wasn't called,
1076 * TKT_FIL_INI is returned. If EOF was encountered, or the instance
1077 * was longer than MAXKTCNAMELEN, TKT_FIL_FMT is returned. Note that the
1078 * instance may be null.
1082 afs_tf_get_pinst(char *inst)
1087 if (tf_gets(inst, MAXKTCNAMELEN) < 1)
1093 * afs_tf_get_cred() reads a CREDENTIALS record from a ticket file and fills
1094 * in the given structure "c". It should only be called after afs_tf_init(),
1095 * afs_tf_get_pname(), and afs_tf_get_pinst() have been called. If all goes
1096 * well, 0 is returned. Possible error codes are:
1098 * TKT_FIL_INI - afs_tf_init wasn't called first
1099 * TKT_FIL_FMT - bad format
1100 * EOF - end of file encountered
1104 afs_tf_get_cred(struct ktc_principal *principal, struct ktc_token *token)
1108 long mit_compat; /* MIT Kerberos 5 with Krb4 uses a "long" for issue_date */
1113 if ((k_errno = tf_gets(principal->name, MAXKTCNAMELEN)) < 2)
1116 case 1: /* can't be just a null */
1121 if ((k_errno = tf_gets(principal->instance, MAXKTCNAMELEN)) < 1)
1128 if ((k_errno = tf_gets(principal->cell, MAXKTCREALMLEN)) < 2)
1131 case 1: /* can't be just a null */
1136 lcstring(principal->cell, principal->cell, MAXKTCREALMLEN);
1137 if (tf_read((char *)&(token->sessionKey), 8) < 1
1138 || tf_read((char *)&(lifetime), sizeof(lifetime)) < 1
1139 || tf_read((char *)&(kvno), sizeof(kvno)) < 1
1140 || tf_read((char *)&(token->ticketLen), sizeof(token->ticketLen))
1142 /* don't try to read a silly amount into ticket->dat */
1143 token->ticketLen > MAXKTCTICKETLEN
1144 || tf_read((char *)(token->ticket), token->ticketLen) < 1
1145 || tf_read((char *)&mit_compat, sizeof(mit_compat)) < 1) {
1148 token->startTime = mit_compat;
1149 token->endTime = life_to_time(token->startTime, lifetime);
1155 * tf_close() closes the ticket file and sets "fd" to -1. If "fd" is
1156 * not a valid file descriptor, it just returns. It also clears the
1157 * buffer used to read tickets.
1159 * The return value is not defined.
1166 #if defined(AFS_AIX_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_SUN5_ENV)
1167 (void)fcntl(fd, F_SETLK, &fileUlock);
1169 (void)flock(fd, LOCK_UN);
1172 fd = -1; /* see declaration of fd above */
1174 memset(tfbfr, 0, sizeof(tfbfr));
1179 * tf_gets() is an internal routine. It takes a string "s" and a count
1180 * "n", and reads from the file until either it has read "n" characters,
1181 * or until it reads a null byte. When finished, what has been read exists
1184 * Possible return values are:
1186 * n the number of bytes read (including null terminator)
1187 * when all goes well
1189 * 0 end of file or read error
1191 * TOO_BIG if "count" characters are read and no null is
1192 * encountered. This is an indication that the ticket
1193 * file is seriously ill.
1197 tf_gets(char *s, int n)
1204 for (count = n - 1; count > 0; --count) {
1205 if (curpos >= sizeof(tfbfr)) {
1206 lastpos = read(fd, tfbfr, sizeof(tfbfr));
1209 if (curpos == lastpos) {
1212 *s = tfbfr[curpos++];
1220 * tf_read() is an internal routine. It takes a string "s" and a count
1221 * "n", and reads from the file until "n" bytes have been read. When
1222 * finished, what has been read exists in "s".
1224 * Possible return values are:
1226 * n the number of bytes read when all goes well
1228 * 0 on end of file or read error
1232 tf_read(char *s, int n)
1236 for (count = n; count > 0; --count) {
1237 if (curpos >= sizeof(tfbfr)) {
1238 lastpos = read(fd, tfbfr, sizeof(tfbfr));
1241 if (curpos == lastpos) {
1244 *s++ = tfbfr[curpos++];
1250 * afs_tf_save_cred() appends an incoming ticket to the end of the ticket
1251 * file. You must call afs_tf_init() before calling afs_tf_save_cred().
1253 * The "service", "instance", and "realm" arguments specify the
1254 * server's name; "aticket" contains the credential.
1256 * Returns 0 if all goes well, TKT_FIL_INI if afs_tf_init() wasn't
1257 * called previously, and KFAILURE for anything else that went wrong.
1261 afs_tf_save_cred(struct ktc_principal *aserver,
1262 struct ktc_token *atoken,
1263 struct ktc_principal *aclient)
1265 char realm[MAXKTCREALMLEN + 1];
1266 char junk[MAXKTCNAMELEN];
1267 struct ktc_principal principal;
1268 struct ktc_token token;
1272 int count; /* count for write */
1273 long mit_compat; /* MIT Kerberos 5 with Krb4 uses a "long" for issue_date */
1275 if (fd < 0) { /* fd is ticket file as set by afs_tf_init */
1279 ucstring(realm, aserver->cell, MAXKTCREALMLEN);
1280 realm[MAXKTCREALMLEN] = '\0';
1282 /* Look for a duplicate ticket */
1283 (void)lseek(fd, (off_t) 0L, 0);
1284 curpos = sizeof(tfbfr);
1286 if (afs_tf_get_pname(junk) || strcmp(junk, aclient->name)
1287 || afs_tf_get_pinst(junk) || strcmp(junk, aclient->instance))
1291 start = lseek(fd, (off_t) 0L, 1) - lastpos + curpos;
1292 status = afs_tf_get_cred(&principal, &token);
1293 } while (status == 0
1294 && (strcmp(aserver->name, principal.name) != 0
1295 || strcmp(aserver->instance, principal.instance) != 0
1296 || strcmp(aserver->cell, principal.cell) != 0));
1299 * Two tickets for the same user authenticating to the same service
1300 * should be the same length, but we check here just to make sure.
1302 if (status == 0 && token.ticketLen != atoken->ticketLen)
1304 if (status && status != EOF)
1307 /* Position over the credential we just matched (or the EOF) */
1308 lseek(fd, start, 0);
1309 curpos = lastpos = sizeof(tfbfr);
1311 /* Write the ticket and associated data */
1313 count = strlen(aserver->name) + 1;
1314 if (write(fd, aserver->name, count) != count)
1317 count = strlen(aserver->instance) + 1;
1318 if (write(fd, aserver->instance, count) != count)
1321 count = strlen(realm) + 1;
1322 if (write(fd, realm, count) != count)
1325 if (write(fd, (char *)&atoken->sessionKey, 8) != 8)
1328 lifetime = time_to_life(atoken->startTime, atoken->endTime);
1329 if (write(fd, (char *)&lifetime, sizeof(int)) != sizeof(int))
1332 kvno = atoken->kvno;
1333 if (write(fd, (char *)&kvno, sizeof(int)) != sizeof(int))
1336 if (write(fd, (char *)&(atoken->ticketLen), sizeof(int)) != sizeof(int))
1339 count = atoken->ticketLen;
1340 if (write(fd, atoken->ticket, count) != count)
1343 mit_compat = atoken->startTime;
1344 if (write(fd, (char *)&mit_compat, sizeof(mit_compat))
1345 != sizeof(mit_compat))
1348 /* Actually, we should check each write for success */
1355 * Copyright 1985, 1986, 1987, 1988 by the Massachusetts Institute
1358 * For copying and distribution information, please see the file
1359 * <mit-copyright.h>.
1363 * This routine is used to generate the name of the file that holds
1364 * the user's cache of server tickets and associated session keys.
1366 * If it is set, krb_ticket_string contains the ticket file name.
1367 * Otherwise, the filename is constructed as follows:
1369 * If it is set, the environment variable "KRBTKFILE" will be used as
1370 * the ticket file name. Otherwise TKT_ROOT (defined in "krb.h") and
1371 * the user's uid are concatenated to produce the ticket file name
1372 * (e.g., "/tmp/tkt123"). A pointer to the string containing the ticket
1373 * file name is returned.
1376 static char krb_ticket_string[4096] = "";
1379 ktc_tkt_string(void)
1381 return ktc_tkt_string_uid(getuid());
1385 ktc_tkt_string_uid(afs_uint32 uid)
1390 if (!*krb_ticket_string) {
1391 if ((env = getenv("KRBTKFILE"))) {
1392 (void)strncpy(krb_ticket_string, env,
1393 sizeof(krb_ticket_string) - 1);
1394 krb_ticket_string[sizeof(krb_ticket_string) - 1] = '\0';
1396 /* 32 bits of signed integer will always fit in 11 characters
1397 * (including the sign), so no need to worry about overflow */
1398 (void)sprintf(krb_ticket_string, "%s%d", TKT_ROOT, uid);
1401 UNLOCK_GLOBAL_MUTEX;
1402 return krb_ticket_string;
1406 * This routine is used to set the name of the file that holds the user's
1407 * cache of server tickets and associated session keys.
1409 * The value passed in is copied into local storage.
1411 * NOTE: This routine should be called during initialization, before other
1412 * Kerberos routines are called; otherwise tkt_string() above may be called
1413 * and return an undesired ticket file name until this routine is called.
1417 ktc_set_tkt_string(char * val)
1421 (void)strncpy(krb_ticket_string, val, sizeof(krb_ticket_string) - 1);
1422 krb_ticket_string[sizeof(krb_ticket_string) - 1] = '\0';
1423 UNLOCK_GLOBAL_MUTEX;
1428 * tf_create() is used to initialize the ticket store. It creates the
1429 * file to contain the tickets and writes the given user's name "pname"
1430 * and instance "pinst" in the file. in_tkt() returns KSUCCESS on
1431 * success, or KFAILURE if something goes wrong.
1435 afs_tf_create(char *pname, char *pinst)
1440 char *file = ktc_tkt_string();
1449 if (lstat(file, &sbuf) == 0) {
1450 if ((sbuf.st_uid != me && me != 0)
1451 || ((sbuf.st_mode & S_IFMT) != S_IFREG) || sbuf.st_mode & 077) {
1454 /* file already exists, and permissions appear ok, so nuke it */
1455 if ((fd = open(file, O_RDWR, 0)) < 0)
1456 goto out; /* can't zero it, but we can still try truncating it */
1458 memset(zerobuf, 0, sizeof(zerobuf));
1460 for (i = 0; i < sbuf.st_size; i += sizeof(zerobuf))
1461 if (write(fd, zerobuf, sizeof(zerobuf)) != sizeof(zerobuf)) {
1472 /* arrange so the file is owned by the ruid
1473 * (swap real & effective uid if necessary).
1474 * This isn't a security problem, since the ticket file, if it already
1475 * exists, has the right uid (== ruid) and mode. */
1477 if (setreuid(metoo, me) < 0) {
1481 tktfile = creat(file, 0600);
1483 if (setreuid(me, metoo) < 0) {
1484 /* can't switch??? fail! */
1491 count = strlen(pname) + 1;
1492 if (write(tktfile, pname, count) != count) {
1493 (void)close(tktfile);
1496 count = strlen(pinst) + 1;
1497 if (write(tktfile, pinst, count) != count) {
1498 (void)close(tktfile);
1501 (void)close(tktfile);
1506 * dest_tkt() is used to destroy the ticket store upon logout.
1507 * If the ticket file does not exist, dest_tkt() returns RET_TKFIL.
1508 * Otherwise the function returns 0 on success, KFAILURE on
1513 afs_tf_dest_tkt(void)
1515 char *file = ktc_tkt_string();
1521 if (lstat(file, &statb) < 0)
1524 if (!(statb.st_mode & S_IFREG))
1527 if ((fd = open(file, O_RDWR, 0)) < 0)
1530 memset(buf, 0, BUFSIZ);
1532 for (i = 0; i < statb.st_size; i += BUFSIZ)
1533 if (write(fd, buf, BUFSIZ) != BUFSIZ) {
1545 if (errno == ENOENT)
1547 else if (errno != 0)
1555 #if !defined(AFS_DARWIN100_ENV) || defined(HAVE_CRT_EXTERNS_H)
1556 # if defined(AFS_DARWIN100_ENV)
1557 # define environ (*_NSGetEnviron())
1559 extern char **environ;
1564 char fname[256], *prefix = "/ticket/";
1565 char fname5[256], *prefix5 = "FILE:/ticket/krb5cc_";
1567 char **newenv, **senv, **denv;
1570 if (stat("/ticket", &sbuf) == -1) {
1571 prefix = "/tmp/tkt";
1572 prefix5 = "FILE:/tmp/krb5cc_";
1575 pag = ktc_curpag() & 0xffffffff;
1577 sprintf(fname, "%s%d", prefix, getuid());
1578 sprintf(fname5, "%s%d", prefix5, getuid());
1580 sprintf(fname, "%sp%lu", prefix, afs_printable_uint32_lu(pag));
1581 sprintf(fname5, "%sp%lud", prefix5, afs_printable_uint32_lu(pag));
1583 ktc_set_tkt_string(fname);
1585 for (senv = environ, numenv = 0; *senv; senv++)
1587 newenv = (char **)malloc((numenv + 2) * sizeof(char *));
1589 for (senv = environ, denv = newenv; *senv; senv++) {
1590 if (strncmp(*senv, "KRBTKFILE=", 10) != 0 &&
1591 strncmp(*senv, "KRB5CCNAME=", 11) != 0)
1595 *denv = malloc(10+11 + strlen(fname) + strlen(fname5) + 2);
1596 strcpy(*denv, "KRBTKFILE=");
1597 strcat(*denv, fname);
1598 *(denv+1) = *denv + strlen(*denv) + 1;
1600 strcpy(*denv, "KRB5CCNAME=");
1601 strcat(*denv, fname5);
1604 UNLOCK_GLOBAL_MUTEX;
1610 * BLETCH! We have to invoke the entire afsconf package just to
1611 * find out what the local cell is.
1617 struct afsconf_dir *conf;
1619 if ((conf = afsconf_Open(AFSDIR_CLIENT_ETC_DIRPATH))
1620 || (conf = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH))) {
1621 code = afsconf_GetLocalCell(conf, lcell, sizeof(lcell));
1622 afsconf_Close(conf);
1624 if (!conf || code) {
1625 printf("** Can't determine local cell name!\n");