git.sur5r.net Git - openldap/blob - doc/man/man8/slappasswd.8

   1 .TH SLAPPASSWD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2004 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|\-T file]
  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 RFC 2307 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.
  38 If this and
  39 .B \-T
  40 are absent, the user will be prompted for the secret to hash.
  41 .B \-s
  42 and
  43 .B \-T
  44 and mutually exclusive flags.
  45 .TP
  46 .BI \-T " file"
  47 Hash the contents of the file.
  48 If this and
  49 .B \-s
  50 are absent, the user will be prompted for the secret to hash.
  51 .B \-s
  52 and
  53 .B \-T
  54 and mutually exclusive flags.
  55 .TP
  56 .BI \-h " scheme"
  57 If -h is specified, one of the following RFC 2307 schemes may
  58 be specified:
  59 .IR {CRYPT} ,
  60 .IR {MD5} ,
  61 .IR {SMD5} ,
  62 .IR {SSHA} ", and"
  63 .IR {SHA} .
  64 The default is
  65 .IR {SSHA} .
  66
  67 .B {SHA}
  68 and
  69 .B {SSHA}
  70 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
  71
  72 .B {MD5}
  73 and
  74 .B {SMD5}
  75 use the MD5 algorithm (RFC 1321), the latter with a seed.
  76
  77 .B {CRYPT}
  78 uses the
  79 .BR crypt (3).
  80
  81 .B {CLEARTEXT}
  82 indicates that the new password should be added to userPassword as
  83 clear text.
  84 .TP
  85 .BI \-c " crypt-salt-format"
  86 Specify the format of the salt passed to
  87 .BR crypt (3)
  88 when generating {CRYPT} passwords.
  89 This string needs to be in
  90 .BR sprintf (3)
  91 format and may include one (and only one) %s conversion.
  92 This conversion will be substituted with a string random
  93 characters from [A\-Za\-z0\-9./].  For example, "%.2s"
  94 provides a two character salt and "$1$%.8s" tells some
  95 versions of crypt(3) to use an MD5 algorithm and provides
  96 8 random characters of salt.  The default is "%s", which
  97 provides 31 characters of salt.
  98 .SH LIMITATIONS
  99 The practice storing hashed passwords in userPassword violates
 100 Standard Track (RFC 2256) schema specifications and may hinder
 101 interoperability.  A new attribute type, authPassword, to hold
 102 hashed passwords has been defined (RFC 3112), but is not yet
 103 implemented in
 104 .BR slapd (8).
 105 .TP
 106 It should also be noted that the behavior of
 107 .BR crypt (3)
 108 is platform specific.
 109 .SH "SECURITY CONSIDERATIONS"
 110 Use of hashed passwords does not protect passwords during
 111 protocol transfer.  TLS or other eavesdropping protections
 112 should be in\-place before using LDAP simple bind.
 113 .TP
 114 The hashed password values should be protected as if they
 115 were clear text passwords.
 116 .SH "SEE ALSO"
 117 .BR ldappasswd (1),
 118 .BR ldapmodify (1),
 119 .BR slapd (8)
 120 .BR slapd.conf (5)
 121 .B RFC 2307
 122 .B RFC 2256
 123 .B RFC 3112
 124 .LP
 125 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 126 .SH ACKNOWLEDGEMENTS
 127 OpenLDAP is developed and maintained by
 128 The OpenLDAP Project (http://www.openldap.org/).
 129 OpenLDAP is derived from University of Michigan LDAP 3.3 Release.