io.micronaut.security.oauth2.configuration.OpenIdClientConfiguration Maven / Gradle / Ivy

Go to download

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

Official Security Solution for Micronaut

There is a newer version: 4.11.1

Show newest version

/*
 * Copyright 2017-2023 original authors
 *
 * 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
 *
 * https://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.micronaut.security.oauth2.configuration;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.naming.Named;
import io.micronaut.security.oauth2.configuration.endpoints.AuthorizationEndpointConfiguration;
import io.micronaut.security.oauth2.configuration.endpoints.EndSessionEndpointConfiguration;
import io.micronaut.security.oauth2.configuration.endpoints.EndpointConfiguration;
import io.micronaut.security.oauth2.configuration.endpoints.TokenEndpointConfiguration;
import java.net.URL;
import java.util.Optional;

/**
 * Configuration for an OpenID client.
 *
 * @author Sergio del Amo
 * @since 1.2.0
 */
public interface OpenIdClientConfiguration extends Named {

    /**
     * @return URL that the OpenID provider asserts as its issuer identifier.
     */
    Optional getIssuer();

    /**
     * @return The OpenID configuration path
     */
    String getConfigurationPath();


    /**
     * @return The JWKS configuration
     */
    Optional getJwksUri();

    /**
     * @see RFC 7591 - Section 3.1
     * @see OpenID Connect Client Registration
     * @return The registration endpoint configuration
     */
    Optional getRegistration();

    /**
     * @see OpenID Connect Core 1.0 - UserInfo
     * @return The user info endpoint configuration
     */
    Optional getUserInfo();

    /**
     * @see RFC 6749 - Section 3.1
     * @see OpenID Connect Core 1.0 - Authorization Endpoint
     * @return The authorization endpoint configuration
     */
    Optional getAuthorization();

    /**
     * @see RFC 6749 - Section 4.1.3
     * @see OpenID Connect Core 1.0
     * @return The token endpoint configuration
     */
    Optional getToken();

    /**
     * @see OpenID Connect Session 1.0
     * @return The end session configuration
     */
    @NonNull
    EndSessionEndpointConfiguration getEndSession();
}