3 * $Id: netg.h,v 1.4 2003/10/12 00:14:55 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.4 2003/10/12 00:14:55 mdw
33 * Major overhaul. Now uses DSA signatures rather than the bogus symmetric
34 * encrypt-and-hope thing. Integrated with mLib and Catacomb.
36 * Revision 1.3 1998/01/12 16:46:18 mdw
39 * Revision 1.2 1997/08/20 16:19:24 mdw
40 * Replace `name_reinit' by `name_end' for more sensible restart.
42 * Revision 1.1 1997/08/07 09:45:00 mdw
43 * New source file added to maintain a netgroups database.
54 /*----- Required headers --------------------------------------------------*/
58 /*----- Type definitions --------------------------------------------------*/
60 typedef sym_iter netg_iter;
61 typedef struct netg__sym netg;
63 /*----- Functions provided ------------------------------------------------*/
65 /* --- @netg_iterate@, @netg_iterate_r@ --- *
67 * Arguments: @netg_iter *i@ = pointer to a netgroup iterator object
71 * Use: Starts iterating over the netgroups.
74 extern void netg_iterate(void);
75 extern void netg_iterate_r(netg_iter */*i*/);
77 /* --- @netg_next@, @netg_next_r@ --- *
79 * Arguments: @netg_iter *i@ = pointer to a netgroup iterator object
81 * Returns: An opaque pointer to the next item, or null.
83 * Use: Returns the next netgroup.
86 extern netg *netg_next(void);
87 extern netg *netg_next_r(netg_iter */*i*/);
89 /* --- @netg_name@ --- *
91 * Arguments: @netg *n@ = netgroup handle returned by @netg_next@.
93 * Returns: A pointer to the name; you may not modify this string.
95 * Use: Returns the name of a netgroup.
98 extern const char *netg_name(netg */*n*/);
100 /* --- @netg_scan@ --- *
102 * Arguments: @netg *n@ = a netgroup handle returned by @netg_next@
103 * @int (*proc)(netg *n, const char *host, const char *user,@
104 * @const char *domain, void *ctx)@ = function to call
106 * @void *ctx@ = context pointer to pass to @proc@.
108 * Returns: Zero if all went well, or the nonzero return value from
111 * Use: Passes all the members of the netgroup to a given function.
112 * The function is given the names, directly from the NIS
113 * netgroup map, except that any empty entries are passed as
114 * null pointers rather than empty strings. You may not modify
115 * any of the strings. The enumeration function, @proc@, may
116 * return nonzero to stop itself from being called any more;
117 * if this happens, the value it returns becomes the result of
118 * this function. If all the items are enumerated OK, this
119 * function returns zero.
122 extern int netg_scan(netg */*n*/,
123 int (*/*proc*/)(netg */*n*/, const char */*host*/,
124 const char */*user*/,
125 const char */*domain*/, void */*ctx*/),
128 /* --- @netg_init@ --- *
134 * Use: Reads the netgroup database and turns it into something nice.
137 extern void netg_init(void);
139 /* --- @netg_end@ --- *
145 * Use: Empties the netgroups database.
148 extern void netg_end(void);
150 /*----- That's all, folks -------------------------------------------------*/