Configuring mutual authentication

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 4 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Configuring Mutual Authentication

    Mutual authentication establishes trust by exchanging SSL certificates during the SSL handshake between a server and a client. The server presents its certificate, and if configured, requests a certificate from the client. Both parties validate the certificates to ensure authenticity before initiating a secure HTTPS connection. This feature is applicable only for outbound HTTPS connections.

    Show full answer Show less

    Key Features

    • Client Key Store Creation: Administrators must set up a Java Key Store, which includes a private key and a public certificate chain. A trusted certificate authority (CA) is needed for this process.
    • Key Store Setup: After generating the Key Store using specific command-line commands, it must be uploaded to the Certificates table in ServiceNow.
    • Trusted Server Certificate Specification: Administrators can specify a trusted server certificate to ensure service validity during outbound SSL connections.
    • Protocol Profile Configuration: A configuration command allows the registration of a custom socket factory for SSL exchanges, affecting outbound connections to use mutual authentication.

    Key Outcomes

    By configuring mutual authentication, ServiceNow customers can enhance security for outbound HTTPS communications. This setup ensures that both the client and server can verify each other’s identities, thereby safeguarding sensitive data exchanged during connections. Proper implementation leads to a reliable and secure integration with external services.

    Mutual authentication establishes trust by exchanging secure sockets layer (SSL) certificates.

    During the SSL handshake, the server presents its certificate to the client. Subsequently, depending on the server's configuration, it may request a certificate from the client. Both server and client perform certificate validation procedures to ensure the authenticity and integrity of the presented certificates.

    Following a successful validation, acknowledgments are exchanged before the initiating the HTTPS connection.

    Administrators do the preliminary work of setting up the client Key Store and generating certificates before certification requests are fulfilled.

    Warning:
    This feature only enables mutual authentication on outbound https connections.

    Creating the Key Store

    The instance currently supports uploading a Java Key Store file, which contain a private key and a public certificate pair, the public certificate includes complete chain including the root certificate.

    To set up your client Key Store:

    • You require a certificate signed by a trusted certificate authority (CA).
    • Your API endpoint provider may assist you in generating the Key Store.

    If you need to generate the Key Store, the process involves several steps using command-line interface commands to generate a new Key Store file, create a certificate signing request (CSR), and import signed certificates. Before importing your domain's primary certificate, any root or intermediate certificates should be imported first. Here's a step-by-step instruction:

    1. Generate a Java keystore and key pair.
      keytool -genkey -alias mydomain -keyalg RSA -keystore my.keystore
    2. Generate a CSR for an existing Java keystore.
      keytool -certreq -alias mydomain -keystore my.keystore -file mydomain.csr
    3. Send the CSR to your CA signing authority to sign and return the certificate files, which includes intermediate and root certificates along with signed certificate.
    4. Import a root or intermediate certificate authority CA certificate to an existing Java keystore.
      keytool -import -trustcacerts -alias root -file Thawte.crt -keystore my.keystore
      Note:
      You can bundle all the certificates in one file and import. This is preferable option. If you do this way you can skip 5
      keytool -import -alias mydomain -file merged.crt -keystore my.keystore
    5. Import a signed primary certificate to an existing Java keystore.
      keytool -import -trustcacerts -alias mydomain -file mydomain.crt -keystore my.keystore

    Setting up the Key Store

    Now that the key store has been created, it can be uploaded to the Certificates table. On the System Definition > Certificates page, click New and set the following fields:
    • Enter a certificate Name.
    • Store the key store as Active.
    • Set Type = Java Key Store.
    • Provide a Key store password. This is the password that was used to create the keystore.
    Click Submit to create the Java Key Store entry.
    Figure 1. Key Store

    Specifying a Trusted Server Certificate

    During an outbound SSL connection, which is an HTTPS Web Service call, it is possible to specify a certificate provided by the service provider that ensures the validity of the service provider during the SSL connection. For example, a browser attempting to connect to a secure service which identifies itself by a certificate.

    By uploading the trusted server certificate, ServiceNow ensures that the service it is connecting to is valid and secure.

    Create a new Certificate entry with the type of "Trust Store Cert" and attach a DER formatted certificate, or copy and paste its PEM format into the PEM Certificate field.

    Protocol Profile

    Figure 2. Certificate Exchange
    • When a client requests the server certificate for authentication, a certificate signing request (CSR) is generated.
    • To respond to a CSR, the server generates two unique cryptographic keys: A public key, which is used to encrypt messages to the server and a private key, which is used to decrypt messages. Both keys are kept in the Key Store.
    • Keys are used to decrypt the client secure messages so they can be read by the server. Any outgoing connection that is going to be HTTPS verifies the certification by checking the Key Store, offering its public certification, and uses the trust store certificates to verify mutual trust back.
    • To complete the secure link between the client and the server, the server matches the certificate to the corresponding private key. Because only the server has access to the private key, the server can decrypt the data from the client.
    Here is an example of a command that registers MYHTTPS with the com.glide.certificates.DBKeyStoreSocketFactory socket factory on port 443. The database key store factory is used during the SSL exchange process to offer a client certificate for mutual authentication.
    glide.httpclient.protocol.myhttps.class = "com.glide.certificates.DBKeyStoreSocketFactory"
    glide.httpclient.protocol.myhttps.port = "443"
    Having the above configuration affects any outbound myhttps://host.domain.com/target URL to use the custom socket factory and exchange certificates during SSL.
    Note:
    Overriding the default HTTPS protocol socket factory affects every outbound HTTPS connection. This is usually undesirable.

    The server responds by sending a certificate. Is this a certificate that the client accepts? If yes, a message is sent to the server accepting the certificate and a secure channel is initiated. If the certificate is not accepted, it may mean that the root authority is needed for certification.