include/pwd_.h

   1 /* vi: set sw=4 ts=4: */
   2 /* Copyright (C) 1991,92,95,96,97,98,99,2001 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.2 User Database Access      <pwd.h>
  22  */
  23
  24 #ifndef _PWD_H
  25 #define _PWD_H 1
  26
  27 #if __GNUC_PREREQ(4,1)
  28 # pragma GCC visibility push(hidden)
  29 #endif
  30
  31 /* The passwd structure.  */
  32 struct passwd {
  33         char *pw_name;          /* Username.  */
  34         char *pw_passwd;        /* Password.  */
  35         uid_t pw_uid;           /* User ID.  */
  36         gid_t pw_gid;           /* Group ID.  */
  37         char *pw_gecos;         /* Real name.  */
  38         char *pw_dir;           /* Home directory.  */
  39         char *pw_shell;         /* Shell program.  */
  40 };
  41
  42
  43 #define setpwent    bb_internal_setpwent
  44 #define endpwent    bb_internal_endpwent
  45 #define getpwent    bb_internal_getpwent
  46 #define fgetpwent   bb_internal_fgetpwent
  47 #define putpwent    bb_internal_putpwent
  48 #define getpwuid    bb_internal_getpwuid
  49 #define getpwnam    bb_internal_getpwnam
  50 #define getpwent_r  bb_internal_getpwent_r
  51 #define getpwuid_r  bb_internal_getpwuid_r
  52 #define getpwnam_r  bb_internal_getpwnam_r
  53 #define fgetpwent_r bb_internal_fgetpwent_r
  54 #define getpw       bb_internal_getpw
  55
  56
  57 /* All function names below should be remapped by #defines above
  58  * in order to not collide with libc names.
  59  * In theory it isn't necessary, but I saw weird interactions at link time.
  60  * Let's play safe */
  61
  62
  63 /* Rewind the password-file stream.  */
  64 extern void setpwent(void);
  65
  66 /* Close the password-file stream.  */
  67 extern void endpwent(void);
  68
  69 /* Read an entry from the password-file stream, opening it if necessary.  */
  70 extern struct passwd *getpwent(void);
  71
  72 /* Read an entry from STREAM.  */
  73 extern struct passwd *fgetpwent(FILE *__stream);
  74
  75 /* Write the given entry onto the given stream.  */
  76 extern int putpwent(__const struct passwd *__restrict __p,
  77                      FILE *__restrict __f);
  78
  79 /* Search for an entry with a matching user ID.  */
  80 extern struct passwd *getpwuid(uid_t __uid);
  81
  82 /* Search for an entry with a matching username.  */
  83 extern struct passwd *getpwnam(__const char *__name);
  84
  85 /* Reentrant versions of some of the functions above.
  86
  87    PLEASE NOTE: the `getpwent_r' function is not (yet) standardized.
  88    The interface may change in later versions of this library.  But
  89    the interface is designed following the principals used for the
  90    other reentrant functions so the chances are good this is what the
  91    POSIX people would choose.  */
  92
  93 extern int getpwent_r(struct passwd *__restrict __resultbuf,
  94                        char *__restrict __buffer, size_t __buflen,
  95                        struct passwd **__restrict __result);
  96
  97 extern int getpwuid_r(uid_t __uid,
  98                        struct passwd *__restrict __resultbuf,
  99                        char *__restrict __buffer, size_t __buflen,
 100                        struct passwd **__restrict __result);
 101
 102 extern int getpwnam_r(__const char *__restrict __name,
 103                        struct passwd *__restrict __resultbuf,
 104                        char *__restrict __buffer, size_t __buflen,
 105                        struct passwd **__restrict __result);
 106
 107 /* Read an entry from STREAM.  This function is not standardized and
 108    probably never will.  */
 109 extern int fgetpwent_r(FILE *__restrict __stream,
 110                         struct passwd *__restrict __resultbuf,
 111                         char *__restrict __buffer, size_t __buflen,
 112                         struct passwd **__restrict __result);
 113
 114 /* Re-construct the password-file line for the given uid
 115    in the given buffer.  This knows the format that the caller
 116    will expect, but this need not be the format of the password file.  */
 117 extern int getpw(uid_t __uid, char *__buffer);
 118
 119 #if __GNUC_PREREQ(4,1)
 120 # pragma GCC visibility pop
 121 #endif
 122
 123 #endif /* pwd.h  */