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

Class TotpCodeAuthComposite<A 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>

uk.ac.ed.epcc.webapp.session.twofactor.CodeAuthComposite<A,java.lang.Integer>

uk.ac.ed.epcc.webapp.session.twofactor.TotpCodeAuthComposite<A>

All Implemented Interfaces:

Contexed, TableStructureContributer<A>, SummaryContributer<A>, AppUserTransitionContributor, RequiredPageProvider<A>, TwoFactorComposite<A>

public class TotpCodeAuthComposite<A extends AppUser>
extends CodeAuthComposite<A,java.lang.Integer>
implements AppUserTransitionContributor, SummaryContributer<A>, RequiredPageProvider<A>

A FormAuthComposite that implements time-based authentication codes compatible with google authenticator

• https://tools.ietf.org/html/rfc4226
• https://tools.ietf.org/html/rfc6238

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TotpCodeAuthComposite.CodeValidator
class	TotpCodeAuthComposite.DirectClearKeyTransition
class	TotpCodeAuthComposite.SetToptTransition

Field Summary

Fields

Modifier and Type	Field and Description
static AppUserKey	CLEAR_KEY
static java.lang.String	REMOVE_KEY_ROLE
static Feature	REQUIRED_TWO_FACTOR
static CurrentUserKey	SET_KEY
static Feature	VERIFY_OLD_CODE

Fields inherited from class uk.ac.ed.epcc.webapp.session.twofactor.CodeAuthComposite

CODE, VERIFICATION_CODE_LABEL

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

fac

Constructor Summary

Constructors

Constructor and Description
TotpCodeAuthComposite(AppUserFactory<A> fac)

Method Summary

Modifier and Type	Method and Description
void	addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, A target) Add to the set of attributes.
ContentBuilder	addExtra(ContentBuilder cb) Add extra content when being shown a modified auth form.
java.util.Set<java.lang.String>	addSuppress(java.util.Set<java.lang.String> suppress) generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.
void	clearSecret(A user)
java.security.Key	decodeKey(java.lang.String enc)
boolean	enabled()
protected boolean	enabled(A user)
long	getCode(java.security.Key key, long counter)
protected java.lang.String	getConfigPrefix()
java.lang.String	getEncodedSecret(java.security.Key key)
Input<java.lang.Integer>	getInput()
long	getNorm() number of milliseconds per code value
java.util.Set<RequiredPage<A>>	getRequiredPages() Get the set of required pages.
java.security.Key	getSecret(A user)
java.util.Map<AppUserKey,Transition<AppUser>>	getTransitions(AppUserTransitionProvider prov)
java.net.URI	getURI(A user, java.security.Key key)
int	getWindow()
boolean	hasKey(A user) Do we have a key for this user.
java.security.Key	makeNewKey()
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
void	setSecret(A user, java.security.Key key)
void	setSecret(A user, java.lang.String enc)
boolean	verify(A user, java.lang.Integer value)
boolean	verify(java.security.Key key, java.lang.Integer value)

Methods inherited from class uk.ac.ed.epcc.webapp.session.twofactor.CodeAuthComposite

modifyForm

Methods inherited from class uk.ac.ed.epcc.webapp.session.twofactor.FormAuthComposite

authenticated, getType, needAuth, needToken, requireAuth, sendToken

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

addDefaults, addFieldHelp, addOptional, addSelectors, addTranslations, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, 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

Field Detail

REQUIRED_TWO_FACTOR

public static final Feature REQUIRED_TWO_FACTOR

VERIFY_OLD_CODE

public static final Feature VERIFY_OLD_CODE

REMOVE_KEY_ROLE

public static final java.lang.String REMOVE_KEY_ROLE

See Also:

Constant Field Values

SET_KEY

public static final CurrentUserKey SET_KEY

CLEAR_KEY

public static final AppUserKey CLEAR_KEY

Constructor Detail

TotpCodeAuthComposite

public TotpCodeAuthComposite(AppUserFactory<A> fac)

Parameters:

fac -

Method Detail

enabled

protected boolean enabled(A user)

Specified by:

enabled in class FormAuthComposite<A extends AppUser>

enabled

public boolean enabled()

Returns:

hasKey

public boolean hasKey(A user)

Do we have a key for this user.

Parameters:

user -

Returns:

boolean

makeNewKey

public java.security.Key makeNewKey()
                             throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException

setSecret

public void setSecret(A user,
                      java.security.Key key)

setSecret

public void setSecret(A user,
                      java.lang.String enc)

clearSecret

public void clearSecret(A user)

Parameters:

user -

decodeKey

public java.security.Key decodeKey(java.lang.String enc)

getSecret

public java.security.Key getSecret(A user)
                            throws java.io.UnsupportedEncodingException,
                                   java.security.NoSuchAlgorithmException,
                                   java.security.spec.InvalidKeySpecException

Throws:

java.io.UnsupportedEncodingException

java.security.NoSuchAlgorithmException

java.security.spec.InvalidKeySpecException

getEncodedSecret

public java.lang.String getEncodedSecret(java.security.Key key)
                                  throws java.io.UnsupportedEncodingException,
                                         java.security.NoSuchAlgorithmException,
                                         java.security.spec.InvalidKeySpecException

Throws:

java.io.UnsupportedEncodingException

java.security.NoSuchAlgorithmException

java.security.spec.InvalidKeySpecException

getCode

public long getCode(java.security.Key key,
                    long counter)
             throws java.security.NoSuchAlgorithmException,
                    java.security.InvalidKeyException

Throws:

java.security.NoSuchAlgorithmException

java.security.InvalidKeyException

getInput

public Input<java.lang.Integer> getInput()

Specified by:

getInput in class CodeAuthComposite<A extends AppUser,java.lang.Integer>

verify

public boolean verify(A user,
                      java.lang.Integer value)

Specified by:

verify in class CodeAuthComposite<A extends AppUser,java.lang.Integer>

verify

public boolean verify(java.security.Key key,
                      java.lang.Integer value)

getNorm

public long getNorm()

number of milliseconds per code value

Returns:

getWindow

public int getWindow()

modifyDefaultTableSpecification

public TableSpecification modifyDefaultTableSpecification(TableSpecification spec,
                                                          java.lang.String table)

Description copied from interface: TableStructureContributer

Modify the TableSpecification of the target factory.

Specified by:

modifyDefaultTableSpecification in interface TableStructureContributer<A extends AppUser>

Overrides:

modifyDefaultTableSpecification in class Composite<A extends AppUser,FormAuthComposite>

Returns:

addSuppress

public java.util.Set<java.lang.String> addSuppress(java.util.Set<java.lang.String> suppress)

Description copied from interface: TableStructureContributer

generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.

Specified by:

addSuppress in interface TableStructureContributer<A extends AppUser>

Overrides:

addSuppress in class Composite<A extends AppUser,FormAuthComposite>

Returns:

Set of fields to suppress in forms.

getURI

public java.net.URI getURI(A user,
                           java.security.Key key)
                    throws java.io.UnsupportedEncodingException,
                           java.security.NoSuchAlgorithmException,
                           java.security.spec.InvalidKeySpecException,
                           java.net.URISyntaxException

Throws:

java.io.UnsupportedEncodingException

java.security.NoSuchAlgorithmException

java.security.spec.InvalidKeySpecException

java.net.URISyntaxException

getTransitions

public java.util.Map<AppUserKey,Transition<AppUser>> getTransitions(AppUserTransitionProvider prov)

Specified by:

getTransitions in interface AppUserTransitionContributor

getRequiredPages

public java.util.Set<RequiredPage<A>> getRequiredPages()

Description copied from interface: RequiredPageProvider

Get the set of required pages.

Specified by:

getRequiredPages in interface RequiredPageProvider<A extends AppUser>

Returns:

Set of RequiredPage objects.

addAttributes

public void addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                          A target)

Description copied from interface: SummaryContributer

Add to the set of attributes. These will usually be added to a Table so the data should be of a type that can be displayed by Tables The keys should be display text.

Specified by:

addAttributes in interface SummaryContributer<A extends AppUser>

getConfigPrefix

protected java.lang.String getConfigPrefix()

Specified by:

getConfigPrefix in class FormAuthComposite<A extends AppUser>

addExtra

public ContentBuilder addExtra(ContentBuilder cb)

Description copied from class: FormAuthComposite

Add extra content when being shown a modified auth form.

Overrides:

addExtra in class FormAuthComposite<A extends AppUser>

Returns: