blob: a0cf7c9f77f02b6efd6e308fc5b53006b8c56259 [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,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 */
Eric Andersenab050f52001-01-27 06:01:43 +000023
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000024#ifndef BB_PWD_H
25#define BB_PWD_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 <pwd.h>
Bernhard Reutner-Fischerfd3552d2008-09-26 11:23:22 +000032 * We will use libc-defined structures, but will #define function names
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000033 * so that function calls are directed to bb_internal_XXX replacements
34 */
Eric Andersenab050f52001-01-27 06:01:43 +000035
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000036#define setpwent bb_internal_setpwent
37#define endpwent bb_internal_endpwent
38#define getpwent bb_internal_getpwent
39#define fgetpwent bb_internal_fgetpwent
40#define putpwent bb_internal_putpwent
41#define getpwuid bb_internal_getpwuid
42#define getpwnam bb_internal_getpwnam
43#define getpwent_r bb_internal_getpwent_r
44#define getpwuid_r bb_internal_getpwuid_r
45#define getpwnam_r bb_internal_getpwnam_r
46#define fgetpwent_r bb_internal_fgetpwent_r
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000047//#define getpw bb_internal_getpw
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000048
49
50/* All function names below should be remapped by #defines above
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000051 * in order to not collide with libc names. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000052
53
Eric Andersen9615a082004-07-15 12:53:49 +000054/* Rewind the password-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000055extern void setpwent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000056
Eric Andersen9615a082004-07-15 12:53:49 +000057/* Close the password-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000058extern void endpwent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000059
Eric Andersen9615a082004-07-15 12:53:49 +000060/* Read an entry from the password-file stream, opening it if necessary. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000061extern struct passwd *getpwent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000062
Eric Andersen9615a082004-07-15 12:53:49 +000063/* Read an entry from STREAM. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000064extern struct passwd *fgetpwent(FILE *__stream);
Eric Andersenab050f52001-01-27 06:01:43 +000065
Eric Andersen9615a082004-07-15 12:53:49 +000066/* Write the given entry onto the given stream. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000067extern int putpwent(const struct passwd *__restrict __p,
Eric Andersen9615a082004-07-15 12:53:49 +000068 FILE *__restrict __f);
Eric Andersenab050f52001-01-27 06:01:43 +000069
Eric Andersen9615a082004-07-15 12:53:49 +000070/* Search for an entry with a matching user ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000071extern struct passwd *getpwuid(uid_t __uid);
Eric Andersen9615a082004-07-15 12:53:49 +000072
73/* Search for an entry with a matching username. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000074extern struct passwd *getpwnam(const char *__name);
Eric Andersen9615a082004-07-15 12:53:49 +000075
76/* Reentrant versions of some of the functions above.
77
78 PLEASE NOTE: the `getpwent_r' function is not (yet) standardized.
79 The interface may change in later versions of this library. But
80 the interface is designed following the principals used for the
81 other reentrant functions so the chances are good this is what the
82 POSIX people would choose. */
83
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000084extern int getpwent_r(struct passwd *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000085 char *__restrict __buffer, size_t __buflen,
86 struct passwd **__restrict __result);
87
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000088extern int getpwuid_r(uid_t __uid,
Eric Andersen9615a082004-07-15 12:53:49 +000089 struct passwd *__restrict __resultbuf,
90 char *__restrict __buffer, size_t __buflen,
91 struct passwd **__restrict __result);
92
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000093extern int getpwnam_r(const char *__restrict __name,
Eric Andersen9615a082004-07-15 12:53:49 +000094 struct passwd *__restrict __resultbuf,
95 char *__restrict __buffer, size_t __buflen,
96 struct passwd **__restrict __result);
97
Eric Andersen9615a082004-07-15 12:53:49 +000098/* Read an entry from STREAM. This function is not standardized and
99 probably never will. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000100extern int fgetpwent_r(FILE *__restrict __stream,
Eric Andersen9615a082004-07-15 12:53:49 +0000101 struct passwd *__restrict __resultbuf,
102 char *__restrict __buffer, size_t __buflen,
103 struct passwd **__restrict __result);
104
105/* Re-construct the password-file line for the given uid
106 in the given buffer. This knows the format that the caller
107 will expect, but this need not be the format of the password file. */
Denis Vlasenkoee5dce32008-09-26 10:35:55 +0000108/* UNUSED extern int getpw(uid_t __uid, char *__buffer); */
Eric Andersen9615a082004-07-15 12:53:49 +0000109
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000110#if __GNUC_PREREQ(4,1)
111# pragma GCC visibility pop
Eric Andersen9615a082004-07-15 12:53:49 +0000112#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000113
114#endif /* pwd.h */