Skip to content

Clarify HMAC key generation for relationship integrity #544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ivanauth wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −2
Open

Clarify HMAC key generation for relationship integrity #544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions app/spicedb/concepts/datastores/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,14 @@ Support for schema changes will likely come in a future version.

##### Setting up relationship integrity

To run with relationship integrity, the following flags must be given to SpiceDB:
First, generate an HMAC key and save it to a file.
For example, using OpenSSL to generate a 256-bit key:

```bash
openssl rand 32 > some.key
```

Then run SpiceDB with the following flags:

```zed
spicedb serve ...existing flags...
Expand All @@ -163,7 +170,8 @@ spicedb serve ...existing flags...
--datastore-relationship-integrity-current-key-filename="some.key"
```

Place the generated key contents (which must support an HMAC key) in `some.key`.
The `--datastore-relationship-integrity-current-key-id` value is an arbitrary identifier you choose for this key, used to track which key signed each relationship.
The `--datastore-relationship-integrity-current-key-filename` should point to the file containing the raw key bytes generated above.

##### Deployment Process

Expand Down
Loading