net.unicon.cas.mfa.authentication.principal

Class MultiFactorCredentials

java.lang.Object

net.unicon.cas.mfa.authentication.principal.MultiFactorCredentials

All Implemented Interfaces:

Serializable, org.jasig.cas.authentication.principal.Credentials

public class MultiFactorCredentials
extends Object
implements org.jasig.cas.authentication.principal.Credentials

A Credentials implementation that is to ease multifactor authentication. It primarily carries the following entities:

• Chain of credentials: represent various forms of credentials during an MFA flow
• Chain of authentications: represent the authentication contexts established during the flow when credentials are verified.

Because the Credentials itself is simply a marker interface, it is up to each credential implementation in the chain to decide how it wants to identify itself. This identifier will be used to locate the particular credential entry in the collection.

The collection of established authentication contexts are ordered, in such a way that each entry in the collection is linked to corresponding leg in the authentication flow.

It is the responsibility of the authentication flow of course, to gather and carry on the instance of MultiFactorCredentials as it knows how to authenticate the user agent and is itself the recipient of each credential identifier.

Author:

Misagh Moayyed

See Also:

getChainedCredentials(), getAuthentication(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiFactorCredentials()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthenticationToChain(org.jasig.cas.authentication.Authentication authentication) Add the authentication to the chain, having verified that the resolved principal of the new authentication matches what has been remembered and collected as the principal.
int	countChainedAuthentications() Count the number of authentication contexts in the chain.
org.jasig.cas.authentication.Authentication	getAuthentication() Creates an instance of the CompositeAuthentication object that collects and harmonizes all principal and authentication attributes into one context.
Map<String,org.jasig.cas.authentication.principal.Credentials>	getChainedCredentials()
org.jasig.cas.authentication.principal.Credentials	getCredentials()
org.jasig.cas.authentication.principal.Principal	getPrincipal() Provides the ability to access the resolved and primary principal based on the authentication context.
boolean	isEmpty() Indicate whether or not the authentication chain is empty.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiFactorCredentials

public MultiFactorCredentials()

Method Detail

getChainedCredentials

public final Map<String,org.jasig.cas.authentication.principal.Credentials> getChainedCredentials()

isEmpty

public final boolean isEmpty()

Indicate whether or not the authentication chain is empty.

Returns:

true, if the context is empty.

countChainedAuthentications

public final int countChainedAuthentications()

Count the number of authentication contexts in the chain.

Returns:

total number of authentications in the chain.

addAuthenticationToChain

public final void addAuthenticationToChain(org.jasig.cas.authentication.Authentication authentication)

Add the authentication to the chain, having verified that the resolved principal of the new authentication matches what has been remembered and collected as the principal.

Parameters:

authentication - authentication context to add to the chain

getAuthentication

public final org.jasig.cas.authentication.Authentication getAuthentication()

Creates an instance of the CompositeAuthentication object that collects and harmonizes all principal and authentication attributes into one context.

Principal attributes are merged from all principals that are already resolved in the authentication chain. Attributes with the same name that belong to the same principal are merged into one, with the latter value overwriting the first. The established principal will be one that is based of MutablePrincipal.

Authentication attributes are merged from all authentications that make up the chain. The merging strategy is such that duplicate attribute names are grouped together into an instance of a Collection implementation and preserved.

Returns:

an instance of CompositeAuthentication

getPrincipal

public final org.jasig.cas.authentication.principal.Principal getPrincipal()

Provides the ability to access the resolved and primary principal based on the authentication context.

Returns:

the primary principal.

getCredentials

public final org.jasig.cas.authentication.principal.Credentials getCredentials()