io.quarkus.elytron.security.oauth2.runtime.OAuth2RuntimeConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-elytron-security-oauth2 Show documentation

Secure your applications with OAuth2 opaque tokens

There is a newer version: 3.17.0

Show newest version

package io.quarkus.elytron.security.oauth2.runtime;

import java.util.Optional;

import io.quarkus.runtime.annotations.ConfigPhase;
import io.quarkus.runtime.annotations.ConfigRoot;
import io.smallrye.config.ConfigMapping;

/**
 * See https://docs.wildfly.org/14/WildFly_Elytron_Security.html#validating-oauth2-bearer-tokens
 */
@ConfigMapping(prefix = "quarkus.oauth2")
@ConfigRoot(phase = ConfigPhase.RUN_TIME)
public interface OAuth2RuntimeConfig {

    /**
     * The OAuth2 client id used to validate the token.
     * Mandatory if the extension is enabled.
     */
    Optional clientId();

    /**
     * The OAuth2 client secret used to validate the token.
     * Mandatory if the extension is enabled.
     */
    Optional clientSecret();

    /**
     * The OAuth2 introspection endpoint URL used to validate the token and gather the authentication claims.
     * Mandatory if the extension is enabled.
     */
    Optional introspectionUrl();

    /**
     * The OAuth2 server certificate file. Warning: this is not supported in native mode where the certificate
     * must be included in the truststore used during the native image generation, see
     * Using SSL With Native Executables.
     */
    Optional caCertFile();
}