Do we need both `CLOAK_KEYCHAIN` and `CLOAK_MASTER_KEY` or one of them

Open Beginner friendly
#75 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Look at the extension's configuration and environment variable handling in the source code, likely in the main extension file or setup documentation. Check how CLOAK_KEYCHAIN and CLOAK_MASTER_KEY are used, and see if both are required or if one supersedes the other. Update the README or configuration docs to clarify the usage.

Written by the indexing model from the issue text.

Description

I'm integrating this extension and it's working great so far! It's simple to set up and it works transparently, I love it! 🙌

I'm curious if we need to provide both CLOACK_KEYCHAIN and CLOAK_MASTER_KEY to our environment when deploying the API.

When using the extension, I see only CLOAK_MASTER_KEY is documented, what to do with CLOAK_KEYCHAIN?

export const prisma = new PrismaClient().$extends(
  fieldEncryptionExtension({
    encryptionKey: process.env['CLOAK_MASTER_KEY'],
  }),
)

Some clarity here would be highly appreciated.

Dominant language
TypeScript
Stars
307
Forks
40
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from 47ng/prisma-field-encryption

All issues in 47ng/prisma-field-encryption

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.