lnicco / ngtcp2

ngtcp2 project is an effort to implement IETF QUIC protocol

ngtcp2

"Call it TCP/2. One More Time."

ngtcp2 project is an effort to implement QUIC protocol which is now being discussed in IETF QUICWG for its standardization.

Requirements

The libngtcp2 C library itself does not depend on any external libraries. The example client, and server are written in C++14, and should compile with the modern C++ compilers (e.g., clang >= 6.0, or gcc >= 6.0).

The following packages are required to configure the build system:

• pkg-config >= 0.20
• autoconf
• automake
• autotools-dev
• libtool

libngtcp2 uses cunit for its unit test frame work:

• cunit >= 2.1

To build sources under the examples directory, libev and nghttp3 are required:

• libev
• nghttp3 (https://github.com/ngtcp2/nghttp3) for HTTP/3

The client and server under examples directory require patched OpenSSL as crypto backend:

• Patched OpenSSL (https://github.com/tatsuhiro-t/openssl/tree/quic-draft-22)

Build from git

$ git clone --depth 1 -b quic-draft-22 https://github.com/tatsuhiro-t/openssl
$ cd openssl
$ # For Linux
$ ./config enable-tls1_3 --prefix=$PWD/build
$ make -j$(nproc)
$ make install_sw
$ cd ..
$ git clone https://github.com/ngtcp2/nghttp3
$ cd nghttp3
$ autoreconf -i
$ ./configure --prefix=$PWD/build --enable-lib-only
$ make -j$(nproc) check
$ make install
$ cd ..
$ git clone -b draft-22 https://github.com/ngtcp2/ngtcp2
$ cd ngtcp2
$ autoreconf -i
$ # For Mac users who have installed libev with MacPorts, append
$ # ',-L/opt/local/lib' to LDFLAGS, and also pass
$ # CPPFLAGS="-I/opt/local/include" to ./configure.
$ ./configure PKG_CONFIG_PATH=$PWD/../openssl/build/lib/pkgconfig:$PWD/../nghttp3/build/lib/pkgconfig LDFLAGS="-Wl,-rpath,$PWD/../openssl/build/lib"
$ make -j$(nproc) check

Client/Server

After successful build, the client and server executable should be found under examples directory. They talk HTTP/3.

Client

$ examples/client [OPTIONS] <ADDR> <PORT> <URI>

The notable options are:

• -d, --data=<PATH>: Read data from <PATH> and send it to a peer.
• -i, --interactive: Read data from terminal and send it to a peer interactively. This does not work with 0-RTT. See below.

Server

$ examples/server [OPTIONS] <ADDR> <PORT> <PRIVATE_KEY_FILE> <CERTIFICATE_FILE>

The notable options are:

• -V, --validate-addr: Enforce stateless address validation.

Resumption and 0-RTT

In order to resume a session, a session ticket, and a transport parameters must be fetched from server. First, run examples/client with --session-file, and --tp-file options which specify a path to session ticket, and transport parameter files respectively to save them locally.

Once these files are available, run examples/client with the same arguments again. You will see that session is resumed in your log if resumption succeeds. Resuming session makes server's first Handshake packet pretty small because it does not send its certificates.

To send 0-RTT data, after making sure that resumption works, use -d option to specify a file which contains data to send.

License

The MIT License

Copyright (c) 2016 ngtcp2 contributors