Secure PLOSSYS Administrator¶
For security reasons, we strongly recommend configuring the TLS encryption. This is also one step to get rid off the annoying certificate warnings in the browser. We also recommend using a regenerated client secret different to the one contained in delivery.
Configure the TLS Encryption¶
-
Get the TLS certificate in PEM format, see the Requirement. For securing the connection to PLOSSYS Administrator, the certificate has to contain the server name of PLOSSYS 5.
-
Create a new directory for the external TLS certificates:
mkdir C:\ProgramData\SEAL Systems\config\tls-external
-
Save the private key and the public certificate in the newly created
C:\ProgramData\SEAL Systems\config\tls.external
directory.copy <your_key.pem> C:\ProgramData\SEAL Systems\config\tls-external\key.pem
copy <your_cert.pem> C:\ProgramData\SEAL Systems\config\tls-external\cert.pem
-
Set the following key to the path of the certificate files:
TLS_EXTERNAL_DIR
: Directory for storing the files necessary for secure transfer with the PLOSSYS Administrator.
Example - setting key via PLOSSYS CLI for all external services (recommended)
plossys config set TLS_EXTERNAL_DIR "C:\ProgramData\SEAL Systems\config\tls-external" --service any --insecure
Example - setting key via PLOSSYS CLI for PLOSSYS Administrator only
plossys config set TLS_EXTERNAL_DIR "C:\ProgramData\SEAL Systems\config\tls-external" --service plossysadmin --insecure
-
If the self-signed certificates are used with PLOSSYS Administrator, the following key has to be set to
0
for theseal-plossysadmin
service:NODE_TLS_REJECT_UNAUTHORIZED
: Flag if self-signed certificates are allowed
Example - setting key via PLOSSYS CLI
plossys config set NODE_TLS_REJECT_UNAUTHORIZED 0 --service plossysadmin --insecure
-
Restart the following service:
seal-plossysadmin
-
Close PLOSSYS Administrator and open it again.
Configure the TLS Encryption in a Cluster¶
In a cluster, execute the steps above on one server. On every other server, execute the following steps:
-
Create a new directory for the external TLS certificates:
mkdir C:\ProgramData\SEAL Systems\config\tls-external
-
Save the private key and the public certificate in the newly created
C:\ProgramData\SEAL Systems\config\tls.external
directory.copy <your_key.pem> C:\ProgramData\SEAL Systems\config\tls-external\key.pem
copy <your_cert.pem> C:\ProgramData\SEAL Systems\config\tls-external\cert.pem
-
Restart the following service:
seal-plossysadmin
-
If needed, close PLOSSYS Administrator and open it again.
Regenerate the Client Secret in the OIDC Identity Provider¶
If the SEAL specific Keycloak is being used in a productive setting, execute the following steps:
-
In the OIDC identity provider, regenerate the secret for the
seal-plossysadmin
client, refer to the SEAL Interfaces for OIDC documentation. -
In the configuration of the
seal-plossysadmin
service, specify the regenerated client secret with the following key:AUTH_CLIENT_SECRET
: Client secret generated in the OIDC identity provider for theseal-plossysadmin
client
Next Step¶
Continue with: Secure the PLOSSYS 5 Services