usr.bin/chpass/chpass.1

   1 .\" Copyright (c) 1988, 1990, 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 .\"     @(#)chpass.1    8.2 (Berkeley) 12/30/93
  29 .\" $FreeBSD: src/usr.bin/chpass/chpass.1,v 1.39 2005/08/02 21:38:02 seanc Exp $
  30 .\"
  31 .Dd December 30, 1993
  32 .Dt CHPASS 1
  33 .Os
  34 .Sh NAME
  35 .Nm chpass ,
  36 .Nm chfn ,
  37 .Nm chsh ,
  38 .Nm ypchpass ,
  39 .Nm ypchfn ,
  40 .Nm ypchsh
  41 .Nd add or change user database information
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl a Ar list
  45 .Op Fl p Ar encpass
  46 .Op Fl e Ar expiretime
  47 .Op Fl s Ar newshell
  48 .Op user
  49 .Nm
  50 .Op Fl oly
  51 .Op Fl a Ar list
  52 .Op Fl p Ar encpass
  53 .Op Fl e Ar expiretime
  54 .Op Fl s Ar newshell
  55 .Op Fl d Ar domain
  56 .Op Fl h Ar host
  57 .Op user
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 utility
  62 allows editing of the user database information associated
  63 with
  64 .Ar user
  65 or, by default, the current user.
  66 .Pp
  67 The
  68 .Nm chfn ,
  69 .Nm chsh ,
  70 .Nm ypchpass ,
  71 .Nm ypchfn
  72 and
  73 .Nm ypchsh
  74 utilities behave identically to
  75 .Nm .
  76 (There is only one program.)
  77 .Pp
  78 The information is formatted and supplied to an editor for changes.
  79 .Pp
  80 Only the information that the user is allowed to change is displayed.
  81 .Pp
  82 The options are as follows:
  83 .Bl -tag -width indent
  84 .It Fl a
  85 The super-user is allowed to directly supply a user database
  86 entry, in the format specified by
  87 .Xr passwd 5 ,
  88 as an argument.
  89 This argument must be a colon
  90 .Pq Dq \&:
  91 separated list of all the
  92 user database fields, although they may be empty.
  93 .It Fl p
  94 The super-user is allowed to directly supply an encrypted password field,
  95 in the format used by
  96 .Xr crypt 3 ,
  97 as an argument.
  98 .It Fl e Ar expiretime
  99 Change the account expire time.
 100 This option is used to set the expire time
 101 from a script as if it was done in the interactive editor.
 102 .It Fl s Ar newshell
 103 Attempt to change the user's shell to
 104 .Ar newshell .
 105 .El
 106 .Pp
 107 Possible display items are as follows:
 108 .Pp
 109 .Bl -tag -width "Other Information:" -compact -offset indent
 110 .It Login:
 111 user's login name
 112 .It Password:
 113 user's encrypted password
 114 .It Uid:
 115 user's login
 116 .It Gid:
 117 user's login group
 118 .It Class:
 119 user's general classification
 120 .It Change:
 121 password change time
 122 .It Expire:
 123 account expiration time
 124 .It Full Name:
 125 user's real name
 126 .It Office Location:
 127 user's office location (1)
 128 .It Office Phone:
 129 user's office phone (1)
 130 .It Home Phone:
 131 user's home phone (1)
 132 .It Other Information:
 133 any locally defined parameters for user (1)
 134 .It Home Directory:
 135 user's home directory
 136 .It Shell:
 137 user's login shell
 138 .Pp
 139 .It NOTE(1) -
 140 In the actual master.passwd file, these fields are comma-delimited
 141 fields embedded in the FullName field.
 142 .El
 143 .Pp
 144 The
 145 .Ar login
 146 field is the user name used to access the computer account.
 147 .Pp
 148 The
 149 .Ar password
 150 field contains the encrypted form of the user's password.
 151 .Pp
 152 The
 153 .Ar uid
 154 field is the number associated with the
 155 .Ar login
 156 field.
 157 Both of these fields should be unique across the system (and often
 158 across a group of systems) as they control file access.
 159 .Pp
 160 While it is possible to have multiple entries with identical login names
 161 and/or identical user id's, it is usually a mistake to do so.
 162 Routines
 163 that manipulate these files will often return only one of the multiple
 164 entries, and that one by random selection.
 165 .Pp
 166 The
 167 .Ar group
 168 field is the group that the user will be placed in at login.
 169 Since
 170 .Bx
 171 supports multiple groups (see
 172 .Xr groups 1 )
 173 this field currently has little special meaning.
 174 This field may be filled in with either a number or a group name (see
 175 .Xr group 5 ) .
 176 .Pp
 177 The
 178 .Ar class
 179 field references class descriptions in
 180 .Pa /etc/login.conf
 181 and is typically used to initialize the user's system resource limits
 182 when they login.
 183 .Pp
 184 The
 185 .Ar change
 186 field is the date by which the password must be changed.
 187 .Pp
 188 The
 189 .Ar expire
 190 field is the date on which the account expires.
 191 .Pp
 192 Both the
 193 .Ar change
 194 and
 195 .Ar expire
 196 fields should be entered in the form
 197 .Dq month day year
 198 where
 199 .Ar month
 200 is the month name (the first three characters are sufficient),
 201 .Ar day
 202 is the day of the month, and
 203 .Ar year
 204 is the year.
 205 .Pp
 206 Five fields are available for storing the user's
 207 .Ar full name , office location ,
 208 .Ar work
 209 and
 210 .Ar home telephone
 211 numbers and finally
 212 .Ar other information
 213 which is a single comma delimited string to represent any additional
 214 gecos fields (typically used for site specific user information).
 215 Note that
 216 .Xr finger 1
 217 will display the office location and office phone together under the
 218 heading
 219 .Ar Office: .
 220 .Pp
 221 The user's
 222 .Ar home directory
 223 is the full
 224 .Ux
 225 path name where the user
 226 will be placed at login.
 227 .Pp
 228 The
 229 .Ar shell
 230 field is the command interpreter the user prefers.
 231 If the
 232 .Ar shell
 233 field is empty, the Bourne shell,
 234 .Pa /bin/sh ,
 235 is assumed.
 236 When altering a login shell, and not the super-user, the user
 237 may not change from a non-standard shell or to a non-standard
 238 shell.
 239 Non-standard is defined as a shell not found in
 240 .Pa /etc/shells .
 241 .Pp
 242 Once the information has been verified,
 243 .Nm
 244 uses
 245 .Xr pwd_mkdb 8
 246 to update the user database.
 247 .Sh ENVIRONMENT
 248 The
 249 .Xr vi 1
 250 editor will be used unless the environment variable
 251 .Ev EDITOR
 252 is set to
 253 an alternate editor.
 254 When the editor terminates, the information is re-read and used to
 255 update the user database itself.
 256 Only the user, or the super-user, may edit the information associated
 257 with the user.
 258 .Pp
 259 See
 260 .Xr pwd_mkdb 8
 261 for an explanation of the impact of setting the
 262 .Ev PW_SCAN_BIG_IDS
 263 environment variable.
 264 .Sh NIS INTERACTION
 265 The
 266 .Nm
 267 utility can also be used in conjunction with NIS, however some restrictions
 268 apply.
 269 Currently,
 270 .Nm
 271 can only make changes to the NIS passwd maps through
 272 .Xr rpc.yppasswdd 8 ,
 273 which normally only permits changes to a user's password, shell and GECOS
 274 fields.
 275 Except when invoked by the super-user on the NIS master server,
 276 .Nm
 277 (and, similarly,
 278 .Xr passwd 1 )
 279 cannot use the
 280 .Xr rpc.yppasswdd 8
 281 server to change other user information or
 282 add new records to the NIS passwd maps.
 283 Furthermore,
 284 .Xr rpc.yppasswdd 8
 285 requires password authentication before it will make any
 286 changes.
 287 The only user allowed to submit changes without supplying
 288 a password is the super-user on the NIS master server; all other users,
 289 including those with root privileges on NIS clients (and NIS slave
 290 servers) must enter a password.
 291 (The super-user on the NIS master is allowed to bypass these restrictions
 292 largely for convenience: a user with root access
 293 to the NIS master server already has the privileges required to make
 294 updates to the NIS maps, but editing the map source files by hand can
 295 be cumbersome.
 296 .Pp
 297 Note: these exceptions only apply when the NIS master server is a
 298 .Fx
 299 or
 300 .Dx
 301 system).
 302 .Pp
 303 Consequently, except where noted, the following restrictions apply when
 304 .Nm
 305 is used with NIS:
 306 .Bl -enum -offset indent
 307 .It
 308 .Em "Only the shell and GECOS information may be changed" .
 309 All other
 310 fields are restricted, even when
 311 .Nm
 312 is invoked by the super-user.
 313 While support for
 314 changing other fields could be added, this would lead to
 315 compatibility problems with other NIS-capable systems.
 316 Even though the super-user may supply data for other fields
 317 while editing an entry, the extra information (other than the
 318 password -- see below) will be silently discarded.
 319 .Pp
 320 Exception: the super-user on the NIS master server is permitted to
 321 change any field.
 322 .It
 323 .Em "Password authentication is required" .
 324 The
 325 .Nm
 326 utility will prompt for the user's NIS password before effecting
 327 any changes.
 328 If the password is invalid, all changes will be
 329 discarded.
 330 .Pp
 331 Exception: the super-user on the NIS master server is allowed to
 332 submit changes without supplying a password.
 333 (The super-user may
 334 choose to turn off this feature using the
 335 .Fl o
 336 flag, described below.)
 337 .It
 338 .Em "Adding new records to the local password database is discouraged" .
 339 The
 340 .Nm
 341 utility will allow the administrator to add new records to the
 342 local password database while NIS is enabled, but this can lead to
 343 some confusion since the new records are appended to the end of
 344 the master password file, usually after the special NIS '+' entries.
 345 The administrator should use
 346 .Xr vipw 8
 347 to modify the local password
 348 file when NIS is running.
 349 .Pp
 350 The super-user on the NIS master server is permitted to add new records
 351 to the NIS password maps, provided the
 352 .Xr rpc.yppasswdd 8
 353 server has been started with the
 354 .Fl a
 355 flag to permitted additions (it refuses them by default).
 356 The
 357 .Nm
 358 utility tries to update the local password database by default; to update the
 359 NIS maps instead, invoke chpass with the
 360 .Fl y
 361 flag.
 362 .It
 363 .Em "Password changes are not permitted".
 364 Users should use
 365 .Xr passwd 1
 366 or
 367 .Xr yppasswd 1
 368 to change their NIS passwords.
 369 The super-user is allowed to specify
 370 a new password (even though the
 371 .Dq Password:
 372 field does not show
 373 up in the editor template, the super-user may add it back by hand),
 374 but even the super-user must supply the user's original password
 375 otherwise
 376 .Xr rpc.yppasswdd 8
 377 will refuse to update the NIS maps.
 378 .Pp
 379 Exception: the super-user on the NIS master server is permitted to
 380 change a user's NIS password with
 381 .Nm .
 382 .El
 383 .Pp
 384 There are also a few extra option flags that are available when
 385 .Nm
 386 is compiled with NIS support:
 387 .Bl -tag -width indent
 388 .It Fl l
 389 Force
 390 .Nm
 391 to modify the local copy of a user's password
 392 information in the event that a user exists in both
 393 the local and NIS databases.
 394 .It Fl y
 395 Opposite effect of
 396 .Fl l .
 397 This flag is largely redundant since
 398 .Nm
 399 operates on NIS entries by default if NIS is enabled.
 400 .It Fl d Ar domain
 401 Specify a particular NIS domain.
 402 The
 403 .Nm
 404 utility uses the system domain name by default, as set by the
 405 .Xr domainname 1
 406 utility.
 407 The
 408 .Fl d
 409 option can be used to override a default, or to specify a domain
 410 when the system domain name is not set.
 411 .It Fl h Ar host
 412 Specify the name or address of an NIS server to query.
 413 Normally,
 414 .Nm
 415 will communicate with the NIS master host specified in the
 416 .Pa master.passwd
 417 or
 418 .Pa passwd
 419 maps.
 420 On hosts that have not been configured as NIS clients, there is
 421 no way for the program to determine this information unless the user
 422 provides the hostname of a server.
 423 Note that the specified hostname need
 424 not be that of the NIS master server; the name of any server, master or
 425 slave, in a given NIS domain will do.
 426 .Pp
 427 When using the
 428 .Fl d
 429 option, the hostname defaults to
 430 .Dq localhost .
 431 The
 432 .Fl h
 433 option can be used in conjunction with the
 434 .Fl d
 435 option, in which case the user-specified hostname will override
 436 the default.
 437 .It Fl o
 438 Force the use of RPC-based updates when communicating with
 439 .Xr rpc.yppasswdd 8
 440 .Pq Dq old-mode .
 441 When invoked by the super-user on the NIS master server,
 442 .Nm
 443 allows unrestricted changes to the NIS passwd maps using dedicated,
 444 non-RPC-based mechanism (in this case, a
 445 .Ux
 446 domain socket).
 447 The
 448 .Fl o
 449 flag can be used to force
 450 .Nm
 451 to use the standard update mechanism instead.
 452 This option is provided
 453 mainly for testing purposes.
 454 .El
 455 .Sh FILES
 456 .Bl -tag -width /etc/master.passwd -compact
 457 .It Pa /etc/master.passwd
 458 the user database
 459 .It Pa /etc/passwd
 460 a Version 7 format password file
 461 .It Pa /etc/chpass.XXXXXX
 462 temporary copy of the password file
 463 .It Pa /etc/shells
 464 the list of approved shells
 465 .El
 466 .Sh SEE ALSO
 467 .Xr finger 1 ,
 468 .Xr login 1 ,
 469 .Xr passwd 1 ,
 470 .Xr getusershell 3 ,
 471 .Xr login.conf 5 ,
 472 .Xr passwd 5 ,
 473 .Xr pw 8 ,
 474 .Xr pwd_mkdb 8 ,
 475 .Xr vipw 8
 476 .Rs
 477 .%A Robert Morris
 478 .%A Ken Thompson
 479 .%T "UNIX Password security"
 480 .Re
 481 .Sh HISTORY
 482 The
 483 .Nm
 484 utility appeared in
 485 .Bx 4.3 Reno .
 486 .Sh BUGS
 487 User information should (and eventually will) be stored elsewhere.