blob: deaf9e6a32af379ecffa8edb25b50a4ee14df126 [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
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000018 02111-1307 USA.
19 */
Eric Andersen9615a082004-07-15 12:53:49 +000020/*
21 * POSIX Standard: 9.2.1 Group Database Access <grp.h>
22 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000023#ifndef BB_GRP_H
24#define BB_GRP_H 1
Eric Andersen9615a082004-07-15 12:53:49 +000025
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000026PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +000027
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000028/* This file is #included after #include <grp.h>
Bernhard Reutner-Fischerfd3552d2008-09-26 11:23:22 +000029 * We will use libc-defined structures, but will #define function names
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000030 * so that function calls are directed to bb_internal_XXX replacements
31 */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000032
33#define setgrent bb_internal_setgrent
34#define endgrent bb_internal_endgrent
35#define getgrent bb_internal_getgrent
36#define fgetgrent bb_internal_fgetgrent
37#define putgrent bb_internal_putgrent
38#define getgrgid bb_internal_getgrgid
39#define getgrnam bb_internal_getgrnam
40#define getgrent_r bb_internal_getgrent_r
41#define getgrgid_r bb_internal_getgrgid_r
42#define getgrnam_r bb_internal_getgrnam_r
43#define fgetgrent_r bb_internal_fgetgrent_r
44#define getgrouplist bb_internal_getgrouplist
45#define initgroups bb_internal_initgroups
46
47
48/* All function names below should be remapped by #defines above
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000049 * in order to not collide with libc names. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000050
Eric Andersenab050f52001-01-27 06:01:43 +000051
Eric Andersen9615a082004-07-15 12:53:49 +000052/* Rewind the group-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000053extern void setgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000054
Eric Andersen9615a082004-07-15 12:53:49 +000055/* Close the group-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000056extern void endgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000057
Eric Andersen9615a082004-07-15 12:53:49 +000058/* Read an entry from the group-file stream, opening it if necessary. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000059extern struct group *getgrent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000060
Eric Andersen9615a082004-07-15 12:53:49 +000061/* Read a group entry from STREAM. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000062extern struct group *fgetgrent(FILE *__stream);
Eric Andersenab050f52001-01-27 06:01:43 +000063
Eric Andersen9615a082004-07-15 12:53:49 +000064/* Write the given entry onto the given stream. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000065extern int putgrent(const struct group *__restrict __p,
Eric Andersen9615a082004-07-15 12:53:49 +000066 FILE *__restrict __f);
Eric Andersenab050f52001-01-27 06:01:43 +000067
Eric Andersen9615a082004-07-15 12:53:49 +000068/* Search for an entry with a matching group ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000069extern struct group *getgrgid(gid_t __gid);
Eric Andersen9615a082004-07-15 12:53:49 +000070
71/* Search for an entry with a matching group name. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000072extern struct group *getgrnam(const char *__name);
Eric Andersen9615a082004-07-15 12:53:49 +000073
74/* Reentrant versions of some of the functions above.
75
76 PLEASE NOTE: the `getgrent_r' function is not (yet) standardized.
77 The interface may change in later versions of this library. But
78 the interface is designed following the principals used for the
79 other reentrant functions so the chances are good this is what the
80 POSIX people would choose. */
81
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000082extern int getgrent_r(struct group *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000083 char *__restrict __buffer, size_t __buflen,
84 struct group **__restrict __result);
85
86/* Search for an entry with a matching group ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000087extern int getgrgid_r(gid_t __gid, struct group *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000088 char *__restrict __buffer, size_t __buflen,
89 struct group **__restrict __result);
90
91/* Search for an entry with a matching group name. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000092extern int getgrnam_r(const char *__restrict __name,
Eric Andersen9615a082004-07-15 12:53:49 +000093 struct group *__restrict __resultbuf,
94 char *__restrict __buffer, size_t __buflen,
95 struct group **__restrict __result);
96
97/* Read a group entry from STREAM. This function is not standardized
98 an probably never will. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000099extern int fgetgrent_r(FILE *__restrict __stream,
Eric Andersen9615a082004-07-15 12:53:49 +0000100 struct group *__restrict __resultbuf,
101 char *__restrict __buffer, size_t __buflen,
102 struct group **__restrict __result);
103
Eric Andersen9615a082004-07-15 12:53:49 +0000104/* Store at most *NGROUPS members of the group set for USER into
105 *GROUPS. Also include GROUP. The actual number of groups found is
106 returned in *NGROUPS. Return -1 if the if *NGROUPS is too small. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +0000107extern int getgrouplist(const char *__user, gid_t __group,
Eric Andersen9615a082004-07-15 12:53:49 +0000108 gid_t *__groups, int *__ngroups);
109
110/* Initialize the group set for the current user
111 by reading the group database and using all groups
112 of which USER is a member. Also include GROUP. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +0000113extern int initgroups(const char *__user, gid_t __group);
Eric Andersen9615a082004-07-15 12:53:49 +0000114
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000115POP_SAVED_FUNCTION_VISIBILITY
Eric Andersen9615a082004-07-15 12:53:49 +0000116
Eric Andersen9615a082004-07-15 12:53:49 +0000117#endif