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