litespeed-quic/README.md

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. We think it is free of major problems. Nevertheless, do not hesitate to report bugs back to us. Even better, send us fixes and improvements!

Currently supported QUIC versions are Q039, Q043, Q046, ID-23, and ID-24. Support for newer versions will be added soon after they are released.

Documentation

The documentation for this module is admittedly sparse. The API is documented in include/lsquic.h. If you have doxygen, you can run doxygen dox.cfg or make docs. The example program is test/http_client.c: a bare-bones, but working, QUIC client. Have a look in EXAMPLES.txt to see how it can be used.

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.

2. Use specific BoringSSL version

git checkout 49de1fc2910524c888866c7e2b0db1ba8af2a530

3. 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

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

2. Compile the library

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

3. 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=Q046
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
• Windows (this needs updating for the server part, now broken)
  • x86_64

Have fun,

LiteSpeed QUIC Team.

Copyright (c) 2017 - 2019 LiteSpeed Technologies Inc