Mundane is a Rust cryptography library backed by BoringSSL that is difficult to misuse, ergonomic, and performant (in that order).

Clone this repo:

Branches

  1. 86423a4 Update to latest version of rustfmt by Joshua Liebow-Feeser · 3 days ago master
  2. ee452e2 Add RELEASING.md, fix boringssl/boringssl.rs symbol names, release 0.2.2 by Joshua Liebow-Feeser · 4 days ago
  3. c5baff6 [docs] Host docs on joshlf.com until docs.rs#259 is fixed by Joshua Liebow-Feeser · 8 days ago
  4. ac7d3aa [Cargo.toml] Exclude BoringSSL test files to make crate file smaller by Joshua Liebow-Feeser · 10 days ago
  5. bde1998 [CONTRIBUTING.md] Explain that 'git clone' needs '--recursive' flag by Joshua Liebow-Feeser · 3 weeks ago

Mundane

Mundane is a Rust cryptography library backed by BoringSSL that is difficult to misuse, ergonomic, and performant (in that order).

Issues and Contributions

We use GitHub issues for issue tracking, and Gerrit for code reviews. See CONTRIBUTING.md for more details.

Dependencies

Mundane vendors a copy of the BoringSSL source, so BoringSSL does not need to be installed locally in order to build. However, the BoringSSL build system has the following dependencies:

  • CMake 2.8.11 or later
  • Perl 5.6.1 or later. See BoringSSL's build instructions for what to do if CMake fails to find Perl on your system.
  • Either Make or Ninja. Ninja is preferable, as it makes compilation significantly faster; if both are present, Ninja will be used. On Windows, Ninja is required.
  • A C++ compiler
  • Go 1.11 or later
  • To build the x86 and x86_64 assembly, your assembler must support AVX2 instructions and MOVBE. If using GNU binutils, you must have 2.22 or later.

In order to avoid errors at link time due to conflicting symbols, we build BoringSSL with a custom prefix for all of its symbols which is based on the name and version of this crate. That way, even if multiple different versions of Mundane are present in the same dependency graph, none of the symbols from one version‘s BoringSSL will conflict with the symbols from another version’s BoringSSL.

Supported platforms

Mundane supports being built on and for Linux and Mac. Windows support is under development. Cross-compilation is not supported.

License

Everything outside of the boringssl/boringssl directory is licensed under an MIT license which can be found in the LICENSE file. Everything in the boringssl/boringssl directory is licensed with a license that can be found in the boringssl/boringssl/LICENSE file.

Disclaimer: Mundane is not an officially supported Google product.