Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 3.09 KB

README.rst

File metadata and controls

100 lines (64 loc) · 3.09 KB
Raw

aioquic

rtd pypi-v pypi-pyversions pypi-l travis codecov black

What is aioquic?

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

QUIC standardisation is not finalised yet, but aioquic closely tracks the specification drafts and is regularly tested for interoperability against other QUIC implementations.

To learn more about aioquic please read the documentation.

Design and features

TLS 1.3

aioquic features a minimal TLS 1.3 implementation built upon the cryptography library. This is because QUIC requires some APIs which are currently unavailable in mainstream TLS implementations such as OpenSSL:

  • the ability to extract traffic secrets
  • the ability to operate directly on TLS messages, without using the TLS record layer

Sans-IO APIs

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 of advantages including making the code testable and allowing integration with different concurrency models.

Running the examples

aioquic requires Python 3.6 or better. After checking out the code using git you can run:

$ pip install -e .
$ pip install aiofiles starlette wsproto

You can now run the example server, which handles both HTTP/0.9 and HTTP/3:

$ python examples/http3_server.py --certificate tests/ssl_cert.pem --private-key tests/ssl_key.pem

You can also run the example client to perform an HTTP/3 request:

$ python examples/http3_client.py https://localhost:4433/

Alternatively you can perform an HTTP/0.9 request:

$ python examples/http3_client.py --legacy-http https://localhost:4433/

License

aioquic is released under the BSD license.