org.jahia.services.pwd

Class PasswordService

java.lang.Object

org.jahia.services.pwd.PasswordService

public class PasswordService
extends Object

Centralized service for password hashing and checking operations.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
PasswordService()

Method Summary

Modifier and Type	Method and Description
String	digest(String password) Create a digest of the provided password, adding the used digester ID as a prefix.
String	digest(String password, boolean strong) Create a digest of the provided password, adding the used digester ID as a prefix.
protected PasswordDigester	getDefaultDigester()
static PasswordService	getInstance() Returns an instance of this service.
boolean	matches(String password, String prefixedDigest) Checks, if the provided clear text password matches the specified digest, considering all aspects like salt, hashing iterations, etc.
void	registerDigester(PasswordDigester digester) Adds the password digester into the registry.
void	setDefaultDigester(PasswordDigester defaultDigester)
void	setDigesters(List<PasswordDigester> digesters)
void	setStrongDigester(PasswordDigester strongDigester)
void	unregisterDigester(String digesterId) Adds the password digester to unregister.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PasswordService

public PasswordService()

Method Detail

getInstance

public static PasswordService getInstance()

Returns an instance of this service.

Returns:

an instance of this service

digest

public String digest(String password)

Create a digest of the provided password, adding the used digester ID as a prefix.

Parameters:

password - the clear text password to be hashed

Returns:

the digest of the provided password, prefixed with an ID of the used digester

digest

public String digest(String password,
                     boolean strong)

Create a digest of the provided password, adding the used digester ID as a prefix.

Parameters:

password - the clear text password to be hashed

strong - if the configured string digester should be used (mainly for root user the stronger digester is used than the default one)

Returns:

the digest of the provided password, prefixed with an ID of the used digester

getDefaultDigester

protected PasswordDigester getDefaultDigester()

matches

public boolean matches(String password,
                       String prefixedDigest)

Checks, if the provided clear text password matches the specified digest, considering all aspects like salt, hashing iterations, etc. It is expected that the digest is prefixed with a digester ID to be used to the check. If there is no prefix, the legacy SHA-1 digest (no salt, 1 iteration) will be used.

Parameters:

password - the clear text password to be checked

prefixedDigest - the digest against which the password will be matched; it is expected that the digest is prefixed with a digester ID to be used to the check

Returns:

true, if the provided password matches its hashed equivalent

registerDigester

public void registerDigester(PasswordDigester digester)

Adds the password digester into the registry.

Parameters:

digester - the password digester to be registered

setDefaultDigester

public void setDefaultDigester(PasswordDigester defaultDigester)

setDigesters

public void setDigesters(List<PasswordDigester> digesters)

setStrongDigester

public void setStrongDigester(PasswordDigester strongDigester)

unregisterDigester

public void unregisterDigester(String digesterId)

Adds the password digester to unregister.

Parameters:

digesterId - the ID of the password digester to be removed from the registry