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