uk.ac.ed.epcc.webapp.session.twofactor

Interface TwoFactorComposite<A extends AppUser>

All Known Implementing Classes:

CodeAuthComposite, FixedCodeAuthComposite, FormAuthComposite, TotpCodeAuthComposite

public interface TwoFactorComposite<A extends AppUser>

Interface for AppUserComposites that implement 2-factor work-flow

Method Summary

Modifier and Type	Method and Description
boolean	needAuth(A user) would a call to requireAuth(AppUser) return a FormResult
FormResult	requireAuth(A user) Check if two factor authentication is required.

Method Detail

requireAuth

FormResult requireAuth(A user)

Check if two factor authentication is required. If this method returns null, two factor authentication is not enabled for the current user or the user has recently validated this authentication within this session. Otherwise a FormResult is returned to validate the two-factor credential.

If authorisation in required this might send out a token via an independent communication channel so use needAuth(AppUser) unless you intent to proceed.

Parameters:

user - AppUser to check.

Returns:

FormResult or null

needAuth

boolean needAuth(A user)

would a call to requireAuth(AppUser) return a FormResult

Parameters:

user -

Returns: