io.trino.server.security.oauth2.OidcDiscoveryConfig Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.trino.server.security.oauth2;

import io.airlift.configuration.Config;
import io.airlift.configuration.ConfigDescription;
import io.airlift.units.Duration;
import jakarta.validation.constraints.NotNull;

import java.util.Optional;

import static io.trino.server.security.oauth2.StaticOAuth2ServerConfig.ACCESS_TOKEN_ISSUER;
import static io.trino.server.security.oauth2.StaticOAuth2ServerConfig.AUTH_URL;
import static io.trino.server.security.oauth2.StaticOAuth2ServerConfig.JWKS_URL;
import static io.trino.server.security.oauth2.StaticOAuth2ServerConfig.TOKEN_URL;
import static io.trino.server.security.oauth2.StaticOAuth2ServerConfig.USERINFO_URL;
import static java.util.concurrent.TimeUnit.SECONDS;

public class OidcDiscoveryConfig
{
    private Duration discoveryTimeout = new Duration(30, SECONDS);
    private boolean userinfoEndpointEnabled = true;

    //TODO Left for backward compatibility, remove after the next release/a couple of releases
    private Optional accessTokenIssuer = Optional.empty();
    private Optional authUrl = Optional.empty();
    private Optional tokenUrl = Optional.empty();
    private Optional jwksUrl = Optional.empty();
    private Optional userinfoUrl = Optional.empty();

    @NotNull
    public Duration getDiscoveryTimeout()
    {
        return discoveryTimeout;
    }

    @Config("http-server.authentication.oauth2.oidc.discovery.timeout")
    @ConfigDescription("OpenID Connect discovery timeout")
    public OidcDiscoveryConfig setDiscoveryTimeout(Duration discoveryTimeout)
    {
        this.discoveryTimeout = discoveryTimeout;
        return this;
    }

    public boolean isUserinfoEndpointEnabled()
    {
        return userinfoEndpointEnabled;
    }

    @Config("http-server.authentication.oauth2.oidc.use-userinfo-endpoint")
    @ConfigDescription("Use userinfo endpoint from OpenID connect metadata document")
    public OidcDiscoveryConfig setUserinfoEndpointEnabled(boolean userinfoEndpointEnabled)
    {
        this.userinfoEndpointEnabled = userinfoEndpointEnabled;
        return this;
    }

    @NotNull
    public Optional getAccessTokenIssuer()
    {
        return accessTokenIssuer;
    }

    @Config(ACCESS_TOKEN_ISSUER)
    @ConfigDescription("The required issuer for access tokens")
    public OidcDiscoveryConfig setAccessTokenIssuer(String accessTokenIssuer)
    {
        this.accessTokenIssuer = Optional.ofNullable(accessTokenIssuer);
        return this;
    }

    @NotNull
    public Optional getAuthUrl()
    {
        return authUrl;
    }

    @Config(AUTH_URL)
    @ConfigDescription("URL of the authorization server's authorization endpoint")
    public OidcDiscoveryConfig setAuthUrl(String authUrl)
    {
        this.authUrl = Optional.ofNullable(authUrl);
        return this;
    }

    @NotNull
    public Optional getTokenUrl()
    {
        return tokenUrl;
    }

    @Config(TOKEN_URL)
    @ConfigDescription("URL of the authorization server's token endpoint")
    public OidcDiscoveryConfig setTokenUrl(String tokenUrl)
    {
        this.tokenUrl = Optional.ofNullable(tokenUrl);
        return this;
    }

    @NotNull
    public Optional getJwksUrl()
    {
        return jwksUrl;
    }

    @Config(JWKS_URL)
    @ConfigDescription("URL of the authorization server's JWKS (JSON Web Key Set) endpoint")
    public OidcDiscoveryConfig setJwksUrl(String jwksUrl)
    {
        this.jwksUrl = Optional.ofNullable(jwksUrl);
        return this;
    }

    @NotNull
    public Optional getUserinfoUrl()
    {
        return userinfoUrl;
    }

    @Config(USERINFO_URL)
    @ConfigDescription("URL of the userinfo endpoint")
    public OidcDiscoveryConfig setUserinfoUrl(String userinfoUrl)
    {
        this.userinfoUrl = Optional.ofNullable(userinfoUrl);
        return this;
    }
}