org.pac4j.oauth.profile.casoauthwrapper.CasOAuthWrapperProfileDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pac4j-oauth Show documentation
There is a newer version: 6.1.0
package org.pac4j.oauth.profile.casoauthwrapper;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.github.scribejava.core.model.Token;
import lombok.val;
import org.pac4j.core.profile.ProfileHelper;
import org.pac4j.core.profile.converter.Converters;
import org.pac4j.oauth.config.OAuthConfiguration;
import org.pac4j.oauth.profile.JsonHelper;
import org.pac4j.oauth.profile.definition.OAuthProfileDefinition;
import org.pac4j.scribe.builder.api.CasOAuthWrapperApi20;

import static org.pac4j.core.profile.AttributeLocation.PROFILE_ATTRIBUTE;

/**
 * {@link CasOAuthWrapperProfile} profile definition.
 *
 * @author Jerome Leleu
 * @since 1.9.2
 */
public class CasOAuthWrapperProfileDefinition extends OAuthProfileDefinition {

    private static final String ID = "id";

    /** Constant IS_FROM_NEW_LOGIN="isFromNewLogin" */
    public static final String IS_FROM_NEW_LOGIN = "isFromNewLogin";
    /** Constant AUTHENTICATION_DATE="authenticationDate" */
    public static final String AUTHENTICATION_DATE = "authenticationDate";
    /** Constant AUTHENTICATION_METHOD="authenticationMethod" */
    public static final String AUTHENTICATION_METHOD = "authenticationMethod";
    /** Constant SUCCESSFUL_AUTHENTICATION_HANDLERS="successfulAuthenticationHandlers" */
    public static final String SUCCESSFUL_AUTHENTICATION_HANDLERS = "successfulAuthenticationHandlers";
    /** Constant LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED="longTermAuthenticationRequestTokenUsed" */
    public static final String LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED = "longTermAuthenticationRequestTokenUsed";

    /**
     * Constructor for CasOAuthWrapperProfileDefinition.
     */
    public CasOAuthWrapperProfileDefinition() {
        super(x -> new CasOAuthWrapperProfile());
        primary(IS_FROM_NEW_LOGIN, Converters.BOOLEAN);
        primary(AUTHENTICATION_DATE, new CasAuthenticationDateFormatter());
        primary(AUTHENTICATION_METHOD, Converters.STRING);
        primary(SUCCESSFUL_AUTHENTICATION_HANDLERS, Converters.STRING);
        primary(LONG_TERM_AUTHENTICATION_REQUEST_TOKEN_USED, Converters.BOOLEAN);
    }

    /** {@inheritDoc} */
    @Override
    public String getProfileUrl(final Token accessToken, final OAuthConfiguration configuration) {
        return ((CasOAuthWrapperApi20) configuration.getApi()).getCasServerUrl() + "/profile";
    }

    /** {@inheritDoc} */
    @Override
    public CasOAuthWrapperProfile extractUserProfile(final String body) {
        val profile = (CasOAuthWrapperProfile) newProfile();
        var json = JsonHelper.getFirstNode(body);
        if (json != null) {
            profile.setId(ProfileHelper.sanitizeIdentifier(JsonHelper.getElement(json, ID)));
            val attributes = json.get("attributes");
            if (attributes != null) {
                extractAttributes(attributes, profile);
            } else {
                // flatten profiles
                extractAttributes(json, profile);
            }
        } else {
            raiseProfileExtractionJsonError(body);
        }
        return profile;
    }

    protected void extractAttributes(final JsonNode json, final CasOAuthWrapperProfile profile) {
        // CAS <= v4.2
        if (json instanceof ArrayNode) {
            val nodes = json.iterator();
            while (nodes.hasNext()) {
                val nextNode = nodes.next();
                val attribute = nextNode.fieldNames().next();
                if (!ID.equals(attribute)) {
                    convertAndAdd(profile, PROFILE_ATTRIBUTE, attribute, JsonHelper.getElement(nextNode, attribute));
                }
            }
            // CAS v5
        } else if (json instanceof ObjectNode) {
            val keys = json.fieldNames();
            while (keys.hasNext()) {
                val key = keys.next();
                if (!ID.equals(key)) {
                    convertAndAdd(profile, PROFILE_ATTRIBUTE, key, JsonHelper.getElement(json, key));
                }
            }
        }
    }
}