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

Class FormAuthComposite<AU extends AppUser>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.Composite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserComposite<AU,FormAuthComposite>

uk.ac.ed.epcc.webapp.session.twofactor.FormAuthComposite<AU>

All Implemented Interfaces:

Contexed, TableStructureContributer<AU>, TwoFactorComposite<AU>

Direct Known Subclasses:

CodeAuthComposite

public abstract class FormAuthComposite<AU extends AppUser>
extends AppUserComposite<AU,FormAuthComposite>
implements TwoFactorComposite<AU>

super-class for TwoFactorComposites that validate using a pin-code

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.Composite

fac

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormAuthComposite(AppUserFactory<AU> fac)

Method Summary

Modifier and Type	Method and Description
ContentBuilder	addExtra(ContentBuilder cb) Add extra content when being shown a modified auth form.
void	authenticated() action to perform when authentication completed
protected abstract boolean	enabled(AU user)
protected abstract java.lang.String	getConfigPrefix()
protected java.lang.Class<? super FormAuthComposite>	getType() Returns the type the composite should be registered under.
abstract void	modifyForm(AU user, Form f) Add two factor fields to a form.
boolean	needAuth(AU user) would a call to TwoFactorComposite.requireAuth(AppUser) return a FormResult
boolean	needToken() Do we need to send tokens via a side channel
FormResult	requireAuth(AU user) Check if two factor authentication is required.
protected void	sendToken(AU user) send side-channel tokens.

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.Composite

addDefaults, addFieldHelp, addOptional, addSelectors, addSuppress, addTranslations, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, modifyDefaultTableSpecification, postUpdate, preRegister, release, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.TableStructureContributer

addFieldConstraints, addFormFields

Constructor Detail

FormAuthComposite

protected FormAuthComposite(AppUserFactory<AU> fac)

Parameters:

fac -

Method Detail

requireAuth

public final FormResult requireAuth(AU user)

Description copied from interface: TwoFactorComposite

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 TwoFactorComposite.needAuth(AppUser) unless you intent to proceed.

Specified by:

requireAuth in interface TwoFactorComposite<AU extends AppUser>

Parameters:

user - AppUser to check.

Returns:

FormResult or null

needToken

public boolean needToken()

Do we need to send tokens via a side channel

Returns:

sendToken

protected void sendToken(AU user)

send side-channel tokens.

Parameters:

user -

enabled

protected abstract boolean enabled(AU user)

modifyForm

public abstract void modifyForm(AU user,
                                Form f)

Add two factor fields to a form. The added fields should not validate unless the correct authentication is applied

Parameters:

f -

addExtra

public ContentBuilder addExtra(ContentBuilder cb)

Add extra content when being shown a modified auth form.

Parameters:

cb -

Returns:

needAuth

public boolean needAuth(AU user)

Description copied from interface: TwoFactorComposite

would a call to TwoFactorComposite.requireAuth(AppUser) return a FormResult

Specified by:

needAuth in interface TwoFactorComposite<AU extends AppUser>

Returns:

authenticated

public void authenticated()

action to perform when authentication completed

Parameters:

ok - was it a successful authentication.

getType

protected final java.lang.Class<? super FormAuthComposite> getType()

Description copied from class: Composite

Returns the type the composite should be registered under.

Specified by:

getType in class Composite<AU extends AppUser,FormAuthComposite>

Returns:

registration type

getConfigPrefix

protected abstract java.lang.String getConfigPrefix()