blob: 697a78606559b39a0cbaf072578d5184d841b40e [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
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000024#ifndef BB_GRP_H
25#define BB_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
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000031/* This file is #included after #include <grp.h>
32 * We will use libc-defined structures, but will #define finction names
33 * so that function calls are directed to bb_internal_XXX replacements
34 */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000035
36#define setgrent bb_internal_setgrent
37#define endgrent bb_internal_endgrent
38#define getgrent bb_internal_getgrent
39#define fgetgrent bb_internal_fgetgrent
40#define putgrent bb_internal_putgrent
41#define getgrgid bb_internal_getgrgid
42#define getgrnam bb_internal_getgrnam
43#define getgrent_r bb_internal_getgrent_r
44#define getgrgid_r bb_internal_getgrgid_r
45#define getgrnam_r bb_internal_getgrnam_r
46#define fgetgrent_r bb_internal_fgetgrent_r
47#define getgrouplist bb_internal_getgrouplist
48#define initgroups bb_internal_initgroups
49
50
51/* All function names below should be remapped by #defines above
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000052 * in order to not collide with libc names. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000053
Eric Andersenab050f52001-01-27 06:01:43 +000054
Eric Andersen9615a082004-07-15 12:53:49 +000055/* Rewind the group-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000056extern void setgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000057
Eric Andersen9615a082004-07-15 12:53:49 +000058/* Close the group-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000059extern void endgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000060
Eric Andersen9615a082004-07-15 12:53:49 +000061/* Read an entry from the group-file stream, opening it if necessary. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000062extern struct group *getgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000063
Eric Andersen9615a082004-07-15 12:53:49 +000064/* Read a group entry from STREAM. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000065extern struct group *fgetgrent(FILE *__stream);
Eric Andersenab050f52001-01-27 06:01:43 +000066
Eric Andersen9615a082004-07-15 12:53:49 +000067/* Write the given entry onto the given stream. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000068extern int putgrent(const struct group *__restrict __p,
Eric Andersen9615a082004-07-15 12:53:49 +000069 FILE *__restrict __f);
Eric Andersenab050f52001-01-27 06:01:43 +000070
Eric Andersen9615a082004-07-15 12:53:49 +000071/* Search for an entry with a matching group ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000072extern struct group *getgrgid(gid_t __gid);
Eric Andersen9615a082004-07-15 12:53:49 +000073
74/* Search for an entry with a matching group name. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000075extern struct group *getgrnam(const char *__name);
Eric Andersen9615a082004-07-15 12:53:49 +000076
77/* Reentrant versions of some of the functions above.
78
79 PLEASE NOTE: the `getgrent_r' function is not (yet) standardized.
80 The interface may change in later versions of this library. But
81 the interface is designed following the principals used for the
82 other reentrant functions so the chances are good this is what the
83 POSIX people would choose. */
84
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000085extern int getgrent_r(struct group *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000086 char *__restrict __buffer, size_t __buflen,
87 struct group **__restrict __result);
88
89/* Search for an entry with a matching group ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000090extern int getgrgid_r(gid_t __gid, struct group *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000091 char *__restrict __buffer, size_t __buflen,
92 struct group **__restrict __result);
93
94/* Search for an entry with a matching group name. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000095extern int getgrnam_r(const char *__restrict __name,
Eric Andersen9615a082004-07-15 12:53:49 +000096 struct group *__restrict __resultbuf,
97 char *__restrict __buffer, size_t __buflen,
98 struct group **__restrict __result);
99
100/* Read a group entry from STREAM. This function is not standardized
101 an probably never will. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000102extern int fgetgrent_r(FILE *__restrict __stream,
Eric Andersen9615a082004-07-15 12:53:49 +0000103 struct group *__restrict __resultbuf,
104 char *__restrict __buffer, size_t __buflen,
105 struct group **__restrict __result);
106
Eric Andersen9615a082004-07-15 12:53:49 +0000107/* Store at most *NGROUPS members of the group set for USER into
108 *GROUPS. Also include GROUP. The actual number of groups found is
109 returned in *NGROUPS. Return -1 if the if *NGROUPS is too small. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +0000110extern int getgrouplist(const char *__user, gid_t __group,
Eric Andersen9615a082004-07-15 12:53:49 +0000111 gid_t *__groups, int *__ngroups);
112
113/* Initialize the group set for the current user
114 by reading the group database and using all groups
115 of which USER is a member. Also include GROUP. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +0000116extern int initgroups(const char *__user, gid_t __group);
Eric Andersen9615a082004-07-15 12:53:49 +0000117
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000118#if __GNUC_PREREQ(4,1)
119# pragma GCC visibility pop
120#endif
Eric Andersen9615a082004-07-15 12:53:49 +0000121
Eric Andersen9615a082004-07-15 12:53:49 +0000122#endif