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.4 1998/01/12 16:46:38 mdw
35 * Revision 1.3 1997/08/20 16:25:08 mdw
36 * Rename `userdb_reinit' to `userdb_end' for more sensible restart.
38 * Revision 1.2 1997/08/04 10:24:26 mdw
39 * Sources placed under CVS control.
41 * Revision 1.1 1997/07/21 13:47:42 mdw
53 /*----- Required headers --------------------------------------------------*/
62 /*----- Type definitions --------------------------------------------------*/
64 /* --- Iterator objects --- */
66 typedef sym_iter userdb_iter
;
68 /*----- User and group block manipulation ---------------------------------*/
70 /* --- @userdb_copyUser@ --- *
72 * Arguments: @struct passwd *pw@ = pointer to block to copy
74 * Returns: Pointer to the copy.
76 * Use: Copies a user block. The copy is `deep' so all the strings
77 * are copied too. Free the copy with @userdb_freeUser@ when
78 * you don't want it any more.
81 extern struct passwd
*userdb_copyUser(struct passwd */
*pw*/
);
83 /* --- @userdb_freeUser@ --- *
85 * Arguments: @void *rec@ = pointer to a user record
89 * Use: Frees a user record.
92 extern void userdb_freeUser(void */
*rec*/
);
94 /* --- @userdb_copyGroup@ --- *
96 * Arguments: @struct group *gr@ = pointer to group block
98 * Returns: Pointer to copied block
100 * Use: Copies a group block. The copy is `deep' so all the strings
101 * are copied too. Free the copy with @userdb_freeGroup@ when
102 * you don't want it any more.
105 extern struct group
*userdb_copyGroup(struct group */
*gr*/
);
107 /* --- @userdb_freeGroup@ --- *
109 * Arguments: @void *rec@ = pointer to a group record
113 * Use: Frees a group record.
116 extern void userdb_freeGroup(void */
*rec*/
);
118 /*----- Internal user database mapping ------------------------------------*/
120 /* --- @userdb_local@ --- *
126 * Use: Reads the local list of users into the maps.
129 extern void userdb_local(void);
131 /* --- @userdb_yp@ --- *
137 * Use: Fetches the YP database of users.
140 extern void userdb_yp(void);
142 /* --- @userdb_userByName@, @userdb_userById@ --- *
144 * Arguments: @const char *name@ = pointer to user's name
145 * @uid_t id@ = user id to find
147 * Returns: Pointer to user block, or zero if not found.
149 * Use: Looks up a user by name or id.
152 extern struct passwd
*userdb_userByName(const char */
*name*/
);
153 extern struct passwd
*userdb_userById(uid_t
/*id*/);
155 /* --- @userdb_iterateUsers@, @userdb_iterateUsers_r@ --- *
157 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator object
161 * Use: Initialises an iteration for the user database.
164 extern void userdb_iterateUsers(void);
165 extern void userdb_iterateUsers_r(userdb_iter */
*i*/
);
167 /* --- @userdb_nextUser@, @userdb_nextUser_r@ --- *
169 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator oject
171 * Returns: Pointer to the next user block, or null.
173 * Use: Returns another user block.
176 extern struct passwd
*userdb_nextUser(void);
177 extern struct passwd
*userdb_nextUser_r(userdb_iter */
*i*/
);
179 /* --- @userdb_groupByName@, @userdb_groupById@ --- *
181 * Arguments: @const char *name@ = pointer to group's name
182 * @gid_t id@ = group id to find
184 * Returns: Pointer to group block, or zero if not found.
186 * Use: Looks up a group by name or id.
189 extern struct group
*userdb_groupByName(const char */
*name*/
);
190 extern struct group
*userdb_groupById(gid_t
/*id*/);
192 /* --- @userdb_iterateGroups@, @userdb_iterateGroups_r@ --- *
194 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator object
198 * Use: Initialises an iteration for the group database.
201 extern void userdb_iterateGroups(void);
202 extern void userdb_iterateGroups_r(userdb_iter */
*i*/
);
204 /* --- @userdb_nextGroup@, @userdb_nextGroup_r@ --- *
206 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator oject
208 * Returns: Pointer to the next group block, or null.
210 * Use: Returns another group block.
213 extern struct group
*userdb_nextGroup(void);
214 extern struct group
*userdb_nextGroup_r(userdb_iter */
*i*/
);
216 /* --- @userdb_init@ --- *
222 * Use: Initialises the user database.
225 extern void userdb_init(void);
227 /* --- @userdb_end@ --- *
233 * Use: Closes down the user database.
236 extern void userdb_end(void);
238 /*----- That's all, folks -------------------------------------------------*/