Page tree

Versions Compared

Key

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

...

Code Block
openssl genrsa -des3 -out root.key 1024 
openssl rsa -in root.key -out root.key 
openssl req -new -key root.key -days 365 -out root.crt -x509 -subj "/CN=root.yourdomain.com"

...

To force CAST AIP core and related applications/CAST Imaging to connect to CAST Storage Service or PostgreSQL in SSL mode, the following is required:

  • an SSLParameters.ini file needs to be created and then configured on all AIP Core instances (AIP Nodes) / CAST Imaging instances
  • a Windows environment variable (System or User according to your own requirements) needs to be created referencing the .ini file on all AIP Core instances (AIP Nodes) / CAST Imaging instances
  • configure the aip-node-app.properties on all AIP Core instances (AIP Nodes)the AIP Node to use SSL mode

Anchor
ini
ini
Create and configure

...

the .ini file on all AIP Core (AIP Node) instances / CAST Imaging instances

Supported CAST applications are configured to look for a file called SSLParametersan .ini via an environment variable that is defined on the host server. This SSLParameter .ini file allows you to configure SSL mode for multiple CAST Storage Services/PostgreSQL instances and determine where the required client side certificates and keys are located.

You can store the SSLParameters .ini file:

  • on the server's local file system - in this situation, all servers hosting CAST applications that must use SSL mode to connect to a CAST Storage Service/PostgreSQL instance must have a copy of the SSLParameters.ini file, therefore if you need to make an update to the file, you will need to make the update on all servers where the file exists.
  • on a shared network drive (recommended) - in this situation, the SSLParameters .ini file is stored on a shared network drive that is accessible from all servers hosting CAST applications that must use SSL mode to connect to a CAST Storage Service/PostgreSQL instance. The advantage of this is that there is only one copy of the SSLParameters.ini file and the configuration is valid for all servers.

Create the SSLParametersThe .ini file using a text editor and use the following syntax:

...

can use any name (e.g. myfile.ini), however, a feature to enable the encryption of analyzed source code also uses an .ini file in exactly the same way, therefore you may already have an .ini file available if you have enabled this - see Storing analyzed source code in encrypted format. If this is the case, you can re-use this file and you can mix and match configuration from both features in this file.

Create the .ini file using a text editor and use the following syntax:

Code Block
[HOST:PORT,database]
ssl=true
sslmode=require
sslrootcert=root.crt
ssljdbckey=postgresql.pk8
sslkey=postgresql.key
sslcert=postgresql.crt 
sslpfx=postgresql.pfx


[HOST:PORT,database]

Refers to the target CAST Storage Service/PostgreSQL instance. For example:

  • SERVER1:2282,postgres
  • 192.168.20.52:2282,postgres
  • SERVER2:5432,mydb

You can add as many [HOST:PORT,database] sections as you require. Note that if you omit the database value, by default "postgres" will be assumed.

ssl=Signifies that the connection to the target server specified in HOST:PORT,database must use SSL mode (true).
sslmode=

Value should be one of the following:

  • require
  • verify-ca
  • verify-full
  • disable

More details about this is mentioned in https://www.postgresql.org/docs/13/libpq-ssl.html. This variable will match the PostgreSQL SSL parameter PGSSLMODE.

All other options

Refers to the location of the client certificates and keys generated previously with OpenSSL The certificates and keys need to be copied to the location you have chosen. The location of these certificates and keys is flexible:

  • They can be stored on a shared network drive
  • They can be stored on the server's local file system - in this situation, the certificates and keys need to be available on all server's that must use SSL mode

You can use the following path syntax:

  • Local drive: D:\keys\postgresql.key
  • Direct path: \\SERVER\certs\root.crt
  • Mapped drive on server: S:\\certs\root.crt >>> Appropriate permissions required.

CAST highly recommends that you separate the storage and place the .crt files in one folder and all other keys (.pk8, .key, .pfx) in another folder - i.e. do not mix the two together.

sslrootcert=Give the full path of root.crt file (the crt file which is generated using OpenSSL for trusted certificate authorities ). This variable will match the PostgreSQL SSL parameter PGSSLROOTCERT.
sslkey=Give the full path of postgresql.key file (the key file which is generated using OpenSSL for client certificate ). This variable will match the PostgreSQL SSL parameter PGSSLKEY.
sslcert=Give the full path of postgresql.crt file (the key file which is generated using OpenSSL for client private key ). This variable will match the PostgreSQL SSL parameter PGSSLCERT.
ssljdbckey=Give the full path of postgresql.pk8 file (this is the key file which is generated using OpenSSL based on client certificate (postgresql.crt) and client private key (postgresql.key) using pk8 for JDBC connections).
sslpfx=Give the full path of postgresql.pfx file (this is the key file which is generated using OpenSSL based on client certificate (postgresql.crt) and client private key (postgresql.key) using pkcs12 for .NET connections).

...

Info
  • Ensure that the service (or the user who launches the CAST applications programs) is dedicated.

  • Do not put certificates and .key files in the same folder

  • Create a dedicated folder for .key files and only give access to the dedicated CAST user

  • Do not use a password on the .pfx file, otherwise you will have to enter the password each time you restart

  • If you are using AIP Console to manage the AIP Node, and you have defined a dedicated CAST Storage Service/PostgreSQL instance just for the Measurement schema (see the screen Configure Measurement Database in Complete start-up wizard - v. 1.x), you must ensure that you define an entry for this CAST Storage Service/PostgreSQL instance in the SSLParameters .ini file and this entry MUST be present on all AIP Nodes that are being managed in AIP Console.

...

For example:

...

Code Block

...

Create a Windows environment variable (System or User according to your own requirements) on each server hosting CAST applications that must use SSL mode to connect to a CAST Storage Service/PostgreSQL instance. Use the following syntax:

  • Variable Name - CASTCONNECTIONEXTRAPARAMETERS
  • Variable Value - location of the SSLParameters.ini file, for example: <FULLPATH>\SSLParameters.ini

Configure AIP Node (for AIP Console) to function in SSL mode

If you are using AIP Console to manage the AIP Node, the following configuration must be performed on each AIP Node (i.e. a machine on which CAST AIP Core has been installed and is being managed in AIP Console) that must use an encrypted SSL connection to the target CAST Storage Service/PostgreSQL instance.

Edit the following file:

Code Block
%PROGRAMDATA%\CAST\AipConsole\AipNode\aip-node-app.properties

Find the following section:

Code Block
# =============================
# CSS Server parameters
# -----------------------------
database.server.name=my_css_server:2282
database.server.user=operator
database.server.ssl=
database.server.ssl.iniPath=
# to encrypt the password use aip-encryption-tool
database.server.password=CRYPTED2:90B1A6EC1618661401B724DB5AC34595
database.name=postgres

Update the database.server.ssl and database.server.ssl.iniPath parameters as follows:

Code Block
# =============================
# CSS Server parameters
# -----------------------------
database.server.name=my_css_server:2282
database.server.user=operator
database.server.ssl=true
database.server.ssl.iniPath=<PATH_TO>/SSLParameters.ini
# to encrypt the password use aip-encryption-tool
database.server.password=CRYPTED2:90401B724DB5AC34595
database.name=postgres

...

Restart Microsoft Windows on all AIP Nodes / CAST Imaging instances

Finally restart Microsoft Windows on all AIP Nodes/ CAST Imaging instances so that all changes are taken into account.

Configure standalone CAST Dashboards to function in SSL mode

There are two ways to force the standalone CAST Dashboards to function in SSL mode:

  • By modifying the URL that points to the CAST Storage Service/PostgreSQL instance (this method must be used for Dashboards deployed in Linux environments, but can also be used in Microsoft Windows environments)
  • By using the SSLParameters.ini file and an environment variable (this method should be used for Dashboards deployed in Microsoft Windows environments)

Method 1: Modify the connection URL

Edit the following file:

Code Block
WAR ≥ 2.x
CATALINA_HOME\webapps\<dashboard>\WEB-INF\classes\application.properties

ZIP ≥ 2.x
<unpacked_zip>\application.properties

Locate the following section in the file:

Code Block
## DATASOURCE
# Resource1 is the datasource name used in domains.properties
# Adapt server name (localhost) and port (2282) if required
# You can add multiple datasources if you want to connect to multiple CSS Servers. Datasource name must be unique
# You have to configure your domains names and relative schema names in domains.properties
restapi.datasource[0].url=jdbc:postgresql://localhost:2282/postgres
restapi.datasource[0].username=operator
restapi.datasource[0].password=CastAIP
restapi.datasource[0].poolname=Resource1
restapi.datasource[0].minimumIdle=10
restapi.datasource[0].maximumPoolSize=20

Modify the restapi.datasource[0].url=jdbc:postgresql://localhost:2282/postgres line to point to the certificate files you generated previously:

Code Block
restapi.datasource[0].url=jdbc:postgresql://my_server:2282/postgres?ssl=true&sslrootcert=\\\\my_host\\share\\root.crt&sslcert=\\\\my_host\\share\\postgresql.crt&sslkey=\\\\my_host\\share\\postgresql.pk8&sslmode=verify-ca

This is broken down as follows:

...

ssl=true

...

sslrootcert=\\\\my_host\\share\\root.crt

...

sslcert=\\\\my_host\\share\\postgresql.crt

...

sslkey=\\\\my_host\\share\\postgresql.pk8

...

sslmode=verify-ca

...

Finally restart the application server so that all changes are taken into account.

Method 2: Using the SSLParameters.ini file and an environment variable

...

titleOne single host CAST Storage Service/PostgreSQL instance
[my_css1:2284,postgres]
ssl=truesslmode=require
sslrootcert=C:\certs\root.crt
ssljdbckey=C:\certs\postgresql.pk8
sslkey=C:\certs\postgresql.key
sslcert=C:\certs\postgresql.crt
sslpfx=C:\certs\postgresql.pfx


Code Block
titleTwo CAST Storage Service/PostgreSQL instances
[my_css1:2284,postgres]
ssl=truesslmode=require
sslrootcert=C:\certs\root.crt
ssljdbckey=C:\certs\postgresql.pk8
sslkey=C:\certs\postgresql.key
sslcert=C:\certs\postgresql.crt
sslpfx=C:\certs\postgresql.pfx

[my_css2:5432,postgres]
ssl=truesslmode=require
sslrootcert=C:\temp\certs\root.crt
ssljdbckey=C:\temp\postgresql.pk8
sslkey=C:\temp\postgresql.key
sslcert=C:\temp\postgresql.crt
sslpfx=C:\temp\postgresql.pfx


Code Block
titleTwo CAST Storage Service/PostgreSQL instances - one with encrypted source code feature ALSO enabled
[my_css1:2284,postgres]
ssl=truesslmode=require
sslrootcert=C:\certs\root.crt
ssljdbckey=C:\certs\postgresql.pk8
sslkey=C:\certs\postgresql.key
sslcert=C:\certs\postgresql.crt
sslpfx=C:\certs\postgresql.pfx

[my_css2:5432,postgres]
ssl=truesslmode=require
sslrootcert=C:\temp\certs\root.crt
ssljdbckey=C:\temp\postgresql.pk8
sslkey=C:\temp\postgresql.key
sslcert=C:\temp\postgresql.crt
sslpfx=C:\temp\postgresql.pfx
encryption_key_default=AFK%3JdMEn99WypMVSCU

Anchor
env
env
Create environment variable on all AIP Core (AIP Node) instances / CAST Imaging instances

Create a Windows environment variable (System or User according to your own requirements) on each server hosting CAST applications that must use SSL mode to connect to a CAST Storage Service/PostgreSQL instance. Use the following syntax:

  • Variable Name - CASTCONNECTIONEXTRAPARAMETERS
  • Variable Value - location of the SSLParameters.ini file, for example: <FULLPATH>\SSLParameters.ini

Image Added

Configure AIP Node (for AIP Console) to function in SSL mode

AIP Console  2.x

Update the CAST Storage Service/PostgreSQL connection profile to use SSL mode (see Administration Center - Settings - CSS and Measurement settings):

Click to enlarge

Image Added

AIP Console 1.x

If you are using AIP Console to manage the AIP Node, the following configuration must be performed on each AIP Node (i.e. a machine on which CAST AIP Core has been installed and is being managed in AIP Console) that must use an encrypted SSL connection to the target CAST Storage Service/PostgreSQL instance.

Edit the following file:

Code Block
%PROGRAMDATA%\CAST\AipConsole\AipNode\aip-node-app.properties

Find the following section:

Code Block
# =============================
# CSS Server parameters
# -----------------------------
database.server.name=my_css_server:2282
database.server.user=operator
database.server.ssl=
database.server.ssl.iniPath=
# to encrypt the password use aip-encryption-tool
database.server.password=CRYPTED2:90B1A6EC1618661401B724DB5AC34595
database.name=postgres

Update the database.server.ssl and database.server.ssl.iniPath parameters as follows:

Code Block
# =============================
# CSS Server parameters
# -----------------------------
database.server.name=my_css_server:2282
database.server.user=operator
database.server.ssl=true
database.server.ssl.iniPath=<PATH_TO>/SSLParameters.ini
# to encrypt the password use aip-encryption-tool
database.server.password=CRYPTED2:90401B724DB5AC34595
database.name=postgres


database.server.sslSet this option to true to enforce an encrypted SSL connection. Without this option, a standard non-encrypted connection will be used.
database.server.ssl.iniPathSet this to the path where your SSLParameters.ini file is located.

Restart Microsoft Windows on all AIP Nodes / CAST Imaging instances

Finally restart Microsoft Windows on all AIP Nodes/ CAST Imaging instances so that all changes are taken into account.

Configure standalone CAST Dashboards (≥ 2.x) to function in SSL mode

There are two ways to force the standalone CAST Dashboards to function in SSL mode. Both are valid for Dashboards deployed on Microsoft Windows and on Linux:

  • By modifying the URL that points to the CAST Storage Service/PostgreSQL instance 
  • By using the .ini file and an environment variable

Method 1: Modify the connection URL

Edit the following file:

Code Block
WAR ≥ 2.x
CATALINA_HOME\webapps\<dashboard>\WEB-INF\classes\application.properties

ZIP ≥ 2.x
<unpacked_zip>\application.properties

JAR ≥ 2.x
%PROGRAMDATA%\CAST\Dashboards\application.properties

Locate the following section in the file:

Code Block
## DATASOURCE
# Resource1 is the datasource name used in domains.properties
# Adapt server name (localhost) and port (2282) if required
# You can add multiple datasources if you want to connect to multiple CSS Servers. Datasource name must be unique
# You have to configure your domains names and relative schema names in domains.properties
restapi.datasource[0].url=jdbc:postgresql://localhost:2282/postgres
restapi.datasource[0].username=operator
restapi.datasource[0].password=CastAIP
restapi.datasource[0].poolname=Resource1
restapi.datasource[0].minimumIdle=10
restapi.datasource[0].maximumPoolSize=20

Modify the restapi.datasource[0].url=jdbc:postgresql://localhost:2282/postgres line to point to the certificate files you generated previously:

Code Block
restapi.datasource[0].url=jdbc:postgresql://my_server:2282/postgres?ssl=true&sslrootcert=\\\\my_host\\share\\root.crt&sslcert=\\\\my_host\\share\\postgresql.crt&sslkey=\\\\my_host\\share\\postgresql.pk8&sslmode=verify-ca

This is broken down as follows:

ssl=true

Force the connection to use SSL mode.

sslrootcert=\\\\my_host\\share\\root.crt

Specifies the location of the root.crt certificate file. In this example, the file is located on a network share \\my_host\share\root.crt. Back slashes in the path MUST be escaped with a backslash.

sslcert=\\\\my_host\\share\\postgresql.crt

Specifies the location of the postgresql.crt certificate file. In this example, the file is located on a network share \\my_host\share\postgresql.crt. Back slashes in the path MUST be escaped with a backslash.

sslkey=\\\\my_host\\share\\postgresql.pk8

Specifies the location of the postgresql.pk8 certificate file. In this example, the file is located on a network share \\my_host\share\postgresql.pk8. Back slashes in the path MUST be escaped with a backslash.

sslmode=verify-ca

See the table in https://www.postgresql.org/docs/13/libpq-ssl.html#LIBPQ-SSL-PROTECTION for more information.

Finally restart the application server so that all changes are taken into account.

Method 2: Using the .ini file and an environment variable

Configure an .ini file

All host servers on which your CAST Dashboards are running need to have access to an .ini file that defines the CAST Storage Service/PostgreSQL instances which must be accessed via SSL, along with the various required certificates:

  • If you stored the .ini file for your AIP Core instance (Node) - see Create and configure the .ini file on all AIP Core (AIP Node) instances / CAST Imaging instances above - on a shared network resource that the CAST Dashboard host server(s) has access to, you can simply re-use this .ini file by pointing the environment variable at this .ini file - CAST highly recommends this method
  • Alternatively, you can create an .ini file on the local file system of the server(s) hosting the CAST Dashboards - this .ini file should contain a reference to all CAST Storage Service/PostgreSQL instances which must be accessed via SSL, along with the various required certificates - i.e. use the same syntax as described above in Create and configure the .ini file on all AIP Core (AIP Node) instances / CAST Imaging instances above. The disadvantage of this option is that if you need to change an encryption key (for example), you will need to update multiple .ini files.
Info

A feature to encrypt analyzed source code also uses an .ini file in exactly the same way as described here, therefore you may already have an .ini file/environment variable available if you have enabled this - see Storing analyzed source code in encrypted format. If this is the case, you can re-use this file and you can mix and match configuration from both features in this file.

Create an environment variable on the host server

On all servers hosting Dashboards that must read encrypted source code, add an environment variable called CASTCONNECTIONEXTRAPARAMETERS that points to the .ini file created previously. Use the following syntax:

Microsoft Windows

System or user environment variable:

  • Variable Name - CASTCONNECTIONEXTRAPARAMETERS
  • Variable Value - location of the .ini file, for example: <FULLPATH>\myfile.ini

Image Added

Linux

Set a system wide environment profile via the /etc/environment file:

  • CASTCONNECTIONEXTRAPARAMETERS="<FULLPATH>/myfile.ini"

Image Added

Finally restart the application server so that all changes are taken into account.

Notes

Any custom scripts that you use to connect to your CAST Storage Service / PostgreSQL instance will need to be refactored to take advantage of the encrypted SSL connection should you wish to.