francoismichel/coding-for-quic-go

A QUIC implementation in pure go

A QUIC implementation in pure Go

quic-go is an implementation of the QUIC protocol in Go. It roughly implements the IETF QUIC draft, although we don't fully support any of the draft versions at the moment.

FEC Extension

This fork proposes a simple Forward Erasure Correction (FEC) extension as proposed in the current Coding for QUIC IRTF draft. It currently implements the third version of the draft, except the negociation process. Two block error correcting codes are currently proposed: XOR and Reed-Solomon. A sliding-window RLC code is on the way. This work is a refactor of our previous implementation presented during the IFIP Networking 2019 conference. This version is currently simpler than the previous version, but aims at staying as up-to-date as possible with both the IRTF draft version and the upstream quic-go implementation, this is why we want to keep a rather simple code. Of course, contributions are welcome.

FEC-enabled HTTP/3 communication

You will find an example of an FEC-enabled HTTP/3 server and client in the example-fec/mail.go file.

To run a FEC-enabled server that will send Reed-Solomon-encoded REPAIR frames, run :

	go run example-fec/main.go -s -p port_to_listen_to -fec -fecScheme rs

To run a FEC-enabled client that will send XOR-encoded REPAIR frames (and decode the Reed-Solomon-encoded REPAIR frames sent by the server), run :

	go run example-fec/main.go -fec -fecScheme rs https://server_address:port/resource_path

You can read the code of this example to better understand how to configure a QUIC session using FEC.

Version compatibility

Since quic-go is under active development, there's no guarantee that two builds of different commits are interoperable. The QUIC version used in the master branch is just a placeholder, and should not be considered stable.

If you want to use quic-go as a library in other projects, please consider using a tagged release. These releases expose experimental QUIC versions, which are guaranteed to be stable.

Google QUIC

quic-go used to support both the QUIC versions supported by Google Chrome and QUIC as deployed on Google's servers, as well as IETF QUIC. Due to the divergence of the two protocols, we decided to not support both versions any more.

The master branch only supports IETF QUIC. For Google QUIC support, please refer to the gquic branch.

Guides

We currently support Go 1.12+, with Go modules support enabled.

Installing and updating dependencies:

go get -u ./...

Running tests:

go test ./...

QUIC without HTTP/3

Take a look at this echo example.

Usage

As a server

See the example server. Starting a QUIC server is very similar to the standard lib http in go:

http.Handle("/", http.FileServer(http.Dir(wwwDir)))
http3.ListenAndServeQUIC("localhost:4242", "/path/to/cert/chain.pem", "/path/to/privkey.pem", nil)

As a client

See the example client. Use a http3.RoundTripper as a Transport in a http.Client.

http.Client{
  Transport: &http3.RoundTripper{},
}

Contributing

We are always happy to welcome new contributors! We have a number of self-contained issues that are suitable for first-time contributors, they are tagged with help wanted. If you have any questions, please feel free to reach out by opening an issue or leaving a comment.