org.wso2.ciphertool.utils

Class Utils

java.lang.Object

org.wso2.ciphertool.utils.Utils

public class Utils
extends Object

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static String	doEncryption(Cipher cipher, String plainTextPwd) encrypt the plain text password
static String	getConfigFilePath(String fileName) returns the configuration file
static Path	getDefaultJSONFilePath() Get default.json file path.
static String	getDeploymentFilePath() Get deployment toml file path
static Map<String,Object>	getJSONConfiguration(Path jsonFilePath) Read from default.json file and return a map of data.
static Map<String,String>	getKeystoreFromConfiguration(String configFilePath, String keystoreName) Read toml file and return a map of keystore data.
static Map<String,String>	getSecreteFromConfiguration(String configFilePath) Read toml file and return list of secrets
static DocumentBuilder	getSecuredDocumentBuilder(boolean setIgnoreComments) This method provides a secured document builder which will secure XXE attacks.
static String	getUnEncryptedValue(String value) Read unencrypted value from [secrets] section in deployment toml file
static String	getValueFromConfigs(String config, String key, Map<String,Object> defaultMap, Element element, String xPath) Retrieve the value for the given configuration from the following order of files.
static String	getValueFromConsole(String msg, boolean isPassword) Retrieve value from command-line
static String	getValueFromXPath(Element element, String xPath) retrieve the value for the given xpath from the file
static boolean	isPrimaryKeyStore() Returns whether it's a primary or an internal keystore
static Properties	loadProperties(String filePath) read values from property file
static String	resolveKeyStorePath(String keyStorePath, String homeFolder, Map<String,Object> defaultMap) Resolve path of the keystore.
static void	setSystemProperties() Set the system properties
static void	writeToPropertyFile(Properties properties, String filePath) writees the properties into a file
static void	writeToSecureConfPropertyFile() Write to the Secret-conf.properties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Utils

public Utils()

Method Detail

getValueFromConsole

public static String getValueFromConsole(String msg,
                                         boolean isPassword)

Retrieve value from command-line

loadProperties

public static Properties loadProperties(String filePath)

read values from property file

Parameters:

filePath - file path

Returns:

Properties properties

getConfigFilePath

public static String getConfigFilePath(String fileName)

returns the configuration file

Parameters:

fileName - file name

Returns:

File file

writeToPropertyFile

public static void writeToPropertyFile(Properties properties,
                                       String filePath)

writees the properties into a file

Parameters:

properties - properties

filePath - filepath

getValueFromConfigs

public static String getValueFromConfigs(String config,
                                         String key,
                                         Map<String,Object> defaultMap,
                                         Element element,
                                         String xPath)

Retrieve the value for the given configuration from the following order of files. 1. deployment.toml 2. default.json 3. carbon.xml

Parameters:

config - Configuration value.

key - Key of the configuration value in default.json.

defaultMap - Map that contains values from default.json.

element - Element.

xPath - Xpath.

Returns:

Configuration value.

getValueFromXPath

public static String getValueFromXPath(Element element,
                                       String xPath)

retrieve the value for the given xpath from the file

Parameters:

element - element

xPath - xpath

Returns:

value from xpath

writeToSecureConfPropertyFile

public static void writeToSecureConfPropertyFile()

Write to the Secret-conf.properties

setSystemProperties

public static void setSystemProperties()

Set the system properties

isPrimaryKeyStore

public static boolean isPrimaryKeyStore()

Returns whether it's a primary or an internal keystore

resolveKeyStorePath

public static String resolveKeyStorePath(String keyStorePath,
                                         String homeFolder,
                                         Map<String,Object> defaultMap)

Resolve path of the keystore.

Parameters:

keyStorePath - path of the keystore

homeFolder - path of the IS_HOME

defaultMap - map that contains values from default.json

Returns:

resolved path of the keystore

getDeploymentFilePath

public static String getDeploymentFilePath()

Get deployment toml file path

Returns:

deployment file path

getDefaultJSONFilePath

public static Path getDefaultJSONFilePath()

Get default.json file path.

Returns:

Default JSON file path.

doEncryption

public static String doEncryption(Cipher cipher,
                                  String plainTextPwd)

encrypt the plain text password

Parameters:

cipher - init cipher

plainTextPwd - plain text password

Returns:

encrypted password

getSecreteFromConfiguration

public static Map<String,String> getSecreteFromConfiguration(String configFilePath)

Read toml file and return list of secrets

Parameters:

configFilePath - file path to deployment toml

Returns:

Map of secrets

getKeystoreFromConfiguration

public static Map<String,String> getKeystoreFromConfiguration(String configFilePath,
                                                              String keystoreName)

Read toml file and return a map of keystore data.

Parameters:

configFilePath - File path to deployment toml.

keystoreName - Name of the keystore.

Returns:

Map of keystore data.

getJSONConfiguration

public static Map<String,Object> getJSONConfiguration(Path jsonFilePath)

Read from default.json file and return a map of data.

Returns:

Map of data.

getUnEncryptedValue

public static String getUnEncryptedValue(String value)

Read unencrypted value from [secrets] section in deployment toml file

Parameters:

value - key to read

Returns:

unencrypted value

getSecuredDocumentBuilder

public static DocumentBuilder getSecuredDocumentBuilder(boolean setIgnoreComments)
                                                 throws ParserConfigurationException

This method provides a secured document builder which will secure XXE attacks.

Parameters:

setIgnoreComments - whether to set setIgnoringComments in DocumentBuilderFactory.

Returns:

DocumentBuilder

Throws:

ParserConfigurationException