]> git.sur5r.net Git - openldap/blob - doc/man/man8/slappasswd.8
Add some clarification as to what hash algorithms are used
[openldap] / doc / man / man8 / slappasswd.8
1 .TH SLAPPASSWD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" $OpenLDAP$
3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
5 .SH NAME
6 slappasswd \- OpenLDAP password utility
7 .SH SYNOPSIS
8 .B SBINDIR/slappasswd
9 .B [\-v]
10 .B [\-u]
11 .B [\-s secret]
12 .B [\-h hash]
13 .B [\-c salt-format]
14 .B 
15 .LP
16 .SH DESCRIPTION
17 .LP
18 .B Slappasswd
19 is used to generate an userPassword value
20 suitable for use with
21 .BR ldapmodify (1)
22 or
23 .BR slapd.conf (5)
24 .I rootpw
25 configuration directive.
26 .SH OPTIONS
27 .TP
28 .B \-v
29 enable verbose mode.
30 .TP
31 .B \-u
32 Generate RFC2307 userPassword values (the default).  Future
33 versions of this program may generate alternative syntaxes
34 by default.  This option is provided for forward compatibility.
35 .TP
36 .BI \-s " secret"
37 The secret to hash.  If not provided, the user will be prompted
38 for the secret to hash.
39 .TP
40 .BI \-h " scheme"
41 If -h is specified, one of the following RFC2307 schemes may
42 be specified:
43 .IR {CRYPT} ,
44 .IR {MD5} ,
45 .IR {SMD5} ,
46 .IR {SSHA} ", and"
47 .IR {SHA} .
48 The default is 
49 .IR {SSHA} .
50 .TP
51 .B {SHA}
52 and
53 .B {SSHA}
54 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
55 .TP
56 .B {MD5}
57 and
58 .B {SMD5}
59 use the MD5 algorithm (RFC 1321), the latter with a seed.
60 .TP
61 .B {CRYPT}
62 uses the
63 .BR crypt (3).
64 .TP
65 .B {CLEARTEXT}
66 indicates that the new password should be added to userPassword as
67 clear text.
68 .TP
69 .BI \-c " crypt-salt-format"
70 Specify the format of the salt passed to
71 .BR crypt (3)
72 when generating {CRYPT} passwords.  
73 This string needs to be in
74 .BR sprintf (3)
75 format and may include one (and only one) %s conversion.
76 This conversion will be substituted with a string random
77 characters from [A\-Za\-z0\-9./].  For example, "%.2s"
78 provides a two character salt and "$1$%.8s" tells some
79 versions of crypt(3) to use an MD5 algorithm and provides
80 8 random characters of salt.  The default is "%s", which
81 provides 31 characters of salt.
82 .SH LIMITATIONS
83 The practice storing hashed passwords in userPassword violates
84 Standard Track (RFC2256) schema specifications and may hinder
85 interoperability.  A new attribute type to hold hashed
86 passwords is needed.
87 .SH "SECURITY CONSIDERATIONS"
88 Use of hashed passwords does not protect passwords during
89 protocol transfer.  TLS or other eavesdropping protections
90 should be inplace before using LDAP simple bind.  The
91 hashed password values should be protected as if they
92 were clear text passwords.
93 .SH "SEE ALSO"
94 .BR ldappasswd (1),
95 .BR ldapmodify (1),
96 .BR slapd (8)
97 .BR slapd.conf (5)
98 .LP
99 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
100 .SH ACKNOWLEDGEMENTS
101 OpenLDAP is developed and maintained by
102 The OpenLDAP Project (http://www.openldap.org/).
103 OpenLDAP is derived from University of Michigan LDAP 3.3 Release.