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
133 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 19f667fba5 Release 1.17.14 
- [FEATURE] http_client can now collect stats: time to connect, TTFB,
  time to download, requests per seconds, and bandwidth.  See -t flag.

- [BUGFIX] http_client: -B, -K, and -r can be used at the same time.

- [BUGFIX] http_client: do not display cert chain before each request.
  Now this is only done once per connection, if the handshake is
  successful and -a option is given.

- [BUGFIX] Do not wait to dispatch on_close() after reading.  If a
  stream is scheduled to be closed after on_read() callback returns,
  close it immediately instead of waiting until the end of the tick.
  If client creates new request from on_close() event, they will be
  processed in the same tick instead of waiting for the next one.

- [BUGFIX] HEADERS stream is critical: always treat it with highest
  priority.
2019-01-16 15:13:59 -05:00
docs Latest changes 2017-10-31 09:35:58 -04:00
include Release 1.17.14 2019-01-16 15:13:59 -05:00
src Release 1.17.14 2019-01-16 15:13:59 -05:00
test Release 1.17.14 2019-01-16 15:13:59 -05:00
wincompat Merge wincompat/test_common_win.c into test_common.c 2018-05-07 16:31:15 -04:00
.travis.yml Turn off Analyzer if using Travis -- it breaks all tests for some reason 2018-04-23 14:54:51 -04:00
APIs.txt Release 1.17.11 2019-01-03 11:48:45 -05:00
BUILD-WINDOWS.md Release 1.17.0 2018-10-16 09:03:33 -04:00
CHANGELOG Release 1.17.14 2019-01-16 15:13:59 -05:00
CMakeLists.txt Release 1.17.11 2019-01-03 11:48:45 -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 1.11.0: [FEATURE] Add support for Q044 2018-08-15 15:06:58 -04:00

README.md

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 will be added once the IETF version of the protocol settles down a little.

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

If you want to turn on optimizations, do

cmake -DCMAKE_BUILD_TYPE=Release . && make
  1. Install the library

This is the manual step. You will need to copy library files manually. LSQUIC client library needs two: ssl/libssl.a and crypto/libcrypto.a. To install these in /usr/local/lib, you should do the following:

BORINGSSL_SOURCE=$PWD
cd /usr/local/lib
sudo cp $BORINGSSL_SOURCE/ssl/libssl.a .
sudo cp $BORINGSSL_SOURCE/crypto/libcrypto.a .

If you do not want to install the library (or do not have root), you can do this instead:

BORINGSSL_SOURCE=$PWD
mkdir -p $HOME/tmp/boringssl-libs
cd $HOME/tmp/boringssl-libs
ln -s $BORINGSSL_SOURCE/ssl/libssl.a
ln -s $BORINGSSL_SOURCE/crypto/libcrypto.a

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
cmake -DBORINGSSL_INCLUDE=$BORINGSSL_SOURCE/include \
                                -DBORINGSSL_LIB=$HOME/tmp/boringssl-libs .
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