2 * Copyright (c) 1992, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Casey Leedom of Lawrence Livermore National Laboratory.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char sccsid[] = "@(#)getcap.c 8.3 (Berkeley) 3/25/94";
35 #endif /* LIBC_SCCS and not lint */
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include "namespace.h"
40 #include <sys/types.h>
50 #include "un-namespace.h"
56 #define ESC ('[' & 037) /* ASCII ESC */
57 #define MAX_RECURSION 32 /* maximum getent recursion */
58 #define SFRAG 100 /* cgetstr mallocs in SFRAG chunks */
62 #define SHADOW (char)2
64 static size_t topreclen; /* toprec length */
65 static char *toprec; /* Additional record specified by cgetset() */
66 static int gottoprec; /* Flag indicating retrieval of toprecord */
68 static int cdbget(DB *, char **, const char *);
69 static int getent(char **, u_int *, char **, int, const char *, int, char *);
70 static int nfcmp(char *, char *);
73 * Cgetset() allows the addition of a user specified buffer to be added
74 * to the database array, in effect "pushing" the buffer on top of the
75 * virtual database. 0 is returned on success, -1 on failure.
78 cgetset(const char *ent)
87 topreclen = strlen(ent);
88 if ((toprec = malloc (topreclen + 1)) == NULL) {
93 (void)strcpy(toprec, ent);
98 * Cgetcap searches the capability record buf for the capability cap with
99 * type `type'. A pointer to the value of cap is returned on success, NULL
100 * if the requested capability couldn't be found.
102 * Specifying a type of ':' means that nothing should follow cap (:cap:).
103 * In this case a pointer to the terminating ':' or NUL will be returned if
106 * If (cap, '@') or (cap, terminator, '@') is found before (cap, terminator)
110 cgetcap(char *buf, const char *cap, int type)
118 * Skip past the current capability field - it's either the
119 * name field if this is the first time through the loop, or
120 * the remainder of a field whose name failed to match cap.
130 * Try to match (cap, type) in buf.
132 for (cp = cap; *cp == *bp && *bp != '\0'; cp++, bp++)
139 if (*bp != '\0' && *bp != ':')
146 return (*bp == '@' ? NULL : bp);
152 * Cgetent extracts the capability record name from the NULL terminated file
153 * array db_array and returns a pointer to a malloc'd copy of it in buf.
154 * Buf must be retained through all subsequent calls to cgetcap, cgetnum,
155 * cgetflag, and cgetstr, but may then be free'd. 0 is returned on success,
156 * -1 if the requested record couldn't be found, -2 if a system error was
157 * encountered (couldn't open/read a file, etc.), and -3 if a potential
158 * reference loop is detected.
161 cgetent(char **buf, char **db_array, const char *name)
165 return (getent(buf, &dummy, db_array, -1, name, 0, NULL));
169 * Getent implements the functions of cgetent. If fd is non-negative,
170 * *db_array has already been opened and fd is the open file descriptor. We
171 * do this to save time and avoid using up file descriptors for tc=
174 * Getent returns the same success/failure codes as cgetent. On success, a
175 * pointer to a malloc'ed capability record with all tc= capabilities fully
176 * expanded and its length (not including trailing ASCII NUL) are left in
180 * + Allocate memory incrementally as needed in chunks of size BFRAG
181 * for capability buffer.
182 * + Recurse for each tc=name and interpolate result. Stop when all
183 * names interpolated, a name can't be found, or depth exceeds
187 getent(char **cap, u_int *len, char **db_array, int fd, const char *name,
188 int depth, char *nfield)
191 char *r_end, *rp, **db_p;
192 int myfd, eof, foundit, retval, clen;
195 char pbuf[_POSIX_PATH_MAX];
198 * Return with ``loop detected'' error if we've recursed more than
199 * MAX_RECURSION times.
201 if (depth > MAX_RECURSION)
205 * Check if we have a top record from cgetset().
207 if (depth == 0 && toprec != NULL && cgetmatch(toprec, name) == 0) {
208 if ((record = malloc (topreclen + BFRAG)) == NULL) {
212 (void)strcpy(record, toprec);
215 rp = record + topreclen + 1;
220 * Allocate first chunk of memory.
222 if ((record = malloc(BFRAG)) == NULL) {
226 r_end = record + BFRAG;
229 * Loop through database array until finding the record.
232 for (db_p = db_array; *db_p != NULL; db_p++) {
236 * Open database if not already open.
240 (void)lseek(fd, (off_t)0, SEEK_SET);
243 (void)snprintf(pbuf, sizeof(pbuf), "%s.db", *db_p);
244 if ((capdbp = dbopen(pbuf, O_RDONLY, 0, DB_HASH, 0))
247 retval = cdbget(capdbp, &record, name);
249 /* no record available */
250 (void)capdbp->close(capdbp);
253 /* save the data; close frees it */
254 clen = strlen(record);
255 cbuf = malloc(clen + 1);
256 memcpy(cbuf, record, clen + 1);
257 if (capdbp->close(capdbp) < 0) {
265 fd = _open(*db_p, O_RDONLY, 0);
272 * Find the requested capability record ...
281 * There is always room for one more character in record.
282 * R_end always points just past end of record.
283 * Rp always points just past last character in record.
284 * B_end always points just past last character in buf.
285 * Bp always points at next character in buf.
292 * Read in a line implementing (\, newline)
300 n = _read(fd, buf, sizeof(buf));
319 if (rp > record && *(rp-1) == '\\') {
328 * Enforce loop invariant: if no room
329 * left in record buffer, try to get
337 newsize = r_end - record + BFRAG;
338 record = reallocf(record, newsize);
339 if (record == NULL) {
345 r_end = record + newsize;
349 /* loop invariant let's us do this */
353 * If encountered eof check next file.
359 * Toss blank lines and comments.
361 if (*record == '\0' || *record == '#')
365 * See if this is the record we want ...
367 if (cgetmatch(record, name) == 0) {
368 if (nfield == NULL || !nfcmp(nfield, record)) {
370 break; /* found it! */
385 * Got the capability record, but now we have to expand all tc=name
386 * references in it ...
392 int diff, iret, tclen;
393 char *icap, *scan, *tc, *tcstart, *tcend;
397 * There is room for one more character in record.
398 * R_end points just past end of record.
399 * Rp points just past last character in record.
400 * Scan points at remainder of record that needs to be
401 * scanned for tc=name constructs.
406 if ((tc = cgetcap(scan, "tc", '=')) == NULL)
410 * Find end of tc=name and stomp on the trailing `:'
411 * (if present) so we can use it to call ourselves.
426 iret = getent(&icap, &ilen, db_p, fd, tc, depth+1,
428 newicap = icap; /* Put into a register. */
440 /* couldn't resolve tc */
449 /* not interested in name field of tc'ed record */
457 newilen -= s - newicap;
460 /* make sure interpolated record is `:'-terminated */
463 *s = ':'; /* overwrite NUL with : */
468 * Make sure there's enough room to insert the
471 diff = newilen - tclen;
472 if (diff >= r_end - rp) {
473 u_int pos, tcpos, tcposend;
477 newsize = r_end - record + diff + BFRAG;
478 tcpos = tcstart - record;
479 tcposend = tcend - record;
480 record = reallocf(record, newsize);
481 if (record == NULL) {
488 r_end = record + newsize;
490 tcstart = record + tcpos;
491 tcend = record + tcposend;
495 * Insert tc'ed record into our record.
497 s = tcstart + newilen;
498 bcopy(tcend, s, rp - tcend);
499 bcopy(newicap, tcstart, newilen);
504 * Start scan on `:' so next cgetcap works properly
505 * (cgetcap always skips first field).
512 * Close file (if we opened it), give back any extra memory, and
513 * return capability, length and success.
517 *len = rp - record - 1; /* don't count NUL */
520 reallocf(record, (size_t)(rp - record))) == NULL) {
532 cdbget(DB *capdbp, char **bp, const char *name)
537 namebuf = strdup(name);
541 key.size = strlen(namebuf);
544 /* Get the reference. */
545 switch(capdbp->get(capdbp, &key, &data, 0)) {
554 /* If not an index to another record, leave. */
555 if (((char *)data.data)[0] != SHADOW)
558 key.data = (char *)data.data + 1;
559 key.size = data.size - 1;
562 *bp = (char *)data.data + 1;
564 return (((char *)(data.data))[0] == TCERR ? 1 : 0);
568 * Cgetmatch will return 0 if name is one of the names of the capability
569 * record buf, -1 if not.
572 cgetmatch(const char *buf, const char *name)
576 if (name == NULL || *name == '\0')
580 * Start search at beginning of record.
585 * Try to match a record name.
590 if (*bp == '|' || *bp == ':' || *bp == '\0')
599 * Match failed, skip to next name in record.
601 bp--; /* a '|' or ':' may have stopped the match */
603 if (*bp == '\0' || *bp == ':')
604 return (-1); /* match failed totally */
607 break; /* found next name */
616 cgetfirst(char **buf, char **db_array)
619 return (cgetnext(buf, db_array));
640 * Cgetnext() gets either the first or next entry in the logical database
641 * specified by db_array. It returns 0 upon completion of the database, 1
642 * upon returning an entry with more remaining, and -1 if an error occurs.
645 cgetnext(char **bp, char **db_array)
648 int done, hadreaderr, i, savederrno, status;
649 char *cp, *line, *rp, *np, buf[BSIZE], nbuf[BSIZE];
655 if (pfp == NULL && (pfp = fopen(*dbp, "r")) == NULL) {
660 if (toprec && !gottoprec) {
664 line = fgetln(pfp, &len);
665 if (line == NULL && pfp) {
666 hadreaderr = ferror(pfp);
676 if (*++dbp == NULL) {
680 fopen(*dbp, "r")) == NULL) {
687 line[len - 1] = '\0';
692 if (isspace((unsigned char)*line) ||
693 *line == ':' || *line == '#' || slash) {
694 if (line[len - 2] == '\\')
700 if (line[len - 2] == '\\')
708 * Line points to a name line.
714 for (cp = line; *cp != '\0'; cp++) {
727 } else { /* name field extends beyond the line */
728 line = fgetln(pfp, &len);
729 if (line == NULL && pfp) {
730 /* Name extends beyond the EOF! */
731 hadreaderr = ferror(pfp);
745 line[len - 1] = '\0';
749 for(cp = nbuf; *cp != '\0'; cp++)
750 if (*cp == '|' || *cp == ':')
758 * Last argument of getent here should be nbuf if we want true
759 * sequential access in the case of duplicates.
760 * With NULL, getent will return the first entry found
761 * rather than the duplicate entry record. This is a
762 * matter of semantics that should be resolved.
764 status = getent(bp, &dummy, db_array, -1, buf, 0, NULL);
765 if (status == -2 || status == -3)
774 * Cgetstr retrieves the value of the string capability cap from the
775 * capability record pointed to by buf. A pointer to a decoded, NUL
776 * terminated, malloc'd copy of the string is returned in the char *
777 * pointed to by str. The length of the string not including the trailing
778 * NUL is returned on success, -1 if the requested string capability
779 * couldn't be found, -2 if a system error was encountered (storage
780 * allocation failure).
783 cgetstr(char *buf, const char *cap, char **str)
791 * Find string capability cap
793 bp = cgetcap(buf, cap, '=');
798 * Conversion / storage allocation loop ... Allocate memory in
799 * chunks SFRAG in size.
801 if ((mem = malloc(SFRAG)) == NULL) {
803 return (-2); /* couldn't even allocate the first fragment */
808 while (*bp != ':' && *bp != '\0') {
811 * There is always room for one more character in mem.
812 * Mp always points just past last character in mem.
813 * Bp always points at next character in buf.
817 if (*bp == ':' || *bp == '\0')
818 break; /* drop unfinished escape */
824 } else if (*bp == '\\') {
826 if (*bp == ':' || *bp == '\0')
827 break; /* drop unfinished escape */
828 if ('0' <= *bp && *bp <= '7') {
832 i = 3; /* maximum of three octal digits */
834 n = n * 8 + (*bp++ - '0');
835 } while (--i && '0' <= *bp && *bp <= '7');
838 else switch (*bp++) {
862 * Catches '\', '^', and
873 * Enforce loop invariant: if no room left in current
874 * buffer, try to get some more.
877 size_t size = mp - mem;
879 if ((mem = reallocf(mem, size + SFRAG)) == NULL)
885 *mp++ = '\0'; /* loop invariant let's us do this */
890 * Give back any extra memory and return value and success.
893 if ((mem = reallocf(mem, (size_t)(mp - mem))) == NULL)
900 * Cgetustr retrieves the value of the string capability cap from the
901 * capability record pointed to by buf. The difference between cgetustr()
902 * and cgetstr() is that cgetustr does not decode escapes but rather treats
903 * all characters literally. A pointer to a NUL terminated malloc'd
904 * copy of the string is returned in the char pointed to by str. The
905 * length of the string not including the trailing NUL is returned on success,
906 * -1 if the requested string capability couldn't be found, -2 if a system
907 * error was encountered (storage allocation failure).
910 cgetustr(char *buf, const char *cap, char **str)
918 * Find string capability cap
920 if ((bp = cgetcap(buf, cap, '=')) == NULL)
924 * Conversion / storage allocation loop ... Allocate memory in
925 * chunks SFRAG in size.
927 if ((mem = malloc(SFRAG)) == NULL) {
929 return (-2); /* couldn't even allocate the first fragment */
934 while (*bp != ':' && *bp != '\0') {
937 * There is always room for one more character in mem.
938 * Mp always points just past last character in mem.
939 * Bp always points at next character in buf.
945 * Enforce loop invariant: if no room left in current
946 * buffer, try to get some more.
949 size_t size = mp - mem;
951 if ((mem = reallocf(mem, size + SFRAG)) == NULL)
957 *mp++ = '\0'; /* loop invariant let's us do this */
962 * Give back any extra memory and return value and success.
965 if ((mem = reallocf(mem, (size_t)(mp - mem))) == NULL)
972 * Cgetnum retrieves the value of the numeric capability cap from the
973 * capability record pointed to by buf. The numeric value is returned in
974 * the long pointed to by num. 0 is returned on success, -1 if the requested
975 * numeric capability couldn't be found.
978 cgetnum(char *buf, const char *cap, long *num)
985 * Find numeric capability cap
987 bp = cgetcap(buf, cap, '#');
992 * Look at value and determine numeric base:
993 * 0x... or 0X... hexadecimal,
999 if (*bp == 'x' || *bp == 'X') {
1008 * Conversion loop ...
1012 if ('0' <= *bp && *bp <= '9')
1014 else if ('a' <= *bp && *bp <= 'f')
1015 digit = 10 + *bp - 'a';
1016 else if ('A' <= *bp && *bp <= 'F')
1017 digit = 10 + *bp - 'A';
1024 n = n * base + digit;
1029 * Return value and success.
1037 * Compare name field of record.
1040 nfcmp(char *nf, char *rec)
1045 for (cp = rec; *cp != ':'; cp++)
1050 ret = strcmp(nf, rec);