No description
Find a file
2023-01-04 15:21:42 -05:00
bin Release 3.1.3 2022-08-19 11:21:44 -04:00
docs Release 3.3.0 2023-01-04 15:21:42 -05:00
include Release 3.3.0 2023-01-04 15:21:42 -05:00
src Release 3.3.0 2023-01-04 15:21:42 -05:00
tests Release 3.2.0 2022-10-20 11:47:58 -04:00
tools Release 2.29.6 2021-03-31 09:38:32 -04:00
wincompat Release 3.1.0 2022-05-06 12:49:46 -04:00
.cirrus.yml Release 2.29.0 2021-02-10 08:51:11 -05:00
.gitmodules Do not force ls-qpack to track branch v0.9.13 . 2022-07-12 15:47:42 -04:00
.nojekyll Switch to readthedocs.org for hosting documentation 2020-02-20 16:56:57 -05:00
.travis.yml Release 2.29.0 2021-02-10 08:51:11 -05:00
APIs.txt Release 3.1.0 2022-05-06 12:49:46 -04:00
appveyor-linux.yml Disable cache for boringSSL, which causes build to fail. 2022-01-11 17:06:22 -05:00
appveyor-windows.cmd Release 3.0.4 2022-01-11 11:17:44 -05:00
appveyor-windows.yml [WIP] use vcpkg for getopt; build windows shared lib enhancements (#350) 2021-12-15 11:38:20 -05:00
BUILD-WINDOWS.md Release 2.26.1 2020-12-17 14:39:51 -05:00
CHANGELOG Release 3.3.0 2023-01-04 15:21:42 -05:00
CMakeLists.txt fix useless getopt.h check (#424) 2022-09-29 09:15:30 -04:00
CONTRIBUTORS.txt Release 3.1.0 2022-05-06 12:49:46 -04:00
Dockerfile Fix paths in Dockerfile (#289) 2021-06-05 10:08:20 -04:00
EXAMPLES.txt fix typo (#429) 2022-11-03 10:56:42 -04:00
LICENSE Release 3.3.0 2023-01-04 15:21:42 -05:00
LICENSE.chrome LSQUIC Client: Initial release 2017-09-22 17:00:03 -04:00
README.md Release 3.3.0 2023-01-04 15:21:42 -05:00

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, Internet-Draft versions 29, and 27; and the older "Google" QUIC versions Q043, Q046, an Q050.

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 31bad2514d21f6207f3925ba56754611c462a873

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 init
git submodule update
  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 init
git submodule update

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-29
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