pwd.h revision 113596
1/*-
2 * Copyright (c) 1989, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *	This product includes software developed by the University of
21 *	California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 *    may be used to endorse or promote products derived from this software
24 *    without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 *	@(#)pwd.h	8.2 (Berkeley) 1/21/94
39 * $FreeBSD: head/include/pwd.h 113596 2003-04-17 14:15:26Z nectar $
40 */
41
42#ifndef _PWD_H_
43#define	_PWD_H_
44
45#include <sys/cdefs.h>
46#include <sys/_types.h>
47
48#ifndef _GID_T_DECLARED
49typedef	__gid_t		gid_t;
50#define	_GID_T_DECLARED
51#endif
52
53#ifndef _TIME_T_DECLARED
54typedef	__time_t	time_t;
55#define	_TIME_T_DECLARED
56#endif
57
58#ifndef _UID_T_DECLARED
59typedef	__uid_t		uid_t;
60#define	_UID_T_DECLARED
61#endif
62
63#ifndef _SIZE_T_DECLARED
64typedef __size_t	size_t;
65#define _SIZE_T_DECLARED
66#endif
67
68#define _PATH_PWD		"/etc"
69#define	_PATH_PASSWD		"/etc/passwd"
70#define	_PASSWD			"passwd"
71#define	_PATH_MASTERPASSWD	"/etc/master.passwd"
72#define	_MASTERPASSWD		"master.passwd"
73
74#define	_PATH_MP_DB		"/etc/pwd.db"
75#define	_MP_DB			"pwd.db"
76#define	_PATH_SMP_DB		"/etc/spwd.db"
77#define	_SMP_DB			"spwd.db"
78
79#define	_PATH_PWD_MKDB		"/usr/sbin/pwd_mkdb"
80
81#define _PWD_VERSION_KEY	"\xFF" "VERSION"
82#define _PWD_CURRENT_VERSION	'\x04'
83
84#define _PW_VERSION_MASK	'0xF0'
85#define _PW_VERSION(x)		((unsigned char)((x)<<4))
86
87#define	_PW_KEYBYNAME		'\x01'	/* stored by name */
88#define	_PW_KEYBYNUM		'\x02'	/* stored by entry in the "file" */
89#define	_PW_KEYBYUID		'\x03'	/* stored by uid */
90#define _PW_KEYYPENABLED	'\x04'	/* YP is enabled */
91#define	_PW_KEYYPBYNUM		'\x05'	/* special +@netgroup entries */
92
93#define	_PASSWORD_EFMT1		'_'	/* extended encryption format */
94
95#define	_PASSWORD_LEN		128	/* max length, not counting NULL */
96
97struct passwd {
98	char	*pw_name;		/* user name */
99	char	*pw_passwd;		/* encrypted password */
100	uid_t	pw_uid;			/* user uid */
101	gid_t	pw_gid;			/* user gid */
102	time_t	pw_change;		/* password change time */
103	char	*pw_class;		/* user access class */
104	char	*pw_gecos;		/* Honeywell login info */
105	char	*pw_dir;		/* home directory */
106	char	*pw_shell;		/* default shell */
107	time_t	pw_expire;		/* account expiration */
108	int	pw_fields;		/* internal: fields filled in */
109};
110
111/* Mapping from fields to bits for pw_fields. */
112#define _PWF(x)		(1 << x)
113#define _PWF_NAME	_PWF(0)
114#define _PWF_PASSWD	_PWF(1)
115#define _PWF_UID	_PWF(2)
116#define _PWF_GID	_PWF(3)
117#define _PWF_CHANGE	_PWF(4)
118#define _PWF_CLASS	_PWF(5)
119#define _PWF_GECOS	_PWF(6)
120#define _PWF_DIR	_PWF(7)
121#define _PWF_SHELL	_PWF(8)
122#define _PWF_EXPIRE	_PWF(9)
123
124/* XXX These flags are bogus.  With nsswitch, there are many
125 * possible sources and they cannot be represented in a small integer.
126 */
127#define _PWF_SOURCE	0x3000
128#define _PWF_FILES	0x1000
129#define _PWF_NIS	0x2000
130#define _PWF_HESIOD	0x3000
131
132__BEGIN_DECLS
133struct passwd	*getpwnam(const char *);
134struct passwd	*getpwuid(uid_t);
135
136#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE >= 500
137void		 endpwent(void);
138struct passwd	*getpwent(void);
139void		 setpwent(void);
140int		 getpwnam_r(const char *, struct passwd *, char *, size_t,
141		    struct passwd **);
142int		 getpwuid_r(uid_t, struct passwd *, char *, size_t,
143		    struct passwd **);
144#endif
145
146#if __BSD_VISIBLE
147int		 getpwent_r(struct passwd *, char *, size_t, struct passwd **);
148int		 setpassent(int);
149const char	*user_from_uid(uid_t, int);
150#endif
151__END_DECLS
152
153#endif /* !_PWD_H_ */
154