com.github.choonchernlim.security.adfs.saml2.SAMLConfigBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-security-adfs-saml2 Show documentation
Spring Security ADFS module using SAML2 protocol
There is a newer version: 0.9.0
Show newest version
package com.github.choonchernlim.security.adfs.saml2;

import static com.github.choonchernlim.betterPreconditions.preconditions.PreconditionFactory.expect;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableSet;
import org.opensaml.saml2.core.AuthnContext;
import org.springframework.core.io.Resource;
import org.springframework.security.saml.userdetails.SAMLUserDetailsService;

import java.util.Set;

/**
 * This class contains all properties that can be configured by Sp using the provided builder class.
 */
public final class SAMLConfigBean {

    /**
     * (REQUIRED) IdP's server name.
     */
    private final String idpServerName;

    /**
     * (REQUIRED) Sp's server name.
     */
    private final String spServerName;

    /**
     * (OPTIONAL) Sp's HTTPS port.
     * 
     * Default is 443.
     */
    private final Integer spHttpsPort;

    /**
     * (OPTIONAL) Sp's context path.
     * 

     * Default is "".
     */
    private final String spContextPath;

    /**
     * (REQUIRED) Keystore containing app's public/private key and ADFS' certificate with public key.
     */
    private final Resource keystoreResource;

    /**
     * (REQUIRED) Keystore alias.
     */
    private final String keystoreAlias;

    /**
     * (REQUIRED) Keystore password.
     */
    private final String keystorePassword;

    /**
     * (REQUIRED) Keystore private key password.
     */
    private final String keystorePrivateKeyPassword;

    /**
     * (REQUIRED) Where to redirect user on successful login if no saved request is found in the session.
     */
    private final String successLoginDefaultUrl;

    /**
     * (REQUIRED) Where to redirect user on successful logout.
     */
    private final String successLogoutUrl;

    /**
     * Where to redirect user on failed login. This value is set to null, which returns
     * 401 error code on failed login. But, in theory, this will never be used because
     * IdP will handled the failed login on IdP login page.
     * 

     * Default is blank.
     */
    private final String failedLoginDefaultUrl;

    /**
     * For configuring user details and authorities.
     * 

     * Default is null.
     */
    private final SAMLUserDetailsService samlUserDetailsService;

    /**
     * Determine what authentication methods to use.
     * 

     * To use the order of authentication methods defined by IdP, set as empty set.
     * 

     * To enable Windows Integrated Auth (WIA) cross browsers and OSes, use `CustomAuthnContext.WINDOWS_INTEGRATED_AUTHN_CTX`.
     * 
     * Default is user/password authentication where IdP login page is displayed.
     */
    private final Set authnContexts;

    SAMLConfigBean(final String idpServerName,
                   final String spServerName,
                   final Integer spHttpsPort,
                   final String spContextPath,
                   final Resource keystoreResource,
                   final String keystoreAlias,
                   final String keystorePassword,
                   final String keystorePrivateKeyPassword,
                   final String successLoginDefaultUrl,
                   final String successLogoutUrl,
                   final String failedLoginDefaultUrl,
                   final SAMLUserDetailsService samlUserDetailsService,
                   final Set authnContexts) {

        //@formatter:off
        this.idpServerName = expect(idpServerName, "IdP server name").not().toBeBlank().check();

        this.spServerName = expect(spServerName, "Sp server name").not().toBeBlank().check();
        this.spHttpsPort = Optional.fromNullable(spHttpsPort).or(443);
        this.spContextPath = Optional.fromNullable(spContextPath).or("");

        this.keystoreResource = (Resource) expect(keystoreResource, "Key store").not().toBeNull().check();
        this.keystoreAlias = expect(keystoreAlias, "Keystore alias").not().toBeBlank().check();
        this.keystorePassword = expect(keystorePassword, "Keystore password").not().toBeBlank().check();
        this.keystorePrivateKeyPassword = expect(keystorePrivateKeyPassword, "Keystore private key password").not().toBeBlank().check();

        this.successLoginDefaultUrl = expect(successLoginDefaultUrl, "Success login URL").not().toBeBlank().check();
        this.successLogoutUrl = expect(successLogoutUrl, "Success logout URL").not().toBeBlank().check();

        this.failedLoginDefaultUrl = Optional.fromNullable(failedLoginDefaultUrl).or("");

        this.samlUserDetailsService = samlUserDetailsService;

        this.authnContexts = Optional.fromNullable(authnContexts).or(ImmutableSet.of(AuthnContext.PASSWORD_AUTHN_CTX));
        //@formatter:on
    }

    public String getIdpServerName() {
        return idpServerName;
    }

    public String getSpServerName() {
        return spServerName;
    }

    public Integer getSpHttpsPort() {
        return spHttpsPort;
    }

    public String getSpContextPath() {
        return spContextPath;
    }

    public Resource getKeystoreResource() {
        return keystoreResource;
    }

    public String getKeystoreAlias() {
        return keystoreAlias;
    }

    public String getKeystorePassword() {
        return keystorePassword;
    }

    public String getKeystorePrivateKeyPassword() {
        return keystorePrivateKeyPassword;
    }

    public String getSuccessLoginDefaultUrl() {
        return successLoginDefaultUrl;
    }

    public String getSuccessLogoutUrl() {
        return successLogoutUrl;
    }

    public String getFailedLoginDefaultUrl() {
        return failedLoginDefaultUrl;
    }

    public SAMLUserDetailsService getSamlUserDetailsService() {
        return samlUserDetailsService;
    }

    public Set getAuthnContexts() {
        return authnContexts;
    }
}