Package net.shibboleth.idp.authn.duo.context

Class DuoAuthenticationContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.authn.duo.context.DuoAuthenticationContext

All Implemented Interfaces:

Iterable<BaseContext>

public final class DuoAuthenticationContext
extends BaseContext

Context that carries Duo factor and device or passcode to be used in validation.

This is used for AuthAPI-based use of Duo rather than the usual delegation of the process to their Web SDK.

Parent:

AuthenticationContext

Added:

After extracting the Duo factor and device or passcode during authentication

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field	Description
private String	clientAddress	Client address.
private String	duoDevice	Device ID.
private String	duoFactor	Factor.
private String	duoPasscode	Passcode.
private Map<String,String>	pushInfo	PushInfo data.
private String	username	Username.

Constructor Summary

Constructors

Constructor	Description
DuoAuthenticationContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getClientAddress()	Get the client address.
String	getDeviceID()	Get the device ID.
String	getFactor()	Get the factor to use.
String	getPasscode()	Get the passcode.
Map<String,String>	getPushInfo()	Get the pushinfo.
String	getUsername()	Get the username.
DuoAuthenticationContext	setClientAddress(String address)	Set the client address.
DuoAuthenticationContext	setDeviceID(String deviceId)	Set the device ID.
DuoAuthenticationContext	setFactor(String factor)	Set the factor to use.
DuoAuthenticationContext	setPasscode(String passcode)	Set the passcode.
DuoAuthenticationContext	setUsername(String name)	Set the username.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeSubcontext, removeSubcontext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

username

@Nullable
private String username

Username.

clientAddress

@Nullable
private String clientAddress

Client address.

duoFactor

@Nullable
private String duoFactor

Factor.

duoDevice

@Nullable
private String duoDevice

Device ID.

duoPasscode

@Nullable
private String duoPasscode

Passcode.

pushInfo

@Nullable
private Map<String,String> pushInfo

PushInfo data.

Constructor Details

DuoAuthenticationContext

public DuoAuthenticationContext()

Constructor.

Method Details

getUsername

@Nullable
public String getUsername()

Get the username.

Returns:

username

setUsername

@Nonnull
public DuoAuthenticationContext setUsername(@Nullable
String name)

Set the username.

Parameters:

name - username

Returns:

this context

getClientAddress

@Nullable
public String getClientAddress()

Get the client address.

Returns:

address

setClientAddress

@Nonnull
public DuoAuthenticationContext setClientAddress(@Nullable
String address)

Set the client address.

Parameters:

address - client address

Returns:

this context

getDeviceID

@Nullable
public String getDeviceID()

Get the device ID.

Returns:

the Duo device identifier

setDeviceID

@Nonnull
public DuoAuthenticationContext setDeviceID(@Nullable
String deviceId)

Set the device ID.

Parameters:

deviceId - the Duo device identifier

Returns:

this context

getFactor

@Nullable
public String getFactor()

Get the factor to use.

Returns:

the factor to use

setFactor

@Nonnull
public DuoAuthenticationContext setFactor(@Nullable
String factor)

Set the factor to use.

Parameters:

factor - the Duo factor

Returns:

this context

getPasscode

@Nullable
public String getPasscode()

Get the passcode.

Returns:

the passcode

setPasscode

@Nonnull
public DuoAuthenticationContext setPasscode(@Nullable
String passcode)

Set the passcode.

Parameters:

passcode - the passcode

Returns:

this context

getPushInfo

@Nonnull
@NonnullElements
@Live
public Map<String,String> getPushInfo()

Get the pushinfo.

Returns:

the pushinfo