usr.sbin/pwd_mkdb/pwd_mkdb.8

   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 April 30, 2018
  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 BCiLNp
  40 .Op Fl d Ar directory
  41 .Op Fl s Ar cachesize
  42 .Op Fl u Ar username
  43 .Ar file
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility creates
  48 .Xr db 3
  49 style secure and insecure databases for the specified file.
  50 These databases are then installed into
  51 .Pa /etc/spwd.db
  52 and
  53 .Pa /etc/pwd.db
  54 respectively.
  55 The file is installed into
  56 .Pa /etc/master.passwd .
  57 The file must be in the correct format (see
  58 .Xr passwd 5 ) .
  59 It is important to note that the format used in this system is
  60 different from the historic Version 7 style format.
  61 .Pp
  62 The options are as follows:
  63 .Bl -tag -width flag
  64 .It Fl C
  65 Check if the password file is in the correct format.
  66 Do not
  67 change, add, or remove any files.
  68 .It Fl N
  69 Tell
  70 .Nm
  71 to exit with an error if it cannot obtain a lock on the file.
  72 By default,
  73 we block waiting for a lock on the source file.
  74 The lock is held through
  75 the rebuilding of the database.
  76 .It Fl p
  77 Create a Version 7 style password file and install it into
  78 .Pa /etc/passwd .
  79 .It Fl i
  80 Ignore locking failure of the
  81 .Pa master.passwd
  82 file.
  83 This option is intended to be used to build password files in
  84 the release process over NFS where no contention can happen.
  85 A non-default directory must also be specified with the
  86 .Fl d
  87 option for locking to be ignored.
  88 Other use of this option is strongly discouraged.
  89 .It Fl d Ar directory
  90 Store databases into specified destination directory instead of
  91 .Pa /etc .
  92 .It Fl u Ar username
  93 Only update the record for the specified user.
  94 Utilities that
  95 operate on a single user can use this option to avoid the
  96 overhead of rebuilding the entire database.
  97 .It Fl s Ar cachesize
  98 Specify in megabytes the size of the memory cache used by the
  99 hashing library.
 100 On systems with a large user base, a small cache
 101 size can lead to prohibitively long database file rebuild times.
 102 As a rough guide, the memory usage of
 103 .Nm
 104 in megabytes will be a little bit more than twice the figure
 105 specified here.
 106 The default is 2 megabytes.
 107 .El
 108 .Pp
 109 The two databases differ in that the secure version contains the user's
 110 encrypted password and the insecure version has an asterisk (``*'')
 111 .Pp
 112 The databases are used by the C library password routines (see
 113 .Xr getpwent 3 ) .
 114 .Pp
 115 The following options affected the generation of legacy entries,
 116 and are now deprecated.
 117 .Bl -tag -width flag
 118 .It Fl B
 119 Store data in big-endian format.
 120 .It Fl L
 121 Store data in little-endian format.
 122 .El
 123 .Pp
 124 The
 125 .Nm
 126 utility exits zero on success, non-zero on failure.
 127 .Sh ENVIRONMENT
 128 If the
 129 .Ev PW_SCAN_BIG_IDS
 130 environment variable is set,
 131 .Nm
 132 will suppress the warning messages that are
 133 normally generated for large user and group IDs.
 134 Such IDs can cause serious problems with software
 135 that makes assumptions about the values of IDs.
 136 .Sh FILES
 137 .Bl -tag -width Pa -compact
 138 .It Pa /etc/pwd.db
 139 The insecure password database file.
 140 .It Pa /etc/pwd.db.tmp
 141 A temporary file.
 142 .It Pa /etc/spwd.db
 143 The secure password database file.
 144 .It Pa /etc/spwd.db.tmp
 145 A temporary file.
 146 .It Pa /etc/master.passwd
 147 The current password file.
 148 .It Pa /etc/passwd
 149 A Version 7 format password file.
 150 .El
 151 .Sh EXAMPLES
 152 Regenerate the password database after manually editing or replacing
 153 the password file:
 154 .Bd -literal -offset -indent
 155 /usr/sbin/pwd_mkdb -p /etc/master.passwd
 156 .Ed
 157 .Sh COMPATIBILITY
 158 Previous versions of the system had a program similar to
 159 .Nm ,
 160 .Xr mkpasswd 8 ,
 161 which built
 162 .Xr dbm 3
 163 style databases for the password file but depended on the calling programs
 164 to install them.
 165 The program was renamed in order that previous users of the program
 166 not be surprised by the changes in functionality.
 167 .Sh SEE ALSO
 168 .Xr chpass 1 ,
 169 .Xr passwd 1 ,
 170 .Xr db 3 ,
 171 .Xr getpwent 3 ,
 172 .Xr passwd 5 ,
 173 .Xr vipw 8
 174 .Sh BUGS
 175 Because of the necessity for atomic update of the password files,
 176 .Nm
 177 uses
 178 .Xr rename 2
 179 to install them.
 180 This, however, requires that the file specified on the command line live
 181 on the same file system as the
 182 .Pa /etc
 183 directory.
 184 .Pp
 185 There are the obvious races with multiple people running
 186 .Nm
 187 on different password files at the same time.
 188 The front-ends to
 189 .Nm ,
 190 .Xr chpass 1 ,
 191 .Xr passwd 1
 192 and
 193 .Xr vipw 8 ,
 194 handle the locking necessary to avoid this problem.