Repository files navigation

aioquic is a library for the QUIC network protocol in Python. It featuresa minimal TLS 1.3 implementation, a QUIC stack and an HTTP/3 stack.

QUIC was standardised inRFC 9000 and HTTP/3 inRFC 9114.aioquic is regularly tested for interoperability against otherQUIC implementations.

To learn more aboutaioquic pleaseread the documentation.

aioquic has been designed to be embedded into Python client and serverlibraries wishing to support QUIC and / or HTTP/3. The goal is to provide acommon codebase for Python libraries in the hope of avoiding duplicated effort.

Both the QUIC and the HTTP/3 APIs follow the "bring your own I/O" pattern,leaving actual I/O operations to the API user. This approach has a number ofadvantages including making the code testable and allowing integration withdifferent concurrency models.

• minimal TLS 1.3 implementation conforming withRFC 8446

• QUIC stack conforming withRFC 9000

  • IPv4 and IPv6 support
  • connection migration and NAT rebinding
  • logging TLS traffic secrets
  • logging QUIC events in QLOG format

• HTTP/3 stack conforming withRFC 9114

  • server push support
  • WebSocket bootstrapping conforming withRFC 9220
  • datagram support conforming withRFC 9297

The easiest way to installaioquic is to run:

pip install aioquic

If there are no wheels for your system or if you wish to buildaioquicfrom source you will need the OpenSSL development headers.

On Debian/Ubuntu run:

sudo apt install libssl-dev python3-dev

On Alpine Linux run:

sudo apk add openssl-dev python3-dev bsd-compat-headers libffi-dev

On OS X run:

brew install openssl

You will need to set some environment variables to link against OpenSSL:

export CFLAGS=-I$(brew --prefix openssl)/includeexport LDFLAGS=-L$(brew --prefix openssl)/lib

On Windows the easiest way to install OpenSSL is to useChocolatey.

choco install openssl

You will need to set some environment variables to link against OpenSSL:

$Env:INCLUDE = "C:\Progra~1\OpenSSL\include"$Env:LIB = "C:\Progra~1\OpenSSL\lib"

aioquic comes with a number of examples illustrating various QUIC usecases.

You can browse these examples here:https://github.com/aiortc/aioquic/tree/main/examples

aioquic is released under theBSD license.