Google Git
Sign in
mundane / mundane / 5c18bf1cd2fa45550e4def982672906f001b80a0
commit5c18bf1cd2fa45550e4def982672906f001b80a0[log] [tgz]
authorErick Tryzelaar <etryzelaar@google.com>Tue Oct 09 22:25:02 2018 -0700
committerErick Tryzelaar <etryzelaar@google.com>Tue Oct 09 22:31:16 2018 -0700
tree7812915ae607d6ac6b1ee37299b67e38de80ed0f
parent8aaa1c80a2dd3e64cbbcdcc813e0105cc31613d0 [diff]
[readme] Document requirement for go 1.11+

Change-Id: If001fc048d595b806d36b5259459caa44ba7e8fd
1 file changed
tree: 7812915ae607d6ac6b1ee37299b67e38de80ed0f
  1. boringssl/
  2. src/
  3. .gitignore
  4. .gitmodules
  5. build.rs
  6. Cargo.toml
  7. CHANGELOG.md
  8. CONTRIBUTING.md
  9. DESIGN.md
  10. LICENSE
  11. README.md
README.md

Mundane

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

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.