getsops / getsops/sops

Ability to optionally set human-readable name to keys in sops config file

Open
#366 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement priority/low
Dominant language
Go
Stars
23.1k
Forks
1.1k
Avg merge
1d 11h
Merged PRs (30d)
9

Description

I'd like to be able to set a name for each key in a sops config file. The main benefit for this is the potential to vastly improve error messages on decryption failures when you have a number of PGP keys within the config file. Currently you will have a huge error output and it can be difficult to parse what error is relevant to your key, especially if you don't immediately recognize your fingerprint.

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.

Research direction

No files, tests, or entry points are named. Start by locating sops config parsing and PGP decryption error reporting, then determine how optional key names can flow between them. Done means configurations can optionally identify keys in decryption failures without requiring names in existing configs.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.