Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alibaba/xquic
XQUIC Library released by Alibaba is a cross-platform implementation of QUIC and HTTP/3 protocol.
https://github.com/alibaba/xquic
http3 ietf protocol quic tls13
Last synced: 3 months ago
JSON representation
XQUIC Library released by Alibaba is a cross-platform implementation of QUIC and HTTP/3 protocol.
- Host: GitHub
- URL: https://github.com/alibaba/xquic
- Owner: alibaba
- License: apache-2.0
- Created: 2021-11-05T12:53:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-21T09:52:37.000Z (4 months ago)
- Last Synced: 2024-07-21T18:54:25.092Z (4 months ago)
- Topics: http3, ietf, protocol, quic, tls13
- Language: C
- Homepage:
- Size: 5.18 MB
- Stars: 1,648
- Watchers: 62
- Forks: 326
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-quic - xquic - Alibaba's cross-platform QUIC and HTTP/3 protocol implementation (Implementations)
README
# XQUIC
[](https://github.com/alibaba/xquic/actions/workflows/build.yml)
[](https://github.com/alibaba/xquic/actions/workflows/codeql-analysis.yml)
[](https://www.codacy.com/gh/alibaba/xquic/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alibaba/xquic&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/alibaba/xquic/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alibaba/xquic&utm_campaign=Badge_Coverage)
> [简体中文文档 README-zh-CN](https://github.com/alibaba/xquic/blob/main/docs/docs-zh/README-zh.md)
## 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](https://interop.seemann.io/) is regularly tested with other QUIC implementations.
### Features
[](https://tools.ietf.org/html/rfc9000)
[](https://tools.ietf.org/html/rfc9001)
[](https://tools.ietf.org/html/rfc9002)
[](https://tools.ietf.org/html/rfc9114)
[](https://tools.ietf.org/html/rfc9204)
[](https://datatracker.ietf.org/doc/html/rfc9221)
[](https://tools.ietf.org/html/draft-ietf-quic-load-balancers-13)
[](https://tools.ietf.org/html/draft-ietf-quic-multipath-05)
[](https://tools.ietf.org/html/draft-ietf-quic-multipath-06)
[](https://datatracker.ietf.org/doc/html/draft-ietf-quic-qlog-main-schema-07)
#### Standardized Features
* All big features conforming with [RFC 9000](https://www.rfc-editor.org/rfc/rfc9000), [RFC9001](https://www.rfc-editor.org/rfc/rfc9001), [RFC9002](https://www.rfc-editor.org/rfc/rfc9002), [RFC9114](https://www.rfc-editor.org/rfc/rfc9114) and [RFC9204](https://www.rfc-editor.org/rfc/rfc9204), including the interface between QUIC and TLS, 0-RTT connection establishment, HTTP/3 and QPACK.
* ALPN Extension conforming with [RFC7301](https://www.rfc-editor.org/rfc/rfc7301)
#### Not Yet Standardized Features
* [Multipath QUIC](https://tools.ietf.org/html/draft-ietf-quic-multipath-04)
* [QUIC-LB](https://tools.ietf.org/html/draft-ietf-quic-load-balancers-13)
#### 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 Tongsuo(BabaSSL) or BoringSSL.
### Build with BoringSSL
```bash
# get XQUIC source code
git clone https://github.com/alibaba/xquic.git
cd xquic
# get and build BoringSSL
git clone https://github.com/google/boringssl.git ./third_party/boringssl
cd ./third_party/boringssl
mkdir -p build && cd build
cmake -DBUILD_SHARED_LIBS=0 -DCMAKE_C_FLAGS="-fPIC" -DCMAKE_CXX_FLAGS="-fPIC" ..
make ssl crypto
cd ..
SSL_TYPE_STR="boringssl"
SSL_PATH_STR="${PWD}"
cd ../..
## Note: if you don’t have golang in your environment, please install [golang](https://go.dev/doc/install) first.
# build XQUIC with BoringSSL
# When build XQUIC with boringssl, /usr/local/babassl directory will be searched
# as default. if boringssl is deployed in other directories, SSL_PATH could be
# used to specify the search path of boringssl
git submodule update --init --recursive
mkdir -p build; cd build
cmake -DGCOV=on -DCMAKE_BUILD_TYPE=Debug -DXQC_ENABLE_TESTING=1 -DXQC_SUPPORT_SENDMMSG_BUILD=1 -DXQC_ENABLE_EVENT_LOG=1 -DXQC_ENABLE_BBR2=1 -DXQC_ENABLE_RENO=1 -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} ..
# exit if cmake error
if [ $? -ne 0 ]; then
echo "cmake failed"
exit 1
fi
make -j
```
### Build with BabaSSL(Tongsuo)
```bash
# get XQUIC source code
git clone https://github.com/alibaba/xquic.git
cd xquic
# get and build BabaSSL(Tongsuo)
git clone -b 8.3-stable https://github.com/Tongsuo-Project/Tongsuo.git ./third_party/babassl
cd ./third_party/babassl/
./config --prefix=/usr/local/babassl
make -j
SSL_TYPE_STR="babassl"
SSL_PATH_STR="${PWD}"
cd -
# build XQUIC with BabaSSL
# When build XQUIC with boringssl, /usr/local/babassl directory will be searched
# as default. if boringssl is deployed in other directories, SSL_PATH could be
# used to specify the search path of boringssl
git submodule update --init --recursive
mkdir -p build; cd build
cmake -DGCOV=on -DCMAKE_BUILD_TYPE=Debug -DXQC_ENABLE_TESTING=1 -DXQC_SUPPORT_SENDMMSG_BUILD=1 -DXQC_ENABLE_EVENT_LOG=1 -DXQC_ENABLE_BBR2=1 -DXQC_ENABLE_RENO=1 -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} ..
# exit if cmake error
if [ $? -ne 0 ]; then
echo "cmake failed"
exit 1
fi
make -j
```
### Run testcases
```bash
sh ../scripts/xquic_test.sh
```
## Documentation
* For using the API, see the [API docs](./docs/API.md).
* For platform support details, see the [Platforms docs](./docs/Platforms.md).
* For Chinese Simplified (zh-CN) translation of the IETF QUIC Protocol, see the Translation docs.
- [RFC8999-invariants-zh](./docs/translation/rfc8999-invariants-zh.md)
- [RFC9000-transport-zh](./docs/translation/rfc9000-transport-zh.md)
- [RFC9001-tls-zh](./docs/translation/rfc9001-tls-zh.md)
- [RFC9002-recovery-zh](./docs/translation/rfc9002-recovery-zh.md)
- [draft-ietf-quic-http-34-zh](./docs/translation/draft-ietf-quic-http-34-zh.md)
- [draft-ietf-quic-qpack-21-zh](./docs/translation/draft-ietf-quic-qpack-21-zh.md)
- [RFC9221-datagram-zh](./docs/translation/rfc9221-datagram-zh.md)
* For using quic-qlog, see the [Features: qlog](./docs/Features.md)
* For testing the library, see the [Testing docs](./docs/docs-zh/Testing-zh.md).
* For other frequently asked questions, see the [FAQs](./docs/docs-zh/FAQ-zh.md) and [Trouble Shooting Guide](./docs/docs-zh/Troubleshooting-zh.md).
## 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](https://github.com/alibaba/xquic/blob/main/CONTRIBUTING.md#all-contributors). See our [Contributing Guidelines](./CONTRIBUTING.md) for more information.
If you have any questions, please feel free to open a new Discussion topic in our [discussion forums](https://github.com/alibaba/xquic/discussions).
## 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
