mirror of
https://github.com/supabase/supabase.git
synced 2026-05-11 10:49:48 +08:00
65c6929414
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Updates verbiage throughout docs to use postgres over postgresql. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated terminology throughout documentation, guides, and resources for consistent product naming across all user-facing materials, including page titles, descriptions, and reference documentation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
36 lines
2.2 KiB
Plaintext
36 lines
2.2 KiB
Plaintext
---
|
||
id: 'pgsodium'
|
||
title: 'pgsodium (pending deprecation): Encryption Features'
|
||
description: 'Encryption library for Postgres'
|
||
---
|
||
|
||
Supabase DOES NOT RECOMMEND any new usage of [`pgsodium`](https://github.com/michelp/pgsodium).
|
||
|
||
The [`pgsodium`](https://github.com/michelp/pgsodium) extension is expected to go through a deprecation cycle in the near future. We will reach out to owners of impacted projects to assist with migrations away from [`pgsodium`](https://github.com/michelp/pgsodium) once the deprecation process begins.
|
||
|
||
<Admonition type="note">
|
||
|
||
The [Vault extension](/docs/guides/database/vault) won’t be impacted. Its internal implementation will shift away from pgsodium, but the interface and API will remain unchanged.
|
||
|
||
</Admonition>
|
||
|
||
[`pgsodium`](https://github.com/michelp/pgsodium) is a Postgres extension which provides SQL access to [`libsodium`'s](https://doc.libsodium.org/) high-level cryptographic algorithms.
|
||
|
||
Supabase previously documented two features derived from pgsodium. Namely [Server Key Management](https://github.com/michelp/pgsodium#server-key-management) and [Transparent Column Encryption](https://github.com/michelp/pgsodium#transparent-column-encryption). At this time, we do not recommend using either on the Supabase platform due to their high level of operational complexity and misconfiguration risk.
|
||
|
||
Note that Supabase projects are encrypted at rest by default which likely is sufficient for your compliance needs e.g. SOC2 & HIPAA.
|
||
|
||
## Get the root encryption key for your Supabase project
|
||
|
||
Encryption requires keys. Keeping the keys in the same database as the encrypted data would be unsafe. For more information about managing the `pgsodium` root encryption key on your Supabase project see **[encryption key location](/docs/guides/database/vault#encryption-key-location)**. This key is required to decrypt values stored in [Supabase Vault](/docs/guides/database/vault) and data encrypted with Transparent Column Encryption.
|
||
|
||
## Resources
|
||
|
||
- [Supabase Vault](/docs/guides/database/vault)
|
||
- Read more about Supabase Vault in the [blog post](/blog/vault-now-in-beta)
|
||
- [Supabase Vault on GitHub](https://github.com/supabase/vault)
|
||
|
||
## Resources
|
||
|
||
- Official [`pgsodium` documentation](https://github.com/michelp/pgsodium)
|