Main site

Connecting Supabase to CipherStash Proxy

This guide explains how to connect Supabase to CipherStash Proxy. Supabase is a PostgreSQL compatible database that can be connected to CipherStash Proxy just like any other PostgreSQL database.

The following steps assume a database schema with a table named users that contains an email column that you want to protect.

Ensure you have Docker installed and running on your system. If you don't have Docker, you can download and install it from Docker's official website.

  • If you don't already have a CipherStash account, create one at CipherStash.
  • Download the CipherStash CLI and log in to your account. For more information, refer to the official documentation of CipherStash CLI.
  • Create a dataset for your Supabase database. For more information, refer to the the Dataset guide.

For this tutorial, we will use the following dataset based on the users table and protection of the email column:

1tables:
2  - path: users
3    fields:
4      - name: email
5        in_place: false
6        cast_type: utf8-str
7        mode: encrypted
8        indexes:
9          - version: 1
10            kind: match
11            tokenizer:
12              kind: ngram
13              token_length: 3
14            token_filters:
15              - kind: downcase
16            k: 6
17            m: 2048
18            include_original: true
19          - version: 1
20            kind: ore
21          - version: 1
22            kind: unique

Use this dataset as a template for your own dataset and upload it to CipherStash using the commands from creating a dataset.

  • In your Supabase project, navigate to Project Settings > Database.
  • Scroll to the Connection info section and note down the following Connection parameters:
    • Host
    • Port
    • Database name
    • Username
    • Password

Gather all the host, port, and any necessary authentication credentials for your Supabase database.

Use the following command to start CipherStash Proxy, replacing the placeholder values with your own:

1docker run -p 6432:6432 \
2  -e CS_USERNAME=fill-me-in \
3  -e CS_PASSWORD=fill-me-in \
4  -e CS_DATABASE__HOST=fill-me-in \
5  -e CS_DATABASE__PORT=fill-me-in \
6  -e CS_DATABASE__NAME=fill-me-in \
7  -e CS_WORKSPACE_ID=fill-me-in \
8  -e CS_CLIENT_ACCESS_KEY=fill-me-in \
9  cipherstash/cipherstash-proxy
  • In your application, replace the original Supabase connection string with the connection string for CipherStash Proxy.
  • Typically, this would involve changing the host in the connection string to point to the local or network address where CipherStash Proxy is running, and updating the port to 6432, while keeping the same credentials.
  • Test the connection from your application to ensure that it can successfully communicate with the Supabase database through CipherStash Proxy.

By following these steps, you should have successfully integrated Supabase with CipherStash Proxy.

With CipherStash Proxy in place, you can now use the entire CipherStash product suite to secure your data.