de.cuioss.portal.authentication.oauth.Oauth2Service Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-authentication-oauth Show documentation
Defines an implementation of the authentication facade using oauth2
The newest version!
/*
 * Copyright 2023 the original author or 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 de.cuioss.portal.authentication.oauth;

import jakarta.servlet.http.HttpServletRequest;

import de.cuioss.portal.authentication.AuthenticatedUserInfo;
import de.cuioss.portal.authentication.oauth.impl.OauthAuthenticatedUserInfo;
import de.cuioss.tools.net.UrlParameter;

/**
 * Accessing the oauth2 services to handle login, token request, and accessing
 * user information.
 *
 * @author Matthias Walliczek
 */
public interface Oauth2Service {

    /**
     * Creates an authenticated {@link AuthenticatedUserInfo} by requesting a token
     * and retrieving user data from the /userinfo endpoint. The returned
     * {@link AuthenticatedUserInfo} contains the {@code preferred_username} as
     * {@link AuthenticatedUserInfo#getDisplayName()} and {@code sub} as
     * {@link AuthenticatedUserInfo#getIdentifier()}. Other userinfo data is stored
     * in the {@link AuthenticatedUserInfo#getContextMap()}.
     *
     * @param servletRequest
     * @param code
     * @param state
     * @param scopes         the scopes to request
     * @return an authenticated {@link AuthenticatedUserInfo}.
     */
    AuthenticatedUserInfo createAuthenticatedUserInfo(HttpServletRequest servletRequest, UrlParameter code,
            UrlParameter state, String scopes, final String codeVerifier);

    /**
     * Calculate the redirect url that gets send to the oauth2 server as urlencoded
     * parameter value.
     *
     * @param url
     * @return the url.
     */
    String calcEncodedRedirectUrl(String url);

    /**
     * Retrieve an {@link AuthenticatedUserInfo} with the user info properties from
     * the oauth server.
     *
     * @param scopes
     * @param token
     * @param tokenTimestamp
     * @return
     */
    AuthenticatedUserInfo retrieveAuthenticatedUser(String scopes, Token token, int tokenTimestamp);

    /**
     * Retrieve an accessToken for the client with defined scope(s).
     *
     * @param scopes the scopes as space separated list, can be null (= all
     *               registered scopes)
     * @return the accessToken
     */
    String retrieveClientToken(String scopes);

    /**
     * Refresh the {@link Token} in the current users context map.
     *
     * @param currentUser current oauth user
     * @return access token
     */
    String refreshToken(OauthAuthenticatedUserInfo currentUser);
}