getsops / getsops/sops

Support github id based public key encryption

Open
#1,409 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I want to achieve something like this:

sops --encrypt --whisper @rsc conf.yaml

The line above will encrypt the conf.yaml for github users rsc, every user's public key is always public available on github, such as https://github.com/rsc.keys, just append the .keys to a user's profile page url.

With this style, we don't have ask the recipient to generate new keys and send it to the maintainer, as long as they can push the repo they can decrypt the sops file, able to push means already has a public key uploaded to github. Same works for other platforms like gitlab.

I made a Age like tool for it: whisper.

My question is it easy to add new encryption tool to sops, are there guidelines or convention I need to follow to make a PR? I have read the CONTRIBUTING.md.

I'm aware of that #1134 is a year old, also sops age does't support key passphrase yet.

FYI: The comparison between age and whisper.

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

Read CONTRIBUTING.md first, then trace the sops encryption entry point for the proposed sops --encrypt --whisper @rsc conf.yaml invocation. Define the scope for resolving GitHub .keys identities, and possibly GitLab identities, with completion demonstrated by encrypting for the selected account and allowing the intended recipient to decrypt it.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, gitlab, go
Domain
cli, cryptography, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.