JetBrains CodeCanvas 2024.1 Help

SSL Keystores

CodeCanvas supports uploading SSL keystores. An SSL client key contained in a keystore is used to identify CodeCanvas as a client when connecting to an external server, for example, a third-party authentication provider.

Generally, such configuration consists of the following steps:

  1. Generating a public certificate .crt file and a PKCS12 keystore .p12 file.

  2. Uploading the .crt file to the third-party authentication provider.

  3. Uploading the keystore to CodeCanvas.

Generate a keystore File

There are several tools that let you create SSL keys and certificates in PKCS12 format. Here is how to create an SSL key with the OpenSSL toolkit:

  1. Generate a new 2048-bit RSA key with password protection:

    openssl genrsa -des3 -out CodeCanvas.key 2048
  2. Generate a certificate request for the generated key:

    openssl req -new -key CodeCanvas.key -out CodeCanvas.csr
  3. Generate a certificate:

    openssl x509 -req -days 365 -in CodeCanvas.csr -signkey CodeCanvas.key -out CodeCanvas.crt

    CodeCanvas.crt is a self-signed public certificate that you should upload to a party that needs to establish a secure connection with CodeCanvas (for example, a third-party authentication provider).

  4. Package the key and the certificate in a PKCS12 file:

    openssl pkcs12 -export -out CodeCanvas.p12 -inkey CodeCanvas.key -in CodeCanvas.crt -certfile CodeCanvas.crt

    You now have a PKCS12 keystore (CodeCanvas.p12 in the example) that you should upload to CodeCanvas.

Upload an SSL keystore

  1. On the sidebar, choose Administration, then SSL keystores.

  2. Click Add keystore.

  3. Enter a name for the new keystore.

  4. Select a file that contains the keystore. Browse for the file or drag-and-drop it into the field.

    • The keystore must be in PKCS12 (.p12) format.

    • The keystore must be password protected.

    • The keystore must contain a single entry.

  5. Click Add to upload the selected file to CodeCanvas.

Added keystores are enabled by default.

Disable and enable keystores

  1. On the sidebar, choose Administration, then SSL keystores.

  2. Locate the keystore in the list and click a corresponding button: Active or Inactive.

Delete a keystore

  1. On the sidebar, choose Administration, then SSL keystores.

  2. Locate the keystore in the list and click delete-icon next to it.

Last modified: 17 May 2024