1.\" $OpenBSD: pwd_mkdb.8,v 1.22 2007/05/31 19:20:28 jmc 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. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" from: @(#)pwd_mkdb.8 8.1 (Berkeley) 6/6/93 31.\" 32.Dd $Mdocdate: May 31 2007 $ 33.Dt PWD_MKDB 8 34.Os 35.Sh NAME 36.Nm pwd_mkdb 37.Nd generate the password databases 38.Sh SYNOPSIS 39.Nm pwd_mkdb 40.Op Fl c 41.Op Fl p | s 42.Op Fl d Ar directory 43.Op Fl u Ar username 44.Ar file 45.Sh DESCRIPTION 46.Nm 47creates 48.Xr db 3 49style secure and insecure databases for the specified file. 50These databases are then installed into 51.Pa /etc/spwd.db 52and 53.Pa /etc/pwd.db , 54respectively. 55The 56.Ar file 57argument is installed into 58.Pa /etc/master.passwd 59by renaming 60.Ar file . 61The 62.Ar file 63must be in the correct format (see 64.Xr passwd 5 ) . 65It is important to note that the format used in this system is 66different from the historic 6th Edition-style format. 67.Pp 68The options are as follows: 69.Bl -tag -width Ds 70.It Fl c 71Check if the password file is in the correct format. 72Do not change, add, or remove any files. 73.It Fl d Ar directory 74Operate in a base directory other than the default of 75.Pa /etc . 76All absolute paths (including 77.Ar file ) 78will be made relative to 79.Ar directory . 80Any directories specified as a part of 81.Ar file 82will be stripped off. 83This option is used to create password databases in directories 84other than 85.Pa /etc ; 86for instance in a 87.Xr chroot 8 88jail. 89.It Fl p 90Create a 6th Edition-style password file and install it into 91.Pa /etc/passwd . 92.It Fl s 93Only update the secure version of the database. 94This is most commonly used in conjunction with the 95.Fl u 96flag during a password change. 97Because the insecure database doesn't contain the password there 98is no reason to update it if the only change is in the password field. 99Cannot be used in conjunction with the 100.Fl p 101flag. 102.It Fl u Ar username 103Only update the record for the specified user. 104Utilities that operate on a single user can use this option to avoid the 105overhead of rebuilding the entire database. 106This option must never be used if the line number of the user's record in 107.Pa /etc/master.passwd 108has changed. 109.It Ar file 110The absolute path to a file in 111.Ar master.passwd 112format, as described in 113.Xr passwd 5 . 114.El 115.Pp 116The two databases differ in that the secure version contains the user's 117encrypted password and the insecure version has an asterisk 118.Pq Sq \&* . 119.Pp 120The databases are used by the C library password routines (see 121.Xr getpwent 3 ) . 122.Pp 123.Nm 124exits zero on success, non-zero on failure. 125.Sh FILES 126.Bl -tag -width /etc/master.passwd -compact 127.It Pa /etc/master.passwd 128current password file 129.It Pa /etc/passwd 130a 6th Edition-style password file 131.It Pa /etc/pwd.db 132insecure password database file 133.It Pa /etc/pwd.db.tmp 134temporary file 135.It Pa /etc/spwd.db 136secure password database file 137.It Pa /etc/spwd.db.tmp 138temporary file 139.El 140.Sh SEE ALSO 141.Xr chpass 1 , 142.Xr passwd 1 , 143.Xr db 3 , 144.Xr getpwent 3 , 145.Xr passwd 5 , 146.Xr vipw 8 147.Sh STANDARDS 148Previous versions of the system had a program similar to 149.Nm pwd_mkdb , 150.Xr mkpasswd , 151which built 152.Xr dbm 3 153style databases for the password file but depended on the calling programs 154to install them. 155The program was renamed in order that previous users of the program 156not be surprised by the changes in functionality. 157.Sh BUGS 158Because of the necessity for atomic update of the password files, 159.Nm 160uses 161.Xr rename 2 162to install them. 163This, however, requires that the file specified on the command line live 164on the same file system as the 165.Pa /etc 166directory. 167.Pp 168There are the obvious races with multiple people running 169.Nm 170on different password files at the same time. 171The front-ends to 172.Nm pwd_mkdb , 173.Xr chpass 1 , 174.Xr passwd 1 , 175and 176.Xr vipw 8 177handle the locking necessary to avoid this problem. 178