[tor-commits] [pluggable-transports/snowflake] 13/13: Add document for NewUTLSHTTPRoundTripper

[gitolite role]

This is an automated email from the git hooks/post-receive script.

shelikhoo pushed a commit to branch main
in repository pluggable-transports/snowflake.

commit 6e29dc676c44ea1b6fe5f13aec48aae91ff1cc3c
Author: Shelikhoo <xiaokangwang at outlook.com>
AuthorDate: Tue Mar 15 12:27:29 2022 +0000

    Add document for NewUTLSHTTPRoundTripper
---
 common/utls/roundtripper.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/common/utls/roundtripper.go b/common/utls/roundtripper.go
index df31ff4..53b997f 100644
--- a/common/utls/roundtripper.go
+++ b/common/utls/roundtripper.go
@@ -13,6 +13,14 @@ import (
 	"golang.org/x/net/http2"
 )
 
+// NewUTLSHTTPRoundTripper creates an instance of RoundTripper that dial to remote HTTPS endpoint with
+// an alternative version of TLS implementation that attempts to imitate browsers' fingerprint.
+// clientHelloID is the clientHello that uTLS attempts to imitate
+// uTlsConfig is the TLS Configuration template
+// backdropTransport is the transport that will be used for non-https traffic
+// removeSNI indicates not to send Server Name Indication Extension
+// returns a RoundTripper: its behaviour is documented at
+// https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake/-/merge_requests/76#note_2777161
 func NewUTLSHTTPRoundTripper(clientHelloID utls.ClientHelloID, uTlsConfig *utls.Config,
 	backdropTransport http.RoundTripper, removeSNI bool) http.RoundTripper {
 	rtImpl := &uTLSHTTPRoundTripperImpl{

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.