org.mule.module.ws.security.WSCryptoUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-module-ws Show documentation
Provides components for working with Web Services.
There is a newer version: 3.9.0
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.module.ws.security;

import static org.apache.ws.security.components.crypto.Merlin.KEYSTORE_ALIAS;
import static org.apache.ws.security.components.crypto.Merlin.KEYSTORE_FILE;
import static org.apache.ws.security.components.crypto.Merlin.KEYSTORE_PASSWORD;
import static org.apache.ws.security.components.crypto.Merlin.KEYSTORE_PRIVATE_PASSWORD;
import static org.apache.ws.security.components.crypto.Merlin.KEYSTORE_TYPE;
import static org.apache.ws.security.components.crypto.Merlin.LOAD_CA_CERTS;
import static org.apache.ws.security.components.crypto.Merlin.TRUSTSTORE_FILE;
import static org.apache.ws.security.components.crypto.Merlin.TRUSTSTORE_PASSWORD;
import static org.apache.ws.security.components.crypto.Merlin.TRUSTSTORE_TYPE;
import org.mule.transport.ssl.api.TlsContextKeyStoreConfiguration;
import org.mule.transport.ssl.api.TlsContextTrustStoreConfiguration;

import java.util.Properties;

import org.apache.ws.security.components.crypto.Merlin;

/**
 * Utility class to create objects with the required properties to configure key stores and trust stores for WS-Security.
 */
public class WSCryptoUtils
{

    /**
     * Name of the property where the crypto provider is defined.
     */
    private static final String WS_CRYPTO_PROVIDER_KEY = "org.apache.ws.security.crypto.provider";

    /**
     * Creates a {@link java.util.Properties} object with the attributes of a key store.
     */
    public static Properties createKeyStoreProperties(TlsContextKeyStoreConfiguration keyStoreConfiguration)
    {
        Properties properties = new Properties();
        properties.setProperty(WS_CRYPTO_PROVIDER_KEY, Merlin.class.getCanonicalName());
        properties.setProperty(KEYSTORE_TYPE, keyStoreConfiguration.getType());
        properties.setProperty(KEYSTORE_PASSWORD, keyStoreConfiguration.getPassword());
        properties.setProperty(KEYSTORE_PRIVATE_PASSWORD, keyStoreConfiguration.getKeyPassword());
        properties.setProperty(KEYSTORE_ALIAS, keyStoreConfiguration.getAlias());
        properties.setProperty(KEYSTORE_FILE, keyStoreConfiguration.getPath());
        return properties;
    }

    /**
     * Creates a {@link java.util.Properties} object with the attributes of a trust store.
     */
    public static Properties createTrustStoreProperties(TlsContextTrustStoreConfiguration trustStoreConfiguration)
    {
        Properties properties = new Properties();
        properties.setProperty(WS_CRYPTO_PROVIDER_KEY, Merlin.class.getCanonicalName());
        properties.setProperty(TRUSTSTORE_TYPE, trustStoreConfiguration.getType());
        properties.setProperty(TRUSTSTORE_PASSWORD, trustStoreConfiguration.getPassword());
        properties.setProperty(TRUSTSTORE_FILE, trustStoreConfiguration.getPath());
        return properties;
    }

    /**
     * Creates a {@link java.util.Properties} object configured to use the default trust store.
     */
    public static Properties createDefaultTrustStoreProperties()
    {
        Properties properties = new Properties();
        properties.setProperty(WS_CRYPTO_PROVIDER_KEY, Merlin.class.getCanonicalName());
        properties.setProperty(LOAD_CA_CERTS, String.valueOf(true));
        return properties;
    }

}