1.0 Introduction

InterSystems Cache is a high-performance database that powers transaction processing applications around the world. It is used for everything from mapping a billion stars in the Milky Way, to processing a billion equity trades in a day, to managing smart energy grids.

InterSystems Cache powers customers’ most mission-critical applications with the ability to store, use, and analyze transactional and historical data concurrently in whatever forms required. High-speed SQL runs consistently and seamlessly across all data models.

2.0 Why Use Fortanix DSM with InterSystems Cache?

InterSystems Cache supports encryption of data at rest. It supports a keyring service that enables internal server components and plugins to securely store sensitive information for later retrieval.

Cryptographically secure generation and secure management of encryption keys are required for true security of data at rest encrypted by InterSystems Cache. {{glossary.Fortanix-Data-Security-Manager}} (DSM), with its KMIP support, provides a secure and flexible solution for this.

InterSystems Cache KMIP keyring plugin authenticates to a KMIP-enabled key management server using a client certificate. DSM supports clients/apps to authenticate using API Key, app ID, and certificate or just certificate.

3.0 Prerequisites

Ensure the following:

Fortanix DSM
InterSystems Management Console
Access to create a certificate for KMIP Server

4.0 Configure Fortanix DSM

A Fortanix DSM service must be configured, and the URL must be accessible. To create a Fortanix DSM account and group, refer to the following sections:

4.1 Signing Up

{{snippet.Signing Up}}

4.2 Creating an Account

Access <Your_DSM_Service_URL> in a web browser and enter your credentials to log in to Fortanix DSM.

{{snippet.Creating an Account}}

4.3 Creating a Group

Perform the following steps to create a group in the Fortanix DSM:

In the DSM left navigation panel, click the Groups menu item, and then click ADD GROUP to create a new group.
Figure 2: Add groups
On the Adding new group page, do the following:
1. Title: Enter a name for your group.
2. Description (optional): Enter a short description of the group.
Click SAVE to create the new group.

The new group is added to the Fortanix DSM successfully.

4.4 Creating an Application

Perform the following steps to create an application (app) in the Fortanix DSM:

The new application is added to the Fortanix DSM successfully.

4.5 Copying the App UUID

Perform the following steps to copy the app UUID from the Fortanix DSM:

In the DSM left navigation panel, click the Apps menu item, and then click the app created in Section 4.4: Creating an Application to go to the detailed view of the app.
From the top of the app’s page, click the copy icon next to the app UUID to copy it to use in Section 4.6: Generating the Certificate as the value of Common Name (CN) to generate the self-signed certificate and a private key.

4.6 Generating the Certificate

Run the following OpenSSL command to create a new certificate, which you will be using to upload in the Fortanix DSM app:

openssl req -newkey rsa:2048 -nodes -keyout sdkms.key -x509 -days 365 -out sdkms.crt

4.7 Updating the Authentication Method

Perform the following steps to change the authentication method:

Go to the detailed view of the app created in Section 4.4: Creating an Application and click Change authentication method and select the Certificate option to change the authentication method to Certificate.
Click SAVE.
On the Add certificate dialog box, click UPLOAD NEW CERTIFICATE to upload the certificate file or paste the content of the certificate generated in previous section.
Select both check boxes to confirm your understanding of the action.
Click UPDATE to save the changes.

5.0 Enabling the Security in InterSystems Cache

5.1 Create a new SSL/TLS Configuration

Log in to the IRIS Management Console.
Figure 5: IRIS management console
After logging in, the InterSystems Management Console homepage is displayed.
Figure 6: InterSystems management portal
On the IRIS instance that will connect to the KMIP server, create an SSL/TLS Configuration that will represent the instance to the KMIP server:
1. Navigate to Home → System Administration → Security → SSL/TLS Configurations.
  Figure 7: SSL/TLS configuration page
2. Click Create New Configuration to open the New SSL/TLS Configuration page and do the following:
  1. Enabled — Select this check box.
  2. Type — Select Client.
  3. Client Certificate and Key — Upload the client certificate and private key generated in Section 4.6: Generating the Certificate.
  4. CA Certificate — Upload the certificate authority used to sign the DSM server certificate.
Figure 8: Update the SSL/TLS configuration
Click the Test icon to validate the connection.
Figure 9: Test server hostname
In the prompt, set the Test server port as 5696 and click OK.
Figure 10: Update port number
Upon successful connection, click Save.
Figure 11: Connection success
Once the SSL/TLS configuration is successfully set up, the final configuration details are displayed in the Management Console as shown below.
Figure 12: Configuration success

5.2 Create KMIP Server Configuration Using Terminal

Perform the following steps to configure a KMIP server using the terminal:

Start the Terminal and log in with a sufficiently privileged user account.
Figure 13: Log in to terminal
Navigate to the %SYS namespace and run the ^SECURITY routine:
```
     zn "%SYS"
%SYS>do ^SECURITY
```
Figure 14: Run ^Security
In the ^SECURITY menu, select option 14) KMIP server setup.
In the KMIP server setup menu, select option 1) Create KMIP server and provide the following configuration values:
1. KMIP server to create? — Enter the name of the KMIP server configuration.
2. Server host DNS name? — Enter the fully qualified DNS name or IP address of the Fortanix DSM server.
3. TCP port number? — The port number on which the KMIP server accepts connections.
4. OASIS KMIP protocol version? — The number associated with your KMIP server’s supported version of the protocol. This is part of the information that you have received from the vendor that provides the KMIP server.
5. SSL/TLS Configuration name? — Enter the name of the SSL/TLS configuration created in the previous step.
6. Non-blocking I/O? — Enter Yes.
7. Auto-reconnect? — Enter Yes.
8. I/O timeout, in seconds? — Enter 10.
9. Log KMIP messages? — Enter Yes.
10. Debug SSL/TLS? — Enter Yes.
11. Confirm creation of KMIP server DSM? — Enter Yes.
```
KMIP Server to create? DSM
Description? DSM
Server host DNS Name?  <fortanix_dsm_url>
Port number? 5696 => 5696
OASIS KMIP protocol version
0) 1.0
1) 1.1
2) 1.2
3) 1.3
4) 1.4
OASIS KMIP protocol version? 2 => 2
SSL/TLS configuration name? KMIP => DSM
Non-blocking I/O? Yes => Yes
Auto-reconnect? No => Yes
I/O timeout, in seconds? 10 => 10
Log KMIP messages? No => Yes
Debug SSL/TLS? No => Yes
Confirm creation of KMIP server DSM? Yes => Yes
KMIP server DSM created
```
Figure 15: Create KMIP server
Once complete, the terminal will confirm as KMIP server DSM created.
To view the configuration, select option 4) Detailed list KMIP server in the KMIP server setup menu.
Figure 16: List the KMIP server

5.3 Create a New Key in KMIP Server

Perform the following steps to activate a database encryption key from a KMIP server:

Start the Terminal for the relevant InterSystems IRIS instance and log in with a sufficiently privileged user account.
At the terminal prompt, switch to the %SYS namespace and run the ^EncryptionKey routine:
```
     zn "%SYS"
%SYS>do ^EncryptionKey
```
Figure 17: Run encryption key
In the Encryption Key Management menu, select option 5) Manage KMIP server.
When prompted, enter the name of the configured KMIP server, which is DSM.
In the KMIP server management menu, the following options are available:
1. Option 1: List keys in the KMIP server.
2. Option 2: Create a new key.
3. Option 3: Destroy a key
  Figure 18: KMIP server - DSM
Select option 2) Create new key on KMIP server to generate a new encryption key.
NOTE
The key is created on the KMIP server but is not activated at this stage.
Figure 19: Create new key on KMIP server
After the key is created, it will appear in the Fortanix DSM under the Security Objects menu item for the corresponding app.
Figure 20: Key created in Fortanix DSM

5.4 Activate the Data-Element Encryption Key from a KMIP Server

The cache supports up to four activated keys at one time for data-element encryption.

Perform the following steps to activate a key for data-element encryption from a KMIP server:

Start the Terminal for the relevant instance and log in as a user with sufficient privileges.
At the terminal prompt, switch to the %SYS namespace and run the ^EncryptionKey routine:
```
     zn "%SYS"
%SYS>do ^EncryptionKey
```
In ^EncryptionKey, select option 4) Data element encryption for applications.
In the Data element encryption for applications choices, select option 1) Activate data element encryption key.
In the Activate data element encryption key choices, select option 2) Use KMIP server.
At the KMIP server prompt, enter the name of the configuration of the KMIP server from which you wish to activate the key. The routine lists the available keys from the KMIP server and prompts for selection.
At the Select key prompt, specify the desired key.
The routine activates the selected key and displays its Key ID.
Figure 21: Activate key
For each activated key, the Data Element Encryption page, (System Administration → Encryption → Data Element Encryption) adds the key to the table of activated keys and displays its identifier.
You can now log in to the IRIS Management Console and verify the activated key.
Figure 22: Key added to table of activated keys

Is it possible to talk to Fortanix DSM using PyKMIP?