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. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)pwd_mkdb.8 8.1 (Berkeley) 6/6/93 29.\" $FreeBSD$ 30.\" 31.Dd March 25, 2023 32.Dt PWD_MKDB 8 33.Os 34.Sh NAME 35.Nm pwd_mkdb 36.Nd "generate the password databases" 37.Sh SYNOPSIS 38.Nm 39.Op Fl CiNp 40.Op Fl d Ar directory 41.Op Fl s Ar cachesize 42.Op Fl u Ar username 43.Ar file 44.Sh DESCRIPTION 45The 46.Nm 47utility creates 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 file is installed into 56.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 C 65Check if the password file is in the correct format. 66Do not 67change, add, or remove any files. 68.It Fl d Ar directory 69Store databases into specified destination directory instead of 70.Pa /etc . 71.It Fl i 72Ignore locking failure of the 73.Pa master.passwd 74file. 75This option is intended to be used to build password files in 76the release process over NFS where no contention can happen. 77A non-default directory must also be specified with the 78.Fl d 79option for locking to be ignored. 80Other use of this option is strongly discouraged. 81.It Fl N 82Tell 83.Nm 84to exit with an error if it cannot obtain a lock on the file. 85By default, 86we block waiting for a lock on the source file. 87The lock is held through 88the rebuilding of the database. 89.It Fl p 90Create a Version 7 style password file and install it into 91.Pa /etc/passwd . 92.It Fl s Ar cachesize 93Specify in megabytes the size of the memory cache used by the 94hashing library. 95On systems with a large user base, a small cache 96size can lead to prohibitively long database file rebuild times. 97As a rough guide, the memory usage of 98.Nm 99in megabytes will be a little bit more than twice the figure 100specified here. 101The default is 2 megabytes. 102.It Fl u Ar username 103Only update the record for the specified user. 104Utilities that 105operate on a single user can use this option to avoid the 106overhead of rebuilding the entire database. 107.El 108.Pp 109The two databases differ in that the secure version contains the user's 110encrypted password and the insecure version has an asterisk (``*'') 111.Pp 112The databases are used by the C library password routines (see 113.Xr getpwent 3 ) . 114.Pp 115The 116.Nm 117utility exits zero on success, non-zero on failure. 118.Sh ENVIRONMENT 119If the 120.Ev PW_SCAN_BIG_IDS 121environment variable is set, 122.Nm 123will suppress the warning messages that are 124normally generated for large user and group IDs. 125Such IDs can cause serious problems with software 126that makes assumptions about the values of IDs. 127.Sh FILES 128.Bl -tag -width Pa -compact 129.It Pa /etc/pwd.db 130The insecure password database file. 131.It Pa /etc/pwd.db.tmp 132A temporary file. 133.It Pa /etc/spwd.db 134The secure password database file. 135.It Pa /etc/spwd.db.tmp 136A temporary file. 137.It Pa /etc/master.passwd 138The current password file. 139.It Pa /etc/passwd 140A Version 7 format password file. 141.El 142.Sh EXAMPLES 143Regenerate the password database after manually editing or replacing 144the password file: 145.Bd -literal -offset -indent 146/usr/sbin/pwd_mkdb -p /etc/master.passwd 147.Ed 148.Sh COMPATIBILITY 149Previous versions of the system had a program similar to 150.Nm , 151.Xr mkpasswd 8 , 152which built 153.Xr dbm 3 154style databases for the password file but depended on the calling programs 155to install them. 156The program was renamed in order that previous users of the program 157not be surprised by the changes in functionality. 158.Sh SEE ALSO 159.Xr chpass 1 , 160.Xr passwd 1 , 161.Xr db 3 , 162.Xr getpwent 3 , 163.Xr passwd 5 , 164.Xr vipw 8 165.Sh BUGS 166Because of the necessity for atomic update of the password files, 167.Nm 168uses 169.Xr rename 2 170to install them. 171This, however, requires that the file specified on the command line live 172on the same file system as the 173.Pa /etc 174directory. 175.Pp 176There are the obvious races with multiple people running 177.Nm 178on different password files at the same time. 179The front-ends to 180.Nm , 181.Xr chpass 1 , 182.Xr passwd 1 183and 184.Xr vipw 8 , 185handle the locking necessary to avoid this problem. 186