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
18 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 bfc7bfd842 Latest changes 
- [API Change] lsquic_engine_connect() returns pointer to the connection
  object.
- [API Change] Add lsquic_conn_get_engine() to get engine object from
  connection object.
- [API Change] Add lsquic_conn_status() to query connection status.
- [API Change] Add add lsquic_conn_set_ctx().
- [API Change] Add new timestamp format, e.g. 2017-03-21 13:43:46.671345
- [OPTIMIZATION] Process handshake STREAM frames as soon as packet
  arrives.
- [OPTIMIZATION] Do not compile expensive send controller sanity check
  by default.
- [OPTIMIZATION] Add fast path to gquic_be_gen_reg_pkt_header.
- [OPTIMIZATION] Only make squeeze function call if necessary.
- [OPTIMIZATION] Speed up Q039 ACK frame parsing.
- [OPTIMIZATION] Fit most used elements of packet_out into first 64 bytes.
- [OPTIMIZATION] Keep track of scheduled bytes instead of calculating.
- [OPTIMIZATION] Prefetch next unacked packet when processing ACK.
- [OPTIMIZATION] Leverage fact that ACK ranges and unacked list are.
  ordered.
- [OPTIMIZATION] Reduce function pointer use for STREAM frame generation
- Fix: reset incoming streams that arrive after we send GOAWAY.
- Fix: delay client on_new_conn() call until connection is fully set up.
- Fixes to buffered packets logic: splitting, STREAM frame elision.
- Fix: do not dispatch on_write callback if no packets are available.
- Fix WINDOW_UPDATE send and resend logic.
- Fix STREAM frame extension code.
- Fix: Drop unflushed data when stream is reset.
- Switch to tracking CWND using bytes rather than packets.
- Fix TCP friendly adjustment in cubic.
- Fix: do not generate invalid STOP_WAITING frames during high packet
  loss.
- Pacer fixes.
2018-02-26 16:01:16 -05:00
docs Latest changes 2017-10-31 09:35:58 -04:00
include Latest changes 2018-02-26 16:01:16 -05:00
src Latest changes 2018-02-26 16:01:16 -05:00
test Latest changes 2018-02-26 16:01:16 -05:00
APIs.txt Add APIs.txt -- describe LSQUIC APIs on high level 2017-10-31 14:28:04 -04:00
CHANGELOG Latest changes 2018-02-26 16:01:16 -05:00
CMakeLists.txt Latest changes 2018-02-26 16:01:16 -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 Latest changes 2018-02-26 16:01:16 -05:00
LICENSE LSQUIC Client: Initial release 2017-09-22 17:00:03 -04:00
LICENSE.chrome LSQUIC Client: Initial release 2017-09-22 17:00:03 -04:00
README.md Update README with Docker instructions. 2017-10-03 15:37:20 -04:00

README.md

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, Q037, Q038, Q039, and Q041. 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
    • x86_64
    • ARM (Raspberry Pi 3)
  • FreeBSD
    • i386
  • MacOS
    • x86_64

Have fun,

LiteSpeed QUIC Team.

Copyright (c) 2017 LiteSpeed Technologies Inc