Java tutorial
/** * The MIT License (MIT) * * Copyright (c) 2014 Seamus Minogue * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ package net.theblackchamber.crypto.util; import static net.theblackchamber.crypto.constants.Constants.ENTRY_NAME_PROPERTY_KEY; import static net.theblackchamber.crypto.constants.Constants.KEYSTORE_PASSWORD_PROPERTY_KEY; import static net.theblackchamber.crypto.constants.Constants.KEY_PATH_PROPERTY_KEY; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; import java.security.KeyStoreException; import java.util.Properties; import net.theblackchamber.crypto.implementations.SecureProperties; import org.apache.commons.lang3.StringUtils; /** * Utility class to provide an easy way to take a clear text properties file and * encrypt it. * * @author sminogue * */ public class SecurePropertiesUtils { /** * Utility which will take an existing Properties file on disk and replace * any -unencrypted values with encrypted.<br> * NOTE: The encryption related properties need to be properly set prior to * using this. entry-name, key-path, keystore-password * * @param clearProperties * Un-encrypted properties file to be secured * @return * @throws FileNotFoundException * Properties file not found on disk. * @throws IOException * Error reading/writing From the clear properties or to the * secure properties * @throws KeyStoreException * Error accessing or using the keystore. */ public static SecureProperties encryptPropertiesFile(File clearProperties) throws FileNotFoundException, IOException, KeyStoreException { // Open clear properties file and load it Properties cProperties = new Properties(); FileInputStream fis = new FileInputStream(clearProperties); cProperties.load(fis); fis.close(); return encryptPropertiesFile(clearProperties, cProperties.getProperty(KEY_PATH_PROPERTY_KEY), cProperties.getProperty(KEYSTORE_PASSWORD_PROPERTY_KEY), cProperties.getProperty(ENTRY_NAME_PROPERTY_KEY), true); } /** * Utility which will take an existing Properties file on disk and replace * any -unencrypted values with encrypted.<br> * Note: Encryption fields passed as parameters <b>WILL NOT</b> be placed * into the resulting SecureProperties file. * * @param clearProperties * Un-encrypted properties file to be secured * @param keyPath * Path to the keystore file. * @param keyPass * Password to be used to open and secure the Keystore password. * @param keyEntry * Entry name of the key to use from the keystore. * @return * @throws FileNotFoundException * Properties file not found on disk. * @throws IOException * Error reading/writing From the clear properties or to the * secure properties * @throws KeyStoreException * Error accessing or using the keystore. */ public static SecureProperties encryptPropertiesFile(File clearProperties, String keyPath, String keyPass, String keyEntry) throws FileNotFoundException, IOException, KeyStoreException { return encryptPropertiesFile(clearProperties, keyPath, keyPass, keyEntry, false); } /** * Utility which will take an existing Properties file on disk and replace * any -unencrypted values with encrypted.<br> * * @param clearProperties * Un-encrypted properties file to be secured * @param keyPath * Path to the keystore file. * @param keyPass * Password to be used to open and secure the Keystore password. * @param keyEntry * Entry name of the key to use from the keystore. * @param retainCrytoConfigProperties * Boolean to indicate if the encryption field parameters should * be stored in the resulting SecureProperties file. True they * will be, False they wont. * @return * @throws FileNotFoundException * Properties file not found on disk. * @throws IOException * Error reading/writing From the clear properties or to the * secure properties * @throws KeyStoreException * Error accessing or using the keystore. */ public static SecureProperties encryptPropertiesFile(File clearProperties, String keyPath, String keyPass, String keyEntry, boolean retainCrytoConfigProperties) throws FileNotFoundException, IOException, KeyStoreException { // Save filename/Path String propertiesFilePath = clearProperties.getPath(); // Create new SecureProperties SecureProperties sProperties = new SecureProperties(); // Open clear properties file and load it Properties cProperties = new Properties(); FileInputStream fis = new FileInputStream(clearProperties); cProperties.load(fis); fis.close(); // Ensure the encryption parameters are not empty. if (StringUtils.isEmpty(ENTRY_NAME_PROPERTY_KEY) || StringUtils.isEmpty(KEY_PATH_PROPERTY_KEY) || StringUtils.isEmpty(KEYSTORE_PASSWORD_PROPERTY_KEY)) { throw new KeyStoreException("Unable to configure due to missing configurations"); } // Loop over clear properties and construct new SecureProperties object // First add crypto entries this will initialize the encryption support. sProperties.setProperty(ENTRY_NAME_PROPERTY_KEY, keyEntry); sProperties.setProperty(KEYSTORE_PASSWORD_PROPERTY_KEY, keyPass); sProperties.setProperty(KEY_PATH_PROPERTY_KEY, keyPath); for (Object key : cProperties.keySet()) { String keyStr = (String) key; if (!StringUtils.equals(keyStr, ENTRY_NAME_PROPERTY_KEY) && !StringUtils.equals(keyStr, KEYSTORE_PASSWORD_PROPERTY_KEY) && !StringUtils.equals(keyStr, KEY_PATH_PROPERTY_KEY)) { sProperties.setProperty(keyStr, cProperties.getProperty(keyStr)); } } if (!retainCrytoConfigProperties) { // Remove the crypto entries from the secure file. Since its passed // in... sProperties.remove(ENTRY_NAME_PROPERTY_KEY); sProperties.remove(KEYSTORE_PASSWORD_PROPERTY_KEY); sProperties.remove(KEY_PATH_PROPERTY_KEY); } // Delete original file from disk clearProperties.delete(); // Write SecureProperties out in its place OutputStream fos = new FileOutputStream(new File(propertiesFilePath)); sProperties.store(fos, "File Encrypted by SecurePropertiesUtils"); fos.flush(); fos.close(); // Return completed SecureProperties object return sProperties; } }