tls

package module
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2024 License: BSD-3-Clause Imports: 60 Imported by: 0

README

uTLS uTLS

Build Status godoc

uTLS is a fork of "crypto/tls", which provides ClientHello fingerprinting resistance, low-level access to handshake, fake session tickets and some other features. Handshake is still performed by "crypto/tls", this library merely changes ClientHello part of it and provides low-level access.

Minimum Go Version: Go 1.21

If you have any questions, bug reports or contributions, you are welcome to publish those on GitHub. If you want to do so in private, you can contact one of developers personally via sergey.frolov@colorado.edu.

You can contact one of developers personally via gaukas.wang@colorado.edu.

Documentation below may not keep up with all the changes and new features at all times, so you are encouraged to use godoc.

Note: Information provided below in this README.md could be obsolete. We welcome any contributions to refresh the documentations in addition to code contributions.

Features

Low-level access to handshake

  • Read/write access to all bits of client hello message.
  • Read access to fields of ClientHandshakeState, which, among other things, includes ServerHello and MasterSecret.
  • Read keystream. Can be used, for example, to "write" something in ciphertext.

ClientHello fingerprinting resistance

Golang's ClientHello has a very unique fingerprint, which especially sticks out on mobile clients, where Golang is not too popular yet. Some members of anti-censorship community are concerned that their tools could be trivially blocked based on ClientHello with relatively small collateral damage. There are multiple solutions to this issue.

It is highly recommended to use multiple fingeprints, including randomized ones to avoid relying on a single fingerprint. utls.Roller does this automatically.

Randomized Fingerprint

Randomized Fingerprints are supposedly good at defeating blacklists, since those fingerprints have random ciphersuites and extensions in random order. Note that all used ciphersuites and extensions are fully supported by uTLS, which provides a solid moving target without any compatibility or parrot-is-dead attack risks.

But note that there's a small chance that generated fingerprint won't work, so you may want to keep generating until a working one is found, and then keep reusing the working fingerprint to avoid suspicious behavior of constantly changing fingerprints. utls.Roller reuses working fingerprint automatically.

Generating randomized fingerprints

To generate a randomized fingerprint, simply do:

uTlsConn := tls.UClient(tcpConn, &config, tls.HelloRandomized)

you can use helloRandomizedALPN or helloRandomizedNoALPN to ensure presence or absence of ALPN(Application-Layer Protocol Negotiation) extension. It is recommended, but certainly not required to include ALPN (or use helloRandomized which may or may not include ALPN). If you do use ALPN, you will want to correctly handle potential application layer protocols (likely h2 or http/1.1).

Reusing randomized fingerprint
// oldConn is an old connection that worked before, so we want to reuse it
// newConn is a new connection we'd like to establish
newConn := tls.UClient(tcpConn, &config, oldConn.ClientHelloID)
Parroting

This package can be used to parrot ClientHello of popular browsers. There are some caveats to this parroting:

  • We are forced to offer ciphersuites and tls extensions that are not supported by crypto/tls. This is not a problem, if you fully control the server and turn unsupported things off on server side.
  • Parroting could be imperfect, and there is no parroting beyond ClientHello.
Compatibility risks of available parrots
Parrot Ciphers* Signature* Unsupported extensions TLS Fingerprint ID
Chrome 62 no no ChannelID 0a4a74aeebd1bb66
Chrome 70 no no ChannelID, Encrypted Certs bc4c7e42f4961cd7
Chrome 72 no no ChannelID, Encrypted Certs bbf04e5f1881f506
Chrome 83 no no ChannelID, Encrypted Certs 9c673fd64a32c8dc
Firefox 56 very low no None c884bad7f40bee56
Firefox 65 very low no MaxRecordSize 6bfedc5d5c740d58
iOS 11.1 low** no None 71a81bafd58e1301
iOS 12.1 low** no None ec55e5b4136c7949

* Denotes very rough guesstimate of likelihood that unsupported things will get echoed back by the server in the wild, visibly breaking the connection.
** No risk, if utls.EnableWeakCiphers() is called prior to using it.

Parrots FAQ

Does it really look like, say, Google Chrome with all the GREASE and stuff?

It LGTM, but please open up Wireshark and check. If you see something — say something.

Aren't there side channels? Everybody knows that the bird is a wordparrot is dead

There sure are. If you found one that approaches practicality at line speed — please tell us.

However, there is a difference between this sort of parroting and techniques like SkypeMorth. Namely, TLS is highly standardized protocol, therefore simply not that many subtle things in TLS protocol could be different and/or suddenly change in one of mimicked implementation(potentially undermining the mimicry). It is possible that we have a distinguisher right now, but amount of those potential distinguishers is limited.

Custom Handshake

It is possible to create custom handshake by

  1. Use HelloCustom as an argument for UClient() to get empty config
  2. Fill tls header fields: UConn.Hello.{Random, CipherSuites, CompressionMethods}, if needed, or stick to defaults.
  3. Configure and add various TLS Extensions to UConn.Extensions: they will be marshaled in order.
  4. Set Session and SessionCache, as needed.

If you need to manually control all the bytes on the wire(certainly not recommended!), you can set UConn.HandshakeStateBuilt = true, and marshal clientHello into UConn.HandshakeState.Hello.raw yourself. In this case you will be responsible for modifying other parts of Config and ClientHelloMsg to reflect your setup and not confuse "crypto/tls", which will be processing response from server.

Fingerprinting Captured Client Hello

You can use a captured client hello to generate new ones that mimic/have the same properties as the original. The generated client hellos should look like they were generated from the same client software as the original fingerprinted bytes. In order to do this:

  1. Create a ClientHelloSpec from the raw bytes of the original client hello
  2. Use HelloCustom as an argument for UClient() to get empty config
  3. Use ApplyPreset with the generated ClientHelloSpec to set the appropriate connection properties
uConn := UClient(&net.TCPConn{}, nil, HelloCustom)
fingerprinter := &Fingerprinter{}
generatedSpec, err := fingerprinter.FingerprintClientHello(rawCapturedClientHelloBytes)
if err != nil {
  panic("fingerprinting failed: %v", err)
}
if err := uConn.ApplyPreset(generatedSpec); err != nil {
  panic("applying generated spec failed: %v", err)
}

The rawCapturedClientHelloBytes should be the full tls record, including the record type/version/length header.

Roller

A simple wrapper, that allows to easily use multiple latest(auto-updated) fingerprints.

// NewRoller creates Roller object with default range of HelloIDs to cycle
// through until a working/unblocked one is found.
func NewRoller() (*Roller, error)

// Dial attempts to connect to given address using different HelloIDs.
// If a working HelloID is found, it is used again for subsequent Dials.
// If tcp connection fails or all HelloIDs are tried, returns with last error.
//
// Usage examples:
//
// Dial("tcp4", "google.com:443", "google.com")
// Dial("tcp", "10.23.144.22:443", "mywebserver.org")
func (c *Roller) Dial(network, addr, serverName string) (*UConn, error)

Fake Session Tickets

Fake session tickets is a very nifty trick that allows power users to hide parts of handshake, which may have some very fingerprintable features of handshake, and saves 1 RTT. Currently, there is a simple function to set session ticket to any desired state:

// If you want you session tickets to be reused - use same cache on following connections
func (uconn *UConn) SetSessionState(session *ClientSessionState)

Note that session tickets (fake ones or otherwise) are not reused.
To reuse tickets, create a shared cache and set it on current and further configs:

// If you want you session tickets to be reused - use same cache on following connections
func (uconn *UConn) SetSessionCache(cache ClientSessionCache)

Custom TLS extensions

If you want to add your own fake (placeholder, without added functionality) extension for mimicry purposes, you can embed *tls.GenericExtension into your own struct and override Len() and Read() methods. For example, DelegatedCredentials extension can be implemented as follows:

const FakeDelegatedCredentials uint16 = 0x0022

type FakeDelegatedCredentialsExtension struct {
	*tls.GenericExtension
	SignatureAlgorithms []tls.SignatureScheme
}

func (e *FakeDelegatedCredentialsExtension) Len() int {
	return 6 + 2*len(e.SignatureAlgorithms)
}

func (e *FakeDelegatedCredentialsExtension) Read(b []byte) (n int, err error) {
	if len(b) < e.Len() {
		return 0, io.ErrShortBuffer
	}
	offset := 0
	appendUint16 := func(val uint16) {
		b[offset] = byte(val >> 8)
		b[offset+1] = byte(val & 0xff)
		offset += 2
	}

	// Extension type
	appendUint16(FakeDelegatedCredentials)

	algosLength := 2 * len(e.SignatureAlgorithms)

	// Extension data length
	appendUint16(uint16(algosLength) + 2)

	// Algorithms list length
	appendUint16(uint16(algosLength))

	// Algorithms list
	for _, a := range e.SignatureAlgorithms {
		appendUint16(uint16(a))
	}
	return e.Len(), io.EOF
}

Then it can be used just like normal extension:

&tls.ClientHelloSpec{
	//...
	Extensions: []tls.TLSExtension{
		//...
		&FakeDelegatedCredentialsExtension{
			SignatureAlgorithms: []tls.SignatureScheme{
				tls.ECDSAWithP256AndSHA256,
				tls.ECDSAWithP384AndSHA384,
				tls.ECDSAWithP521AndSHA512,
				tls.ECDSAWithSHA1,
			},
		},
		//...
	}
	//...
}

Client Hello IDs

See full list of clientHelloID values here.
There are different behaviors you can get, depending on your clientHelloID:

  1. utls.HelloRandomized adds/reorders extensions, ciphersuites, etc. randomly.
    HelloRandomized adds ALPN in a percentage of cases, you may want to use HelloRandomizedALPN or HelloRandomizedNoALPN to choose specific behavior explicitly, as ALPN might affect application layer.
  2. utls.HelloGolang HelloGolang will use default "crypto/tls" handshake marshaling codepath, which WILL overwrite your changes to Hello(Config, Session are fine). You might want to call BuildHandshakeState() before applying any changes. UConn.Extensions will be completely ignored.
  3. utls.HelloCustom will prepare ClientHello with empty uconn.Extensions so you can fill it with TLSExtension's manually.
  4. The rest will will parrot given browser. Such parrots include, for example:
    • utls.HelloChrome_Auto- parrots recommended(usually latest) Google Chrome version
    • utls.HelloChrome_58 - parrots Google Chrome 58
    • utls.HelloFirefox_Auto - parrots recommended(usually latest) Firefox version
    • utls.HelloFirefox_55 - parrots Firefox 55

Usage

Examples

Find basic examples here.
Here's a more advanced example showing how to generate randomized ClientHello, modify generated ciphersuites a bit, and proceed with the handshake.

Migrating from "crypto/tls"

Here's how default "crypto/tls" is typically used:

    dialConn, err := net.Dial("tcp", "172.217.11.46:443")
    if err != nil {
        fmt.Printf("net.Dial() failed: %+v\n", err)
        return
    }

    config := tls.Config{ServerName: "www.google.com"}
    tlsConn := tls.Client(dialConn, &config)
    n, err = tlsConn.Write("Hello, World!")
    //...

To start using using uTLS:

  1. Import this library (e.g. import tls "github.com/refraction-networking/utls")
  2. Pick the Client Hello ID
  3. Simply substitute tlsConn := tls.Client(dialConn, &config) with tlsConn := tls.UClient(dialConn, &config, tls.clientHelloID)
Customizing handshake

Some customizations(such as setting session ticket/clientHello) have easy-to-use functions for them. The idea is to make common manipulations easy:

    cRandom := []byte{100, 101, 102, 103, 104, 105, 106, 107, 108, 109,
        110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
        120, 121, 122, 123, 124, 125, 126, 127, 128, 129,
        130, 131}
    tlsConn.SetClientRandom(cRandom)
    masterSecret := make([]byte, 48)
    copy(masterSecret, []byte("masterSecret is NOT sent over the wire")) // you may use it for real security

    // Create a session ticket that wasn't actually issued by the server.
    sessionState := utls.MakeClientSessionState(sessionTicket, uint16(tls.VersionTLS12),
        tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
        masterSecret,
        nil, nil)
    tlsConn.SetSessionState(sessionState)

For other customizations there are following functions

// you can use this to build the state manually and change it
// for example use Randomized ClientHello, and add more extensions
func (uconn *UConn) BuildHandshakeState() error

// Then apply the changes and marshal final bytes, which will be sent
func (uconn *UConn) MarshalClientHello() error

Contributors' guide

Please refer to this document if you're interested in internals

Credits

The initial development of uTLS was completed during an internship at Google Jigsaw. This is not an official Google product.

Documentation

Overview

Copyright 2022 The Go Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

Package tls partially implements TLS 1.2, as specified in RFC 5246, and TLS 1.3, as specified in RFC 8446.

Index

Examples

Constants

View Source 
const (
	// TLS 1.0 - 1.2 cipher suites.
	TLS_RSA_WITH_RC4_128_SHA                      uint16 = 0x0005
	TLS_RSA_WITH_3DES_EDE_CBC_SHA                 uint16 = 0x000a
	TLS_RSA_WITH_AES_128_CBC_SHA                  uint16 = 0x002f
	TLS_RSA_WITH_AES_256_CBC_SHA                  uint16 = 0x0035
	TLS_RSA_WITH_AES_128_CBC_SHA256               uint16 = 0x003c
	TLS_RSA_WITH_AES_128_GCM_SHA256               uint16 = 0x009c
	TLS_RSA_WITH_AES_256_GCM_SHA384               uint16 = 0x009d
	TLS_ECDHE_ECDSA_WITH_RC4_128_SHA              uint16 = 0xc007
	TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA          uint16 = 0xc009
	TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA          uint16 = 0xc00a
	TLS_ECDHE_RSA_WITH_RC4_128_SHA                uint16 = 0xc011
	TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA           uint16 = 0xc012
	TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA            uint16 = 0xc013
	TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA            uint16 = 0xc014
	TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256       uint16 = 0xc023
	TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256         uint16 = 0xc027
	TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256         uint16 = 0xc02f
	TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256       uint16 = 0xc02b
	TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384         uint16 = 0xc030
	TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384       uint16 = 0xc02c
	TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256   uint16 = 0xcca8
	TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 uint16 = 0xcca9

	// TLS 1.3 cipher suites.
	TLS_AES_128_GCM_SHA256       uint16 = 0x1301
	TLS_AES_256_GCM_SHA384       uint16 = 0x1302
	TLS_CHACHA20_POLY1305_SHA256 uint16 = 0x1303

	// TLS_FALLBACK_SCSV isn't a standard cipher suite but an indicator
	// that the client is doing version fallback. See RFC 7507.
	TLS_FALLBACK_SCSV uint16 = 0x5600

	// Legacy names for the corresponding cipher suites with the correct _SHA256
	// suffix, retained for backward compatibility.
	TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305   = TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
	TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 = TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
)

A list of cipher suite IDs that are, or have been, implemented by this package.

See https://www.iana.org/assignments/tls-parameters/tls-parameters.xml

View Source 
const (
	VersionTLS10 = 0x0301
	VersionTLS11 = 0x0302
	VersionTLS12 = 0x0303
	VersionTLS13 = 0x0304

	// Deprecated: SSLv3 is cryptographically broken, and is no longer
	// supported by this package. See golang.org/issue/32716.
	VersionSSL30 = 0x0300
)
View Source 
const (
	QUICEncryptionLevelInitial = QUICEncryptionLevel(iota)
	QUICEncryptionLevelEarly
	QUICEncryptionLevelHandshake
	QUICEncryptionLevelApplication
)
View Source 
const (
	OLD_TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256   = uint16(0xcc13)
	OLD_TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 = uint16(0xcc14)

	DISABLED_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = uint16(0xc024)
	DISABLED_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384   = uint16(0xc028)
	DISABLED_TLS_RSA_WITH_AES_256_CBC_SHA256         = uint16(0x003d)

	FAKE_OLD_TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 = uint16(0xcc15) // we can try to craft these ciphersuites
	FAKE_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256           = uint16(0x009e) // from existing pieces, if needed

	FAKE_TLS_DHE_RSA_WITH_AES_128_CBC_SHA    = uint16(0x0033)
	FAKE_TLS_DHE_RSA_WITH_AES_256_CBC_SHA    = uint16(0x0039)
	FAKE_TLS_RSA_WITH_RC4_128_MD5            = uint16(0x0004)
	FAKE_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 = uint16(0x009f)
	FAKE_TLS_DHE_DSS_WITH_AES_128_CBC_SHA    = uint16(0x0032)
	FAKE_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 = uint16(0x006b)
	FAKE_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 = uint16(0x0067)
	FAKE_TLS_EMPTY_RENEGOTIATION_INFO_SCSV   = uint16(0x00ff)

	// https://docs.microsoft.com/en-us/dotnet/api/system.net.security.tlsciphersuite?view=netcore-3.1
	FAKE_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA = uint16(0xc008)
)
View Source 
const (
	PskModePlain uint8 = pskModePlain
	PskModeDHE   uint8 = pskModeDHE
)
View Source 
const (
	OuterClientHello byte = 0x00
	InnerClientHello byte = 0x01
)
View Source 
const (
	VERSION_NEGOTIATION uint32 = 0x00000000 // rfc9000
	VERSION_1           uint32 = 0x00000001 // rfc9000
	VERSION_2           uint32 = 0x6b3343cf // rfc9369

	VERSION_GREASE uint32 = 0x0a0a0a0a // -> 0x?a?a?a?a
)
View Source 
const (
	GREASE_MAX_MULTIPLIER = (0x3FFFFFFFFFFFFFFF - 27) / 31
)
View Source 
const GREASE_PLACEHOLDER = 0x0a0a

based on spec's GreaseStyle, GREASE_PLACEHOLDER may be replaced by another GREASE value https://tools.ietf.org/html/draft-ietf-tls-grease-01

View Source 
const NoSession sessionControllerState = 0
View Source 
const (
	PRNGSeedLength = 32
)
View Source 
const PskExtAllSet sessionControllerState = 4
View Source 
const PskExtInitialized sessionControllerState = 3
View Source 
const SessionTicketExtAllSet sessionControllerState = 2
View Source 
const SessionTicketExtInitialized sessionControllerState = 1

Variables

View Source 
var (
	X25519Kyber512Draft00    = CurveID(0xfe30)
	X25519Kyber768Draft00    = CurveID(0x6399)
	X25519Kyber768Draft00Old = CurveID(0xfe31)
	P256Kyber768Draft00      = CurveID(0xfe32)
)
View Source 
var (
	FakeFFDHE2048 = uint16(0x0100)
	FakeFFDHE3072 = uint16(0x0101)
)

fake curves(groups)

View Source 
var (
	// HelloGolang will use default "crypto/tls" handshake marshaling codepath, which WILL
	// overwrite your changes to Hello(Config, Session are fine).
	// You might want to call BuildHandshakeState() before applying any changes.
	// UConn.Extensions will be completely ignored.
	HelloGolang = ClientHelloID{helloGolang, helloAutoVers, nil, nil}

	// HelloCustom will prepare ClientHello with empty uconn.Extensions so you can fill it with
	// TLSExtensions manually or use ApplyPreset function
	HelloCustom = ClientHelloID{helloCustom, helloAutoVers, nil, nil}

	// HelloRandomized* randomly adds/reorders extensions, ciphersuites, etc.
	HelloRandomized       = ClientHelloID{helloRandomized, helloAutoVers, nil, nil}
	HelloRandomizedALPN   = ClientHelloID{helloRandomizedALPN, helloAutoVers, nil, nil}
	HelloRandomizedNoALPN = ClientHelloID{helloRandomizedNoALPN, helloAutoVers, nil, nil}

	// The rest will will parrot given browser.
	HelloFirefox_Auto = HelloFirefox_120
	HelloFirefox_55   = ClientHelloID{helloFirefox, "55", nil, nil}
	HelloFirefox_56   = ClientHelloID{helloFirefox, "56", nil, nil}
	HelloFirefox_63   = ClientHelloID{helloFirefox, "63", nil, nil}
	HelloFirefox_65   = ClientHelloID{helloFirefox, "65", nil, nil}
	HelloFirefox_99   = ClientHelloID{helloFirefox, "99", nil, nil}
	HelloFirefox_102  = ClientHelloID{helloFirefox, "102", nil, nil}
	HelloFirefox_105  = ClientHelloID{helloFirefox, "105", nil, nil}
	HelloFirefox_120  = ClientHelloID{helloFirefox, "120", nil, nil}

	HelloChrome_Auto        = HelloChrome_120
	HelloChrome_58          = ClientHelloID{helloChrome, "58", nil, nil}
	HelloChrome_62          = ClientHelloID{helloChrome, "62", nil, nil}
	HelloChrome_70          = ClientHelloID{helloChrome, "70", nil, nil}
	HelloChrome_72          = ClientHelloID{helloChrome, "72", nil, nil}
	HelloChrome_83          = ClientHelloID{helloChrome, "83", nil, nil}
	HelloChrome_87          = ClientHelloID{helloChrome, "87", nil, nil}
	HelloChrome_96          = ClientHelloID{helloChrome, "96", nil, nil}
	HelloChrome_100         = ClientHelloID{helloChrome, "100", nil, nil}
	HelloChrome_102         = ClientHelloID{helloChrome, "102", nil, nil}
	HelloChrome_106_Shuffle = ClientHelloID{helloChrome, "106", nil, nil} // TLS Extension shuffler enabled starting from 106

	// Chrome w/ PSK: Chrome start sending this ClientHello after doing TLS 1.3 handshake with the same server.
	// Beta: PSK extension added. However, uTLS doesn't ship with full PSK support.
	// Use at your own discretion.
	HelloChrome_100_PSK              = ClientHelloID{helloChrome, "100_PSK", nil, nil}
	HelloChrome_112_PSK_Shuf         = ClientHelloID{helloChrome, "112_PSK", nil, nil}
	HelloChrome_114_Padding_PSK_Shuf = ClientHelloID{helloChrome, "114_PSK", nil, nil}

	// Chrome w/ Post-Quantum Key Agreement
	// Beta: PQ extension added. However, uTLS doesn't ship with full PQ support. Use at your own discretion.
	HelloChrome_115_PQ     = ClientHelloID{helloChrome, "115_PQ", nil, nil}
	HelloChrome_115_PQ_PSK = ClientHelloID{helloChrome, "115_PQ_PSK", nil, nil}

	// Chrome ECH
	HelloChrome_120 = ClientHelloID{helloChrome, "120", nil, nil}
	// Chrome w/ Post-Quantum Key Agreement and Encrypted ClientHello
	HelloChrome_120_PQ = ClientHelloID{helloChrome, "120_PQ", nil, nil}

	HelloIOS_Auto = HelloIOS_14
	HelloIOS_11_1 = ClientHelloID{helloIOS, "111", nil, nil} // legacy "111" means 11.1
	HelloIOS_12_1 = ClientHelloID{helloIOS, "12.1", nil, nil}
	HelloIOS_13   = ClientHelloID{helloIOS, "13", nil, nil}
	HelloIOS_14   = ClientHelloID{helloIOS, "14", nil, nil}

	HelloAndroid_11_OkHttp = ClientHelloID{helloAndroid, "11", nil, nil}

	HelloEdge_Auto = HelloEdge_85 // HelloEdge_106 seems to be incompatible with this library
	HelloEdge_85   = ClientHelloID{helloEdge, "85", nil, nil}
	HelloEdge_106  = ClientHelloID{helloEdge, "106", nil, nil}

	HelloSafari_Auto = HelloSafari_16_0
	HelloSafari_16_0 = ClientHelloID{helloSafari, "16.0", nil, nil}

	Hello360_Auto = Hello360_7_5 // Hello360_11_0 seems to be incompatible with this library
	Hello360_7_5  = ClientHelloID{hello360, "7.5", nil, nil}
	Hello360_11_0 = ClientHelloID{hello360, "11.0", nil, nil}

	HelloQQ_Auto = HelloQQ_11_1
	HelloQQ_11_1 = ClientHelloID{helloQQ, "11.1", nil, nil}
)
View Source 
var DefaultWeights = Weights{
	Extensions_Append_ALPN:                             0.7,
	TLSVersMax_Set_VersionTLS13:                        0.4,
	CipherSuites_Remove_RandomCiphers:                  0.4,
	SigAndHashAlgos_Append_ECDSAWithSHA1:               0.63,
	SigAndHashAlgos_Append_ECDSAWithP521AndSHA512:      0.59,
	SigAndHashAlgos_Append_PSSWithSHA256:               0.51,
	SigAndHashAlgos_Append_PSSWithSHA384_PSSWithSHA512: 0.9,
	CurveIDs_Append_X25519:                             0.71,
	CurveIDs_Append_CurveP521:                          0.46,
	Extensions_Append_Padding:                          0.62,
	Extensions_Append_Status:                           0.74,
	Extensions_Append_SCT:                              0.46,
	Extensions_Append_Reneg:                            0.75,
	Extensions_Append_EMS:                              0.77,
	FirstKeyShare_Set_CurveP256:                        0.25,
	Extensions_Append_ALPS:                             0.33,
}

Do not modify them directly as they may being used. If you want to use your custom weights, please make a copy first.

View Source 
var ErrEmptyPsk = errors.New("tls: empty psk detected; remove the psk extension for this connection or set OmitEmptyPsk to true to conceal it in utls")
View Source 
var ErrUnknownClientHelloID = errors.New("tls: unknown ClientHelloID")
View Source 
var ErrUnknownExtension = errors.New("extension name is unknown to the dictionary")

Functions

func AlwaysPadToLen 

func AlwaysPadToLen(padToLen int) func(int) (int, bool)

AlwaysPadToLen could be used for parsed ClientHello, since some fingerprints might not use BoringSSL padding style and we want to pad to a the same length.

func BoringPaddingStyle 

func BoringPaddingStyle(unpaddedLen int) (int, bool)

https://github.com/google/boringssl/blob/7d7554b6b3c79e707e25521e61e066ce2b996e4c/ssl/t1_lib.c#L2803

func CipherSuiteName 

func CipherSuiteName(id uint16) string

CipherSuiteName returns the standard name for the passed cipher suite ID (e.g. "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"), or a fallback representation of the ID value if the cipher suite is not implemented by this package.

func EnableWeakCiphers 

func EnableWeakCiphers()

EnableWeakCiphers allows utls connections to continue in some cases, when weak cipher was chosen. This provides better compatibility with servers on the web, but weakens security. Feel free to use this option if you establish additional secure connection inside of utls connection. This option does not change the shape of parrots (i.e. same ciphers will be offered either way). Must be called before establishing any connections.

func GetBoringGREASEValue 

func GetBoringGREASEValue(greaseSeed [ssl_grease_last_index]uint16, index int) uint16

will panic if ssl_grease_last_index[index] is out of bounds.

func Listen 

func Listen(network, laddr string, config *Config) (net.Listener, error)

Listen creates a TLS listener accepting connections on the given network address using net.Listen. The configuration config must be non-nil and must include at least one certificate or else set GetCertificate.

func NewListener 

func NewListener(inner net.Listener, config *Config) net.Listener

NewListener creates a Listener which accepts connections from an inner Listener and wraps each connection with Server. The configuration config must be non-nil and must include at least one certificate or else set GetCertificate.

func VersionName 

func VersionName(version uint16) string

VersionName returns the name for the provided TLS version number (e.g. "TLS 1.3"), or a fallback representation of the value if the version is not implemented by this package.

Types

type ALPNExtension 

type ALPNExtension struct {
	AlpnProtocols []string
}

ALPNExtension implements application_layer_protocol_negotiation (16)

func (*ALPNExtension) Len 

func (e *ALPNExtension) Len() int

func (*ALPNExtension) Read 

func (e *ALPNExtension) Read(b []byte) (int, error)

func (*ALPNExtension) UnmarshalJSON 

func (e *ALPNExtension) UnmarshalJSON(b []byte) error

func (*ALPNExtension) Write 

func (e *ALPNExtension) Write(b []byte) (int, error)

type ActiveConnectionIDLimit 

type ActiveConnectionIDLimit uint64

func (ActiveConnectionIDLimit) ID 

func (ActiveConnectionIDLimit) ID() uint64

func (ActiveConnectionIDLimit) Value 

func (a ActiveConnectionIDLimit) Value() []byte

type AlertError 

type AlertError uint8

An AlertError is a TLS alert.

When using a QUIC transport, QUICConn methods will return an error which wraps AlertError rather than sending a TLS alert.

func (AlertError) Error 

func (e AlertError) Error() string

type ApplicationSettingsExtension 

type ApplicationSettingsExtension struct {
	SupportedProtocols []string
}

ApplicationSettingsExtension represents the TLS ALPS extension. At the time of this writing, this extension is currently a draft: https://datatracker.ietf.org/doc/html/draft-vvv-tls-alps-01

func (*ApplicationSettingsExtension) Len 

func (e *ApplicationSettingsExtension) Len() int

func (*ApplicationSettingsExtension) Read 

func (e *ApplicationSettingsExtension) Read(b []byte) (int, error)

func (*ApplicationSettingsExtension) UnmarshalJSON 

func (e *ApplicationSettingsExtension) UnmarshalJSON(b []byte) error

func (*ApplicationSettingsExtension) Write 

func (e *ApplicationSettingsExtension) Write(b []byte) (int, error)

Write implementation copied from ALPNExtension.Write

type CertCompressionAlgo 

type CertCompressionAlgo uint16

https://tools.ietf.org/html/draft-ietf-tls-certificate-compression-04 

const (
	CertCompressionZlib   CertCompressionAlgo = 0x0001
	CertCompressionBrotli CertCompressionAlgo = 0x0002
	CertCompressionZstd   CertCompressionAlgo = 0x0003
)

type Certificate 

type Certificate struct {
	Certificate [][]byte
	// PrivateKey contains the private key corresponding to the public key in
	// Leaf. This must implement crypto.Signer with an RSA, ECDSA or Ed25519 PublicKey.
	// For a server up to TLS 1.2, it can also implement crypto.Decrypter with
	// an RSA PublicKey.
	PrivateKey crypto.PrivateKey
	// SupportedSignatureAlgorithms is an optional list restricting what
	// signature algorithms the PrivateKey can be used for.
	SupportedSignatureAlgorithms []SignatureScheme
	// OCSPStaple contains an optional OCSP response which will be served
	// to clients that request it.
	OCSPStaple []byte
	// SignedCertificateTimestamps contains an optional list of Signed
	// Certificate Timestamps which will be served to clients that request it.
	SignedCertificateTimestamps [][]byte
	// Leaf is the parsed form of the leaf certificate, which may be initialized
	// using x509.ParseCertificate to reduce per-handshake processing. If nil,
	// the leaf certificate will be parsed as needed.
	Leaf *x509.Certificate
}

A Certificate is a chain of one or more certificates, leaf first.

func LoadX509KeyPair 

func LoadX509KeyPair(certFile, keyFile string) (Certificate, error)

LoadX509KeyPair reads and parses a public/private key pair from a pair of files. The files must contain PEM encoded data. The certificate file may contain intermediate certificates following the leaf certificate to form a certificate chain. On successful return, Certificate.Leaf will be nil because the parsed form of the certificate is not retained.

Example 
package main

import (
	"crypto/tls"
	"log"
)

func main() {
	cert, err := tls.LoadX509KeyPair("testdata/example-cert.pem", "testdata/example-key.pem")
	if err != nil {
		log.Fatal(err)
	}
	cfg := &tls.Config{Certificates: []tls.Certificate{cert}}
	listener, err := tls.Listen("tcp", ":2000", cfg)
	if err != nil {
		log.Fatal(err)
	}
	_ = listener
}

Output:

func X509KeyPair 

func X509KeyPair(certPEMBlock, keyPEMBlock []byte) (Certificate, error)

X509KeyPair parses a public/private key pair from a pair of PEM encoded data. On successful return, Certificate.Leaf will be nil because the parsed form of the certificate is not retained.

Example 
package main

import (
	"crypto/tls"
	"log"
)

func main() {
	certPem := []byte(`-----BEGIN CERTIFICATE-----
MIIBhTCCASugAwIBAgIQIRi6zePL6mKjOipn+dNuaTAKBggqhkjOPQQDAjASMRAw
DgYDVQQKEwdBY21lIENvMB4XDTE3MTAyMDE5NDMwNloXDTE4MTAyMDE5NDMwNlow
EjEQMA4GA1UEChMHQWNtZSBDbzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABD0d
7VNhbWvZLWPuj/RtHFjvtJBEwOkhbN/BnnE8rnZR8+sbwnc/KhCk3FhnpHZnQz7B
5aETbbIgmuvewdjvSBSjYzBhMA4GA1UdDwEB/wQEAwICpDATBgNVHSUEDDAKBggr
BgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MCkGA1UdEQQiMCCCDmxvY2FsaG9zdDo1
NDUzgg4xMjcuMC4wLjE6NTQ1MzAKBggqhkjOPQQDAgNIADBFAiEA2zpJEPQyz6/l
Wf86aX6PepsntZv2GYlA5UpabfT2EZICICpJ5h/iI+i341gBmLiAFQOyTDT+/wQc
6MF9+Yw1Yy0t
-----END CERTIFICATE-----`)
	keyPem := []byte(`-----BEGIN EC PRIVATE KEY-----
MHcCAQEEIIrYSSNQFaA2Hwf1duRSxKtLYX5CB04fSeQ6tF1aY/PuoAoGCCqGSM49
AwEHoUQDQgAEPR3tU2Fta9ktY+6P9G0cWO+0kETA6SFs38GecTyudlHz6xvCdz8q
EKTcWGekdmdDPsHloRNtsiCa697B2O9IFA==
-----END EC PRIVATE KEY-----`)
	cert, err := tls.X509KeyPair(certPem, keyPem)
	if err != nil {
		log.Fatal(err)
	}
	cfg := &tls.Config{Certificates: []tls.Certificate{cert}}
	listener, err := tls.Listen("tcp", ":2000", cfg)
	if err != nil {
		log.Fatal(err)
	}
	_ = listener
}

Output:
Example (HttpServer) 
package main

import (
	"crypto/tls"
	"log"
	"net/http"
	"time"
)

func main() {
	certPem := []byte(`-----BEGIN CERTIFICATE-----
MIIBhTCCASugAwIBAgIQIRi6zePL6mKjOipn+dNuaTAKBggqhkjOPQQDAjASMRAw
DgYDVQQKEwdBY21lIENvMB4XDTE3MTAyMDE5NDMwNloXDTE4MTAyMDE5NDMwNlow
EjEQMA4GA1UEChMHQWNtZSBDbzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABD0d
7VNhbWvZLWPuj/RtHFjvtJBEwOkhbN/BnnE8rnZR8+sbwnc/KhCk3FhnpHZnQz7B
5aETbbIgmuvewdjvSBSjYzBhMA4GA1UdDwEB/wQEAwICpDATBgNVHSUEDDAKBggr
BgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MCkGA1UdEQQiMCCCDmxvY2FsaG9zdDo1
NDUzgg4xMjcuMC4wLjE6NTQ1MzAKBggqhkjOPQQDAgNIADBFAiEA2zpJEPQyz6/l
Wf86aX6PepsntZv2GYlA5UpabfT2EZICICpJ5h/iI+i341gBmLiAFQOyTDT+/wQc
6MF9+Yw1Yy0t
-----END CERTIFICATE-----`)
	keyPem := []byte(`-----BEGIN EC PRIVATE KEY-----
MHcCAQEEIIrYSSNQFaA2Hwf1duRSxKtLYX5CB04fSeQ6tF1aY/PuoAoGCCqGSM49
AwEHoUQDQgAEPR3tU2Fta9ktY+6P9G0cWO+0kETA6SFs38GecTyudlHz6xvCdz8q
EKTcWGekdmdDPsHloRNtsiCa697B2O9IFA==
-----END EC PRIVATE KEY-----`)
	cert, err := tls.X509KeyPair(certPem, keyPem)
	if err != nil {
		log.Fatal(err)
	}
	cfg := &tls.Config{Certificates: []tls.Certificate{cert}}
	srv := &http.Server{
		TLSConfig:    cfg,
		ReadTimeout:  time.Minute,
		WriteTimeout: time.Minute,
	}
	log.Fatal(srv.ListenAndServeTLS("", ""))
}

Output:

type CertificateRequestInfo 

type CertificateRequestInfo struct {
	// AcceptableCAs contains zero or more, DER-encoded, X.501
	// Distinguished Names. These are the names of root or intermediate CAs
	// that the server wishes the returned certificate to be signed by. An
	// empty slice indicates that the server has no preference.
	AcceptableCAs [][]byte

	// SignatureSchemes lists the signature schemes that the server is
	// willing to verify.
	SignatureSchemes []SignatureScheme

	// Version is the TLS version that was negotiated for this connection.
	Version uint16
	// contains filtered or unexported fields
}

CertificateRequestInfo contains information from a server's CertificateRequest message, which is used to demand a certificate and proof of control from a client.

func (*CertificateRequestInfo) Context 

func (c *CertificateRequestInfo) Context() context.Context

Context returns the context of the handshake that is in progress. This context is a child of the context passed to HandshakeContext, if any, and is canceled when the handshake concludes.

func (*CertificateRequestInfo) SupportsCertificate 

func (cri *CertificateRequestInfo) SupportsCertificate(c *Certificate) error

SupportsCertificate returns nil if the provided certificate is supported by the server that sent the CertificateRequest. Otherwise, it returns an error describing the reason for the incompatibility.

type CertificateRequestMsgTLS13 

type CertificateRequestMsgTLS13 struct {
	Raw                              []byte
	OcspStapling                     bool
	Scts                             bool
	SupportedSignatureAlgorithms     []SignatureScheme
	SupportedSignatureAlgorithmsCert []SignatureScheme
	CertificateAuthorities           [][]byte
}

type CertificateVerificationError 

type CertificateVerificationError struct {
	// UnverifiedCertificates and its contents should not be modified.
	UnverifiedCertificates []*x509.Certificate
	Err                    error
}

CertificateVerificationError is returned when certificate verification fails during the handshake.

func (*CertificateVerificationError) Error 

func (e *CertificateVerificationError) Error() string

func (*CertificateVerificationError) Unwrap 

func (e *CertificateVerificationError) Unwrap() error

type CipherSuite 

type CipherSuite struct {
	ID   uint16
	Name string

	// Supported versions is the list of TLS protocol versions that can
	// negotiate this cipher suite.
	SupportedVersions []uint16

	// Insecure is true if the cipher suite has known security issues
	// due to its primitives, design, or implementation.
	Insecure bool
}

CipherSuite is a TLS cipher suite. Note that most functions in this package accept and expose cipher suite IDs instead of this type.

func CipherSuites 

func CipherSuites() []*CipherSuite

CipherSuites returns a list of cipher suites currently implemented by this package, excluding those with security issues, which are returned by InsecureCipherSuites.

The list is sorted by ID. Note that the default cipher suites selected by this package might depend on logic that can't be captured by a static list, and might not match those returned by this function.

func InsecureCipherSuites 

func InsecureCipherSuites() []*CipherSuite

InsecureCipherSuites returns a list of cipher suites currently implemented by this package and which have security issues.

Most applications should not use the cipher suites in this list, and should only use those returned by CipherSuites.

type CipherSuitesJSONUnmarshaler 

type CipherSuitesJSONUnmarshaler struct {
	// contains filtered or unexported fields
}

func (*CipherSuitesJSONUnmarshaler) CipherSuites 

func (c *CipherSuitesJSONUnmarshaler) CipherSuites() []uint16

func (*CipherSuitesJSONUnmarshaler) UnmarshalJSON 

func (c *CipherSuitesJSONUnmarshaler) UnmarshalJSON(jsonStr []byte) error

type ClientAuthType 

type ClientAuthType int

ClientAuthType declares the policy the server will follow for TLS Client Authentication. 

const (
	// NoClientCert indicates that no client certificate should be requested
	// during the handshake, and if any certificates are sent they will not
	// be verified.
	NoClientCert ClientAuthType = iota
	// RequestClientCert indicates that a client certificate should be requested
	// during the handshake, but does not require that the client send any
	// certificates.
	RequestClientCert
	// RequireAnyClientCert indicates that a client certificate should be requested
	// during the handshake, and that at least one certificate is required to be
	// sent by the client, but that certificate is not required to be valid.
	RequireAnyClientCert
	// VerifyClientCertIfGiven indicates that a client certificate should be requested
	// during the handshake, but does not require that the client sends a
	// certificate. If the client does send a certificate it is required to be
	// valid.
	VerifyClientCertIfGiven
	// RequireAndVerifyClientCert indicates that a client certificate should be requested
	// during the handshake, and that at least one valid certificate is required
	// to be sent by the client.
	RequireAndVerifyClientCert
)

func (ClientAuthType) String 

func (i ClientAuthType) String() string

type ClientHelloBuildStatus 

type ClientHelloBuildStatus int
const BuildByGoTLS ClientHelloBuildStatus = 2
const BuildByUtls ClientHelloBuildStatus = 1
const NotBuilt ClientHelloBuildStatus = 0

type ClientHelloID 

type ClientHelloID struct {
	Client string

	// Version specifies version of a mimicked clients (e.g. browsers).
	// Not used in randomized, custom handshake, and default Go.
	Version string

	// Seed is only used for randomized fingerprints to seed PRNG.
	// Must not be modified once set.
	Seed *PRNGSeed

	// Weights are only used for randomized fingerprints in func
	// generateRandomizedSpec(). Must not be modified once set.
	Weights *Weights
}

func (*ClientHelloID) IsSet 

func (p *ClientHelloID) IsSet() bool

func (*ClientHelloID) Str 

func (p *ClientHelloID) Str() string

type ClientHelloInfo 

type ClientHelloInfo struct {
	// CipherSuites lists the CipherSuites supported by the client (e.g.
	// TLS_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256).
	CipherSuites []uint16

	// ServerName indicates the name of the server requested by the client
	// in order to support virtual hosting. ServerName is only set if the
	// client is using SNI (see RFC 4366, Section 3.1).
	ServerName string

	// SupportedCurves lists the elliptic curves supported by the client.
	// SupportedCurves is set only if the Supported Elliptic Curves
	// Extension is being used (see RFC 4492, Section 5.1.1).
	SupportedCurves []CurveID

	// SupportedPoints lists the point formats supported by the client.
	// SupportedPoints is set only if the Supported Point Formats Extension
	// is being used (see RFC 4492, Section 5.1.2).
	SupportedPoints []uint8

	// SignatureSchemes lists the signature and hash schemes that the client
	// is willing to verify. SignatureSchemes is set only if the Signature
	// Algorithms Extension is being used (see RFC 5246, Section 7.4.1.4.1).
	SignatureSchemes []SignatureScheme

	// SupportedProtos lists the application protocols supported by the client.
	// SupportedProtos is set only if the Application-Layer Protocol
	// Negotiation Extension is being used (see RFC 7301, Section 3.1).
	//
	// Servers can select a protocol by setting Config.NextProtos in a
	// GetConfigForClient return value.
	SupportedProtos []string

	// SupportedVersions lists the TLS versions supported by the client.
	// For TLS versions less than 1.3, this is extrapolated from the max
	// version advertised by the client, so values other than the greatest
	// might be rejected if used.
	SupportedVersions []uint16

	// Conn is the underlying net.Conn for the connection. Do not read
	// from, or write to, this connection; that will cause the TLS
	// connection to fail.
	Conn net.Conn
	// contains filtered or unexported fields
}

ClientHelloInfo contains information from a ClientHello message in order to guide application logic in the GetCertificate and GetConfigForClient callbacks.

func (*ClientHelloInfo) Context 

func (c *ClientHelloInfo) Context() context.Context

Context returns the context of the handshake that is in progress. This context is a child of the context passed to HandshakeContext, if any, and is canceled when the handshake concludes.

func (*ClientHelloInfo) SupportsCertificate 

func (chi *ClientHelloInfo) SupportsCertificate(c *Certificate) error

SupportsCertificate returns nil if the provided certificate is supported by the client that sent the ClientHello. Otherwise, it returns an error describing the reason for the incompatibility.

If this ClientHelloInfo was passed to a GetConfigForClient or GetCertificate callback, this method will take into account the associated Config. Note that if GetConfigForClient returns a different Config, the change can't be accounted for by this method.

This function will call x509.ParseCertificate unless c.Leaf is set, which can incur a significant performance cost.

type ClientHelloSpec 

type ClientHelloSpec struct {
	CipherSuites       []uint16       // nil => default
	CompressionMethods []uint8        // nil => no compression
	Extensions         []TLSExtension // nil => no extensions

	TLSVersMin uint16 // [1.0-1.3] default: parse from .Extensions, if SupportedVersions ext is not present => 1.0
	TLSVersMax uint16 // [1.2-1.3] default: parse from .Extensions, if SupportedVersions ext is not present => 1.2

	// GreaseStyle: currently only random
	// sessionID may or may not depend on ticket; nil => random
	GetSessionID func(ticket []byte) [32]byte
}

func UTLSIdToSpec 

func UTLSIdToSpec(id ClientHelloID) (ClientHelloSpec, error)

UTLSIdToSpec converts a ClientHelloID to a corresponding ClientHelloSpec.

Exported internal function utlsIdToSpec per request.

func (*ClientHelloSpec) AlwaysAddPadding 

func (chs *ClientHelloSpec) AlwaysAddPadding()

func (*ClientHelloSpec) FromRaw 

func (chs *ClientHelloSpec) FromRaw(raw []byte, ctrlFlags ...bool) error

FromRaw converts a ClientHello message in the form of raw bytes into a ClientHelloSpec.

ctrlFlags: []bool{bluntMimicry, realPSK}

func (*ClientHelloSpec) ImportTLSClientHello 

func (chs *ClientHelloSpec) ImportTLSClientHello(data map[string][]byte) error

Import TLS ClientHello data from client.tlsfingerprint.io:8443

data is a map of []byte with following keys: - cipher_suites: [10, 10, 19, 1, 19, 2, 19, 3, 192, 43, 192, 47, 192, 44, 192, 48, 204, 169, 204, 168, 192, 19, 192, 20, 0, 156, 0, 157, 0, 47, 0, 53] - compression_methods: [0] => null - extensions: [10, 10, 255, 1, 0, 45, 0, 35, 0, 16, 68, 105, 0, 11, 0, 43, 0, 18, 0, 13, 0, 0, 0, 10, 0, 27, 0, 5, 0, 51, 0, 23, 10, 10, 0, 21] - pt_fmts (ec_point_formats): [1, 0] => len: 1, content: 0x00 - sig_algs （signature_algorithms): [0, 16, 4, 3, 8, 4, 4, 1, 5, 3, 8, 5, 5, 1, 8, 6, 6, 1] => len: 16, content: 0x0403, 0x0804, 0x0401, 0x0503, 0x0805, 0x0501, 0x0806, 0x0601 - supported_versions: [10, 10, 3, 4, 3, 3] => 0x0a0a, 0x0304, 0x0303 (GREASE, TLS 1.3, TLS 1.2) - curves (named_groups, supported_groups): [0, 8, 10, 10, 0, 29, 0, 23, 0, 24] => len: 8, content: GREASE, 0x001d, 0x0017, 0x0018 - alpn: [0, 12, 2, 104, 50, 8, 104, 116, 116, 112, 47, 49, 46, 49] => len: 12, content: h2, http/1.1 - key_share: [10, 10, 0, 1, 0, 29, 0, 32] => {group: 0x0a0a, len:1}, {group: 0x001d, len:32} - psk_key_exchange_modes: [1] => psk_dhe_ke(0x01) - cert_compression_algs: [2, 0, 2] => brotli (0x0002) - record_size_limit: [0, 255] => 255

TLSVersMin/TLSVersMax are set to 0 if supported_versions is present. To prevent conflict, they should be set manually if needed BEFORE calling this function.

func (*ClientHelloSpec) ImportTLSClientHelloFromJSON 

func (chs *ClientHelloSpec) ImportTLSClientHelloFromJSON(jsonB []byte) error

ImportTLSClientHelloFromJSON imports ClientHelloSpec from JSON data from client.tlsfingerprint.io format

It calls ImportTLSClientHello internally after unmarshaling JSON data into map[string][]byte

func (*ClientHelloSpec) ReadCipherSuites 

func (chs *ClientHelloSpec) ReadCipherSuites(b []byte) error

ReadCipherSuites is a helper function to construct a list of cipher suites from a []byte into []uint16.

example: []byte{0x13, 0x01, 0x13, 0x02, 0x13, 0x03} => []uint16{0x1301, 0x1302, 0x1303}

func (*ClientHelloSpec) ReadCompressionMethods 

func (chs *ClientHelloSpec) ReadCompressionMethods(compressionMethods []byte) error

ReadCompressionMethods is a helper function to construct a list of compression methods from a []byte into []uint8.

func (*ClientHelloSpec) ReadTLSExtensions 

func (chs *ClientHelloSpec) ReadTLSExtensions(b []byte, allowBluntMimicry bool, realPSK bool) error

ReadTLSExtensions is a helper function to construct a list of TLS extensions from a byte slice into []TLSExtension.

func (*ClientHelloSpec) UnmarshalJSON 

func (chs *ClientHelloSpec) UnmarshalJSON(jsonB []byte) error

UnmarshalJSON unmarshals a ClientHello message in the form of JSON into a ClientHelloSpec.

type ClientHelloSpecJSONUnmarshaler 

type ClientHelloSpecJSONUnmarshaler struct {
	CipherSuites       *CipherSuitesJSONUnmarshaler       `json:"cipher_suites"`
	CompressionMethods *CompressionMethodsJSONUnmarshaler `json:"compression_methods"`
	Extensions         *TLSExtensionsJSONUnmarshaler      `json:"extensions"`
	TLSVersMin         uint16                             `json:"min_vers,omitempty"` // optional
	TLSVersMax         uint16                             `json:"max_vers,omitempty"` // optional
}

func (*ClientHelloSpecJSONUnmarshaler) ClientHelloSpec 

func (chsju *ClientHelloSpecJSONUnmarshaler) ClientHelloSpec() ClientHelloSpec

type ClientSessionCache 

type ClientSessionCache interface {
	// Get searches for a ClientSessionState associated with the given key.
	// On return, ok is true if one was found.
	Get(sessionKey string) (session *ClientSessionState, ok bool)

	// Put adds the ClientSessionState to the cache with the given key. It might
	// get called multiple times in a connection if a TLS 1.3 server provides
	// more than one session ticket. If called with a nil *ClientSessionState,
	// it should remove the cache entry.
	Put(sessionKey string, cs *ClientSessionState)
}

ClientSessionCache is a cache of ClientSessionState objects that can be used by a client to resume a TLS session with a given server. ClientSessionCache implementations should expect to be called concurrently from different goroutines. Up to TLS 1.2, only ticket-based resumption is supported, not SessionID-based resumption. In TLS 1.3 they were merged into PSK modes, which are supported via this interface.

func NewLRUClientSessionCache 

func NewLRUClientSessionCache(capacity int) ClientSessionCache

NewLRUClientSessionCache returns a ClientSessionCache with the given capacity that uses an LRU strategy. If capacity is < 1, a default capacity is used instead.

type ClientSessionState 

type ClientSessionState struct {
	// contains filtered or unexported fields
}

ClientSessionState contains the state needed by a client to resume a previous TLS session.

func MakeClientSessionState 

func MakeClientSessionState(
	SessionTicket []uint8,
	Vers uint16,
	CipherSuite uint16,
	MasterSecret []byte,
	ServerCertificates []*x509.Certificate,
	VerifiedChains [][]*x509.Certificate) *ClientSessionState

ClientSessionState contains the state needed by clients to resume TLS sessions.

func NewResumptionState 

func NewResumptionState(ticket []byte, state *SessionState) (*ClientSessionState, error)

NewResumptionState returns a state value that can be returned by [ClientSessionCache.Get] to resume a previous session.

state needs to be returned by ParseSessionState, and the ticket and session state must have been returned by ClientSessionState.ResumptionState.

func (*ClientSessionState) CipherSuite 

func (css *ClientSessionState) CipherSuite() uint16

Ciphersuite negotiated for the session

func (*ClientSessionState) EMS 

func (css *ClientSessionState) EMS() bool

func (*ClientSessionState) MasterSecret 

func (css *ClientSessionState) MasterSecret() []byte

MasterSecret generated by client on a full handshake

func (*ClientSessionState) ResumptionState 

func (cs *ClientSessionState) ResumptionState() (ticket []byte, state *SessionState, err error)

ResumptionState returns the session ticket sent by the server (also known as the session's identity) and the state necessary to resume this session.

It can be called by [ClientSessionCache.Put] to serialize (with SessionState.Bytes) and store the session.

func (*ClientSessionState) ServerCertificates 

func (css *ClientSessionState) ServerCertificates() []*x509.Certificate

Certificate chain presented by the server

func (*ClientSessionState) SessionTicket 

func (css *ClientSessionState) SessionTicket() []uint8

Encrypted ticket used for session resumption with server

func (*ClientSessionState) SetAgeAdd 

func (css *ClientSessionState) SetAgeAdd(ageAdd uint32)

func (*ClientSessionState) SetCipherSuite 

func (css *ClientSessionState) SetCipherSuite(CipherSuite uint16)

func (*ClientSessionState) SetCreatedAt 

func (css *ClientSessionState) SetCreatedAt(createdAt uint64)

func (*ClientSessionState) SetEMS 

func (css *ClientSessionState) SetEMS(ems bool)

func (*ClientSessionState) SetMasterSecret 

func (css *ClientSessionState) SetMasterSecret(MasterSecret []byte)

func (*ClientSessionState) SetServerCertificates 

func (css *ClientSessionState) SetServerCertificates(ServerCertificates []*x509.Certificate)

func (*ClientSessionState) SetSessionTicket 

func (css *ClientSessionState) SetSessionTicket(SessionTicket []uint8)

func (*ClientSessionState) SetUseBy 

func (css *ClientSessionState) SetUseBy(useBy uint64)

func (*ClientSessionState) SetVerifiedChains 

func (css *ClientSessionState) SetVerifiedChains(VerifiedChains [][]*x509.Certificate)

func (*ClientSessionState) SetVers 

func (css *ClientSessionState) SetVers(Vers uint16)

func (*ClientSessionState) VerifiedChains 

func (css *ClientSessionState) VerifiedChains() [][]*x509.Certificate

Certificate chains we built for verification

func (*ClientSessionState) Vers 

func (css *ClientSessionState) Vers() uint16

SSL/TLS version negotiated for the session

type CompressionMethodsJSONUnmarshaler 

type CompressionMethodsJSONUnmarshaler struct {
	// contains filtered or unexported fields
}

func (*CompressionMethodsJSONUnmarshaler) CompressionMethods 

func (c *CompressionMethodsJSONUnmarshaler) CompressionMethods() []uint8

func (*CompressionMethodsJSONUnmarshaler) UnmarshalJSON 

func (c *CompressionMethodsJSONUnmarshaler) UnmarshalJSON(jsonStr []byte) error

type Config 

type Config struct {
	// Rand provides the source of entropy for nonces and RSA blinding.
	// If Rand is nil, TLS uses the cryptographic random reader in package
	// crypto/rand.
	// The Reader must be safe for use by multiple goroutines.
	Rand io.Reader

	// Time returns the current time as the number of seconds since the epoch.
	// If Time is nil, TLS uses time.Now.
	Time func() time.Time

	// Certificates contains one or more certificate chains to present to the
	// other side of the connection. The first certificate compatible with the
	// peer's requirements is selected automatically.
	//
	// Server configurations must set one of Certificates, GetCertificate or
	// GetConfigForClient. Clients doing client-authentication may set either
	// Certificates or GetClientCertificate.
	//
	// Note: if there are multiple Certificates, and they don't have the
	// optional field Leaf set, certificate selection will incur a significant
	// per-handshake performance cost.
	Certificates []Certificate

	// NameToCertificate maps from a certificate name to an element of
	// Certificates. Note that a certificate name can be of the form
	// '*.example.com' and so doesn't have to be a domain name as such.
	//
	// Deprecated: NameToCertificate only allows associating a single
	// certificate with a given name. Leave this field nil to let the library
	// select the first compatible chain from Certificates.
	NameToCertificate map[string]*Certificate

	// GetCertificate returns a Certificate based on the given
	// ClientHelloInfo. It will only be called if the client supplies SNI
	// information or if Certificates is empty.
	//
	// If GetCertificate is nil or returns nil, then the certificate is
	// retrieved from NameToCertificate. If NameToCertificate is nil, the
	// best element of Certificates will be used.
	//
	// Once a Certificate is returned it should not be modified.
	GetCertificate func(*ClientHelloInfo) (*Certificate, error)

	// GetClientCertificate, if not nil, is called when a server requests a
	// certificate from a client. If set, the contents of Certificates will
	// be ignored.
	//
	// If GetClientCertificate returns an error, the handshake will be
	// aborted and that error will be returned. Otherwise
	// GetClientCertificate must return a non-nil Certificate. If
	// Certificate.Certificate is empty then no certificate will be sent to
	// the server. If this is unacceptable to the server then it may abort
	// the handshake.
	//
	// GetClientCertificate may be called multiple times for the same
	// connection if renegotiation occurs or if TLS 1.3 is in use.
	//
	// Once a Certificate is returned it should not be modified.
	GetClientCertificate func(*CertificateRequestInfo) (*Certificate, error)

	// GetConfigForClient, if not nil, is called after a ClientHello is
	// received from a client. It may return a non-nil Config in order to
	// change the Config that will be used to handle this connection. If
	// the returned Config is nil, the original Config will be used. The
	// Config returned by this callback may not be subsequently modified.
	//
	// If GetConfigForClient is nil, the Config passed to Server() will be
	// used for all connections.
	//
	// If SessionTicketKey was explicitly set on the returned Config, or if
	// SetSessionTicketKeys was called on the returned Config, those keys will
	// be used. Otherwise, the original Config keys will be used (and possibly
	// rotated if they are automatically managed).
	GetConfigForClient func(*ClientHelloInfo) (*Config, error)

	// VerifyPeerCertificate, if not nil, is called after normal
	// certificate verification by either a TLS client or server. It
	// receives the raw ASN.1 certificates provided by the peer and also
	// any verified chains that normal processing found. If it returns a
	// non-nil error, the handshake is aborted and that error results.
	//
	// If normal verification fails then the handshake will abort before
	// considering this callback. If normal verification is disabled (on the
	// client when InsecureSkipVerify is set, or on a server when ClientAuth is
	// RequestClientCert or RequireAnyClientCert), then this callback will be
	// considered but the verifiedChains argument will always be nil. When
	// ClientAuth is NoClientCert, this callback is not called on the server.
	// rawCerts may be empty on the server if ClientAuth is RequestClientCert or
	// VerifyClientCertIfGiven.
	//
	// This callback is not invoked on resumed connections, as certificates are
	// not re-verified on resumption.
	//
	// verifiedChains and its contents should not be modified.
	VerifyPeerCertificate func(rawCerts [][]byte, verifiedChains [][]*x509.Certificate) error

	// VerifyConnection, if not nil, is called after normal certificate
	// verification and after VerifyPeerCertificate by either a TLS client
	// or server. If it returns a non-nil error, the handshake is aborted
	// and that error results.
	//
	// If normal verification fails then the handshake will abort before
	// considering this callback. This callback will run for all connections,
	// including resumptions, regardless of InsecureSkipVerify or ClientAuth
	// settings.
	VerifyConnection func(ConnectionState) error

	// RootCAs defines the set of root certificate authorities
	// that clients use when verifying server certificates.
	// If RootCAs is nil, TLS uses the host's root CA set.
	RootCAs *x509.CertPool

	// NextProtos is a list of supported application level protocols, in
	// order of preference. If both peers support ALPN, the selected
	// protocol will be one from this list, and the connection will fail
	// if there is no mutually supported protocol. If NextProtos is empty
	// or the peer doesn't support ALPN, the connection will succeed and
	// ConnectionState.NegotiatedProtocol will be empty.
	NextProtos []string

	// ApplicationSettings is a set of application settings (ALPS) to use
	// with each application protocol (ALPN).
	ApplicationSettings map[string][]byte // [uTLS]

	// ServerName is used to verify the hostname on the returned
	// certificates unless InsecureSkipVerify is given. It is also included
	// in the client's handshake to support virtual hosting unless it is
	// an IP address.
	ServerName string

	// ClientAuth determines the server's policy for
	// TLS Client Authentication. The default is NoClientCert.
	ClientAuth ClientAuthType

	// ClientCAs defines the set of root certificate authorities
	// that servers use if required to verify a client certificate
	// by the policy in ClientAuth.
	ClientCAs *x509.CertPool

	// InsecureSkipVerify controls whether a client verifies the server's
	// certificate chain and host name. If InsecureSkipVerify is true, crypto/tls
	// accepts any certificate presented by the server and any host name in that
	// certificate. In this mode, TLS is susceptible to machine-in-the-middle
	// attacks unless custom verification is used. This should be used only for
	// testing or in combination with VerifyConnection or VerifyPeerCertificate.
	InsecureSkipVerify bool

	// InsecureSkipTimeVerify controls whether a client verifies the server's
	// certificate chain against time. If InsecureSkipTimeVerify is true,
	// crypto/tls accepts the certificate even when it is expired.
	//
	// This field is ignored when InsecureSkipVerify is true.
	InsecureSkipTimeVerify bool // [uTLS]

	// OmitEmptyPsk determines whether utls will automatically conceal
	// the psk extension when it is empty. When the psk extension is empty, the
	// browser omits it from the client hello. Utls can mimic this behavior,
	// but it deviates from the provided client hello specification, rendering
	// it unsuitable as the default behavior. Users have the option to enable
	// this behavior at their own discretion.
	OmitEmptyPsk bool // [uTLS]

	// InsecureServerNameToVerify is used to verify the hostname on the returned
	// certificates. It is intended to use with spoofed ServerName.
	// If InsecureServerNameToVerify is "*", crypto/tls will do normal
	// certificate validation but ignore certifacate's DNSName.
	//
	// This field is ignored when InsecureSkipVerify is true.
	InsecureServerNameToVerify string // [uTLS]

	// PreferSkipResumptionOnNilExtension controls the behavior when session resumption is enabled but the corresponding session extensions are nil.
	//
	// To successfully use session resumption, ensure that the following requirements are met:
	//  - SessionTicketsDisabled is set to false
	//  - ClientSessionCache is non-nil
	//  - For TLS 1.2, SessionTicketExtension is non-nil
	//  - For TLS 1.3, PreSharedKeyExtension is non-nil
	//
	// There may be cases where users enable session resumption (SessionTicketsDisabled: false && ClientSessionCache: non-nil), but they do not provide SessionTicketExtension or PreSharedKeyExtension in the ClientHelloSpec. This could be intentional or accidental.
	//
	// By default, utls throws an exception in such scenarios. Set this to true to skip the resumption and suppress the exception.
	PreferSkipResumptionOnNilExtension bool // [uTLS]

	// CipherSuites is a list of enabled TLS 1.0–1.2 cipher suites. The order of
	// the list is ignored. Note that TLS 1.3 ciphersuites are not configurable.
	//
	// If CipherSuites is nil, a safe default list is used. The default cipher
	// suites might change over time. In Go 1.22 RSA key exchange based cipher
	// suites were removed from the default list, but can be re-added with the
	// GODEBUG setting tlsrsakex=1.
	CipherSuites []uint16

	// PreferServerCipherSuites is a legacy field and has no effect.
	//
	// It used to control whether the server would follow the client's or the
	// server's preference. Servers now select the best mutually supported
	// cipher suite based on logic that takes into account inferred client
	// hardware, server hardware, and security.
	//
	// Deprecated: PreferServerCipherSuites is ignored.
	PreferServerCipherSuites bool

	// SessionTicketsDisabled may be set to true to disable session ticket and
	// PSK (resumption) support. Note that on clients, session ticket support is
	// also disabled if ClientSessionCache is nil.
	SessionTicketsDisabled bool

	// SessionTicketKey is used by TLS servers to provide session resumption.
	// See RFC 5077 and the PSK mode of RFC 8446. If zero, it will be filled
	// with random data before the first server handshake.
	//
	// Deprecated: if this field is left at zero, session ticket keys will be
	// automatically rotated every day and dropped after seven days. For
	// customizing the rotation schedule or synchronizing servers that are
	// terminating connections for the same host, use SetSessionTicketKeys.
	SessionTicketKey [32]byte

	// ClientSessionCache is a cache of ClientSessionState entries for TLS
	// session resumption. It is only used by clients.
	ClientSessionCache ClientSessionCache

	// UnwrapSession is called on the server to turn a ticket/identity
	// previously produced by [WrapSession] into a usable session.
	//
	// UnwrapSession will usually either decrypt a session state in the ticket
	// (for example with [Config.EncryptTicket]), or use the ticket as a handle
	// to recover a previously stored state. It must use [ParseSessionState] to
	// deserialize the session state.
	//
	// If UnwrapSession returns an error, the connection is terminated. If it
	// returns (nil, nil), the session is ignored. crypto/tls may still choose
	// not to resume the returned session.
	UnwrapSession func(identity []byte, cs ConnectionState) (*SessionState, error)

	// WrapSession is called on the server to produce a session ticket/identity.
	//
	// WrapSession must serialize the session state with [SessionState.Bytes].
	// It may then encrypt the serialized state (for example with
	// [Config.DecryptTicket]) and use it as the ticket, or store the state and
	// return a handle for it.
	//
	// If WrapSession returns an error, the connection is terminated.
	//
	// Warning: the return value will be exposed on the wire and to clients in
	// plaintext. The application is in charge of encrypting and authenticating
	// it (and rotating keys) or returning high-entropy identifiers. Failing to
	// do so correctly can compromise current, previous, and future connections
	// depending on the protocol version.
	WrapSession func(ConnectionState, *SessionState) ([]byte, error)

	// MinVersion contains the minimum TLS version that is acceptable.
	//
	// By default, TLS 1.2 is currently used as the minimum. TLS 1.0 is the
	// minimum supported by this package.
	//
	// The server-side default can be reverted to TLS 1.0 by including the value
	// "tls10server=1" in the GODEBUG environment variable.
	MinVersion uint16

	// MaxVersion contains the maximum TLS version that is acceptable.
	//
	// By default, the maximum version supported by this package is used,
	// which is currently TLS 1.3.
	MaxVersion uint16

	// CurvePreferences contains the elliptic curves that will be used in
	// an ECDHE handshake, in preference order. If empty, the default will
	// be used. The client will use the first preference as the type for
	// its key share in TLS 1.3. This may change in the future.
	CurvePreferences []CurveID

	// PQSignatureSchemesEnabled controls whether additional post-quantum
	// signature schemes are supported for peer certificates. For available
	// signature schemes, see tls_cf.go.
	PQSignatureSchemesEnabled bool // [UTLS] ported from cloudflare/go

	// DynamicRecordSizingDisabled disables adaptive sizing of TLS records.
	// When true, the largest possible TLS record size is always used. When
	// false, the size of TLS records may be adjusted in an attempt to
	// improve latency.
	DynamicRecordSizingDisabled bool

	// Renegotiation controls what types of renegotiation are supported.
	// The default, none, is correct for the vast majority of applications.
	Renegotiation RenegotiationSupport

	// KeyLogWriter optionally specifies a destination for TLS master secrets
	// in NSS key log format that can be used to allow external programs
	// such as Wireshark to decrypt TLS connections.
	// See https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format.
	// Use of KeyLogWriter compromises security and should only be
	// used for debugging.
	KeyLogWriter io.Writer

	SessionIDGenerator func(clientHello []byte, sessionID []byte) error

	// ECHConfigs contains the ECH configurations to be used by the ECH
	// extension if any.
	// It could either be distributed by the server in EncryptedExtensions
	// message or out-of-band.
	//
	// If ECHConfigs is nil and an ECH extension is present, GREASEd ECH
	// extension will be sent.
	//
	// If GREASE ECH extension is present, this field will be ignored.
	ECHConfigs []ECHConfig // [uTLS]
	// contains filtered or unexported fields
}

A Config structure is used to configure a TLS client or server. After one has been passed to a TLS function it must not be modified. A Config may be reused; the tls package will also not modify it.

Example (KeyLogWriter) 
package main

import (
	"crypto/tls"
	"log"
	"net/http"
	"net/http/httptest"
	"os"
)

// zeroSource is an io.Reader that returns an unlimited number of zero bytes.
type zeroSource struct{}

func (zeroSource) Read(b []byte) (n int, err error) {
	for i := range b {
		b[i] = 0
	}

	return len(b), nil
}

func main() {
	// Debugging TLS applications by decrypting a network traffic capture.

	// WARNING: Use of KeyLogWriter compromises security and should only be
	// used for debugging.

	// Dummy test HTTP server for the example with insecure random so output is
	// reproducible.
	server := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
	server.TLS = &tls.Config{
		Rand: zeroSource{}, // for example only; don't do this.
	}
	server.StartTLS()
	defer server.Close()

	// Typically the log would go to an open file:
	// w, err := os.OpenFile("tls-secrets.txt", os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
	w := os.Stdout

	client := &http.Client{
		Transport: &http.Transport{
			TLSClientConfig: &tls.Config{
				KeyLogWriter: w,

				Rand:               zeroSource{}, // for reproducible output; don't do this.
				InsecureSkipVerify: true,         // test server certificate is not trusted.
			},
		},
	}
	resp, err := client.Get(server.URL)
	if err != nil {
		log.Fatalf("Failed to get URL: %v", err)
	}
	resp.Body.Close()

	// The resulting file can be used with Wireshark to decrypt the TLS
	// connection by setting (Pre)-Master-Secret log filename in SSL Protocol
	// preferences.
}

Output:
Example (VerifyConnection) 
package main

import (
	"crypto/tls"
	"crypto/x509"
)

func main() {
	// VerifyConnection can be used to replace and customize connection
	// verification. This example shows a VerifyConnection implementation that
	// will be approximately equivalent to what crypto/tls does normally to
	// verify the peer's certificate.

	// Client side configuration.
	_ = &tls.Config{
		// Set InsecureSkipVerify to skip the default validation we are
		// replacing. This will not disable VerifyConnection.
		InsecureSkipVerify: true,
		VerifyConnection: func(cs tls.ConnectionState) error {
			opts := x509.VerifyOptions{
				DNSName:       cs.ServerName,
				Intermediates: x509.NewCertPool(),
			}
			for _, cert := range cs.PeerCertificates[1:] {
				opts.Intermediates.AddCert(cert)
			}
			_, err := cs.PeerCertificates[0].Verify(opts)
			return err
		},
	}

	// Server side configuration.
	_ = &tls.Config{
		// Require client certificates (or VerifyConnection will run anyway and
		// panic accessing cs.PeerCertificates[0]) but don't verify them with the
		// default verifier. This will not disable VerifyConnection.
		ClientAuth: tls.RequireAnyClientCert,
		VerifyConnection: func(cs tls.ConnectionState) error {
			opts := x509.VerifyOptions{
				DNSName:       cs.ServerName,
				Intermediates: x509.NewCertPool(),
				KeyUsages:     []x509.ExtKeyUsage{x509.ExtKeyUsageClientAuth},
			}
			for _, cert := range cs.PeerCertificates[1:] {
				opts.Intermediates.AddCert(cert)
			}
			_, err := cs.PeerCertificates[0].Verify(opts)
			return err
		},
	}

	// Note that when certificates are not handled by the default verifier
	// ConnectionState.VerifiedChains will be nil.
}

Output:

func (*Config) BuildNameToCertificate deprecated 

func (c *Config) BuildNameToCertificate()

BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate from the CommonName and SubjectAlternateName fields of each of the leaf certificates.

Deprecated: NameToCertificate only allows associating a single certificate with a given name. Leave that field nil to let the library select the first compatible chain from Certificates.

func (*Config) Clone 

func (c *Config) Clone() *Config

Clone returns a shallow clone of c or nil if c is nil. It is safe to clone a Config that is being used concurrently by a TLS client or server.

func (*Config) DecryptTicket 

func (c *Config) DecryptTicket(identity []byte, cs ConnectionState) (*SessionState, error)

DecryptTicket decrypts a ticket encrypted by Config.EncryptTicket. It can be used as a [Config.UnwrapSession] implementation.

If the ticket can't be decrypted or parsed, DecryptTicket returns (nil, nil).

func (*Config) EncryptTicket 

func (c *Config) EncryptTicket(cs ConnectionState, ss *SessionState) ([]byte, error)

EncryptTicket encrypts a ticket with the Config's configured (or default) session ticket keys. It can be used as a [Config.WrapSession] implementation.

func (*Config) SetSessionTicketKeys 

func (c *Config) SetSessionTicketKeys(keys [][32]byte)

SetSessionTicketKeys updates the session ticket keys for a server.

The first key will be used when creating new tickets, while all keys can be used for decrypting tickets. It is safe to call this function while the server is running in order to rotate the session ticket keys. The function will panic if keys is empty.

Calling this function will turn off automatic session ticket key rotation.

If multiple servers are terminating connections for the same host they should all have the same session ticket keys. If the session ticket keys leaks, previously recorded and future TLS connections using those keys might be compromised.

type Conn 

type Conn struct {
	// contains filtered or unexported fields
}

A Conn represents a secured connection. It implements the net.Conn interface.

func Client 

func Client(conn net.Conn, config *Config) *Conn

Client returns a new TLS client side connection using conn as the underlying transport. The config cannot be nil: users must set either ServerName or InsecureSkipVerify in the config.

func Dial 

func Dial(network, addr string, config *Config) (*Conn, error)

Dial connects to the given network address using net.Dial and then initiates a TLS handshake, returning the resulting TLS connection. Dial interprets a nil configuration as equivalent to the zero configuration; see the documentation of Config for the defaults.

Example 
package main

import (
	"crypto/tls"
	"crypto/x509"
)

func main() {
	// Connecting with a custom root-certificate set.

	const rootPEM = `
-- GlobalSign Root R2, valid until Dec 15, 2021
-----BEGIN CERTIFICATE-----
MIIDujCCAqKgAwIBAgILBAAAAAABD4Ym5g0wDQYJKoZIhvcNAQEFBQAwTDEgMB4G
A1UECxMXR2xvYmFsU2lnbiBSb290IENBIC0gUjIxEzARBgNVBAoTCkdsb2JhbFNp
Z24xEzARBgNVBAMTCkdsb2JhbFNpZ24wHhcNMDYxMjE1MDgwMDAwWhcNMjExMjE1
MDgwMDAwWjBMMSAwHgYDVQQLExdHbG9iYWxTaWduIFJvb3QgQ0EgLSBSMjETMBEG
A1UEChMKR2xvYmFsU2lnbjETMBEGA1UEAxMKR2xvYmFsU2lnbjCCASIwDQYJKoZI
hvcNAQEBBQADggEPADCCAQoCggEBAKbPJA6+Lm8omUVCxKs+IVSbC9N/hHD6ErPL
v4dfxn+G07IwXNb9rfF73OX4YJYJkhD10FPe+3t+c4isUoh7SqbKSaZeqKeMWhG8
eoLrvozps6yWJQeXSpkqBy+0Hne/ig+1AnwblrjFuTosvNYSuetZfeLQBoZfXklq
tTleiDTsvHgMCJiEbKjNS7SgfQx5TfC4LcshytVsW33hoCmEofnTlEnLJGKRILzd
C9XZzPnqJworc5HGnRusyMvo4KD0L5CLTfuwNhv2GXqF4G3yYROIXJ/gkwpRl4pa
zq+r1feqCapgvdzZX99yqWATXgAByUr6P6TqBwMhAo6CygPCm48CAwEAAaOBnDCB
mTAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUm+IH
V2ccHsBqBt5ZtJot39wZhi4wNgYDVR0fBC8wLTAroCmgJ4YlaHR0cDovL2NybC5n
bG9iYWxzaWduLm5ldC9yb290LXIyLmNybDAfBgNVHSMEGDAWgBSb4gdXZxwewGoG
3lm0mi3f3BmGLjANBgkqhkiG9w0BAQUFAAOCAQEAmYFThxxol4aR7OBKuEQLq4Gs
J0/WwbgcQ3izDJr86iw8bmEbTUsp9Z8FHSbBuOmDAGJFtqkIk7mpM0sYmsL4h4hO
291xNBrBVNpGP+DTKqttVCL1OmLNIG+6KYnX3ZHu01yiPqFbQfXf5WRDLenVOavS
ot+3i9DAgBkcRcAtjOj4LaR0VknFBbVPFd5uRHg5h6h+u/N5GJG79G+dwfCMNYxd
AfvDbbnvRG15RjF+Cv6pgsH/76tuIMRQyV+dTZsXjAzlAcmgQWpzU/qlULRuJQ/7
TBj0/VLZjmmx6BEP3ojY+x1J96relc8geMJgEtslQIxq/H5COEBkEveegeGTLg==
-----END CERTIFICATE-----`

	// First, create the set of root certificates. For this example we only
	// have one. It's also possible to omit this in order to use the
	// default root set of the current operating system.
	roots := x509.NewCertPool()
	ok := roots.AppendCertsFromPEM([]byte(rootPEM))
	if !ok {
		panic("failed to parse root certificate")
	}

	conn, err := tls.Dial("tcp", "mail.google.com:443", &tls.Config{
		RootCAs: roots,
	})
	if err != nil {
		panic("failed to connect: " + err.Error())
	}
	conn.Close()
}

Output:

func DialWithDialer 

func DialWithDialer(dialer *net.Dialer, network, addr string, config *Config) (*Conn, error)

DialWithDialer connects to the given network address using dialer.Dial and then initiates a TLS handshake, returning the resulting TLS connection. Any timeout or deadline given in the dialer apply to connection and TLS handshake as a whole.

DialWithDialer interprets a nil configuration as equivalent to the zero configuration; see the documentation of Config for the defaults.

DialWithDialer uses context.Background internally; to specify the context, use Dialer.DialContext with NetDialer set to the desired dialer.

func MakeConnWithCompleteHandshake 

func MakeConnWithCompleteHandshake(tcpConn net.Conn, version uint16, cipherSuite uint16, masterSecret []byte, clientRandom []byte, serverRandom []byte, isClient bool) *Conn

MakeConnWithCompleteHandshake allows to forge both server and client side TLS connections. Major Hack Alert.

func Server 

func Server(conn net.Conn, config *Config) *Conn

Server returns a new TLS server side connection using conn as the underlying transport. The configuration config must be non-nil and must include at least one certificate or else set GetCertificate.

func (*Conn) Close 

func (c *Conn) Close() error

Close closes the connection.

func (*Conn) CloseWrite 

func (c *Conn) CloseWrite() error

CloseWrite shuts down the writing side of the connection. It should only be called once the handshake has completed and does not call CloseWrite on the underlying connection. Most callers should just use Conn.Close.

func (*Conn) ConnectionState 

func (c *Conn) ConnectionState() ConnectionState

ConnectionState returns basic TLS details about the connection.

func (*Conn) Handshake 

func (c *Conn) Handshake() error

Handshake runs the client or server handshake protocol if it has not yet been run.

Most uses of this package need not call Handshake explicitly: the first Conn.Read or Conn.Write will call it automatically.

For control over canceling or setting a timeout on a handshake, use Conn.HandshakeContext or the Dialer's DialContext method instead.

In order to avoid denial of service attacks, the maximum RSA key size allowed in certificates sent by either the TLS server or client is limited to 8192 bits. This limit can be overridden by setting tlsmaxrsasize in the GODEBUG environment variable (e.g. GODEBUG=tlsmaxrsasize=4096).

func (*Conn) HandshakeContext 

func (c *Conn) HandshakeContext(ctx context.Context) error

HandshakeContext runs the client or server handshake protocol if it has not yet been run.

The provided Context must be non-nil. If the context is canceled before the handshake is complete, the handshake is interrupted and an error is returned. Once the handshake has completed, cancellation of the context will not affect the connection.

Most uses of this package need not call HandshakeContext explicitly: the first Conn.Read or Conn.Write will call it automatically.

func (*Conn) LocalAddr 

func (c *Conn) LocalAddr() net.Addr

LocalAddr returns the local network address.

func (*Conn) NetConn 

func (c *Conn) NetConn() net.Conn

NetConn returns the underlying connection that is wrapped by c. Note that writing to or reading from this connection directly will corrupt the TLS session.

func (*Conn) OCSPResponse 

func (c *Conn) OCSPResponse() []byte

OCSPResponse returns the stapled OCSP response from the TLS server, if any. (Only valid for client connections.)

func (*Conn) Read 

func (c *Conn) Read(b []byte) (int, error)

Read reads data from the connection.

As Read calls Conn.Handshake, in order to prevent indefinite blocking a deadline must be set for both Read and Conn.Write before Read is called when the handshake has not yet completed. See Conn.SetDeadline, Conn.SetReadDeadline, and Conn.SetWriteDeadline.

func (*Conn) RemoteAddr 

func (c *Conn) RemoteAddr() net.Addr

RemoteAddr returns the remote network address.

func (*Conn) SetDeadline 

func (c *Conn) SetDeadline(t time.Time) error

SetDeadline sets the read and write deadlines associated with the connection. A zero value for t means Conn.Read and Conn.Write will not time out. After a Write has timed out, the TLS state is corrupt and all future writes will return the same error.

func (*Conn) SetReadDeadline 

func (c *Conn) SetReadDeadline(t time.Time) error

SetReadDeadline sets the read deadline on the underlying connection. A zero value for t means Conn.Read will not time out.

func (*Conn) SetWriteDeadline 

func (c *Conn) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the write deadline on the underlying connection. A zero value for t means Conn.Write will not time out. After a Conn.Write has timed out, the TLS state is corrupt and all future writes will return the same error.

func (*Conn) VerifyHostname 

func (c *Conn) VerifyHostname(host string) error

VerifyHostname checks that the peer certificate chain is valid for connecting to host. If so, it returns nil; if not, it returns an error describing the problem.

func (*Conn) Write 

func (c *Conn) Write(b []byte) (int, error)

Write writes data to the connection.

As Write calls Conn.Handshake, in order to prevent indefinite blocking a deadline must be set for both Conn.Read and Write before Write is called when the handshake has not yet completed. See Conn.SetDeadline, Conn.SetReadDeadline, and Conn.SetWriteDeadline.

type ConnectionState 

type ConnectionState struct {
	// Version is the TLS version used by the connection (e.g. VersionTLS12).
	Version uint16

	// HandshakeComplete is true if the handshake has concluded.
	HandshakeComplete bool

	// DidResume is true if this connection was successfully resumed from a
	// previous session with a session ticket or similar mechanism.
	DidResume bool

	// CipherSuite is the cipher suite negotiated for the connection (e.g.
	// TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_AES_128_GCM_SHA256).
	CipherSuite uint16

	// NegotiatedProtocol is the application protocol negotiated with ALPN.
	NegotiatedProtocol string

	// NegotiatedProtocolIsMutual used to indicate a mutual NPN negotiation.
	//
	// Deprecated: this value is always true.
	NegotiatedProtocolIsMutual bool

	// PeerApplicationSettings is the Application-Layer Protocol Settings (ALPS)
	// provided by peer.
	PeerApplicationSettings []byte // [uTLS]

	// ServerName is the value of the Server Name Indication extension sent by
	// the client. It's available both on the server and on the client side.
	ServerName string

	// PeerCertificates are the parsed certificates sent by the peer, in the
	// order in which they were sent. The first element is the leaf certificate
	// that the connection is verified against.
	//
	// On the client side, it can't be empty. On the server side, it can be
	// empty if Config.ClientAuth is not RequireAnyClientCert or
	// RequireAndVerifyClientCert.
	//
	// PeerCertificates and its contents should not be modified.
	PeerCertificates []*x509.Certificate

	// VerifiedChains is a list of one or more chains where the first element is
	// PeerCertificates[0] and the last element is from Config.RootCAs (on the
	// client side) or Config.ClientCAs (on the server side).
	//
	// On the client side, it's set if Config.InsecureSkipVerify is false. On
	// the server side, it's set if Config.ClientAuth is VerifyClientCertIfGiven
	// (and the peer provided a certificate) or RequireAndVerifyClientCert.
	//
	// VerifiedChains and its contents should not be modified.
	VerifiedChains [][]*x509.Certificate

	// SignedCertificateTimestamps is a list of SCTs provided by the peer
	// through the TLS handshake for the leaf certificate, if any.
	SignedCertificateTimestamps [][]byte

	// OCSPResponse is a stapled Online Certificate Status Protocol (OCSP)
	// response provided by the peer for the leaf certificate, if any.
	OCSPResponse []byte

	// TLSUnique contains the "tls-unique" channel binding value (see RFC 5929,
	// Section 3). This value will be nil for TLS 1.3 connections and for
	// resumed connections that don't support Extended Master Secret (RFC 7627).
	TLSUnique []byte

	// ECHRetryConfigs contains the ECH retry configurations sent by the server in
	// EncryptedExtensions message. It is only populated if the server sent the
	// ech extension in EncryptedExtensions message.
	ECHRetryConfigs []ECHConfig // [uTLS]
	// contains filtered or unexported fields
}

ConnectionState records basic TLS details about the connection.

func (*ConnectionState) ExportKeyingMaterial 

func (cs *ConnectionState) ExportKeyingMaterial(label string, context []byte, length int) ([]byte, error)

ExportKeyingMaterial returns length bytes of exported key material in a new slice as defined in RFC 5705. If context is nil, it is not used as part of the seed. If the connection was set to allow renegotiation via Config.Renegotiation, or if the connections supports neither TLS 1.3 nor Extended Master Secret, this function will return an error.

Exporting key material without Extended Master Secret or TLS 1.3 was disabled in Go 1.22 due to security issues (see the Security Considerations sections of RFC 5705 and RFC 7627), but can be re-enabled with the GODEBUG setting tlsunsafeekm=1.

type CookieExtension 

type CookieExtension struct {
	Cookie []byte
}

CookieExtension implements cookie (44). MUST NOT be part of initial ClientHello

func (*CookieExtension) Len 

func (e *CookieExtension) Len() int

func (*CookieExtension) Read 

func (e *CookieExtension) Read(b []byte) (int, error)

func (*CookieExtension) UnmarshalJSON 

func (e *CookieExtension) UnmarshalJSON(data []byte) error

type CurveID 

type CurveID uint16

CurveID is the type of a TLS identifier for an elliptic curve. See https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8.

In TLS 1.3, this type is called NamedGroup, but at this time this library only supports Elliptic Curve based groups. See RFC 8446, Section 4.2.7. 

const (
	CurveP256 CurveID = 23
	CurveP384 CurveID = 24
	CurveP521 CurveID = 25
	X25519    CurveID = 29
)
const (
	CurveSECP256R1 CurveID = 0x0017
	CurveSECP384R1 CurveID = 0x0018
	CurveSECP521R1 CurveID = 0x0019
	CurveX25519    CurveID = 0x001d

	FakeCurveFFDHE2048 CurveID = 0x0100
	FakeCurveFFDHE3072 CurveID = 0x0101
	FakeCurveFFDHE4096 CurveID = 0x0102
	FakeCurveFFDHE6144 CurveID = 0x0103
	FakeCurveFFDHE8192 CurveID = 0x0104
)

func (CurveID) String 

func (i CurveID) String() string

type DelegatedCredentialsExtension 

type DelegatedCredentialsExtension = FakeDelegatedCredentialsExtension

type Dialer 

type Dialer struct {
	// NetDialer is the optional dialer to use for the TLS connections'
	// underlying TCP connections.
	// A nil NetDialer is equivalent to the net.Dialer zero value.
	NetDialer *net.Dialer

	// Config is the TLS configuration to use for new connections.
	// A nil configuration is equivalent to the zero
	// configuration; see the documentation of Config for the
	// defaults.
	Config *Config
}

Dialer dials TLS connections given a configuration and a Dialer for the underlying connection.

func (*Dialer) Dial 

func (d *Dialer) Dial(network, addr string) (net.Conn, error)

Dial connects to the given network address and initiates a TLS handshake, returning the resulting TLS connection.

The returned Conn, if any, will always be of type *Conn.

Dial uses context.Background internally; to specify the context, use Dialer.DialContext.

func (*Dialer) DialContext 

func (d *Dialer) DialContext(ctx context.Context, network, addr string) (net.Conn, error)

DialContext connects to the given network address and initiates a TLS handshake, returning the resulting TLS connection.

The provided Context must be non-nil. If the context expires before the connection is complete, an error is returned. Once successfully connected, any expiration of the context will not affect the connection.

The returned Conn, if any, will always be of type *Conn.

type DisableActiveMigration 

type DisableActiveMigration struct{}

func (*DisableActiveMigration) ID 

func (*DisableActiveMigration) ID() uint64

func (*DisableActiveMigration) Value 

func (*DisableActiveMigration) Value() []byte

Its Value MUST ALWAYS be empty.

type ECHConfig 

type ECHConfig struct {
	Version  uint16
	Length   uint16
	Contents ECHConfigContents
	// contains filtered or unexported fields
}

func UnmarshalECHConfigs 

func UnmarshalECHConfigs(raw []byte) ([]ECHConfig, error)

UnmarshalECHConfigs parses a sequence of ECH configurations.

Ported from cloudflare/go

type ECHConfigContents 

type ECHConfigContents struct {
	KeyConfig         HPKEKeyConfig
	MaximumNameLength uint8
	PublicName        []byte
	// contains filtered or unexported fields
}

func UnmarshalECHConfigContents 

func UnmarshalECHConfigContents(contents []byte) (ECHConfigContents, error)

func (*ECHConfigContents) ParsePublicKey 

func (echcc *ECHConfigContents) ParsePublicKey() error

type ECHExtension 

type ECHExtension = EncryptedClientHelloExtension // alias

type EncryptedClientHelloExtension 

type EncryptedClientHelloExtension interface {
	// TLSExtension must be implemented by all EncryptedClientHelloExtension implementations.
	TLSExtension

	// Configure configures the EncryptedClientHelloExtension with the given slice of ECHConfig.
	Configure([]ECHConfig) error

	// MarshalClientHello is called by (*UConn).MarshalClientHello() when an ECH extension
	// is present to allow the ECH extension to take control of the generation of the
	// entire ClientHello message.
	MarshalClientHello(*UConn) error
	// contains filtered or unexported methods
}

type ExtendedMasterSecretExtension 

type ExtendedMasterSecretExtension struct {
}

ExtendedMasterSecretExtension implements extended_master_secret (23)

Was named as ExtendedMasterSecretExtension, renamed due to crypto/tls implemented this extension's support.

func (*ExtendedMasterSecretExtension) Len 

func (e *ExtendedMasterSecretExtension) Len() int

func (*ExtendedMasterSecretExtension) Read 

func (e *ExtendedMasterSecretExtension) Read(b []byte) (int, error)

func (*ExtendedMasterSecretExtension) UnmarshalJSON 

func (e *ExtendedMasterSecretExtension) UnmarshalJSON(_ []byte) error

func (*ExtendedMasterSecretExtension) Write 

func (e *ExtendedMasterSecretExtension) Write(_ []byte) (int, error)

type FakeChannelIDExtension 

type FakeChannelIDExtension struct {
	// The extension ID changed from 30031 to 30032. Set to true to use the old extension ID.
	OldExtensionID bool
}

func (*FakeChannelIDExtension) Len 

func (e *FakeChannelIDExtension) Len() int

func (*FakeChannelIDExtension) Read 

func (e *FakeChannelIDExtension) Read(b []byte) (int, error)

func (*FakeChannelIDExtension) UnmarshalJSON 

func (e *FakeChannelIDExtension) UnmarshalJSON(_ []byte) error

func (*FakeChannelIDExtension) Write 

func (e *FakeChannelIDExtension) Write(_ []byte) (int, error)

type FakeDelegatedCredentialsExtension 

type FakeDelegatedCredentialsExtension struct {
	SupportedSignatureAlgorithms []SignatureScheme
}

func (*FakeDelegatedCredentialsExtension) Len 

func (e *FakeDelegatedCredentialsExtension) Len() int

func (*FakeDelegatedCredentialsExtension) Read 

func (e *FakeDelegatedCredentialsExtension) Read(b []byte) (int, error)

func (*FakeDelegatedCredentialsExtension) UnmarshalJSON 

func (e *FakeDelegatedCredentialsExtension) UnmarshalJSON(data []byte) error

Implementation copied from SignatureAlgorithmsExtension.UnmarshalJSON

func (*FakeDelegatedCredentialsExtension) Write 

func (e *FakeDelegatedCredentialsExtension) Write(b []byte) (int, error)

type FakePreSharedKeyExtension 

type FakePreSharedKeyExtension struct {
	UnimplementedPreSharedKeyExtension

	Identities []PskIdentity `json:"identities"`
	Binders    [][]byte      `json:"binders"`
	// Deprecated: Set OmitEmptyPsk in Config instead.
	OmitEmptyPsk bool
}

FakePreSharedKeyExtension is an extension used to set the PSK extension in the ClientHello.

It does not compute binders based on ClientHello, but uses the binders specified instead. We still need to learn more of the safety of hardcoding both Identities and Binders without recalculating the latter.

func (*FakePreSharedKeyExtension) GetPreSharedKeyCommon 

func (e *FakePreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon

func (*FakePreSharedKeyExtension) InitializeByUtls 

func (e *FakePreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)

func (*FakePreSharedKeyExtension) IsInitialized 

func (e *FakePreSharedKeyExtension) IsInitialized() bool

func (*FakePreSharedKeyExtension) Len 

func (e *FakePreSharedKeyExtension) Len() int

func (*FakePreSharedKeyExtension) PatchBuiltHello 

func (*FakePreSharedKeyExtension) PatchBuiltHello(*PubClientHelloMsg) error

func (*FakePreSharedKeyExtension) Read 

func (e *FakePreSharedKeyExtension) Read(b []byte) (int, error)

func (*FakePreSharedKeyExtension) SetOmitEmptyPsk 

func (e *FakePreSharedKeyExtension) SetOmitEmptyPsk(val bool)

func (*FakePreSharedKeyExtension) UnmarshalJSON 

func (e *FakePreSharedKeyExtension) UnmarshalJSON(data []byte) error

func (*FakePreSharedKeyExtension) Write 

func (e *FakePreSharedKeyExtension) Write(b []byte) (n int, err error)

type FakeQUICTransportParameter 

type FakeQUICTransportParameter struct {
	Id  uint64
	Val []byte
}

func (*FakeQUICTransportParameter) ID 

func (f *FakeQUICTransportParameter) ID() uint64

func (*FakeQUICTransportParameter) Value 

func (f *FakeQUICTransportParameter) Value() []byte

type FakeRecordSizeLimitExtension 

type FakeRecordSizeLimitExtension struct {
	Limit uint16
}

FakeRecordSizeLimitExtension implements record_size_limit (28) but with no support.

func (*FakeRecordSizeLimitExtension) Len 

func (e *FakeRecordSizeLimitExtension) Len() int

func (*FakeRecordSizeLimitExtension) Read 

func (e *FakeRecordSizeLimitExtension) Read(b []byte) (int, error)

func (*FakeRecordSizeLimitExtension) UnmarshalJSON 

func (e *FakeRecordSizeLimitExtension) UnmarshalJSON(data []byte) error

func (*FakeRecordSizeLimitExtension) Write 

func (e *FakeRecordSizeLimitExtension) Write(b []byte) (int, error)

type FakeTokenBindingExtension 

type FakeTokenBindingExtension struct {
	MajorVersion, MinorVersion uint8
	KeyParameters              []uint8
}

https://tools.ietf.org/html/rfc8472#section-2

func (*FakeTokenBindingExtension) Len 

func (e *FakeTokenBindingExtension) Len() int

func (*FakeTokenBindingExtension) Read 

func (e *FakeTokenBindingExtension) Read(b []byte) (int, error)

func (*FakeTokenBindingExtension) UnmarshalJSON 

func (e *FakeTokenBindingExtension) UnmarshalJSON(data []byte) error

func (*FakeTokenBindingExtension) Write 

func (e *FakeTokenBindingExtension) Write(b []byte) (int, error)

type Fingerprinter 

type Fingerprinter struct {
	// AllowBluntMimicry will ensure that unknown extensions are
	// passed along into the resulting ClientHelloSpec as-is
	// WARNING: there could be numerous subtle issues with ClientHelloSpecs
	// that are generated with this flag which could compromise security and/or mimicry
	AllowBluntMimicry bool
	// AlwaysAddPadding will always add a UtlsPaddingExtension with BoringPaddingStyle
	// at the end of the extensions list if it isn't found in the fingerprinted hello.
	// This could be useful in scenarios where the hello you are fingerprinting does not
	// have any padding, but you suspect that other changes you make to the final hello
	// (including things like different SNI lengths) would cause padding to be necessary
	AlwaysAddPadding bool

	RealPSKResumption bool // if set, PSK extension (if any) will be real PSK extension, otherwise it will be fake PSK extension
}

Fingerprinter is a struct largely for holding options for the FingerprintClientHello func

func (*Fingerprinter) FingerprintClientHello 

func (f *Fingerprinter) FingerprintClientHello(data []byte) (clientHelloSpec *ClientHelloSpec, err error)

FingerprintClientHello returns a ClientHelloSpec which is based on the ClientHello that is passed in as the data argument

If the ClientHello passed in has extensions that are not recognized or cannot be handled it will return a non-nil error and a nil *ClientHelloSpec value

The data should be the full tls record, including the record type/version/length header as well as the handshake type/length/version header https://tools.ietf.org/html/rfc5246#section-6.2 https://tools.ietf.org/html/rfc5246#section-7.4

It calls UnmarshalClientHello internally, and is kept for backwards compatibility

func (*Fingerprinter) RawClientHello 

func (f *Fingerprinter) RawClientHello(raw []byte) (clientHelloSpec *ClientHelloSpec, err error)

RawClientHello returns a ClientHelloSpec which is based on the ClientHello raw bytes that is passed in as the raw argument.

It was renamed from FingerprintClientHello in v1.3.1 and earlier versions as a more precise name for the function

func (*Fingerprinter) UnmarshalJSONClientHello 

func (f *Fingerprinter) UnmarshalJSONClientHello(json []byte) (clientHelloSpec *ClientHelloSpec, err error)

UnmarshalJSONClientHello returns a ClientHelloSpec which is based on the ClientHello JSON bytes that is passed in as the json argument.

type FinishedHash 

type FinishedHash struct {
	Client hash.Hash
	Server hash.Hash

	// Prior to TLS 1.2, an additional MD5 hash is required.
	ClientMD5 hash.Hash
	ServerMD5 hash.Hash

	// In TLS 1.2, a full buffer is sadly required.
	Buffer []byte

	Version uint16
	Prf     func(result, secret, label, seed []byte)
}

A FinishedHash calculates the hash of a set of handshake messages suitable for including in a Finished message.

type GREASEECHExtension 

type GREASEECHExtension = GREASEEncryptedClientHelloExtension // alias

type GREASEEncryptedClientHelloExtension 

type GREASEEncryptedClientHelloExtension struct {
	CandidateCipherSuites []HPKESymmetricCipherSuite

	CandidateConfigIds []uint8

	EncapsulatedKey      []byte   // if empty, will generate random bytes
	CandidatePayloadLens []uint16 // Pre-encryption. If 0, will pick 128(+16=144)

	UnimplementedECHExtension
	// contains filtered or unexported fields
}

func BoringGREASEECH 

func BoringGREASEECH() *GREASEEncryptedClientHelloExtension

BoringGREASEECH returns a GREASE scheme BoringSSL uses by default.

func (*GREASEEncryptedClientHelloExtension) Configure 

func (*GREASEEncryptedClientHelloExtension) Configure([]ECHConfig) error

Configure implements EncryptedClientHelloExtension.

func (*GREASEEncryptedClientHelloExtension) Len 

func (g *GREASEEncryptedClientHelloExtension) Len() int

Len implements TLSExtension.

func (*GREASEEncryptedClientHelloExtension) MarshalClientHello 

func (*GREASEEncryptedClientHelloExtension) MarshalClientHello(*UConn) error

MarshalClientHello implements EncryptedClientHelloExtension.

func (*GREASEEncryptedClientHelloExtension) Read 

func (g *GREASEEncryptedClientHelloExtension) Read(b []byte) (int, error)

Read implements TLSExtension.

func (*GREASEEncryptedClientHelloExtension) Write 

func (g *GREASEEncryptedClientHelloExtension) Write(b []byte) (int, error)

Write implements TLSExtensionWriter.

type GREASEQUICBit 

type GREASEQUICBit struct{}

func (*GREASEQUICBit) ID 

func (*GREASEQUICBit) ID() uint64

func (*GREASEQUICBit) Value 

func (*GREASEQUICBit) Value() []byte

Its Value MUST ALWAYS be empty.

type GREASETransportParameter 

type GREASETransportParameter struct {
	IdOverride    uint64 // if set to a valid GREASE ID, use this instead of randomly generated one.
	Length        uint16 // if len(ValueOverride) == 0, will generate random data of this size.
	ValueOverride []byte // if len(ValueOverride) > 0, use this instead of random bytes.
}

func (GREASETransportParameter) GetGREASEID 

func (GREASETransportParameter) GetGREASEID() uint64

GetGREASEID returns a random valid GREASE ID for transport parameters.

func (*GREASETransportParameter) ID 

func (g *GREASETransportParameter) ID() uint64

func (GREASETransportParameter) IsGREASEID 

func (GREASETransportParameter) IsGREASEID(id uint64) bool

IsGREASEID returns true if id is a valid GREASE ID for transport parameters.

func (*GREASETransportParameter) Value 

func (g *GREASETransportParameter) Value() []byte

type GenericExtension 

type GenericExtension struct {
	Id   uint16
	Data []byte
}

GenericExtension allows to include in ClientHello arbitrary unsupported extensions. It is not defined in TLS RFCs nor by IANA. If a server echoes this extension back, the handshake will likely fail due to no further support.

func (*GenericExtension) Len 

func (e *GenericExtension) Len() int

func (*GenericExtension) Read 

func (e *GenericExtension) Read(b []byte) (int, error)

func (*GenericExtension) UnmarshalJSON 

func (e *GenericExtension) UnmarshalJSON(b []byte) error

type HPKEKeyConfig 

type HPKEKeyConfig struct {
	ConfigId  uint8
	KemId     HPKE_KEM_ID
	PublicKey kem.PublicKey

	CipherSuites []HPKESymmetricCipherSuite
	// contains filtered or unexported fields
}

type HPKERawPublicKey 

type HPKERawPublicKey = []byte

type HPKESymmetricCipherSuite 

type HPKESymmetricCipherSuite struct {
	KdfId  HPKE_KDF_ID
	AeadId HPKE_AEAD_ID
}

type HPKE_AEAD_ID 

type HPKE_AEAD_ID = uint16 // RFC 9180

type HPKE_KDF_ID 

type HPKE_KDF_ID = uint16 // RFC 9180

type HPKE_KEM_ID 

type HPKE_KEM_ID = uint16 // RFC 9180

type ISessionTicketExtension 

type ISessionTicketExtension interface {
	TLSExtension

	// If false is returned, utls will invoke `InitializeByUtls()` for the necessary initialization.
	Initializable

	// InitializeByUtls is invoked when IsInitialized() returns false.
	// It initializes the extension using a real and valid TLS 1.2 session.
	InitializeByUtls(session *SessionState, ticket []byte)

	GetSession() *SessionState

	GetTicket() []byte
}

type InitialMaxData 

type InitialMaxData uint64

func (InitialMaxData) ID 

func (InitialMaxData) ID() uint64

func (InitialMaxData) Value 

func (i InitialMaxData) Value() []byte

type InitialMaxStreamDataBidiLocal 

type InitialMaxStreamDataBidiLocal uint64

func (InitialMaxStreamDataBidiLocal) ID 

func (InitialMaxStreamDataBidiLocal) ID() uint64

func (InitialMaxStreamDataBidiLocal) Value 

func (i InitialMaxStreamDataBidiLocal) Value() []byte

type InitialMaxStreamDataBidiRemote 

type InitialMaxStreamDataBidiRemote uint64

func (InitialMaxStreamDataBidiRemote) ID 

func (InitialMaxStreamDataBidiRemote) ID() uint64

func (InitialMaxStreamDataBidiRemote) Value 

func (i InitialMaxStreamDataBidiRemote) Value() []byte

type InitialMaxStreamDataUni 

type InitialMaxStreamDataUni uint64

func (InitialMaxStreamDataUni) ID 

func (InitialMaxStreamDataUni) ID() uint64

func (InitialMaxStreamDataUni) Value 

func (i InitialMaxStreamDataUni) Value() []byte

type InitialMaxStreamsBidi 

type InitialMaxStreamsBidi uint64

func (InitialMaxStreamsBidi) ID 

func (InitialMaxStreamsBidi) ID() uint64

func (InitialMaxStreamsBidi) Value 

func (i InitialMaxStreamsBidi) Value() []byte

type InitialMaxStreamsUni 

type InitialMaxStreamsUni uint64

func (InitialMaxStreamsUni) ID 

func (InitialMaxStreamsUni) ID() uint64

func (InitialMaxStreamsUni) Value 

func (i InitialMaxStreamsUni) Value() []byte

type InitialSourceConnectionID 

type InitialSourceConnectionID []byte // if empty, will be set to the Connection ID used for the Initial packet.

func (InitialSourceConnectionID) ID 

func (InitialSourceConnectionID) ID() uint64

func (InitialSourceConnectionID) Value 

func (i InitialSourceConnectionID) Value() []byte

type Initializable 

type Initializable interface {
	// IsInitialized returns a boolean indicating whether the extension has been initialized.
	// If false is returned, utls will initialize the extension.
	IsInitialized() bool
}

type KemPrivateKey 

type KemPrivateKey struct {
	SecretKey kem.PrivateKey
	CurveID   CurveID
}

func (*KemPrivateKey) ToPrivate 

func (kpk *KemPrivateKey) ToPrivate() *kemPrivateKey

type KeyShare 

type KeyShare struct {
	Group CurveID `json:"group"`
	Data  []byte  `json:"key_exchange,omitempty"` // optional
}

TLS 1.3 Key Share. See RFC 8446, Section 4.2.8.

type KeyShareExtension 

type KeyShareExtension struct {
	KeyShares []KeyShare
}

KeyShareExtension implements key_share (51) and is for TLS 1.3 only.

func (*KeyShareExtension) Len 

func (e *KeyShareExtension) Len() int

func (*KeyShareExtension) Read 

func (e *KeyShareExtension) Read(b []byte) (int, error)

func (*KeyShareExtension) UnmarshalJSON 

func (e *KeyShareExtension) UnmarshalJSON(b []byte) error

func (*KeyShareExtension) Write 

func (e *KeyShareExtension) Write(b []byte) (int, error)

type KeyShares 

type KeyShares []KeyShare

func (KeyShares) ToPrivate 

func (KSS KeyShares) ToPrivate() []keyShare

type KeySharesParameters 

type KeySharesParameters struct {
	// contains filtered or unexported fields
}

[uTLS SECTION START] KeySharesParameters serves as a in-memory storage for generated keypairs by UTLS when generating ClientHello. It is used to store both ecdhe and kem keypairs.

func NewKeySharesParameters 

func NewKeySharesParameters() *KeySharesParameters

func (*KeySharesParameters) AddEcdheKeypair 

func (ksp *KeySharesParameters) AddEcdheKeypair(curveID CurveID, ecdheKey *ecdh.PrivateKey, ecdhePubKey *ecdh.PublicKey)

func (*KeySharesParameters) AddKemKeypair 

func (ksp *KeySharesParameters) AddKemKeypair(curveID CurveID, kemKey kem.PrivateKey, kemPubKey kem.PublicKey)

func (*KeySharesParameters) GetEcdheKey 

func (ksp *KeySharesParameters) GetEcdheKey(curveID CurveID) (ecdheKey *ecdh.PrivateKey, ok bool)

func (*KeySharesParameters) GetEcdhePubkey 

func (ksp *KeySharesParameters) GetEcdhePubkey(curveID CurveID) (params *ecdh.PublicKey, ok bool)

func (*KeySharesParameters) GetKemKey 

func (ksp *KeySharesParameters) GetKemKey(curveID CurveID) (kemKey kem.PrivateKey, ok bool)

func (*KeySharesParameters) GetKemPubkey 

func (ksp *KeySharesParameters) GetKemPubkey(curveID CurveID) (params kem.PublicKey, ok bool)

type LoadSessionTrackerState 

type LoadSessionTrackerState int

Tracking the state of calling conn.loadSession 

const CalledByGoTLS LoadSessionTrackerState = 3
const CalledByULoadSession LoadSessionTrackerState = 2
const NeverCalled LoadSessionTrackerState = 0
const UtlsAboutToCall LoadSessionTrackerState = 1

type MaxAckDelay 

type MaxAckDelay uint64

func (MaxAckDelay) ID 

func (MaxAckDelay) ID() uint64

func (MaxAckDelay) Value 

func (m MaxAckDelay) Value() []byte

type MaxDatagramFrameSize 

type MaxDatagramFrameSize uint64

func (MaxDatagramFrameSize) ID 

func (MaxDatagramFrameSize) ID() uint64

func (MaxDatagramFrameSize) Value 

func (m MaxDatagramFrameSize) Value() []byte

type MaxIdleTimeout 

type MaxIdleTimeout uint64 // in milliseconds

func (MaxIdleTimeout) ID 

func (MaxIdleTimeout) ID() uint64

func (MaxIdleTimeout) Value 

func (m MaxIdleTimeout) Value() []byte

type MaxUDPPayloadSize 

type MaxUDPPayloadSize uint64

func (MaxUDPPayloadSize) ID 

func (MaxUDPPayloadSize) ID() uint64

func (MaxUDPPayloadSize) Value 

func (m MaxUDPPayloadSize) Value() []byte

type NPNExtension 

type NPNExtension struct {
	NextProtos []string
}

NPNExtension implements next_protocol_negotiation (Not IANA assigned)

func (*NPNExtension) Len 

func (e *NPNExtension) Len() int

func (*NPNExtension) Read 

func (e *NPNExtension) Read(b []byte) (int, error)

func (*NPNExtension) UnmarshalJSON 

func (e *NPNExtension) UnmarshalJSON(_ []byte) error

draft-agl-tls-nextprotoneg-04: The "extension_data" field of a "next_protocol_negotiation" extension in a "ClientHello" MUST be empty.

func (*NPNExtension) Write 

func (e *NPNExtension) Write(_ []byte) (int, error)

Write is a no-op for NPNExtension. NextProtos are not included in the ClientHello.

type PRNGSeed 

type PRNGSeed [PRNGSeedLength]byte

PRNGSeed is a PRNG seed.

func NewPRNGSeed 

func NewPRNGSeed() (*PRNGSeed, error)

NewPRNGSeed creates a new PRNG seed using crypto/rand.Read.

type PSKKeyExchangeModesExtension 

type PSKKeyExchangeModesExtension struct {
	Modes []uint8
}

PSKKeyExchangeModesExtension implements psk_key_exchange_modes (45).

func (*PSKKeyExchangeModesExtension) Len 

func (e *PSKKeyExchangeModesExtension) Len() int

func (*PSKKeyExchangeModesExtension) Read 

func (e *PSKKeyExchangeModesExtension) Read(b []byte) (int, error)

func (*PSKKeyExchangeModesExtension) UnmarshalJSON 

func (e *PSKKeyExchangeModesExtension) UnmarshalJSON(b []byte) error

func (*PSKKeyExchangeModesExtension) Write 

func (e *PSKKeyExchangeModesExtension) Write(b []byte) (int, error)

type PaddingTransportParameter 

type PaddingTransportParameter []byte

func (PaddingTransportParameter) ID 

func (PaddingTransportParameter) ID() uint64

func (PaddingTransportParameter) Value 

func (p PaddingTransportParameter) Value() []byte

type PreSharedKeyCommon 

type PreSharedKeyCommon struct {
	Identities  []PskIdentity
	Binders     [][]byte
	BinderKey   []byte // this will be used to compute the binder when hello message is ready
	EarlySecret []byte
	Session     *SessionState
}

type PreSharedKeyExtension 

type PreSharedKeyExtension interface {
	// TLSExtension must be implemented by all PreSharedKeyExtension implementations.
	TLSExtension

	// If false is returned, utls will invoke `InitializeByUtls()` for the necessary initialization.
	Initializable

	SetOmitEmptyPsk(val bool)

	// InitializeByUtls is invoked when IsInitialized() returns false.
	// It initializes the extension using a real and valid TLS 1.3 session.
	InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)

	// GetPreSharedKeyCommon retrieves the final PreSharedKey-related states as defined in PreSharedKeyCommon.
	GetPreSharedKeyCommon() PreSharedKeyCommon

	// PatchBuiltHello is called once the hello message is fully applied and marshaled.
	// Its purpose is to update the binders of PSK (Pre-Shared Key) identities.
	PatchBuiltHello(hello *PubClientHelloMsg) error
	// contains filtered or unexported methods
}

The lifecycle of a PreSharedKeyExtension:

Creation Phase:

  • The extension is created.

Write Phase:

  • [writeToUConn() called]:

    > - During this phase, it is important to note that implementations should not write any session data to the UConn (Underlying Connection) as the session is not yet loaded. The session context is not active at this point.

Initialization Phase:

  • [IsInitialized() called]:

    If IsInitialized() returns true

    > - GetPreSharedKeyCommon() will be called subsequently and the PSK states in handshake/clientHello will be fully initialized.

    If IsInitialized() returns false:

    > - [conn.loadSession() called]:

    >> - Once the session is available:

    >>> - [InitializeByUtls() called]:

    >>>> - The InitializeByUtls() method is invoked to initialize the extension based on the loaded session data.

    >>>> - This step prepares the extension for further processing.

Marshal Phase:

  • [Len() called], [Read() called]:

    > - Implementations should marshal the extension into bytes, using placeholder binders to maintain the correct length.

Binders Preparation Phase:

  • [PatchBuiltHello(hello) called]:

    > - The client hello is already marshaled in the "hello.Raw" format.

    > - Implementations are expected to update the binders within the marshaled client hello.

  • [GetPreSharedKeyCommon() called]:

    > - Implementations should gather and provide the final pre-shared key (PSK) related data.

    > - This data will be incorporated into both the clientHello and HandshakeState, ensuring that the PSK-related information is properly set and ready for the handshake process.

type PskIdentities 

type PskIdentities []PskIdentity

func (PskIdentities) ToPrivate 

func (PSS PskIdentities) ToPrivate() []pskIdentity

type PskIdentity 

type PskIdentity struct {
	Label               []byte `json:"identity"`
	ObfuscatedTicketAge uint32 `json:"obfuscated_ticket_age"`
}

TLS 1.3 PSK Identity. Can be a Session Ticket, or a reference to a saved session. See RFC 8446, Section 4.2.11.

type PubCipherSuite 

type PubCipherSuite struct {
	Id uint16
	// the lengths, in bytes, of the key material needed for each component.
	KeyLen int
	MacLen int
	IvLen  int
	Ka     func(version uint16) keyAgreement
	// flags is a bitmask of the suite* values, above.
	Flags  int
	Cipher func(key, iv []byte, isRead bool) interface{}
	Mac    func(macKey []byte) hash.Hash
	Aead   func(key, fixedNonce []byte) aead
}

A CipherSuite is a specific combination of key agreement, cipher and MAC function. All cipher suites currently assume RSA key agreement.

type PubCipherSuiteTLS13 

type PubCipherSuiteTLS13 struct {
	Id     uint16
	KeyLen int
	Aead   func(key, fixedNonce []byte) aead
	Hash   crypto.Hash
}

type PubClientHandshakeState 

type PubClientHandshakeState struct {
	C            *Conn
	ServerHello  *PubServerHelloMsg
	Hello        *PubClientHelloMsg
	MasterSecret []byte
	Session      *SessionState

	State12 TLS12OnlyState
	State13 TLS13OnlyState
	// contains filtered or unexported fields
}

ClientHandshakeState includes both TLS 1.3-only and TLS 1.2-only states, only one of them will be used, depending on negotiated version.

ClientHandshakeState will be converted into and from either

  • clientHandshakeState (TLS 1.2)
  • clientHandshakeStateTLS13 (TLS 1.3)

uTLS will call .handshake() on one of these private internal states, to perform TLS handshake using standard crypto/tls implementation.

type PubClientHelloMsg 

type PubClientHelloMsg struct {
	Raw                          []byte
	Vers                         uint16
	Random                       []byte
	SessionId                    []byte
	CipherSuites                 []uint16
	CompressionMethods           []uint8
	NextProtoNeg                 bool
	ServerName                   string
	OcspStapling                 bool
	Scts                         bool
	Ems                          bool // [uTLS] actually implemented due to its prevalence
	SupportedCurves              []CurveID
	SupportedPoints              []uint8
	TicketSupported              bool
	SessionTicket                []uint8
	SupportedSignatureAlgorithms []SignatureScheme
	SecureRenegotiation          []byte
	SecureRenegotiationSupported bool
	AlpnProtocols                []string

	// 1.3
	SupportedSignatureAlgorithmsCert []SignatureScheme
	SupportedVersions                []uint16
	Cookie                           []byte
	KeyShares                        []KeyShare
	EarlyData                        bool
	PskModes                         []uint8
	PskIdentities                    []PskIdentity
	PskBinders                       [][]byte
	QuicTransportParameters          []byte
	// contains filtered or unexported fields
}

func UnmarshalClientHello 

func UnmarshalClientHello(data []byte) *PubClientHelloMsg

UnmarshalClientHello allows external code to parse raw client hellos. It returns nil on failure.

func (*PubClientHelloMsg) Marshal 

func (chm *PubClientHelloMsg) Marshal() ([]byte, error)

Marshal allows external code to convert a ClientHello object back into raw bytes.

type PubServerHelloMsg 

type PubServerHelloMsg struct {
	Raw                          []byte
	Vers                         uint16
	Random                       []byte
	SessionId                    []byte
	CipherSuite                  uint16
	CompressionMethod            uint8
	NextProtoNeg                 bool
	NextProtos                   []string
	OcspStapling                 bool
	Scts                         [][]byte
	ExtendedMasterSecret         bool
	TicketSupported              bool // used by go tls to determine whether to add the session ticket ext
	SecureRenegotiation          []byte
	SecureRenegotiationSupported bool
	AlpnProtocol                 string

	// 1.3
	SupportedVersion        uint16
	ServerShare             keyShare
	SelectedIdentityPresent bool
	SelectedIdentity        uint16
	Cookie                  []byte  // HelloRetryRequest extension
	SelectedGroup           CurveID // HelloRetryRequest extension

}

type QUICConfig 

type QUICConfig struct {
	TLSConfig *Config
}

A QUICConfig configures a QUICConn.

type QUICConn 

type QUICConn struct {
	// contains filtered or unexported fields
}

A QUICConn represents a connection which uses a QUIC implementation as the underlying transport as described in RFC 9001.

Methods of QUICConn are not safe for concurrent use.

func QUICClient 

func QUICClient(config *QUICConfig) *QUICConn

QUICClient returns a new TLS client side connection using QUICTransport as the underlying transport. The config cannot be nil.

The config's MinVersion must be at least TLS 1.3.

func QUICServer 

func QUICServer(config *QUICConfig) *QUICConn

QUICServer returns a new TLS server side connection using QUICTransport as the underlying transport. The config cannot be nil.

The config's MinVersion must be at least TLS 1.3.

func (*QUICConn) Close 

func (q *QUICConn) Close() error

Close closes the connection and stops any in-progress handshake.

func (*QUICConn) ConnectionState 

func (q *QUICConn) ConnectionState() ConnectionState

ConnectionState returns basic TLS details about the connection.

func (*QUICConn) HandleData 

func (q *QUICConn) HandleData(level QUICEncryptionLevel, data []byte) error

HandleData handles handshake bytes received from the peer. It may produce connection events, which may be read with QUICConn.NextEvent.

func (*QUICConn) NextEvent 

func (q *QUICConn) NextEvent() QUICEvent

NextEvent returns the next event occurring on the connection. It returns an event with a Kind of QUICNoEvent when no events are available.

func (*QUICConn) SendSessionTicket 

func (q *QUICConn) SendSessionTicket(opts QUICSessionTicketOptions) error

SendSessionTicket sends a session ticket to the client. It produces connection events, which may be read with QUICConn.NextEvent. Currently, it can only be called once.

func (*QUICConn) SetTransportParameters 

func (q *QUICConn) SetTransportParameters(params []byte)

SetTransportParameters sets the transport parameters to send to the peer.

Server connections may delay setting the transport parameters until after receiving the client's transport parameters. See QUICTransportParametersRequired.

func (*QUICConn) Start 

func (q *QUICConn) Start(ctx context.Context) error

Start starts the client or server handshake protocol. It may produce connection events, which may be read with QUICConn.NextEvent.

Start must be called at most once.

type QUICEncryptionLevel 

type QUICEncryptionLevel int

QUICEncryptionLevel represents a QUIC encryption level used to transmit handshake messages.

func (QUICEncryptionLevel) String 

func (l QUICEncryptionLevel) String() string

type QUICEvent 

type QUICEvent struct {
	Kind QUICEventKind

	// Set for QUICSetReadSecret, QUICSetWriteSecret, and QUICWriteData.
	Level QUICEncryptionLevel

	// Set for QUICTransportParameters, QUICSetReadSecret, QUICSetWriteSecret, and QUICWriteData.
	// The contents are owned by crypto/tls, and are valid until the next NextEvent call.
	Data []byte

	// Set for QUICSetReadSecret and QUICSetWriteSecret.
	Suite uint16
}

A QUICEvent is an event occurring on a QUIC connection.

The type of event is specified by the Kind field. The contents of the other fields are kind-specific.

type QUICEventKind 

type QUICEventKind int

A QUICEventKind is a type of operation on a QUIC connection. 

const (
	// QUICNoEvent indicates that there are no events available.
	QUICNoEvent QUICEventKind = iota

	// QUICSetReadSecret and QUICSetWriteSecret provide the read and write
	// secrets for a given encryption level.
	// QUICEvent.Level, QUICEvent.Data, and QUICEvent.Suite are set.
	//
	// Secrets for the Initial encryption level are derived from the initial
	// destination connection ID, and are not provided by the QUICConn.
	QUICSetReadSecret
	QUICSetWriteSecret

	// QUICWriteData provides data to send to the peer in CRYPTO frames.
	// QUICEvent.Data is set.
	QUICWriteData

	// QUICTransportParameters provides the peer's QUIC transport parameters.
	// QUICEvent.Data is set.
	QUICTransportParameters

	// QUICTransportParametersRequired indicates that the caller must provide
	// QUIC transport parameters to send to the peer. The caller should set
	// the transport parameters with QUICConn.SetTransportParameters and call
	// QUICConn.NextEvent again.
	//
	// If transport parameters are set before calling QUICConn.Start, the
	// connection will never generate a QUICTransportParametersRequired event.
	QUICTransportParametersRequired

	// QUICRejectedEarlyData indicates that the server rejected 0-RTT data even
	// if we offered it. It's returned before QUICEncryptionLevelApplication
	// keys are returned.
	QUICRejectedEarlyData

	// QUICHandshakeDone indicates that the TLS handshake has completed.
	QUICHandshakeDone
)

type QUICSessionTicketOptions 

type QUICSessionTicketOptions struct {
	// EarlyData specifies whether the ticket may be used for 0-RTT.
	EarlyData bool
}

type QUICTransportParametersExtension 

type QUICTransportParametersExtension struct {
	TransportParameters TransportParameters
	// contains filtered or unexported fields
}

QUICTransportParametersExtension implements quic_transport_parameters (57).

Currently, it works as a fake extension and does not support parsing, since the QUICConn provided by this package does not really understand these parameters.

func (*QUICTransportParametersExtension) Len 

func (e *QUICTransportParametersExtension) Len() int

func (*QUICTransportParametersExtension) Read 

func (e *QUICTransportParametersExtension) Read(b []byte) (int, error)

type RecordHeaderError 

type RecordHeaderError struct {
	// Msg contains a human readable string that describes the error.
	Msg string
	// RecordHeader contains the five bytes of TLS record header that
	// triggered the error.
	RecordHeader [5]byte
	// Conn provides the underlying net.Conn in the case that a client
	// sent an initial handshake that didn't look like TLS.
	// It is nil if there's already been a handshake or a TLS alert has
	// been written to the connection.
	Conn net.Conn
}

RecordHeaderError is returned when a TLS record header is invalid.

func (RecordHeaderError) Error 

func (e RecordHeaderError) Error() string

type RenegotiationInfoExtension 

type RenegotiationInfoExtension struct {
	// Renegotiation field limits how many times client will perform renegotiation: no limit, once, or never.
	// The extension still will be sent, even if Renegotiation is set to RenegotiateNever.
	Renegotiation RenegotiationSupport // [UTLS] added for internal use only

	// RenegotiatedConnection is not yet properly handled, now we
	// are just copying it to the client hello.
	//
	// If this is the initial handshake for a connection, then the
	// "renegotiated_connection" field is of zero length in both the
	// ClientHello and the ServerHello.
	RenegotiatedConnection []byte
}

RenegotiationInfoExtension implements renegotiation_info (65281)

func (*RenegotiationInfoExtension) Len 

func (e *RenegotiationInfoExtension) Len() int

func (*RenegotiationInfoExtension) Read 

func (e *RenegotiationInfoExtension) Read(b []byte) (int, error)

func (*RenegotiationInfoExtension) UnmarshalJSON 

func (e *RenegotiationInfoExtension) UnmarshalJSON(_ []byte) error

func (*RenegotiationInfoExtension) Write 

func (e *RenegotiationInfoExtension) Write(b []byte) (int, error)

type RenegotiationSupport 

type RenegotiationSupport int

RenegotiationSupport enumerates the different levels of support for TLS renegotiation. TLS renegotiation is the act of performing subsequent handshakes on a connection after the first. This significantly complicates the state machine and has been the source of numerous, subtle security issues. Initiating a renegotiation is not supported, but support for accepting renegotiation requests may be enabled.

Even when enabled, the server may not change its identity between handshakes (i.e. the leaf certificate must be the same). Additionally, concurrent handshake and application data flow is not permitted so renegotiation can only be used with protocols that synchronise with the renegotiation, such as HTTPS.

Renegotiation is not defined in TLS 1.3. 

const (
	// RenegotiateNever disables renegotiation.
	RenegotiateNever RenegotiationSupport = iota

	// RenegotiateOnceAsClient allows a remote server to request
	// renegotiation once per connection.
	RenegotiateOnceAsClient

	// RenegotiateFreelyAsClient allows a remote server to repeatedly
	// request renegotiation.
	RenegotiateFreelyAsClient
)

type Roller 

type Roller struct {
	HelloIDs            []ClientHelloID
	HelloIDMu           sync.Mutex
	WorkingHelloID      *ClientHelloID
	TcpDialTimeout      time.Duration
	TlsHandshakeTimeout time.Duration
	// contains filtered or unexported fields
}

func NewRoller 

func NewRoller() (*Roller, error)

NewRoller creates Roller object with default range of HelloIDs to cycle through until a working/unblocked one is found.

func (*Roller) Dial 

func (c *Roller) Dial(network, addr, serverName string) (*UConn, error)

Dial attempts to establish connection to given address using different HelloIDs. If a working HelloID is found, it is used again for subsequent Dials. If tcp connection fails or all HelloIDs are tried, returns with last error.

Usage examples: 

Dial("tcp4", "google.com:443", "google.com")
Dial("tcp", "10.23.144.22:443", "mywebserver.org")

type SCTExtension 

type SCTExtension struct {
}

SCTExtension implements signed_certificate_timestamp (18)

func (*SCTExtension) Len 

func (e *SCTExtension) Len() int

func (*SCTExtension) Read 

func (e *SCTExtension) Read(b []byte) (int, error)

func (*SCTExtension) UnmarshalJSON 

func (e *SCTExtension) UnmarshalJSON(_ []byte) error

func (*SCTExtension) Write 

func (e *SCTExtension) Write(_ []byte) (int, error)

type SNIExtension 

type SNIExtension struct {
	ServerName string // not an array because go crypto/tls doesn't support multiple SNIs
}

SNIExtension implements server_name (0)

func (*SNIExtension) Len 

func (e *SNIExtension) Len() int

func (*SNIExtension) Read 

func (e *SNIExtension) Read(b []byte) (int, error)

func (*SNIExtension) UnmarshalJSON 

func (e *SNIExtension) UnmarshalJSON(_ []byte) error

func (*SNIExtension) Write 

func (e *SNIExtension) Write(b []byte) (int, error)

Write is a no-op for StatusRequestExtension. SNI should not be fingerprinted and is user controlled.

type SessionState 

type SessionState struct {

	// Extra is ignored by crypto/tls, but is encoded by [SessionState.Bytes]
	// and parsed by [ParseSessionState].
	//
	// This allows [Config.UnwrapSession]/[Config.WrapSession] and
	// [ClientSessionCache] implementations to store and retrieve additional
	// data alongside this session.
	//
	// To allow different layers in a protocol stack to share this field,
	// applications must only append to it, not replace it, and must use entries
	// that can be recognized even if out of order (for example, by starting
	// with an id and version prefix).
	Extra [][]byte

	// EarlyData indicates whether the ticket can be used for 0-RTT in a QUIC
	// connection. The application may set this to false if it is true to
	// decline to offer 0-RTT even if supported.
	EarlyData bool
	// contains filtered or unexported fields
}

A SessionState is a resumable session.

func ParseSessionState 

func ParseSessionState(data []byte) (*SessionState, error)

ParseSessionState parses a SessionState encoded by SessionState.Bytes.

func (*SessionState) Bytes 

func (s *SessionState) Bytes() ([]byte, error)

Bytes encodes the session, including any private fields, so that it can be parsed by ParseSessionState. The encoding contains secret values critical to the security of future and possibly past sessions.

The specific encoding should be considered opaque and may change incompatibly between Go versions.

type SessionTicketExtension 

type SessionTicketExtension struct {
	Session     *SessionState
	Ticket      []byte
	Initialized bool
}

SessionTicketExtension implements session_ticket (35)

func (*SessionTicketExtension) GetSession 

func (e *SessionTicketExtension) GetSession() *SessionState

func (*SessionTicketExtension) GetTicket 

func (e *SessionTicketExtension) GetTicket() []byte

func (*SessionTicketExtension) InitializeByUtls 

func (e *SessionTicketExtension) InitializeByUtls(session *SessionState, ticket []byte)

func (*SessionTicketExtension) IsInitialized 

func (e *SessionTicketExtension) IsInitialized() bool

func (*SessionTicketExtension) Len 

func (e *SessionTicketExtension) Len() int

func (*SessionTicketExtension) Read 

func (e *SessionTicketExtension) Read(b []byte) (int, error)

func (*SessionTicketExtension) UnmarshalJSON 

func (e *SessionTicketExtension) UnmarshalJSON(_ []byte) error

func (*SessionTicketExtension) Write 

func (e *SessionTicketExtension) Write(_ []byte) (int, error)

type SignatureAlgorithmsCertExtension 

type SignatureAlgorithmsCertExtension struct {
	SupportedSignatureAlgorithms []SignatureScheme
}

SignatureAlgorithmsCertExtension implements signature_algorithms_cert (50)

func (*SignatureAlgorithmsCertExtension) Len 

func (e *SignatureAlgorithmsCertExtension) Len() int

func (*SignatureAlgorithmsCertExtension) Read 

func (e *SignatureAlgorithmsCertExtension) Read(b []byte) (int, error)

func (*SignatureAlgorithmsCertExtension) UnmarshalJSON 

func (e *SignatureAlgorithmsCertExtension) UnmarshalJSON(data []byte) error

Copied from SignatureAlgorithmsExtension.UnmarshalJSON

func (*SignatureAlgorithmsCertExtension) Write 

func (e *SignatureAlgorithmsCertExtension) Write(b []byte) (int, error)

Write implementation copied from SignatureAlgorithmsExtension.Write

Warning: not tested.

type SignatureAlgorithmsExtension 

type SignatureAlgorithmsExtension struct {
	SupportedSignatureAlgorithms []SignatureScheme
}

SignatureAlgorithmsExtension implements signature_algorithms (13)

func (*SignatureAlgorithmsExtension) Len 

func (e *SignatureAlgorithmsExtension) Len() int

func (*SignatureAlgorithmsExtension) Read 

func (e *SignatureAlgorithmsExtension) Read(b []byte) (int, error)

func (*SignatureAlgorithmsExtension) UnmarshalJSON 

func (e *SignatureAlgorithmsExtension) UnmarshalJSON(data []byte) error

func (*SignatureAlgorithmsExtension) Write 

func (e *SignatureAlgorithmsExtension) Write(b []byte) (int, error)

type SignatureScheme 

type SignatureScheme uint16

SignatureScheme identifies a signature algorithm supported by TLS. See RFC 8446, Section 4.2.3. 

const (
	// RSASSA-PKCS1-v1_5 algorithms.
	PKCS1WithSHA256 SignatureScheme = 0x0401
	PKCS1WithSHA384 SignatureScheme = 0x0501
	PKCS1WithSHA512 SignatureScheme = 0x0601

	// RSASSA-PSS algorithms with public key OID rsaEncryption.
	PSSWithSHA256 SignatureScheme = 0x0804
	PSSWithSHA384 SignatureScheme = 0x0805
	PSSWithSHA512 SignatureScheme = 0x0806

	// ECDSA algorithms. Only constrained to a specific curve in TLS 1.3.
	ECDSAWithP256AndSHA256 SignatureScheme = 0x0403
	ECDSAWithP384AndSHA384 SignatureScheme = 0x0503
	ECDSAWithP521AndSHA512 SignatureScheme = 0x0603

	// EdDSA algorithms.
	Ed25519 SignatureScheme = 0x0807

	// Legacy signature and hash algorithms for TLS 1.2.
	PKCS1WithSHA1 SignatureScheme = 0x0201
	ECDSAWithSHA1 SignatureScheme = 0x0203
)
var (
	FakePKCS1WithSHA224 SignatureScheme = 0x0301
	FakeECDSAWithSHA224 SignatureScheme = 0x0303

	FakeSHA1WithDSA   SignatureScheme = 0x0202
	FakeSHA256WithDSA SignatureScheme = 0x0402
)

newest signatures

func (SignatureScheme) String 

func (i SignatureScheme) String() string

type StatusRequestExtension 

type StatusRequestExtension struct {
}

StatusRequestExtension implements status_request (5)

func (*StatusRequestExtension) Len 

func (e *StatusRequestExtension) Len() int

func (*StatusRequestExtension) Read 

func (e *StatusRequestExtension) Read(b []byte) (int, error)

func (*StatusRequestExtension) UnmarshalJSON 

func (e *StatusRequestExtension) UnmarshalJSON(_ []byte) error

func (*StatusRequestExtension) Write 

func (e *StatusRequestExtension) Write(b []byte) (int, error)

Write is a no-op for StatusRequestExtension. No data for this extension.

type StatusRequestV2Extension 

type StatusRequestV2Extension struct {
}

StatusRequestV2Extension implements status_request_v2 (17)

func (*StatusRequestV2Extension) Len 

func (e *StatusRequestV2Extension) Len() int

func (*StatusRequestV2Extension) Read 

func (e *StatusRequestV2Extension) Read(b []byte) (int, error)

func (*StatusRequestV2Extension) UnmarshalJSON 

func (e *StatusRequestV2Extension) UnmarshalJSON(_ []byte) error

func (*StatusRequestV2Extension) Write 

func (e *StatusRequestV2Extension) Write(b []byte) (int, error)

Write is a no-op for StatusRequestV2Extension. No data for this extension.

type SupportedCurvesExtension 

type SupportedCurvesExtension struct {
	Curves []CurveID
}

SupportedCurvesExtension implements supported_groups (renamed from "elliptic_curves") (10)

func (*SupportedCurvesExtension) Len 

func (e *SupportedCurvesExtension) Len() int

func (*SupportedCurvesExtension) Read 

func (e *SupportedCurvesExtension) Read(b []byte) (int, error)

func (*SupportedCurvesExtension) UnmarshalJSON 

func (e *SupportedCurvesExtension) UnmarshalJSON(data []byte) error

func (*SupportedCurvesExtension) Write 

func (e *SupportedCurvesExtension) Write(b []byte) (int, error)

type SupportedPointsExtension 

type SupportedPointsExtension struct {
	SupportedPoints []uint8
}

SupportedPointsExtension implements ec_point_formats (11)

func (*SupportedPointsExtension) Len 

func (e *SupportedPointsExtension) Len() int

func (*SupportedPointsExtension) Read 

func (e *SupportedPointsExtension) Read(b []byte) (int, error)

func (*SupportedPointsExtension) UnmarshalJSON 

func (e *SupportedPointsExtension) UnmarshalJSON(data []byte) error

func (*SupportedPointsExtension) Write 

func (e *SupportedPointsExtension) Write(b []byte) (int, error)

type SupportedVersionsExtension 

type SupportedVersionsExtension struct {
	Versions []uint16
}

SupportedVersionsExtension implements supported_versions (43).

func (*SupportedVersionsExtension) Len 

func (e *SupportedVersionsExtension) Len() int

func (*SupportedVersionsExtension) Read 

func (e *SupportedVersionsExtension) Read(b []byte) (int, error)

func (*SupportedVersionsExtension) UnmarshalJSON 

func (e *SupportedVersionsExtension) UnmarshalJSON(b []byte) error

func (*SupportedVersionsExtension) Write 

func (e *SupportedVersionsExtension) Write(b []byte) (int, error)

type TLS12OnlyState 

type TLS12OnlyState struct {
	FinishedHash FinishedHash
	Suite        PubCipherSuite
}

TLS 1.2 and before only

type TLS13OnlyState 

type TLS13OnlyState struct {
	Suite           *PubCipherSuiteTLS13
	EcdheKey        *ecdh.PrivateKey
	KeySharesParams *KeySharesParameters
	KEMKey          *KemPrivateKey
	EarlySecret     []byte
	BinderKey       []byte
	CertReq         *CertificateRequestMsgTLS13
	UsingPSK        bool // don't set this field when building client hello
	SentDummyCCS    bool
	Transcript      hash.Hash
	TrafficSecret   []byte // client_application_traffic_secret_0
}

TLS 1.3 only

type TLSExtension 

type TLSExtension interface {
	Len() int // includes header

	// Read reads up to len(p) bytes into p.
	// It returns the number of bytes read (0 <= n <= len(p)) and any error encountered.
	Read(p []byte) (n int, err error) // implements io.Reader
	// contains filtered or unexported methods
}

func ExtensionFromID 

func ExtensionFromID(id uint16) TLSExtension

ExtensionFromID returns a TLSExtension for the given extension ID.

func ShuffleChromeTLSExtensions 

func ShuffleChromeTLSExtensions(exts []TLSExtension) []TLSExtension

ShuffleChromeTLSExtensions shuffles the extensions in the ClientHelloSpec to avoid ossification. It shuffles every extension except GREASE, padding and pre_shared_key extensions.

This feature was first introduced by Chrome 106.

type TLSExtensionJSON 

type TLSExtensionJSON interface {
	TLSExtension

	// UnmarshalJSON unmarshals the JSON-encoded data into the extension.
	UnmarshalJSON([]byte) error
}

type TLSExtensionWriter 

type TLSExtensionWriter interface {
	TLSExtension

	// Write writes the extension data as a byte slice, up to len(b) bytes from b.
	// It returns the number of bytes written (0 <= n <= len(b)) and any error encountered.
	//
	// The implementation MUST NOT silently drop data if consumed less than len(b) bytes,
	// instead, it MUST return an error.
	Write(b []byte) (n int, err error)
}

TLSExtensionWriter is an interface allowing a TLS extension to be auto-constucted/recovered by reading in a byte stream.

type TLSExtensionsJSONUnmarshaler 

type TLSExtensionsJSONUnmarshaler struct {
	AllowUnknownExt bool // if set, unknown extensions will be added as GenericExtension, without recovering ext payload
	UseRealPSK      bool // if set, PSK extension will be real PSK extension, otherwise it will be fake PSK extension
	// contains filtered or unexported fields
}

func (*TLSExtensionsJSONUnmarshaler) Extensions 

func (e *TLSExtensionsJSONUnmarshaler) Extensions() []TLSExtension

func (*TLSExtensionsJSONUnmarshaler) UnmarshalJSON 

func (e *TLSExtensionsJSONUnmarshaler) UnmarshalJSON(jsonStr []byte) error

type TicketKey 

type TicketKey struct {
	AesKey  [16]byte
	HmacKey [16]byte
	// created is the time at which this ticket key was created. See Config.ticketKeys.
	Created time.Time
}

TicketKey is the internal representation of a session ticket key.

func TicketKeyFromBytes 

func TicketKeyFromBytes(b [32]byte) TicketKey

func (TicketKey) ToPrivate 

func (TK TicketKey) ToPrivate() ticketKey

type TicketKeys 

type TicketKeys []TicketKey

func (TicketKeys) ToPrivate 

func (TKS TicketKeys) ToPrivate() []ticketKey

type TransportParameter 

type TransportParameter interface {
	ID() uint64
	Value() []byte
}

TransportParameter represents a QUIC transport parameter.

Caller will write the following to the wire: 

var b []byte
b = quicvarint.Append(b, ID())
b = quicvarint.Append(b, len(Value()))
b = append(b, Value())

Therefore Value() should return the exact bytes to be written to the wire AFTER the length field, i.e., the bytes MAY be a Variable Length Integer per RFC depending on the type of the transport parameter, but MUST NOT including the length field unless the parameter is defined so.

type TransportParameters 

type TransportParameters []TransportParameter

func (TransportParameters) Marshal 

func (tps TransportParameters) Marshal() []byte

type UConn 

type UConn struct {
	*Conn

	Extensions    []TLSExtension
	ClientHelloID ClientHelloID

	HandshakeState PubClientHandshakeState
	// contains filtered or unexported fields
}

func UClient 

func UClient(conn net.Conn, config *Config, clientHelloID ClientHelloID) *UConn

UClient returns a new uTLS client, with behavior depending on clientHelloID. Config CAN be nil, but make sure to eventually specify ServerName.

func (*UConn) ApplyConfig 

func (uconn *UConn) ApplyConfig() error

func (*UConn) ApplyPreset 

func (uconn *UConn) ApplyPreset(p *ClientHelloSpec) error

ApplyPreset should only be used in conjunction with HelloCustom to apply custom specs. Fields of TLSExtensions that are slices/pointers are shared across different connections with same ClientHelloSpec. It is advised to use different specs and avoid any shared state.

func (*UConn) BuildHandshakeState 

func (uconn *UConn) BuildHandshakeState() error

BuildHandshakeState behavior varies based on ClientHelloID and whether it was already called before. If HelloGolang: 

[only once] make default ClientHello and overwrite existing state

If any other mimicking ClientHelloID is used: 

[only once] make ClientHello based on ID and overwrite existing state
[each call] apply uconn.Extensions config to internal crypto/tls structures
[each call] marshal ClientHello.

BuildHandshakeState is automatically called before uTLS performs handshake, and should only be called explicitly to inspect/change fields of default/mimicked ClientHello. With the excpetion of session ticket and psk extensions, which cannot be changed after calling BuildHandshakeState, all other fields can be modified.

func (*UConn) BuildHandshakeStateWithoutSession 

func (uconn *UConn) BuildHandshakeStateWithoutSession() error

BuildHandshakeStateWithoutSession is the same as BuildHandshakeState, but does not set the session. This is only useful when you want to inspect the ClientHello before setting the session manually through SetSessionTicketExtension or SetPSKExtension. BuildHandshakeState is automatically called before uTLS performs handshake.

func (*UConn) DidTls12Resume 

func (uconn *UConn) DidTls12Resume() bool

func (*UConn) GetOutKeystream 

func (uconn *UConn) GetOutKeystream(length int) ([]byte, error)

get current state of cipher and encrypt zeros to get keystream

func (*UConn) GetUnderlyingConn 

func (uconn *UConn) GetUnderlyingConn() net.Conn

func (*UConn) Handshake 

func (c *UConn) Handshake() error

Handshake runs the client handshake using given clientHandshakeState Requires hs.hello, and, optionally, hs.session to be set.

func (*UConn) HandshakeContext 

func (c *UConn) HandshakeContext(ctx context.Context) error

HandshakeContext runs the client or server handshake protocol if it has not yet been run.

The provided Context must be non-nil. If the context is canceled before the handshake is complete, the handshake is interrupted and an error is returned. Once the handshake has completed, cancellation of the context will not affect the connection.

func (*UConn) MarshalClientHello 

func (uconn *UConn) MarshalClientHello() error

func (*UConn) MarshalClientHelloNoECH 

func (uconn *UConn) MarshalClientHelloNoECH() error

MarshalClientHelloNoECH marshals ClientHello as if there was no ECH extension present.

func (*UConn) QUICGetTransportParameters 

func (uc *UConn) QUICGetTransportParameters() ([]byte, error)

func (*UConn) QUICSetReadSecret 

func (uc *UConn) QUICSetReadSecret(level QUICEncryptionLevel, suite uint16, secret []byte)

func (*UConn) QUICSetWriteSecret 

func (uc *UConn) QUICSetWriteSecret(level QUICEncryptionLevel, suite uint16, secret []byte)

func (*UConn) Read 

func (c *UConn) Read(b []byte) (int, error)

Read reads data from the connection.

As Read calls Conn.Handshake, in order to prevent indefinite blocking a deadline must be set for both Read and Conn.Write before Read is called when the handshake has not yet completed. See Conn.SetDeadline, Conn.SetReadDeadline, and Conn.SetWriteDeadline.

func (*UConn) RemoveSNIExtension 

func (uconn *UConn) RemoveSNIExtension() error

RemoveSNIExtension removes SNI from the list of extensions sent in ClientHello It returns an error when used with HelloGolang ClientHelloID

func (*UConn) SetClientRandom 

func (uconn *UConn) SetClientRandom(r []byte) error

SetClientRandom sets client random explicitly. BuildHandshakeFirst() must be called before SetClientRandom. r must to be 32 bytes long.

func (*UConn) SetPskExtension 

func (uconn *UConn) SetPskExtension(pskExt PreSharedKeyExtension) error

SetPskExtension sets the psk extension for tls 1.3 resumption. This is a no-op if the psk is nil.

func (*UConn) SetSNI 

func (uconn *UConn) SetSNI(sni string)

func (*UConn) SetSessionCache 

func (uconn *UConn) SetSessionCache(cache ClientSessionCache)

If you want session tickets to be reused - use same cache on following connections

func (*UConn) SetSessionState deprecated 

func (uconn *UConn) SetSessionState(session *ClientSessionState) error

SetSessionState sets the session ticket, which may be preshared or fake. If session is nil, the body of session ticket extension will be unset, but the extension itself still MAY be present for mimicking purposes. Session tickets to be reused - use same cache on following connections.

Deprecated: This method is deprecated in favor of SetSessionTicketExtension, as it only handles session override of TLS 1.2

func (*UConn) SetSessionTicketExtension 

func (uconn *UConn) SetSessionTicketExtension(sessionTicketExt ISessionTicketExtension) error

SetSessionTicket sets the session ticket extension. If extension is nil, this will be a no-op.

func (*UConn) SetTLSVers 

func (uconn *UConn) SetTLSVers(minTLSVers, maxTLSVers uint16, specExtensions []TLSExtension) error

SetTLSVers sets min and max TLS version in all appropriate places. Function will use first non-zero version parsed in following order:

  1. Provided minTLSVers, maxTLSVers
  2. specExtensions may have SupportedVersionsExtension
  3. [default] min = TLS 1.0, max = TLS 1.2

Error is only returned if things are in clearly undesirable state to help user fix them.

func (*UConn) SetUnderlyingConn 

func (uconn *UConn) SetUnderlyingConn(c net.Conn)

func (*UConn) Write 

func (c *UConn) Write(b []byte) (int, error)

Copy-pasted from tls.Conn in its entirety. But c.Handshake() is now utls' one, not tls. Write writes data to the connection.

type UQUICConn 

type UQUICConn struct {
	// contains filtered or unexported fields
}

A UQUICConn represents a connection which uses a QUIC implementation as the underlying transport as described in RFC 9001.

Methods of UQUICConn are not safe for concurrent use.

func UQUICClient 

func UQUICClient(config *QUICConfig, clientHelloID ClientHelloID) *UQUICConn

QUICClient returns a new TLS client side connection using QUICTransport as the underlying transport. The config cannot be nil.

The config's MinVersion must be at least TLS 1.3.

func (*UQUICConn) ApplyPreset 

func (q *UQUICConn) ApplyPreset(p *ClientHelloSpec) error

func (*UQUICConn) Close 

func (q *UQUICConn) Close() error

Close closes the connection and stops any in-progress handshake.

func (*UQUICConn) ConnectionState 

func (q *UQUICConn) ConnectionState() ConnectionState

ConnectionState returns basic TLS details about the connection.

func (*UQUICConn) HandleData 

func (q *UQUICConn) HandleData(level QUICEncryptionLevel, data []byte) error

HandleData handles handshake bytes received from the peer. It may produce connection events, which may be read with NextEvent.

func (*UQUICConn) NextEvent 

func (q *UQUICConn) NextEvent() QUICEvent

NextEvent returns the next event occurring on the connection. It returns an event with a Kind of QUICNoEvent when no events are available.

func (*UQUICConn) SendSessionTicket 

func (q *UQUICConn) SendSessionTicket(opts QUICSessionTicketOptions) error

SendSessionTicket sends a session ticket to the client. It produces connection events, which may be read with NextEvent. Currently, it can only be called once.

func (*UQUICConn) SetTransportParameters 

func (q *UQUICConn) SetTransportParameters(params []byte)

SetTransportParameters sets the transport parameters to send to the peer.

Server connections may delay setting the transport parameters until after receiving the client's transport parameters. See QUICTransportParametersRequired.

func (*UQUICConn) Start 

func (q *UQUICConn) Start(ctx context.Context) error

Start starts the client or server handshake protocol. It may produce connection events, which may be read with NextEvent.

Start must be called at most once.

type UnimplementedECHExtension 

type UnimplementedECHExtension struct{}

UnimplementedECHExtension is a placeholder for an ECH extension that is not implemented. All implementations of EncryptedClientHelloExtension should embed this struct to ensure forward compatibility.

func (*UnimplementedECHExtension) Configure 

func (*UnimplementedECHExtension) Configure([]ECHConfig) error

Configure implements EncryptedClientHelloExtension.

func (*UnimplementedECHExtension) Len 

func (*UnimplementedECHExtension) Len() int

Len implements TLSExtension.

func (*UnimplementedECHExtension) MarshalClientHello 

func (*UnimplementedECHExtension) MarshalClientHello(*UConn) error

MarshalClientHello implements EncryptedClientHelloExtension.

func (*UnimplementedECHExtension) Read 

func (*UnimplementedECHExtension) Read(_ []byte) (int, error)

Read implements TLSExtension.

type UnimplementedPreSharedKeyExtension 

type UnimplementedPreSharedKeyExtension struct{}

func (*UnimplementedPreSharedKeyExtension) GetPreSharedKeyCommon 

func (*UnimplementedPreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon

func (*UnimplementedPreSharedKeyExtension) InitializeByUtls 

func (*UnimplementedPreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)

func (*UnimplementedPreSharedKeyExtension) IsInitialized 

func (*UnimplementedPreSharedKeyExtension) IsInitialized() bool

func (*UnimplementedPreSharedKeyExtension) Len 

func (*UnimplementedPreSharedKeyExtension) Len() int

func (*UnimplementedPreSharedKeyExtension) PatchBuiltHello 

func (*UnimplementedPreSharedKeyExtension) PatchBuiltHello(hello *PubClientHelloMsg) error

func (*UnimplementedPreSharedKeyExtension) Read 

func (*UnimplementedPreSharedKeyExtension) Read([]byte) (int, error)

func (*UnimplementedPreSharedKeyExtension) SetOmitEmptyPsk 

func (*UnimplementedPreSharedKeyExtension) SetOmitEmptyPsk(val bool)

type UtlsCompressCertExtension 

type UtlsCompressCertExtension struct {
	Algorithms []CertCompressionAlgo
}

UtlsCompressCertExtension implements compress_certificate (27) and is only implemented client-side for server certificates. Alternate certificate message formats (https://datatracker.ietf.org/doc/html/rfc7250) are not supported.

See https://datatracker.ietf.org/doc/html/rfc8879#section-3

func (*UtlsCompressCertExtension) Len 

func (e *UtlsCompressCertExtension) Len() int

func (*UtlsCompressCertExtension) Read 

func (e *UtlsCompressCertExtension) Read(b []byte) (int, error)

func (*UtlsCompressCertExtension) UnmarshalJSON 

func (e *UtlsCompressCertExtension) UnmarshalJSON(b []byte) error

func (*UtlsCompressCertExtension) Write 

func (e *UtlsCompressCertExtension) Write(b []byte) (int, error)

type UtlsExtendedMasterSecretExtension deprecated 

type UtlsExtendedMasterSecretExtension = ExtendedMasterSecretExtension

UtlsExtendedMasterSecretExtension is an alias for ExtendedMasterSecretExtension.

Deprecated: Use ExtendedMasterSecretExtension instead.

type UtlsGREASEExtension 

type UtlsGREASEExtension struct {
	Value uint16
	Body  []byte // in Chrome first grease has empty body, second grease has a single zero byte
}

it is responsibility of user not to generate multiple grease extensions with same value

func (*UtlsGREASEExtension) Len 

func (e *UtlsGREASEExtension) Len() int

func (*UtlsGREASEExtension) Read 

func (e *UtlsGREASEExtension) Read(b []byte) (int, error)

func (*UtlsGREASEExtension) UnmarshalJSON 

func (e *UtlsGREASEExtension) UnmarshalJSON(b []byte) error

func (*UtlsGREASEExtension) Write 

func (e *UtlsGREASEExtension) Write(b []byte) (int, error)

type UtlsPaddingExtension 

type UtlsPaddingExtension struct {
	PaddingLen int
	WillPad    bool // set to false to disable extension

	// Functor for deciding on padding length based on unpadded ClientHello length.
	// If willPad is false, then this extension should not be included.
	GetPaddingLen func(clientHelloUnpaddedLen int) (paddingLen int, willPad bool)
}

UtlsPaddingExtension implements padding (21)

func (*UtlsPaddingExtension) Len 

func (e *UtlsPaddingExtension) Len() int

func (*UtlsPaddingExtension) Read 

func (e *UtlsPaddingExtension) Read(b []byte) (int, error)

func (*UtlsPaddingExtension) UnmarshalJSON 

func (e *UtlsPaddingExtension) UnmarshalJSON(b []byte) error

func (*UtlsPaddingExtension) Update 

func (e *UtlsPaddingExtension) Update(clientHelloUnpaddedLen int)

func (*UtlsPaddingExtension) Write 

func (e *UtlsPaddingExtension) Write(_ []byte) (int, error)

type UtlsPreSharedKeyExtension 

type UtlsPreSharedKeyExtension struct {
	UnimplementedPreSharedKeyExtension
	PreSharedKeyCommon

	// Deprecated: Set OmitEmptyPsk in Config instead.
	OmitEmptyPsk bool
	// contains filtered or unexported fields
}

UtlsPreSharedKeyExtension is an extension used to set the PSK extension in the ClientHello.

func (*UtlsPreSharedKeyExtension) GetPreSharedKeyCommon 

func (e *UtlsPreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon

func (*UtlsPreSharedKeyExtension) InitializeByUtls 

func (e *UtlsPreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)

func (*UtlsPreSharedKeyExtension) IsInitialized 

func (e *UtlsPreSharedKeyExtension) IsInitialized() bool

func (*UtlsPreSharedKeyExtension) Len 

func (e *UtlsPreSharedKeyExtension) Len() int

func (*UtlsPreSharedKeyExtension) PatchBuiltHello 

func (e *UtlsPreSharedKeyExtension) PatchBuiltHello(hello *PubClientHelloMsg) error

func (*UtlsPreSharedKeyExtension) Read 

func (e *UtlsPreSharedKeyExtension) Read(b []byte) (int, error)

func (*UtlsPreSharedKeyExtension) SetOmitEmptyPsk 

func (e *UtlsPreSharedKeyExtension) SetOmitEmptyPsk(val bool)

func (*UtlsPreSharedKeyExtension) UnmarshalJSON 

func (e *UtlsPreSharedKeyExtension) UnmarshalJSON(_ []byte) error

func (*UtlsPreSharedKeyExtension) Write 

func (e *UtlsPreSharedKeyExtension) Write(b []byte) (int, error)

type VersionInformation 

type VersionInformation struct {
	ChoosenVersion    uint32
	AvailableVersions []uint32 // Also known as "Other Versions" in early drafts.

	LegacyID bool // If true, use the legacy-assigned ID (0xff73db) instead of the RFC-assigned one (0x11).
}

func (*VersionInformation) GetGREASEVersion 

func (*VersionInformation) GetGREASEVersion() uint32

func (*VersionInformation) ID 

func (v *VersionInformation) ID() uint64

func (*VersionInformation) Value 

func (v *VersionInformation) Value() []byte

type Weights 

type Weights struct {
	Extensions_Append_ALPN                             float64
	TLSVersMax_Set_VersionTLS13                        float64
	CipherSuites_Remove_RandomCiphers                  float64
	SigAndHashAlgos_Append_ECDSAWithSHA1               float64
	SigAndHashAlgos_Append_ECDSAWithP521AndSHA512      float64
	SigAndHashAlgos_Append_PSSWithSHA256               float64
	SigAndHashAlgos_Append_PSSWithSHA384_PSSWithSHA512 float64
	CurveIDs_Append_X25519                             float64
	CurveIDs_Append_CurveP521                          float64
	Extensions_Append_Padding                          float64
	Extensions_Append_Status                           float64
	Extensions_Append_SCT                              float64
	Extensions_Append_Reneg                            float64
	Extensions_Append_EMS                              float64
	FirstKeyShare_Set_CurveP256                        float64
	Extensions_Append_ALPS                             float64
}

Notes

Bugs

Source Files

View all Source files

Directories

Path Synopsis
examples
ech
old
tls-resumption
internal
boring
helper
quicvarint
quicvarint/protocol
Package testenv provides information about what functionality is available in different testing environments run by the Go team.
 Package testenv provides information about what functionality is available in different testing environments run by the Go team.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.