xquic

XQUIC

• 官方文档
• AI文档
• 简体中文文档 README-zh-CN

Introduction

XQUIC Library released by Alibaba is …

… a client and server implementation of QUIC and HTTP/3 as specified by the IETF. Currently supported QUIC versions are v1 and draft-29.

… OS and platform agnostic. It currently supports Android, iOS, HarmonyOS, Linux, macOS and Windows(v1.2.0). Most of the code is used in our own products, and has been tested at scale on android, iOS apps, as well as servers.

… still in active development. Interoperability is regularly tested with other QUIC implementations.

Features

Standardized Features

• All big features conforming with RFC 9000, RFC9001, RFC9002, RFC9114 and RFC9204, including the interface between QUIC and TLS, 0-RTT connection establishment, HTTP/3 and QPACK.
• ALPN Extension conforming with RFC7301

Supported TLS 1.3 Cipher Suites

XQUIC supports the following TLS 1.3 cipher suites for QUIC packet protection (as defined in RFC 9001 Section 5):

Cipher Suite	AEAD	Header Protection	Status
TLS_AES_128_GCM_SHA256	AEAD_AES_128_GCM	AES-ECB (128-bit)	Supported
TLS_AES_256_GCM_SHA384	AEAD_AES_256_GCM	AES-ECB (256-bit)	Supported
TLS_CHACHA20_POLY1305_SHA256	AEAD_CHACHA20_POLY1305	ChaCha20	Supported
TLS_AES_128_CCM_SHA256	AEAD_AES_128_CCM	—	Not Supported
TLS_AES_128_CCM_8_SHA256	—	—	Not Supported

Note: TLS_AES_128_CCM_SHA256 and TLS_AES_128_CCM_8_SHA256 are not supported. CCM-based cipher suites are optional per RFC 9001 and have significantly lower confidentiality and integrity limits (2^21.5) compared to GCM (2^23 / 2^52) and ChaCha20-Poly1305. TLS_AES_128_CCM_8_SHA256 is further excluded from QUIC usage by RFC 9001 as no header protection scheme is defined for it.

Not Yet Standardized Features

• Multipath QUIC
• QUIC-LB

Library Features

• Pluggable congestion control: NewReno, Cubic, BBR and BBRv2, ...
• Pluggable cryptography, integration with BoringSSL and BabaSSL
• Cross-platform implementation, support Android, iOS, HarmonyOS, Linux, macOS and Windows(v1.2.0)

Requirements

To build XQUIC, you need

• CMake
• BoringSSL or BabaSSL

To run test cases, you need

• libevent
• CUnit

QuickStart Guide

XQUIC can be built with BabaSSL(Tongsuo) or BoringSSL.

Build with BoringSSL

…

Build with BabaSSL(Tongsuo)

…

Run testcases

sh ../scripts/xquic_test.sh

Documentation

• For using the API, see the API docs.

• For platform support details, see the Platforms docs.

• For Chinese Simplified (zh-CN) translation of the IETF QUIC Protocol, see the Translation docs.

  • RFC8999-invariants-zh
  • RFC9000-transport-zh
  • RFC9001-tls-zh
  • RFC9002-recovery-zh
  • draft-ietf-quic-http-34-zh
  • draft-ietf-quic-qpack-21-zh
  • RFC9221-datagram-zh

• For using quic-qlog, see the Features: qlog

• For testing the library, see the Testing docs.

• For other frequently asked questions, see the FAQs and Trouble Shooting Guide.

Contributing

We would love for you to contribute to XQUIC and help make it even better than it is today! All types of contributions are encouraged and valued. Thanks to all contributors. See our Contributing Guidelines for more information.

If you have any questions, please feel free to open a new Discussion topic in our discussion forums.

License

XQUIC is released under the Apache 2.0 License.

Contact Us

Feel free to contact us in the following ways:

• e-mail: [email protected]
• Dingtalk group: 34059705
• slack channel: #xquic in quicdev group