Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anowell/secretctl
GPG wrapper for multi-user encryption/decryption of secrets
https://github.com/anowell/secretctl
Last synced: about 1 month ago
JSON representation
GPG wrapper for multi-user encryption/decryption of secrets
- Host: GitHub
- URL: https://github.com/anowell/secretctl
- Owner: anowell
- License: mit
- Created: 2015-03-29T05:15:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-26T17:18:01.000Z (almost 9 years ago)
- Last Synced: 2023-04-09T06:14:33.597Z (over 1 year ago)
- Language: Shell
- Size: 13.7 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
secretctl
---------
GPG wrapper to simplify multi-user encryption/decryption of secrets
usage
--------------
Usage can be seen by running `secretctl` with no args
```
Usage: secretctl CMD [ARGS]
A simple gpg-based workflow for shared encryption of secrets.
secretctl works by maintaining a directory containing public keys
and a keyfile that maps the key ID to the key name (basename of the key file)
Generate a key with: gpg --gen-key
Commands:
share KEYID [KEYNAME] Exports a gpg key to be shared for future encryptions.
Exports to .gpg-keys keydir searching up from working dir
Will create .gpg-keys in current directory if not found
KEYID is the hex ID of a public key which is output when
creating (gpg --gen-key) or listing keys (gpg --list-keys):
- given: pub rsa2048/A69BF163 2015-03-29
- KEYID is A69BF163
KEYNAME is a human-recognizable short name for the key
Defaults to USER_HOSTNAME
sync Synchronizes keydir with keychain by importing all public keys
in the keydir into your keychain
encrypt FILENAME ... Encrypts one or more files with all the public keys in the keydir
Outputs the encrypted file(s) as FILENAME.gpg
decrypt FILENAME ... Decrypts one or more files with your keyring
Outputs the decrypted file(s) without the .gpg suffix
reencrypt FILENAME ... Re-encrypts one or more files with your keyring
This command simplifies the process of decrypting and then encrypting
clean Remove all decrypted files that have an encrypted counterpart
list List all public keys which have been imported to your local store.
```
workflow
--------
This is the basic workflow for getting started
```
$ gpg --gen-key
...interactive key generation...
gpg: key A59B011E marked as ultimately trusted
...snip...
$ secretctl share A59B011E
Complete. Sharing A59B011E as anowell_olaf and added to the keylist.
```
This is the basic workflow to encrypt and decrypt a secret:
```
# Encrypt the secret
$ echo "top secret stuff" > my_secret
$ secretctl encrypt my_secret
Complete. Encrypted as my_secret.gpg
$ secretctl clean
removed 'my_secret'
# Decrypt the secret
$ secretctl decrypt my_secret.gpg
Complete. Decrypted to my_secret
$ cat my_secret
top secret stuff
```
This is the workflow for re-encrypting a secret for an additional user to access:
```
# After another user exports a GPG key using secretctl:
$ secretctl sync
Importing /path/to/gpg/anowell_olaf.pub
... Do you want to sign? [y/N]
Importing /path/to/gpg/johndoe_serenity.pub
... Do you want to sign? [y/N]
Finished importing all public keys. Ready to encrypt.
# Reencrypt with the newly imported GPG recipients
$ secretctl reencrypt my_secret.gpg
Decrypting my_secret.gpg
Decrypted to my_secret
Encrypting my_secret
Encrypted as my_secret.gpg
Completed. Finished reencrypting 1 file(s)
# Now my_secret can be decrypted with the private key for either anowell_olaf or johndoe_serenity
```