Skip to content

randombit/botan-rs

Repository files navigation

botan-rs

Build status crates.io docs.rs

This crate wraps the C API exposed by the Botan cryptography library.

Currently the crate exposes ciphers, hashes, MACs, KDFs, password based key derivation (PBKDF2, Scrypt, Argon2, etc), bcrypt password hashes, random number generators, X.509 certificates, format preserving encryption, HOTP/TOTP, NIST key wrapping, multiprecision integers, and the usual public key algorithms (RSA, ECDSA, ECDH, DH, ...)

PRs and comments/issues happily accepted.

MSRV

The Minimum Supported Rust Version (MSRV) of this crate is Rust 1.64.0.

Any future increase in the MSRV will be accompanied by increasing the minor version number.

Botan Versions Supported

The latest version of Botan3 is highly recomended for best security and performance. At least 2.13.0 is required.

Features

The following features are supported:

  • std (enabled by default): Enable using std library features. If disabled then the crates are no_std, however support for alloc is still required.
  • vendored: Build a copy of the C++ library directly, without relying on a system installed version.
  • static: Enable static linking for a non-vendored, externally provided Botan dependency.
  • pkg-config: Enable finding a non-vendored, externally provided Botan with pkg-config. Can be used in combination with static.

The crate detects at build time what features are exported from the C interface, and adjusts itself accordingly. These feature sets can be checked using #[cfg(botan_ffi_YYYYMMDD)] where YYYYMMDD can be any of

  • 20230403: Botan 3.0
  • 20240408: Botan 3.4
  • 20250506: Botan 3.8