2018-11-30 11:07:14 -08:00
2018-10-02 21:19:49 +02:00
2018-11-30 11:07:14 -08:00
2018-02-09 19:27:15 -08:00
2018-10-19 20:21:40 +02:00
2018-04-28 22:07:13 -07:00
2018-11-30 11:07:14 -08:00

Quinn

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

Quinn is an implementation of the QUIC network protocol currently undergoing standardization by the IETF. It is currently suitable for experimental use. The implementation is split up into the state machine crate quinn-proto which performs no I/O internally and can be tested deterministically, and a high-level tokio-compatible API in quinn. See quinn/examples/ for usage.

Quinn is the subject of a RustFest Paris (May 2018) presentation; you can also get the slides (and the animation about head-of-line blocking). Video of the talk is available on YouTube. Since this presentation, Quinn has been merged with quicr, another Rust implementation.

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

Quinn was created and is maintained by Dirkjan Ochtman and Benjamin Saunders.

Features

  • Simultaneous client/server operation
  • Ordered and unordered reads for improved performance
  • Works on stable Rust
  • Uses rustls for all TLS operations and ring for cryptography

Status

  • QUIC draft 11 with TLS 1.3
  • Cryptographic handshake
  • Stream data w/ flow control and congestion control
  • Connection close
  • Stateless retry
  • Migration
  • 0-RTT data
  • Session resumption
  • HTTP over QUIC

How to start

The example client currently always verifies the server's certificate chain. Example certificates are included in the repository for test purposes.

$ cd quinn
$ cargo run --example server -- --cert ../certs/server.chain --key ../certs/server.rsa .
$ cargo run --example client -- --ca ../certs/ca.der https://localhost:4433/Cargo.toml

Development

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.

S
Description
noq, a QUIC implementation in Rust
Readme 106 MiB
Languages
Rust 99.3%
Python 0.5%
Shell 0.2%