ring's Rust crate is named ring. See https://crates.io/crates/ring to see
what the latest version is and to see how to add a dependency on it to your
project.
When hacking on ring itself, you can build it using cargo build and
cargo test as usual. ring includes some C, C++, and assembly language
components, and its build script (build.rs) builds all those things
automatically.
When you build ring from its package (e.g. the ones on crates.io), you only
need the Rust toolchain and a C/C++ compiler. For Windows targets, the packaged
crate contains precompiled object files for the assembly language modules so no
macro assembler is required. On other platforms, ring's build script assumes
the C/C++ compiler knows how to build .S files (assembly language sources
with C preprocessor directives).
If you want to hack on ring then you need to build it directly from its Git repository. There are some additional requirements for doing this that do not apply when building from crates.io:
-
For any target for which ring has assembly language implementations of primitives (32- and 64- bit Intel, and 32- and 64-bit ARM), Perl must be installed and in
$PATH. -
For Windows targets,
target/tools/nasm[.exe]is used as the assembler; mk/install-build-tools.ps1 downloads it for Windows hosts.
When you build ring for a target that is different than the one you are using for the build process you need to install the rust tool chain and a C/C++ compiler that can produce binaries for the intended target.
Besides the required dependencies you need to set the environment variables
TARGET_CC and TARGET_AR to the full path of the cross-compiler and the
cross-archiver respectively.
ring targets the current stable release of Rust and Cargo. We also verify that the current beta and nightly releases work.
On Windows, ring supports the x86_64-pc-windows-msvc and i686-pc-windows-msvc targets best. These targets require the “Visual C++ Build Tools 2015” package or Visual Studio 2015 Update 3 or later to be installed. Patches to get it working on other variants, including in particular Visual Studio 2017 (#338), Windows ARM platforms, Windows Universal Platform, Windows XP (the v140_xp toolchain; #339), and the -gnu targets (#330) are welcome.
For other platforms, GCC 4.6 or later and Clang 3.5 or later are currently supported best. The build script passes options to the C/C++ compiler that are GCC- and Clang- specific. Pull requests to support other compilers will be considered.
Note in particular that if you are cross-compiling an x86 build on a 64-bit version of Linux, then you need to have the proper gcc-multilibs and g++-multilibs packages or equivalent installed.
If you generate a standalone NDK toolchain in order to compile your project,
the wrapper automatically passes flags to the actual compiler to define the
__ANDROID_API__ macro. Otherwise, the macro __ANDROID_API__ must be
defined with a value of at least 21 on 64-bit targets or 18 on 32-bit targets;
e.g. export CFLAGS=-D__ANDROID_API__=21.
The slow_tests feature runs additional tests that are too slow to run during
a normal edit-compile-test cycle.
The test_logging feature prints out the input test vectors when a test fails.