[apple/system_cmds.git] / pwd_mkdb.tproj / pwd_mkdb.8

.\" Copyright (c) 1991, 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.
.\"
.\"	@(#)pwd_mkdb.8	8.2 (Berkeley) 4/27/95
.\"
.Dd April 27, 1995
.Dt PWD_MKDB 8
.Os
.Sh NAME
.Nm pwd_mkdb
.Nd "generate the password databases"
.Sh SYNOPSIS
.Nm pwd_mkdb
.Op Fl p
.Ar file
.Sh DESCRIPTION
.Nm Pwd_mkdb
creates
.Xr db 3
style secure and insecure databases for the specified file.
These databases are then installed into
.Dq Pa /etc/spwd.db
and
.Dq Pa /etc/pwd.db
respectively.
The file is installed into
.Dq Pa /etc/master.passwd .
The file must be in the correct format (see
.Xr passwd 5 ) .
It is important to note that the format used in this system is
different from the historic Version 7 style format.
.Pp
The options are as follows:
.Bl -tag -width flag
.It Fl p
Create a Version 7 style password file and install it into
.Dq Pa /etc/passwd .
.El
.Pp
The two databases differ in that the secure version contains the user's 
encrypted password and the insecure version has an asterisk (``*'')
.Pp
The databases are used by the C library password routines (see
.Xr getpwent 3 ) .
.Pp
.Nm Pwd_mkdb
exits zero on success, non-zero on failure.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /etc/master.passwd
The current password file.
.It Pa /etc/passwd
A Version 7 format password file.
.It Pa /etc/pwd.db
The insecure password database file.
.It Pa /etc/pwd.db.tmp
A temporary file.
.It Pa /etc/spwd.db
The secure password database file.
.It Pa /etc/spwd.db.tmp
A temporary file.
.El
.Sh BUGS
Because of the necessity for atomic update of the password files,
.Nm pwd_mkdb
uses
.Xr rename 2
to install them.
This, however, requires that the file specified on the command line live
on the same file system as the
.Dq Pa /etc
directory.
.Pp
There are the obvious races with multiple people running
.Nm pwd_mkdb
on different password files at the same time.
The front-ends to 
.Nm pwd_mkdb ,
.Xr chpass 1 ,
.Xr passwd 1
and
.Xr vipw 8 ,
handle the locking necessary to avoid this problem.
.Sh COMPATIBILITY
Previous versions of the system had a program similar to
.Nm pwd_mkdb ,
.Xr mkpasswd 8 ,
which built
.Xr dbm 3
style databases for the password file but depended on the calling programs
to install them.
The program was renamed in order that previous users of the program
not be surprised by the changes in functionality.
.Sh SEE ALSO
.Xr chpass 1 ,
.Xr passwd 1 ,
.Xr db 3 ,
.Xr getpwent 3 ,
.Xr passwd 5 ,
.Xr vipw 8
Commit	Line	Data
1815bff5 A	1	.\" Copyright (c) 1991, 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	.\" @(#)pwd_mkdb.8 8.2 (Berkeley) 4/27/95
	33	.\"
	34	.Dd April 27, 1995
	35	.Dt PWD_MKDB 8
	36	.Os
	37	.Sh NAME
	38	.Nm pwd_mkdb
	39	.Nd "generate the password databases"
	40	.Sh SYNOPSIS
	41	.Nm pwd_mkdb
	42	.Op Fl p
	43	.Ar file
	44	.Sh DESCRIPTION
	45	.Nm Pwd_mkdb
	46	creates
	47	.Xr db 3
	48	style secure and insecure databases for the specified file.
	49	These databases are then installed into
	50	.Dq Pa /etc/spwd.db
	51	and
	52	.Dq Pa /etc/pwd.db
	53	respectively.
	54	The file is installed into
	55	.Dq Pa /etc/master.passwd .
	56	The file must be in the correct format (see
	57	.Xr passwd 5 ) .
	58	It is important to note that the format used in this system is
	59	different from the historic Version 7 style format.
	60	.Pp
	61	The options are as follows:
	62	.Bl -tag -width flag
	63	.It Fl p
	64	Create a Version 7 style password file and install it into
65	.Dq Pa /etc/passwd .
66	.El
67	.Pp
68	The two databases differ in that the secure version contains the user's
69	encrypted password and the insecure version has an asterisk (``*'')
70	.Pp
71	The databases are used by the C library password routines (see
72	.Xr getpwent 3 ) .
73	.Pp
74	.Nm Pwd_mkdb
75	exits zero on success, non-zero on failure.
76	.Sh FILES
77	.Bl -tag -width Pa -compact
78	.It Pa /etc/master.passwd
79	The current password file.
80	.It Pa /etc/passwd
81	A Version 7 format password file.
82	.It Pa /etc/pwd.db
83	The insecure password database file.
84	.It Pa /etc/pwd.db.tmp
85	A temporary file.
86	.It Pa /etc/spwd.db
87	The secure password database file.
88	.It Pa /etc/spwd.db.tmp
89	A temporary file.
90	.El
91	.Sh BUGS
92	Because of the necessity for atomic update of the password files,
93	.Nm pwd_mkdb
94	uses
95	.Xr rename 2
96	to install them.
97	This, however, requires that the file specified on the command line live
98	on the same file system as the
99	.Dq Pa /etc
100	directory.
101	.Pp
102	There are the obvious races with multiple people running
103	.Nm pwd_mkdb
104	on different password files at the same time.
105	The front-ends to
106	.Nm pwd_mkdb ,
107	.Xr chpass 1 ,
108	.Xr passwd 1
109	and
110	.Xr vipw 8 ,
111	handle the locking necessary to avoid this problem.
112	.Sh COMPATIBILITY
113	Previous versions of the system had a program similar to
114	.Nm pwd_mkdb ,
115	.Xr mkpasswd 8 ,
116	which built
117	.Xr dbm 3
118	style databases for the password file but depended on the calling programs
119	to install them.
120	The program was renamed in order that previous users of the program
121	not be surprised by the changes in functionality.
122	.Sh SEE ALSO
123	.Xr chpass 1 ,
124	.Xr passwd 1 ,
125	.Xr db 3 ,
126	.Xr getpwent 3 ,
127	.Xr passwd 5 ,
128	.Xr vipw 8