Use the procedure below to set up a CSP Vault for Databases test environment for Microsoft SQL Server. 

Prerequisites

Before you begin, make sure you have completed the following tasks:

To set up a CSP Vault test environment

  1. Log in to the Cryptographic Security Platform Vault for Databases webGUI using an account with Cloud Admin privileges.
  2. (optional) Create a CSP cluster node mapping. For more information, see: Creating a Cluster Node Mapping for CSP Vault for Databases.

    A CSP cluster node mapping helps Entrust client on the database node to failover in case one of the CSP node fails.

  3. Download the TDE script bundle. For more information, see: Downloading the TDE Script Bundle for Microsoft SQL Server.

    The prefix specified when downloading the TDE scripts is stored in entrust.conf as the DBSet name. The DBSet name does not represent an actual object. It serves as the base name for generating the associated CVMSet and KeySet names. For example, if the DBSet name is sqlserver, the scripts create the KeySet sqlserver_keyset and the CVMSet sqlserver_cvmset.  You can change the DBSet name in entrust.conf after downloading the TDE scripts.

    The CVMSet and KeySet names must be the same in the production and test environments. When setting up the connection between the test database server and test CSP Vault for Databases, use the same DBSet name in entrust.conf as in the production environment.

  4. Copy the TDE script bundle to the test Microsoft SQL server node.

    The bundle is a ZIP file named <name>.zip, where <name> is the name you specified when downloading the bundle in To set up a CSP Vault test environment. For example, mssql_toi(1).zip.

    The steps below use mssql_toi(1) as an example.

  5. Open your test Microsoft SQL server node.
  6. Navigate to the folder where the TDE scripts are stored.
  7. Unblock the TDE script bundle by running the following PowerShell command:
    Unblock-File -Path "<path-to-your-file>"
  8. Extract the TDE script bundle into the folder by running the following command:
    Unzip -Path "<path-to-your-file>" -DestinationPath "<destination-path>"
    For example:
    Unzip -Path .\mssql.zip -DestinationPath C:\Users\Administrator\mssql

    The bundle contains the following files:

    • check-connection.exe

    • encryptclust.ps1

    • entrust.conf

    • entrust_dbmstudio.ps1

    • htsql ekm_provider.dll

    • open_db_key.ps1

    • precheck.ps1

    • setup.ps1

  9. Verify the CSP Vault-related configuration settings in the entrust.conf file:
    grep kcv entrust.conf

    Note that the terminal displays the IP address of first Microsoft SQL server node because that is the first node in the CSP cluster.

  10. Set up the test Microsoft SQL server node. In PowerShell, run:
    .\setup.ps1 -node first -config .\entrust.conf

    Set up the test Microsoft SQL Server server as the first node (-node first). The test environment uses an independent CSP Vault cluster, so the test server is the first node in that environment and is not an additional node of the production environment.

    The test environment is independent of the production environment. Perform this step as a first-node setup to create the CVM Set and KeySet in the test environment.
  11. At the prompt, enter the password for the vault administrator of the CSP Vault for Databases.
  12. At the prompt, log in to the CSP Vault for Databases as the vault administrator. The setup script creates the KeySet and the CVMset in your CSP Vault for Databases.
  13. At the prompt, verify that the Microsoft SQL server node can communicate with CSP Vault for Databases:
    PS> hcl status and PS> check-connection <Access Token File Path>

    You now have two independent CSP Vault for Databases and Microsoft SQL server environments: a production environment and a test environment.