[apple/system_cmds.git] / passwd.tproj / passwd.1

.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)passwd.1	8.1 (Berkeley) 6/6/93
.\"
.Dd June 6, 1993
.Dt PASSWD 1
.Os BSD 4
.Sh NAME
.Nm passwd
.Nd modify a user's password
.Sh SYNOPSIS
.Nm passwd
.Op Fl i Ar infosystem
.Op Fl l Ar location
.Op Ar name
.Sh DESCRIPTION
.Nm Passwd
changes the user's password.  First, the user is prompted for their
current password.
If the current password is correctly typed, a new password is
requested.
The new password must be entered twice to avoid typing errors.
.Pp
The new password should be at least six characters long and not
purely alphabetic.
Its total length should be less than
.Dv _PASSWORD_LEN
(currently 128 characters) although some infosystems allow longer passwords.
Numbers, upper case letters and meta characters
are encouraged.
.Pp
Once the password has been verified,
.Nm passwd
communicates the new password information to
the authenticating host.
.Bl -tag -width flag
.It Fl i Ar infosystem
This option specifies where the password update should be applied.
Under Mac OS X 10.3, supported infosystems are:
.Bl -tag -width flag
.It Ar opendirectory
(default)
A system conforming to opendirectory APIs and supporting updates (including LDAP, netinfo, etc).
If no -l option is specified, the search node is used.
.It Ar netinfo
The netinfo database containing the user's password.
If no -l option is specified, the local netinfo database is assumed.
.It Ar file
The local flat-files (included for legacy configurations).
.It Ar nis
A remote NIS server containing the user's password.
.El
.It Fl l Ar location
This option causes the password to be updated in the given location of the choosen infosystem.
When changing only the local password,
.Xr pwd_mkdb  8
is used to update the password databases.
.Bl -tag -width flag
.It for netinfo,
location may be a domain name or server/tag
.It for file,
location may be a file name (/etc/master.passwd is the default)
.It for nis,
location may be a NIS domainname
.It for opendirectory,
location may be a directory node name
.El
.El
.Pp
The super-user privilages are not required change a user's current password
if only the local password is modified.
.Sh FILES
.Bl -tag -width /etc/master.passwd -compact
.It Pa /etc/master.passwd
The user database
.It Pa /etc/passwd 
A Version 7 format password file
.It Pa /etc/passwd.XXXXXX
Temporary copy of the password file
.El
.Sh SEE ALSO
.Xr chpass 1 ,
.Xr login 1 ,
.Xr passwd 5 ,
.Xr pwd_mkdb 8 ,
.Xr vipw 8 ,
.Xr nicl 1
.Rs
.%A Robert Morris
.%A Ken Thompson
.%T "UNIX password security"
.Re
.Sh HISTORY
A
.Nm passwd
command appeared in
.At v6 .
Commit	Line	Data
1815bff5 A	1	.\" Copyright (c) 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	.\" @(#)passwd.1 8.1 (Berkeley) 6/6/93
	33	.\"
	34	.Dd June 6, 1993
	35	.Dt PASSWD 1
	36	.Os BSD 4
	37	.Sh NAME
	38	.Nm passwd
	39	.Nd modify a user's password
	40	.Sh SYNOPSIS
	41	.Nm passwd
c3a08f59 A	42	.Op Fl i Ar infosystem
	43	.Op Fl l Ar location
	44	.Op Ar name
1815bff5 A	45	.Sh DESCRIPTION
1815bff5 A	46	.Nm Passwd
c3a08f59	47	changes the user's password. First, the user is prompted for their
1815bff5 A	48	current password.
	49	If the current password is correctly typed, a new password is
	50	requested.
	51	The new password must be entered twice to avoid typing errors.
	52	.Pp
	53	The new password should be at least six characters long and not
	54	purely alphabetic.
c3a08f59	55	Its total length should be less than
1815bff5	56	.Dv _PASSWORD_LEN
c3a08f59	57	(currently 128 characters) although some infosystems allow longer passwords.
1815bff5 A	58	Numbers, upper case letters and meta characters
	59	are encouraged.
	60	.Pp
	61	Once the password has been verified,
	62	.Nm passwd
	63	communicates the new password information to
c3a08f59	64	the authenticating host.
1815bff5	65	.Bl -tag -width flag
c3a08f59 A	66	.It Fl i Ar infosystem
	67	This option specifies where the password update should be applied.
	68	Under Mac OS X 10.3, supported infosystems are:
	69	.Bl -tag -width flag
2fc1e207	70	.It Ar opendirectory
c3a08f59	71	(default)
2fc1e207 A	72	A system conforming to opendirectory APIs and supporting updates (including LDAP, netinfo, etc).
	73	If no -l option is specified, the search node is used.
	74	.It Ar netinfo
c3a08f59 A	75	The netinfo database containing the user's password.
	76	If no -l option is specified, the local netinfo database is assumed.
	77	.It Ar file
	78	The local flat-files (included for legacy configurations).
	79	.It Ar nis
	80	A remote NIS server containing the user's password.
c3a08f59 A	81	.El
	82	.It Fl l Ar location
	83	This option causes the password to be updated in the given location of the choosen infosystem.
1815bff5 A	84	When changing only the local password,
	85	.Xr pwd_mkdb 8
	86	is used to update the password databases.
c3a08f59 A	87	.Bl -tag -width flag
	88	.It for netinfo,
	89	location may be a domain name or server/tag
	90	.It for file,
	91	location may be a file name (/etc/master.passwd is the default)
	92	.It for nis,
	93	location may be a NIS domainname
	94	.It for opendirectory,
	95	location may be a directory node name
83f6dbe8	96	.El
1815bff5 A	97	.El
1815bff5 A	98	.Pp
c3a08f59	99	The super-user privilages are not required change a user's current password
1815bff5 A	100	if only the local password is modified.
	101	.Sh FILES
	102	.Bl -tag -width /etc/master.passwd -compact
	103	.It Pa /etc/master.passwd
	104	The user database
	105	.It Pa /etc/passwd
	106	A Version 7 format password file
	107	.It Pa /etc/passwd.XXXXXX
	108	Temporary copy of the password file
	109	.El
	110	.Sh SEE ALSO
	111	.Xr chpass 1 ,
1815bff5 A	112	.Xr login 1 ,
1815bff5 A	113	.Xr passwd 5 ,
1815bff5	114	.Xr pwd_mkdb 8 ,
83f6dbe8	115	.Xr vipw 8 ,
c3a08f59	116	.Xr nicl 1
1815bff5 A	117	.Rs
	118	.%A Robert Morris
	119	.%A Ken Thompson
	120	.%T "UNIX password security"
	121	.Re
	122	.Sh HISTORY
	123	A
	124	.Nm passwd
	125	command appeared in
	126	.At v6 .