io.micronaut.security.oauth2.endpoint.token.request.context.OpenIdCodeTokenRequestContext 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.token.request.context;

import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.type.Argument;
import io.micronaut.http.MediaType;
import io.micronaut.security.oauth2.configuration.OauthClientConfiguration;
import io.micronaut.security.oauth2.configuration.OpenIdClientConfiguration;
import io.micronaut.security.oauth2.configuration.endpoints.TokenEndpointConfiguration;
import io.micronaut.security.oauth2.endpoint.SecureEndpoint;
import io.micronaut.security.oauth2.endpoint.authorization.response.AuthorizationResponse;
import io.micronaut.security.oauth2.endpoint.token.response.OpenIdTokenResponse;
import io.micronaut.security.oauth2.endpoint.token.response.TokenErrorResponse;
import io.micronaut.security.oauth2.grants.AuthorizationCodeGrant;
import io.micronaut.security.oauth2.url.OauthRouteUrlBuilder;
import java.util.Map;

/**
 * A token request context for sending an authorization
 * code grant request to an OpenID provider.
 *
 * @author James Kleeh
 * @since 1.2.0
 */
public class OpenIdCodeTokenRequestContext extends AbstractTokenRequestContext, OpenIdTokenResponse> {

    private final AuthorizationResponse authorizationResponse;
    private final OauthRouteUrlBuilder oauthRouteUrlBuilder;

    @Nullable
    private final String codeVerifier;

    /**
     * @param authorizationResponse The authorization response
     * @param oauthRouteUrlBuilder  The oauth route URL builder
     * @param tokenEndpoint         The token endpoint
     * @param clientConfiguration   The client configuration
     * @param codeVerifier            The PKCE code_verify
     */
    public OpenIdCodeTokenRequestContext(AuthorizationResponse authorizationResponse,
                                         OauthRouteUrlBuilder oauthRouteUrlBuilder,
                                         SecureEndpoint tokenEndpoint,
                                         OauthClientConfiguration clientConfiguration,
                                         @Nullable String codeVerifier) {
        super(getMediaType(clientConfiguration), tokenEndpoint, clientConfiguration);
        this.authorizationResponse = authorizationResponse;
        this.oauthRouteUrlBuilder = oauthRouteUrlBuilder;
        this.codeVerifier = codeVerifier;
    }

    /**
     * Resolves the media type for the request body.
     *
     * @param clientConfiguration The client configuration
     * @return The media type
     */
    protected static MediaType getMediaType(OauthClientConfiguration clientConfiguration) {
        return clientConfiguration.getOpenid()
                .flatMap(OpenIdClientConfiguration::getToken)
                .map(TokenEndpointConfiguration::getContentType)
                .orElse(MediaType.APPLICATION_FORM_URLENCODED_TYPE);
    }

    @Override
    public Map getGrant() {
        AuthorizationCodeGrant codeGrant = new AuthorizationCodeGrant();
        codeGrant.setCode(authorizationResponse.getCode());
        codeGrant.setCodeVerifier(getCodeVerifier());
        codeGrant.setRedirectUri(oauthRouteUrlBuilder
            .buildCallbackUrl(authorizationResponse.getCallbackRequest(), clientConfiguration.getName()).toString());
        return codeGrant.toMap();
    }

    @Override
    public Argument getResponseType() {
        return Argument.of(OpenIdTokenResponse.class);
    }

    @Override
    public Argument getErrorResponseType() {
        return Argument.of(TokenErrorResponse.class);
    }

    /**
     * @since 3.9.0
     * @return The PKCE code verifier
     */
    @Nullable
    public String getCodeVerifier() {
        return codeVerifier;
    }
}