Versions Compared

Key

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

...

  • The connection from a client (user browser or REST client) to JOC Cockpit can be secured by HTTPS. This includes that the client validates the JOC Cockpit's SSL Server Authentication Certificate. In addition the JOC Cockpit can be configured for mutual authentication, requesting in return the client to present a Client Authentication Certificate that is validated by JOC Cockpit.
  • This article describes the steps required to set up JOC Cockpit for certificate based authentication.
  • Use with JS7 - Identity Services 
    • For the the JS7 - JOC Identity Service certificates  certificates can be used for single-factor and for two-factor authentication.
    • For any other Identity Services certificates can be used for two-factor authentication.
  • Authentication Schemes
    • Single-factor authentication includes that use of a Client Authentication Certificate is sufficient to login to JOC Cockpit, no specification of user account and password is required.
    • Two-factor authentication includes that
      • the client (user browser, REST client) presents a Client Authentication Certificate and
      • the client specifies the user account and password for login.

...

JETTY_BASE is Jetty's base directory which that is specified during the JOC Cockpit installation:

  • C:\ProgramData\sos-berlin.com\joc (default on Windows)
  • /home/<setup-user>/sos-berlin.com/joc (default on Linux)

Add the following entries to the JETTY_BASE/start.ini configuration file:

...

  • Line 2: if needClientAuth is set to true then a Client Certificate is required. If this setting is false and the wantCientAuth setting is true then users have the option for user account/password based authentication or certificate based authentication.
  • Line 4: this setting looks weird, however, it is required due to a bug in Jetty 9.4, see https://github.com/eclipse/jetty.project/issues/3466. With later releases of Jetty that fix this bug this setting is not required.

...

  • Self-signed Certificates
    • JOC Cockpit holds the client's certificate in its truststore. 
    • Each client's individual certificate is required to be in place.
  • CA signed Certificates
    • JOC Cockpit holds the CA certificate, i.e. the root certificate/intermediate certificateRoot CA Certificate/Intermediate CA Certificate(s), in its truststore.
    • Connections from any clients that use a certificate signed by the CA will be accepted.
    • This approach is more flexible as it does not require to modify the Jetty truststore when adding/removing clients.

...

For use with self-signed certificates the root certificate Root CA Certificate has to be added to the client's certificate store. Certificates from trusted root Root CAs frequently are available from a client's keystore.

...

  • The private key is created by the client when generating a key pair for a self-signed certificate and respectively when creating a Certificate Signing Request (CSR) for its CA.
  • For CA signed certificates the client's certificate store includes the certificate chain, i.e. client certificate and root certificate/intermediate certificateRoot CA Certificate/Intermediate CA Certificate(s) that have been used when signing the client's certificate.
  • Frequently private key and certificate(s) are stored in a PKCS12 keystore that comes with a .pfx or .p12 file extension. However, other file formats for private key and certificate(s) are available.
  • The clients' keystore has to be imported into the client's certificate store. The location of the certificate store depends on the client application that is used to access JOC Cockpit:
    • Browser Clients
      • Firefox (any platform): support for use of an individual certificate store that is available with the browser, see Options -> Privacy & Security -> Certificates.
      • Chrome, Vivaldi, Edge (Windows): supports  support for use of the Windows Certificate Store
      • Chrome, Vivaldi (Linux): support for use of an individual certificate store that is available with the browser, see Options -> Privacy
      • Chrome, Safari (Mac OS): support for use of the Mac OS Certificate Store
    • REST Clients
      • JS7 PowerShell Module (Connect-JS7): Windows, Linux, Mac OS: support for use of a PKCS12 keystore (.p12); Windows: support for use of the Windows Certificate Store.
      • Other REST Clients: REST clients implemented with programming languages or scripting languages follow individual approaches to manage a certificate store.

...