Page History
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
|
...
Info |
---|
The default keystore named |
Table of Contents | ||||
---|---|---|---|---|
|
Primary Keystore
...
The configuration files and the keystore files referred to in each file are listed out. See an example of this below.
|
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. Using this RegistryKeystore
element in addition to the Keystore
element in the carbon.xml
file allows you to maintain a separate keystore with a different certification 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 using the default key store in the product pack (wso2carbon.jks).
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 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
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
|
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>
</parameter>
|
...
|
...
Info |
---|
Under the < |
...
|