2507531d619c2b540bce30545cd543486d1546c4
5 * User database management
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.3 1997/08/20 16:25:08 mdw
33 * Rename `userdb_reinit' to `userdb_end' for more sensible restart.
35 * Revision 1.2 1997/08/04 10:24:26 mdw
36 * Sources placed under CVS control.
38 * Revision 1.1 1997/07/21 13:47:42 mdw
50 /*----- Required headers --------------------------------------------------*/
59 /*----- Type definitions --------------------------------------------------*/
61 /* --- Iterator objects --- */
63 typedef sym_iter userdb_iter
;
65 /*----- User and group block manipulation ---------------------------------*/
67 /* --- @userdb_copyUser@ --- *
69 * Arguments: @struct passwd *pw@ = pointer to block to copy
71 * Returns: Pointer to the copy.
73 * Use: Copies a user block. The copy is `deep' so all the strings
74 * are copied too. Free the copy with @userdb_freeUser@ when
75 * you don't want it any more.
78 extern struct passwd
*userdb_copyUser(struct passwd */
*pw*/
);
80 /* --- @userdb_freeUser@ --- *
82 * Arguments: @void *rec@ = pointer to a user record
86 * Use: Frees a user record.
89 extern void userdb_freeUser(void */
*rec*/
);
91 /* --- @userdb_copyGroup@ --- *
93 * Arguments: @struct group *gr@ = pointer to group block
95 * Returns: Pointer to copied block
97 * Use: Copies a group block. The copy is `deep' so all the strings
98 * are copied too. Free the copy with @userdb_freeGroup@ when
99 * you don't want it any more.
102 extern struct group
*userdb_copyGroup(struct group */
*gr*/
);
104 /* --- @userdb_freeGroup@ --- *
106 * Arguments: @void *rec@ = pointer to a group record
110 * Use: Frees a group record.
113 extern void userdb_freeGroup(void */
*rec*/
);
115 /*----- Internal user database mapping ------------------------------------*/
117 /* --- @userdb_local@ --- *
123 * Use: Reads the local list of users into the maps.
126 extern void userdb_local(void);
128 /* --- @userdb_yp@ --- *
134 * Use: Fetches the YP database of users.
137 extern void userdb_yp(void);
139 /* --- @userdb_userByName@, @userdb_userById@ --- *
141 * Arguments: @const char *name@ = pointer to user's name
142 * @uid_t id@ = user id to find
144 * Returns: Pointer to user block, or zero if not found.
146 * Use: Looks up a user by name or id.
149 extern struct passwd
*userdb_userByName(const char */
*name*/
);
150 extern struct passwd
*userdb_userById(uid_t
/*id*/);
152 /* --- @userdb_iterateUsers@, @userdb_iterateUsers_r@ --- *
154 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator object
158 * Use: Initialises an iteration for the user database.
161 extern void userdb_iterateUsers(void);
162 extern void userdb_iterateUsers_r(userdb_iter */
*i*/
);
164 /* --- @userdb_nextUser@, @userdb_nextUser_r@ --- *
166 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator oject
168 * Returns: Pointer to the next user block, or null.
170 * Use: Returns another user block.
173 extern struct passwd
*userdb_nextUser(void);
174 extern struct passwd
*userdb_nextUser_r(userdb_iter */
*i*/
);
176 /* --- @userdb_groupByName@, @userdb_groupById@ --- *
178 * Arguments: @const char *name@ = pointer to group's name
179 * @gid_t id@ = group id to find
181 * Returns: Pointer to group block, or zero if not found.
183 * Use: Looks up a group by name or id.
186 extern struct group
*userdb_groupByName(const char */
*name*/
);
187 extern struct group
*userdb_groupById(gid_t
/*id*/);
189 /* --- @userdb_iterateGroups@, @userdb_iterateGroups_r@ --- *
191 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator object
195 * Use: Initialises an iteration for the group database.
198 extern void userdb_iterateGroups(void);
199 extern void userdb_iterateGroups_r(userdb_iter */
*i*/
);
201 /* --- @userdb_nextGroup@, @userdb_nextGroup_r@ --- *
203 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator oject
205 * Returns: Pointer to the next group block, or null.
207 * Use: Returns another group block.
210 extern struct group
*userdb_nextGroup(void);
211 extern struct group
*userdb_nextGroup_r(userdb_iter */
*i*/
);
213 /* --- @userdb_init@ --- *
219 * Use: Initialises the user database.
222 extern void userdb_init(void);
224 /* --- @userdb_end@ --- *
230 * Use: Closes down the user database.
233 extern void userdb_end(void);
235 /*----- That's all, folks -------------------------------------------------*/