1 /* $NetBSD: pwcache.c,v 1.29 2004/06/20 22:20:14 jmc Exp $ */
4 * Copyright (c) 1992 Keith Muller.
5 * Copyright (c) 1992, 1993
6 * The Regents of the University of California. All rights reserved.
8 * This code is derived from software contributed to Berkeley by
9 * Keith Muller of the University of California, San Diego.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Copyright (c) 2002 The NetBSD Foundation, Inc.
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
49 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
50 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
51 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
52 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
53 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
54 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
55 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
56 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
57 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
58 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
59 * POSSIBILITY OF SUCH DAMAGE.
62 #include <sys/cdefs.h>
63 __FBSDID("$FreeBSD$");
65 #include <sys/types.h>
66 #include <sys/param.h>
77 __weak_alias(user_from_uid,_user_from_uid)
78 __weak_alias(group_from_gid,_group_from_gid)
79 __weak_alias(pwcache_userdb,_pwcache_userdb)
80 __weak_alias(pwcache_groupdb,_pwcache_groupdb)
86 * routines that control user, group, uid and gid caches (for the archive
87 * member print routine).
89 * these routines cache BOTH hits and misses, a major performance improvement
93 * function pointers to various name lookup routines.
94 * these may be changed as necessary.
96 static int (*_pwcache_setgroupent)(int) = setgroupent;
97 static void (*_pwcache_endgrent)(void) = endgrent;
98 static struct group * (*_pwcache_getgrnam)(const char *) = getgrnam;
99 static struct group * (*_pwcache_getgrgid)(gid_t) = getgrgid;
100 static int (*_pwcache_setpassent)(int) = setpassent;
101 static void (*_pwcache_endpwent)(void) = endpwent;
102 static struct passwd * (*_pwcache_getpwnam)(const char *) = getpwnam;
103 static struct passwd * (*_pwcache_getpwuid)(uid_t) = getpwuid;
108 static int pwopn; /* is password file open */
109 static int gropn; /* is group file open */
110 static UIDC **uidtb; /* uid to name cache */
111 static GIDC **gidtb; /* gid to name cache */
112 static UIDC **usrtb; /* user name to uid cache */
113 static GIDC **grptb; /* group name to gid cache */
115 static int uidtb_fail; /* uidtb_start() failed ? */
116 static int gidtb_fail; /* gidtb_start() failed ? */
117 static int usrtb_fail; /* usrtb_start() failed ? */
118 static int grptb_fail; /* grptb_start() failed ? */
121 static u_int st_hash(const char *, size_t, int);
122 static int uidtb_start(void);
123 static int gidtb_start(void);
124 static int usrtb_start(void);
125 static int grptb_start(void);
129 st_hash(const char *name, size_t len, int tabsz)
135 key = (key << 8) | (key >> 24);
138 return (key % tabsz);
143 * creates an an empty uidtb
145 * 0 if ok, -1 otherwise
155 if ((uidtb = (UIDC **)calloc(UID_SZ, sizeof(UIDC *))) == NULL) {
164 * creates an an empty gidtb
166 * 0 if ok, -1 otherwise
176 if ((gidtb = (GIDC **)calloc(GID_SZ, sizeof(GIDC *))) == NULL) {
185 * creates an an empty usrtb
187 * 0 if ok, -1 otherwise
197 if ((usrtb = (UIDC **)calloc(UNM_SZ, sizeof(UIDC *))) == NULL) {
206 * creates an an empty grptb
208 * 0 if ok, -1 otherwise
218 if ((grptb = (GIDC **)calloc(GNM_SZ, sizeof(GIDC *))) == NULL) {
227 * caches the name (if any) for the uid. If noname clear, we always
228 * return the stored name (if valid or invalid match).
229 * We use a simple hash table.
231 * Pointer to stored name (or a empty string)
234 user_from_uid(uid_t uid, int noname)
239 if ((uidtb == NULL) && (uidtb_start() < 0))
243 * see if we have this uid cached
245 pptr = uidtb + (uid % UID_SZ);
248 if ((ptr != NULL) && (ptr->valid > 0) && (ptr->uid == uid)) {
250 * have an entry for this uid
252 if (!noname || (ptr->valid == VALID))
258 * No entry for this uid, we will add it
261 if (_pwcache_setpassent != NULL)
262 (*_pwcache_setpassent)(1);
267 *pptr = ptr = (UIDC *)malloc(sizeof(UIDC));
269 if ((pw = (*_pwcache_getpwuid)(uid)) == NULL) {
271 * no match for this uid in the local password file
272 * a string that is the uid in numeric format
277 (void)snprintf(ptr->name, UNMLEN, "%lu", (long) uid);
278 ptr->valid = INVALID;
283 * there is an entry for this uid in the password file
286 return (pw->pw_name);
288 (void)strlcpy(ptr->name, pw->pw_name, UNMLEN);
296 * caches the name (if any) for the gid. If noname clear, we always
297 * return the stored name (if valid or invalid match).
298 * We use a simple hash table.
300 * Pointer to stored name (or a empty string)
303 group_from_gid(gid_t gid, int noname)
308 if ((gidtb == NULL) && (gidtb_start() < 0))
312 * see if we have this gid cached
314 pptr = gidtb + (gid % GID_SZ);
317 if ((ptr != NULL) && (ptr->valid > 0) && (ptr->gid == gid)) {
319 * have an entry for this gid
321 if (!noname || (ptr->valid == VALID))
327 * No entry for this gid, we will add it
330 if (_pwcache_setgroupent != NULL)
331 (*_pwcache_setgroupent)(1);
336 *pptr = ptr = (GIDC *)malloc(sizeof(GIDC));
338 if ((gr = (*_pwcache_getgrgid)(gid)) == NULL) {
340 * no match for this gid in the local group file, put in
341 * a string that is the gid in numberic format
346 (void)snprintf(ptr->name, GNMLEN, "%lu", (long) gid);
347 ptr->valid = INVALID;
352 * there is an entry for this group in the group file
355 return (gr->gr_name);
357 (void)strlcpy(ptr->name, gr->gr_name, GNMLEN);
365 * caches the uid for a given user name. We use a simple hash table.
367 * the uid (if any) for a user name, or a -1 if no match can be found
370 uid_from_user(const char *name, uid_t *uid)
377 * return -1 for mangled names
379 if (name == NULL || ((namelen = strlen(name)) == 0))
381 if ((usrtb == NULL) && (usrtb_start() < 0))
385 * look up in hash table, if found and valid return the uid,
386 * if found and invalid, return a -1
388 pptr = usrtb + st_hash(name, namelen, UNM_SZ);
391 if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
392 if (ptr->valid == INVALID)
399 if (_pwcache_setpassent != NULL)
400 (*_pwcache_setpassent)(1);
405 *pptr = ptr = (UIDC *)malloc(sizeof(UIDC));
408 * no match, look it up, if no match store it as an invalid entry,
409 * or store the matching uid
412 if ((pw = (*_pwcache_getpwnam)(name)) == NULL)
417 (void)strlcpy(ptr->name, name, UNMLEN);
418 if ((pw = (*_pwcache_getpwnam)(name)) == NULL) {
419 ptr->valid = INVALID;
423 *uid = ptr->uid = pw->pw_uid;
429 * caches the gid for a given group name. We use a simple hash table.
431 * the gid (if any) for a group name, or a -1 if no match can be found
434 gid_from_group(const char *name, gid_t *gid)
441 * return -1 for mangled names
443 if (name == NULL || ((namelen = strlen(name)) == 0))
445 if ((grptb == NULL) && (grptb_start() < 0))
449 * look up in hash table, if found and valid return the uid,
450 * if found and invalid, return a -1
452 pptr = grptb + st_hash(name, namelen, GID_SZ);
455 if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
456 if (ptr->valid == INVALID)
463 if (_pwcache_setgroupent != NULL)
464 (*_pwcache_setgroupent)(1);
469 *pptr = ptr = (GIDC *)malloc(sizeof(GIDC));
472 * no match, look it up, if no match store it as an invalid entry,
473 * or store the matching gid
476 if ((gr = (*_pwcache_getgrnam)(name)) == NULL)
482 (void)strlcpy(ptr->name, name, GNMLEN);
483 if ((gr = (*_pwcache_getgrnam)(name)) == NULL) {
484 ptr->valid = INVALID;
488 *gid = ptr->gid = gr->gr_gid;
492 #define FLUSHTB(arr, len, fail) \
495 for (i = 0; i < len; i++) \
496 if (arr[i] != NULL) \
501 } while (/* CONSTCOND */0);
505 int (*a_setpassent)(int),
506 void (*a_endpwent)(void),
507 struct passwd * (*a_getpwnam)(const char *),
508 struct passwd * (*a_getpwuid)(uid_t))
512 /* a_setpassent and a_endpwent may be NULL */
513 if (a_getpwnam == NULL || a_getpwuid == NULL)
516 if (_pwcache_endpwent != NULL)
517 (*_pwcache_endpwent)();
518 FLUSHTB(uidtb, UID_SZ, uidtb_fail);
519 FLUSHTB(usrtb, UNM_SZ, usrtb_fail);
521 _pwcache_setpassent = a_setpassent;
522 _pwcache_endpwent = a_endpwent;
523 _pwcache_getpwnam = a_getpwnam;
524 _pwcache_getpwuid = a_getpwuid;
531 int (*a_setgroupent)(int),
532 void (*a_endgrent)(void),
533 struct group * (*a_getgrnam)(const char *),
534 struct group * (*a_getgrgid)(gid_t))
538 /* a_setgroupent and a_endgrent may be NULL */
539 if (a_getgrnam == NULL || a_getgrgid == NULL)
542 if (_pwcache_endgrent != NULL)
543 (*_pwcache_endgrent)();
544 FLUSHTB(gidtb, GID_SZ, gidtb_fail);
545 FLUSHTB(grptb, GNM_SZ, grptb_fail);
547 _pwcache_setgroupent = a_setgroupent;
548 _pwcache_endgrent = a_endgrent;
549 _pwcache_getgrnam = a_getgrnam;
550 _pwcache_getgrgid = a_getgrgid;
559 test_getpwnam(const char *name)
561 static struct passwd foo;
563 memset(&foo, 0, sizeof(foo));
564 if (strcmp(name, "toor") == 0) {
568 return (getpwnam(name));
572 main(int argc, char *argv[])
577 printf("pass 1 (default userdb)\n");
578 for (i = 1; i < argc; i++) {
579 printf("i: %d, pwopn %d usrtb_fail %d usrtb %p\n",
580 i, pwopn, usrtb_fail, usrtb);
581 r = uid_from_user(argv[i], &u);
583 printf(" uid_from_user %s: failed\n", argv[i]);
585 printf(" uid_from_user %s: %d\n", argv[i], u);
587 printf("pass 1 finish: pwopn %d usrtb_fail %d usrtb %p\n",
588 pwopn, usrtb_fail, usrtb);
591 printf("pass 2 (replacement userdb)\n");
592 printf("pwcache_userdb returned %d\n",
593 pwcache_userdb(setpassent, test_getpwnam, getpwuid));
594 printf("pwopn %d usrtb_fail %d usrtb %p\n", pwopn, usrtb_fail, usrtb);
596 for (i = 1; i < argc; i++) {
597 printf("i: %d, pwopn %d usrtb_fail %d usrtb %p\n",
598 i, pwopn, usrtb_fail, usrtb);
600 r = uid_from_user(argv[i], &u);
602 printf(" uid_from_user %s: failed\n", argv[i]);
604 printf(" uid_from_user %s: %d\n", argv[i], u);
606 printf("pass 2 finish: pwopn %d usrtb_fail %d usrtb %p\n",
607 pwopn, usrtb_fail, usrtb);
610 printf("pass 3 (null pointers)\n");
611 printf("pwcache_userdb returned %d\n",
612 pwcache_userdb(NULL, NULL, NULL));
616 #endif /* TEST_PWCACHE */