xref: /freebsd/usr.sbin/pwd_mkdb/pwd_mkdb.8 (revision e627b39baccd1ec9129690167cf5e6d860509655)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)pwd_mkdb.8	8.1 (Berkeley) 6/6/93
33.\"
34.Dd June 6, 1993
35.Dt PWD_MKDB 8
36.Os
37.Sh NAME
38.Nm pwd_mkdb
39.Nd "generate the password databases"
40.Sh SYNOPSIS
41.Nm pwd_mkdb
42.Op Fl c
43.Op Fl p
44.Op Fl d Ar directory
45.Ar file
46.Sh DESCRIPTION
47.Nm Pwd_mkdb
48creates
49.Xr db 3
50style secure and insecure databases for the specified file.
51These databases are then installed into
52.Dq Pa /etc/spwd.db
53and
54.Dq Pa /etc/pwd.db
55respectively.
56The file is installed into
57.Dq Pa /etc/master.passwd .
58The file must be in the correct format (see
59.Xr passwd 5 ) .
60It is important to note that the format used in this system is
61different from the historic Version 7 style format.
62.Pp
63The options are as follows:
64.Bl -tag -width flag
65.It Fl c
66Check if the password file is in the correct format. Do not
67change, add, or remove any files.
68.It Fl p
69Create a Version 7 style password file and install it into
70.Dq Pa /etc/passwd .
71.It Fl d
72Store databases into specified destination directory instead of
73.Dq Pa /etc .
74.El
75.Pp
76The two databases differ in that the secure version contains the user's
77encrypted password and the insecure version has an asterisk (``*'')
78.Pp
79The databases are used by the C library password routines (see
80.Xr getpwent 3 ) .
81.Pp
82.Nm Pwd_mkdb
83exits zero on success, non-zero on failure.
84.Sh FILES
85.Bl -tag -width Pa -compact
86.It Pa /etc/pwd.db
87The insecure password database file.
88.It Pa /etc/pwd.db.tmp
89A temporary file.
90.It Pa /etc/spwd.db
91The secure password database file.
92.It Pa /etc/spwd.db.tmp
93A temporary file.
94.It Pa /etc/master.passwd
95The current password file.
96.It Pa /etc/passwd
97A Version 7 format password file.
98.El
99.Sh BUGS
100Because of the necessity for atomic update of the password files,
101.Nm pwd_mkdb
102uses
103.Xr rename 2
104to install them.
105This, however, requires that the file specified on the command line live
106on the same file system as the
107.Dq Pa /etc
108directory.
109.Pp
110There are the obvious races with multiple people running
111.Nm pwd_mkdb
112on different password files at the same time.
113The front-ends to
114.Nm pwd_mkdb ,
115.Xr chpass 1 ,
116.Xr passwd 1
117and
118.Xr vipw 8 ,
119handle the locking necessary to avoid this problem.
120.Sh COMPATIBILITY
121Previous versions of the system had a program similar to
122.Nm pwd_mkdb ,
123.Xr mkpasswd 8 ,
124which built
125.Xr dbm 3
126style databases for the password file but depended on the calling programs
127to install them.
128The program was renamed in order that previous users of the program
129not be surprised by the changes in functionality.
130.Sh SEE ALSO
131.Xr chpass 1 ,
132.Xr passwd 1 ,
133.Xr db 3 ,
134.Xr getpwent 3 ,
135.Xr passwd 5 ,
136.Xr vipw 8
137