| Table of Contents |
|---|
Creating a Java KeyStore and SSL certificate
MettleCI Workbench can be configured to expose ports over HTTP, HTTPS, or both simultaneously at separate ports. Before configuring Workbench to use HTTPS, a Java KeyStore containing the HTTPS certificate must be created first. Java KeyStores can be created and managed using the keytool command included with all installations of Java.
First ensure that you use the keytool command shipped with the Java v1.8 package you downloaded to support MettleCI. You can check which version of keytool is your command line’s line's default keytool by using the operating system-specific commands where keytool
| Status | ||||
|---|---|---|---|---|
|
which keytool | Status | ||||
|---|---|---|---|---|
|
Next, you’ll use a the keytool command with the following template (with a format like that show below) to create a keystore containing a basic KeyStore that contains a single, basic, self-signed certificate:
| Code Block | ||
|---|---|---|
| ||
keytool -genkey -keyalg RSA -alias workbench -keystore <path-to-keystore>
-storepass <store-password> -storetype PKCS12 -keysize 2048
-sigalg SHA256withRSA -dname "CN=<host url>"
-ext san=dns:<host url>
-validity <days-valid> |
Please Use the following table to replace the <placeholder-values> in this command based on the following descriptions:example command with values that are specific to your environment and policies.
Placeholder | Description | Example Value |
|---|---|---|
path-to-keystore | Full qualified path of the key store to be created |
|
store-password | Password required when reading or writing to the newly created key store | Choose a random password string. Note that the key stores supplied with Java have a default password of |
host-url | The domain name of the URL that will be used to access Workbench in your browser. This does not include the protocol or port numbers. For example, |
(no port number) |
days-valid | The number of days for which the key should remain valid | Note that the key stores supplied with Java have a default validity of 180 days. |
...
Note that with the exception of keytool -list the keytool command will not normally return a value to the console .to indicate it has executed successfully
Regenerating keys
If you want to regenerate your keystore certificate for any reason (i.e. it has expired) you can use the following command:
| Code Block |
|---|
# Delete it $> keytool -delete -noprompt -alias workbench -keystore workbench.p12 -storepass changeit # Verify it has been deleted $> keytool -list -v -keystore /opt/dm/mci/workbench.p12 -storetype PKCS12 -storepass changeit Keystore type: PKCS12 Keystore provider: SunJSSE Your keystore contains 0 entries $> |
...
Enabling HTTPS support in the MettleCI Workbench config.yml
Once a keystore containing the Workbench HTTPS certificate has been created, update your MettleCI config.yml file to add the following section:
...
Verify Workbench is up and running under HTTP and/or HTTPS by navigating to https://<host url>:8443 and/or http://<host url>:8080 (as appropriate) in your browser.
Trusting your certificate
You will need your local browser to trust the certificate on your DataStage engine tier. There will be slightly different processes for this depending upon your chosen browser and whether or not you have self-signed the certificate or used a CA.
Inspecting your certificate
Typically, when you first connect to Workbench using HTTPS you will see a certificate error in your browser. This may look like this…
...
Once you’re happy that the thumbprint matches you can proceed to installing your certificate.
Installing your certificate
If Install Certificate is enabled then click it to install the certificate into the Trust Root Certification Authorities store
...
If Install Certificate is not enabled then select the Details tab in the Certificate dialog then click Copy to File.
...
Start the Certificate Export Wizard by clicking Next, accept the default settings, enter a meaningful certificate name to export it to your local system, and click Finish. Now the certificate has been successfully exported to a file.
In the Certificate Export Wizard success message, click Finish.
In the Certificate dialog, click OK.
You can now follow your operating system’s process for importing the certificate file into the Trust Root Certification Authorities store.
...