master
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)pwd.h 8.2 (Berkeley) 1/21/94
37 */
38
39#ifndef _PWD_H_
40#define _PWD_H_
41
42#include <sys/cdefs.h>
43#include <sys/_types.h>
44
45#ifndef _GID_T_DECLARED
46typedef __gid_t gid_t;
47#define _GID_T_DECLARED
48#endif
49
50#ifndef _TIME_T_DECLARED
51typedef __time_t time_t;
52#define _TIME_T_DECLARED
53#endif
54
55#ifndef _UID_T_DECLARED
56typedef __uid_t uid_t;
57#define _UID_T_DECLARED
58#endif
59
60#ifndef _SIZE_T_DECLARED
61typedef __size_t size_t;
62#define _SIZE_T_DECLARED
63#endif
64
65#define _PATH_PWD "/etc"
66#define _PATH_PASSWD "/etc/passwd"
67#define _PASSWD "passwd"
68#define _PATH_MASTERPASSWD "/etc/master.passwd"
69#define _MASTERPASSWD "master.passwd"
70
71#define _PATH_MP_DB "/etc/pwd.db"
72#define _MP_DB "pwd.db"
73#define _PATH_SMP_DB "/etc/spwd.db"
74#define _SMP_DB "spwd.db"
75
76#define _PATH_PWD_MKDB "/usr/sbin/pwd_mkdb"
77
78/* Historically, the keys in _PATH_MP_DB/_PATH_SMP_DB had the format
79 * `1 octet tag | key', where the tag is one of the _PW_KEY* values
80 * listed below. These values happen to be ASCII digits. Starting
81 * with FreeBSD 5.1, the tag is now still a single octet, but the
82 * upper 4 bits are interpreted as a version. Pre-FreeBSD 5.1 format
83 * entries are version `3' -- this conveniently results in the same
84 * key values as before. The new, architecture-independent entries
85 * are version `4'.
86 * As it happens, some applications read the database directly.
87 * (Bad app, no cookie!) Thus, we leave the _PW_KEY* symbols at their
88 * old pre-FreeBSD 5.1 values so these apps still work. Consequently
89 * we have to muck around a bit more to get the correct, versioned
90 * tag, and that is what the _PW_VERSIONED macro is about.
91 */
92
93#define _PW_VERSION_MASK '\xF0'
94#define _PW_VERSIONED(x, v) ((unsigned char)(((x) & 0xCF) | ((v)<<4)))
95
96#define _PW_KEYBYNAME '\x31' /* stored by name */
97#define _PW_KEYBYNUM '\x32' /* stored by entry in the "file" */
98#define _PW_KEYBYUID '\x33' /* stored by uid */
99#define _PW_KEYYPENABLED '\x34' /* YP is enabled */
100#define _PW_KEYYPBYNUM '\x35' /* special +@netgroup entries */
101
102/* The database also contains a key to indicate the format version of
103 * the entries therein. There may be other, older versioned entries
104 * as well.
105 */
106#define _PWD_VERSION_KEY "\xFF" "VERSION"
107#define _PWD_CURRENT_VERSION '\x04'
108
109#define _PASSWORD_EFMT1 '_' /* extended encryption format */
110
111#define _PASSWORD_LEN 128 /* max length, not counting NULL */
112
113struct passwd {
114 char *pw_name; /* user name */
115 char *pw_passwd; /* encrypted password */
116 uid_t pw_uid; /* user uid */
117 gid_t pw_gid; /* user gid */
118 time_t pw_change; /* password change time */
119 char *pw_class; /* user access class */
120 char *pw_gecos; /* Honeywell login info */
121 char *pw_dir; /* home directory */
122 char *pw_shell; /* default shell */
123 time_t pw_expire; /* account expiration */
124 int pw_fields; /* internal: fields filled in */
125};
126
127/* Mapping from fields to bits for pw_fields. */
128#define _PWF(x) (1 << x)
129#define _PWF_NAME _PWF(0)
130#define _PWF_PASSWD _PWF(1)
131#define _PWF_UID _PWF(2)
132#define _PWF_GID _PWF(3)
133#define _PWF_CHANGE _PWF(4)
134#define _PWF_CLASS _PWF(5)
135#define _PWF_GECOS _PWF(6)
136#define _PWF_DIR _PWF(7)
137#define _PWF_SHELL _PWF(8)
138#define _PWF_EXPIRE _PWF(9)
139
140/* XXX These flags are bogus. With nsswitch, there are many
141 * possible sources and they cannot be represented in a small integer.
142 */
143#define _PWF_SOURCE 0x3000
144#define _PWF_FILES 0x1000
145#define _PWF_NIS 0x2000
146#define _PWF_HESIOD 0x3000
147
148__BEGIN_DECLS
149struct passwd *getpwnam(const char *);
150struct passwd *getpwuid(uid_t);
151
152#if __XSI_VISIBLE >= 500
153void endpwent(void);
154struct passwd *getpwent(void);
155void setpwent(void);
156#endif
157
158#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE >= 500
159int getpwnam_r(const char *, struct passwd *, char *, size_t,
160 struct passwd **);
161int getpwuid_r(uid_t, struct passwd *, char *, size_t,
162 struct passwd **);
163#endif
164
165#if __BSD_VISIBLE
166int getpwent_r(struct passwd *, char *, size_t, struct passwd **);
167int setpassent(int);
168const char *user_from_uid(uid_t, int);
169int uid_from_user(const char *, uid_t *);
170int pwcache_userdb(int (*)(int), void (*)(void),
171 struct passwd * (*)(const char *),
172 struct passwd * (*)(uid_t));
173#endif
174__END_DECLS
175
176#endif /* !_PWD_H_ */