freebsd-nq/usr.sbin/pwd_mkdb/pwd_mkdb.8

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)pwd_mkdb.8	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd October 20, 2018
.Dt PWD_MKDB 8
.Os
.Sh NAME
.Nm pwd_mkdb
.Nd "generate the password databases"
.Sh SYNOPSIS
.Nm
.Op Fl CiNp
.Op Fl d Ar directory
.Op Fl s Ar cachesize
.Op Fl u Ar username
.Ar file
.Sh DESCRIPTION
The
.Nm
utility creates
.Xr db 3
style secure and insecure databases for the specified file.
These databases are then installed into
.Pa /etc/spwd.db
and
.Pa /etc/pwd.db
respectively.
The file is installed into
.Pa /etc/master.passwd .
The file must be in the correct format (see
.Xr passwd 5 ) .
It is important to note that the format used in this system is
different from the historic Version 7 style format.
.Pp
The options are as follows:
.Bl -tag -width flag
.It Fl C
Check if the password file is in the correct format.
Do not
change, add, or remove any files.
.It Fl N
Tell
.Nm
to exit with an error if it cannot obtain a lock on the file.
By default,
we block waiting for a lock on the source file.
The lock is held through
the rebuilding of the database.
.It Fl p
Create a Version 7 style password file and install it into
.Pa /etc/passwd .
.It Fl i
Ignore locking failure of the
.Pa master.passwd
file.
This option is intended to be used to build password files in
the release process over NFS where no contention can happen.
A non-default directory must also be specified with the
.Fl d
option for locking to be ignored.
Other use of this option is strongly discouraged.
.It Fl d Ar directory
Store databases into specified destination directory instead of
.Pa /etc .
.It Fl u Ar username
Only update the record for the specified user.
Utilities that
operate on a single user can use this option to avoid the
overhead of rebuilding the entire database.
.It Fl s Ar cachesize
Specify in megabytes the size of the memory cache used by the
hashing library.
On systems with a large user base, a small cache
size can lead to prohibitively long database file rebuild times.
As a rough guide, the memory usage of
.Nm
in megabytes will be a little bit more than twice the figure
specified here.
The default is 2 megabytes.
.El
.Pp
The two databases differ in that the secure version contains the user's
encrypted password and the insecure version has an asterisk (``*'')
.Pp
The databases are used by the C library password routines (see
.Xr getpwent 3 ) .
.Pp
The
.Nm
utility exits zero on success, non-zero on failure.
.Sh ENVIRONMENT
If the
.Ev PW_SCAN_BIG_IDS
environment variable is set,
.Nm
will suppress the warning messages that are
normally generated for large user and group IDs.
Such IDs can cause serious problems with software
that makes assumptions about the values of IDs.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /etc/pwd.db
The insecure password database file.
.It Pa /etc/pwd.db.tmp
A temporary file.
.It Pa /etc/spwd.db
The secure password database file.
.It Pa /etc/spwd.db.tmp
A temporary file.
.It Pa /etc/master.passwd
The current password file.
.It Pa /etc/passwd
A Version 7 format password file.
.El
.Sh EXAMPLES
Regenerate the password database after manually editing or replacing
the password file:
.Bd -literal -offset -indent
/usr/sbin/pwd_mkdb -p /etc/master.passwd
.Ed
.Sh COMPATIBILITY
Previous versions of the system had a program similar to
.Nm ,
.Xr mkpasswd 8 ,
which built
.Xr dbm 3
style databases for the password file but depended on the calling programs
to install them.
The program was renamed in order that previous users of the program
not be surprised by the changes in functionality.
.Sh SEE ALSO
.Xr chpass 1 ,
.Xr passwd 1 ,
.Xr db 3 ,
.Xr getpwent 3 ,
.Xr passwd 5 ,
.Xr vipw 8
.Sh BUGS
Because of the necessity for atomic update of the password files,
.Nm
uses
.Xr rename 2
to install them.
This, however, requires that the file specified on the command line live
on the same file system as the
.Pa /etc
directory.
.Pp
There are the obvious races with multiple people running
.Nm
on different password files at the same time.
The front-ends to
.Nm ,
.Xr chpass 1 ,
.Xr passwd 1
and
.Xr vipw 8 ,
handle the locking necessary to avoid this problem.
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)pwd_mkdb.8 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\"`
pwd_mkdb: retire -B and -L endianness options Legacy v3 db support was retired in r333133, and it was v3 support that required the -B and -L options. The options were retained temporarily, but now that stable/12 has branched they can be removed. Sponsored by: The FreeBSD Foundation 2018-10-21 00:48:38 +00:00			`.Dd October 20, 2018`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Dt PWD_MKDB 8`
			`.Os`
			`.Sh NAME`
			`.Nm pwd_mkdb`
			`.Nd "generate the password databases"`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
pwd_mkdb: retire -B and -L endianness options Legacy v3 db support was retired in r333133, and it was v3 support that required the -B and -L options. The options were retained temporarily, but now that stable/12 has branched they can be removed. Sponsored by: The FreeBSD Foundation 2018-10-21 00:48:38 +00:00			`.Op Fl CiNp`
Added the -d <directory> functionality to allow construction of the password databases somewhere other than /etc. 1994-09-07 22:54:00 +00:00			`.Op Fl d Ar directory`
Allow specification of cache-size to pwd_mkdb PR: 5193 Reviewed by: phk Submitted by: Nick Hilliard <nick@foobar.org> 1998-04-19 07:15:34 +00:00			`.Op Fl s Ar cachesize`
Document the -u option. Forgotten by: guido 1997-04-04 00:49:35 +00:00			`.Op Fl u Ar username`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ar file`
			`.Sh DESCRIPTION`
The .Nm utility 2002-07-14 14:47:15 +00:00			`The`
			`.Nm`
			`utility creates`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Xr db 3`
			`style secure and insecure databases for the specified file.`
			`These databases are then installed into`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Pa /etc/spwd.db`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`and`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Pa /etc/pwd.db`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`respectively.`
			`The file is installed into`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Pa /etc/master.passwd .`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`The file must be in the correct format (see`
			`.Xr passwd 5 ) .`
			`It is important to note that the format used in this system is`
			`different from the historic Version 7 style format.`
			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width flag`
Rename the pwd_mkdb(8) option '-c' to '-C' for better compatiblity with BSD/OS. 1998-01-10 17:27:28 +00:00			`.It Fl C`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`Check if the password file is in the correct format.`
			`Do not`
New option: [-c] Check if the password file is in the correct format. Do not change, add, or remove any files. 1996-08-19 16:03:15 +00:00			`change, add, or remove any files.`
PR: bin/3478 Have pwd_mkdb lock the source file while rebuilding the database. When called by programs such as vipw, the source file is a temporary file and this does not conflict with the lock on /etc/master.passwd already held by vipw. When run manually, however, master.passwd is typically specified as the argument and the locking prevents other programs from messing with master.passwd during the database rebuild. Also pwd_mkdb uses a blocking exclusive lock as it may be called from a script. The -N option was added to cause pwd_mkdb to get the lock non-blocking and exit with an error if the attempt fails, again useful for scripts. 1998-12-13 01:53:50 +00:00			`.It Fl N`
			`Tell`
It's bad enough to capitalize the name of the executable at the beginning of the sentence, but at the very least it shouldn't be done in the middle of a sentence! 2001-08-04 22:11:08 +00:00			`.Nm`
Mechanically kill hard sentence breaks. 2004-07-02 23:13:00 +00:00			`to exit with an error if it cannot obtain a lock on the file.`
			`By default,`
			`we block waiting for a lock on the source file.`
			`The lock is held through`
PR: bin/3478 Have pwd_mkdb lock the source file while rebuilding the database. When called by programs such as vipw, the source file is a temporary file and this does not conflict with the lock on /etc/master.passwd already held by vipw. When run manually, however, master.passwd is typically specified as the argument and the locking prevents other programs from messing with master.passwd during the database rebuild. Also pwd_mkdb uses a blocking exclusive lock as it may be called from a script. The -N option was added to cause pwd_mkdb to get the lock non-blocking and exit with an error if the attempt fails, again useful for scripts. 1998-12-13 01:53:50 +00:00			`the rebuilding of the database.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl p`
			`Create a Version 7 style password file and install it into`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Pa /etc/passwd .`
Add support for ignoring locking failures. This is only enabled when you've specified a directory. It is intended to be used in building custom releases over NFS where locking may be unreliable at best and there is no contention that the locking is designed to arbitrate. Other uses of this flag are discouraged. Document same in usage and man page (including the warning about unwise). Sponsored by: Timing Solutions 2004-07-21 17:38:04 +00:00			`.It Fl i`
			`Ignore locking failure of the`
			`.Pa master.passwd`
			`file.`
			`This option is intended to be used to build password files in`
			`the release process over NFS where no contention can happen.`
			`A non-default directory must also be specified with the`
			`.Fl d`
			`option for locking to be ignored.`
			`Other use of this option is strongly discouraged.`
Document the -u option. Forgotten by: guido 1997-04-04 00:49:35 +00:00			`.It Fl d Ar directory`
Added the -d <directory> functionality to allow construction of the password databases somewhere other than /etc. 1994-09-07 22:54:00 +00:00			`Store databases into specified destination directory instead of`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Pa /etc .`
Document the -u option. Forgotten by: guido 1997-04-04 00:49:35 +00:00			`.It Fl u Ar username`
Mechanically kill hard sentence breaks. 2004-07-02 23:13:00 +00:00			`Only update the record for the specified user.`
			`Utilities that`
Document the -u option. Forgotten by: guido 1997-04-04 00:49:35 +00:00			`operate on a single user can use this option to avoid the`
			`overhead of rebuilding the entire database.`
Allow specification of cache-size to pwd_mkdb PR: 5193 Reviewed by: phk Submitted by: Nick Hilliard <nick@foobar.org> 1998-04-19 07:15:34 +00:00			`.It Fl s Ar cachesize`
			`Specify in megabytes the size of the memory cache used by the`
Mechanically kill hard sentence breaks. 2004-07-02 23:13:00 +00:00			`hashing library.`
			`On systems with a large user base, a small cache`
Allow specification of cache-size to pwd_mkdb PR: 5193 Reviewed by: phk Submitted by: Nick Hilliard <nick@foobar.org> 1998-04-19 07:15:34 +00:00			`size can lead to prohibitively long database file rebuild times.`
			`As a rough guide, the memory usage of`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Allow specification of cache-size to pwd_mkdb PR: 5193 Reviewed by: phk Submitted by: Nick Hilliard <nick@foobar.org> 1998-04-19 07:15:34 +00:00			`in megabytes will be a little bit more than twice the figure`
Mechanically kill hard sentence breaks. 2004-07-02 23:13:00 +00:00			`specified here.`
			`The default is 2 megabytes.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.El`
			`.Pp`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`The two databases differ in that the secure version contains the user's`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			encrypted password and the insecure version has an asterisk (``*'')
			`.Pp`
			`The databases are used by the C library password routines (see`
			`.Xr getpwent 3 ) .`
			`.Pp`
The .Nm utility 2002-07-14 14:47:15 +00:00			`The`
			`.Nm`
			`utility exits zero on success, non-zero on failure.`
Replace the -q option to pwd_mkdb with a test for PW_SCAN_BIG_IDS in the environment. This allows big ID warnings to be suppressed for vipw and chpass as well. Since the environment variable test is only performed for callers of pw_scan() that do not set pw_big_ids_warning, the test can still be overriden. Currently, chpass and pwd_mkdb are the only users of pw_scan() and neither of them overrides the environment variable test. 1999-12-02 16:39:15 +00:00			`.Sh ENVIRONMENT`
			`If the`
			`.Ev PW_SCAN_BIG_IDS`
			`environment variable is set,`
			`.Nm`
			`will suppress the warning messages that are`
			`normally generated for large user and group IDs.`
			`Such IDs can cause serious problems with software`
			`that makes assumptions about the values of IDs.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh FILES`
			`.Bl -tag -width Pa -compact`
Added the -d <directory> functionality to allow construction of the password databases somewhere other than /etc. 1994-09-07 22:54:00 +00:00			`.It Pa /etc/pwd.db`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`The insecure password database file.`
Added the -d <directory> functionality to allow construction of the password databases somewhere other than /etc. 1994-09-07 22:54:00 +00:00			`.It Pa /etc/pwd.db.tmp`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`A temporary file.`
Added the -d <directory> functionality to allow construction of the password databases somewhere other than /etc. 1994-09-07 22:54:00 +00:00			`.It Pa /etc/spwd.db`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`The secure password database file.`
Added the -d <directory> functionality to allow construction of the password databases somewhere other than /etc. 1994-09-07 22:54:00 +00:00			`.It Pa /etc/spwd.db.tmp`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`A temporary file.`
			`.It Pa /etc/master.passwd`
			`The current password file.`
			`.It Pa /etc/passwd`
			`A Version 7 format password file.`
			`.El`
Add an example of the most common use case. MFC after: 1 week 2014-02-05 09:28:02 +00:00			`.Sh EXAMPLES`
			`Regenerate the password database after manually editing or replacing`
			`the password file:`
			`.Bd -literal -offset -indent`
Add -p to the example (why isn't this the default?) MFC after: 1 week 2014-02-06 09:57:27 +00:00			`/usr/sbin/pwd_mkdb -p /etc/master.passwd`
Add an example of the most common use case. MFC after: 1 week 2014-02-05 09:28:02 +00:00			`.Ed`
Sort sections. 2005-01-18 20:02:45 +00:00			`.Sh COMPATIBILITY`
			`Previous versions of the system had a program similar to`
			`.Nm ,`
			`.Xr mkpasswd 8 ,`
			`which built`
			`.Xr dbm 3`
			`style databases for the password file but depended on the calling programs`
			`to install them.`
			`The program was renamed in order that previous users of the program`
			`not be surprised by the changes in functionality.`
			`.Sh SEE ALSO`
			`.Xr chpass 1 ,`
			`.Xr passwd 1 ,`
			`.Xr db 3 ,`
			`.Xr getpwent 3 ,`
			`.Xr passwd 5 ,`
			`.Xr vipw 8`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh BUGS`
			`Because of the necessity for atomic update of the password files,`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`uses`
			`.Xr rename 2`
			`to install them.`
			`This, however, requires that the file specified on the command line live`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`on the same file system as the`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Pa /etc`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`directory.`
			`.Pp`
			`There are the obvious races with multiple people running`
Staticize usage(). Cosmetics. 1997-10-10 06:27:07 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`on different password files at the same time.`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`The front-ends to`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm ,`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Xr chpass 1 ,`
			`.Xr passwd 1`
			`and`
			`.Xr vipw 8 ,`
			`handle the locking necessary to avoid this problem.`