include/grp_.h

   1 /* vi: set sw=4 ts=4: */
   2 /* 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
  24 #ifndef BB_GRP_H
  25 #define BB_GRP_H 1
  26
  27 #if __GNUC_PREREQ(4,1)
  28 # pragma GCC visibility push(hidden)
  29 #endif
  30
  31 /* This file is #included after #include <grp.h>
  32  * We will use libc-defined structures, but will #define function names
  33  * so that function calls are directed to bb_internal_XXX replacements
  34  */
  35
  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
  52  * in order to not collide with libc names. */
  53
  54
  55 /* Rewind the group-file stream.  */
  56 extern void setgrent(void);
  57
  58 /* Close the group-file stream.  */
  59 extern void endgrent(void);
  60
  61 /* Read an entry from the group-file stream, opening it if necessary.  */
  62 extern struct group *getgrent(void);
  63
  64 /* Read a group entry from STREAM.  */
  65 extern struct group *fgetgrent(FILE *__stream);
  66
  67 /* Write the given entry onto the given stream.  */
  68 extern int putgrent(const struct group *__restrict __p,
  69                      FILE *__restrict __f);
  70
  71 /* Search for an entry with a matching group ID.  */
  72 extern struct group *getgrgid(gid_t __gid);
  73
  74 /* Search for an entry with a matching group name.  */
  75 extern struct group *getgrnam(const char *__name);
  76
  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
  85 extern int getgrent_r(struct group *__restrict __resultbuf,
  86                        char *__restrict __buffer, size_t __buflen,
  87                        struct group **__restrict __result);
  88
  89 /* Search for an entry with a matching group ID.  */
  90 extern int getgrgid_r(gid_t __gid, struct group *__restrict __resultbuf,
  91                        char *__restrict __buffer, size_t __buflen,
  92                        struct group **__restrict __result);
  93
  94 /* Search for an entry with a matching group name.  */
  95 extern int getgrnam_r(const char *__restrict __name,
  96                        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.  */
 102 extern int fgetgrent_r(FILE *__restrict __stream,
 103                         struct group *__restrict __resultbuf,
 104                         char *__restrict __buffer, size_t __buflen,
 105                         struct group **__restrict __result);
 106
 107 /* 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.  */
 110 extern int getgrouplist(const char *__user, gid_t __group,
 111                          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.  */
 116 extern int initgroups(const char *__user, gid_t __group);
 117
 118 #if __GNUC_PREREQ(4,1)
 119 # pragma GCC visibility pop
 120 #endif
 121
 122 #endif