Component: Secrets
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 2.2k
- Forks
- 115
- Avg merge
- 17h 28m
- Merged PRs (30d)
- 50
Description
This Issue exists to collect many items that relate to "Secrets" in Darklang -- a managed system of creating encrypted values such as passwords, referencing/using them, and protecting them from parties who shouldn't have access.
Before working on any of this, we need to get a bit further along with our baseline CLI and editing experience.
- bring back Secrets in darklang-next locally
- take inspiration from james
- Allow adding documentation to secrets
- When a user adds a secret, there's often useful information to go with it, such as a description, or how to set it or change it. As I add some API keys to an app, I find I want a link to the documentation, and also a link to how to change the key. If possible, a user might want to link to the upstream "resource" (maybe a page for that key on the vendor's dashboard).
- support deleting secrets (see old #2815)
- Add regular notification of secrets
- Users might set up Dark with a secret and then forget about it, which increases the attack surface should dark be compromised.
- To help with this, we should send regular notifications to customers listing the names of secrets they have stored on the platform. Maybe a monthly or quarterly email that they can configure in settings.
- thoughts: "prevent accidental exposure" (see old #3709)
- todo: extract the individual ideas here
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Treat this as an umbrella issue rather than a single implementation task. First narrow it to one checklist item after the baseline CLI and editing experience is further along, then read old issues #2815 and #3709 and the linked James video for context. Done should be defined by a separate scoped issue with clear acceptance criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100