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

Class DuoSDKClientAdaptor

java.lang.Object

net.shibboleth.idp.plugin.authn.duo.AbstractDuoOIDCClient

net.shibboleth.idp.plugin.authn.duo.sdk.impl.DuoSDKClientAdaptor

All Implemented Interfaces:

DuoOIDCClient, DuoOIDCClientCapabilities

@ThreadSafe
@Immutable
public final class DuoSDKClientAdaptor
extends AbstractDuoOIDCClient

An Object Adaptor class for bridging between the Duo SDK implementation and the internal DuoOIDCClient interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	DuoSDKClientAdaptor.DefaultHealthCheckResponseConverter	Default health check response converter.
private class	DuoSDKClientAdaptor.DefaultTokenResponseConverter	Default Duo token converter.

Field Summary

Fields

Modifier and Type	Field	Description
private com.duosecurity.Client	client	The wrapped Duo native client.
private DuoOIDCIntegration	duoIntegration	Save off the integration to help generate the JWT.
private Function<com.duosecurity.model.HealthCheckResponse,DuoHealthCheck>	healthCheckResponseConverter	Function to map the native Duo HealthCheckResponse object to the interface DuoHealthCheck object.
private org.slf4j.Logger	log	Class logger.
private BiFunction<com.duosecurity.model.Token,DuoOIDCIntegration,com.nimbusds.jwt.JWT>	tokenResponseConverter	Function to map the native Duo Token object to the interface JWT object.

Constructor Summary

Constructors

Constructor	Description
DuoSDKClientAdaptor(DuoOIDCIntegration integration, List<String> caCerts)	Package-private constructor.

Method Summary

Modifier and Type	Method	Description
String	createAuthUrl(String username, String state, String nonce, String redirectURIOverride)
com.nimbusds.jwt.JWT	exchangeAuthorizationCodeFor2FAResult(String code, String username, String redirectURIOverride)
DuoHealthCheck	healthCheck()
boolean	isSupportsNonce()

Methods inherited from class net.shibboleth.idp.plugin.authn.duo.AbstractDuoOIDCClient

getCapabilities, getClientId

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

client

@Nonnull
private final com.duosecurity.Client client

The wrapped Duo native client.

healthCheckResponseConverter

@Nonnull
private final Function<com.duosecurity.model.HealthCheckResponse,DuoHealthCheck> healthCheckResponseConverter

Function to map the native Duo HealthCheckResponse object to the interface DuoHealthCheck object.

tokenResponseConverter

@Nonnull
private final BiFunction<com.duosecurity.model.Token,DuoOIDCIntegration,com.nimbusds.jwt.JWT> tokenResponseConverter

Function to map the native Duo Token object to the interface JWT object.

duoIntegration

@Nonnull
private final DuoOIDCIntegration duoIntegration

Save off the integration to help generate the JWT.

Constructor Detail

DuoSDKClientAdaptor

DuoSDKClientAdaptor(@Nonnull
                    DuoOIDCIntegration integration,
                    @Nullable
                    List<String> caCerts)
             throws DuoClientException

Package-private constructor. Initialises the native Duo SDK client.

Should only be instantiated by the DuoSDKClientFactory.

Parameters:

integration - the Duo integration to initialize the client from. Never null.

caCerts - the list of CA Certificates used to validate connections to Duo. Can be null.

Throws:

DuoClientException - if there is an error instantiating the client

Method Detail

healthCheck

@Nonnull
public DuoHealthCheck healthCheck()
                           throws DuoClientException

Throws:

DuoClientException

createAuthUrl

@Nonnull
public String createAuthUrl(@Nonnull @NotEmpty
                            String username,
                            @Nonnull @NotEmpty
                            String state,
                            @Nullable
                            String nonce,
                            @Nullable
                            String redirectURIOverride)
                     throws DuoClientException

The Duo WebSDK Client does not support either the nonce or redirectURIOverride parameters.

Throws:

DuoClientException

exchangeAuthorizationCodeFor2FAResult

@Nonnull
public com.nimbusds.jwt.JWT exchangeAuthorizationCodeFor2FAResult(@Nonnull
                                                                  String code,
                                                                  @Nonnull
                                                                  String username,
                                                                  @Nullable
                                                                  String redirectURIOverride)
                                                           throws DuoClientException

The Duo WebSDK Client does not support the redirectURIOverride parameter.

Throws:

DuoClientException

isSupportsNonce

public boolean isSupportsNonce()