blob: 6199034d2b08d2dad62a4ed5883cc9cabaf4de41 [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
Eric Andersen9615a082004-07-15 12:53:49 +000024#ifndef _PWD_H
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000025#define _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
Eric Andersenab050f52001-01-27 06:01:43 +000031/* The passwd structure. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000032struct 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. */
Eric Andersenab050f52001-01-27 06:01:43 +000040};
41
Eric Andersenab050f52001-01-27 06:01:43 +000042
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000043#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
Eric Andersen9615a082004-07-15 12:53:49 +000063/* Rewind the password-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000064extern void setpwent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000065
Eric Andersen9615a082004-07-15 12:53:49 +000066/* Close the password-file stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000067extern void endpwent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000068
Eric Andersen9615a082004-07-15 12:53:49 +000069/* Read an entry from the password-file stream, opening it if necessary. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000070extern struct passwd *getpwent(void);
Eric Andersenab050f52001-01-27 06:01:43 +000071
Eric Andersen9615a082004-07-15 12:53:49 +000072/* Read an entry from STREAM. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000073extern struct passwd *fgetpwent(FILE *__stream);
Eric Andersenab050f52001-01-27 06:01:43 +000074
Eric Andersen9615a082004-07-15 12:53:49 +000075/* Write the given entry onto the given stream. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000076extern int putpwent(__const struct passwd *__restrict __p,
Eric Andersen9615a082004-07-15 12:53:49 +000077 FILE *__restrict __f);
Eric Andersenab050f52001-01-27 06:01:43 +000078
Eric Andersen9615a082004-07-15 12:53:49 +000079/* Search for an entry with a matching user ID. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000080extern struct passwd *getpwuid(uid_t __uid);
Eric Andersen9615a082004-07-15 12:53:49 +000081
82/* Search for an entry with a matching username. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000083extern struct passwd *getpwnam(__const char *__name);
Eric Andersen9615a082004-07-15 12:53:49 +000084
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
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000093extern int getpwent_r(struct passwd *__restrict __resultbuf,
Eric Andersen9615a082004-07-15 12:53:49 +000094 char *__restrict __buffer, size_t __buflen,
95 struct passwd **__restrict __result);
96
Denis Vlasenkocb04ff52006-12-30 21:11:57 +000097extern int getpwuid_r(uid_t __uid,
Eric Andersen9615a082004-07-15 12:53:49 +000098 struct passwd *__restrict __resultbuf,
99 char *__restrict __buffer, size_t __buflen,
100 struct passwd **__restrict __result);
101
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000102extern int getpwnam_r(__const char *__restrict __name,
Eric Andersen9615a082004-07-15 12:53:49 +0000103 struct passwd *__restrict __resultbuf,
104 char *__restrict __buffer, size_t __buflen,
105 struct passwd **__restrict __result);
106
Eric Andersen9615a082004-07-15 12:53:49 +0000107/* Read an entry from STREAM. This function is not standardized and
108 probably never will. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000109extern int fgetpwent_r(FILE *__restrict __stream,
Eric Andersen9615a082004-07-15 12:53:49 +0000110 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. */
Denis Vlasenkocb04ff52006-12-30 21:11:57 +0000117extern int getpw(uid_t __uid, char *__buffer);
Eric Andersen9615a082004-07-15 12:53:49 +0000118
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000119#if __GNUC_PREREQ(4,1)
120# pragma GCC visibility pop
Eric Andersen9615a082004-07-15 12:53:49 +0000121#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000122
123#endif /* pwd.h */