Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/woodruffw/pgpkeydump
A tool for dumping PGP keys as JSON
https://github.com/woodruffw/pgpkeydump
pgp pgp-key
Last synced: 2 days ago
JSON representation
A tool for dumping PGP keys as JSON
- Host: GitHub
- URL: https://github.com/woodruffw/pgpkeydump
- Owner: woodruffw
- License: apache-2.0
- Created: 2023-04-11T10:15:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T12:09:12.000Z (17 days ago)
- Last Synced: 2024-09-16T13:57:28.423Z (17 days ago)
- Topics: pgp, pgp-key
- Language: Rust
- Homepage: https://crates.io/crates/pgpkeydump
- Size: 301 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pgpkeydump
[](https://github.com/woodruffw/pgpkeydump/actions/workflows/ci.yml)
[](https://crates.io/crates/pgpkeydump)
A tool for dumping PGP keys as JSON.
## Installation
From crates:
```bash
cargo install pgpkeydump
```
If the build fails, then you might need `nettle`. For macOS:
```bash
brew install nettle
```
`pgpkeydump` is also available on the Arch User Repository as [`pgpkeydump`](https://aur.archlinux.org/packages/pgpkeydump).
## Usage
```bash
pgpkeydump somekey.asc
```
Both ASCII-armored and binary inputs should work. If the filename argument
is omitted, standard input is read instead. Output always goes to standard
output.
## Example
```bash
pgpkeydump \
<(curl https://keys.openpgp.org/vks/v1/by-keyid/85AE00C504833B3C)
```
## Why?
PGP is a
[miserable ecosystem](https://latacora.micro.blog/2019/07/16/the-pgp-problem.html),
and there is no good way to get a machine-readable representation of
a PGP message without mucking through either an unstable textual CLI
output or parsing individual PGP packets.
This tool exists *solely* to take a key-shaped PGP message and dump
(some of) its contents. It doesn't support anything else, **will never support
anything else**, and will never attempt to actually verify the authenticity
or integrity of its inputs. It is not suitable for use for anything except
exploration of a PGP key message's internals.
## Alternatives
If this tool doesn't do what you want, then the closest alternatives are:
* [`pgpdump`](https://github.com/kazu-yamamoto/pgpdump), which is
semi-maintained but only provides a textual output (and crashes for me on all
kinds of reasonable inputs);
* [`sq packet dump`](https://docs.sequoia-pgp.org/sq/), which is maintained
but only provides a textual output.
* `gpg --list-packets` or `gpg --with-colons`: Good luck!