Supabase

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.

Step 0: Prepare Your Environment

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.

Step 1: Set Up CipherStash Proxy

1.1 Create a CipherStash account

• 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.

1.2 Configure a dataset

• Create a dataset for your Supabase database. For more information, refer to the official documentation of CipherStash Datasets.

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
23

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

1.3 Configure CipherStash Proxy

• You will need to create the following in order the configure CipherStash Proxy:
  • A client id and key
  • An access key

Step 2: Retrieve Supabase Connection Details

2.1 Get Supabase Host Information

• 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

Step 3: Configure CipherStash Proxy to Connect to Supabase

3.1 Set Up Database Proxy

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

3.2 Start CipherStash Proxy

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
10

Step 4: Connect to Your Database Through CipherStash Proxy

4.1 Update Application Connection String

• 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.

Step 5: Test Your Connection

5.1 Verify Connectivity

• Test the connection from your application to ensure that it can successfully communicate with the Supabase database through CipherStash Proxy.

Conclusion

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

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

• CipherStash Audit: Audit your database queries and data access logs.
• CipherStash Encrypt: Encrypt your data at rest and in transit.
• CipherStash Identify: Identify and mask sensitive data in your database. (Coming soon!)