com.verisec.frejaeid.client.beans.general.SslSettings Maven / Gradle / Ivy

Go to download
package com.verisec.frejaeid.client.beans.general;

import com.verisec.frejaeid.client.exceptions.FrejaEidClientInternalException;

import javax.net.ssl.SSLContext;

import org.apache.commons.lang3.StringUtils;

/**
 * There are two ways of establishing the SSL connection with the server and
 * passing the client key pair and the server certificate to the library.
 */
public class SslSettings {

    private String keystorePath;
    private String keystorePass;
    private String serverCertificatePath;
    private SSLContext sslContext;

    /**
     * Returns instance of {@link SslSettings} which will create SSL context
     * with given keyStore (supported types are
     * JKS,
     * JCEKS, PKCS12), password and trusted server certificate.
     * 
     * In order to establish SSL with server, client should provide path of
     * keyStore and password and path of trusted server certificate.
     *
     * @param keystorePath          absolute path of keyStore file where key pair with
     *                              appropriate SSL certificate is stored.
     * @param keystorePass          password of client keyStore.
     * @param serverCertificatePath absolute path of server certificate.
     * @return sslSettings
     * @throws FrejaEidClientInternalException if any parameter is {@code null}
     *                                         or empty.
     */
    public static SslSettings create(String keystorePath, String keystorePass, String serverCertificatePath)
            throws FrejaEidClientInternalException {
        if (StringUtils.isAnyBlank(keystorePath, keystorePass, serverCertificatePath)) {
            throw new FrejaEidClientInternalException(
                    "KeyStore Path, keyStore password or server certificate path cannot be null or empty.");
        }
        return new SslSettings(keystorePath, keystorePass, serverCertificatePath);
    }

    /**
     * Returns instance of {@link SslSettings} which will create SSL context
     * with given keyStore (supported types are
     * JKS,
     * JCEKS, PKCS12), password.
     *
     * Use this creator if you have added server certificate to keyStore.
     * 
     * In order to establish SSL with server, client should provide path of
     * keyStore and password.
     *
     * @param keystorePath absolute path of keyStore file where key pair with
     *                     appropriate SSL certificate and server certificate are stored.
     * @param keystorePass password of client keyStore.
     * @return sslSettings
     * @throws FrejaEidClientInternalException if any parameter is {@code null}
     *                                         or empty.
     */
    public static SslSettings create(String keystorePath, String keystorePass) throws FrejaEidClientInternalException {
        if (StringUtils.isAnyBlank(keystorePath, keystorePass)) {
            throw new FrejaEidClientInternalException("KeyStore Path or keyStore password cannot be null or empty.");
        }
        return new SslSettings(keystorePath, keystorePass, null);
    }

    /**
     * Returns instance of {@link SslSettings} created with given SslContext. In
     * order to establish SSL with server, client should provide SSLContext
     * object from javax.net.ssl package.
     *
     * @param sslContext created using keyStore file where key pair with
     *                   appropriate SSL certificate is stored.
     * @return sslSettings
     */
    public static SslSettings create(SSLContext sslContext) {
        return new SslSettings(sslContext);
    }

    private SslSettings(String keystorePath, String keystorePass, String serverCertificatePath) {
        this.keystorePath = keystorePath;
        this.keystorePass = keystorePass;
        this.serverCertificatePath = serverCertificatePath;
    }

    private SslSettings(SSLContext sslContext) {
        this.sslContext = sslContext;
    }

    public String getKeystorePath() {
        return keystorePath;
    }

    public String getKeystorePass() {
        return keystorePass;
    }

    public SSLContext getSslContext() {
        return sslContext;
    }

    public String getServerCertificatePath() {
        return serverCertificatePath;
    }

}