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

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