Page History

...

1. In any WSO2 product based on Carbon 4.4.0, you can install the Cipher Tool feature from the WSO2 feature repository. See the related topics for instructions on installing features.
2. Open the cipher-text.properties file and the cipher-tool.properties file from the <PRODUCT_HOME>/repository/conf/security folder. 

3. By default, these two files are already configured with the most common passwords that should be encrypted for your product. If required, you can edit the information that you want to encrypt.

   Expand
   title Default cipher-tool.properties
   Code Block # Important: This cipher-tool.properties file should be sync with carbon/core/distribution/carbon-home/repository/conf/cipher-tool.properties. This is added here as it goes with wso2 cipher tool. # This properties file contains all the aliases to be used in carbon components. If any property need to be secured, you need to add alias name, file name and the value. This value is described xpath as follows:. # The value goes as, the <file_name>//<xpath>,<true/false> # where <file_name> - is the file (along with the file name// path) to be secured, # <xpath> - is the xpath to the property value to be secured,true if xml elements start with capital letter. Please check existing property values below. # <true / false> - This is true if the last parameter in the xpath is parameter (starts with [ and ends with ]) and you want its value to be replaced with "password" Carbon.Security.KeyStore.Password=repository/conf/carbon.xml//Server/Security/KeyStore/Password,truefalse Carbon.Security.KeyStore.KeyPassword=repository/conf/carbon.xml//Server/Security/KeyStore/KeyPassword,truefalse Carbon.Security.TrustStore.Password=repository/conf/carbon.xml//Server/Security/TrustStore/Password,truefalse UserManager.AdminUser.Password=repository/conf/user-mgt.xml//UserManager/Realm/Configuration/AdminUser/Password,truefalse Datasources.WSO2_CARBON_DB.Configuration.Password=repository/conf/datasources/master-datasources.xml//datasources-configuration/datasources/datasource[name='WSO2_CARBON_DB']/definition[@type='RDBMS']/configuration/password,false #ServerServer.Service.Connector.keystorePass=repository/conf/tomcat/catalina-server.xml//Server/Service/Connector[@keystorePass],false #Datasource.WSO2AM_DB.configuration.password=master-datasources.xml//datasources-configuration/datasources/datasource[name='WSO2AM_DB']/definition[@type='RDBMS']/configuration/password,false #Datasource.WSO2AM_STATS_DB.configuration.password=master-datasources.xml//datasources-configuration/datasources/datasource[name='WSO2AM_STATS_DB']/definition[@type='RDBMS']/configuration/password,false #UserStoreManager.Property.ConnectionPassword=user-mgt.xml//UserManager/Realm/UserStoreManager/Property[@name='ConnectionPassword'],true #UserStoreManager.Property.password=user-mgt.xml//UserManager/Realm/UserStoreManager/Property[@name='password'],true #AuthManager.Password=api-manager.xml//APIManager/AuthManager/Password,true #APIGateway.Password=api-manager.xml//APIManager/APIGateway/Environments/Environment/Password,true #APIUsageTracking.BAMPassword=api-manager.xml//APIManager/APIUsageTracking/BAMPassword,true #APIUsageTracking.JDBCPassword=api-manager.xml//APIManager/APIUsageTracking/JDBCPassword,true #APIKeyManager.Password=api-manager.xml//APIManager/APIKeyManager/Password,true #Database.Password=api-manager.xml//APIManager/Database/Password,true #Security.UserTrustedRPStore.Password=identity.xml//Server/Security/UserTrustedRPStore/Password #Security.UserTrustedRPStore.KeyPassword=identity.xml//Server/Security/UserTrustedRPStore/KeyPassword #Identity.System.StorePass=identity.xml//Server/Identity/System/StorePass #MultifactorAuthentication.XMPPSettings.XMPPConfig.XMPPPassword=identity.xml//MultifactorAuthentication/XMPPSettings/XMPPConfig/XMPPPassword #BPELEPR.Password=securedinvoke.epr//EndpointReference/Metadata/transport/authorization-password,false #Axis2.Https.Listener.TrustStore.Password=axis2.xml//axisconfig/transportReceiver[@name='https']/parameter[@name='truststore']/TrustStore/Password,false #Axis2.Https.Listener.KeyStore.Password=axis2.xml//axisconfig/transportReceiver[@name='https']/parameter[@name='keystore']/KeyStore/Password,false #Axis2.Https.Listener.KeyStore.KeyPassword=axis2.xml//axisconfig/transportReceiver[@name='https']/parameter[@name='keystore']/KeyStore/KeyPassword,false #Axis2.Https.Sender.TrustStore.Password=axis2.xml//axisconfig/transportSender[@name='https']/parameter[@name='truststore']/TrustStore/Password,false #Axis2.Https.Sender.KeyStore.Password=axis2.xml//axisconfig/transportSender[@name='https']/parameter[@name='keystore']/KeyStore/Password,false #Axis2.Https.Sender.KeyStore.KeyPassword=axis2.xml//axisconfig/transportSender[@name='https']/parameter[@name='keystore']/KeyStore/KeyPassword,false #Axis2.Mailto.Parameter.Password=axis2.xml//axisconfig/transportSender[@name='mailto']/parameter[@name='mail.smtp.password'],false #eventBrokerConfig.eventBroker.deliveryManager.remoteMessageBroker.password=event-broker.xml//eventBrokerConfig/eventBroker/deliveryManager/remoteMessageBroker/password,false #Service.LoggingConfig.ArchivedPassword=logging-config.xml//loggingConfig/archivedPassword,false #Service.LoggingConfig.Password=logging-config.xml//loggingConfig/password,false #Summarizer.LoggingConfig.Password=summarizer-config.xml//loggingConfig/password,false #Summarizer.LoggingConfig.BamPassword=summarizer-config.xml//loggingConfig/bamPassword,false #Summarizer.LoggingConfig.PublisherPassword=summarizer-config.xml//loggingConfig/publisherPassword,false

   Expand
   title Default cipher-text.properties
   Code Block # This is the default file based secret repository, used by Secret Manager of synapse secure vault # By default, This file contains the secret alias names Vsand the plain text passwords enclosed with '[]' brackets # In Production environments, It is recommend to replace thosethese plain text password by the encrypted values. CipherTool can be used for it. Carbon.Security.KeyStore.Password=[wso2carbon] Carbon.Security.KeyStore.KeyPassword=[wso2carbon] Carbon.Security.TrustStore.Password=[wso2carbon] UserManager.AdminUser.Password=[admin] Datasources.WSO2_CARBON_DB.Configuration.Password=[wso2carbon] #ServerServer.Service.Connector.keystorePass=[wso2carbon] #datasource.WSO2AM_DB.configuration.password=[wso2carbon] #UserStoreManager.Property.ConnectionPassword=[admin] #UserStoreManager.Property.password=[admin] #AuthManager.Password=[admin] #APIGateway.Password=[admin] #APIUsageTracking.BAMPassword=[admin] #APIUsageTracking.JDBCPassword=[wso2carbon] #APIKeyManager.Password=[admin] #Database.Password=[wso2carbon] #Security.UserTrustedRPStore.Password=[wso2carbon] #Security.UserTrustedRPStore.KeyPassword=[wso2carbon] #Identity.System.StorePass=[wso2carbon] #MultifactorAuthentication.XMPPSettings.XMPPConfig.XMPPPassword=[wso2carbon] #BPELEPR.Password=[admin] #Axis2.Https.Listener.TrustStore.Password=[wso2carbon] #Axis2.Https.Listener.KeyStore.Password=[wso2carbon] #Axis2.Https.Listener.KeyStore.KeyPassword=[wso2carbon] #Axis2.Https.Sender.TrustStore.Password=[wso2carbon] #Axis2.Https.Sender.KeyStore.Password=[wso2carbon] #Axis2.Https.Sender.KeyStore.KeyPassword=[wso2carbon] #Axis2.Mailto.Parameter.Password=[wso2carbon] #eventBrokerConfig.eventBroker.deliveryManager.remoteMessageBroker.password=[admin] #Log4j.Appender.LOGEVENT.Password=[admin] #Service.LoggingConfig.ArchivedPassword=[admin] #Service.LoggingConfig.Password=[admin] #Summarizer.LoggingConfig.Password=[admin] #Summarizer.LoggingConfig.BamPassword=[admin] #Summarizer.LoggingConfig.PublisherPassword=[admin]

   If there are other passwords from configuration files that you want to encrypt, you can add the details to these files. For example, in WSO2 Storage Server, you will want to configure the "root" password in the rss-config.xml file. 

   • Add the following to the cipher-tool.properties file:

     Code Block
     #rss-config.xml passwords #RSSConfiguration.DEFAULT.WSO2RSS1.Password=rss-config.xml//RSSConfiguration/Environments/Environment[Name='DEFAULT']/RSSInstances/RSSInstance[Name='WSO2RSS1']/DataSourceConfiguration/Definition/Password,true

   • Add the following to the cipher-text.properties file:

     Code Block
     #rss-config.xml passwords #RSSConfiguration.DEFAULT.WSO2RSS1.Password=[root]

...