docs: document more ways to secure the data api (#27756)

Document ways to increase the security of Data API, including:

- Disabling it entirely
- Exposing a custom schema instead of the `public` schema

Also found a duplicated link in the nav for CLS, so removed it.
This commit is contained in:
Charis authored and GitHub committed 2024-07-03 12:32:16 +00:00
1 parent efc5ee6ec4
commit 161ba3da32
3 files changed
+63 -4

No files matched your search

@@ -734,6 +734,10 @@ export const database: NavMenuConstant = {
name: 'Column Level Security',
url: '/guides/database/postgres/column-level-security',
},
{
name: 'Hardening the Data API',
url: '/guides/database/hardening-data-api',
},
{
name: 'Custom Claims & RBAC',
url: '/guides/database/postgres/custom-claims-and-role-based-access-control-rbac',
@@ -747,10 +751,6 @@ export const database: NavMenuConstant = {
name: 'Superuser Access and Unsupported Operations',
url: '/guides/database/postgres/roles-superuser',
},
{
name: 'Column level privileges',
url: '/guides/database/postgres/column-level-security',
},
],
},
{
@@ -0,0 +1,57 @@
---
title: 'Hardening the Data API'
---
Your database's automatically generated Data API exposes the `public` schema by default. If your `public` schema is used by other tools as a default space, you might want to lock down this schema. This helps prevent accidental exposure of data that's automatically added to `public`.
There are two levels of security hardening for the Data API:
- Disabling the Data API entirely. This is recommended if you _never_ need to access your database via Supabase client libraries or the REST and GraphQL endpoints.
- Removing the `public` schema from the Data API and replacing it with a custom schema (such as `api`).
## Disabling the Data API
You can disable the Data API entirely if you never intend to use the Supabase client libraries or the REST and GraphQL data endpoints. For example, if you only access your database via a direct connection on the server, disabling the Data API gives you the greatest layer of protection.
1. Go to [API Settings](/dashboard/project/_/settings/api) in the Supabase Dashboard.
1. Under **Data API Settings**, toggle **Enable Data API** off.
## Exposing a custom schema instead of `public`
If you want to use the Data API but with increased security, you can expose a custom schema instead of `public`. By not using `public`, which is often used as a default space and has laxer default permissions, you get more conscious control over your exposed data.
Any data, views, or functions that should be exposed need to be deliberately put within your custom schema (which we will call `api`), rather than ending up there by default.
### Step 1: Remove `public` from exposed schemas
1. Go to [**API Settings**](/dashboard/project/_/settings/api) in the Supabase Dashboard.
1. Under **Data API Settings**, remove `public` from **Exposed schemas**. Also remove `public` from **Extra search path**.
1. Click **Save**.
1. Go to [**Database Extensions**](/dashboard/project/_/database/extensions) and disable the `pg_graphql` extension.
### Step 2: Create an `api` schema and expose it
1. Connect to your database. You can use `psql`, the [Supabase SQL Editor](/dashboard/project/_/sql), or the Postgres client of your choice.
1. Create a new schema named `api`:
```sql
create schema if not exists api;
```
1. Grant the `anon` and `authenticated` roles usage on this schema.
```sql
grant usage on schema api to anon, authenticated;
```
1. Go to [API Settings](/dashboard/project/_/settings/api) in the Supabase Dashboard.
1. Under **Data API Settings**, add `api` to **Exposed schemas**. Make sure it is the first schema in the list, so that it will be searched first by default.
1. Under these new settings, `anon` and `authenticated` can execute functions defined in the `api` schema, but they have no automatic permissions on any tables. On a table-by-table basis, you can grant them permissions. For example:
```sql
grant select on table api.<your_table> to anon;
grant select, insert, update, delete on table api.<your_table> to authenticated;
```
@@ -27,5 +27,7 @@ Unlike your anon key, your **service role key** is **never** safe to expose beca
Supabase and Postgres provide you with multiple ways to manage security, including but not limited to Row Level Security. See the Access and Security pages for more information:
- [Row Level Security](/docs/guides/database/postgres/row-level-security)
- [Column Level Security](/docs/guides/database/postgres/column-level-security)
- [Hardening the Data API](/docs/guides/database/hardening-data-api)
- [Managing Postgres roles](/docs/guides/database/postgres/roles)
- [Managing secrets with Vault](/docs/guides/database/vault)