Skip to content
Database

Row Level Security

Secure your data using Postgres Row Level Security.

Postgres Row Level Security (RLS) gives you granular authorization rules that run inside the database.

Use the guide in three parts:

Read the first section when you're deciding how to model access. Go directly to the second section when you're ready to secure a table.

Understand Row Level Security#

What a policy does#

Policies are Postgres's rule engine. Each policy is attached to a table, and the policy is executed every time a table is accessed.

Think of a policy as adding a WHERE clause to every query. A policy like this:

create policy "Individuals can view their own todos."
on todos for select
to authenticated
using ( (select auth.uid()) = user_id );

That policy translates to this whenever a user selects from the todos table:

select *
from todos
where auth.uid() = todos.user_id;
-- Policy is implicitly added.

You write RLS rules in SQL, so a rule can express whatever access logic your app needs. Because RLS is a Postgres primitive, it also protects your data when it is reached through third-party tooling, which is what makes it "defense in depth". Combine RLS with Supabase Auth for end-to-end user security from the browser to the database.

Grants and policies#

Postgres runs two checks before a client touches a table. Grants decide whether a role can run an operation on the table at all. Policies decide which rows that operation applies to. Set both for every table you expose.

On existing projects, a new table in public starts with every privilege already granted to all three roles:

RoleGranted automaticallyWhat it should keep
anonselect, insert, update, deleteOnly what signed-out visitors are meant to read
authenticatedselect, insert, update, deleteOnly the operations your app exposes to signed-in users
service_roleselect, insert, update, deleteFull access. It bypasses RLS, so keep it server-side

Adding policies doesn't take those grants back. A table protected only by policies still hands anon an insert path if you never revoke the grant.

Not every project grants these automatically. See Default privileges. Grant each role only the operations it needs.

A missing grant raises a 42501 error before any policy runs. When a request fails that your policy should allow, check the grants before you change the policy. To set them, see Enable RLS and set the grants.

Authenticated and unauthenticated roles#

Supabase maps every request to one of the roles:

  • anon: an unauthenticated request (the user is not logged in)
  • authenticated: an authenticated request (the user is logged in)

These are Postgres Roles. You can use these roles within your Policies using the TO clause:

create policy "Profiles are viewable by everyone"
on profiles for select
to authenticated, anon
using ( true );
-- OR
create policy "Public profiles are viewable only by authenticated users"
on profiles for select
to authenticated
using ( true );

A policy that reads to anon using ( true ) grants every unauthenticated visitor read access to every row the role can already reach through grants. Use it only for data that is meant to be public.

Views and RLS#

Views bypass RLS by default because they are usually created with the postgres user. This is a feature of Postgres, which automatically creates views with security definer. A view over a protected table hands out every row its policies were meant to withhold, so a view needs the same attention as a table. To create one safely, see Expose a view safely.

Secure a table with RLS#

Follow these steps for every table in an exposed schema:

  1. Enable RLS and set the grants to match the app.
  2. Write a policy per operation.
  3. Create a .sql file under supabase/tests/ that asserts allow and deny for select, insert, update, and delete, for anon and authenticated.
  4. Run supabase test db and fix what it reports.

Until the suite passes, you don't know whether the policies do what you intended.

Enable RLS and set the grants#

Run these statements in the SQL Editor for a one-off change, or in a migration to keep the change reproducible across environments. Grants and RLS belong in the same migration.

Enable RLS, then set the grants to match what each role does in your app:

  1. Enable RLS on the table.

    alter table public.reports enable row level security;

    Once RLS is enabled, no data is accessible through the API when using a publishable key, until you create policies.

  2. Revoke any existing grants from both client roles.

    revoke all on table public.reports from anon, authenticated;
  3. Grant back only the privileges the role needs.

    -- Signed-in users manage reports. Signed-out visitors get nothing.
    grant select, insert, update, delete on table public.reports to authenticated;
  4. Write the test file for the table, and run the suite.

    supabase test new reports_rls.test
    supabase test db

    Give every table you secure one. The examples below show what goes in the file.

Data that clients read but never write, such as a feed a backend job populates, gets select only. The policy and the test file are part of the same change:

alter table public.announcements enable row level security;
revoke all on table public.announcements from anon, authenticated;
grant select on table public.announcements to anon, authenticated;
create policy "Anyone can read announcements"
on public.announcements for select
to anon, authenticated
using ( true );
-- File: supabase/tests/announcements_rls.test.sql
-- Create: supabase test new announcements_rls.test
-- Run: supabase test db
-- Repeat for every public-read table you secured.
begin;
select plan(10);
insert into announcements (id, body)
values ('33333333-3333-3333-3333-333333333333', 'published');
-- A read has to return the row. lives_ok passes on an empty result.
select ok(
not has_table_privilege('anon', 'public.announcements', 'insert,update,delete'),
'anon holds no write grant on the feed'
);
select ok(
not has_table_privilege('authenticated', 'public.announcements', 'insert,update,delete'),
'authenticated holds no write grant on the feed'
);
set local role anon;
select results_eq(
$$select body from announcements where id = '33333333-3333-3333-3333-333333333333'$$,
array['published'],
'anon reads the feed'
);
select throws_ok(
$$insert into announcements select * from announcements$$,
'42501',
null,
'anon cannot insert into the feed'
);
select throws_ok(
$$update announcements set id = id$$,
'42501',
null,
'anon cannot update the feed'
);
select throws_ok(
$$delete from announcements$$,
'42501',
null,
'anon cannot delete from the feed'
);
set local role authenticated;
select results_eq(
$$select body from announcements where id = '33333333-3333-3333-3333-333333333333'$$,
array['published'],
'authenticated reads the feed'
);
select throws_ok(
$$insert into announcements select * from announcements$$,
'42501',
null,
'authenticated cannot insert into the feed'
);
select throws_ok(
$$update announcements set id = id$$,
'42501',
null,
'authenticated cannot update the feed'
);
select throws_ok(
$$delete from announcements$$,
'42501',
null,
'authenticated cannot delete from the feed'
);
select * from finish();
rollback;

If new tables still receive automatic grants, see Revoke default privileges. To enable RLS automatically on every new table, see Event triggers.

Write a policy for each operation#

Write a separate policy for select, insert, update, and delete. Postgres does not accept multiple operations in one for clause, and a for all policy hides which operation each rule was meant to cover.

These examples use a profiles table where each user manages only their own row:

create table profiles (
id uuid primary key,
user_id uuid references auth.users,
avatar_url text
);
alter table profiles enable row level security;
revoke all on table profiles from anon, authenticated;
grant select, insert, update, delete on table profiles to authenticated;

Supabase provides helper functions that simplify RLS if you are using Supabase Auth. auth.uid() returns the ID of the user making the request.

SELECT policies#

You can specify select policies with the using clause.

create policy "Users can view their own profile."
on profiles for select
to authenticated
using ( (select auth.uid()) = user_id );

INSERT policies#

You can specify insert policies with the with check clause. The with check expression ensures that any new row adheres to the policy constraints, so a user cannot create a row that belongs to someone else.

create policy "Users can create their own profile."
on profiles for insert
to authenticated
with check ( (select auth.uid()) = user_id );

UPDATE policies#

You can specify update policies by combining the using and with check expressions. The using clause decides which existing rows can be updated. The with check clause decides what the resulting row is allowed to look like, which stops a user from reassigning user_id to someone else.

create policy "Users can update their own profile."
on profiles for update
to authenticated
using ( (select auth.uid()) = user_id ) -- checks the existing row
with check ( (select auth.uid()) = user_id ); -- checks the resulting row

If no with check expression is defined, the using expression decides both which rows are visible and which new rows are allowed.

DELETE policies#

You can specify delete policies with the using clause.

create policy "Users can delete their own profile."
on profiles for delete
to authenticated
using ( (select auth.uid()) = user_id );

Policy tests#

When you adapt those four policies to a table, add this file for that table. The path is supabase/tests/<table>_rls.test.sql. For a table users share, also assert that a member who is not the owner can perform the operations its policies allow, and that a non-member cannot.

-- File: supabase/tests/profiles_rls.test.sql
-- Create: supabase test new profiles_rls.test
-- Run: supabase test db
-- One file per table you enabled RLS on. Name that table in the assertions.
-- Do not create a table only the tests use.
begin;
select plan(14);
insert into auth.users (id, email)
values
('11111111-1111-1111-1111-111111111111', 'owner@example.com'),
('22222222-2222-2222-2222-222222222222', 'other@example.com');
-- anon holds no grant, so the request stops before any policy runs.
set local role anon;
select throws_ok(
$$select * from profiles$$,
'42501',
null,
'anon cannot read profiles'
);
select throws_ok(
$$insert into profiles (id, user_id, avatar_url)
values (
gen_random_uuid(),
'11111111-1111-1111-1111-111111111111',
'anon.png'
)$$,
'42501',
null,
'anon cannot create a profile'
);
select throws_ok(
$$update profiles set avatar_url = 'anon.png'$$,
'42501',
null,
'anon cannot update profiles'
);
select throws_ok(
$$delete from profiles$$,
'42501',
null,
'anon cannot delete profiles'
);
-- The owner writes their own row. returning proves the row changed.
set local role authenticated;
set local request.jwt.claim.sub = '11111111-1111-1111-1111-111111111111';
select results_eq(
$$insert into profiles (id, user_id, avatar_url)
values (
gen_random_uuid(),
'11111111-1111-1111-1111-111111111111',
'owner.png'
)
returning avatar_url$$,
array['owner.png'],
'the owner creates their own profile'
);
select results_eq(
$$select avatar_url from profiles where user_id = '11111111-1111-1111-1111-111111111111'$$,
array['owner.png'],
'the owner reads their own profile'
);
select results_eq(
$$update profiles set avatar_url = 'updated.png'
where user_id = '11111111-1111-1111-1111-111111111111'
returning avatar_url$$,
array['updated.png'],
'the owner updates their own profile'
);
-- A signed-in stranger holds the grant, so the policy is what stops them.
set local request.jwt.claim.sub = '22222222-2222-2222-2222-222222222222';
select throws_ok(
$$insert into profiles (id, user_id, avatar_url)
values (
gen_random_uuid(),
'11111111-1111-1111-1111-111111111111',
'stolen.png'
)$$,
'42501',
null,
'another user cannot create a profile for the owner'
);
select is_empty(
$$select * from profiles$$,
'another user reads no profiles'
);
select is_empty(
$$update profiles set avatar_url = 'stolen.png' returning avatar_url$$,
'another user updates no profiles'
);
-- Matching no rows is not proof on its own. Pair every denied write with a
-- check that the row it targeted is intact. Scope it to that row: a suite
-- that asserts on everything a role can see breaks once the table holds more.
set local request.jwt.claim.sub = '11111111-1111-1111-1111-111111111111';
select results_eq(
$$select avatar_url from profiles where user_id = '11111111-1111-1111-1111-111111111111'$$,
array['updated.png'],
'the denied update left the owner row intact'
);
set local request.jwt.claim.sub = '22222222-2222-2222-2222-222222222222';
select is_empty(
$$delete from profiles returning avatar_url$$,
'another user deletes no profiles'
);
set local request.jwt.claim.sub = '11111111-1111-1111-1111-111111111111';
select results_eq(
$$select avatar_url from profiles where user_id = '11111111-1111-1111-1111-111111111111'$$,
array['updated.png'],
'the denied delete left the owner row intact'
);
-- Owner delete last so earlier cases still have a row to assert against.
set local request.jwt.claim.sub = '11111111-1111-1111-1111-111111111111';
select results_eq(
$$delete from profiles where user_id = '11111111-1111-1111-1111-111111111111'
returning avatar_url$$,
array['updated.png'],
'the owner deletes their own profile'
);
select * from finish();
rollback;

Match the assertion to how the request is denied. Only two of the three raise an error:

Denied byPostgresAssert with
A missing grantraises 42501throws_ok
A with check violationraises 42501throws_ok
A using clause filtering the row outraises nothing, matches zero rowsis_empty over the statement with returning, then a read proving the target row is intact

Never prove an allowed write with lives_ok. It passes when the write matched zero rows. Add returning and assert the returned value.

Switch role and identity with set local role and set local request.jwt.claim.sub.

Specify roles in your policies#

Always name the role a policy applies to, using the to clause. Instead of this:

create policy "rls_test_select" on rls_test
using ( auth.uid() = user_id );

Use:

create policy "rls_test_select" on rls_test
to authenticated
using ( (select auth.uid()) = user_id );

This prevents the policy ( (select auth.uid()) = user_id ) from running for any anon users, since the execution stops at the to authenticated step.

Run the test suite#

The files above live under supabase/tests/ and run through pgTAP. Create them with supabase test new <table>_rls.test, and run them with supabase test db.

supabase-test-helpers adds tests.create_supabase_user(), tests.authenticate_as(), and tests.rls_enabled(). See Advanced pgTAP testing and Testing your database.

Add indexes#

Add an index on every column your policies filter on. Postgres evaluates the policy against each candidate row, so an unindexed filter column turns a read into a sequential scan. For a policy like this:

create policy "rls_test_select" on test_table
to authenticated
using ( (select auth.uid()) = user_id );

You can add an index like:

create index userid
on test_table
using btree (user_id);

A column counts as indexed only when it comes first in a btree index. Postgres can't use a multi-column index to filter on a column that isn't the leading one, so a composite primary key indexes its first column and no others. A membership table keyed on (team_id, user_id) has no index on user_id:

create table team_members (
team_id uuid references teams (id),
user_id uuid references auth.users (id),
primary key (team_id, user_id)
);
-- The primary key covers team_id. A policy filtering on user_id needs its own index.
create index team_members_user_id_idx
on team_members
using btree (user_id);

Call functions with select#

You can use select statement to improve policies that use functions. For example, instead of this:

create policy "rls_test_select" on test_table
to authenticated
using ( auth.uid() = user_id );

You can do:

create policy "rls_test_select" on test_table
to authenticated
using ( (select auth.uid()) = user_id );

This method works well for JWT functions like auth.uid() and auth.jwt() as well as security definer Functions. Wrapping the function causes an initPlan to be run by the Postgres optimizer, which allows it to "cache" the results per-statement, rather than calling the function on each row.

Indexing the filter columns and wrapping helper calls keeps policies fast as a table grows. For the measured impact, and for tuning beyond these two rules, see Row Level Security performance.

Expose a view safely#

In Postgres 15 and above, make a view obey the RLS policies of its underlying tables when invoked by anon and authenticated by setting security_invoker = true.

create view <VIEW_NAME>
with(security_invoker = true)
as select <QUERY>

In older versions of Postgres, protect your views by revoking access from the anon and authenticated roles, or by putting them in an unexposed schema.

RLS reference#

These are the functions and patterns available inside a policy expression.

Helper functions#

Supabase provides some helper functions that make it easier to write policies.

auth.uid()#

Returns the ID of the user making the request.

auth.jwt()#

Returns the JWT of the user making the request. Anything that you store in the user's raw_app_meta_data column or the raw_user_meta_data column will be accessible using this function. It's important to know the distinction between these two:

  • raw_user_meta_data - can be updated by the authenticated user using the supabase.auth.update() function. It is not a good place to store authorization data.
  • raw_app_meta_data - cannot be updated by the user, so it's a good place to store authorization data.

The auth.jwt() function is extremely versatile. For example, if you store some team data inside app_metadata, you can use it to determine whether a particular user belongs to a team. For example, if this was an array of IDs:

create policy "User is in team"
on my_table
to authenticated
using ( team_id in (select auth.jwt() -> 'app_metadata' -> 'teams'));

MFA#

The auth.jwt() function can be used to check for Multi-Factor Authentication. For example, you could restrict a user from updating their profile unless they have at least 2 levels of authentication (Assurance Level 2):

create policy "Restrict updates."
on profiles
as restrictive
for update
to authenticated using (
(select auth.jwt()->>'aal') = 'aal2'
);

Use security definer functions#

A "security definer" function runs using the same role that created the function. This means that if you create a role with a superuser (like postgres), then that function will have bypassrls privileges. For example, if you had a policy like this:

create policy "rls_test_select" on test_table
to authenticated
using (
exists (
select 1 from roles_table
where (select auth.uid()) = user_id and role = 'good_role'
)
);

We can instead create a security definer function which can scan roles_table without any RLS penalties:

create function private.has_good_role()
returns boolean
language plpgsql
security definer -- will run as the creator
set search_path = '' -- every name inside must be schema-qualified
as $$
begin
return exists (
select 1 from public.roles_table
where (select auth.uid()) = user_id and role = 'good_role'
);
end;
$$;
-- Update our policy to use this function:
create policy "rls_test_select"
on test_table
to authenticated
using ( (select private.has_good_role()) );

Add member and non-member cases to that table's file under supabase/tests/. A member who is not the owner must be allowed; a non-member must not.

Set search_path = '' on every security definer function and schema-qualify the names inside it. Without a pinned search_path, a caller can point an unqualified name at their own object and run it with the function owner's privileges.

Avoid recursive policies#

Two tables whose policies read each other never resolve. Postgres raises 42P17, infinite recursion detected in policy for relation, and the query fails for every role the policies apply to.

Sharing features produce this shape. A policy on lists checks list_members to find who the list is shared with, and a policy on list_members checks lists to find who owns it:

-- Reject: each policy reads the table the other one protects.
create policy "members read lists" on lists for select
to authenticated
using (
exists (
select 1 from list_members m
where m.list_id = lists.id and m.user_id = (select auth.uid())
)
);
create policy "members read membership" on list_members for select
to authenticated
using (
exists (
select 1 from lists l
where l.id = list_members.list_id and l.owner_id = (select auth.uid())
)
);

Break the cycle with a security definer function. It reads the membership table as its owner, so the second policy never runs and the cycle is broken:

create schema if not exists private;
create function private.user_list_ids()
returns setof uuid
language sql
security definer
set search_path = ''
stable
as $$
select list_id from public.list_members
where user_id = (select auth.uid())
$$;
revoke execute on function private.user_list_ids() from public;
grant usage on schema private to authenticated;
grant execute on function private.user_list_ids() to authenticated;
create policy "members read lists" on lists for select
to authenticated
using ( id in (select private.user_list_ids()) );
create policy "members read membership" on list_members for select
to authenticated
using ( list_id in (select private.user_list_ids()) );

The function filters on (select auth.uid()), so it returns only the caller's lists. A member who doesn't own the list still reads it, and a non-member reads nothing.

This works because the function runs as its owner, and a security definer function only skips RLS when its owner can. On Supabase the owner is postgres, which has bypassrls. A function owned by a role without bypassrls, or reading a table set to force row level security, evaluates the membership policy again and stays recursive.

Bypassing Row Level Security#

Use a secret key for administrative tasks that need to bypass RLS. A secret key authorizes access through the service_role Postgres role, which has the bypassrls attribute. Never use a secret key in the browser or expose it to customers.

The JWT-based service_role key is a legacy alternative. Prefer a secret key where possible.

You can also create new Postgres Roles which can bypass Row Level Security using the "bypass RLS" privilege:

alter role "role_name" with bypassrls;

This can be useful for system-level access. Never share login credentials for any Postgres Role with this privilege.