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

Class SimpleDuoOIDCIntegration

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.idp.plugin.authn.duo.SimpleDuoOIDCIntegration
All Implemented Interfaces:
PrincipalSupportingComponent, DuoOIDCIntegration, Component, DestructableComponent, InitializableComponent
@ThreadSafe @Deprecated(forRemoval=true, since="2.1.0") public final class SimpleDuoOIDCIntegration extends AbstractInitializableComponent implements DuoOIDCIntegration
Deprecated, for removal: This API element is subject to removal in a future version.
A data wrapper for use with Duo OIDC integrations which does not support redirectURI generation.

This class was replaced by the DefaultDuoOIDCIntegration subclass.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    apiHost
    Deprecated, for removal: This API element is subject to removal in a future version.
    API host.
    private String
    authorizeEndpoint
    Deprecated, for removal: This API element is subject to removal in a future version.
    The URL path to the authorization endpoint.
    private String
    clientId
    Deprecated, for removal: This API element is subject to removal in a future version.
    Integration key.
    private String
    healthEndpoint
    Deprecated, for removal: This API element is subject to removal in a future version.
    The URL path to the health endpoint.
    private boolean
    passwordless
    Deprecated, for removal: This API element is subject to removal in a future version.
    Passwordless indicator.
    private String
    redirectURI
    Deprecated, for removal: This API element is subject to removal in a future version.
    The used (by clients) redirect_uri to send the client after authorisation .
    private String
    secretKey
    Deprecated, for removal: This API element is subject to removal in a future version.
    Secret key.
    private final Subject
    supportedPrincipals
    Deprecated, for removal: This API element is subject to removal in a future version.
    Container for supported principals.
    private String
    tokenEndpoint
    Deprecated, for removal: This API element is subject to removal in a future version.
    The URL path to the token endpoint.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SimpleDuoOIDCIntegration()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doInitialize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    boolean
    equals(Object obj)
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    getAPIHost()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the name of the API host to contact.
    String
    getAuthorizeEndpoint()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the path of the authorization endpoint.
    String
    getClientId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the clientId key.
    String
    getHealthCheckEndpoint()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the path of the health check endpoint.
    String
    getRedirectURI()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the runtime redirectURI to direct the client to after authorisation.
    String
    getSecretKey()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the secret key.
    <T extends Principal>
    Set<T>
    getSupportedPrincipals(Class<T> c)
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    getTokenEndpoint()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the path of the token endpoint.
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    boolean
    isPasswordless()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets whether the integration is suitable for use as a passwordless single factor.
    void
    setAPIHost(String host)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the API host to use.
    void
    setAuthorizeEndpoint(String endpoint)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the authorize endpoint URL path.
    void
    setClientId(String id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the client ID to use.
    void
    setHealthCheckEndpoint(String endpoint)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the health check endpoint URL path.
    void
    setPasswordless(boolean flag)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets whether this integration is suitable for use as a single factor.
    void
    setRedirectURI(String url)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the redirect URI.
    void
    setSecretKey(String key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the secret key to use.
    <T extends Principal>
    void
    setSupportedPrincipals(Collection<T> principals)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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.
    void
    setTokenEndpoint(String endpoint)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the token endpoint URL path.
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.

    Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

    checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface net.shibboleth.idp.plugin.authn.duo.DuoOIDCIntegration

    getAllowedFactors, getContextToPrincipalMappingStrategy

  • Field Details

    • passwordless

      private boolean passwordless
      Deprecated, for removal: This API element is subject to removal in a future version.
      Passwordless indicator.

    • apiHost

      @NonnullAfterInit @NotEmpty private String apiHost
      Deprecated, for removal: This API element is subject to removal in a future version.
      API host.

    • clientId

      @NonnullAfterInit @NotEmpty private String clientId
      Deprecated, for removal: This API element is subject to removal in a future version.
      Integration key.

    • secretKey

      @NonnullAfterInit @NotEmpty private String secretKey
      Deprecated, for removal: This API element is subject to removal in a future version.
      Secret key.

    • redirectURI

      @Nullable private String redirectURI
      Deprecated, for removal: This API element is subject to removal in a future version.
      The used (by clients) redirect_uri to send the client after authorisation .

    • healthEndpoint

      @NonnullAfterInit @NotEmpty private String healthEndpoint
      Deprecated, for removal: This API element is subject to removal in a future version.
      The URL path to the health endpoint.

    • authorizeEndpoint

      @NonnullAfterInit @NotEmpty private String authorizeEndpoint
      Deprecated, for removal: This API element is subject to removal in a future version.
      The URL path to the authorization endpoint.

    • tokenEndpoint

      @NonnullAfterInit @NotEmpty private String tokenEndpoint
      Deprecated, for removal: This API element is subject to removal in a future version.
      The URL path to the token endpoint.

    • supportedPrincipals

      @Nonnull private final Subject supportedPrincipals
      Deprecated, for removal: This API element is subject to removal in a future version.
      Container for supported principals.

  • Constructor Details

    • SimpleDuoOIDCIntegration

      public SimpleDuoOIDCIntegration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor.

  • Method Details

    • setPasswordless

      public void setPasswordless(boolean flag)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets whether this integration is suitable for use as a single factor.

      Defaults to false.

      Parameters:
      flag - flag to set
      Since:
      2.1.0

    • isPasswordless

      public boolean isPasswordless()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets whether the integration is suitable for use as a passwordless single factor.

      Defaults to false.

      Specified by:
      isPasswordless in interface DuoOIDCIntegration
      Returns:
      true iff the integration limits methods to passwordless

    • getAPIHost

      @Nonnull @NotEmpty public String getAPIHost()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the name of the API host to contact.
      Specified by:
      getAPIHost in interface DuoOIDCIntegration
      Returns:
      name of API host

    • setAPIHost

      public void setAPIHost(@Nonnull @NotEmpty String host)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the API host to use.
      Parameters:
      host - API host

    • getHealthCheckEndpoint

      @Nonnull @NotEmpty public String getHealthCheckEndpoint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the path of the health check endpoint.
      Specified by:
      getHealthCheckEndpoint in interface DuoOIDCIntegration
      Returns:
      the path of the health check endpoint

    • setHealthCheckEndpoint

      public void setHealthCheckEndpoint(@Nonnull @NotEmpty String endpoint)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the health check endpoint URL path.
      Parameters:
      endpoint - the endpoint.

    • getAuthorizeEndpoint

      @Nonnull @NotEmpty public String getAuthorizeEndpoint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the path of the authorization endpoint.
      Specified by:
      getAuthorizeEndpoint in interface DuoOIDCIntegration
      Returns:
      the path of the authorization endpoint

    • setAuthorizeEndpoint

      public void setAuthorizeEndpoint(@Nonnull @NotEmpty String endpoint)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the authorize endpoint URL path.
      Parameters:
      endpoint - the endpoint.

    • getTokenEndpoint

      @Nonnull @NotEmpty public String getTokenEndpoint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the path of the token endpoint.
      Specified by:
      getTokenEndpoint in interface DuoOIDCIntegration
      Returns:
      the path of the token endpoint;

    • setTokenEndpoint

      public void setTokenEndpoint(@Nonnull @NotEmpty String endpoint)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the token endpoint URL path.
      Parameters:
      endpoint - the endpoint.

    • getRedirectURI

      @Nullable public String getRedirectURI()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the runtime redirectURI to direct the client to after authorisation.
      Specified by:
      getRedirectURI in interface DuoOIDCIntegration
      Returns:
      the redirectURI

    • setRedirectURI

      public void setRedirectURI(@Nonnull String url)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the redirect URI.
      Parameters:
      url - the url.

    • setClientId

      public void setClientId(@Nonnull @NotEmpty String id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the client ID to use.
      Parameters:
      id - the client identifier.

    • getClientId

      @Nonnull @NotEmpty public String getClientId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the clientId key.
      Specified by:
      getClientId in interface DuoOIDCIntegration
      Returns:
      the integration key

    • setSecretKey

      public void setSecretKey(@Nonnull @NotEmpty String key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the secret key to use.
      Parameters:
      key - secret key

    • getSecretKey

      @Nonnull @NotEmpty public String getSecretKey()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the secret key.
      Specified by:
      getSecretKey in interface DuoOIDCIntegration
      Returns:
      the secret key

    • getSupportedPrincipals

      @Nonnull @NonnullElements @Unmodifiable public <T extends Principal> Set<T> getSupportedPrincipals(@Nonnull Class<T> c)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getSupportedPrincipals in interface PrincipalSupportingComponent

    • setSupportedPrincipals

      public <T extends Principal> void setSupportedPrincipals(@Nullable @NonnullElements Collection<T> principals)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      doInitialize in class AbstractInitializableComponent
      Throws:
      ComponentInitializationException

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object