pgp 0.3.1

OpenPGP implementation in Rust
Documentation

rPGP

OpenPGP implemented in pure Rust, permissively licensed

crates.io version CircleCI build status Appveyor build status Docs License

rPGP is the only full Rust implementation of OpenPGP, following RFC4880 and RFC2440. It offers a minimal low-level API and does not prescribe trust schemes or key management policies. It fully supports all functionality required by the Autocrypt 1.1 e-mail encryption specification.

rPGP is regularly published as the pgp Crate and its RSA implementation lives under the collective RustCrypto umbrella. For ECC crypto support we are using Curve25519-dalek.

Please note that the API is not well documented yet. You may check out the tests which exercise the API. Please open issues here if if you are attempting to use rPGP and need help.

Status (Last updated: October 2019)

rPGP and its RSA dependency got a first independent security review mid 2019. No critical flaws were found. We have fixed and are fixing some high, medium and low risk ones. We will soon publish the full review report. Further independent security reviews are upcoming.

rPGP is used in production by Delta Chat, the e-mail based messenger app suite, successfully running on Windows, Linux, macOS, Android and iOS in 32bit and 64 bit builds.

More details on platform and OpenPGP implementation status:

Experimental WASM Support

When enabeling the wasm feature, rpgp can be compiled to run using WASM in Node.js and the supported Browsers. Experimental bindings for this can be found in rpgp/rpgp-js.

Developement

To run the stress tests,

> git submodule update --init --recursive
> cargo test --release -- --ignored

To enable debugging, add

use pretty_env_logger;
let _ = pretty_env_logger::try_init();

And then run tests with RUST_LOG=pgp=info.

LICENSE

MIT or Apache 2.0

Contribution

Unless you explicitly state otherwise, any contribution submitted for inclusion in rPGP by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.