Configure Key Exchange
Key Management Framework (KMF) generates automatic key exchange requests for supported cryptographic modules during the fresh installation or upgrade of the instance, and manages the data encryption key locally for the instance.
Before you begin
A cryptographic module with a key must be created in both the target and source instances before using Key Exchange.
Role required: sn_kmf.cryptographic_manager
About this task
Key Exchange requests are initiated from the target instance.
Automatic Key Exchange is active by default when cloning an instance, where the property is cloned to the target instance. Along with KMF, configure system properties to manage how keys are handled during an instance clone:
- Turn off automatic key exchange: Set the glide_encryption.auto_key_exchange.enabled property to false for recurring clone requests.
- Send auto key exchange requests: Set this property to true.
Important: The base system property is set to true by default, meaning that automatic key exchange is activated when cloning an instance. This value must be set to false if you're using the Rekey ciphertext with Key Exchange or the recurring Key Exchange functionality. See Recurring Key Exchange walkthrough for additional details.
Procedure
Navigate to All > Key Management > Resource Exchange Requests > New.
On the form, fill in the fields.
| Name | Description | |
|---|---|---|
| Exchange Frequency |
| |
| <Source or Target> Instance sys\_id |
Tip: Enter | |
| <Source or Target> Instance Host | Enter the host location or name of the source or target instance.Tip: For example instanceA.service-now.com | |
| Crypto Specifications | The keys from the crypto specification in a crypto module define the keys to clone. For both one-time and recurring clone requests, your instance automatically creates a Resource Exchange module access policy. You don't need to configure a policy manually.Note: Select the lookup using list icon ( Image omitted: IconUI15GlobalTextSearch.png Enable Rekeying after Key ImportedLookup using list icon.) to browse the available cryptographic specifications.</td></tr><tr><td> | Option to enable auto rekeying. |
Select Submit.
If successful, a confirmation displays at the top of the form. The Requests table is updated with an entry of Request Pending in both the source instance and in the target instance. Open the Request Record to view the status of the request, the Imported Key Count, and the Total Key Count on the target or source host.
Shows the request status for Requests.
In the source instance, approve the pending request to complete the exchange.
The approval process depends on the exchange frequency you selected.
One Time Clone or Recurring Clone
The module access policy on the source instance auto-approves the request at clone time. No manual action is required.
Adhoc
Manually approve each pending request in the source instance:
- Log in to the source instance and navigate to All > Key Management > Resource Exchange Requests.
- Open a request with a status of Request Pending.
- Change the Status field to Request Approved.
Select Update Request.
Important: Select Update Request, not the standard Update button. Using the standard Update button does not complete the approval.
Repeat for each remaining Request Pending entry. Note: Not all crypto specifications requested may exist in the source instance. Requests for specifications not found in the source instance do not require approval.
Request Approved appears in the Status field on the Request record.
Result
After a key exchange is attempted, your non-production instance updates the protected.script.values.kmf.rekeyed system property. This property is visible in the System Properties [sys_properties] table after a key exchange is attempted. If the encryption using the exchanged key is successful, this property has a value of true. Otherwise, the property has a value of false. If the value is false, the instance will attempt to encrypt again the next day.
Parent Topic:Key Management Framework Resource Exchange