io.micronaut.security.oauth2.routes.OauthController 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.routes;

import io.micronaut.context.annotation.Executable;
import io.micronaut.core.async.annotation.SingleResult;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.security.annotation.Secured;
import io.micronaut.security.oauth2.client.OauthClient;
import io.micronaut.security.rules.SecurityRule;
import java.util.Map;
import org.reactivestreams.Publisher;

/**
 * Responsible for OAuth 2.0 authorization redirect, authorization
 * callback, and end session redirects. Each controller is
 * associated with a single {@link OauthClient}.
 *
 * @author James Kleeh
 * @since 1.2.0
 */
@Secured(SecurityRule.IS_ANONYMOUS)
public interface OauthController {

    /**
     * @return The client associated with this controller
     */
    OauthClient getClient();

    /**
     * Performs an authorization redirect to an OAuth 2.0 provider.
     *
     * @param request The current request
     * @return A redirecting http response
     */
    @Executable
    @SingleResult
    Publisher> login(HttpRequest request);

    /**
     * Receives the authorization callback from the OAuth 2.0 provider
     * and responds to the user.
     *
     * @param request The current request
     * @return A response
     */
    @Executable
    @SingleResult
    Publisher> callback(HttpRequest> request);

}