This documentation is for WSO2 Carbon 4.2.0. View documentation for the latest release.
Page Comparison - Configuring Keystores in WSO2 Products (v.48 vs v.69) - Carbon 4.2.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Keystores allow you to manage the keys that are stored in a database. A keystore must contain a key pair with a certificate signed by a trusted Certification Authority (CA). A CA is an entity trusted by all parties participating in a secure communication. This entity will certify the trusted party's public keys by signing them. Since the certificate authority is trusted, it will accept the public key certificates signed by that particular CA as trusted. WSO2 Carbon uses several keystores to power the HTTPS transport and to encrypt other confidential information such as administrator passwords.

The keystores used to encrypt administrator passwords and other confidential information in Carbon is configured in the <PRODUCTAfter you have created a new keystore and updated the client-truststore.jks file, you must update a few configuration files in order to make the keystore work. Note that keystores are used for multiple functions in WSO2 products, which includes securing the servlet transport, encrypting confidential information in configuration files, etc. Therefore, you must update the specific configuration files with the relevant keystore information. For example, you may have separate keystores for the purpose of encrypting passwords in configuration files, and for securing the servlet transport.

The  wso2carbon.jks  keystore file, which is shipped with all WSO2 products, is used as the default keystore for all functions. However, in a production environment, it is recommended to create new keystores with keys and certificates.

Tip

If you want an easy way to locate all the configuration files that have references to keystores, you can use the grep command as follows:

  1. Open a command prompt and navigate to the <PRODUCT_HOME>/repository/conf/

...

Info

The default keystore named wso2carbon.jks can be found in the <PRODUCT_HOME>/repository/resources/security directory of your product pack. Other required keystores can be created using the management console of each carbon product.

Note

Note that when keystones are configured, two keystore passwords are specified in the relevant .xml file:

  • The <Password> element indicates the password of the keystore file.
  • The <KeyPassword> element points to the password required to access the private key.

Table of Contents
maxLevel3
minLevel3

Primary Keystore

...

  1. directory where your product stores all configuration files.
  2. Execute the following command: grep -nr ".jks" .

The configuration files and the keystore files referred to in each file are listed out. See an example of this below.

Code Block
./axis2/axis2.xml:260:                <Location>repository/resources/security/wso2carbon.jks</Location>
./axis2/axis2.xml:431:                <Location>repository/resources/security/wso2carbon.jks</Location>
./carbon.xml:316:            <Location>${carbon.home}/repository/resources/security/wso2carbon.jks</Location>
./carbon.xml:332:            <Location>${carbon.home}/repository/resources/security/wso2carbon.jks</Location>
./identity.xml:180:				<Location>${carbon.home}/repository/resources/security/wso2carbon.jks</Location>
./security/secret-conf.properties:21:#keystore.identity.location=repository/resources/security/wso2carbon.jks

Configuring the primary keystore

The primary keystore mainly stores the keys certifying SSL connections to Carbon servers , and the keys for encrypting administrator passwords as well as other confidential information. The keystore configuration in the   The Keystore element in the carbon.xml file is as given below. Note that in this example, we are using the default key store in the product pack (wso2carbon.jks)., stored in the < PRODUCT_HOME>/repository/conf/ directory must be updated with details of the primary keystore. The default configuration is shown below. 

Code Block
<KeyStore>
	<Location>${carbon.home}/resources/security/wso2carbon.jks</Location>
	<Type>JKS</Type>
	<Password>wso2carbon</Password>
	<KeyAlias>wso2carbon</KeyAlias>
	<KeyPassword>wso2carbon</KeyPassword>
</KeyStore>

Registry Keystore

RegistryKeyStore is a separate keystore element configurable in the carbon.xml file. This configuration applies for the keystore which stores the keys that certify encrypting/decrypting meta data to the registry. Therefore, using this RegistryKeystore element in addition to the Keystore element in the carbon.xml file allows you to maintain a separate keystore for the purpose of encrypting/decrypting meta data to the registry. The registry keystore configuration in the carbon.xml file is as given below. Note that in this example, we are referring to the default keystore in the product pack (wso2carbon.jks) as the registry keystore.

Code Block
<RegistryKeyStore>
            <!-- Keystore file location-->
            
 
<TrustStore>
	<!-- trust-store file location -->
	<Location>${carbon.home}/repository/resources/security/client-truststore.jks</Location>
	<!-- trust-store type (JKS/PKCS12 etc.) -->
	<Type>JKS</Type> 
	<!-- trust-store password -->
	<Password>wso2carbon</Password>
</TrustStore>

You need to add in the following information:

  • <jks store password>
  • <jks alias>
  • <jks store password(same as the key password)>

Configuring a keystore for Java permissions

The sec.policy file stored in the <PRODUCT_HOME>/repository/conf/ directory should be updated with details of the keystore used for enabling Java permissions for your server. The default configuration is shown below.

Code Block
keystore "file:${user.dir}/repository/resources/security/wso2carbon.jks", "JKS";
Excerpt
hiddentrue

NOTE to WRITERS: The following section can be used to list down product specific configuration files that use keystores. For example in BAM:

  Product-specific configurations

  • Make the following changes in the <PRODUCT_HOME>/repository/conf/identity.xml file.

    Code Block
    languagexml
    <Security>
    	<UserTrustedRPStore>
    			<!-- Keystore password -->
    			<Password>wso2carbon</Password>
    			<!-- Private Key password -->
    			<KeyPassword>wso2carbon</KeyPassword>
    	</UserTrustedRPStore>
    </Security>
    <EntitlementSettings>
    ...
    	<ThirftBasedEntitlementConfig>
    ...
    		<KeyStore>
    			<Location>${carbon.home}/repository/resources/security/
wso2carbon
  • <jks name>.jks</Location>
    			<Password><jks store password></Password>
    		</KeyStore>
    	</ThirftBasedEntitlementConfig>
    </EntitlementSettings>
  • If you want to use NIO sender, change the  <transportSender> section in the <PRODUCT_HOME>/repository/conf/axis2/axis2.xml file accordingly as shown below.

    Code Block
    languagexml
    <transportSender name="https" class="org.apache.synapse.transport.nhttp.HttpCoreNIOSSLSender">
        
<!--
  •  
Keystore
  •  
type
  •  
(JKS/PKCS12 etc.)-->
  •  <parameter name="non-blocking" locked="false">true</parameter>
            <parameter name="keystore" 
<Type>JKS</Type>
  • locked="false">
                <KeyStore>
    
<!--
  •  
Keystore
  •  
password-->
  •              
<Password>wso2carbon</Password>
  •  <Location>repository/resources/security/wso2carbon.jks</Location>
                
<!--
  •  
Private
  •  
Key
  •  
alias-->
  •  <Type>JKS</Type>
               
<KeyAlias>wso2carbon</KeyAlias>
  •      <Password>wso2carbon</Password>
                
<!--
  •  
Private
  •  
Key
  •  
password-->
  •  <KeyPassword>wso2carbon</KeyPassword>
               
<KeyPassword>wso2carbon</KeyPassword>
  •  </
RegistryKeyStore>

Keystore of the HTTPS transport

The keystore of the HTTPS transport is configured in the axis2.xml file under the HTTPS transport receiver and HTTPS transport sender configurations. 

Code Block
<parameter name="keystore" locked="false"> <KeyStore> <Location>resources/security/wso2carbon.jks</Location> <Type>JKS</Type> <Password>wso2carbon</Password> <KeyPassword>wso2carbon</KeyPassword> </KeyStore>
  • KeyStore>
            </parameter>
            <parameter name="truststore" locked="false">
    
<TrustStore> <Location>resources/
  •             <TrustStore>
                    <Location>repository/resources/security/client-truststore.jks</Location>
    
  •                 <Type>JKS</Type>
    
  •                 <Password>wso2carbon</Password>
    
  •             </TrustStore>
            </parameter>
    

...

  • <

...

  • /transportSender>