s2n-quic

s2n-quic

s2n-quic is a Rust implementation of the IETF QUIC protocol, featuring:

• a simple, easy-to-use API. See an example of an s2n-quic echo server built with just a few API calls
• high configurability using providers for granular control of functionality
• extensive automated testing, including fuzz testing, integration testing, unit testing, snapshot testing, efficiency testing, performance benchmarking, interoperability testing and more
• integration with s2n-tls, AWS's simple, small, fast and secure TLS implementation, as well as rustls
• thorough compliance coverage tracking of normative language in relevant standards
• and much more, including CUBIC congestion controller support, packet pacing, Generic Segmentation Offload support, Path MTU discovery, and unique connection identifiers detached from the address

See the API documentation, examples, and s2n-quic Guide to get started with s2n-quic.

Installation

s2n-quic is available on crates.io and can be added to a project like so:

[dependencies]
s2n-quic = "1"

NOTE: The default TLS provider depends on the platform. On unix-like systems, and on Windows when building with the GNU/MinGW toolchain, s2n-tls is used as the default TLS provider. On Windows with the MSVC toolchain, rustls is the default, because s2n-tls does not build with MSVC.

On linux systems, aws-lc-rs will be used for cryptographic operations. A C compiler and CMake may be required on these systems for installation.

Example

The following implements a basic echo server and client. The client connects to the server and pipes its stdin on a stream. The server listens for new streams and pipes any data it receives back to the client. The client will then pipe all stream data to stdout.

Server

…

Client

…

Minimum Supported Rust Version (MSRV)

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

The current MSRV is 1.92.0.

Supported Operating Systems

s2n-quic can be built on Linux, MacOS, and Windows. s2n-quic requires Linux kernel version 5.0 or later. Earlier Linux kernel versions are not supported as they lack the Generic Segmentation Offload (GSO) capabilities required by s2n-quic.

Security issue notifications

If you discover a potential security issue in s2n-quic we ask that you notify AWS Security via our vulnerability reporting page. Please do not create a public github issue.

See our Security Reporting Policy for additional guidance on issues considered in-scope for our threat model.

If you package or distribute s2n-quic, or use s2n-quic as part of a large multi-user service, you may be eligible for pre-notification of future s2n-quic releases. Please contact [email protected].

License

This project is licensed under the Apache-2.0 License.