xref: /freebsd/usr.sbin/pwd_mkdb/pwd_mkdb.8 (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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 p
43.Op Fl d Ar directory
44.Ar file
45.Sh DESCRIPTION
46.Nm Pwd_mkdb
47creates
48.Xr db 3
49style secure and insecure databases for the specified file.
50These databases are then installed into
51.Dq Pa /etc/spwd.db
52and
53.Dq Pa /etc/pwd.db
54respectively.
55The file is installed into
56.Dq Pa /etc/master.passwd .
57The file must be in the correct format (see
58.Xr passwd 5 ) .
59It is important to note that the format used in this system is
60different from the historic Version 7 style format.
61.Pp
62The options are as follows:
63.Bl -tag -width flag
64.It Fl p
65Create a Version 7 style password file and install it into
66.Dq Pa /etc/passwd .
67.It Fl d
68Store databases into specified destination directory instead of
69.Dq Pa /etc .
70.El
71.Pp
72The two databases differ in that the secure version contains the user's
73encrypted password and the insecure version has an asterisk (``*'')
74.Pp
75The databases are used by the C library password routines (see
76.Xr getpwent 3 ) .
77.Pp
78.Nm Pwd_mkdb
79exits zero on success, non-zero on failure.
80.Sh FILES
81.Bl -tag -width Pa -compact
82.It Pa /etc/pwd.db
83The insecure password database file.
84.It Pa /etc/pwd.db.tmp
85A temporary file.
86.It Pa /etc/spwd.db
87The secure password database file.
88.It Pa /etc/spwd.db.tmp
89A temporary file.
90.It Pa /etc/master.passwd
91The current password file.
92.It Pa /etc/passwd
93A Version 7 format password file.
94.El
95.Sh BUGS
96Because of the necessity for atomic update of the password files,
97.Nm pwd_mkdb
98uses
99.Xr rename 2
100to install them.
101This, however, requires that the file specified on the command line live
102on the same file system as the
103.Dq Pa /etc
104directory.
105.Pp
106There are the obvious races with multiple people running
107.Nm pwd_mkdb
108on different password files at the same time.
109The front-ends to
110.Nm pwd_mkdb ,
111.Xr chpass 1 ,
112.Xr passwd 1
113and
114.Xr vipw 8 ,
115handle the locking necessary to avoid this problem.
116.Sh COMPATIBILITY
117Previous versions of the system had a program similar to
118.Nm pwd_mkdb ,
119.Xr mkpasswd 8 ,
120which built
121.Xr dbm 3
122style databases for the password file but depended on the calling programs
123to install them.
124The program was renamed in order that previous users of the program
125not be surprised by the changes in functionality.
126.Sh SEE ALSO
127.Xr chpass 1 ,
128.Xr passwd 1 ,
129.Xr db 3 ,
130.Xr getpwent 3 ,
131.Xr passwd 5 ,
132.Xr vipw 8
133