]>
git.saurik.com Git - apple/libc.git/blob - gen/getcap.c
2 * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
20 * @APPLE_LICENSE_HEADER_END@
23 * Copyright (c) 1992, 1993
24 * The Regents of the University of California. All rights reserved.
26 * This code is derived from software contributed to Berkeley by
27 * Casey Leedom of Lawrence Livermore National Laboratory.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
32 * 1. Redistributions of source code must retain the above copyright
33 * notice, this list of conditions and the following disclaimer.
34 * 2. Redistributions in binary form must reproduce the above copyright
35 * notice, this list of conditions and the following disclaimer in the
36 * documentation and/or other materials provided with the distribution.
37 * 3. All advertising materials mentioning features or use of this software
38 * must display the following acknowledgement:
39 * This product includes software developed by the University of
40 * California, Berkeley and its contributors.
41 * 4. Neither the name of the University nor the names of its contributors
42 * may be used to endorse or promote products derived from this software
43 * without specific prior written permission.
45 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 #if defined(LIBC_SCCS) && !defined(lint)
59 static char rcsid
[] = "$OpenBSD: getcap.c,v 1.4 1997/02/01 04:35:33 deraadt Exp $";
60 #endif /* LIBC_SCCS and not lint */
62 #include <sys/types.h>
76 #define ESC ('[' & 037) /* ASCII ESC */
77 #define MAX_RECURSION 32 /* maximum getent recursion */
78 #define SFRAG 100 /* cgetstr mallocs in SFRAG chunks */
82 #define SHADOW (char)2
84 static size_t topreclen
; /* toprec length */
85 static char *toprec
; /* Additional record specified by cgetset() */
86 static int gottoprec
; /* Flag indicating retrieval of toprecord */
88 static int cdbget
__P((DB
*, char **, char *));
89 static int getent
__P((char **, u_int
*, char **, int, char *, int, char *));
90 static int nfcmp
__P((char *, char *));
93 * Cgetset() allows the addition of a user specified buffer to be added
94 * to the database array, in effect "pushing" the buffer on top of the
95 * virtual database. 0 is returned on success, -1 on failure.
108 topreclen
= strlen(ent
);
109 if ((toprec
= malloc (topreclen
+ 1)) == NULL
) {
114 (void)strcpy(toprec
, ent
);
119 * Cgetcap searches the capability record buf for the capability cap with
120 * type `type'. A pointer to the value of cap is returned on success, NULL
121 * if the requested capability couldn't be found.
123 * Specifying a type of ':' means that nothing should follow cap (:cap:).
124 * In this case a pointer to the terminating ':' or NUL will be returned if
127 * If (cap, '@') or (cap, terminator, '@') is found before (cap, terminator)
131 cgetcap(buf
, cap
, type
)
135 register char *bp
, *cp
;
140 * Skip past the current capability field - it's either the
141 * name field if this is the first time through the loop, or
142 * the remainder of a field whose name failed to match cap.
152 * Try to match (cap, type) in buf.
154 for (cp
= cap
; *cp
== *bp
&& *bp
!= '\0'; cp
++, bp
++)
161 if (*bp
!= '\0' && *bp
!= ':')
168 return (*bp
== '@' ? NULL
: bp
);
174 * Cgetent extracts the capability record name from the NULL terminated file
175 * array db_array and returns a pointer to a malloc'd copy of it in buf.
176 * Buf must be retained through all subsequent calls to cgetcap, cgetnum,
177 * cgetflag, and cgetstr, but may then be free'd. 0 is returned on success,
178 * -1 if the requested record couldn't be found, -2 if a system error was
179 * encountered (couldn't open/read a file, etc.), and -3 if a potential
180 * reference loop is detected.
183 cgetent(buf
, db_array
, name
)
184 char **buf
, **db_array
, *name
;
188 return (getent(buf
, &dummy
, db_array
, -1, name
, 0, NULL
));
192 * Getent implements the functions of cgetent. If fd is non-negative,
193 * *db_array has already been opened and fd is the open file descriptor. We
194 * do this to save time and avoid using up file descriptors for tc=
197 * Getent returns the same success/failure codes as cgetent. On success, a
198 * pointer to a malloc'ed capability record with all tc= capabilities fully
199 * expanded and its length (not including trailing ASCII NUL) are left in
203 * + Allocate memory incrementally as needed in chunks of size BFRAG
204 * for capability buffer.
205 * + Recurse for each tc=name and interpolate result. Stop when all
206 * names interpolated, a name can't be found, or depth exceeds
210 getent(cap
, len
, db_array
, fd
, name
, depth
, nfield
)
211 char **cap
, **db_array
, *name
, *nfield
;
216 register char *r_end
, *rp
, **db_p
;
217 int myfd
, eof
, foundit
, retval
, clen
;
220 char pbuf
[_POSIX_PATH_MAX
];
223 * Return with ``loop detected'' error if we've recursed more than
224 * MAX_RECURSION times.
226 if (depth
> MAX_RECURSION
)
230 * Check if we have a top record from cgetset().
232 if (depth
== 0 && toprec
!= NULL
&& cgetmatch(toprec
, name
) == 0) {
233 if ((record
= malloc (topreclen
+ BFRAG
)) == NULL
) {
237 (void)strcpy(record
, toprec
);
240 rp
= record
+ topreclen
+ 1;
245 * Allocate first chunk of memory.
247 if ((record
= malloc(BFRAG
)) == NULL
) {
251 r_end
= record
+ BFRAG
;
254 * Loop through database array until finding the record.
257 for (db_p
= db_array
; *db_p
!= NULL
; db_p
++) {
261 * Open database if not already open.
265 (void)lseek(fd
, (off_t
)0, SEEK_SET
);
268 (void)snprintf(pbuf
, sizeof(pbuf
), "%s.db", *db_p
);
269 if ((capdbp
= dbopen(pbuf
, O_RDONLY
, 0, DB_HASH
, 0))
272 retval
= cdbget(capdbp
, &record
, name
);
274 /* no record available */
275 (void)capdbp
->close(capdbp
);
278 /* save the data; close frees it */
279 clen
= strlen(record
);
280 cbuf
= malloc(clen
+ 1);
281 memcpy(cbuf
, record
, clen
+ 1);
282 if (capdbp
->close(capdbp
) < 0) {
290 fd
= open(*db_p
, O_RDONLY
, 0);
292 /* No error on unfound file. */
299 * Find the requested capability record ...
303 register char *b_end
, *bp
;
308 * There is always room for one more character in record.
309 * R_end always points just past end of record.
310 * Rp always points just past last character in record.
311 * B_end always points just past last character in buf.
312 * Bp always points at next character in buf.
319 * Read in a line implementing (\, newline)
327 n
= read(fd
, buf
, sizeof(buf
));
346 if (rp
> record
&& *(rp
-1) == '\\') {
355 * Enforce loop invariant: if no room
356 * left in record buffer, try to get
364 newsize
= r_end
- record
+ BFRAG
;
365 record
= realloc(record
, newsize
);
366 if (record
== NULL
) {
372 r_end
= record
+ newsize
;
376 /* loop invariant let's us do this */
380 * If encountered eof check next file.
386 * Toss blank lines and comments.
388 if (*record
== '\0' || *record
== '#')
392 * See if this is the record we want ...
394 if (cgetmatch(record
, name
) == 0) {
395 if (nfield
== NULL
|| !nfcmp(nfield
, record
)) {
397 break; /* found it! */
412 * Got the capability record, but now we have to expand all tc=name
413 * references in it ...
416 register char *newicap
, *s
;
417 register int newilen
;
419 int diff
, iret
, tclen
;
420 char *icap
, *scan
, *tc
, *tcstart
, *tcend
;
424 * There is room for one more character in record.
425 * R_end points just past end of record.
426 * Rp points just past last character in record.
427 * Scan points at remainder of record that needs to be
428 * scanned for tc=name constructs.
433 if ((tc
= cgetcap(scan
, "tc", '=')) == NULL
)
437 * Find end of tc=name and stomp on the trailing `:'
438 * (if present) so we can use it to call ourselves.
453 iret
= getent(&icap
, &ilen
, db_p
, fd
, tc
, depth
+1,
455 newicap
= icap
; /* Put into a register. */
467 /* couldn't resolve tc */
476 /* not interested in name field of tc'ed record */
484 newilen
-= s
- newicap
;
487 /* make sure interpolated record is `:'-terminated */
490 *s
= ':'; /* overwrite NUL with : */
495 * Make sure there's enough room to insert the
498 diff
= newilen
- tclen
;
499 if (diff
>= r_end
- rp
) {
500 u_int pos
, tcpos
, tcposend
;
504 newsize
= r_end
- record
+ diff
+ BFRAG
;
505 tcpos
= tcstart
- record
;
506 tcposend
= tcend
- record
;
507 record
= realloc(record
, newsize
);
508 if (record
== NULL
) {
515 r_end
= record
+ newsize
;
517 tcstart
= record
+ tcpos
;
518 tcend
= record
+ tcposend
;
522 * Insert tc'ed record into our record.
524 s
= tcstart
+ newilen
;
525 bcopy(tcend
, s
, rp
- tcend
);
526 bcopy(newicap
, tcstart
, newilen
);
531 * Start scan on `:' so next cgetcap works properly
532 * (cgetcap always skips first field).
539 * Close file (if we opened it), give back any extra memory, and
540 * return capability, length and success.
544 *len
= rp
- record
- 1; /* don't count NUL */
547 realloc(record
, (size_t)(rp
- record
))) == NULL
) {
559 cdbget(capdbp
, bp
, name
)
566 key
.size
= strlen(name
);
569 /* Get the reference. */
570 switch(capdbp
->get(capdbp
, &key
, &data
, 0)) {
577 /* If not an index to another record, leave. */
578 if (((char *)data
.data
)[0] != SHADOW
)
581 key
.data
= (char *)data
.data
+ 1;
582 key
.size
= data
.size
- 1;
585 *bp
= (char *)data
.data
+ 1;
586 return (((char *)(data
.data
))[0] == TCERR
? 1 : 0);
590 * Cgetmatch will return 0 if name is one of the names of the capability
591 * record buf, -1 if not.
597 register char *np
, *bp
;
600 * Start search at beginning of record.
605 * Try to match a record name.
610 if (*bp
== '|' || *bp
== ':' || *bp
== '\0')
619 * Match failed, skip to next name in record.
621 bp
--; /* a '|' or ':' may have stopped the match */
623 if (*bp
== '\0' || *bp
== ':')
624 return (-1); /* match failed totally */
627 break; /* found next name */
636 cgetfirst(buf
, db_array
)
637 char **buf
, **db_array
;
640 return (cgetnext(buf
, db_array
));
661 * Cgetnext() gets either the first or next entry in the logical database
662 * specified by db_array. It returns 0 upon completion of the database, 1
663 * upon returning an entry with more remaining, and -1 if an error occurs.
666 cgetnext(bp
, db_array
)
672 char *cp
, *line
, *rp
, *np
, buf
[BSIZE
], nbuf
[BSIZE
];
678 if (pfp
== NULL
&& (pfp
= fopen(*dbp
, "r")) == NULL
) {
683 if (toprec
&& !gottoprec
) {
687 line
= fgetln(pfp
, &len
);
688 if (line
== NULL
&& pfp
) {
694 if (*++dbp
== NULL
) {
698 fopen(*dbp
, "r")) == NULL
) {
705 line
[len
- 1] = '\0';
710 if (isspace(*line
) ||
711 *line
== ':' || *line
== '#' || slash
) {
712 if (line
[len
- 2] == '\\')
718 if (line
[len
- 2] == '\\')
726 * Line points to a name line.
731 for (cp
= line
; *cp
!= '\0'; cp
++) {
744 } else { /* name field extends beyond the line */
745 line
= fgetln(pfp
, &len
);
746 if (line
== NULL
&& pfp
) {
753 line
[len
- 1] = '\0';
757 for(cp
= nbuf
; *cp
!= NULL
; cp
++)
758 if (*cp
== '|' || *cp
== ':')
766 * Last argument of getent here should be nbuf if we want true
767 * sequential access in the case of duplicates.
768 * With NULL, getent will return the first entry found
769 * rather than the duplicate entry record. This is a
770 * matter of semantics that should be resolved.
772 status
= getent(bp
, &dummy
, db_array
, -1, buf
, 0, NULL
);
773 if (status
== -2 || status
== -3)
782 * Cgetstr retrieves the value of the string capability cap from the
783 * capability record pointed to by buf. A pointer to a decoded, NUL
784 * terminated, malloc'd copy of the string is returned in the char *
785 * pointed to by str. The length of the string not including the trailing
786 * NUL is returned on success, -1 if the requested string capability
787 * couldn't be found, -2 if a system error was encountered (storage
788 * allocation failure).
791 cgetstr(buf
, cap
, str
)
795 register u_int m_room
;
796 register char *bp
, *mp
;
801 * Find string capability cap
803 bp
= cgetcap(buf
, cap
, '=');
808 * Conversion / storage allocation loop ... Allocate memory in
809 * chunks SFRAG in size.
811 if ((mem
= malloc(SFRAG
)) == NULL
) {
813 return (-2); /* couldn't even allocate the first fragment */
818 while (*bp
!= ':' && *bp
!= '\0') {
821 * There is always room for one more character in mem.
822 * Mp always points just past last character in mem.
823 * Bp always points at next character in buf.
827 if (*bp
== ':' || *bp
== '\0')
828 break; /* drop unfinished escape */
830 } else if (*bp
== '\\') {
832 if (*bp
== ':' || *bp
== '\0')
833 break; /* drop unfinished escape */
834 if ('0' <= *bp
&& *bp
<= '7') {
838 i
= 3; /* maximum of three octal digits */
840 n
= n
* 8 + (*bp
++ - '0');
841 } while (--i
&& '0' <= *bp
&& *bp
<= '7');
844 else switch (*bp
++) {
868 * Catches '\', '^', and
879 * Enforce loop invariant: if no room left in current
880 * buffer, try to get some more.
883 size_t size
= mp
- mem
;
885 if ((mem
= realloc(mem
, size
+ SFRAG
)) == NULL
)
891 *mp
++ = '\0'; /* loop invariant let's us do this */
896 * Give back any extra memory and return value and success.
899 if ((mem
= realloc(mem
, (size_t)(mp
- mem
))) == NULL
)
906 * Cgetustr retrieves the value of the string capability cap from the
907 * capability record pointed to by buf. The difference between cgetustr()
908 * and cgetstr() is that cgetustr does not decode escapes but rather treats
909 * all characters literally. A pointer to a NUL terminated malloc'd
910 * copy of the string is returned in the char pointed to by str. The
911 * length of the string not including the trailing NUL is returned on success,
912 * -1 if the requested string capability couldn't be found, -2 if a system
913 * error was encountered (storage allocation failure).
916 cgetustr(buf
, cap
, str
)
917 char *buf
, *cap
, **str
;
919 register u_int m_room
;
920 register char *bp
, *mp
;
925 * Find string capability cap
927 if ((bp
= cgetcap(buf
, cap
, '=')) == NULL
)
931 * Conversion / storage allocation loop ... Allocate memory in
932 * chunks SFRAG in size.
934 if ((mem
= malloc(SFRAG
)) == NULL
) {
936 return (-2); /* couldn't even allocate the first fragment */
941 while (*bp
!= ':' && *bp
!= '\0') {
944 * There is always room for one more character in mem.
945 * Mp always points just past last character in mem.
946 * Bp always points at next character in buf.
952 * Enforce loop invariant: if no room left in current
953 * buffer, try to get some more.
956 size_t size
= mp
- mem
;
958 if ((mem
= realloc(mem
, size
+ SFRAG
)) == NULL
)
964 *mp
++ = '\0'; /* loop invariant let's us do this */
969 * Give back any extra memory and return value and success.
972 if ((mem
= realloc(mem
, (size_t)(mp
- mem
))) == NULL
)
979 * Cgetnum retrieves the value of the numeric capability cap from the
980 * capability record pointed to by buf. The numeric value is returned in
981 * the long pointed to by num. 0 is returned on success, -1 if the requested
982 * numeric capability couldn't be found.
985 cgetnum(buf
, cap
, num
)
990 register int base
, digit
;
994 * Find numeric capability cap
996 bp
= cgetcap(buf
, cap
, '#');
1001 * Look at value and determine numeric base:
1002 * 0x... or 0X... hexadecimal,
1008 if (*bp
== 'x' || *bp
== 'X') {
1017 * Conversion loop ...
1021 if ('0' <= *bp
&& *bp
<= '9')
1023 else if ('a' <= *bp
&& *bp
<= 'f')
1024 digit
= 10 + *bp
- 'a';
1025 else if ('A' <= *bp
&& *bp
<= 'F')
1026 digit
= 10 + *bp
- 'A';
1033 n
= n
* base
+ digit
;
1038 * Return value and success.
1046 * Compare name field of record.
1055 for (cp
= rec
; *cp
!= ':'; cp
++)
1060 ret
= strcmp(nf
, rec
);