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 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * $FreeBSD: src/lib/libc/gen/getcap.c,v 1.11.2.2 2001/01/15 06:48:09 gad Exp $
39 #if defined(LIBC_SCCS) && !defined(lint)
40 static char sccsid[] = "@(#)getcap.c 8.3 (Berkeley) 3/25/94";
41 #endif /* LIBC_SCCS and not lint */
43 #include <sys/types.h>
57 #define ESC ('[' & 037) /* ASCII ESC */
58 #define MAX_RECURSION 32 /* maximum getent recursion */
59 #define SFRAG 100 /* cgetstr mallocs in SFRAG chunks */
63 #define SHADOW (char)2
65 static size_t topreclen; /* toprec length */
66 static char *toprec; /* Additional record specified by cgetset() */
67 static int gottoprec; /* Flag indicating retrieval of toprecord */
69 static int cdbget __P((DB *, char **, char *));
70 static int getent __P((char **, u_int *, char **, int, char *, int, char *));
71 static int nfcmp __P((char *, char *));
74 * Cgetset() allows the addition of a user specified buffer to be added
75 * to the database array, in effect "pushing" the buffer on top of the
76 * virtual database. 0 is returned on success, -1 on failure.
89 topreclen = strlen(ent);
90 if ((toprec = malloc (topreclen + 1)) == NULL) {
95 (void)strcpy(toprec, ent);
100 * Cgetcap searches the capability record buf for the capability cap with
101 * type `type'. A pointer to the value of cap is returned on success, NULL
102 * if the requested capability couldn't be found.
104 * Specifying a type of ':' means that nothing should follow cap (:cap:).
105 * In this case a pointer to the terminating ':' or NUL will be returned if
108 * If (cap, '@') or (cap, terminator, '@') is found before (cap, terminator)
112 cgetcap(buf, cap, type)
116 register char *bp, *cp;
121 * Skip past the current capability field - it's either the
122 * name field if this is the first time through the loop, or
123 * the remainder of a field whose name failed to match cap.
133 * Try to match (cap, type) in buf.
135 for (cp = cap; *cp == *bp && *bp != '\0'; cp++, bp++)
142 if (*bp != '\0' && *bp != ':')
149 return (*bp == '@' ? NULL : bp);
155 * Cgetent extracts the capability record name from the NULL terminated file
156 * array db_array and returns a pointer to a malloc'd copy of it in buf.
157 * Buf must be retained through all subsequent calls to cgetcap, cgetnum,
158 * cgetflag, and cgetstr, but may then be free'd. 0 is returned on success,
159 * -1 if the requested record couldn't be found, -2 if a system error was
160 * encountered (couldn't open/read a file, etc.), and -3 if a potential
161 * reference loop is detected.
164 cgetent(buf, db_array, name)
165 char **buf, **db_array, *name;
169 return (getent(buf, &dummy, db_array, -1, name, 0, NULL));
173 * Getent implements the functions of cgetent. If fd is non-negative,
174 * *db_array has already been opened and fd is the open file descriptor. We
175 * do this to save time and avoid using up file descriptors for tc=
178 * Getent returns the same success/failure codes as cgetent. On success, a
179 * pointer to a malloc'ed capability record with all tc= capabilities fully
180 * expanded and its length (not including trailing ASCII NUL) are left in
184 * + Allocate memory incrementally as needed in chunks of size BFRAG
185 * for capability buffer.
186 * + Recurse for each tc=name and interpolate result. Stop when all
187 * names interpolated, a name can't be found, or depth exceeds
191 getent(cap, len, db_array, fd, name, depth, nfield)
192 char **cap, **db_array, *name, *nfield;
197 register char *r_end, *rp, **db_p;
198 int myfd, eof, foundit, retval, clen;
201 char pbuf[_POSIX_PATH_MAX];
204 * Return with ``loop detected'' error if we've recursed more than
205 * MAX_RECURSION times.
207 if (depth > MAX_RECURSION)
211 * Check if we have a top record from cgetset().
213 if (depth == 0 && toprec != NULL && cgetmatch(toprec, name) == 0) {
214 if ((record = malloc (topreclen + BFRAG)) == NULL) {
218 (void)strcpy(record, toprec);
221 rp = record + topreclen + 1;
226 * Allocate first chunk of memory.
228 if ((record = malloc(BFRAG)) == NULL) {
232 r_end = record + BFRAG;
235 * Loop through database array until finding the record.
238 for (db_p = db_array; *db_p != NULL; db_p++) {
242 * Open database if not already open.
246 (void)lseek(fd, (off_t)0, SEEK_SET);
249 (void)snprintf(pbuf, sizeof(pbuf), "%s.db", *db_p);
250 if ((capdbp = dbopen(pbuf, O_RDONLY, 0, DB_HASH, 0))
253 retval = cdbget(capdbp, &record, name);
255 /* no record available */
256 (void)capdbp->close(capdbp);
259 /* save the data; close frees it */
260 clen = strlen(record);
261 cbuf = malloc(clen + 1);
262 memcpy(cbuf, record, clen + 1);
263 if (capdbp->close(capdbp) < 0) {
271 fd = _open(*db_p, O_RDONLY, 0);
278 * Find the requested capability record ...
282 register char *b_end, *bp;
287 * There is always room for one more character in record.
288 * R_end always points just past end of record.
289 * Rp always points just past last character in record.
290 * B_end always points just past last character in buf.
291 * Bp always points at next character in buf.
298 * Read in a line implementing (\, newline)
306 n = _read(fd, buf, sizeof(buf));
325 if (rp > record && *(rp-1) == '\\') {
334 * Enforce loop invariant: if no room
335 * left in record buffer, try to get
343 newsize = r_end - record + BFRAG;
344 record = reallocf(record, newsize);
345 if (record == NULL) {
351 r_end = record + newsize;
355 /* loop invariant let's us do this */
359 * If encountered eof check next file.
365 * Toss blank lines and comments.
367 if (*record == '\0' || *record == '#')
371 * See if this is the record we want ...
373 if (cgetmatch(record, name) == 0) {
374 if (nfield == NULL || !nfcmp(nfield, record)) {
376 break; /* found it! */
391 * Got the capability record, but now we have to expand all tc=name
392 * references in it ...
395 register char *newicap, *s;
396 register int newilen;
398 int diff, iret, tclen;
399 char *icap, *scan, *tc, *tcstart, *tcend;
403 * There is room for one more character in record.
404 * R_end points just past end of record.
405 * Rp points just past last character in record.
406 * Scan points at remainder of record that needs to be
407 * scanned for tc=name constructs.
412 if ((tc = cgetcap(scan, "tc", '=')) == NULL)
416 * Find end of tc=name and stomp on the trailing `:'
417 * (if present) so we can use it to call ourselves.
432 iret = getent(&icap, &ilen, db_p, fd, tc, depth+1,
434 newicap = icap; /* Put into a register. */
446 /* couldn't resolve tc */
455 /* not interested in name field of tc'ed record */
463 newilen -= s - newicap;
466 /* make sure interpolated record is `:'-terminated */
469 *s = ':'; /* overwrite NUL with : */
474 * Make sure there's enough room to insert the
477 diff = newilen - tclen;
478 if (diff >= r_end - rp) {
479 u_int pos, tcpos, tcposend;
483 newsize = r_end - record + diff + BFRAG;
484 tcpos = tcstart - record;
485 tcposend = tcend - record;
486 record = reallocf(record, newsize);
487 if (record == NULL) {
494 r_end = record + newsize;
496 tcstart = record + tcpos;
497 tcend = record + tcposend;
501 * Insert tc'ed record into our record.
503 s = tcstart + newilen;
504 bcopy(tcend, s, rp - tcend);
505 bcopy(newicap, tcstart, newilen);
510 * Start scan on `:' so next cgetcap works properly
511 * (cgetcap always skips first field).
518 * Close file (if we opened it), give back any extra memory, and
519 * return capability, length and success.
523 *len = rp - record - 1; /* don't count NUL */
526 reallocf(record, (size_t)(rp - record))) == NULL) {
538 cdbget(capdbp, bp, name)
545 key.size = strlen(name);
548 /* Get the reference. */
549 switch(capdbp->get(capdbp, &key, &data, 0)) {
556 /* If not an index to another record, leave. */
557 if (((char *)data.data)[0] != SHADOW)
560 key.data = (char *)data.data + 1;
561 key.size = data.size - 1;
564 *bp = (char *)data.data + 1;
565 return (((char *)(data.data))[0] == TCERR ? 1 : 0);
569 * Cgetmatch will return 0 if name is one of the names of the capability
570 * record buf, -1 if not.
576 register char *np, *bp;
579 * Start search at beginning of record.
584 * Try to match a record name.
589 if (*bp == '|' || *bp == ':' || *bp == '\0')
598 * Match failed, skip to next name in record.
600 bp--; /* a '|' or ':' may have stopped the match */
602 if (*bp == '\0' || *bp == ':')
603 return (-1); /* match failed totally */
606 break; /* found next name */
615 cgetfirst(buf, db_array)
616 char **buf, **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(bp, db_array)
650 int done, hadreaderr, i, savederrno, status;
651 char *cp, *line, *rp, *np, buf[BSIZE], nbuf[BSIZE];
657 if (pfp == NULL && (pfp = fopen(*dbp, "r")) == NULL) {
662 if (toprec && !gottoprec) {
666 line = fgetln(pfp, &len);
667 if (line == NULL && pfp) {
668 hadreaderr = ferror(pfp);
678 if (*++dbp == NULL) {
682 fopen(*dbp, "r")) == NULL) {
689 line[len - 1] = '\0';
694 if (isspace((unsigned char)*line) ||
695 *line == ':' || *line == '#' || slash) {
696 if (line[len - 2] == '\\')
702 if (line[len - 2] == '\\')
710 * Line points to a name line.
716 for (cp = line; *cp != '\0'; cp++) {
729 } else { /* name field extends beyond the line */
730 line = fgetln(pfp, &len);
731 if (line == NULL && pfp) {
732 /* Name extends beyond the EOF! */
733 hadreaderr = ferror(pfp);
747 line[len - 1] = '\0';
751 for(cp = nbuf; *cp != '\0'; cp++)
752 if (*cp == '|' || *cp == ':')
760 * Last argument of getent here should be nbuf if we want true
761 * sequential access in the case of duplicates.
762 * With NULL, getent will return the first entry found
763 * rather than the duplicate entry record. This is a
764 * matter of semantics that should be resolved.
766 status = getent(bp, &dummy, db_array, -1, buf, 0, NULL);
767 if (status == -2 || status == -3)
776 * Cgetstr retrieves the value of the string capability cap from the
777 * capability record pointed to by buf. A pointer to a decoded, NUL
778 * terminated, malloc'd copy of the string is returned in the char *
779 * pointed to by str. The length of the string not including the trailing
780 * NUL is returned on success, -1 if the requested string capability
781 * couldn't be found, -2 if a system error was encountered (storage
782 * allocation failure).
785 cgetstr(buf, cap, str)
789 register u_int m_room;
790 register char *bp, *mp;
795 * Find string capability cap
797 bp = cgetcap(buf, cap, '=');
802 * Conversion / storage allocation loop ... Allocate memory in
803 * chunks SFRAG in size.
805 if ((mem = malloc(SFRAG)) == NULL) {
807 return (-2); /* couldn't even allocate the first fragment */
812 while (*bp != ':' && *bp != '\0') {
815 * There is always room for one more character in mem.
816 * Mp always points just past last character in mem.
817 * Bp always points at next character in buf.
821 if (*bp == ':' || *bp == '\0')
822 break; /* drop unfinished escape */
828 } else if (*bp == '\\') {
830 if (*bp == ':' || *bp == '\0')
831 break; /* drop unfinished escape */
832 if ('0' <= *bp && *bp <= '7') {
836 i = 3; /* maximum of three octal digits */
838 n = n * 8 + (*bp++ - '0');
839 } while (--i && '0' <= *bp && *bp <= '7');
842 else switch (*bp++) {
866 * Catches '\', '^', and
877 * Enforce loop invariant: if no room left in current
878 * buffer, try to get some more.
881 size_t size = mp - mem;
883 if ((mem = reallocf(mem, size + SFRAG)) == NULL)
889 *mp++ = '\0'; /* loop invariant let's us do this */
894 * Give back any extra memory and return value and success.
897 if ((mem = reallocf(mem, (size_t)(mp - mem))) == NULL)
904 * Cgetustr retrieves the value of the string capability cap from the
905 * capability record pointed to by buf. The difference between cgetustr()
906 * and cgetstr() is that cgetustr does not decode escapes but rather treats
907 * all characters literally. A pointer to a NUL terminated malloc'd
908 * copy of the string is returned in the char pointed to by str. The
909 * length of the string not including the trailing NUL is returned on success,
910 * -1 if the requested string capability couldn't be found, -2 if a system
911 * error was encountered (storage allocation failure).
914 cgetustr(buf, cap, str)
915 char *buf, *cap, **str;
917 register u_int m_room;
918 register char *bp, *mp;
923 * Find string capability cap
925 if ((bp = cgetcap(buf, cap, '=')) == NULL)
929 * Conversion / storage allocation loop ... Allocate memory in
930 * chunks SFRAG in size.
932 if ((mem = malloc(SFRAG)) == NULL) {
934 return (-2); /* couldn't even allocate the first fragment */
939 while (*bp != ':' && *bp != '\0') {
942 * There is always room for one more character in mem.
943 * Mp always points just past last character in mem.
944 * Bp always points at next character in buf.
950 * Enforce loop invariant: if no room left in current
951 * buffer, try to get some more.
954 size_t size = mp - mem;
956 if ((mem = reallocf(mem, size + SFRAG)) == NULL)
962 *mp++ = '\0'; /* loop invariant let's us do this */
967 * Give back any extra memory and return value and success.
970 if ((mem = reallocf(mem, (size_t)(mp - mem))) == NULL)
977 * Cgetnum retrieves the value of the numeric capability cap from the
978 * capability record pointed to by buf. The numeric value is returned in
979 * the long pointed to by num. 0 is returned on success, -1 if the requested
980 * numeric capability couldn't be found.
983 cgetnum(buf, cap, num)
988 register int base, digit;
992 * Find numeric capability cap
994 bp = cgetcap(buf, cap, '#');
999 * Look at value and determine numeric base:
1000 * 0x... or 0X... hexadecimal,
1006 if (*bp == 'x' || *bp == 'X') {
1015 * Conversion loop ...
1019 if ('0' <= *bp && *bp <= '9')
1021 else if ('a' <= *bp && *bp <= 'f')
1022 digit = 10 + *bp - 'a';
1023 else if ('A' <= *bp && *bp <= 'F')
1024 digit = 10 + *bp - 'A';
1031 n = n * base + digit;
1036 * Return value and success.
1044 * Compare name field of record.
1053 for (cp = rec; *cp != ':'; cp++)
1058 ret = strcmp(nf, rec);