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