blob: 45ee22ba98f197a4a1c99934c9a9369f2cf3a03c [file] [log] [blame]
"Robert P. J. Day"63fc1a92006-07-02 19:47:05 +00001/* vi: set sw=4 ts=4: */
Eric Andersen9615a082004-07-15 12:53:49 +00002/* Copyright (C) 1991,92,95,96,97,98,99,2000,01 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
19
20/*
21 * POSIX Standard: 9.2.1 Group Database Access <grp.h>
22 */
23
Eric Andersen9615a082004-07-15 12:53:49 +000024#ifndef _GRP_H
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000025#define _GRP_H 1
Eric Andersenab050f52001-01-27 06:01:43 +000026
Denis Vlasenko98636eb2008-05-09 17:59:34 +000027#if __GNUC_PREREQ(4,1)
28# pragma GCC visibility push(hidden)
29#endif
30
Eric Andersen9615a082004-07-15 12:53:49 +000031/* The group structure. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000032struct group {
33 char *gr_name; /* Group name. */
34 char *gr_passwd; /* Password. */
35 gid_t gr_gid; /* Group ID. */
36 char **gr_mem; /* Member list. */
Eric Andersenab050f52001-01-27 06:01:43 +000037};
38
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000039/* We don't reimplement this, just supplying prototype */
40/* The function itself is in libc */
41/* Set the group set for the current user to GROUPS (N of them). */
42extern int setgroups(size_t __n, __const gid_t *__groups);
43
44
45#define setgrent bb_internal_setgrent
46#define endgrent bb_internal_endgrent
47#define getgrent bb_internal_getgrent
48#define fgetgrent bb_internal_fgetgrent
49#define putgrent bb_internal_putgrent
50#define getgrgid bb_internal_getgrgid
51#define getgrnam bb_internal_getgrnam
52#define getgrent_r bb_internal_getgrent_r
53#define getgrgid_r bb_internal_getgrgid_r
54#define getgrnam_r bb_internal_getgrnam_r
55#define fgetgrent_r bb_internal_fgetgrent_r
56#define getgrouplist bb_internal_getgrouplist
57#define initgroups bb_internal_initgroups
58
59
60/* All function names below should be remapped by #defines above
61 * in order to not collide with libc names.
62 * In theory it isn't necessary, but I saw weird interactions at link time.
63 * Let's play safe */
64
Eric Andersenab050f52001-01-27 06:01:43 +000065
Eric Andersen9615a082004-07-15 12:53:49 +000066/* Rewind the group-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000067extern void setgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000068
Eric Andersen9615a082004-07-15 12:53:49 +000069/* Close the group-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000070extern void endgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000071
Eric Andersen9615a082004-07-15 12:53:49 +000072/* Read an entry from the group-file stream, opening it if necessary. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000073extern struct group *getgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000074
Eric Andersen9615a082004-07-15 12:53:49 +000075/* Read a group entry from STREAM. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000076extern struct group *fgetgrent(FILE *__stream);
Eric Andersenab050f52001-01-27 06:01:43 +000077
Eric Andersen9615a082004-07-15 12:53:49 +000078/* Write the given entry onto the given stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000079extern int putgrent(__const struct group *__restrict __p,
Eric Andersen9615a082004-07-15 12:53:49 +000080 FILE *__restrict __f);
Eric Andersenab050f52001-01-27 06:01:43 +000081
Eric Andersen9615a082004-07-15 12:53:49 +000082/* Search for an entry with a matching group ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000083extern struct group *getgrgid(gid_t __gid);
Eric Andersen9615a082004-07-15 12:53:49 +000084
85/* Search for an entry with a matching group name. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000086extern struct group *getgrnam(__const char *__name);
Eric Andersen9615a082004-07-15 12:53:49 +000087
88/* Reentrant versions of some of the functions above.
89
90 PLEASE NOTE: the `getgrent_r' function is not (yet) standardized.
91 The interface may change in later versions of this library. But
92 the interface is designed following the principals used for the
93 other reentrant functions so the chances are good this is what the
94 POSIX people would choose. */
95
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000096extern int getgrent_r(struct group *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000097 char *__restrict __buffer, size_t __buflen,
98 struct group **__restrict __result);
99
100/* Search for an entry with a matching group ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000101extern int getgrgid_r(gid_t __gid, struct group *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +0000102 char *__restrict __buffer, size_t __buflen,
103 struct group **__restrict __result);
104
105/* Search for an entry with a matching group name. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000106extern int getgrnam_r(__const char *__restrict __name,
Eric Andersen9615a082004-07-15 12:53:49 +0000107 struct group *__restrict __resultbuf,
108 char *__restrict __buffer, size_t __buflen,
109 struct group **__restrict __result);
110
111/* Read a group entry from STREAM. This function is not standardized
112 an probably never will. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000113extern int fgetgrent_r(FILE *__restrict __stream,
Eric Andersen9615a082004-07-15 12:53:49 +0000114 struct group *__restrict __resultbuf,
115 char *__restrict __buffer, size_t __buflen,
116 struct group **__restrict __result);
117
Eric Andersen9615a082004-07-15 12:53:49 +0000118/* Store at most *NGROUPS members of the group set for USER into
119 *GROUPS. Also include GROUP. The actual number of groups found is
120 returned in *NGROUPS. Return -1 if the if *NGROUPS is too small. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000121extern int getgrouplist(__const char *__user, gid_t __group,
Eric Andersen9615a082004-07-15 12:53:49 +0000122 gid_t *__groups, int *__ngroups);
123
124/* Initialize the group set for the current user
125 by reading the group database and using all groups
126 of which USER is a member. Also include GROUP. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000127extern int initgroups(__const char *__user, gid_t __group);
Eric Andersen9615a082004-07-15 12:53:49 +0000128
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000129#if __GNUC_PREREQ(4,1)
130# pragma GCC visibility pop
131#endif
Eric Andersen9615a082004-07-15 12:53:49 +0000132
Eric Andersen9615a082004-07-15 12:53:49 +0000133#endif