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

Class OtpCredentialLoader

java.lang.Object

org.wildfly.security.auth.realm.ldap.OtpCredentialLoader

All Implemented Interfaces:

CredentialLoader, CredentialPersister

class OtpCredentialLoader
extends Object
implements CredentialPersister

A CredentialLoader for loading OTP credentials stored within defined attributes of LDAP entries.

Author:

Jan Kalina

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	OtpCredentialLoader.ForIdentityLoader

Field Summary

Fields

Modifier and Type	Field	Description
private String	algorithmAttributeName
private String	hashAttributeName
private String	seedAttributeName
private String	sequenceAttributeName

Constructor Summary

Constructors

Constructor	Description
OtpCredentialLoader(String algorithmAttributeName, String hashAttributeName, String seedAttributeName, String sequenceAttributeName)

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.
OtpCredentialLoader.ForIdentityLoader	forIdentity(DirContext context, String distinguishedName, Attributes attributes)	Obtain an IdentityCredentialLoader to query the credentials for a specific identity.
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec)	Determine whether a given credential is definitely supported, possibly supported (for some identities), or definitely not supported.

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, forIdentity

Field Detail

algorithmAttributeName

private final String algorithmAttributeName

hashAttributeName

private final String hashAttributeName

seedAttributeName

private final String seedAttributeName

sequenceAttributeName

private final String sequenceAttributeName

Constructor Detail

OtpCredentialLoader

OtpCredentialLoader(String algorithmAttributeName,
                    String hashAttributeName,
                    String seedAttributeName,
                    String sequenceAttributeName)

Method Detail

getCredentialAcquireSupport

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

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)

algorithmName - 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

forIdentity

public OtpCredentialLoader.ForIdentityLoader forIdentity(DirContext context,
                                                         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:

context - 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.

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