Sync usage with man page.
[netbsd-mini2440.git] / share / man / man5 / passwd.conf.5
blob4e4135dada789b93c01185b4904e42aed913e5f6
1 .\"     $NetBSD: passwd.conf.5,v 1.8 2005/09/05 03:37:15 hubertf Exp $
2 .\"
3 .\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"      This product includes software developed by Niels Provos.
17 .\" 4. The name of the author may not be used to endorse or promote products
18 .\"    derived from this software without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .Dd September 4, 2005
32 .Dt PASSWD.CONF 5
33 .Os
34 .Sh NAME
35 .Nm passwd.conf
36 .Nd password encryption configuration file
37 .Sh SYNOPSIS
38 .Nm
39 .Sh DESCRIPTION
40 The
41 .Pa /etc/passwd.conf
42 file, consisting of
43 .Dq stanzas ,
44 describes the configuration of the password cipher used
45 to encrypt local or YP passwords.
46 .Pp
47 There are default, user and group specific stanzas.
48 If no user or group
49 stanza to a specific option is available, the default stanza
50 is used.
51 .Pp
52 To differentiate between user and group stanzas, groups are prefixed
53 with a single colon
54 .Pq Sq \&: .
55 .Pp
56 Some fields and their possible values that can appear in this file are:
57 .Bl -tag -width localcipher
58 .It Sy localcipher
59 The cipher to use for local passwords.
60 Possible values are:
61 .Dq old ,
62 .Dq newsalt,\*[Lt]rounds\*[Gt] ,
63 .Dq md5 ,
64 .Dq sha1,\*[Lt]rounds\*[Gt] ,
65 and
66 .Dq blowfish,\*[Lt]rounds\*[Gt] .
67 For
68 .Dq newsalt
69 the value of rounds is a 24-bit integer with a minimum of 7250 rounds.
70 For
71 .Dq sha1
72 the value of rounds is a 32-bit integer, 0 means use the default
73 of 24680.
74 For
75 .Dq blowfish
76 the value can be between 4 and 31.
77 It specifies the base 2 logarithm of the number of rounds.
78 .It Sy ypcipher
79 The cipher to use for YP passwords.
80 The possible values are the same as for localcipher.
81 .El
82 .Pp
83 To retrieve information from this file use
84 .Xr pw_getconf 3 .
85 .Sh FILES
86 .Bl -tag -width /etc/passwd.conf -compact
87 .It Pa /etc/passwd.conf
88 .El
89 .Sh EXAMPLES
90 Use MD5 as the local cipher and old-style DES as the YP cipher.
91 Use blowfish with 2^5 rounds for root:
92 .Bd -literal
93  default:
94       localcipher = md5
95       ypcipher = old
97  root:
98       localcipher = blowfish,5
99 .Ed
100 .Sh SEE ALSO
101 .Xr passwd 1 ,
102 .Xr pwhash 1 ,
103 .Xr pw_getconf 3 ,
104 .Xr passwd 5
105 .Sh HISTORY
108 configuration file first appeared in
109 .Nx 1.6 .