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 _GRP_H
  25 #define _GRP_H 1
  26
  27 #if __GNUC_PREREQ(4,1)
  28 # pragma GCC visibility push(hidden)
  29 #endif
  30
  31 /* The group structure.  */
  32 struct 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. */
  37 };
  38
  39 /* 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).  */
  42 extern 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
  65
  66 /* Rewind the group-file stream.  */
  67 extern void setgrent(void);
  68
  69 /* Close the group-file stream.  */
  70 extern void endgrent(void);
  71
  72 /* Read an entry from the group-file stream, opening it if necessary.  */
  73 extern struct group *getgrent(void);
  74
  75 /* Read a group entry from STREAM.  */
  76 extern struct group *fgetgrent(FILE *__stream);
  77
  78 /* Write the given entry onto the given stream.  */
  79 extern int putgrent(__const struct group *__restrict __p,
  80                      FILE *__restrict __f);
  81
  82 /* Search for an entry with a matching group ID.  */
  83 extern struct group *getgrgid(gid_t __gid);
  84
  85 /* Search for an entry with a matching group name.  */
  86 extern struct group *getgrnam(__const char *__name);
  87
  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
  96 extern int getgrent_r(struct group *__restrict __resultbuf,
  97                        char *__restrict __buffer, size_t __buflen,
  98                        struct group **__restrict __result);
  99
 100 /* Search for an entry with a matching group ID.  */
 101 extern int getgrgid_r(gid_t __gid, struct group *__restrict __resultbuf,
 102                        char *__restrict __buffer, size_t __buflen,
 103                        struct group **__restrict __result);
 104
 105 /* Search for an entry with a matching group name.  */
 106 extern int getgrnam_r(__const char *__restrict __name,
 107                        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.  */
 113 extern int fgetgrent_r(FILE *__restrict __stream,
 114                         struct group *__restrict __resultbuf,
 115                         char *__restrict __buffer, size_t __buflen,
 116                         struct group **__restrict __result);
 117
 118 /* 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.  */
 121 extern int getgrouplist(__const char *__user, gid_t __group,
 122                          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.  */
 127 extern int initgroups(__const char *__user, gid_t __group);
 128
 129 #if __GNUC_PREREQ(4,1)
 130 # pragma GCC visibility pop
 131 #endif
 132
 133 #endif