Package org.wildfly.security.auth.realm.ldap

Class UserPasswordCredentialLoader

java.lang.Object

org.wildfly.security.auth.realm.ldap.UserPasswordCredentialLoader

All Implemented Interfaces:

CredentialLoader, CredentialPersister

class UserPasswordCredentialLoader
extends Object
implements CredentialPersister

A CredentialLoader for loading credentials stored within the 'userPassword' attribute of LDAP entries.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	UserPasswordCredentialLoader.ForIdentityLoader

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static String	DEFAULT_USER_PASSWORD_ATTRIBUTE_NAME
private String	userPasswordAttributeName

Constructor Summary

Constructors

Constructor	Description
UserPasswordCredentialLoader(String userPasswordAttributeName)	Construct a new UserPasswordCredentialLoader for a specific attribute name.

Method Summary

Modifier and Type	Method	Description
void	addRequiredIdentityAttributes(Collection<String> attributes)	Construct set of LDAP attributes, which should be loaded as part of the identity from identity entry.
IdentityCredentialPersister	forIdentity(DirContext dirContext, String distinguishedName, Attributes attributes)	Obtain an IdentityCredentialLoader to query the credentials for a specific identity.
IdentityCredentialPersister	forIdentity(DirContext dirContext, String distinguishedName, Attributes attributes, Encoding hashEncoding)	Obtain an IdentityCredentialLoader to query the credentials for a specific identity.
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String credentialAlgorithm, AlgorithmParameterSpec parameterSpec)	Determine whether a given credential is definitely supported, possibly supported (for some identities), or definitely not supported.
(package private) EvidenceVerifier	toEvidenceVerifier()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.auth.realm.ldap.CredentialLoader

addBinaryIdentityAttributes

Field Detail

DEFAULT_USER_PASSWORD_ATTRIBUTE_NAME

static final String DEFAULT_USER_PASSWORD_ATTRIBUTE_NAME

See Also:

Constant Field Values

userPasswordAttributeName

private final String userPasswordAttributeName

Constructor Detail

UserPasswordCredentialLoader

UserPasswordCredentialLoader(String userPasswordAttributeName)

Construct a new UserPasswordCredentialLoader for a specific attribute name.

Parameters:

userPasswordAttributeName - the name of the attribute within the LDAP entry that holds the credential.

Method Detail

getCredentialAcquireSupport

public SupportLevel getCredentialAcquireSupport(Class<? extends Credential> credentialType,
                                                String credentialAlgorithm,
                                                AlgorithmParameterSpec parameterSpec)
                                         throws RealmUnavailableException

Description copied from interface: CredentialLoader

Determine whether a given credential is definitely supported, possibly supported (for some identities), or definitely not supported.

A DirContextFactory is made available if the directory server is going to be queried but most likely this call will need to be generic as querying a whole directory is not realistic.

Note: The DirContextFactory approach will be evolved further for better referral support so it makes it easier for it to be passed in for each call.

Specified by:

getCredentialAcquireSupport in interface CredentialLoader

Parameters:

credentialType - the credential type (must not be null)

credentialAlgorithm - the credential algorithm name

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

Returns:

the level of support for this credential type

Throws:

RealmUnavailableException

forIdentity

public IdentityCredentialPersister forIdentity(DirContext dirContext,
                                               String distinguishedName,
                                               Attributes attributes)

Description copied from interface: CredentialPersister

Obtain an IdentityCredentialLoader to query the credentials for a specific identity. Note: By this point referrals relating to the identity should have been resolved so the DirContextFactory should be suitable for use with the supplied distinguishedName

Specified by:

forIdentity in interface CredentialLoader

Specified by:

forIdentity in interface CredentialPersister

Parameters:

dirContext - the DirContext to use to connect to LDAP.

distinguishedName - the distinguished name of the identity.

attributes - the identity attributes requested by CredentialLoader.addRequiredIdentityAttributes(Collection)

Returns:

An IdentityCredentialLoader for the specified identity identified by their distinguished name.

forIdentity

public IdentityCredentialPersister forIdentity(DirContext dirContext,
                                               String distinguishedName,
                                               Attributes attributes,
                                               Encoding hashEncoding)

Description copied from interface: CredentialLoader

Obtain an IdentityCredentialLoader to query the credentials for a specific identity.

Note: By this point referrals relating to the identity should have been resolved so the DirContextFactory should be suitable for use with the supplied distinguishedName

Specified by:

forIdentity in interface CredentialLoader

Parameters:

dirContext - the DirContext to use to connect to LDAP.

distinguishedName - the distinguished name of the identity.

attributes - the identity attributes requested by CredentialLoader.addRequiredIdentityAttributes(Collection)

hashEncoding - specifies the string format for the hashed password

Returns:

An IdentityCredentialLoader for the specified identity identified by their distinguished name.

addRequiredIdentityAttributes

public void addRequiredIdentityAttributes(Collection<String> attributes)

Description copied from interface: CredentialLoader

Construct set of LDAP attributes, which should be loaded as part of the identity from identity entry.

Specified by:

addRequiredIdentityAttributes in interface CredentialLoader

Parameters:

attributes - output collection of attributes names, into which should be added

toEvidenceVerifier

EvidenceVerifier toEvidenceVerifier()