Package pl.edu.icm.unity.engine.api.authn

Interface AuthenticationProcessor

public interface AuthenticationProcessor

Utility methods processing results of authenticators.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
boolean	checkIfUserHasCredential(AuthenticatorInstanceMetadata authn, long entityId)
static List<SessionParticipant>	extractParticipants(AuthenticationResult... results)	Extracts and returns all remote SessionParticipants from the AuthenticationResults.
AuthenticatedEntity	finalizeAfterPrimaryAuthentication(PartialAuthnState state, boolean skipSecondFactor)	Should be used if the second step authentication is not required: retrieve a final AuthenticatedEntity.
AuthenticatedEntity	finalizeAfterSecondaryAuthentication(PartialAuthnState state, AuthenticationResult result2)	Should be used if the second step authentication is required to process second authenticator results and retrieve a final AuthenticatedEntity.
AuthenticatorInstance	getValidAuthenticatorForEntity(Collection<AuthenticatorInstance> pool, long entityId)
PartialAuthnState	processPrimaryAuthnResult(AuthenticationResult result, AuthenticationFlow authenticationFlow, AuthenticationOptionKey authnOptionId)	Starting point: the result of the primary authenticator is verified.

Method Detail

getValidAuthenticatorForEntity

AuthenticatorInstance getValidAuthenticatorForEntity(Collection<AuthenticatorInstance> pool,
                                                     long entityId)

Returns:

authenticator which is valid for the given entity from the given pool

checkIfUserHasCredential

boolean checkIfUserHasCredential(AuthenticatorInstanceMetadata authn,
                                 long entityId)

Returns:

true only if user can use the given authenticator. Works well (currently) only for local authenticators

processPrimaryAuthnResult

PartialAuthnState processPrimaryAuthnResult(AuthenticationResult result,
                                            AuthenticationFlow authenticationFlow,
                                            AuthenticationOptionKey authnOptionId)
                                     throws AuthenticationException

Starting point: the result of the primary authenticator is verified. If the authentication failed then an exception is thrown. Otherwise it is checked whether, according to the AuthenticationFlow selected, second authentication should be performed, what is returned.

Throws:

AuthenticationException

finalizeAfterPrimaryAuthentication

AuthenticatedEntity finalizeAfterPrimaryAuthentication(PartialAuthnState state,
                                                       boolean skipSecondFactor)

Should be used if the second step authentication is not required: retrieve a final AuthenticatedEntity.

finalizeAfterSecondaryAuthentication

AuthenticatedEntity finalizeAfterSecondaryAuthentication(PartialAuthnState state,
                                                         AuthenticationResult result2)
                                                  throws AuthenticationException

Should be used if the second step authentication is required to process second authenticator results and retrieve a final AuthenticatedEntity.

Parameters:

primaryResult -

Returns:

Throws:

AuthenticationException

extractParticipants

static List<SessionParticipant> extractParticipants(AuthenticationResult... results)

Extracts and returns all remote SessionParticipants from the AuthenticationResults.