1 /* $NetBSD: getcap.c,v 1.29 1999/03/29 09:27:29 abs Exp $ */
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Casey Leedom of Lawrence Livermore National Laboratory.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #include <sys/types.h>
41 #if defined(HAVE_DB_185_H)
43 #elif defined(HAVE_DB_H)
58 #define ESC ('[' & 037) /* ASCII ESC */
59 #define MAX_RECURSION 32 /* maximum getent recursion */
60 #define SFRAG 100 /* cgetstr mallocs in SFRAG chunks */
64 #define SHADOW (char)2
66 static size_t topreclen; /* toprec length */
67 static char *toprec; /* Additional record specified by cgetset() */
68 static int gottoprec; /* Flag indicating retrieval of toprecord */
71 * Don't use db support unless it's build into libc but we don't
72 * check for that now, so just disable the code.
74 #if defined(HAVE_DBOPEN) && defined(HAVE_DB_H)
80 static int cdbget (DB *, char **, const char *);
82 static int getent (char **, size_t *, char **, int, const char *, int, char *);
83 static int nfcmp (char *, char *);
86 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetset(const char *ent);
87 ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL cgetcap(char *buf, const char *cap, int type);
88 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetent(char **buf, char **db_array, const char *name);
89 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetmatch(const char *buf, const char *name);
90 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetclose(void);
92 int cgetfirst(char **buf, char **db_array);
93 int cgetnext(char **bp, char **db_array);
95 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetstr(char *buf, const char *cap, char **str);
96 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetustr(char *buf, const char *cap, char **str);
97 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL cgetnum(char *buf, const char *cap, long *num);
99 * Cgetset() allows the addition of a user specified buffer to be added
100 * to the database array, in effect "pushing" the buffer on top of the
101 * virtual database. 0 is returned on success, -1 on failure.
103 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
104 cgetset(const char *ent)
106 const char *source, *check;
116 topreclen = strlen(ent);
117 if ((toprec = malloc (topreclen + 1)) == NULL) {
125 while (*source) { /* Strip whitespace */
126 *dest++ = *source++; /* Do not check first field */
127 while (*source == ':') {
129 while (*check && (isspace((unsigned char)*check) ||
130 (*check=='\\' && isspace((unsigned char)check[1]))))
145 * Cgetcap searches the capability record buf for the capability cap with
146 * type `type'. A pointer to the value of cap is returned on success, NULL
147 * if the requested capability couldn't be found.
149 * Specifying a type of ':' means that nothing should follow cap (:cap:).
150 * In this case a pointer to the terminating ':' or NUL will be returned if
153 * If (cap, '@') or (cap, terminator, '@') is found before (cap, terminator)
156 ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL
157 cgetcap(char *buf, const char *cap, int type)
165 * Skip past the current capability field - it's either the
166 * name field if this is the first time through the loop, or
167 * the remainder of a field whose name failed to match cap.
177 * Try to match (cap, type) in buf.
179 for (cp = cap; *cp == *bp && *bp != '\0'; cp++, bp++)
186 if (*bp != '\0' && *bp != ':')
193 return (*bp == '@' ? NULL : bp);
199 * Cgetent extracts the capability record name from the NULL terminated file
200 * array db_array and returns a pointer to a malloc'd copy of it in buf.
201 * Buf must be retained through all subsequent calls to cgetcap, cgetnum,
202 * cgetflag, and cgetstr, but may then be free'd. 0 is returned on success,
203 * -1 if the requested record couldn't be found, -2 if a system error was
204 * encountered (couldn't open/read a file, etc.), and -3 if a potential
205 * reference loop is detected.
207 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
208 cgetent(char **buf, char **db_array, const char *name)
212 return (getent(buf, &dummy, db_array, -1, name, 0, NULL));
216 * Getent implements the functions of cgetent. If fd is non-negative,
217 * *db_array has already been opened and fd is the open file descriptor. We
218 * do this to save time and avoid using up file descriptors for tc=
221 * Getent returns the same success/failure codes as cgetent. On success, a
222 * pointer to a malloc'ed capability record with all tc= capabilities fully
223 * expanded and its length (not including trailing ASCII NUL) are left in
227 * + Allocate memory incrementally as needed in chunks of size BFRAG
228 * for capability buffer.
229 * + Recurse for each tc=name and interpolate result. Stop when all
230 * names interpolated, a name can't be found, or depth exceeds
234 getent(char **cap, size_t *len, char **db_array, int fd,
235 const char *name, int depth, char *nfield)
237 char *r_end, *rp = NULL, **db_p; /* pacify gcc */
238 int myfd = 0, eof, foundit;
243 * Return with ``loop detected'' error if we've recursed more than
244 * MAX_RECURSION times.
246 if (depth > MAX_RECURSION)
250 * Check if we have a top record from cgetset().
252 if (depth == 0 && toprec != NULL && cgetmatch(toprec, name) == 0) {
253 size_t len = topreclen + BFRAG;
254 if ((record = malloc (len)) == NULL) {
258 (void)strlcpy(record, toprec, len);
260 rp = record + topreclen + 1;
265 * Allocate first chunk of memory.
267 if ((record = malloc(BFRAG)) == NULL) {
271 r_end = record + BFRAG;
274 * Loop through database array until finding the record.
277 for (db_p = db_array; *db_p != NULL; db_p++) {
281 * Open database if not already open.
285 (void)lseek(fd, (off_t)0, SEEK_SET);
288 char pbuf[_POSIX_PATH_MAX];
294 (void)snprintf(pbuf, sizeof(pbuf), "%s.db", *db_p);
295 if ((capdbp = dbopen(pbuf, O_RDONLY, 0, DB_HASH, 0))
298 retval = cdbget(capdbp, &record, name);
300 /* no record available */
301 (void)capdbp->close(capdbp);
304 /* save the data; close frees it */
305 clen = strlen(record);
306 cbuf = malloc(clen + 1);
309 memmove(cbuf, record, clen + 1);
310 if (capdbp->close(capdbp) < 0) {
320 fd = open(*db_p, O_RDONLY, 0);
322 /* No error on unfound file. */
329 * Find the requested capability record ...
333 char *b_end, *bp, *cp;
338 * There is always room for one more character in record.
339 * R_end always points just past end of record.
340 * Rp always points just past last character in record.
341 * B_end always points just past last character in buf.
342 * Bp always points at next character in buf.
343 * Cp remembers where the last colon was.
352 * Read in a line implementing (\, newline)
360 n = read(fd, buf, sizeof(buf));
392 * If the field was `empty' (i.e.
393 * contained only white space), back up
394 * to the colon (eliminating the
401 } else if (c == '\\') {
403 } else if (c != ' ' && c != '\t') {
405 * Forget where the colon was, as this
406 * is not an empty field.
413 * Enforce loop invariant: if no room
414 * left in record buffer, try to get
422 newsize = r_end - record + BFRAG;
423 record = realloc(record, newsize);
424 if (record == NULL) {
430 r_end = record + newsize;
434 /* Eliminate any white space after the last colon. */
437 /* Loop invariant lets us do this. */
441 * If encountered eof check next file.
447 * Toss blank lines and comments.
449 if (*record == '\0' || *record == '#')
453 * See if this is the record we want ...
455 if (cgetmatch(record, name) == 0) {
456 if (nfield == NULL || !nfcmp(nfield, record)) {
458 break; /* found it! */
471 * Got the capability record, but now we have to expand all tc=name
472 * references in it ...
476 size_t ilen, newilen;
477 int diff, iret, tclen;
478 char *icap, *scan, *tc, *tcstart, *tcend;
482 * There is room for one more character in record.
483 * R_end points just past end of record.
484 * Rp points just past last character in record.
485 * Scan points at remainder of record that needs to be
486 * scanned for tc=name constructs.
491 if ((tc = cgetcap(scan, "tc", '=')) == NULL)
495 * Find end of tc=name and stomp on the trailing `:'
496 * (if present) so we can use it to call ourselves.
511 iret = getent(&icap, &ilen, db_p, fd, tc, depth+1,
513 newicap = icap; /* Put into a register. */
525 /* couldn't resolve tc */
534 /* not interested in name field of tc'ed record */
542 newilen -= s - newicap;
545 /* make sure interpolated record is `:'-terminated */
548 *s = ':'; /* overwrite NUL with : */
553 * Make sure there's enough room to insert the
556 diff = newilen - tclen;
557 if (diff >= r_end - rp) {
558 u_int pos, tcpos, tcposend;
562 newsize = r_end - record + diff + BFRAG;
563 tcpos = tcstart - record;
564 tcposend = tcend - record;
565 record = realloc(record, newsize);
566 if (record == NULL) {
573 r_end = record + newsize;
575 tcstart = record + tcpos;
576 tcend = record + tcposend;
580 * Insert tc'ed record into our record.
582 s = tcstart + newilen;
583 memmove(s, tcend, (size_t)(rp - tcend));
584 memmove(tcstart, newicap, newilen);
589 * Start scan on `:' so next cgetcap works properly
590 * (cgetcap always skips first field).
597 * Close file (if we opened it), give back any extra memory, and
598 * return capability, length and success.
602 *len = rp - record - 1; /* don't count NUL */
605 realloc(record, (size_t)(rp - record))) == NULL) {
618 cdbget(DB *capdbp, char **bp, const char *name)
623 /* LINTED key is not modified */
624 key.data = (char *)name;
625 key.size = strlen(name);
628 /* Get the reference. */
629 switch(capdbp->get(capdbp, &key, &data, 0)) {
636 /* If not an index to another record, leave. */
637 if (((char *)data.data)[0] != SHADOW)
640 key.data = (char *)data.data + 1;
641 key.size = data.size - 1;
644 *bp = (char *)data.data + 1;
645 return (((char *)(data.data))[0] == TCERR ? 1 : 0);
650 * Cgetmatch will return 0 if name is one of the names of the capability
651 * record buf, -1 if not.
654 cgetmatch(const char *buf, const char *name)
659 * Start search at beginning of record.
664 * Try to match a record name.
669 if (*bp == '|' || *bp == ':' || *bp == '\0')
678 * Match failed, skip to next name in record.
680 bp--; /* a '|' or ':' may have stopped the match */
682 if (*bp == '\0' || *bp == ':')
683 return (-1); /* match failed totally */
686 break; /* found next name */
692 cgetfirst(char **buf, char **db_array)
695 return (cgetnext(buf, db_array));
703 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
718 * Cgetnext() gets either the first or next entry in the logical database
719 * specified by db_array. It returns 0 upon completion of the database, 1
720 * upon returning an entry with more remaining, and -1 if an error occurs.
723 cgetnext(char **bp, char **db_array)
727 char *cp, *line, *rp, *np, buf[BSIZE], nbuf[BSIZE];
733 if (pfp == NULL && (pfp = fopen(*dbp, "r")) == NULL) {
738 if (toprec && !gottoprec) {
742 line = fgetln(pfp, &len);
743 if (line == NULL && pfp) {
750 if (*++dbp == NULL) {
754 fopen(*dbp, "r")) == NULL) {
761 line[len - 1] = '\0';
766 if (isspace((unsigned char)*line) ||
767 *line == ':' || *line == '#' || slash) {
768 if (line[len - 2] == '\\')
774 if (line[len - 2] == '\\')
782 * Line points to a name line.
787 for (cp = line; *cp != '\0'; cp++) {
800 } else { /* name field extends beyond the line */
801 line = fgetln(pfp, &len);
802 if (line == NULL && pfp) {
812 line[len - 1] = '\0';
816 for(cp = nbuf; *cp != '\0'; cp++)
817 if (*cp == '|' || *cp == ':')
825 * Last argument of getent here should be nbuf if we want true
826 * sequential access in the case of duplicates.
827 * With NULL, getent will return the first entry found
828 * rather than the duplicate entry record. This is a
829 * matter of semantics that should be resolved.
831 status = getent(bp, &dummy, db_array, -1, buf, 0, NULL);
832 if (status == -2 || status == -3)
842 * Cgetstr retrieves the value of the string capability cap from the
843 * capability record pointed to by buf. A pointer to a decoded, NUL
844 * terminated, malloc'd copy of the string is returned in the char *
845 * pointed to by str. The length of the string not including the trailing
846 * NUL is returned on success, -1 if the requested string capability
847 * couldn't be found, -2 if a system error was encountered (storage
848 * allocation failure).
850 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
851 cgetstr(char *buf, const char *cap, char **str)
862 * Find string capability cap
864 bp = cgetcap(buf, cap, '=');
869 * Conversion / storage allocation loop ... Allocate memory in
870 * chunks SFRAG in size.
872 if ((mem = malloc(SFRAG)) == NULL) {
874 return (-2); /* couldn't even allocate the first fragment */
879 while (*bp != ':' && *bp != '\0') {
882 * There is always room for one more character in mem.
883 * Mp always points just past last character in mem.
884 * Bp always points at next character in buf.
888 if (*bp == ':' || *bp == '\0')
889 break; /* drop unfinished escape */
891 } else if (*bp == '\\') {
893 if (*bp == ':' || *bp == '\0')
894 break; /* drop unfinished escape */
895 if ('0' <= *bp && *bp <= '7') {
899 i = 3; /* maximum of three octal digits */
901 n = n * 8 + (*bp++ - '0');
902 } while (--i && '0' <= *bp && *bp <= '7');
905 else switch (*bp++) {
929 * Catches '\', '^', and
940 * Enforce loop invariant: if no room left in current
941 * buffer, try to get some more.
944 size_t size = mp - mem;
946 if ((nmem = realloc(mem, size + SFRAG)) == NULL) {
955 *mp++ = '\0'; /* loop invariant let's us do this */
960 * Give back any extra memory and return value and success.
963 if ((nmem = realloc(mem, (size_t)(mp - mem))) == NULL) {
974 * Cgetustr retrieves the value of the string capability cap from the
975 * capability record pointed to by buf. The difference between cgetustr()
976 * and cgetstr() is that cgetustr does not decode escapes but rather treats
977 * all characters literally. A pointer to a NUL terminated malloc'd
978 * copy of the string is returned in the char pointed to by str. The
979 * length of the string not including the trailing NUL is returned on success,
980 * -1 if the requested string capability couldn't be found, -2 if a system
981 * error was encountered (storage allocation failure).
983 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
984 cgetustr(char *buf, const char *cap, char **str)
993 * Find string capability cap
995 if ((bp = cgetcap(buf, cap, '=')) == NULL)
999 * Conversion / storage allocation loop ... Allocate memory in
1000 * chunks SFRAG in size.
1002 if ((mem = malloc(SFRAG)) == NULL) {
1004 return (-2); /* couldn't even allocate the first fragment */
1009 while (*bp != ':' && *bp != '\0') {
1012 * There is always room for one more character in mem.
1013 * Mp always points just past last character in mem.
1014 * Bp always points at next character in buf.
1020 * Enforce loop invariant: if no room left in current
1021 * buffer, try to get some more.
1024 size_t size = mp - mem;
1026 if ((mem = realloc(mem, size + SFRAG)) == NULL)
1032 *mp++ = '\0'; /* loop invariant let's us do this */
1037 * Give back any extra memory and return value and success.
1040 if ((mem = realloc(mem, (size_t)(mp - mem))) == NULL)
1047 * Cgetnum retrieves the value of the numeric capability cap from the
1048 * capability record pointed to by buf. The numeric value is returned in
1049 * the long pointed to by num. 0 is returned on success, -1 if the requested
1050 * numeric capability couldn't be found.
1052 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
1053 cgetnum(char *buf, const char *cap, long *num)
1060 * Find numeric capability cap
1062 bp = cgetcap(buf, cap, '#');
1067 * Look at value and determine numeric base:
1068 * 0x... or 0X... hexadecimal,
1074 if (*bp == 'x' || *bp == 'X') {
1083 * Conversion loop ...
1087 if ('0' <= *bp && *bp <= '9')
1089 else if ('a' <= *bp && *bp <= 'f')
1090 digit = 10 + *bp - 'a';
1091 else if ('A' <= *bp && *bp <= 'F')
1092 digit = 10 + *bp - 'A';
1099 n = n * base + digit;
1104 * Return value and success.
1112 * Compare name field of record.
1115 nfcmp(char *nf, char *rec)
1120 for (cp = rec; *cp != ':'; cp++)
1125 ret = strcmp(nf, rec);