| blob | 78c902cc7dae0be521df584007b99371ad1ec02d |
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 June 9, 2021
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 .Sh NIS INTERACTION
259 The
260 .Nm
261 utility can also be used in conjunction with NIS, however some restrictions
262 apply.
263 Currently,
264 .Nm
265 can only make changes to the NIS passwd maps through
266 .Xr rpc.yppasswdd 8 ,
267 which normally only permits changes to a user's password, shell and GECOS
268 fields.
269 Except when invoked by the super-user on the NIS master server,
270 .Nm
271 (and, similarly,
272 .Xr passwd 1 )
273 cannot use the
274 .Xr rpc.yppasswdd 8
275 server to change other user information or
276 add new records to the NIS passwd maps.
277 Furthermore,
278 .Xr rpc.yppasswdd 8
279 requires password authentication before it will make any
280 changes.
281 The only user allowed to submit changes without supplying
282 a password is the super-user on the NIS master server; all other users,
283 including those with root privileges on NIS clients (and NIS slave
284 servers) must enter a password.
285 (The super-user on the NIS master is allowed to bypass these restrictions
286 largely for convenience: a user with root access
287 to the NIS master server already has the privileges required to make
288 updates to the NIS maps, but editing the map source files by hand can
289 be cumbersome.
290 .Pp
291 Note: these exceptions only apply when the NIS master server is a
292 .Fx
293 or
294 .Dx
295 system).
296 .Pp
297 Consequently, except where noted, the following restrictions apply when
298 .Nm
299 is used with NIS:
300 .Bl -enum -offset indent
301 .It
302 .Em "Only the shell and GECOS information may be changed" .
303 All other
304 fields are restricted, even when
305 .Nm
306 is invoked by the super-user.
307 While support for
308 changing other fields could be added, this would lead to
309 compatibility problems with other NIS-capable systems.
310 Even though the super-user may supply data for other fields
311 while editing an entry, the extra information (other than the
312 password -- see below) will be silently discarded.
313 .Pp
314 Exception: the super-user on the NIS master server is permitted to
315 change any field.
316 .It
317 .Em "Password authentication is required" .
318 The
319 .Nm
320 utility will prompt for the user's NIS password before effecting
321 any changes.
322 If the password is invalid, all changes will be
323 discarded.
324 .Pp
325 Exception: the super-user on the NIS master server is allowed to
326 submit changes without supplying a password.
327 (The super-user may
328 choose to turn off this feature using the
329 .Fl o
330 flag, described below.)
331 .It
332 .Em "Adding new records to the local password database is discouraged" .
333 The
334 .Nm
335 utility will allow the administrator to add new records to the
336 local password database while NIS is enabled, but this can lead to
337 some confusion since the new records are appended to the end of
338 the master password file, usually after the special NIS '+' entries.
339 The administrator should use
340 .Xr vipw 8
341 to modify the local password
342 file when NIS is running.
343 .Pp
344 The super-user on the NIS master server is permitted to add new records
345 to the NIS password maps, provided the
346 .Xr rpc.yppasswdd 8
347 server has been started with the
348 .Fl a
349 flag to permitted additions (it refuses them by default).
350 The
351 .Nm
352 utility tries to update the local password database by default; to update the
353 NIS maps instead, invoke chpass with the
354 .Fl y
355 flag.
356 .It
357 .Em "Password changes are not permitted".
358 Users should use
359 .Xr passwd 1
360 or
361 .Xr yppasswd 1
362 to change their NIS passwords.
363 The super-user is allowed to specify
364 a new password (even though the
365 .Dq Password:
366 field does not show
367 up in the editor template, the super-user may add it back by hand),
368 but even the super-user must supply the user's original password
369 otherwise
370 .Xr rpc.yppasswdd 8
371 will refuse to update the NIS maps.
372 .Pp
373 Exception: the super-user on the NIS master server is permitted to
374 change a user's NIS password with
375 .Nm .
376 .El
377 .Pp
378 There are also a few extra option flags that are available when
379 .Nm
380 is compiled with NIS support:
381 .Bl -tag -width indent
382 .It Fl l
383 Force
384 .Nm
385 to modify the local copy of a user's password
386 information in the event that a user exists in both
387 the local and NIS databases.
388 .It Fl y
389 Opposite effect of
390 .Fl l .
391 This flag is largely redundant since
392 .Nm
393 operates on NIS entries by default if NIS is enabled.
394 .It Fl d Ar domain
395 Specify a particular NIS domain.
396 The
397 .Nm
398 utility uses the system domain name by default, as set by the
399 .Xr domainname 1
400 utility.
401 The
402 .Fl d
403 option can be used to override a default, or to specify a domain
404 when the system domain name is not set.
405 .It Fl h Ar host
406 Specify the name or address of an NIS server to query.
407 Normally,
408 .Nm
409 will communicate with the NIS master host specified in the
410 .Pa master.passwd
411 or
412 .Pa passwd
413 maps.
414 On hosts that have not been configured as NIS clients, there is
415 no way for the program to determine this information unless the user
416 provides the hostname of a server.
417 Note that the specified hostname need
418 not be that of the NIS master server; the name of any server, master or
419 slave, in a given NIS domain will do.
420 .Pp
421 When using the
422 .Fl d
423 option, the hostname defaults to
424 .Dq localhost .
425 The
426 .Fl h
427 option can be used in conjunction with the
428 .Fl d
429 option, in which case the user-specified hostname will override
430 the default.
431 .It Fl o
432 Force the use of RPC-based updates when communicating with
433 .Xr rpc.yppasswdd 8
434 .Pq Dq old-mode .
435 When invoked by the super-user on the NIS master server,
436 .Nm
437 allows unrestricted changes to the NIS passwd maps using dedicated,
438 non-RPC-based mechanism (in this case, a
439 .Ux
440 domain socket).
441 The
442 .Fl o
443 flag can be used to force
444 .Nm
445 to use the standard update mechanism instead.
446 This option is provided
447 mainly for testing purposes.
448 .El
449 .Sh FILES
450 .Bl -tag -width /etc/master.passwd -compact
451 .It Pa /etc/master.passwd
452 the user database
453 .It Pa /etc/passwd
454 a Version 7 format password file
455 .It Pa /etc/chpass.XXXXXX
456 temporary copy of the password file
457 .It Pa /etc/shells
458 the list of approved shells
459 .El
460 .Sh SEE ALSO
461 .Xr finger 1 ,
462 .Xr login 1 ,
463 .Xr passwd 1 ,
464 .Xr getusershell 3 ,
465 .Xr login.conf 5 ,
466 .Xr passwd 5 ,
467 .Xr pw 8 ,
468 .Xr pwd_mkdb 8 ,
469 .Xr vipw 8
470 .Rs
471 .%A Robert Morris
472 .%A Ken Thompson
473 .%T "UNIX Password security"
474 .Re
475 .Sh HISTORY
476 The
477 .Nm
478 utility appeared in
479 .Bx 4.3 Reno .
480 .Sh BUGS
481 User information should (and eventually will) be stored elsewhere.