You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: product_docs/docs/tde/15/secure_key/key_store/entrust/index.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,4 +6,4 @@ deepToC: true
6
6
7
7
## Configuration guide
8
8
9
-
See the [EDB Postgres and Entrust KeyControl](https://www.entrust.com/sites/default/files/2024-03/edb-postgres-and-entrust-keycontrol-ig.pdf) integration guide for installation, configuration and usage instructions (including key rotation).
9
+
See the [EDB Postgres and Entrust KeyControl](https://www.entrust.com/sites/default/files/2024-03/edb-postgres-and-entrust-keycontrol-ig.pdf) integration guide for installation, configuration, and usage instructions, including key rotation.
Copy file name to clipboardExpand all lines: product_docs/docs/tde/15/secure_key/key_store/thales/index.mdx
+3-3
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,8 @@ description: Learn how to secure your encryption key with a Thales CipherTrust M
4
4
deepToC: true
5
5
---
6
6
7
-
You can configure TDE to use an external key from Thales CipherTrust Manager to wrap the data encryption key with a key from the Thales key store. You can either use `pykmip`, or the Thales REST API to perform the cryptographic operations of the integration.
7
+
You can configure TDE to use an external key from Thales CipherTrust Manager to wrap the data encryption key with a key from the Thales key store. You can use either pykmip or the Thales REST API to perform the cryptographic operations of the integration.
8
8
9
-
- To use the Python library `pykmip` for cryptographic operations with Thales CipherTrust Manager, see [Using pykmip](/partner_docs/ThalesCipherTrustManager/05-UsingThalesCipherTrustManager/) in the [Implementing Thales CipherTrust Manager](/partner_docs/ThalesCipherTrustManager/) documentation for instructions. `pykmip` is a Python library that implements the KMIP industry standard for key management operations.
9
+
- To use the Python library pykmip for cryptographic operations with Thales CipherTrust Manager, see [Using pykmip](/partner_docs/ThalesCipherTrustManager/05-UsingThalesCipherTrustManager/) in the [Implementing Thales CipherTrust Manager](/partner_docs/ThalesCipherTrustManager/) documentation for instructions. pykmip is a Python library that implements the KMIP industry standard for key management operations.
10
10
11
-
- To use Thales REST API for cryptographic operations with Thales CipherTrust Manager, [install the EDB TDE Thales REST API client](installing_thales_client) and then [configure it for usage with TDE](/tde/latest/secure_key/key_store/thales/thales_restapi). The REST API allows operations to directly connect to Thales CipherTrust, bypassing other intermediate protocols.
11
+
- To use the Thales REST API for cryptographic operations with Thales CipherTrust Manager, [install the EDB TDE Thales REST API client](installing_thales_client) and then [configure it for use with TDE](/tde/latest/secure_key/key_store/thales/thales_restapi). The REST API allows operations to directly connect to Thales CipherTrust, bypassing other intermediate protocols.
Copy file name to clipboardExpand all lines: product_docs/docs/tde/15/secure_key/key_store/thales/thales_restapi.mdx
+24-39
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn how to secure your encryption key with a Thales management ke
5
5
deepToC: true
6
6
---
7
7
8
-
You can configure TDE to use an external key from Thales CipherTrust Manager to wrap the data encryption key. This integration uses Thales REST API to allow cryptographic operations by directly connecting to Thales CipherTrust Manager, bypassing other intermediate protocols.
8
+
You can configure TDE to use an external key from Thales CipherTrust Manager to wrap the data encryption key. This integration uses the Thales REST API to allow cryptographic operations by directly connecting to Thales CipherTrust Manager, bypassing other intermediate protocols.
9
9
10
10
To implement this integration, EDB provides two scripts that simplify processes:
11
11
@@ -29,8 +29,8 @@ The configuration process consists in the following steps:
29
29
30
30
## Prerequisites
31
31
32
-
- Ensure you have Python3 installed. You can check with `python3 --version`. Otherwise, [install it](https://www.python.org/downloads/).
33
-
- Ensure your Python3 installation includes the base64 encode and decode library (included by default).
32
+
- Ensure you have Python3 installed. You can check to see if it's installed with `python3 --version`. If it's not installed, [install it](https://www.python.org/downloads/).
33
+
- Ensure your Python3 installation includes the base64 encode and decode library, which is included by default.
34
34
- Install the [/jq command line JSON parser](https://jqlang.org/).
35
35
36
36
## Installing the EDB TDE Thales REST API client packages
@@ -41,45 +41,31 @@ See [Installing EDB TDE Thales REST](/tde/latest/secure_key/key_store/thales/ins
41
41
42
42
## Creating a certificate for authentication
43
43
44
-
Create a Certificate Signing Request (CSR) and then provide that CSR to a Certificate Authority (CA), so it can generate a certificate.
44
+
Create a certificate signing request (CSR). Then provide that CSR to a certificate authority (CA) so it can generate a certificate.
45
45
46
46
1. Access your Thales CipherTrust Manager instance.
47
47
48
-
1.Navigate to the **CSR tool** under**CA**:
48
+
1.Under **CA**, select**CSR Tool**.
49
49
50
-

51
-
52
-
1. Create a CSR. Ensure you select the RSA option, `2048` size and then select **Create**:
53
-
54
-

50
+
1. Create a CSR. Select the RSA algorithm and set the size to 2048. Select **Create**.
55
51
56
-
1. In the same pop-up window, after the certificate has been created, select **save csr** and **save private key** to download a `CSR.pem` and `key.pem` file.
57
-
58
-

59
-
60
-
1. Provide a CSR to a certificate authority (CA) so it can generate a certificate. Navigate to **CA** > **Local**.
52
+
1. To download a `CSR.pem` and `key.pem` file, after the certificate is created, in the same dialog box, select **save csr** and **save private key** .
61
53
62
-

54
+
1. Provide a CSR to a CA so it can generate a certificate. Under **CA**, select **Local**.
63
55
64
-
1. Select a CA. You can use the default local CA provided by CipherTrust. Then, select **Upload CSR**:
56
+
1. Select a CA. You can use the default local CA provided by CipherTrust. Then select **Upload CSR**.
65
57
66
-

67
-
68
-
1. Enter the previously assigned **Display name**, paste the contents of the downloaded `CSR.pem` file and select **Issue Certificate**:
69
-
70
-

58
+
1. Enter the previously assigned **Display name**, paste the contents of the downloaded `CSR.pem` file, and select **Issue Certificate**.
71
59
72
60
1. Download the `Certificate.pem` certificate:
73
61
74
62

75
63
76
-
1. Update your user configuration to allow certificate-based login. Navigate to **Access Management** >**Users** and select your user.
64
+
1. Update your user configuration to allow certificate-based login. Under **Access Management**, select**Users** and select your user.
77
65
78
-
1. Under **LOGIN**, enable **Allow user to login using certificate**, and enter a Certificate Subject Distinguished Name with `CN=` prefix:
66
+
1. Under **LOGIN**, enable **Allow user to login using certificate**, and enter a value in **Certificate Subject Distinguished Name**. Use a `CN=` prefix.
79
67
80
-

81
-
82
-
You should now have downloaded three pem files: `CSR.pem`, `key.pem` and `Certificate.pem`. Ensure you store them in an accessible location.
68
+
You downloaded three .pem files: `CSR.pem`, `key.pem`, and `Certificate.pem`. Store them in an accessible location.
83
69
84
70
## Creating an AES key on Thales CipherTrust Manager
85
71
@@ -104,13 +90,13 @@ To create an AES 256 key, you can execute the downloaded script, which ensures t
104
90
export SERVER_USER='user'
105
91
```
106
92
107
-
1.Execute `edb_tde_createkey.py` to create they key. To execute it correctly, you need:
93
+
1.To create they key, execute `edb_tde_createkey.py`. To execute it correctly, you need:
108
94
109
-
- A key name to identify your key. Replace `key_name` in the example with an identifiable name of your choice.
95
+
- A key name to identify your key. Replace `<key_name>` in the example with an identifiable name of your choice.
110
96
111
-
- The `uid` of the user that created the certificate. You can find the user `uid` in the Thales CipherTrust Manager, under**Access Management** >**Users**, select your user. The user `uid` information is a sequence of digits and letters, e.g.`local|285xxxfb-xxxb-4xxx-9339-2d58xxx60ae6`.
97
+
- The uid of the user that created the certificate. You can find the user uid in the Thales CipherTrust Manager. Under**Access Management**, select**Users**, then select your user. The user uid information is a sequence of digits and letters, for example,`local|285xxxfb-xxxb-4xxx-9339-2d58xxx60ae6`.
112
98
113
-
- The path to the `edb_tde_createkey.py` script installed by the packages. In RPM-based systems, the default location is `/usr/edb/tde/rest/client/edb_tde_createkey.py` and in Debian, `/usr/lib/edb/tde/rest/client/edb_tde_createkey.py`.
99
+
- The path to the `edb_tde_createkey.py` script installed by the packages. In RPM-based systems, the default location is `/usr/edb/tde/rest/client/edb_tde_createkey.py`. In Debian, it's`/usr/lib/edb/tde/rest/client/edb_tde_createkey.py`.
114
100
115
101
Replace these values in the example:
116
102
@@ -119,16 +105,16 @@ To create an AES 256 key, you can execute the downloaded script, which ensures t
@@ -140,7 +126,7 @@ To create an AES 256 key, you can execute the downloaded script, which ensures t
140
126
```
141
127
142
128
!!!note
143
-
Note down the key `id` (first line of output), as you will need it later.
129
+
Record the key `id` (first line of output), as you'll need it later.
144
130
145
131
Alternatively, you can create a key manually using the Thales CipherTrust Manager portal.
146
132
@@ -156,11 +142,11 @@ Next, export the encryption and decryption commands as environment variables for
156
142
157
143
1. Set the wrapping and unwrapping commands that will perform encryption and decryption. To set them correctly, you need:
158
144
159
-
- The `key_name` you assigned to the key during creation.
145
+
- The `key_name`value you assigned to the key during creation.
160
146
161
147
- The AES key `id`, which you can find in the output of the key creation command or look up in the Thales CipherTrust Manager portal.
162
148
163
-
- The path to the `edb_tde_crypto.py` script installed by the packages. In RPM-based systems, the default location is `/usr/edb/tde/rest/client/edb_tde_crypto.py`, and in Debian, `/usr/lib/edb/tde/rest/client/edb_tde_crypto.py`.
149
+
- The path to the `edb_tde_crypto.py` script installed by the packages. In RPM-based systems, the default location is `/usr/edb/tde/rest/client/edb_tde_crypto.py`. In Debian, it's`/usr/lib/edb/tde/rest/client/edb_tde_crypto.py`.
164
150
165
151
Replace these values in the example:
166
152
@@ -169,5 +155,4 @@ Next, export the encryption and decryption commands as environment variables for
1. You can now [initialize a TDE-enabled database cluster](/tde/latest/initdb_tde_options/#option---data-encryption-or--y) with `initdb --data-encryption`. TDE will fall back on the exported `PGDATAKEYWRAPCMD` and `PGDATAKEYUNWRAPCMD` commands for the wrapping and unwrapping of data encryption keys.
173
-
158
+
1. You can now [initialize a TDE-enabled database cluster](/tde/latest/initdb_tde_options/#option---data-encryption-or--y) with `initdb --data-encryption`. TDE falls back on the exported `PGDATAKEYWRAPCMD` and `PGDATAKEYUNWRAPCMD` commands for wrapping and unwrapping data encryption keys.
0 commit comments