Google Git
Sign in
fuchsia / mundane / 6a2b672f3c7bc039353db55a54afc06d0954693f
commit6a2b672f3c7bc039353db55a54afc06d0954693f[log] [tgz]
authorJoshua Liebow-Feeser <joshlf@google.com>Fri Mar 27 20:06:09 2020 +0000
committerJoshua Liebow-Feeser <joshlf@google.com>Fri Mar 27 20:06:09 2020 +0000
treec424b1fc34e4cbcb8456a1b38da8bbf6dfff79b6
parentda060be93c68b5bee331bc07cc43bfc4ed620928 [diff]
Roll BoringSSL, update bindgen

The latest version of bindgen converts the C type `size_t` to a new
Rust type alias of the same name. On most platforms, this is an alias
to the unsigned integer type of platform's pointer width (e.g., `u32`
on 32-bit platforms, `u64` on 64-bit platforms, etc). Thus, we just
assume that that will be the case on all platforms we're compiled on,
and introduce some machinery to convert between `size_t` and `usize`
easily that will fail compilation if the conversion is not valid on
the target platform. See the `IntoSizeT` and `IntoUsize` traits in
the `boringssl::raw` module.

Change-Id: I2c22ba83de149587772668b8fd01a7f997604600
Reviewed-on: https://fuchsia-review.googlesource.com/c/mundane/+/375794
Reviewed-by: Drew Fisher <zarvox@google.com>
4 files changed
tree: c424b1fc34e4cbcb8456a1b38da8bbf6dfff79b6
  1. .gitignore
  2. .gitmodules
  3. CHANGELOG.md
  4. CONTRIBUTING.md
  5. Cargo.toml
  6. DESIGN.md
  7. LICENSE
  8. PULL_REQUEST_TEMPLATE.md
  9. README.md
  10. RELEASING.md
  11. boringssl/
  12. build/
  13. rustfmt.toml
  14. src/
  15. test.sh
  16. tests/
README.md

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

Rust 1.36 or newer is required.

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.10 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.