Skip to content

Files

Latest commit

boquan-fangBoquan Fang
boquan-fang
and
Boquan Fang
chore: pin once_cell version to unblock the CI (#5174)
Mar 11, 2025
93d31b2 · Mar 11, 2025

History

History

rust

README.md

s2n-tls Rust Bindings

NOTICE: These bindings are currently subject to change and should not be used without the expectation of future breakage.

Installation

In order to generate rust bindings for s2n-tls, you need to have the following installed:

  • Rust - this can be easily installed with rustup
  • libclang - this is usually installed through your system's package manager
  • libssl-dev
  • pkg-config

Usage

Generating rust bindings can be accomplished by running the generate.sh script:

$ ./bindings/rust/extended/generate.sh

This script generates the low-level bindings in the crate s2n-tls-sys, which is used by the s2n-tls crate to provide higher-level bindings. See s2n-tls-sys for more information on s2n-tls-sys crate.

Minimum Supported Rust Version (MSRV)

There are two rust bindings workspaces that have different MSRV policies. Crates in standard maintain a rolling MSRV policy of at least 6 months. Crates in extended maintain an older MSRV for increased support.

Extended

Crates in the extended workspace currently support an "extended" MSRV of 1.63.0. This is a temporary state. Customers must not rely on s2n-tls crates maintaining this level of stability. We expect to revert back to the mentioned standard policy shortly.

Standard

We will maintain a rolling MSRV (minimum supported rust version) policy of at least 6 months. The current s2n-tls version is not guaranteed to build on Rust versions earlier than the MSRV.