github.com/MerlinKodo/quic-go@v0.39.2/README.md (about) 1 # A QUIC implementation in pure Go 2 3 <img src="docs/quic.png" width=303 height=124> 4 5 [](https://pkg.go.dev/github.com/MerlinKodo/quic-go) 6 [](https://codecov.io/gh/quic-go/quic-go/) 7 [](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:quic-go) 8 9 quic-go is an implementation of the QUIC protocol ([RFC 9000](https://datatracker.ietf.org/doc/html/rfc9000), [RFC 9001](https://datatracker.ietf.org/doc/html/rfc9001), [RFC 9002](https://datatracker.ietf.org/doc/html/rfc9002)) in Go. It has support for HTTP/3 ([RFC 9114](https://datatracker.ietf.org/doc/html/rfc9114)), including QPACK ([RFC 9204](https://datatracker.ietf.org/doc/html/rfc9204)). 10 11 In addition to these base RFCs, it also implements the following RFCs: 12 * Unreliable Datagram Extension ([RFC 9221](https://datatracker.ietf.org/doc/html/rfc9221)) 13 * Datagram Packetization Layer Path MTU Discovery (DPLPMTUD, [RFC 8899](https://datatracker.ietf.org/doc/html/rfc8899)) 14 * QUIC Version 2 ([RFC 9369](https://datatracker.ietf.org/doc/html/rfc9369)) 15 * QUIC Event Logging using qlog ([draft-ietf-quic-qlog-main-schema](https://datatracker.ietf.org/doc/draft-ietf-quic-qlog-main-schema/) and [draft-ietf-quic-qlog-quic-events](https://datatracker.ietf.org/doc/draft-ietf-quic-qlog-quic-events/)) 16 17 ## Using QUIC 18 19 ### Running a Server 20 21 The central entry point is the `quic.Transport`. A transport manages QUIC connections running on a single UDP socket. Since QUIC uses Connection IDs, it can demultiplex a listener (accepting incoming connections) and an arbitrary number of outgoing QUIC connections on the same UDP socket. 22 23 ```go 24 udpConn, err := net.ListenUDP("udp4", &net.UDPAddr{Port: 1234}) 25 // ... error handling 26 tr := quic.Transport{ 27 Conn: udpConn, 28 } 29 ln, err := tr.Listen(tlsConf, quicConf) 30 // ... error handling 31 go func() { 32 for { 33 conn, err := ln.Accept() 34 // ... error handling 35 // handle the connection, usually in a new Go routine 36 } 37 }() 38 ``` 39 40 The listener `ln` can now be used to accept incoming QUIC connections by (repeatedly) calling the `Accept` method (see below for more information on the `quic.Connection`). 41 42 As a shortcut, `quic.Listen` and `quic.ListenAddr` can be used without explicitly initializing a `quic.Transport`: 43 44 ``` 45 ln, err := quic.Listen(udpConn, tlsConf, quicConf) 46 ``` 47 48 When using the shortcut, it's not possible to reuse the same UDP socket for outgoing connections. 49 50 ### Running a Client 51 52 As mentioned above, multiple outgoing connections can share a single UDP socket, since QUIC uses Connection IDs to demultiplex connections. 53 54 ```go 55 ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second) // 3s handshake timeout 56 defer cancel() 57 conn, err := tr.Dial(ctx, <server address>, <tls.Config>, <quic.Config>) 58 // ... error handling 59 ``` 60 61 As a shortcut, `quic.Dial` and `quic.DialAddr` can be used without explictly initializing a `quic.Transport`: 62 63 ```go 64 ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second) // 3s handshake timeout 65 defer cancel() 66 conn, err := quic.Dial(ctx, conn, <server address>, <tls.Config>, <quic.Config>) 67 ``` 68 69 Just as we saw before when used a similar shortcut to run a server, it's also not possible to reuse the same UDP socket for other outgoing connections, or to listen for incoming connections. 70 71 ### Using a QUIC Connection 72 73 #### Accepting Streams 74 75 QUIC is a stream-multiplexed transport. A `quic.Connection` fundamentally differs from the `net.Conn` and the `net.PacketConn` interface defined in the standard library. Data is sent and received on (unidirectional and bidirectional) streams (and, if supported, in [datagrams](#quic-datagrams)), not on the connection itself. The stream state machine is described in detail in [Section 3 of RFC 9000](https://datatracker.ietf.org/doc/html/rfc9000#section-3). 76 77 Note: A unidirectional stream is a stream that the initiator can only write to (`quic.SendStream`), and the receiver can only read from (`quic.ReceiveStream`). A bidirectional stream (`quic.Stream`) allows reading from and writing to for both sides. 78 79 On the receiver side, streams are accepted using the `AcceptStream` (for bidirectional) and `AcceptUniStream` functions. For most user cases, it makes sense to call these functions in a loop: 80 81 ```go 82 for { 83 str, err := conn.AcceptStream(context.Background()) // for bidirectional streams 84 // ... error handling 85 // handle the stream, usually in a new Go routine 86 } 87 ``` 88 89 These functions return an error when the underlying QUIC connection is closed. 90 91 #### Opening Streams 92 93 There are two slightly different ways to open streams, one synchronous and one (potentially) asynchronous. This API is necessary since the receiver grants us a certain number of streams that we're allowed to open. It may grant us additional streams later on (typically when existing streams are closed), but it means that at the time we want to open a new stream, we might not be able to do so. 94 95 Using the synchronous method `OpenStreamSync` for bidirectional streams, and `OpenUniStreamSync` for unidirectional streams, an application can block until the peer allows opening additional streams. In case that we're allowed to open a new stream, these methods return right away: 96 97 ```go 98 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) 99 defer cancel() 100 str, err := conn.OpenStreamSync(ctx) // wait up to 5s to open a new bidirectional stream 101 ``` 102 103 The asynchronous version never blocks. If it's currently not possible to open a new stream, it returns a `net.Error` timeout error: 104 105 ```go 106 str, err := conn.OpenStream() 107 if nerr, ok := err.(net.Error); ok && nerr.Timeout() { 108 // It's currently not possible to open another stream, 109 // but it might be possible later, once the peer allowed us to do so. 110 } 111 ``` 112 113 These functions return an error when the underlying QUIC connection is closed. 114 115 #### Using Streams 116 117 Using QUIC streams is pretty straightforward. The `quic.ReceiveStream` implements the `io.Reader` interface, and the `quic.SendStream` implements the `io.Writer` interface. A bidirectional stream (`quic.Stream`) implements both these interfaces. Conceptually, a bidirectional stream can be thought of as the composition of two unidirectional streams in opposite directions. 118 119 Calling `Close` on a `quic.SendStream` or a `quic.Stream` closes the send side of the stream. On the receiver side, this will be surfaced as an `io.EOF` returned from the `io.Reader` once all data has been consumed. Note that for bidirectional streams, `Close` _only_ closes the send side of the stream. It is still possible to read from the stream until the peer closes or resets the stream. 120 121 In case the application wishes to abort sending on a `quic.SendStream` or a `quic.Stream` , it can reset the send side by calling `CancelWrite` with an application-defined error code (an unsigned 62-bit number). On the receiver side, this surfaced as a `quic.StreamError` containing that error code on the `io.Reader`. Note that for bidirectional streams, `CancelWrite` _only_ resets the send side of the stream. It is still possible to read from the stream until the peer closes or resets the stream. 122 123 Conversely, in case the application wishes to abort receiving from a `quic.ReceiveStream` or a `quic.Stream`, it can ask the sender to abort data transmission by calling `CancelRead` with an application-defined error code (an unsigned 62-bit number). On the receiver side, this surfaced as a `quic.StreamError` containing that error code on the `io.Writer`. Note that for bidirectional streams, `CancelWrite` _only_ resets the receive side of the stream. It is still possible to write to the stream. 124 125 A bidirectional stream is only closed once both the read and the write side of the stream have been either closed and reset. Only then the peer is granted a new stream according to the maximum number of concurrent streams configured via `quic.Config.MaxIncomingStreams`. 126 127 ### Configuring QUIC 128 129 The `quic.Config` struct passed to both the listen and dial calls (see above) contains a wide range of configuration options for QUIC connections, incl. the ability to fine-tune flow control limits, the number of streams that the peer is allowed to open concurrently, keep-alives, idle timeouts, and many more. Please refer to the documentation for the `quic.Config` for details. 130 131 The `quic.Transport` contains a few configuration options that don't apply to any single QUIC connection, but to all connections handled by that transport. It is highly recommend to set the `StatelessResetToken`, which allows endpoints to quickly recover from crashes / reboots of our node (see [Section 10.3 of RFC 9000](https://datatracker.ietf.org/doc/html/rfc9000#section-10.3)). 132 133 ### Closing a Connection 134 135 #### When the remote Peer closes the Connection 136 137 In case the peer closes the QUIC connection, all calls to open streams, accept streams, as well as all methods on streams immediately return an error. Additionally, it is set as cancellation cause of the connection context. Users can use errors assertions to find out what exactly went wrong: 138 139 * `quic.VersionNegotiationError`: Happens during the handshake, if there is no overlap between our and the remote's supported QUIC versions. 140 * `quic.HandshakeTimeoutError`: Happens if the QUIC handshake doesn't complete within the time specified in `quic.Config.HandshakeTimeout`. 141 * `quic.IdleTimeoutError`: Happens after completion of the handshake if the connection is idle for longer than the minimum of both peers idle timeouts (as configured by `quic.Config.IdleTimeout`). The connection is considered idle when no stream data (and datagrams, if applicable) are exchanged for that period. The QUIC connection can be instructed to regularly send a packet to prevent a connection from going idle by setting `quic.Config.KeepAlive`. However, this is no guarantee that the peer doesn't suddenly go away (e.g. by abruptly shutting down the node or by crashing), or by a NAT binding expiring, in which case this error might still occur. 142 * `quic.StatelessResetError`: Happens when the remote peer lost the state required to decrypt the packet. This requires the `quic.Transport.StatelessResetToken` to be configured by the peer. 143 * `quic.TransportError`: Happens if when the QUIC protocol is violated. Unless the error code is `APPLICATION_ERROR`, this will not happen unless one of the QUIC stacks involved is misbehaving. Please open an issue if you encounter this error. 144 * `quic.ApplicationError`: Happens when the remote decides to close the connection, see below. 145 146 #### Initiated by the Application 147 148 A `quic.Connection` can be closed using `CloseWithError`: 149 150 ```go 151 conn.CloseWithError(0x42, "error 0x42 occurred") 152 ``` 153 154 Applications can transmit both an error code (an unsigned 62-bit number) as well as a UTF-8 encoded human-readable reason. The error code allows the receiver to learn why the connection was closed, and the reason can be useful for debugging purposes. 155 156 On the receiver side, this is surfaced as a `quic.ApplicationError`. 157 158 ### QUIC Datagrams 159 160 Unreliable datagrams are a QUIC extension ([RFC 9221](https://datatracker.ietf.org/doc/html/rfc9221)) that is negotiated during the handshake. Support can be enabled by setting the `quic.Config.EnableDatagram` flag. Note that this doesn't guarantee that the peer also supports datagrams. Whether or not the feature negotiation succeeded can be learned from the `quic.ConnectionState.SupportsDatagrams` obtained from `quic.Connection.ConnectionState()`. 161 162 QUIC DATAGRAMs are a new QUIC frame type sent in QUIC 1-RTT packets (i.e. after completion of the handshake). Therefore, they're end-to-end encrypted and congestion-controlled. However, if a DATAGRAM frame is deemed lost by QUIC's loss detection mechanism, they are not automatically retransmitted. 163 164 Datagrams are sent using the `SendMessage` method on the `quic.Connection`: 165 166 ```go 167 conn.SendMessage([]byte("foobar")) 168 ``` 169 170 And received using `ReceiveMessage`: 171 172 ```go 173 msg, err := conn.ReceiveMessage() 174 ``` 175 176 Note that this code path is currently not optimized. It works for datagrams that are sent occasionally, but it doesn't achieve the same throughput as writing data on a stream. Please get in touch on issue #3766 if your use case relies on high datagram throughput, or if you'd like to help fix this issue. There are also some restrictions regarding the maximum message size (see #3599). 177 178 ### QUIC Event Logging using qlog 179 180 quic-go logs a wide range of events defined in [draft-ietf-quic-qlog-quic-events](https://datatracker.ietf.org/doc/draft-ietf-quic-qlog-quic-events/), providing comprehensive insights in the internals of a QUIC connection. 181 182 qlog files can be processed by a number of 3rd-party tools. [qviz](https://qvis.quictools.info/) has proven very useful for debugging all kinds of QUIC connection failures. 183 184 qlog is activated by setting a `Tracer` callback on the `Config`. It is called as soon as quic-go decides to starts the QUIC handshake on a new connection. 185 A useful implementation of this callback could look like this: 186 ```go 187 quic.Config{ 188 Tracer: func(ctx context.Context, p logging.Perspective, connID quic.ConnectionID) *logging.ConnectionTracer { 189 role := "server" 190 if p == logging.PerspectiveClient { 191 role = "client" 192 } 193 filename := fmt.Sprintf("./log_%x_%s.qlog", connID, role) 194 f, err := os.Create(filename) 195 // handle the error 196 return qlog.NewConnectionTracer(f, p, connID) 197 } 198 } 199 ``` 200 201 This implementation of the callback creates a new qlog file in the current directory named `log_<client / server>_<QUIC connection ID>.qlog`. 202 203 204 ## Using HTTP/3 205 206 ### As a server 207 208 See the [example server](example/main.go). Starting a QUIC server is very similar to the standard library http package in Go: 209 210 ```go 211 http.Handle("/", http.FileServer(http.Dir(wwwDir))) 212 http3.ListenAndServeQUIC("localhost:4242", "/path/to/cert/chain.pem", "/path/to/privkey.pem", nil) 213 ``` 214 215 ### As a client 216 217 See the [example client](example/client/main.go). Use a `http3.RoundTripper` as a `Transport` in a `http.Client`. 218 219 ```go 220 http.Client{ 221 Transport: &http3.RoundTripper{}, 222 } 223 ``` 224 225 ## Projects using quic-go 226 227 | Project | Description | Stars | 228 | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | 229 | [AdGuardHome](https://github.com/AdguardTeam/AdGuardHome) | Free and open source, powerful network-wide ads & trackers blocking DNS server. |  | 230 | [algernon](https://github.com/xyproto/algernon) | Small self-contained pure-Go web server with Lua, Markdown, HTTP/2, QUIC, Redis and PostgreSQL support |  | 231 | [caddy](https://github.com/caddyserver/caddy/) | Fast, multi-platform web server with automatic HTTPS |  | 232 | [cloudflared](https://github.com/cloudflare/cloudflared) | A tunneling daemon that proxies traffic from the Cloudflare network to your origins |  | 233 | [go-libp2p](https://github.com/libp2p/go-libp2p) | libp2p implementation in Go, powering [Kubo](https://github.com/ipfs/kubo) (IPFS) and [Lotus](https://github.com/filecoin-project/lotus) (Filecoin), among others |  | 234 | [Hysteria](https://github.com/apernet/hysteria) | A powerful, lightning fast and censorship resistant proxy |  | 235 | [Mercure](https://github.com/dunglas/mercure) | An open, easy, fast, reliable and battery-efficient solution for real-time communications |  | 236 | [OONI Probe](https://github.com/ooni/probe-cli) | Next generation OONI Probe. Library and CLI tool. |  | 237 | [syncthing](https://github.com/syncthing/syncthing/) | Open Source Continuous File Synchronization |  | 238 | [traefik](https://github.com/traefik/traefik) | The Cloud Native Application Proxy |  | 239 | [v2ray-core](https://github.com/v2fly/v2ray-core) | A platform for building proxies to bypass network restrictions |  | 240 | [YoMo](https://github.com/yomorun/yomo) | Streaming Serverless Framework for Geo-distributed System |  | 241 242 If you'd like to see your project added to this list, please send us a PR. 243 244 ## Release Policy 245 246 quic-go always aims to support the latest two Go releases. 247 248 ### Dependency on forked crypto/tls 249 250 Since the standard library didn't provide any QUIC APIs before the Go 1.21 release, we had to fork crypto/tls to add the required APIs ourselves: [qtls for Go 1.20](https://github.com/quic-go/qtls-go1-20). 251 This had led to a lot of pain in the Go ecosystem, and we're happy that we can rely on Go 1.21 going forward. 252 253 ## Contributing 254 255 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](https://github.com/MerlinKodo/quic-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). If you have any questions, please feel free to reach out by opening an issue or leaving a comment.