docs.rs failed to build wolfcrypt-sys-0.1.4
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

wolfcrypt-sys

Raw FFI bindings to wolfCrypt, generated by bindgen. This is the foundation crate for the wolfssl-rs workspace.

Prefer the higher-level crates (wolfcrypt, wolfcrypt-ring-compat, wolfcrypt-tls) over depending on this directly.

Why

wolfcrypt-sys separates the generated FFI from the safe wrappers so that:

The bindgen output can be regenerated (by updating the wolfSSL source) without a breaking-change version bump on wolfcrypt or wolfcrypt-rs.
It emits DEP_WOLFCRYPT_SYS_* cargo metadata (include paths, cfg flags, lib dirs) via the links = "wolfcrypt_sys" key so downstream crates do not need to re-discover the wolfSSL installation.
Per-algorithm cfg flags (wolfssl_aes_gcm, wolfssl_ecc_p384, …) are parsed from the compiled wolfSSL and emitted here; higher-level crates use these flags to gate algorithm support at compile time.

Usage

wolfcrypt-sys = { version = "0.1", features = ["vendored"] }

How it works

wolfssl-src       Compiles wolfSSL C source; emits DEP_WOLFSSL_SRC_* metadata
      │
wolfcrypt-sys     build.rs reads wolfSSL metadata; runs bindgen over wolfssl/
      │           headers; emits DEP_WOLFCRYPT_SYS_{CFGS,INCLUDE,ROOT,…}
      │           (links = "wolfcrypt_sys")
      │
wolfcrypt-rs      Reads DEP_WOLFCRYPT_SYS_* to compile compat_shim.c

The generated bindings.rs is written to $OUT_DIR and include!-d into lib.rs. The allowlist covers wolfCrypt algorithm structs and functions; wolfSSL TLS types are excluded.

Finding wolfSSL

The build script searches in order:

WOLFSSL_LIB_DIR + WOLFSSL_INCLUDE_DIR environment variables
WOLFSSL_DIR install prefix
vendored feature + WOLFSSL_SRC — compiles from source via wolfssl-src
pkg-config

Features

Feature	Description
`vendored`	Compile wolfSSL from source (requires `WOLFSSL_SRC`)
`fips`	Enable the FIPS 140-3 code path
`riscv-bare-metal`	Bare-metal RISC-V configuration (Caliptra)

Need FIPS 140-3 validation in your Rust application? wolfCrypt is FIPS 140-3 validated. Contact wolfSSL for a commercial FIPS license and the validated source tree.

Copyright

License

MIT — see LICENSE.

The MIT License applies to the Rust source code in this crate. The underlying wolfSSL/wolfCrypt C library is licensed under GPL-2.0-or-later with a commercial option available from wolfSSL Inc.

wolfcrypt-sys 0.1.4