Setting up SSL for OpenLM Server and Identity Service v2x – KB903

Table of contents

Setting up SSL for Identity Service
Setting up SSL for OpenLM Server

This is a quick guide that describes how to set up the SSL connection for the OpenLM Server and Identity Service v2x.

Important:

It is mandatory that the certificates used for the Server also be installed and present in the Trusted Certificate Store of the machine with the component connecting to the OpenLM Server.
Once SSL is enabled for the Server, it is necessary to update the hostname/IP of all components that connect to it to use the HTTPS protocol. As with the Server configuration, make sure that the exact FQDN is used when specifying the host.
A self-signed certificate has been used for demonstration purposes. We strongly advise using a use Certificate with a digital signature from a Certificate Authority (CA).

Setting up SSL for Identity Service #

Go to C:Program FilesOpenLMOpenLM/OpenLM IdentityService/SecurityService/cert and place here the certificate with a digital signature from a certificate authority (CA).
Attention! Do not delete any existing certificates!
Open the appsettings.json file located at C:Program FilesOpenLMOpenLM Identity ServiceSecurityService with a convenient text editor and administrator privileges.
Locate the Settings node and change the “IssuerUri” parameter from HTTP to HTTPS:

},
  "Settings": {
    "UseDb": true,
    "IssuerUri": "https://hostname:5000",
    "DbType": "MariaDB"
  },

5. Edit the Kestrel node. Provide the data for the certificate: path to the Certificate and password then change the URL parameter from HTTP to HTTPS:

  },
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "https://hostname:5000"
      },
      "Https": {
        "Url": "http://*:5001"
      }      
    },
    "Certificates": {
      "Default": {
	"Path": "./cert/cert.pfx",
        "Password": "12345"
      }
    }
  },

Path – The path to the certificate file. Make sure the Windows paths use double backslashes instead of forward slashes.
Password – the password for the private key of the certificate.

Note: make sure the curly braces { } are properly closed at all times.

6. Save the changes.

7. Restart the Identity Service:

8. To verify whether the SSL connection is successful, open up the Identity Service UI, type in the address bar the new address (HTTPS), and refresh the page. Click on the “Lock” icon as portrayed below:

Setting up SSL for OpenLM Server #

1. Go to C:Program FilesOpenLMOpenLM/Server/bin and create a folder called “Cert”, then paste the certificate with a digital signature from a certificate authority (CA) to this folder.

2. Open up the appsettings.json located at C:Program FilesOpenLMOpenLM Serverbin in a text editor with administrator privileges.

3. Locate and edit the Kestrel node configurations and update the URL for the Kestrel endpoint, i.e the full path to EasyAdmin: https://path.domain:port

},
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "hostname:5015"
      }
    },

4. Locate and edit the Certificates node. Provide the following details:

Path – The path to the certificate file. Make sure the Windows paths use double backslashes instead of forward slashes.
Password – the password for the private key of the certificate.

Note: make sure the curly braces { } are properly closed at all times.

},
    "Certificates": {
      "Default": {
        "Path": "./cert/cert.pfx",
        "Password": "12345"
      }
    },

5. Locate the “Auth” node and edit the “Authority” line with the updated Identity Server URL (HTTPS)

},
  "Auth": {
    "EnableSecurity": true,
    "Authority": "https://hostnname:5000",
    "Audience": "openlm.server.api",
    "AuthProvider": "",
    "ClientId": "openlm.server.client",
    "ClientSecret": "c0936471-0f6a-44af-9078-99d150683cad",
    "ClientScope": "openlm.cloud.scope openlm.ugs.read.scope IdentityServerApi openlm.dss.scope openlm.etlmanager.scope",
    "TokenEndpoint": "/connect/token"
  }
}

6. Save the changes (Ctrl+S).

7. Now it is time to change the OpenLM Server we have declared in the Identity Service Settings. Open up the Identity Service→Settings→Security Configuration tab and declare the updated Sever’s address (HTTPS) and click Save: