Data Security Manager with Microsoft SQL Server TDE Integration - Before You Begin

Last Updated: July 26, 2023 17:02

FORTANIX DATA SECURITY MANAGER WITH MICROSOFT SQL TDE INTEGRATION - BEFORE YOU BEGIN GUIDE.pdf
(600 KB)

1.0 Overview

This article describes the steps that must be performed before integrating Fortanix Data Security Manager (DSM) with Microsoft SQL Transparent Data Encryption (TDE).

1.1 Prerequisites

Ensure the following:

The Fortanix CNG Client must be installed and configured.

The port 443 must be accessible from the SQL target machine to Fortanix DSM.

Protocol

Inbound/

Outbound

Port Number

Load balancer (Yes/No)

Purpose

TCP

Outbound

443

HTTPS – Used for calling REST API. MS-SQL server will access the cluster/SaaS URL on this port.

Each individual node will also need this port open.

The SQL Server must be installed and configured on the target machine.
Administrators are privileged to access SQL Server Management Studio from the target machine.

1.2 Limitations and Restrictions

You must be a highly privileged user (such as a system administrator) to create a database encryption key and encrypt a database. That user must be able to be authenticated by the EKM module.
Upon startup, the database engine must open the database. To do this, you should create a credential that will be authenticated by the EKM and add it to a login that is based on an asymmetric key. Users cannot sign in using that login, but the database engine will be able to authenticate itself with the EKM device.
If the asymmetric key stored by EKM Provider (Fortanix DSM) is lost, the database will not be able to be opened by SQL Server. Hence, it is recommended to never delete or edit SQL Server managed keys from Fortanix DSM manually. Even after key rotation, it is recommended to keep the old keys, so that older backups can be used in contingency scenarios.
Access to install the Fortanix KMS Server file to configure it on the machine and user.

1.3 Permissions

This document uses the following permissions:

To change a configuration option and run the RECONFIGURE statement, you must be granted the ALTER SETTINGS server-level permission. The ALTER SETTINGS permission is implicitly held by the System Administrator and the Server Administrator who hold fixed server roles.
Requires ALTER ANY CREDENTIAL.
Requires ALTER ANY LOGIN.
Requires CONTROL permission on the database to encrypt the database.
Requires CREATE ASYMMETRIC KEY permission.

2.0 Fortanix CNG Provider

The Fortanix CNG Provider must be installed on every target machine. Refer to https://support.fortanix.com/hc/en-us/articles/360018084132-CNG-EKM to download the CNG Provider.

FortanixKmsClient.msi installs the Fortanix CNG Provider, as well as an EKM provider and the PKCS#11 library. Next, to configure the CNG client Fortanix CNG Provider communicates with Fortanix DSM for crypto operations.

2.1 Installation

Perform the following steps to complete the installation on your machine:

On the Fortanix KMS Client Setup dialog box, click the Next button.

Figure 1: Fortanix KMS Client Setup
Select the checkbox for I accept the terms in the License Agreement and click the Next Button.

Figure 2: Fortanix KMS Client Setup
Enter the location for installing the Fortanix KMS Client as C:\Program Files\Fortanix\KMS Client\.

Figure 3: Fortanix KMS Client Setup
Click the Install button to install the Fortanix KMS client.

Figure 4: Fortanix KMS Client Setup
After the installation is done, click the Finish button.

Figure 5: Fortanix KMS Client Setup

2.2 Configuring CNG Client

The Fortanix KMS Server URL and proxy information are configured in the Windows registry for the local machine or the current user.

Run the following command to navigate to FortanixKmsClientConfig.exe file:

cd C:\Program Files\Fortanix\KmsClient\

The machine key store uses the local machine configuration, and the user key store uses the current user configuration.
For example, run the following command to configure the Fortanix KMS Server URL for the local machine:

FortanixKmsClientConfig.exe machine --api-endpoint {KMS_URL}

Where,

KMS_URL refers to the Fortanix DSM URL. On-premises customers use KMS URL and SaaS. The customers can use the following URLs based on the region.
- Europe: https://eu.smartkey.io/
- APAC: https://apac.smartkey.io/
- United States of America: https://amer.smartkey.io/

For example,

FortanixKmsClientConfig.exe machine --api-endpoint https://<fortanix_dsm_url>

Run the following command to configure the Fortanix KMS Server URL for the current user:

FortanixKmsClientConfig.exe user --api-endpoint {KMS_URL}

To configure proxy information, add --proxy http://proxy.com or --proxy none to unconfigure proxy.

2.3 Creating Groups

A group is a collection of security objects created by and accessible by users and applications that belong to the group. The user who creates a group automatically gets assigned the role of group administrator. You can add more users to the group in the role of administrators or auditors. You can also add applications to the group to enable the applications to create and use security objects in that group.

To add a group, specify the following:

The title of the group (required).
A short description for the group (not mandatory).
Users in your account as members.
Applications in your account to add to the group so that they can use the security objects in the group. Refer to “Section 2.4- Creating Apps” to know the steps for creating the app.
Add a quorum approval policy (optional). A group administrator may enable a quorum approval policy for a group, which mandates that all security-sensitive operations in that group would require a quorum approval.

Figure 6: Adding New Group

2.4 Creating Apps

An application can use Fortanix DSM to generate, store, and use security objects, such as cryptographic keys, certificates, or an arbitrary secret. Examples of applications include web servers, PKI servers, key vaults, and so on. An application can interact with Fortanix DSM using the REST APIs or the PKCS#11, JCE, or CNG providers.

To add an application, specify the following:

Name of the application (required).
Type of the application. Select the value as interface.
A short description of the application.
Select the authentication method as API key.
Assign the app to the MSSQL group as created in the “Section 2.3- Creating Group”.

After the application has been added, you can use the API key to authenticate the CNG client to Fortanix DSM and start making calls to do cryptographic operations.

Figure 7: Adding New App

3.0 Reference Documents

Refer to the following documents to know the integration procedure in the same sequence as mentioned: