87afce0b16550096c42426649f7478d796a9c710
3 * $Id: netg.c,v 1.1 1997/08/07 09:45:00 mdw Exp $
5 * A local database of netgroups
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of `become'
14 * `Become' is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * `Become' is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with `become'; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Revision history --------------------------------------------------*
32 * Revision 1.1 1997/08/07 09:45:00 mdw
33 * New source file added to maintain a netgroups database.
37 /*----- Header files ------------------------------------------------------*/
39 /* --- ANSI headers --- */
46 /* --- Unix headers --- */
50 #include <sys/types.h>
54 # include <rpcsvc/ypclnt.h>
55 # include <rpcsvc/yp_prot.h>
58 #include <netinet/in.h>
60 #include <arpa/inet.h>
66 /* --- Local headers --- */
75 /*----- Type definitions --------------------------------------------------*/
77 /* --- Quick discussion --- *
79 * I've just noticed: netgroups are horrible. They form a directed graph
80 * which is really horrible; I'll have to try and turn it into something
81 * more sensible (which will essentially involve cutting cycles).
83 * The structure looks a little bit like a good ol' List (see Knuth 1 or
84 * any decent Lisp manual), but with more information in the cons cells.
87 /* --- @netg__cons@ --- */
89 typedef struct netg__cons
{
92 struct netg__cons
*cons
;
93 struct netg__atom
*atom
;
95 struct netg__cons
*cdr
;
99 f_cons
= 1, /* The @car@ is a cons cell */
100 f_visit
= 2, /* Currently threaded on this cell */
101 f_uncycled
= 4 /* Cycles removed from here on in */
104 /* --- @netg__atom@ --- */
106 typedef struct netg__atom
{
107 char *n
; /* Unresolved netgroup reference */
108 char *h
; /* Matched hostname */
109 char *u
; /* Matched user name */
110 char *d
; /* Matched domain name */
113 /* --- @netg__sym@ --- */
115 typedef struct netg__sym
{
120 /* --- Token types for the netgroup parser --- */
127 /*----- Static variables --------------------------------------------------*/
129 static sym_table netg__table
; /* Netgroup table */
130 static sym_iter netg__iter
; /* Iterator object for users */
132 /*----- Main code ---------------------------------------------------------*/
134 /* --- @netg__lex@ --- *
136 * Arguments: @const char **p@ = pointer to next unscanned character
137 * @char *q@ = pointer to output buffer
139 * Returns: Token type (either character code or a magic number).
141 * Use: Lexes a netgroups line into tokens.
144 static int netg__lex(char **p
, char *q
)
146 /* --- Skip any leading whitespace --- */
148 while (isspace((unsigned char)**p
))
151 /* --- Now work out what we've got --- */
155 if (**p
== '(' || **p
== ')' || **p
== ',')
159 while (**p
!= 0 && **p
!= '(' && **p
!= ')' &&
160 **p
!= ',' && !isspace((unsigned char)**p
));
165 /* --- @netg__foreach@ --- *
167 * Arguments: @int st@ = YP protocol-level status code
168 * @char *k@ = pointer to string containing the key
169 * @int ksz@ = length of the key string
170 * @char *v@ = pointer to string containing the value
171 * @int vsz@ = length of the value string
172 * @char *data@ = pointer to my data information
174 * Returns: Zero to continue, nonzero for no more entries.
176 * Use: Handles each incoming netgroup, attaching it to the table.
179 static int netg__foreach(int st
, char *k
, int ksz
,
180 char *v
, int vsz
, char *data
)
185 netg__cons
*c
, **link
;
189 /* --- If something is amiss, then quit now --- */
194 /* --- Ignore empty lines from the original file --- */
199 /* --- Build my own trashable copies of the key and value --- *
201 * Note the oddness when I copy the value string. The extra byte at the
202 * beginning allows me to use the same area of memory as an output buffer
203 * for the lexer. It must be big enough; the lexer doesn't back up; and
204 * that extra byte gives me somewhere to put a terminating null byte.
207 kc
= xmalloc(ksz
+ 1);
211 vc
= xmalloc(vsz
+ 2);
212 memcpy(vc
+ 1, v
, vsz
);
215 T( trace(TRACE_DEBUG
, "debug: netgroup `%s': `%s'", kc
, vc
+ 1); )
217 /* --- Allocate a symbol in my table --- */
219 sng
= sym_find(&netg__table
, kc
, -1, sizeof(*sng
), &f
);
223 /* --- Run to the end of the list --- */
225 for (link
= &sng
->cons
; *link
; link
= &((*link
)->cdr
))
228 /* --- Now start the tricky bit --- *
230 * I have to start parsing the netgroup value string. Oh, well, it
233 * The parser is written so as to avoid saying things more often than
234 * necessary. This tends to involve @goto@s. You've been warned.
238 t
= netg__lex(&p
, vc
);
242 /* --- Start with a fresh cons cell, with an empty atom attached --- */
244 c
= xmalloc(sizeof(*c
));
245 c
->car
.atom
= xmalloc(sizeof(*c
->car
.atom
));
247 /* --- Restart here after an error --- *
249 * If I restart here, I can avoid freeing the cons cell reallocating
250 * it, which is a little silly.
254 c
->car
.atom
->n
= c
->car
.atom
->h
= c
->car
.atom
->u
= c
->car
.atom
->d
= 0;
258 /* --- Handle end-of-line --- */
263 /* --- Handle a netgroup reference --- */
265 if (t
== tok_string
) {
266 T( trace(TRACE_DEBUG
, "debug: add reference to `%s'", vc
); )
267 c
->car
.atom
->n
= xstrdup(vc
);
270 t
= netg__lex(&p
, vc
);
274 /* --- Parse our merry way through the host--user--domain triple --- */
278 t
= netg__lex(&p
, vc
);
280 if (t
== tok_string
) {
281 T( trace(TRACE_DEBUG
, "debug: add host `%s'", vc
); )
282 c
->car
.atom
->h
= xstrdup(vc
);
283 t
= netg__lex(&p
, vc
);
288 t
= netg__lex(&p
, vc
);
290 if (t
== tok_string
) {
291 T( trace(TRACE_DEBUG
, "debug: add user `%s'", vc
); )
292 c
->car
.atom
->u
= xstrdup(vc
);
293 t
= netg__lex(&p
, vc
);
298 t
= netg__lex(&p
, vc
);
300 if (t
== tok_string
) {
301 T( trace(TRACE_DEBUG
, "debug: add domain `%s'", vc
); )
302 c
->car
.atom
->d
= xstrdup(vc
);
303 t
= netg__lex(&p
, vc
);
308 t
= netg__lex(&p
, vc
);
310 /* --- Finished that, so insert this cons cell into the list --- */
316 /* --- Tidy up during scanning of a triple --- *
318 * I'll search for the closing paren, and hope that I won't miss out too
323 while (t
!= tok_eof
&& t
!= ')')
324 t
= netg__lex(&p
, vc
);
326 /* --- Other syntax oddnesses come out here --- *
328 * Snarf the token which caused the error.
332 moan("syntax error in netgroups line for `%s'", kc
);
333 if (c
->car
.atom
->n
) free(c
->car
.atom
->n
);
334 if (c
->car
.atom
->h
) free(c
->car
.atom
->h
);
335 if (c
->car
.atom
->u
) free(c
->car
.atom
->u
);
336 if (c
->car
.atom
->d
) free(c
->car
.atom
->d
);
337 t
= netg__lex(&p
, vc
);
346 /* --- @netg__dumpGroup@ --- *
348 * Arguments: @netg__cons *c@ = pointer to a list head
349 * @int lev@ = indentation level
353 * Use: Dumps the netgroup given.
358 static void netg__dumpGroup(netg__cons
*c
, int lev
)
365 /* --- Check for a cycle --- */
367 if (c
->f
& f_visit
) {
368 trace(TRACE_DEBUG
, "debug: %*scycle!", lev
* 2, "");
372 /* --- Dump the netgroup --- */
376 for (cc
= c
; cc
; cc
= cc
->cdr
) {
377 if (cc
->f
& f_cons
) {
378 trace(TRACE_DEBUG
, "debug: %*ssubnetgroup...", lev
* 2, "");
379 netg__dumpGroup(cc
->car
.cons
, lev
+ 1);
380 } else if (cc
->car
.atom
->n
) {
381 trace(TRACE_DEBUG
, "debug: %*sunresolved subgroup `%s'",
382 lev
* 2, "", cc
->car
.atom
->n
);
384 trace(TRACE_DEBUG
, "debug: %*s(%s, %s, %s)", lev
* 2, "",
385 cc
->car
.atom
->h ? cc
->car
.atom
->h
: "<all-hosts>",
386 cc
->car
.atom
->u ? cc
->car
.atom
->u
: "<all-users>",
387 cc
->car
.atom
->d ? cc
->car
.atom
->d
: "<all-domains>");
396 /* --- @netg__dump@ --- *
402 * Use: Dumps the netgroups table.
405 static void netg__dump(void)
411 trace(TRACE_DEBUG
, "debug: dumping netgroups file");
412 for (sym_createIter(&i
, &netg__table
); (sng
= sym_next(&i
)) != 0; ) {
413 trace(TRACE_DEBUG
, "debug: netgroup `%s'...", sng
->_base
.name
);
414 sng
->cons
->f
&= ~f_visit
;
415 netg__dumpGroup(sng
->cons
, 1);
420 /* --- @netg_iterate@, @netg_iterate_r@ --- *
422 * Arguments: @netg_iter *i@ = pointer to a netgroup iterator object
426 * Use: Starts iterating over the netgroups.
429 void netg_iterate(void) { netg_iterate_r(&netg__iter
); }
430 void netg_iterate_r(netg_iter
*i
) { sym_createIter(i
, &netg__table
); }
432 /* --- @netg_next@, @netg_next_r@ --- *
434 * Arguments: @netg_iter *i@ = pointer to a netgroup iterator object
436 * Returns: An opaque pointer to the next item, or null.
438 * Use: Returns the next netgroup.
441 netg
*netg_next(void) { return (netg_next_r(&netg__iter
)); }
442 netg
*netg_next_r(netg_iter
*i
) { return (sym_next(i
)); }
444 /* --- @netg_name@ --- *
446 * Arguments: @netg *n@ = netgroup handle returned by @netg_next@.
448 * Returns: A pointer to the name; you may not modify this string.
450 * Use: Returns the name of a netgroup.
453 const char *netg_name(netg
*n
) { return (n
->_base
.name
); }
455 /* --- @netg_scan@ --- *
457 * Arguments: @netg *n@ = a netgroup handle returned by @netg_next@
458 * @int (*proc)(netg *n, const char *host, const char *user,@
459 * @const char *domain, void *ctx)@ = function to call
461 * @void *ctx@ = context pointer to pass to @proc@.
463 * Returns: Zero if all went well, or the nonzero return value from
466 * Use: Passes all the members of the netgroup to a given function.
467 * The function is given the names, directly from the NIS
468 * netgroup map, except that any empty entries are passed as
469 * null pointers rather than empty strings. You may not modify
470 * any of the strings. The enumeration function, @proc@, may
471 * return nonzero to stop itself from being called any more;
472 * if this happens, the value it returns becomes the result of
473 * this function. If all the items are enumerated OK, this
474 * function returns zero.
477 static int netg__doScan(netg__cons
*c
,
479 int (*proc
)(netg */
*n*/
, const char */
*host*/
,
480 const char */
*user*/
,
481 const char */
*domain*/
, void */
*ctx*/
),
488 e
= netg__doScan(c
->car
.cons
, n
, proc
, ctx
);
490 e
= proc(n
, c
->car
.atom
->h
, c
->car
.atom
->u
, c
->car
.atom
->d
, ctx
);
498 int netg_scan(netg
*n
,
499 int (*proc
)(netg */
*n*/
, const char */
*host*/
,
500 const char */
*user*/
, const char */
*domain*/
,
504 return (netg__doScan(n
->cons
, n
, proc
, ctx
));
507 /* --- @netg__breakCycle@ --- *
509 * Arguments: @netg__cons *c@ = pointer to a list
513 * Use: Scans the given list (recursively) and breaks any cycles it
517 static void netg__breakCycle(netg__cons
*c
)
521 if (!c
|| c
->f
& f_uncycled
)
525 for (cc
= c
; cc
; cc
= cc
->cdr
) {
528 if (cc
->car
.cons
->f
& f_visit
) {
529 T( trace(TRACE_DEBUG
, "debug: cycle in netgroups"); )
532 netg__breakCycle(cc
->car
.cons
);
538 /* --- @netg_init@ --- *
544 * Use: Reads the netgroup database and turns it into something nice.
551 /* --- Initialise my symbol table --- */
553 sym_createTable(&netg__table
);
555 /* --- Bind myself unto a YP server --- */
557 if (yp_get_default_domain(&ypdom
) ||
561 /* --- Now try to read all the netgroup entries --- */
564 static struct ypall_callback ncb
= { netg__foreach
, 0 };
565 yp_all(ypdom
, "netgroup", &ncb
);
568 /* --- Unbind from the server --- */
572 /* --- Dump the table --- */
574 IF_TRACING(TRACE_DEBUG
, netg__dump(); )
576 /* --- Now resolve all the remaining references --- */
584 for (sym_createIter(&i
, &netg__table
); (sng
= sym_next(&i
)) != 0; ) {
585 for (c
= sng
->cons
; c
; c
= c
->cdr
) {
586 if ((c
->f
& f_cons
) == 0 && c
->car
.atom
->n
) {
588 ng
= sym_find(&netg__table
, a
->n
, -1, 0, 0);
590 moan("undefined netgroup `%s' (ignored)", a
->n
);
593 c
->car
.cons
= ng
->cons
;
603 /* --- Remove cycles in the netgroups table --- */
609 for (sym_createIter(&i
, &netg__table
); (sng
= sym_next(&i
)) != 0; )
610 sng
->cons
->f
&= ~f_uncycled
;
611 for (sym_createIter(&i
, &netg__table
); (sng
= sym_next(&i
)) != 0; )
612 netg__breakCycle(sng
->cons
);
615 /* --- Dump the table again --- */
617 IF_TRACING(TRACE_DEBUG
, netg__dump(); )
620 /* --- @netg_reinit@ --- *
626 * Use: Forces a re-read of the netgroups file.
629 void netg_reinit(void)
635 /* --- Remove all the old netgroups rubbish --- */
637 for (sym_createIter(&i
, &netg__table
); (sng
= sym_next(&i
)) != 0; ) {
641 if (~c
->f
& f_cons
) {
642 if (c
->car
.atom
->n
) free(c
->car
.atom
->n
);
643 if (c
->car
.atom
->h
) free(c
->car
.atom
->h
);
644 if (c
->car
.atom
->u
) free(c
->car
.atom
->u
);
645 if (c
->car
.atom
->d
) free(c
->car
.atom
->d
);
650 sym_remove(&netg__table
, sng
);
653 /* --- Now rebuild the world --- */
658 /*----- Test driver -------------------------------------------------------*/
662 int scanner(netg
*n
, const char *h
, const char *u
, const char *d
, void *c
)
664 fprintf(stderr
, " %s, %s, %s\n",
665 h ? h
: "<any>", u ? u
: "<any>", d ? d
: "<any>");
673 traceon(stderr
, TRACE_ALL
);
675 for (netg_iterate(); (n
= netg_next()) != 0; ) {
676 fprintf(stderr
, "netgroup %s\n", netg_name(n
));
677 netg_scan(n
, scanner
, 0);
684 /*----- That's all, folks -------------------------------------------------*/