

Change the hostname¶

This section guides you through changing the hostname of WSO2 Identity Server.

Change the hostname - Server hostname for internal API calls is by default configured as localhost. This configuration is utilized to build the internal absolute URL of a service endpoint that will be consumed whenever internal API calls are generated. To configure the hostname, follow one of the two options given below according to your requirement.

Option 1

Configure the hostname as follows in <IS_HOME>/repository/conf/deployment.toml.
```
[server]
hostname = "is.dev.wso2.com"
```
Add localhost as SAN for the certificate (-ext SAN=dns:localhost) as the internal hostname is by default localhost. For that, navigate to the <IS_HOME>/repository/resources/security directory on the command prompt and use the following command to create a new keystore with CN=is.dev.wso2.com and localhost as SAN.

Format
```
keytool -genkey -alias <alias_name> -keyalg RSA -keysize 2048 -keystore <keystore_name>.jks -dname "CN=<hostname>, OU=<organizational_unit>,O=<organization>,L=<Locality>,S=<State/province>,C=<country_code>" -storepass <keystore_password> -keypass <confirm_keystore_password> -ext SAN=dns:localhost
```
Replace the values enclosed within <> in the command given above with a value you prefer. Following is a sample command.

Sample keytool command
```
keytool -genkey -alias newcert -keyalg RSA -keysize 2048 -keystore newkeystore.jks -dname "CN=is.dev.wso2.com, OU=Is,O=Wso2,L=SL,S=WS,C=LK" -storepass mypassword -keypass mypassword -ext SAN=dns:localhost
```
Option 2

Instead of adding SAN, you can configure the same name for the hostname, and the internal_hostname in <IS_HOME>/repository/conf/deployment.toml as follows.
```
[server]
hostname = "is.dev.wso2.com"
internal_hostname = "is.dev.wso2.com"
```
Navigate to the <IS_HOME>/repository/resources/security directory on the command prompt and use the following command to create a new keystore with CN=is.dev.wso2.com.

Format
```
keytool -genkey -alias <alias_name> -keyalg RSA -keysize 2048 -keystore <keystore_name>.jks -dname "CN=<hostname>, OU=<organizational_unit>,O=<organization>,L=<Locality>,S=<State/province>,C=<country_code>" -storepass <keystore_password> -keypass <confirm_keystore_password>
```
Replace the values enclosed within <> in the command given above with a value you prefer. Following is a sample command.

Sample keytool command
```
keytool -genkey -alias newcert -keyalg RSA -keysize 2048 -keystore newkeystore.jks -dname "CN=is.dev.wso2.com, OU=Is,O=Wso2,L=SL,S=WS,C=LK" -storepass mypassword -keypass mypassword
```
If the keystore name and password is changed, all the references to it within the WSO2 Identity Server must be updated as well. Add the following configuration to the deployment.toml file in the <IS_HOME>/repository/conf/ folder.
```
[keystore.primary]
file_name = "new-keystore.jks"
password = "new-keystore-password"
alias = "new-private-key-alias"
key_password = "new-private-key-password"
```
Export the public key from your keystore .jks file using the following command.

Format
```
keytool -export -alias <alias_name> -keystore <keystore_name>.jks -file <public_key_name>.pem
```
Replace the values enclosed within <> in the command given above with a value you prefer as shown in the sample command below.

Sample keytool command
```
keytool -export -alias newcert -keystore newkeystore.jks -file pkn.pem
```
Import the public key you extracted in the previous step to the client-truststore.jks file using the following command.

Format
```
keytool -import -alias <alias_name> -file <public_key_name>.pem -keystore client-truststore.jks -storepass <keystore_password>
```
Replace the values enclosed within <> in the command given above with a value you prefer. Following is a sample command.

Sample keytool command
```
keytool -import -alias newcert -file pkn.pem -keystore client-truststore.jks -storepass wso2carbon
```
Note

If you create a new client truststore, in-place of the default client-truststore.jks, place the new truststore in the <IS_HOME>/repository/resources/security/ folder and add the following configuration to the deployment.toml file in the <IS_HOME>/repository/conf/ folder.
```
[truststore]
file_name = "custome-trustore-name.jks" 
password = "password" 
```
Verfiy the hostname change by attempting to log in to My Account, getting a token from any grant type, etc.
If you are trying this out on your local machine, open the etc/hosts/ file and add the following entry to map the new hostname. is.dev.wso2.com is used as an example in the sample entry shown below.
```
127.0.0.1       is.dev.wso2.com
```

When you recreate the keystore in full, a new key-pair value is created. This means that any existing encrypted data (for example users created before recreating the keystore) are still encrypted using the original keystore (wso2carbon.jks). Therefore, older users will not be able to log in to My Account and need to be migrated. You can use one of the following options in this situation.

Option 1

Change the hostname. The hostname is part of the Subject of the Certificate (i.e., it is not part of the original key-pair). Therefore, you can use the same public and private key pair to generate a new CSR with the updated CN (subject). This can be done by adding the -dname option when -certreq is executed. Once the CA certificate is obtained, follow the instructions given in the importing certificates to the keystore topic to import it correctly. By doing that, you do not need to touch the key-pair, and any other operations performed using the same key pair such as encryption, will not get affected.

Option 2

Create a new keystore with the instructions for the new hostname and then use that keystore for SSL/TLS by changing Tomcat connector configuration as described in the Configure Keystores topic. This approach separates the keystores. The secondary keystore with the new hostname will only be used for Tomcat SSL/TLS communication, while the primary one is used for all other operations (encryption, etc.). By doing this, you can make sure that the existing encrypted data is not affected.

Note

If you have chosen Option 2, you need to maintain and secure the two keystores. Hence, Option 1 is recommended, unless you prefer separation of keys used in SSL/TLS communication and internal data encryption, signing, etc.

Once this is done, you need to change all localhost references. The following points would be the main places where the references should be changed.

The configurations in the <IS_HOME/repository/conf/deployment.toml file that references localhost.
The entity ID that is available in the resident identity provider configurations.
The callback URLs of the federated identity providers.
The callback URLs of the default system applications such as My Account and Console.

Note

By default, both the My Account and the Console Applications use the localhost:9443 domain within the callback URL. When you change the hostname, the WSO2 Identity Server will not be running on the localhost:9443 domian and these values will not automatically change. Hence, you should manually change the callback URLs to use the new hostname.

To edit the default system applications such as My Account and Console, the following configuration should be added to the <IS_HOME/repository/conf/deployment.toml file:

[system_applications]
read_only_apps = []

Top