5 releases
0.1.7 | Aug 18, 2024 |
---|---|
0.1.6 | Aug 12, 2024 |
0.1.5 | Aug 11, 2024 |
0.1.4 | Aug 9, 2024 |
0.1.0 | Aug 6, 2024 |
#327 in Cryptography
33 downloads per month
44KB
883 lines
Ghostkey CLI
A command-line interface for managing ghost keys and certificates in the Freenet ecosystem.
What are Ghost Keys?
Ghost keys are a cryptographic mechanism used in Freenet to provide anonymous, unlinkable donations. They allow donors to prove they have made a donation without revealing their identity or linking multiple donations together. Ghost keys are created through a multi-step process involving master keys, delegate certificates, and finally the ghost key itself.
Purpose of Ghost Keys
- Anonymity: Donors can prove they've made a donation without revealing their identity.
- Verifiability: The system can verify that a donation has been made without knowing who made it.
This CLI tool provides the necessary utilities to manage the entire lifecycle of ghost keys, from generating master keys to creating and verifying ghost key certificates.
Features
- Generate master keys
- Create and verify delegate certificates
- Generate and verify ghost key certificates
- Sign messages with ghost keys
- Verify signed messages
Installation
To install the Ghostkey CLI, you need to have Rust and Cargo installed on your system:
curl https://sh.rustup.rs -sSf | sh
Then, you can build and install the CLI using:
cargo install ghostkey
Usage
$ ghostkey -h
Usage: ghostkey [COMMAND]
Commands:
generate-master-key Generate a new master keypair
generate-delegate Generates a new delegate signing key and certificate
verify-delegate Verifies a delegate key certificate using the master verifying key
generate-ghost-key Generates a ghost key from a delegate signing key
verify-ghost-key Verifies a ghost key certificate using the master verifying key
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
ghostkey <subcommand> --help
Examples
-
Verify a ghost key certificate:
ghostkey verify-ghost-key --ghost-certificate ./ghost-key/ghost_key_certificate.pem
-
Sign a message:
ghostkey sign-message --ghost-certificate ./ghost-key/ghost_key_certificate.pem --ghost-signing-key ./ghost-key/ghost_key_signing_key.pem --message ./message.txt --output ./signed_message.pem
-
Verify a signed message:
ghostkey verify-signed-message --signed-message ./signed_message.pem --master-verifying-key ./master-keys/master_verifying_key.pem
This script will run through various scenarios to ensure the CLI is functioning correctly.
License
This project is licensed under the GNU Affero General Public License v3.0.
Dependencies
~10–21MB
~313K SLoC