new: support variable length quic frame padding (#10)

Add variable length QUIC frame padding support. Refactor how QUIC frames are defined in a QUIC Spec. Update documentation and examples. Added Chrome and Firefox parrots. Close #3.
2025-04-03 04:07:35 +03:00 · 2023-08-05 22:47:08 -06:00 · 2023-08-05 22:47:08 -06:00 · 9d3fe2aa07
commit 9d3fe2aa07
parent 5e966a9bec
8 changed files with 1154 additions and 478 deletions
--- a/README.md
+++ b/README.md
@ -11,22 +11,31 @@ If you have any questions, bug reports or contributions, you are welcome to publ

 Development is still in progress and we welcome any contributions adding new features or fixing extant bugs.

+# Disclaimer
+This repository belongs to a large research project on how to fingerprint QUIC clients and how to mitigate such fingerprinting. We do not encourage any malicious use of this project's output, including this repository, [uTLS](https://github.com/refraction-networking/utls), and [clienthellod](https://github.com/gaukas/clienthellod).
+
+Our research paper is still yet to be published and therefore this repository is neither ready for production use nor peer-reviewed. And the scope of our research is limited that such mimicry backed by this library MAY NOT be realisticly indistinguishable from the real QUIC clients being mimicked, and some misuses of this library MAY lead to easier fingerprinting against the mimic. We welcome any contributions to improve the realism of the mimicry, as well as expanding the scope of this project. 
+
+For anyone intending to use this library for censorship circumvention, please be sure to understand the risks and limitations of this library. 
+
+If you are interested in our research, please stay tuned for our paper.
+
 # Development in Progress
 ## Development Roadmap
 - [ ] Customize Initial Packet 
 	- [x] QUIC Header 
-	- [ ] QUIC Frame ([#3](https://github.com/gaukas/uquic/issues/3))
+	- [x] QUIC Frame (~~[#3](https://github.com/gaukas/uquic/issues/3)~~)
 		- [x] QUIC Crypto Frame
 		- [x] QUIC Padding Frame
 		- [x] QUIC Ping Frame
-		- [ ] QUIC ACK Frame
+		- [ ] QUIC ACK Frame (on hold)
 	- [x] TLS ClientHello Message (by [uTLS](https://github.com/refraction-networking/utls))
 		- [x] QUIC Transport Parameters (in a uTLS extension)
 - [ ] Customize Initial ACK behavior ([#1](https://github.com/gaukas/uquic/issues/1), [quic-go#4007](https://github.com/quic-go/quic-go/issues/4007))
 - [ ] Customize Initial Retry behavior ([#2](https://github.com/gaukas/uquic/issues/2))
 - [ ] Add preset QUIC parrots
-	- [ ] Google Chrome parrot
-	- [ ] Mozilla Firefox parrot
+	- [x] Google Chrome parrot (call for parrots w/ `Token/PSK`)
+	- [x] Mozilla Firefox parrot (call for parrots w/ `Token/PSK`)
 	- [ ] Apple Safari parrot
 	- [ ] Microsoft Edge parrot

@ -37,59 +46,66 @@ uQUIC provides a mechanism to customize the Initial Packet, which is unencrypted
 ### Build a QUIC Spec
 A QUIC Spec sets parameters and policies for uQUIC in establishing a QUIC connection. 

-```go
-func getQUICSpec() *uquic.QUICSpec {
-	return &uquic.QUICSpec{
-		InitialPacketSpec: uquic.InitialPacketSpec{
-			SrcConnIDLength:        3,
-			DestConnIDLength:       8,
-			InitPacketNumberLength: 1,
-			InitPacketNumber:       1,
-			ClientTokenLength:      0,
-			FrameOrder: uquic.QUICFrames{
-				&uquic.QUICFrameCrypto{
-					Offset: 0,
-					Length: 0,
-				},
-			},
-		},
-		ClientHelloSpec: getClientHelloSpec(),
-        UDPDatagramMinSize: 1357,
-	}
-}
+See `u_parrot.go` for examples of building a QUIC Spec (parrot).

-func getClientHelloSpec() *utls.ClientHelloSpec {
-	return &utls.ClientHelloSpec{
-        // skipped a few mandatory fields, see uTLS for details
-		Extensions: []utls.TLSExtension{
-			// skipped a few mandatory extensions, see uTLS for details
-			&utls.QUICTransportParametersExtension{
-				TransportParameters: utls.TransportParameters{
-					utls.InitialMaxStreamDataBidiRemote(0x100000),
-					utls.InitialMaxStreamsBidi(16),
-					utls.MaxDatagramFrameSize(1200),
-					utls.MaxIdleTimeout(30000),
-					utls.ActiveConnectionIDLimit(8),
-					&utls.GREASEQUICBit{},
-					&utls.VersionInformation{
-						ChoosenVersion: utls.VERSION_1,
-						AvailableVersions: []uint32{
-							utls.VERSION_GREASE,
-							utls.VERSION_1,
-						},
-						LegacyID: true,
-					},
-					utls.InitialMaxStreamsUni(16),
-					&utls.GREASE{},
-					utls.InitialMaxStreamDataBidiLocal(0xc00000),
-					utls.InitialMaxStreamDataUni(0x100000),
-					utls.InitialSourceConnectionID([]byte{}),
-					utls.MaxAckDelay(20),
-					utls.InitialMaxData(0x1800000),
-					&utls.DisableActiveMigration{},
-				},
-			},
-		},
+### Use a preset QUIC Spec
+We provide a few preset QUIC Specs (parrots) for popular QUIC clients in `u_parrot.go`.
+
+To use one, simple invoke `QUICID2Spec(id)`. See below for a complete example of using a preset QUIC Spec in an HTTP3 client.
+
+```go
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"log"
+	"net/http"
+
+	tls "github.com/refraction-networking/utls"
+
+	quic "github.com/refraction-networking/uquic"
+	"github.com/refraction-networking/uquic/http3"
+)
+
+func main() {
+	roundTripper := &http3.RoundTripper{
+		TLSClientConfig: &tls.Config{},
+		QuicConfig:      &quic.Config{},
 	}
+
+	quicSpec, err := quic.QUICID2Spec(quic.QUICFirefox_116)
+	// quicSpec, err := quic.QUICID2Spec(quic.QUICChrome_115)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	uRoundTripper := http3.GetURoundTripper(
+		roundTripper,
+		&quicSpec,
+		// getCRQUICSpec(),
+		nil,
+	)
+	defer uRoundTripper.Close()
+
+	h3client := &http.Client{
+		Transport: uRoundTripper,
+	}
+
+	addr := "https://quic.tlsfingerprint.io/qfp/?beautify=true"
+
+	rsp, err := h3client.Get(addr)
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Printf("Got response for %s: %#v", addr, rsp)
+
+	body := &bytes.Buffer{}
+	_, err = io.Copy(body, rsp.Body)
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Printf("Response Body: %s", body.Bytes())
 }
-```
+```