Package net.shibboleth.idp.authn.duo

Class BasicDuoIntegration

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.authn.duo.BasicDuoIntegration

All Implemented Interfaces:

DuoIntegration, PrincipalSupportingComponent, Component, DestructableComponent, InitializableComponent

public class BasicDuoIntegration
extends AbstractInitializableComponent
implements DuoIntegration

Wrapper for use of Duo.

Since:

3.3.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	apiHost	API host.
private String	applicationKey	Application key.
private String	integrationKey	Integration key.
private String	secretKey	Secret key.
private Subject	supportedPrincipals	Container for supported principals.

Constructor Summary

Constructors

Constructor	Description
BasicDuoIntegration()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
String	getAPIHost()	Get the name of the API host to contact.
String	getApplicationKey()	Get the application key.
String	getIntegrationKey()	Get the integration key.
String	getSecretKey()	Get the secret key.
<T extends Principal> Set<T>	getSupportedPrincipals(Class<T> c)	Get an immutable set of supported custom principals that the component produces, supports, contains, etc.
void	setAPIHost(String host)	Set the API host to use.
void	setApplicationKey(String key)	Set the application key to use.
void	setIntegrationKey(String key)	Set the integration key to use.
void	setSecretKey(String key)	Set the secret key to use.
<T extends Principal> void	setSupportedPrincipals(Collection<T> principals)	Set supported non-user-specific principals that the action will include in the subjects it generates, in place of any default principals from the flow.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

apiHost

@NonnullAfterInit
@NotEmpty
private String apiHost

API host.

applicationKey

@Nullable
@NotEmpty
private String applicationKey

Application key.

integrationKey

@NonnullAfterInit
@NotEmpty
private String integrationKey

Integration key.

secretKey

@NonnullAfterInit
@NotEmpty
private String secretKey

Secret key.

supportedPrincipals

@Nonnull
private final Subject supportedPrincipals

Container for supported principals.

Constructor Detail

BasicDuoIntegration

public BasicDuoIntegration()

Constructor.

Method Detail

getAPIHost

@Nonnull
@NotEmpty
public String getAPIHost()

Get the name of the API host to contact.

Specified by:

getAPIHost in interface DuoIntegration

Returns:

name of API host

setAPIHost

public void setAPIHost(@Nonnull @NotEmpty
                       String host)

Set the API host to use.

Parameters:

host - API host

getApplicationKey

@Nullable
@NotEmpty
public String getApplicationKey()

Get the application key.

Specified by:

getApplicationKey in interface DuoIntegration

Returns:

the application key

setApplicationKey

public void setApplicationKey(@Nullable @NotEmpty
                              String key)

Set the application key to use.

Parameters:

key - application key

getIntegrationKey

@Nonnull
@NotEmpty
public String getIntegrationKey()

Get the integration key.

Specified by:

getIntegrationKey in interface DuoIntegration

Returns:

the integration key

setIntegrationKey

public void setIntegrationKey(@Nonnull @NotEmpty
                              String key)

Set the integration key to use.

Parameters:

key - integration key

getSecretKey

@Nonnull
@NotEmpty
public String getSecretKey()

Get the secret key.

Specified by:

getSecretKey in interface DuoIntegration

Returns:

the secret key

setSecretKey

public void setSecretKey(@Nonnull @NotEmpty
                         String key)

Set the secret key to use.

Parameters:

key - secret key

getSupportedPrincipals

@Nonnull
@NonnullElements
@Unmodifiable
public <T extends Principal> Set<T> getSupportedPrincipals(@Nonnull
                                                           Class<T> c)

Get an immutable set of supported custom principals that the component produces, supports, contains, etc.

Specified by:

getSupportedPrincipals in interface PrincipalSupportingComponent

Type Parameters:

T - type of Principal to inquire on

Parameters:

c - type of Principal to inquire on

Returns:

a set of matching principals

setSupportedPrincipals

public <T extends Principal> void setSupportedPrincipals(@Nullable @NonnullElements
                                                         Collection<T> principals)

Set supported non-user-specific principals that the action will include in the subjects it generates, in place of any default principals from the flow.

Setting to a null or empty collection will maintain the default behavior of relying on the flow.

Type Parameters:

T - a type of principal to add, if not generic

Parameters:

principals - supported principals to include

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException