io.micronaut.security.oauth2.endpoint.endsession.request.AwsCognitoEndSessionEndpoint 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.endpoint.endsession.request;

import io.micronaut.context.exceptions.ConfigurationException;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.uri.UriBuilder;
import io.micronaut.security.authentication.Authentication;
import io.micronaut.security.oauth2.client.OpenIdProviderMetadata;
import io.micronaut.security.oauth2.configuration.OauthClientConfiguration;
import io.micronaut.security.oauth2.configuration.OpenIdClientConfiguration;
import io.micronaut.security.oauth2.endpoint.endsession.response.EndSessionCallbackUrlBuilder;

import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Supplier;

/**
 * Provides specific configuration to logout from AWS Cognito.
 *
 * @see AWS Cognito Logout Endpoint
 *
 * @author Sergio del Amo
 * @since 1.2.0
 */
public class AwsCognitoEndSessionEndpoint extends AbstractEndSessionRequest {

    private static final String PARAM_CLIENT_ID = "client_id";
    private static final String PARAM_LOGOUT_URI = "logout_uri";

    /**
     * @param endSessionCallbackUrlBuilder The end session callback URL builder
     * @param clientConfiguration The client configuration
     * @param providerMetadata The provider metadata supplier
     */
    public AwsCognitoEndSessionEndpoint(EndSessionCallbackUrlBuilder endSessionCallbackUrlBuilder,
                                        OauthClientConfiguration clientConfiguration,
                                        Supplier providerMetadata) {
        super(endSessionCallbackUrlBuilder, clientConfiguration, providerMetadata);
    }

    @Override
    protected String getUrl() {
        String userInfoEndpoint = providerMetadataSupplier.get().getUserinfoEndpoint();
        if (userInfoEndpoint != null) {
            return UriBuilder.of(userInfoEndpoint).replacePath("/logout").toString();
        } else {
            URL url = clientConfiguration.getOpenid()
                    .flatMap(OpenIdClientConfiguration::getIssuer)
                    .orElseThrow(() -> new ConfigurationException("Open ID client configuration is missing the issuer URL"));
            return StringUtils.prependUri(url.toString(), "/logout");
        }
    }

    @Override
    protected Map getArguments(HttpRequest originating,
                                               Authentication authentication) {
        Map arguments = new HashMap<>();
        arguments.put(PARAM_CLIENT_ID, clientConfiguration.getClientId());
        arguments.put(PARAM_LOGOUT_URI, getRedirectUri(originating));
        return arguments;
    }
}