Skip to content

Latest commit

 

History

History
88 lines (74 loc) · 3.01 KB

README.md

File metadata and controls

88 lines (74 loc) · 3.01 KB
Raw

picoquic sample

The sample program is a simple QUIC client/server demo.

Building

picoquic_sample is built as part of the compilation process of picoquic. It will be available in the root folder.

Usage

Usage: ../picoquic_sample client server_name port folder *queried_file or : ../picoquic_sample server port cert_file private_key_file folder

Example

Generate the certificates:

openssl req -x509 -newkey rsa:2048 -days 365 -keyout ca-key.pem -out ca-cert.pem
openssl req -newkey rsa:2048 -keyout server-key.pem -out server-req.pem

These commands will prompt a few questions, you don't need to put actual data for this simple test.

Create a folder to hold server files:

mkdir server_files
echo "Hello world!" >> ./server_files/index.htm

And run the server:

./picoquic_sample server 4433 ./ca-cert.pem ./server-key.pem ./server_files

Then, test if you can reach it using the client:

./picoquic_sample client localhost 4433 /tmp index.htm

Getting logs

Both server and clients will create logs of the connections if they can write files in the expected folders. If you want logs, you will need to create these folders before launching the server or the client.

The log files are in the qlog format. They will be added to the working directory of client or server. The name of the log files are derived from the initial connection identifier used for the connection, which is represented as a string of hexadecimal digits. For example, if the Initial CID is 012345678abcdef, the logs created by client and server will be:

012345678abcdef.client.qlog
012345678abcdef.server.qlog

The qlog syntax is defined using JSON. The logs can be read using a text editor, or with specialized tools like QVIS

Building the sample

The sample is built when building picoquic using cmake and make, but you may want to build it separately from picoquic. For that, you will need to compile the sample components: sample.c, sample_client.c and sample_server.c. This requires accessing sample.h, and adding an include search path to picoquic\lib in order to find the include files:

  • Picoquic API: picoquic.h
  • Picoquic portable socket API: picosocks.h
  • Picoquic utilities: picoquic_utils.h

You will then need to link the objects with the following dependencies:

  • Picoquic core library: libpicoquic-core.a
  • Picoquic logging library: libpicoquic-log.a
  • Picotls core library: libpicotls-core.a
  • Picotls fusion library: libpicotls-fusion.a
  • Picotls minicrypto library: libpicotls-minicrypto.a
  • Picotls openssl mapping library: libpicotls-openssl.a
  • OpenSSL library: libssl.so
  • OpenSSL crypto library: libcrypto.so

On Windows, these dependencies have different names, as seen in the project sample.vcxproj

Suggestions for a better experience and contributions such as CMake of make files would be most welcome!