iv-org-mirror/litespeed-quic
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/litespeed-quic.git synced 2024-08-15 00:53:43 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
156 commits 10 branches 192 tags 11 MiB
C 75.8%
NASL 23.1%
C++ 0.5%
CMake 0.4%
Perl 0.1%
Find a file
Dmitri Tikhonov 428530e38e Release 1.19.6 
- [BUGFIX] Ensure that Largest Observed does not decrease in ACKs we
  send.  ACK frames placed in packets in buffered queues (optimization
  introduced in 1.17.15) can be preceded by an ACK frame generated later.
  In this case, the older ACK frame should not be sent out, as Chromium-
  based servers flags decrease in the ACK frame's Largest Observed value
  as an error.
2019-03-19 16:23:50 -04:00
docs Latest changes 2017-10-31 09:35:58 -04:00
include Release 1.19.6 2019-03-19 16:23:50 -04:00
src Release 1.19.6 2019-03-19 16:23:50 -04:00
test Release 1.19.5 2019-03-05 16:56:02 -05:00
tools/bench Release 1.18.0 2019-01-28 15:41:28 -05:00
wincompat Resuscitate Windows build (#61) 2019-01-30 15:28:35 -05:00
.cirrus.yml Simplify configuration -- use more cmake functions (#62) 2019-02-01 02:12:06 -05:00
.travis.yml Simplify configuration -- use more cmake functions (#62) 2019-02-01 02:12:06 -05:00
APIs.txt Release 1.17.11 2019-01-03 11:48:45 -05:00
BUILD-WINDOWS.md Update Windows build instructions 2019-02-01 02:41:23 -05:00
CHANGELOG Release 1.19.6 2019-03-19 16:23:50 -04:00
CMakeLists.txt Release 1.19.0 2019-02-04 08:59:11 -05:00
CONTRIBUTORS.txt Release 1.17.11 2019-01-03 11:48:45 -05:00
Dockerfile Add basic Dockerfile 2017-10-03 15:33:09 -04:00
dox.cfg LSQUIC Client: Initial release 2017-09-22 17:00:03 -04:00
EXAMPLES.txt Release 1.17.14 2019-01-16 15:13:59 -05:00
LICENSE Release 1.17.11 2019-01-03 11:48:45 -05:00
LICENSE.chrome LSQUIC Client: Initial release 2017-09-22 17:00:03 -04:00
print-glibc-version.sh Latest changes 2018-07-10 11:51:45 -04:00
README.md Update build instructions in the README 2019-02-01 02:24:29 -05:00

README.md

Build Status Build Status Build status

LiteSpeed QUIC (LSQUIC) Client Library README

Description

LiteSpeed QUIC (LSQUIC) Client Library is an open-source implementation of QUIC functionality for clients. It is released in the hope to speed the adoption of QUIC. Most of the code in this distribution is used in our own products: LiteSpeed Web Server and ADC. 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 Q035, Q039, Q043, and Q044. Support for newer versions will be added soon after they are released. The version(s) specified by IETF QUIC WG are being developed on one or more branches. When deemed stable, the IETF QUIC support will be added to the master branch.

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
  1. Check out stable branch:
git checkout chromium-stable
  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

Building LSQUIC Client Library

LSQUIC's http_client 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-client.git
cd lsquic-client
  1. Compile the library
# $BORINGSSL is the top-level BoringSSL directory from the previous step
cmake -DBORINGSSL_DIR=$BORINGSSL .
make
  1. Run tests
make test

Building with Docker

The library and http_client example can be built with Docker.

docker build -t lsquic-client .

Then you can use the http_client example from the command line.

docker run -it --rm lsquic-client http_client -H www.google.com -s 74.125.22.106:443 -p /

Platforms

The client library has been tested on the following platforms:

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

Have fun,

LiteSpeed QUIC Team.

Copyright (c) 2017 - 2018 LiteSpeed Technologies Inc