Skip to content
This repository has been archived by the owner on May 13, 2023. It is now read-only.

Support WALRUS (Postgres RLS) Integration with Realtime Server #56

Closed
w3b6x9 opened this issue Oct 22, 2021 · 2 comments
Closed

Support WALRUS (Postgres RLS) Integration with Realtime Server #56

w3b6x9 opened this issue Oct 22, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@w3b6x9
Copy link
Member

w3b6x9 commented Oct 22, 2021

Feature request

Is your feature request related to a problem? Please describe.

Currently, Realtime server sends all database changes to all connected clients despite Postgres Row Level Security policies. This poses security concerns when developers wish to broadcast database changes containing sensitive data to an authorized subset of connected clients based on tables with RLS enabled and row security policies.

Realtime server will integrate WALRUS (Write Ahead Log Realtime Unified Security), which means there are some changes that lib clients need to make in order to support this new security functionality.

Describe the solution you'd like

The following changes will need to be made:

  • Pass user auth token, if available, as channel params with key user_token when subscribing client to Realtime channel.
  • Update Realtime transformers to pass through changes when they're already arrays.
    Realtime w/ WALRUS will pass Postgres array types as [1, 2, 3], _int4, and ["a", "b", "c"], _text, instead of "{1,2,3}" (_int4/_text) so this can be forwarded without any transformations. However, clients should maintain backward compatibility so they should still be able to handle stringified Postgres array (e.g. "{1,2,3}") cases.

The changes have already been applied to supabase-js and realtime-js and their PRs can be referenced while making the necessary changes:

  • Passing user auth token as user_token

feat: add user_token when creating realtime channel subscription #270

  • Update Realtime transformers (including bug fixes)

feat: update transformers to accept already transformed walrus changes #107

fix: error parsing JSON when transforming array data types #113

The bug fixes include longstanding issues with transformers in realtime-js where range types are first JSON parsed (which results in an error sometimes due to Postgres' range exclusive and inclusive bounds) and how stringified (e.g. "{1,2,3}") array types are split (can't always split on "," in cases like _daterange). Please see PR for additional context.

Additional context

We're looking to launch WALRUS in Realtime at the end of November, and all developers using the JS client will have to do is version bump their supabase-js to v1.2.0, which contains all the changes described above.

Please reach out if there's any questions and definitely tag me to confirm PRs if you'd like! Thank you!

@dshukertjr
Copy link
Member

This is now implemented and released! Looking forward to using WALRUS in my app!

@w3b6x9
Copy link
Member Author

w3b6x9 commented Nov 9, 2021

@dshukertjr awesome work!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants