@ -4,6 +4,9 @@ You can configure a default principal key using a global key provider. This key
## Create a default principal key
!!! note
The sample output below is for demonstration purposes only. Be sure to replace the key name and provider with your actual values.
To create a global principal key, run:
```sql
@ -13,6 +16,18 @@ SELECT pg_tde_create_key_using_global_key_provider(
);
```
??? example "Sample output"
```sql
postgres=# SELECT pg_tde_create_key_using_global_key_provider(
'keytest1',
'file-keyring'
);
pg_tde_create_key_using_global_key_provider
---------------------------------------------
(1 row)
```
## Configure a default principal key
To configure a global principal key, run:
@ -24,11 +39,26 @@ SELECT pg_tde_set_default_key_using_global_key_provider(
);
```
??? example "Sample output"
```sql
postgres=# SELECT pg_tde_set_default_key_using_global_key_provider(
'keytest1',
'file-keyring'
);
pg_tde_set_default_key_using_global_key_provider
--------------------------------------------------
(1 row)
```
## Parameter description
* `key-name` is the name under which the principal key is stored in the provider.
* `global_vault_provider` is the name of the global key provider you previously configured.
!!! note
If no error is reported, the action completed successfully.
## How key generation works
The key material (actual cryptographic key) is auto-generated by `pg_tde` and stored securely by the configured provider.
@ -36,22 +66,6 @@ The key material (actual cryptographic key) is auto-generated by `pg_tde` and st
!!! note
This process sets the **default principal key for the entire server** . Any database without a key explicitly configured will fall back to this key.
## Example
This example is for testing purposes only. Replace the key name and provider name with your values:
```sql
SELECT pg_tde_create_key_using_global_key_provider(
'test-db-master-key',
'file-vault'
);
SELECT pg_tde_set_key_using_global_key_provider(
'test-db-master-key',
'file-vault'
);
```
## Next steps
[Validate Encryption with pg_tde :material-arrow-right: ](../test.md ){.md-button}