Package net.shibboleth.idp.authn.duo.impl

Class AbstractDuoAuthenticator

java.lang.Object

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

net.shibboleth.idp.authn.duo.impl.AbstractDuoAuthenticator

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

Direct Known Subclasses:

DuoAuthAuthenticator, DuoPreauthAuthenticator

@ThreadSafe
public abstract class AbstractDuoAuthenticator
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

A base class for authentication actions which call a Duo AuthAPI endpont.

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.http.client.HttpClient	httpClient	HttpClient for contacting Duo.
private org.opensaml.security.httpclient.HttpClientSecurityParameters	httpClientSecurityParameters	HTTP client security parameters.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper	JSON object mapper.

Constructor Summary

Constructors

Constructor	Description
AbstractDuoAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected <T extends DuoResponseWrapper<?>> T	doAPIRequest(org.apache.http.client.methods.HttpUriRequest request, com.fasterxml.jackson.core.type.TypeReference<T> wrapperTypeRef)	Performs a call to the Duo AuthAPI.
protected void	doInitialize()
void	setHttpClient(org.apache.http.client.HttpClient client)	Set the HttpClient to use for contacting Duo.
void	setHttpClientSecurityParameters(org.opensaml.security.httpclient.HttpClientSecurityParameters params)	Set the optional client security parameters.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)	Set the JSON ObjectMapper.

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

httpClient

@NonnullAfterInit
private org.apache.http.client.HttpClient httpClient

HttpClient for contacting Duo.

httpClientSecurityParameters

@Nullable
private org.opensaml.security.httpclient.HttpClientSecurityParameters httpClientSecurityParameters

HTTP client security parameters.

objectMapper

@NonnullAfterInit
private com.fasterxml.jackson.databind.ObjectMapper objectMapper

JSON object mapper.

Constructor Detail

AbstractDuoAuthenticator

public AbstractDuoAuthenticator()

Method Detail

setHttpClient

public void setHttpClient(@Nonnull
                          org.apache.http.client.HttpClient client)

Set the HttpClient to use for contacting Duo.

Parameters:

client - HttpClient

setHttpClientSecurityParameters

public void setHttpClientSecurityParameters(@Nullable
                                            org.opensaml.security.httpclient.HttpClientSecurityParameters params)

Set the optional client security parameters.

Parameters:

params - the new client security parameters

setObjectMapper

public void setObjectMapper(@Nonnull
                            com.fasterxml.jackson.databind.ObjectMapper mapper)

Set the JSON ObjectMapper.

Parameters:

mapper - object mapper

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doAPIRequest

protected <T extends DuoResponseWrapper<?>> T doAPIRequest(@Nonnull
                                                           org.apache.http.client.methods.HttpUriRequest request,
                                                           @Nonnull
                                                           com.fasterxml.jackson.core.type.TypeReference<T> wrapperTypeRef)
                                                    throws com.duosecurity.duoweb.DuoWebException,
                                                           org.apache.http.client.ClientProtocolException,
                                                           IOException

Performs a call to the Duo AuthAPI. Upon a successful call, the JSON response is mapped into the appropriate type of DuoResponseWrapper.

Type Parameters:

T - the DuoResponse type being wrapped

Parameters:

request - the prepared HTTP request

wrapperTypeRef - the type of DuoResponseWrapper to use

Returns:

a DuoResponseWrapper

Throws:

IOException - on an I/O error

org.apache.http.client.ClientProtocolException - on an HTTP error

com.duosecurity.duoweb.DuoWebException - on a Duo-related error