public class

LdapShaPasswordEncoder

extends Object
implements PasswordEncoder
java.lang.Object
   ↳ org.springframework.security.authentication.encoding.LdapShaPasswordEncoder

Class Overview

A version of ShaPasswordEncoder which supports Ldap SHA and SSHA (salted-SHA) encodings. The values are base-64 encoded and have the label "{SHA}" (or "{SSHA}") prepended to the encoded hash. These can be made lower-case in the encoded password, if required, by setting the forceLowerCasePrefix property to true. Also supports plain text passwords, so can safely be used in cases when both encoded and non-encoded passwords are in use or when a null implementation is required.

Summary

Public Constructors
LdapShaPasswordEncoder()
Public Methods
String encodePassword(String rawPass, Object salt)
Calculates the hash of password (and salt bytes, if supplied) and returns a base64 encoded concatenation of the hash and salt, prefixed with {SHA} (or {SSHA} if salt was used).
boolean isPasswordValid(String encPass, String rawPass, Object salt)
Checks the validity of an unencoded password against an encoded one in the form "{SSHA}sQuQF8vj8Eg2Y1hPdh3bkQhCKQBgjhQI".
void setForceLowerCasePrefix(boolean forceLowerCasePrefix)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.security.authentication.encoding.PasswordEncoder

Public Constructors

public LdapShaPasswordEncoder ()

Public Methods

public String encodePassword (String rawPass, Object salt)

Calculates the hash of password (and salt bytes, if supplied) and returns a base64 encoded concatenation of the hash and salt, prefixed with {SHA} (or {SSHA} if salt was used).

Parameters
rawPass the password to be encoded.
salt the salt. Must be a byte array or null.
Returns
  • the encoded password in the specified format

public boolean isPasswordValid (String encPass, String rawPass, Object salt)

Checks the validity of an unencoded password against an encoded one in the form "{SSHA}sQuQF8vj8Eg2Y1hPdh3bkQhCKQBgjhQI".

Parameters
encPass the actual SSHA or SHA encoded password
rawPass unencoded password to be verified.
salt ignored. If the format is SSHA the salt bytes will be extracted from the encoded password.
Returns
  • true if they match (independent of the case of the prefix).

public void setForceLowerCasePrefix (boolean forceLowerCasePrefix)