Configure mutual authentication
Summarize
Summary of Configure mutual authentication
Mutual authentication in ServiceNow establishes trust between client and server by exchanging SSL certificates during HTTPS connections. Both parties validate each other's certificates to ensure authenticity before securely communicating. This feature applies only to outbound HTTPS connections from the instance.
Show less
Key Features
- Java Key Store (JKS) Support: ServiceNow supports uploading a Java Key Store file containing private keys and public certificates with a complete certificate chain.
- Certificate Generation and Import: Administrators must generate the Key Store and associated certificates, including root and intermediate certificates, using command-line keytool commands. This includes generating a keystore and key pair, creating a CSR, obtaining signed certificates from a trusted Certificate Authority (CA), and importing certificates into the keystore.
- Uploading Key Store: After creation, the Key Store is uploaded via the System Definition > Certificates page, specifying it as an active Java Key Store and setting the password used during creation.
- Trusted Server Certificates: ServiceNow allows specifying trusted server certificates to validate the identity of the service provider during outbound HTTPS calls. Trusted server certificates can be uploaded in DER or PEM format as "Trust Store Cert" entries.
- Certificate Exchange Process: During SSL handshake, ServiceNow generates a public/private key pair stored in the Key Store. The public key encrypts messages to the server, and the private key decrypts client messages. Mutual trust is established by verifying certificates against the Key Store and Trust Store certificates.
Practical Implications for ServiceNow Customers
- Mutual authentication enhances security for outbound HTTPS connections by ensuring both client and server verify each other's identities.
- Proper setup requires generating and managing Java Key Stores and certificates signed by a trusted CA.
- Uploading both client keystores and trusted server certificates into ServiceNow is essential for certificate validation and establishing trust.
- Understanding the certificate exchange and validation flow helps troubleshoot connection issues related to certificate acceptance and trust.
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.
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:
- Generate a Java keystore and key pair.
keytool -genkey -alias mydomain -keyalg RSA -keystore my.keystore - Generate a CSR for an existing Java keystore.
keytool -certreq -alias mydomain -keystore my.keystore -file mydomain.csr - 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.
- Import a root or intermediate certificate authority CA certificate to an existing Java
keystore.
keytool -import -trustcacerts -alias root -file Thawte.crt -keystore my.keystoreNote:You can bundle all the certificates in one file and import. This is preferable option. If you do this way you can skip 5keytool -import -alias mydomain -file merged.crt -keystore my.keystore - 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
- 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.
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
- 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.
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.