sirius.web.security.SAMLResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirius-web Show documentation
Provides a modern and scalable web server as SIRIUS module
There is a newer version: 22.2.3
/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.web.security;

import sirius.kernel.commons.MultiMap;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Collection;

/**
 * Represents the parsed payload of a SAML response.
 */
public class SAMLResponse {

    private String issuer;
    private String fingerprint;
    private String nameId;
    private MultiMap attributes;

    /**
     * Contains the attribute URI used to transmit a security group.
     */
    public static final String ATTRIBUTE_GROUP = "http://schemas.xmlsoap.org/claims/Group";

    /**
     * Contains the attribute URI used to transmit the given name of the user being authenticated.
     */
    public static final String ATTRIBUTE_GIVEN_NAME = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname";

    /**
     * Contains the attribute URI used to transmit the surname of the user being authenticated.
     */
    public static final String ATTRIBUTE_SURNAME = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname";

    /**
     * Contains the attribute URI used to transmit the email address of the user being authenticated.
     */
    public static final String ATTRIBUTE_EMAIL_ADDRESS =
            "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress";

    /**
     * Creates a new SAML response.
     *
     * @param issuer      the issuer which created the SAML response
     * @param fingerprint the fingerprint of the certificate which was used to sign the response
     * @param nameId      the name of the user
     * @param attributes  the attributes within the Assertion
     */
    public SAMLResponse(String issuer, String fingerprint, String nameId, MultiMap attributes) {
        this.issuer = issuer;
        this.fingerprint = fingerprint;
        this.nameId = nameId;
        this.attributes = attributes;
    }

    /**
     * Returns the issuer of the assertion.
     *
     * @return the issuer of the assertion
     */
    public String getIssuer() {
        return issuer;
    }

    /**
     * Returns the fingerprint of the certificate which was used to sign the response.
     *
     * @return the fungerprint of the X509 certificate
     */
    public String getFingerprint() {
        return fingerprint;
    }

    /**
     * Returns the username or id which has been authenticated.
     *
     * @return the username
     */
    public String getNameId() {
        return nameId;
    }

    /**
     * Returns all attributes which were submitted for the given attribute URI.
     *
     * @param name the name or attribute URI
     * @return a collection containing all values submitted for the given attribute
     * or an empty collection if there are none.
     */
    @Nonnull
    public Collection getAttribute(String name) {
        return attributes.get(name);
    }

    /**
     * Returns the first attribute value submitted for the given attribute URI.
     *
     * @param name the name or attribute URI
     * @return the first value being submitted or null if there was no value
     */
    @Nullable
    public String getAttributeValue(String name) {
        return attributes.get(name).stream().findFirst().orElse(null);
    }
}