Skip to content

LiteSpeed QUIC and HTTP/3 Library

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.chrome
Notifications You must be signed in to change notification settings

litespeedtech/lsquic

Folders and files

NameName
Last commit message
Last commit date
Jun 22, 2024
Feb 18, 2025
Apr 4, 2025
Feb 29, 2024
Apr 4, 2025
Dec 20, 2023
Mar 31, 2021
May 6, 2022
Jan 4, 2024
Jul 12, 2022
Feb 20, 2020
Jan 4, 2024
Feb 10, 2021
May 6, 2022
Dec 17, 2020
Feb 18, 2025
Nov 14, 2024
May 6, 2022
Nov 14, 2024
Nov 3, 2022
Jan 4, 2023
Sep 22, 2017
May 29, 2024
Jan 11, 2022
Jan 11, 2022
Dec 15, 2021

Repository files navigation

Linux and MacOS build status Windows build status FreeBSD build status Documentation Status

LiteSpeed QUIC (LSQUIC) Library README

Description

LiteSpeed QUIC (LSQUIC) Library is an open-source implementation of QUIC and HTTP/3 functionality for servers and clients. Most of the code in this distribution is used in our own products: LiteSpeed Web Server, LiteSpeed ADC, and OpenLiteSpeed.

Currently supported QUIC versions are v1, v2, Internet-Draft versions 29, and 27; and the older "Google" QUIC versions Q043, Q046, an Q050.

Standard Compliance

LiteSpeed QUIC is mostly compliant to the follow RFCs:

  • RFC 9000 QUIC: A UDP-Based Multiplexed and Secure Transport
  • RFC 9001 Using TLS to Secure QUIC
  • RFC 9002 QUIC Loss Detection and Congestion Control
  • RFC 9114 HTTP/3
  • RFC 9204 QPACK: Field Compression for HTTP/3

QUIC protocol extensions

The following QUIC protocol extensions are implemented:

Documentation

Documentation is available at https://lsquic.readthedocs.io/en/latest/.

In addition, see example programs for API usage and EXAMPLES.txt for some compilation and run-time options.

Requirements

To build LSQUIC, you need CMake, zlib, and BoringSSL. The example program uses libevent to provide the event loop.

Building BoringSSL

BoringSSL is not packaged; you have to build it yourself. The process is straightforward. You will need go installed.

  1. Clone BoringSSL by issuing the following command:
git clone https://boringssl.googlesource.com/boringssl
cd boringssl

You may need to install pre-requisites like zlib and libevent.

  1. Use specific BoringSSL version
git checkout 9fc1c33e9c21439ce5f87855a6591a9324e569fd

Or, just try the latest master branch.

  1. Compile the library
cmake . &&  make

Remember where BoringSSL sources are:

BORINGSSL=$PWD

If you want to turn on optimizations, do

cmake -DCMAKE_BUILD_TYPE=Release . && make

If you want to build as a library, (necessary to build lsquic itself as as shared library) do:

cmake -DBUILD_SHARED_LIBS=1 . && make

Building LSQUIC Library

LSQUIC's http_client, http_server, and the tests link BoringSSL libraries statically. Following previous section, you can build LSQUIC as follows:

  1. Get the source code
git clone https://github.com/litespeedtech/lsquic.git
cd lsquic
git submodule update --init
  1. Compile the library

Statically:

# $BORINGSSL is the top-level BoringSSL directory from the previous step
cmake -DBORINGSSL_DIR=$BORINGSSL .
make

As a dynamic library:

cmake -DLSQUIC_SHARED_LIB=1 -DBORINGSSL_DIR=$BORINGSSL .
make
  1. Run tests
make test

Building with Docker

The library and the example client and server can be built with Docker.

Initialize Git submodules:

cd lsquic
git submodule update --init

Build the Docker image:

docker build -t lsquic .

Then you can use the examples from the command line. For example:

sudo docker run -it --rm lsquic http_client -s www.google.com  -p / -o version=h3
sudo docker run -p 12345:12345/udp -v /path/to/certs:/mnt/certs -it --rm lsquic http_server -c www.example.com,/mnt/certs/chain,/mnt/certs/key

Platforms

The library has been tested on the following platforms:

  • Linux
    • i386
    • x86_64
    • ARM (Raspberry Pi 3)
  • FreeBSD
    • i386
  • MacOS
    • x86_64
  • iOS
    • ARM
  • Android
    • ARM
  • Windows
    • x86_64

Get Involved

Do not hesitate to report bugs back to us. Even better, send us fixes and improvements!

Have fun,

LiteSpeed QUIC Team.

Copyright (c) 2017 - 2021 LiteSpeed Technologies Inc