1 /* $NetBSD: pwcache.c,v 1.31 2010/03/23 20:28:59 drochner 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 #if HAVE_NBTOOL_CONFIG_H
63 #include "nbtool_config.h"
65 * XXX Undefine the renames of these functions so that we don't
66 * XXX rename the versions found in the host's <pwd.h> by mistake!
72 #include <sys/cdefs.h>
73 #if defined(LIBC_SCCS) && !defined(lint)
75 static char sccsid[] = "@(#)cache.c 8.1 (Berkeley) 5/31/93";
77 __RCSID("$NetBSD: pwcache.c,v 1.31 2010/03/23 20:28:59 drochner Exp $");
79 #endif /* LIBC_SCCS and not lint */
80 __FBSDID("$FreeBSD$");
82 #include "namespace.h"
84 #include <sys/types.h>
85 #include <sys/param.h>
95 #define _DIAGASSERT(x) assert((x))
97 #if HAVE_NBTOOL_CONFIG_H
98 /* XXX Now, re-apply the renaming that we undid above. */
99 #define group_from_gid __nbcompat_group_from_gid
100 #define user_from_uid __nbcompat_user_from_uid
104 __weak_alias(user_from_uid,_user_from_uid)
105 __weak_alias(group_from_gid,_group_from_gid)
106 __weak_alias(pwcache_groupdb,_pwcache_groupdb)
109 #if !HAVE_PWCACHE_USERDB || HAVE_NBTOOL_CONFIG_H
113 * routines that control user, group, uid and gid caches (for the archive
114 * member print routine).
116 * these routines cache BOTH hits and misses, a major performance improvement
120 * function pointers to various name lookup routines.
121 * these may be changed as necessary.
123 static int (*_pwcache_setgroupent)(int) = setgroupent;
124 static void (*_pwcache_endgrent)(void) = endgrent;
125 static struct group * (*_pwcache_getgrnam)(const char *) = getgrnam;
126 static struct group * (*_pwcache_getgrgid)(gid_t) = getgrgid;
127 static int (*_pwcache_setpassent)(int) = setpassent;
128 static void (*_pwcache_endpwent)(void) = endpwent;
129 static struct passwd * (*_pwcache_getpwnam)(const char *) = getpwnam;
130 static struct passwd * (*_pwcache_getpwuid)(uid_t) = getpwuid;
135 static int pwopn; /* is password file open */
136 static int gropn; /* is group file open */
137 static UIDC **uidtb; /* uid to name cache */
138 static GIDC **gidtb; /* gid to name cache */
139 static UIDC **usrtb; /* user name to uid cache */
140 static GIDC **grptb; /* group name to gid cache */
142 static int uidtb_fail; /* uidtb_start() failed ? */
143 static int gidtb_fail; /* gidtb_start() failed ? */
144 static int usrtb_fail; /* usrtb_start() failed ? */
145 static int grptb_fail; /* grptb_start() failed ? */
148 static u_int st_hash(const char *, size_t, int);
149 static int uidtb_start(void);
150 static int gidtb_start(void);
151 static int usrtb_start(void);
152 static int grptb_start(void);
156 st_hash(const char *name, size_t len, int tabsz)
160 _DIAGASSERT(name != NULL);
164 key = (key << 8) | (key >> 24);
167 return (key % tabsz);
172 * creates an an empty uidtb
174 * 0 if ok, -1 otherwise
184 if ((uidtb = (UIDC **)calloc(UID_SZ, sizeof(UIDC *))) == NULL) {
193 * creates an an empty gidtb
195 * 0 if ok, -1 otherwise
205 if ((gidtb = (GIDC **)calloc(GID_SZ, sizeof(GIDC *))) == NULL) {
214 * creates an an empty usrtb
216 * 0 if ok, -1 otherwise
226 if ((usrtb = (UIDC **)calloc(UNM_SZ, sizeof(UIDC *))) == NULL) {
235 * creates an an empty grptb
237 * 0 if ok, -1 otherwise
247 if ((grptb = (GIDC **)calloc(GNM_SZ, sizeof(GIDC *))) == NULL) {
256 * caches the name (if any) for the uid. If noname clear, we always
257 * return the stored name (if valid or invalid match).
258 * We use a simple hash table.
260 * Pointer to stored name (or a empty string)
263 user_from_uid(uid_t uid, int noname)
268 if ((uidtb == NULL) && (uidtb_start() < 0))
272 * see if we have this uid cached
274 pptr = uidtb + (uid % UID_SZ);
277 if ((ptr != NULL) && (ptr->valid > 0) && (ptr->uid == uid)) {
279 * have an entry for this uid
281 if (!noname || (ptr->valid == VALID))
287 * No entry for this uid, we will add it
290 if (_pwcache_setpassent != NULL)
291 (*_pwcache_setpassent)(1);
296 *pptr = ptr = (UIDC *)malloc(sizeof(UIDC));
298 if ((pw = (*_pwcache_getpwuid)(uid)) == NULL) {
300 * no match for this uid in the local password file
301 * a string that is the uid in numeric format
306 (void)snprintf(ptr->name, UNMLEN, "%lu", (long) uid);
307 ptr->valid = INVALID;
312 * there is an entry for this uid in the password file
315 return (pw->pw_name);
317 (void)strlcpy(ptr->name, pw->pw_name, UNMLEN);
325 * caches the name (if any) for the gid. If noname clear, we always
326 * return the stored name (if valid or invalid match).
327 * We use a simple hash table.
329 * Pointer to stored name (or a empty string)
332 group_from_gid(gid_t gid, int noname)
337 if ((gidtb == NULL) && (gidtb_start() < 0))
341 * see if we have this gid cached
343 pptr = gidtb + (gid % GID_SZ);
346 if ((ptr != NULL) && (ptr->valid > 0) && (ptr->gid == gid)) {
348 * have an entry for this gid
350 if (!noname || (ptr->valid == VALID))
356 * No entry for this gid, we will add it
359 if (_pwcache_setgroupent != NULL)
360 (*_pwcache_setgroupent)(1);
365 *pptr = ptr = (GIDC *)malloc(sizeof(GIDC));
367 if ((gr = (*_pwcache_getgrgid)(gid)) == NULL) {
369 * no match for this gid in the local group file, put in
370 * a string that is the gid in numberic format
375 (void)snprintf(ptr->name, GNMLEN, "%lu", (long) gid);
376 ptr->valid = INVALID;
381 * there is an entry for this group in the group file
384 return (gr->gr_name);
386 (void)strlcpy(ptr->name, gr->gr_name, GNMLEN);
394 * caches the uid for a given user name. We use a simple hash table.
396 * the uid (if any) for a user name, or a -1 if no match can be found
399 uid_from_user(const char *name, uid_t *uid)
406 * return -1 for mangled names
408 if (name == NULL || ((namelen = strlen(name)) == 0))
410 if ((usrtb == NULL) && (usrtb_start() < 0))
414 * look up in hash table, if found and valid return the uid,
415 * if found and invalid, return a -1
417 pptr = usrtb + st_hash(name, namelen, UNM_SZ);
420 if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
421 if (ptr->valid == INVALID)
428 if (_pwcache_setpassent != NULL)
429 (*_pwcache_setpassent)(1);
434 *pptr = ptr = (UIDC *)malloc(sizeof(UIDC));
437 * no match, look it up, if no match store it as an invalid entry,
438 * or store the matching uid
441 if ((pw = (*_pwcache_getpwnam)(name)) == NULL)
446 (void)strlcpy(ptr->name, name, UNMLEN);
447 if ((pw = (*_pwcache_getpwnam)(name)) == NULL) {
448 ptr->valid = INVALID;
452 *uid = ptr->uid = pw->pw_uid;
458 * caches the gid for a given group name. We use a simple hash table.
460 * the gid (if any) for a group name, or a -1 if no match can be found
463 gid_from_group(const char *name, gid_t *gid)
470 * return -1 for mangled names
472 if (name == NULL || ((namelen = strlen(name)) == 0))
474 if ((grptb == NULL) && (grptb_start() < 0))
478 * look up in hash table, if found and valid return the uid,
479 * if found and invalid, return a -1
481 pptr = grptb + st_hash(name, namelen, GID_SZ);
484 if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
485 if (ptr->valid == INVALID)
492 if (_pwcache_setgroupent != NULL)
493 (*_pwcache_setgroupent)(1);
498 *pptr = ptr = (GIDC *)malloc(sizeof(GIDC));
501 * no match, look it up, if no match store it as an invalid entry,
502 * or store the matching gid
505 if ((gr = (*_pwcache_getgrnam)(name)) == NULL)
511 (void)strlcpy(ptr->name, name, GNMLEN);
512 if ((gr = (*_pwcache_getgrnam)(name)) == NULL) {
513 ptr->valid = INVALID;
517 *gid = ptr->gid = gr->gr_gid;
521 #define FLUSHTB(arr, len, fail) \
524 for (i = 0; i < len; i++) \
525 if (arr[i] != NULL) \
530 } while (/* CONSTCOND */0);
534 int (*a_setpassent)(int),
535 void (*a_endpwent)(void),
536 struct passwd * (*a_getpwnam)(const char *),
537 struct passwd * (*a_getpwuid)(uid_t))
541 /* a_setpassent and a_endpwent may be NULL */
542 if (a_getpwnam == NULL || a_getpwuid == NULL)
545 if (_pwcache_endpwent != NULL)
546 (*_pwcache_endpwent)();
547 FLUSHTB(uidtb, UID_SZ, uidtb_fail);
548 FLUSHTB(usrtb, UNM_SZ, usrtb_fail);
550 _pwcache_setpassent = a_setpassent;
551 _pwcache_endpwent = a_endpwent;
552 _pwcache_getpwnam = a_getpwnam;
553 _pwcache_getpwuid = a_getpwuid;
560 int (*a_setgroupent)(int),
561 void (*a_endgrent)(void),
562 struct group * (*a_getgrnam)(const char *),
563 struct group * (*a_getgrgid)(gid_t))
567 /* a_setgroupent and a_endgrent may be NULL */
568 if (a_getgrnam == NULL || a_getgrgid == NULL)
571 if (_pwcache_endgrent != NULL)
572 (*_pwcache_endgrent)();
573 FLUSHTB(gidtb, GID_SZ, gidtb_fail);
574 FLUSHTB(grptb, GNM_SZ, grptb_fail);
576 _pwcache_setgroupent = a_setgroupent;
577 _pwcache_endgrent = a_endgrent;
578 _pwcache_getgrnam = a_getgrnam;
579 _pwcache_getgrgid = a_getgrgid;
588 test_getpwnam(const char *name)
590 static struct passwd foo;
592 memset(&foo, 0, sizeof(foo));
593 if (strcmp(name, "toor") == 0) {
597 return (getpwnam(name));
601 main(int argc, char *argv[])
606 printf("pass 1 (default userdb)\n");
607 for (i = 1; i < argc; i++) {
608 printf("i: %d, pwopn %d usrtb_fail %d usrtb %p\n",
609 i, pwopn, usrtb_fail, usrtb);
610 r = uid_from_user(argv[i], &u);
612 printf(" uid_from_user %s: failed\n", argv[i]);
614 printf(" uid_from_user %s: %d\n", argv[i], u);
616 printf("pass 1 finish: pwopn %d usrtb_fail %d usrtb %p\n",
617 pwopn, usrtb_fail, usrtb);
620 printf("pass 2 (replacement userdb)\n");
621 printf("pwcache_userdb returned %d\n",
622 pwcache_userdb(setpassent, test_getpwnam, getpwuid));
623 printf("pwopn %d usrtb_fail %d usrtb %p\n", pwopn, usrtb_fail, usrtb);
625 for (i = 1; i < argc; i++) {
626 printf("i: %d, pwopn %d usrtb_fail %d usrtb %p\n",
627 i, pwopn, usrtb_fail, usrtb);
629 r = uid_from_user(argv[i], &u);
631 printf(" uid_from_user %s: failed\n", argv[i]);
633 printf(" uid_from_user %s: %d\n", argv[i], u);
635 printf("pass 2 finish: pwopn %d usrtb_fail %d usrtb %p\n",
636 pwopn, usrtb_fail, usrtb);
639 printf("pass 3 (null pointers)\n");
640 printf("pwcache_userdb returned %d\n",
641 pwcache_userdb(NULL, NULL, NULL));
645 #endif /* TEST_PWCACHE */
646 #endif /* !HAVE_PWCACHE_USERDB */