git.sur5r.net Git - openldap/blob - contrib/slapd-modules/passwd/sha2/slapd-pw-sha2.5

   1 .TH SLAPD-PW-SHA2 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2015-2017 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd-pw-sha2 \- SHA-2 password module to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .RS
  10 .LP
  11 .B moduleload
  12 .B pw-sha2
  13 .RE
  14 .SH DESCRIPTION
  15 .LP
  16 The
  17 .B pw-sha2
  18 module to
  19 .BR slapd (8)
  20 provides support for the use of SSHA-512, SSHA-384, SSHA-256, SHA-512,
  21 SHA-384 and SHA-256 from the SHA-2 family (FIPS 180-2) of hash functions
  22 in hashed passwords in OpenLDAP.
  23 .LP
  24 It does so by providing the following additional password schemes for use in slapd:
  25 .RS
  26 .TP
  27 .B {SSHA256}
  28 SHA-256 with salt, giving hash values of 256 bits length
  29 .TP
  30 .B {SHA256}
  31 plain SHA-256 giving hash values of 256 bits length
  32 .TP
  33 .B {SSHA384}
  34 SHA-384 with salt, giving hash values of 384 bits length
  35 .TP
  36 .B {SHA384}
  37 plain SHA-384 giving hash values of 384 bits length
  38 .TP
  39 .B {SSHA512}
  40 SHA-512 with salt, giving hash values of 512 bits length
  41 .TP
  42 .B {SHA512}
  43 plain SHA-512 giving hash values of 512 bits length
  44 .RE
  45
  46 .SH CONFIGURATION
  47 The
  48 .B pw-sha2
  49 module does not need any configuration.
  50 .LP
  51 After loading the module, the password schemes
  52 {SSHA256}, {SSHA384}, {SSHA512}, {SSHA256}, {SHA384}, and {SHA512}
  53 will be recognised in values of the
  54 .I userPassword
  55 attribute.
  56 .LP
  57 You can then instruct OpenLDAP to use these schemes when processing
  58 the LDAPv3 Password Modify (RFC 3062) extended operations by using the
  59 .BR password-hash
  60 option in
  61 .BR slapd.conf (5).
  62
  63 .SH NOTES
  64 If you want to use the schemes described here with
  65 .BR slappasswd (8),
  66 don't forget to load the module using its command line options.
  67 The relevant option/value is:
  68 .RS
  69 .LP
  70 .B \-o
  71 .BR module\-load = pw-sha2
  72 .LP
  73 .RE
  74 Depending on
  75 .BR pw-sha2 's
  76 location, you may also need:
  77 .RS
  78 .LP
  79 .B \-o
  80 .BR module\-path = \fIpathspec\fP
  81 .RE
  82
  83 .SH EXAMPLES
  84 All of the userPassword LDAP attributes below encode the password
  85 .RI ' secret '.
  86 .EX
  87 .LP
  88 userPassword: {SHA512}vSsar3708Jvp9Szi2NWZZ02Bqp1qRCFpbcTZPdBhnWgs5WtNZKnvCXdhztmeD2cmW192CF5bDufKRpayrW/isg==
  89 .LP
  90 userPassword: {SHA384}WKd1ukESvjAFrkQHznV9iP2nHUBJe7gCbsrFTU4//HIyzo3jq1rLMK45dg/ufFPt
  91 .LP
  92 userPassword: {SHA256}K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols=
  93 .EE
  94 .LP
  95 To make {SSHA512} the password hash used in Password Modify extended operations,
  96 simply set this line in slapd.conf(5):
  97 .EX
  98 .LP
  99 password-hash   {SSHA512}
 100 .EX
 101
 102 .SH SEE ALSO
 103 .BR slapd.conf (5),
 104 .BR ldappasswd (1),
 105 .BR slappasswd (8),
 106 .BR ldap (3),
 107 .LP
 108 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 109 .LP
 110
 111 .SH ACKNOWLEDGEMENTS
 112 This manual page has been written by Peter Marschall based on the
 113 module's README file written by Jeff Turner.
 114 .LP
 115 .B OpenLDAP
 116 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 117 .B OpenLDAP
 118 is derived from University of Michigan LDAP 3.3 Release.