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.2 1997/08/04 10:24:26 mdw
33 * Sources placed under CVS control.
35 * Revision 1.1 1997/07/21 13:47:42 mdw
47 /*----- Required headers --------------------------------------------------*/
56 /*----- Type definitions --------------------------------------------------*/
58 /* --- Iterator objects --- */
60 typedef sym_iter userdb_iter
;
62 /*----- User and group block manipulation ---------------------------------*/
64 /* --- @userdb_copyUser@ --- *
66 * Arguments: @struct passwd *pw@ = pointer to block to copy
68 * Returns: Pointer to the copy.
70 * Use: Copies a user block. The copy is `deep' so all the strings
71 * are copied too. Free the copy with @userdb_freeUser@ when
72 * you don't want it any more.
75 extern struct passwd
*userdb_copyUser(struct passwd */
*pw*/
);
77 /* --- @userdb_freeUser@ --- *
79 * Arguments: @void *rec@ = pointer to a user record
83 * Use: Frees a user record.
86 extern void userdb_freeUser(void */
*rec*/
);
88 /* --- @userdb_copyGroup@ --- *
90 * Arguments: @struct group *gr@ = pointer to group block
92 * Returns: Pointer to copied block
94 * Use: Copies a group block. The copy is `deep' so all the strings
95 * are copied too. Free the copy with @userdb_freeGroup@ when
96 * you don't want it any more.
99 extern struct group
*userdb_copyGroup(struct group */
*gr*/
);
101 /* --- @userdb_freeGroup@ --- *
103 * Arguments: @void *rec@ = pointer to a group record
107 * Use: Frees a group record.
110 extern void userdb_freeGroup(void */
*rec*/
);
112 /*----- Internal user database mapping ------------------------------------*/
114 /* --- @userdb_local@ --- *
120 * Use: Reads the local list of users into the maps.
123 extern void userdb_local(void);
125 /* --- @userdb_yp@ --- *
131 * Use: Fetches the YP database of users.
134 extern void userdb_yp(void);
136 /* --- @userdb_userByName@, @userdb_userById@ --- *
138 * Arguments: @const char *name@ = pointer to user's name
139 * @uid_t id@ = user id to find
141 * Returns: Pointer to user block, or zero if not found.
143 * Use: Looks up a user by name or id.
146 extern struct passwd
*userdb_userByName(const char */
*name*/
);
147 extern struct passwd
*userdb_userById(uid_t
/*id*/);
149 /* --- @userdb_iterateUsers@, @userdb_iterateUsers_r@ --- *
151 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator object
155 * Use: Initialises an iteration for the user database.
158 extern void userdb_iterateUsers(void);
159 extern void userdb_iterateUsers_r(userdb_iter */
*i*/
);
161 /* --- @userdb_nextUser@, @userdb_nextUser_r@ --- *
163 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator oject
165 * Returns: Pointer to the next user block, or null.
167 * Use: Returns another user block.
170 extern struct passwd
*userdb_nextUser(void);
171 extern struct passwd
*userdb_nextUser_r(userdb_iter */
*i*/
);
173 /* --- @userdb_groupByName@, @userdb_groupById@ --- *
175 * Arguments: @const char *name@ = pointer to group's name
176 * @gid_t id@ = group id to find
178 * Returns: Pointer to group block, or zero if not found.
180 * Use: Looks up a group by name or id.
183 extern struct group
*userdb_groupByName(const char */
*name*/
);
184 extern struct group
*userdb_groupById(gid_t
/*id*/);
186 /* --- @userdb_iterateGroups@, @userdb_iterateGroups_r@ --- *
188 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator object
192 * Use: Initialises an iteration for the group database.
195 extern void userdb_iterateGroups(void);
196 extern void userdb_iterateGroups_r(userdb_iter */
*i*/
);
198 /* --- @userdb_nextGroup@, @userdb_nextGroup_r@ --- *
200 * Arguments: @userdb_iter *i@ = pointer to a symbol table iterator oject
202 * Returns: Pointer to the next group block, or null.
204 * Use: Returns another group block.
207 extern struct group
*userdb_nextGroup(void);
208 extern struct group
*userdb_nextGroup_r(userdb_iter */
*i*/
);
210 /* --- @userdb_init@ --- *
216 * Use: Initialises the user database.
219 extern void userdb_init(void);
221 /* --- @userdb_reinit@ --- *
227 * Use: Reinitialises the user database.
230 extern void userdb_reinit(void);
232 /*----- That's all, folks -------------------------------------------------*/