gpgtool/README.md

68 lines
1.6 KiB
Markdown
Raw Normal View History

2022-07-13 23:49:12 +02:00
# GPGTool
2022-07-19 14:42:50 +02:00
Zsh script to manage GPG keys without storing the master key in your main GnuPG
2022-07-23 18:36:58 +02:00
keyring.
2022-07-19 11:49:36 +02:00
2022-07-19 13:58:04 +02:00
**This is currently in a *TESTING* state. Do not use for production unless you
can manually verify each step doesnt accidentally leak into your main GnuPG
2022-07-19 14:32:23 +02:00
keyring.**
2022-07-19 13:58:04 +02:00
2022-07-19 11:49:36 +02:00
GPG lets you have sub keys for encryption and for signing without having access
to the secret part of the master key. That way you can use your GPG key without
fear of having your secure identity compromised should you ever “lose” your
keys.
An attacker will be able to use the currently valid sub keys until you revoke
them. They will _never_ be able to create new sub keys for your master key.
2022-07-19 14:42:50 +02:00
So in case of compromise of your GPG key(s)
1. whip out your securely stored master key,
2. revoke your current sub keys,
3. make sure to propagate that e.g. via key server and
4. generate new sub keys.
2022-07-19 11:49:36 +02:00
2022-07-23 18:36:58 +02:00
## How It Works
FIXXME
2022-07-19 11:49:36 +02:00
## Installation
Download / clone this repo and put it somewhere. Either run `gpgtools` from
there directly or put it in your `PATH`.
If you want to package this for your flavour for \*nix, go ahead. Its GPL.
## Usage
2022-07-23 18:36:58 +02:00
### Open the Key Safe
FIXXME
### Work with Your Keys
FIXXME
### Close the Key Safe
2022-07-13 23:49:12 +02:00
FIXXME
2022-07-19 11:49:36 +02:00
## (Optional) Configuration File
FIXXME
See [`gpgtool.example.conf`](gpgtool.example.conf).
## F.A.Q.
**Q:** I want this as a bash script!
**A:** Thats not a question.
**Q:** Can I have this as a bash script?
**A:** No.
2022-07-13 23:49:12 +02:00
[![GitHub Sponsors](https://img.shields.io/github/sponsors/alterNERDtive?style=for-the-badge)](https://github.com/sponsors/alterNERDtive)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/S6S1DLYBS)