xref: /netbsd-src/usr.sbin/pwd_mkdb/pwd_mkdb.8 (revision 6ea46cb5e46c49111a6ecf3bcbe3c7e2730fe9f6)
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.\"	from: @(#)pwd_mkdb.8	8.1 (Berkeley) 6/6/93
33.\"	$Id: pwd_mkdb.8,v 1.5 1994/09/16 21:05:14 mycroft Exp $
34.\"
35.Dd June 6, 1993
36.Dt PWD_MKDB 8
37.Os
38.Sh NAME
39.Nm pwd_mkdb
40.Nd "generate the password databases"
41.Sh SYNOPSIS
42.Nm pwd_mkdb
43.Op Fl p
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.El
68.Pp
69The two databases differ in that the secure version contains the user's
70encrypted password and the insecure version has an asterisk (``*'')
71.Pp
72The databases are used by the C library password routines (see
73.Xr getpwent 3 ) .
74.Pp
75.Nm Pwd_mkdb
76exits zero on success, non-zero on failure.
77.Sh FILES
78.Bl -tag -width Pa -compact
79.It Pa /etc/master.passwd
80The current password file.
81.It Pa /etc/passwd
82A Version 7 format password file.
83.It Pa /etc/pwd.db
84The insecure password database file.
85.It Pa /etc/pwd.db.tmp
86A temporary file.
87.It Pa /etc/spwd.db
88The secure password database file.
89.It Pa /etc/spwd.db.tmp
90A temporary file.
91.El
92.Sh BUGS
93Because of the necessity for atomic update of the password files,
94.Nm pwd_mkdb
95uses
96.Xr rename 2
97to install them.
98This, however, requires that the file specified on the command line live
99on the same file system as the
100.Dq Pa /etc
101directory.
102.Pp
103There are the obvious races with multiple people running
104.Nm pwd_mkdb
105on different password files at the same time.
106The front-ends to
107.Nm pwd_mkdb ,
108.Xr chpass 1 ,
109.Xr passwd 1
110and
111.Xr vipw 8 ,
112handle the locking necessary to avoid this problem.
113.Sh COMPATIBILITY
114Previous versions of the system had a program similar to
115.Nm pwd_mkdb ,
116.Xr mkpasswd 8 ,
117which built
118.Xr dbm 3
119style databases for the password file but depended on the calling programs
120to install them.
121The program was renamed in order that previous users of the program
122not be surprised by the changes in functionality.
123.Sh SEE ALSO
124.Xr chpass 1 ,
125.Xr passwd 1 ,
126.Xr db 3 ,
127.Xr getpwent 3 ,
128.Xr passwd 5 ,
129.Xr vipw 8
130