# Entrust HSM Encryption

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FAonpf569nhvrzoqZnn2v%2Fksm-entrust.jpg?alt=media&#x26;token=77ce0762-25e3-4b11-b6bd-62e4ec79b39b" alt=""><figcaption></figcaption></figure>

Keeper Secrets Manager integrates with Entrust HSM in order to provide encryption for Keeper Secrets Manager configuration files.  With this integration, you can protect connection details on your machine while taking advantage of Keeper's zero-knowledge encryption of all you secret credentials.

## Features

* Encrypt and Decrypt your KSM configuration files with Entrust HSM
* Protect against unauthorized access to your Secrets Manager connections
* Requires only minor change to code for immediate protection.  Works with all KSM Python SDK functionality

## Prerequisites

* Supports the [Python Secrets Manager SDK](https://docs.keeper.io/en/keeperpam/secrets-manager/developer-sdk-library/python-sdk)
* The Python module needs to be built as a nShield native application
  * Using Python (v3.8.5) and nfpython modules from SDK ISO image from Entrust nShield software (Security World 12.80 or later)
* Virtualenv is recommended&#x20;

## Setup

### 1. Create and Configure Virtualenv

This step is optional, but recommended for development

{% tabs %}
{% tab title="Linux" %}
Create a virtualenv environment to work in

`/opt/nfast/python3/bin/python3 -m venv --copies venv`

Activate the virtualenv environment before starting development

`. venv/bin/activate`&#x20;
{% endtab %}

{% tab title="Windows" %}
Create a virtualenv environment to work in

`c:\Program Files\nCipher\nfast\python3\python --copies -m venv venv`

&#x20;

Activate the virtualenv environment before starting development

`venv\Scripts\activate.ps1`
{% endtab %}
{% endtabs %}

### 2. Install KSM Storage and nfpython Modules&#x20;

The Secrets Manager HSM modules are located in the Keeper Secrets Manager storage module which can be installed using pip

```
pip3 install keeper-secrets-manager-storage
```

The nfpython package also needs to be installed in order to utilize the Entrust HSM.  This package is installed as part of the nShield package with your Entrust installation.

In Linux:

```
pip install /opt/nfast/python3/additional-packages/nfpython*.whl 
```

In Windows:

```
pip install c:\Program Files\nCipher\nfast\python3\additional-packages\nfpython*.whl
```

### 3. Add Entrust HSM Storage to Your Code

Use the `HsmNfastKeyValueStorage` as your Secrets Manager storage in the `SecretsManager` constructor.&#x20;

The `HsmNfastKeyValueStorage` requires the method and identity ("simple" and "ksmkey" respectively in this example).

{% code title="entrust\_hsm\_example.py" %}

```python
from keeper_secrets_manager_core import SecretsManager
from keeper_secrets_manager_hsm.storage_hsm_nfast import HsmNfastKeyValueStorage

config=HsmNfastKeyValueStorage('simple', 'ksmkey', 'client-config.json')

secrets_manager = SecretsManager(config=config, verify_ssl_certs=True)

all_records = secrets_manager.get_secrets()

```

{% endcode %}

{% hint style="success" %}
You're all set and ready to use Secrets Manager with Entrust NShield HSM
{% endhint %}

## Using Secrets Manager with Entrust HSM

Once setup, the Secrets Manager Entrust integration supports all Secrets Manager SDK functionality.  Your code will need to be able to access the nShield HSM in order to manage the decryption of the configuration file when run.

{% hint style="info" %}
Check out the [KSM SDKs documentation](https://docs.keeper.io/en/keeperpam/secrets-manager/developer-sdk-library) for more examples and functionality
{% endhint %}

### Create an Encryption Key for Testing

In order to test encryption with the Entrust nShield HSM, use the following command:

Replace "ksmkey" in these examples with the identity in your HSM.

in Linux:

```bash
opt/nfast/bin/generatekey -b simple protect=module type=AES size=256 ident=ksmkey
```

in Windows:

{% code overflow="wrap" %}

```bash
c:\Program Files\nShield\nfast\bin\generatekey -b simple protect=module type=AES size=256 ident=ksmkey
```

{% endcode %}