Crate pgp

source ·
Expand description

🔐 pgp-lib

Rust library to deal with PGP operations, based on rPGP.

Features

  • Encrypts asynchronously bytes using multiple public keys
  • Decrypts asynchronously bytes using a secret key and its passphrase
  • Signs asynchronously bytes using a secret key and its passphrase
  • Verifies asynchronously bytes using a public key and a standalone signature
  • Finds public keys matching emails using WKD and Key Servers (HTTP and HKP protocols supported)
  • Provides helpers to generate a key pair, to read secret/public keys from path, to read signature from bytes etc.

Development

The development environment is managed by Nix. Running nix-shell will spawn a shell with everything you need to get started with the lib: cargo, cargo-watch, rust-bin, rust-analyzer…

# Start a Nix shell
$ nix-shell

# then build the lib
$ cargo build -p pgp-lib

Contributing

If you find a bug that does not exist yet, please send an email at ~soywod/pimalaya@todo.sr.ht.

If you have a question, please send an email at ~soywod/pimalaya@lists.sr.ht.

If you want to propose a feature or fix a bug, please send a patch at ~soywod/pimalaya@lists.sr.ht using git send-email (see this guide on how to configure it).

If you want to subscribe to the mailing list, please send an email at ~soywod/pimalaya+subscribe@lists.sr.ht.

If you want to unsubscribe to the mailing list, please send an email at ~soywod/pimalaya+unsubscribe@lists.sr.ht.

If you want to discuss about the project, feel free to join the Matrix workspace #pimalaya or contact me directly @soywod.

Credits

nlnet

Special thanks to the nlnet foundation that helped Himalaya to receive financial support from the NGI Assure program of the European Commission in September, 2022.

Sponsoring

GitHub PayPal Ko-fi Buy Me a Coffee Liberapay

Modules

  • decrypt
    Module dedicated to PGP decryption.
  • encrypt
    Module dedicated to PGP encryption.
  • hkp
    Module dedicated to HTTP Keyserver Protocol.
  • http
    Module dedicated to HTTP.
  • native
    rPGP
  • sign
    Module dedicated to PGP signing.
  • utils
    Module dedicated to PGP helpers.
  • verify
    Module dedicated to PGP verification.
  • wkd
    Module dedicated to Web Key Directory.

Enums

Functions

  • decrypt
    Decrypts bytes using the given secret key and its passphrase.
  • encrypt
    Encrypts given bytes using the given list of public keys.
  • gen_key_pair
    Generates a new pair of secret and public keys for the given email address and passphrase.
  • read_pkey_from_path
    Reads a signed public key from the given path.
  • read_sig_from_bytes
    Reads a standalone signature from the given raw bytes.
  • read_skey_from_file
    Reads a signed secret key from the given path.
  • read_skey_from_string
    Reads a signed secret key from the given raw string.
  • sign
    Signs given bytes using the given private key and its passphrase.
  • verify
    Verifies given standalone signature using the given public key.

Type Aliases