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