Lib.rs

› Network programming
#quic #protocols #async-api #client-server

quinn

Versatile QUIC transport protocol implementation

by Benjamin Saunders, Dirkjan Ochtman and 96 contributors

27 releases

0.11.6 Nov 13, 2024
0.11.3 Aug 4, 2024
0.11.2 Jun 7, 2024
0.10.2 Aug 2, 2023
0.1.0 Oct 2, 2018

#12 in Network programming

Download history 489191/week @ 2024-08-04 516069/week @ 2024-08-11 497132/week @ 2024-08-18 550210/week @ 2024-08-25 581232/week @ 2024-09-01 541156/week @ 2024-09-08 503836/week @ 2024-09-15 581101/week @ 2024-09-22 610511/week @ 2024-09-29 625038/week @ 2024-10-06 646739/week @ 2024-10-13 644509/week @ 2024-10-20 647761/week @ 2024-10-27 800644/week @ 2024-11-03 836505/week @ 2024-11-10 782294/week @ 2024-11-17

3,103,632 downloads per month
Used in 960 crates (152 directly)

MIT/Apache

1MB
25K SLoC

Documentation Crates.io Build status codecov Chat Chat License: MIT License: Apache 2.0

Quinn is a pure-Rust, async-compatible implementation of the IETF QUIC transport protocol. The project was founded by Dirkjan Ochtman and Benjamin Saunders as a side project in 2018, and has seen more than 30 releases since then. If you're using Quinn in a commercial setting, please consider sponsoring the project.

Features

  • Simultaneous client/server operation
  • Ordered and unordered stream reads for improved performance
  • Works on stable Rust, tested on Linux, macOS and Windows
  • Pluggable cryptography, with a standard implementation backed by rustls and ring
  • Application-layer datagrams for small, unreliable messages
  • Future-based async API
  • Minimum supported Rust version of 1.66

Overview

  • quinn: High-level async API based on tokio, see examples for usage. This will be used by most developers. (Basic benchmarks are included.)
  • quinn-proto: Deterministic state machine of the protocol which performs no I/O internally and is suitable for use with custom event loops (and potentially a C or C++ API).
  • quinn-udp: UDP sockets with ECN information tuned for the protocol.
  • bench: Benchmarks without any framework.
  • fuzz: Fuzz tests.

Getting Started

Examples

$ cargo run --example server ./
$ cargo run --example client https://localhost:4433/Cargo.toml

This launches an HTTP 0.9 server on the loopback address serving the current working directory, with the client fetching ./Cargo.toml. By default, the server generates a self-signed certificate and stores it to disk, where the client will automatically find and trust it.

Links

Usage Notes

Click to show the notes

Buffers

A Quinn endpoint corresponds to a single UDP socket, no matter how many connections are in use. Handling high aggregate data rates on a single endpoint can require a larger UDP buffer than is configured by default in most environments. If you observe erratic latency and/or throughput over a stable network link, consider increasing the buffer sizes used. For example, you could adjust the SO_SNDBUF and SO_RCVBUF options of the UDP socket to be used before passing it in to Quinn. Note that some platforms (e.g. Linux) require elevated privileges or modified system configuration for a process to increase its UDP buffer sizes.

Certificates

By default, Quinn clients validate the cryptographic identity of servers they connect to. This prevents an active, on-path attacker from intercepting messages, but requires trusting some certificate authority. For many purposes, this can be accomplished by using certificates from Let's Encrypt for servers, and relying on the default configuration for clients.

For some cases, including peer-to-peer, trust-on-first-use, deliberately insecure applications, or any case where servers are not identified by domain name, this isn't practical. Arbitrary certificate validation logic can be implemented by enabling the dangerous_configuration feature of rustls and constructing a Quinn ClientConfig with an overridden certificate verifier by hand.

When operating your own certificate authority doesn't make sense, rcgen can be used to generate self-signed certificates on demand. To support trust-on-first-use, servers that automatically generate self-signed certificates should write their generated certificate to persistent storage and reuse it on future runs.

Contribution

All feedback welcome. Feel free to file bugs, requests for documentation and any other feedback to the issue tracker.

The quinn-proto test suite uses simulated IO for reproducibility and to avoid long sleeps in certain timing-sensitive tests. If the SSLKEYLOGFILE environment variable is set, the tests will emit UDP packets for inspection using external protocol analyzers like Wireshark, and NSS-compatible key logs for the client side of each connection will be written to the path specified in the variable.

The minimum supported Rust version for published releases of our crates will always be at least 6 months old at the time of release.

Dependencies

~3–28MB
~598K SLoC