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 ¶
- Constants
- Variables
- func AlwaysPadToLen(padToLen int) func(int) (int, bool)
- func BoringPaddingStyle(unpaddedLen int) (int, bool)
- func CipherSuiteName(id uint16) string
- func EnableWeakCiphers()
- func GetBoringGREASEValue(greaseSeed [ssl_grease_last_index]uint16, index int) uint16
- func Listen(network, laddr string, config *Config) (net.Listener, error)
- func NewListener(inner net.Listener, config *Config) net.Listener
- func VersionName(version uint16) string
- type ALPNExtension
- type ActiveConnectionIDLimit
- type AlertError
- type ApplicationSettingsExtension
- type CertCompressionAlgo
- type Certificate
- type CertificateRequestInfo
- type CertificateRequestMsgTLS13
- type CertificateVerificationError
- type CipherSuite
- type CipherSuitesJSONUnmarshaler
- type ClientAuthType
- type ClientHelloBuildStatus
- type ClientHelloID
- type ClientHelloInfo
- type ClientHelloSpec
- func (chs *ClientHelloSpec) AlwaysAddPadding()
- func (chs *ClientHelloSpec) FromRaw(raw []byte, ctrlFlags ...bool) error
- func (chs *ClientHelloSpec) ImportTLSClientHello(data map[string][]byte) error
- func (chs *ClientHelloSpec) ImportTLSClientHelloFromJSON(jsonB []byte) error
- func (chs *ClientHelloSpec) ReadCipherSuites(b []byte) error
- func (chs *ClientHelloSpec) ReadCompressionMethods(compressionMethods []byte) error
- func (chs *ClientHelloSpec) ReadTLSExtensions(b []byte, allowBluntMimicry bool, realPSK bool) error
- func (chs *ClientHelloSpec) UnmarshalJSON(jsonB []byte) error
- type ClientHelloSpecFactory
- type ClientHelloSpecJSONUnmarshaler
- type ClientSessionCache
- type ClientSessionState
- func (css *ClientSessionState) CipherSuite() uint16
- func (css *ClientSessionState) MasterSecret() []byte
- func (cs *ClientSessionState) ResumptionState() (ticket []byte, state *SessionState, err error)
- func (css *ClientSessionState) ServerCertificates() []*x509.Certificate
- func (css *ClientSessionState) SessionTicket() []uint8
- func (css *ClientSessionState) SetCipherSuite(CipherSuite uint16)
- func (css *ClientSessionState) SetMasterSecret(MasterSecret []byte)
- func (css *ClientSessionState) SetServerCertificates(ServerCertificates []*x509.Certificate)
- func (css *ClientSessionState) SetSessionTicket(SessionTicket []uint8)
- func (css *ClientSessionState) SetVerifiedChains(VerifiedChains [][]*x509.Certificate)
- func (css *ClientSessionState) SetVers(Vers uint16)
- func (css *ClientSessionState) VerifiedChains() [][]*x509.Certificate
- func (css *ClientSessionState) Vers() uint16
- type CompressionMethodsJSONUnmarshaler
- type Config
- func (c *Config) BuildNameToCertificate()deprecated
- func (c *Config) Clone() *Config
- func (c *Config) DecryptTicket(identity []byte, cs ConnectionState) (*SessionState, error)
- func (c *Config) EncryptTicket(cs ConnectionState, ss *SessionState) ([]byte, error)
- func (c *Config) SetSessionTicketKeys(keys [][32]byte)
- type Conn
- func Client(conn net.Conn, config *Config) *Conn
- func Dial(network, addr string, config *Config) (*Conn, error)
- func DialWithDialer(dialer *net.Dialer, network, addr string, config *Config) (*Conn, error)
- func MakeConnWithCompleteHandshake(tcpConn net.Conn, version uint16, cipherSuite uint16, masterSecret []byte, ...) *Conn
- func Server(conn net.Conn, config *Config) *Conn
- func (c *Conn) Close() error
- func (c *Conn) CloseWrite() error
- func (c *Conn) ConnectionState() ConnectionState
- func (c *Conn) Handshake() error
- func (c *Conn) HandshakeContext(ctx context.Context) error
- func (c *Conn) LocalAddr() net.Addr
- func (c *Conn) NetConn() net.Conn
- func (c *Conn) OCSPResponse() []byte
- func (c *Conn) Read(b []byte) (int, error)
- func (c *Conn) RemoteAddr() net.Addr
- func (c *Conn) SetDeadline(t time.Time) error
- func (c *Conn) SetReadDeadline(t time.Time) error
- func (c *Conn) SetWriteDeadline(t time.Time) error
- func (c *Conn) VerifyHostname(host string) error
- func (c *Conn) Write(b []byte) (int, error)
- type ConnectionState
- type CookieExtension
- type CurveID
- type DelegatedCredentialsExtension
- type Dialer
- type DisableActiveMigration
- type ECHConfig
- type ECHConfigContents
- type ECHExtension
- type EncryptedClientHelloExtension
- type ExtendedMasterSecretExtension
- type FakeChannelIDExtension
- type FakeDelegatedCredentialsExtension
- type FakePreSharedKeyExtension
- func (e *FakePreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon
- func (e *FakePreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, ...)
- func (e *FakePreSharedKeyExtension) IsInitialized() bool
- func (e *FakePreSharedKeyExtension) Len() int
- func (*FakePreSharedKeyExtension) PatchBuiltHello(*PubClientHelloMsg) error
- func (e *FakePreSharedKeyExtension) Read(b []byte) (int, error)
- func (e *FakePreSharedKeyExtension) SetOmitEmptyPsk(val bool)
- func (e *FakePreSharedKeyExtension) UnmarshalJSON(data []byte) error
- func (e *FakePreSharedKeyExtension) Write(b []byte) (n int, err error)
- type FakeQUICTransportParameter
- type FakeRecordSizeLimitExtension
- type FakeTokenBindingExtension
- type Fingerprinter
- func (f *Fingerprinter) FingerprintClientHello(data []byte) (clientHelloSpec *ClientHelloSpec, err error)
- func (f *Fingerprinter) RawClientHello(raw []byte) (clientHelloSpec *ClientHelloSpec, err error)
- func (f *Fingerprinter) UnmarshalJSONClientHello(json []byte) (clientHelloSpec *ClientHelloSpec, err error)
- type FinishedHash
- type GREASEECHExtension
- type GREASEEncryptedClientHelloExtension
- type GREASEQUICBit
- type GREASETransportParameter
- type GenericExtension
- type HPKEKeyConfig
- type HPKERawPublicKey
- type HPKESymmetricCipherSuite
- type HPKE_AEAD_ID
- type HPKE_KDF_ID
- type HPKE_KEM_ID
- type ISessionTicketExtension
- type InitialMaxData
- type InitialMaxStreamDataBidiLocal
- type InitialMaxStreamDataBidiRemote
- type InitialMaxStreamDataUni
- type InitialMaxStreamsBidi
- type InitialMaxStreamsUni
- type InitialSourceConnectionID
- type Initializable
- type KemPrivateKey
- type KeyShare
- type KeyShareExtension
- type KeyShares
- type KeySharesParameters
- func (ksp *KeySharesParameters) AddEcdheKeypair(curveID CurveID, ecdheKey *ecdh.PrivateKey, ecdhePubKey *ecdh.PublicKey)
- func (ksp *KeySharesParameters) AddKemKeypair(curveID CurveID, kemKey kem.PrivateKey, kemPubKey kem.PublicKey)
- func (ksp *KeySharesParameters) GetEcdheKey(curveID CurveID) (ecdheKey *ecdh.PrivateKey, ok bool)
- func (ksp *KeySharesParameters) GetEcdhePubkey(curveID CurveID) (params *ecdh.PublicKey, ok bool)
- func (ksp *KeySharesParameters) GetKemKey(curveID CurveID) (kemKey kem.PrivateKey, ok bool)
- func (ksp *KeySharesParameters) GetKemPubkey(curveID CurveID) (params kem.PublicKey, ok bool)
- type LoadSessionTrackerState
- type MaxAckDelay
- type MaxDatagramFrameSize
- type MaxIdleTimeout
- type MaxUDPPayloadSize
- type NPNExtension
- type PRNGSeed
- type PSKKeyExchangeModesExtension
- type PaddingTransportParameter
- type PreSharedKeyCommon
- type PreSharedKeyExtension
- type PskIdentities
- type PskIdentity
- type PubCipherSuite
- type PubCipherSuiteTLS13
- type PubClientHandshakeState
- type PubClientHelloMsg
- type PubServerHelloMsg
- type QUICConfig
- type QUICConn
- func (q *QUICConn) Close() error
- func (q *QUICConn) ConnectionState() ConnectionState
- func (q *QUICConn) HandleData(level QUICEncryptionLevel, data []byte) error
- func (q *QUICConn) NextEvent() QUICEvent
- func (q *QUICConn) SendSessionTicket(opts QUICSessionTicketOptions) error
- func (q *QUICConn) SetTransportParameters(params []byte)
- func (q *QUICConn) Start(ctx context.Context) error
- type QUICEncryptionLevel
- type QUICEvent
- type QUICEventKind
- type QUICSessionTicketOptions
- type QUICTransportParametersExtension
- type RecordHeaderError
- type RenegotiationInfoExtension
- type RenegotiationSupport
- type Roller
- type SCTExtension
- type SNIExtension
- type SessionState
- type SessionTicketExtension
- func (e *SessionTicketExtension) GetSession() *SessionState
- func (e *SessionTicketExtension) GetTicket() []byte
- func (e *SessionTicketExtension) InitializeByUtls(session *SessionState, ticket []byte)
- func (e *SessionTicketExtension) IsInitialized() bool
- func (e *SessionTicketExtension) Len() int
- func (e *SessionTicketExtension) Read(b []byte) (int, error)
- func (e *SessionTicketExtension) UnmarshalJSON(_ []byte) error
- func (e *SessionTicketExtension) Write(_ []byte) (int, error)
- type SignatureAlgorithmsCertExtension
- type SignatureAlgorithmsExtension
- type SignatureScheme
- type StatusRequestExtension
- type StatusRequestV2Extension
- type SupportedCurvesExtension
- type SupportedPointsExtension
- type SupportedVersionsExtension
- type TLS12OnlyState
- type TLS13OnlyState
- type TLSExtension
- type TLSExtensionJSON
- type TLSExtensionWriter
- type TLSExtensionsJSONUnmarshaler
- type TicketKey
- type TicketKeys
- type TransportParameter
- type TransportParameters
- type UConn
- func (uconn *UConn) ApplyConfig() error
- func (uconn *UConn) ApplyPreset(p *ClientHelloSpec) error
- func (uconn *UConn) BuildHandshakeState() error
- func (uconn *UConn) DidTls12Resume() bool
- func (uconn *UConn) GetOutKeystream(length int) ([]byte, error)
- func (uconn *UConn) GetUnderlyingConn() net.Conn
- func (c *UConn) Handshake() error
- func (c *UConn) HandshakeContext(ctx context.Context) error
- func (uconn *UConn) MarshalClientHello() error
- func (uc *UConn) QUICGetTransportParameters() ([]byte, error)
- func (uc *UConn) QUICSetReadSecret(level QUICEncryptionLevel, suite uint16, secret []byte)
- func (uc *UConn) QUICSetWriteSecret(level QUICEncryptionLevel, suite uint16, secret []byte)
- func (uconn *UConn) RemoveSNIExtension() error
- func (uconn *UConn) SetClientRandom(r []byte) error
- func (uconn *UConn) SetPskExtension(pskExt PreSharedKeyExtension) error
- func (uconn *UConn) SetSNI(sni string)
- func (uconn *UConn) SetSessionCache(cache ClientSessionCache)
- func (uconn *UConn) SetSessionState(session *ClientSessionState) errordeprecated
- func (uconn *UConn) SetSessionTicketExtension(sessionTicketExt ISessionTicketExtension) error
- func (uconn *UConn) SetTLSVers(minTLSVers, maxTLSVers uint16, specExtensions []TLSExtension) error
- func (uconn *UConn) SetUnderlyingConn(c net.Conn)
- func (c *UConn) Write(b []byte) (int, error)
- type UQUICConn
- func (q *UQUICConn) ApplyPreset(p *ClientHelloSpec) error
- func (q *UQUICConn) Close() error
- func (q *UQUICConn) ConnectionState() ConnectionState
- func (q *UQUICConn) HandleData(level QUICEncryptionLevel, data []byte) error
- func (q *UQUICConn) NextEvent() QUICEvent
- func (q *UQUICConn) SendSessionTicket(opts QUICSessionTicketOptions) error
- func (q *UQUICConn) SetTransportParameters(params []byte)
- func (q *UQUICConn) Start(ctx context.Context) error
- type UnimplementedECHExtension
- type UnimplementedPreSharedKeyExtension
- func (*UnimplementedPreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon
- func (*UnimplementedPreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, ...)
- func (*UnimplementedPreSharedKeyExtension) IsInitialized() bool
- func (*UnimplementedPreSharedKeyExtension) Len() int
- func (*UnimplementedPreSharedKeyExtension) PatchBuiltHello(hello *PubClientHelloMsg) error
- func (*UnimplementedPreSharedKeyExtension) Read([]byte) (int, error)
- func (*UnimplementedPreSharedKeyExtension) SetOmitEmptyPsk(val bool)
- type UtlsCompressCertExtension
- type UtlsExtendedMasterSecretExtensiondeprecated
- type UtlsGREASEExtension
- type UtlsPaddingExtension
- type UtlsPreSharedKeyExtension
- func (e *UtlsPreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon
- func (e *UtlsPreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, ...)
- func (e *UtlsPreSharedKeyExtension) IsInitialized() bool
- func (e *UtlsPreSharedKeyExtension) Len() int
- func (e *UtlsPreSharedKeyExtension) PatchBuiltHello(hello *PubClientHelloMsg) error
- func (e *UtlsPreSharedKeyExtension) Read(b []byte) (int, error)
- func (e *UtlsPreSharedKeyExtension) SetOmitEmptyPsk(val bool)
- func (e *UtlsPreSharedKeyExtension) UnmarshalJSON(_ []byte) error
- func (e *UtlsPreSharedKeyExtension) Write(b []byte) (int, error)
- type VersionInformation
- type Weights
- Bugs
Examples ¶
Constants ¶
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 TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA uint16 = 0xc008 // 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
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 )
const ( ExtensionServerName uint16 = 0 ExtensionStatusRequest uint16 = 5 ExtensionSupportedCurves uint16 = 10 // supported_groups in TLS 1.3, see RFC 8446, Section 4.2.7 ExtensionSupportedPoints uint16 = 11 ExtensionSignatureAlgorithms uint16 = 13 ExtensionALPN uint16 = 16 ExtensionStatusRequestV2 uint16 = 17 ExtensionSCT uint16 = 18 ExtensionPadding uint16 = 21 ExtensionExtendedMasterSecret uint16 = 23 // https://tools.ietf.org/html/rfc7627 ExtensionCompressCertificate uint16 = 27 // https://datatracker.ietf.org/doc/html/rfc8879#section-7.1 ExtensionRecordSizeLimit uint16 = 28 ExtensionDelegatedCredentials uint16 = 34 ExtensionSessionTicket uint16 = 35 ExtensionEarlyData uint16 = 42 ExtensionSupportedVersions uint16 = 43 ExtensionCookie uint16 = 44 ExtensionPSKModes uint16 = 45 ExtensionCertificateAuthorities uint16 = 47 ExtensionSignatureAlgorithmsCert uint16 = 50 ExtensionQUICTransportParameters uint16 = 57 ExtensionNextProtoNeg uint16 = 13172 // not IANA assigned ExtensionALPS uint16 = 17513 ExtensionECH uint16 = 65037 ExtensionRenegotiationInfo uint16 = 65281 )
TLS extension numbers
const ( QUICEncryptionLevelInitial = QUICEncryptionLevel(iota) QUICEncryptionLevelEarly QUICEncryptionLevelHandshake QUICEncryptionLevelApplication )
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) )
const ( PskModePlain uint8 = pskModePlain PskModeDHE uint8 = pskModeDHE )
const ( OuterClientHello byte = 0x00 InnerClientHello byte = 0x01 )
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 )
const (
CompressionNone uint8 = 0
)
TLS compression types.
const ( // extensions with 'fake' prefix break connection, if server echoes them back FakeExtensionEncryptThenMAC uint16 = 22 )
TLS
const (
GREASE_MAX_MULTIPLIER = (0x3FFFFFFFFFFFFFFF - 27) / 31
)
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
const NoSession sessionControllerState = 0
const (
PRNGSeedLength = 32
)
const (
PointFormatUncompressed uint8 = 0
)
TLS Elliptic Curve Point Formats https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
const PskExtAllSet sessionControllerState = 4
const PskExtInitialized sessionControllerState = 3
const SessionTicketExtAllSet sessionControllerState = 2
const SessionTicketExtInitialized sessionControllerState = 1
Variables ¶
var ( X25519Kyber512Draft00 = CurveID(0xfe30) X25519Kyber768Draft00 = CurveID(0x6399) X25519Kyber768Draft00Old = CurveID(0xfe31) P256Kyber768Draft00 = CurveID(0xfe32) )
var ( FakeFFDHE2048 = uint16(0x0100) FakeFFDHE3072 = uint16(0x0101) )
fake curves(groups)
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, false, helloAutoVers, nil, nil, EmptyClientHelloSpecFactory} // HelloCustom will prepare ClientHello with empty uconn.Extensions so you can fill it with // TLSExtensions manually or use ApplyPreset function HelloCustom = ClientHelloID{helloCustomInternal, false, helloAutoVers, nil, nil, EmptyClientHelloSpecFactory} // HelloRandomized* randomly adds/reorders extensions, ciphersuites, etc. HelloRandomized = ClientHelloID{helloRandomized, false, helloAutoVers, nil, nil, EmptyClientHelloSpecFactory} HelloRandomizedALPN = ClientHelloID{helloRandomizedALPN, false, helloAutoVers, nil, nil, EmptyClientHelloSpecFactory} HelloRandomizedNoALPN = ClientHelloID{helloRandomizedNoALPN, false, helloAutoVers, nil, nil, EmptyClientHelloSpecFactory} // The rest will will parrot given browser. HelloFirefox_Auto = HelloFirefox_120 HelloFirefox_55 = ClientHelloID{helloFirefox, false, "55", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_56 = ClientHelloID{helloFirefox, false, "56", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_63 = ClientHelloID{helloFirefox, false, "63", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_65 = ClientHelloID{helloFirefox, false, "65", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_99 = ClientHelloID{helloFirefox, false, "99", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_102 = ClientHelloID{helloFirefox, false, "102", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_104 = ClientHelloID{helloFirefox, false, "104", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_106 = ClientHelloID{helloFirefox, false, "106", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_108 = ClientHelloID{helloFirefox, false, "108", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_110 = ClientHelloID{helloFirefox, false, "110", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_105 = ClientHelloID{helloFirefox, false, "105", nil, nil, EmptyClientHelloSpecFactory} HelloFirefox_120 = ClientHelloID{helloFirefox, false, "120", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_106_Shuffle = ClientHelloID{helloChrome, true, "106", nil, nil, EmptyClientHelloSpecFactory} // 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, false, "100_PSK", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_112_PSK = ClientHelloID{helloChrome, false, "112_PSK", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_114_Padding_PSK = ClientHelloID{helloChrome, false, "114_PSK", nil, nil, EmptyClientHelloSpecFactory} // 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, false, "115_PQ", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_115_PQ_PSK = ClientHelloID{helloChrome, false, "115_PQ_PSK", nil, nil, EmptyClientHelloSpecFactory} HelloOpera_Auto = HelloOpera_91 HelloOpera_91 = ClientHelloID{helloOpera, false, "91", nil, nil, EmptyClientHelloSpecFactory} HelloOpera_90 = ClientHelloID{helloOpera, false, "90", nil, nil, EmptyClientHelloSpecFactory} HelloOpera_89 = ClientHelloID{helloOpera, false, "89", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_Auto = HelloChrome_120 HelloChrome_58 = ClientHelloID{helloChrome, false, "58", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_62 = ClientHelloID{helloChrome, false, "62", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_70 = ClientHelloID{helloChrome, false, "70", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_72 = ClientHelloID{helloChrome, false, "72", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_83 = ClientHelloID{helloChrome, false, "83", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_87 = ClientHelloID{helloChrome, false, "87", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_96 = ClientHelloID{helloChrome, false, "96", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_100 = ClientHelloID{helloChrome, false, "100", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_102 = ClientHelloID{helloChrome, false, "102", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_103 = ClientHelloID{helloChrome, false, "103", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_104 = ClientHelloID{helloChrome, false, "104", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_105 = ClientHelloID{helloChrome, false, "105", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_106 = ClientHelloID{helloChrome, false, "106", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_107 = ClientHelloID{helloChrome, false, "107", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_108 = ClientHelloID{helloChrome, false, "108", nil, nil, EmptyClientHelloSpecFactory} // Chrome ECH HelloChrome_120 = ClientHelloID{helloChrome, false, "120", nil, nil, EmptyClientHelloSpecFactory} // Chrome w/ Post-Quantum Key Agreement and Encrypted ClientHello HelloChrome_120_PQ = ClientHelloID{helloChrome, false, "120_PQ", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_109 = ClientHelloID{helloChrome, false, "109", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_110 = ClientHelloID{helloChrome, false, "110", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_111 = ClientHelloID{helloChrome, false, "111", nil, nil, EmptyClientHelloSpecFactory} HelloChrome_112 = ClientHelloID{helloChrome, false, "112", nil, nil, EmptyClientHelloSpecFactory} HelloIOS_Auto = HelloIOS_16_0 HelloIOS_11_1 = ClientHelloID{helloIOS, false, "111", nil, nil, EmptyClientHelloSpecFactory} // legacy "111" means 11.1 HelloIOS_12_1 = ClientHelloID{helloIOS, false, "12.1", nil, nil, EmptyClientHelloSpecFactory} HelloIOS_13 = ClientHelloID{helloIOS, false, "13", nil, nil, EmptyClientHelloSpecFactory} HelloIOS_14 = ClientHelloID{helloIOS, false, "14", nil, nil, EmptyClientHelloSpecFactory} HelloIOS_15_5 = ClientHelloID{helloIOS, false, "15.5", nil, nil, EmptyClientHelloSpecFactory} HelloIOS_15_6 = ClientHelloID{helloIOS, false, "15.6", nil, nil, EmptyClientHelloSpecFactory} HelloIOS_16_0 = ClientHelloID{helloIOS, false, "16.0", nil, nil, EmptyClientHelloSpecFactory} HelloIPad_Auto = HelloIPad_15_6 HelloIPad_15_6 = ClientHelloID{helloIPad, false, "15.6", nil, nil, EmptyClientHelloSpecFactory} HelloSafari_Auto = HelloSafari_16_0 HelloSafari_15_6_1 = ClientHelloID{helloSafari, false, "15.6.1", nil, nil, EmptyClientHelloSpecFactory} HelloSafari_16_0 = ClientHelloID{helloSafari, false, "16.0", nil, nil, EmptyClientHelloSpecFactory} HelloAndroid_11_OkHttp = ClientHelloID{helloAndroid, false, "11", nil, nil, EmptyClientHelloSpecFactory} HelloEdge_Auto = HelloEdge_85 // HelloEdge_106 seems to be incompatible with this library HelloEdge_85 = ClientHelloID{helloEdge, false, "85", nil, nil, EmptyClientHelloSpecFactory} HelloEdge_106 = ClientHelloID{helloEdge, false, "106", nil, nil, EmptyClientHelloSpecFactory} Hello360_Auto = Hello360_7_5 // Hello360_11_0 seems to be incompatible with this library Hello360_7_5 = ClientHelloID{hello360, false, "7.5", nil, nil, EmptyClientHelloSpecFactory} Hello360_11_0 = ClientHelloID{hello360, false, "11.0", nil, nil, EmptyClientHelloSpecFactory} HelloQQ_Auto = HelloQQ_11_1 HelloQQ_11_1 = ClientHelloID{helloQQ, false, "11.1", nil, nil, EmptyClientHelloSpecFactory} )
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.
var EmptyClientHelloSpecFactory = func() (ClientHelloSpec, error) { return ClientHelloSpec{}, fmt.Errorf("please implement this method") }
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")
var ErrUnknownClientHelloID = errors.New("tls: unknown ClientHelloID")
var ErrUnknownExtension = errors.New("extension name is unknown to the dictionary")
Functions ¶
func AlwaysPadToLen ¶ added in v1.6.0
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 ¶
https://github.com/google/boringssl/blob/7d7554b6b3c79e707e25521e61e066ce2b996e4c/ssl/t1_lib.c#L2803
func CipherSuiteName ¶ added in v1.5.8
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 ¶
will panic if ssl_grease_last_index[index] is out of bounds.
func Listen ¶
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 ¶
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 ¶ added in v1.6.0
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) UnmarshalJSON ¶ added in v1.6.0
func (e *ALPNExtension) UnmarshalJSON(b []byte) error
type ActiveConnectionIDLimit ¶ added in v1.6.0
type ActiveConnectionIDLimit uint64
func (ActiveConnectionIDLimit) ID ¶ added in v1.6.0
func (ActiveConnectionIDLimit) ID() uint64
func (ActiveConnectionIDLimit) Value ¶ added in v1.6.0
func (a ActiveConnectionIDLimit) Value() []byte
type AlertError ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e AlertError) Error() string
type ApplicationSettingsExtension ¶ added in v0.5.0
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 ¶ added in v0.5.0
func (e *ApplicationSettingsExtension) Len() int
func (*ApplicationSettingsExtension) Read ¶ added in v0.5.0
func (e *ApplicationSettingsExtension) Read(b []byte) (int, error)
func (*ApplicationSettingsExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *ApplicationSettingsExtension) UnmarshalJSON(b []byte) error
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 ¶ added in v1.5.8
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 ¶ added in v1.5.8
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e *CertificateVerificationError) Error() string
func (*CertificateVerificationError) Unwrap ¶ added in v1.6.0
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 ¶ added in v1.5.8
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 ¶ added in v1.5.8
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 ¶ added in v1.6.0
type CipherSuitesJSONUnmarshaler struct {
// contains filtered or unexported fields
}
func (*CipherSuitesJSONUnmarshaler) CipherSuites ¶ added in v1.6.0
func (c *CipherSuitesJSONUnmarshaler) CipherSuites() []uint16
func (*CipherSuitesJSONUnmarshaler) UnmarshalJSON ¶ added in v1.6.0
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 ¶ added in v1.5.8
func (i ClientAuthType) String() string
type ClientHelloBuildStatus ¶ added in v1.6.0
type ClientHelloBuildStatus int
const BuildByGoTLS ClientHelloBuildStatus = 2
const BuildByUtls ClientHelloBuildStatus = 1
const NotBuilt ClientHelloBuildStatus = 0
type ClientHelloID ¶
type ClientHelloID struct { Client string RandomExtensionOrder bool // 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 SpecFactory ClientHelloSpecFactory }
func (*ClientHelloID) IsSet ¶
func (p *ClientHelloID) IsSet() bool
func (*ClientHelloID) Str ¶
func (p *ClientHelloID) Str() string
func (*ClientHelloID) ToSpec ¶ added in v0.4.0
func (p *ClientHelloID) ToSpec() (ClientHelloSpec, error)
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 ¶ added in v1.5.8
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 ¶ added in v1.5.8
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 ¶ added in v1.5.8
func UTLSIdToSpec(id ClientHelloID) (ClientHelloSpec, error)
UTLSIdToSpec converts a ClientHelloID to a corresponding ClientHelloSpec.
Exported internal function utlsIdToSpec per request.
func (*ClientHelloSpec) AlwaysAddPadding ¶ added in v1.6.0
func (chs *ClientHelloSpec) AlwaysAddPadding()
func (*ClientHelloSpec) FromRaw ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (chs *ClientHelloSpec) UnmarshalJSON(jsonB []byte) error
UnmarshalJSON unmarshals a ClientHello message in the form of JSON into a ClientHelloSpec.
type ClientHelloSpecFactory ¶ added in v0.4.0
type ClientHelloSpecFactory func() (ClientHelloSpec, error)
type ClientHelloSpecJSONUnmarshaler ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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) MasterSecret ¶
func (css *ClientSessionState) MasterSecret() []byte
MasterSecret generated by client on a full handshake
func (*ClientSessionState) ResumptionState ¶ added in v1.6.0
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) SetCipherSuite ¶
func (css *ClientSessionState) SetCipherSuite(CipherSuite uint16)
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) 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 ¶ added in v1.6.0
type CompressionMethodsJSONUnmarshaler struct {
// contains filtered or unexported fields
}
func (*CompressionMethodsJSONUnmarshaler) CompressionMethods ¶ added in v1.6.0
func (c *CompressionMethodsJSONUnmarshaler) CompressionMethods() []uint8
func (*CompressionMethodsJSONUnmarshaler) UnmarshalJSON ¶ added in v1.6.0
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. 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 when acting as a // client, and TLS 1.0 when acting as a server. TLS 1.0 is the minimum // supported by this package, both as a client and as a server. // // The client-side default can temporarily be reverted to TLS 1.0 by // including the value "x509sha1=1" in the GODEBUG environment variable. // Note that this option will be removed in Go 1.19 (but it will still be // possible to set this field to VersionTLS10 explicitly). 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 // 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 ¶
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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) CloseWrite ¶
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 Close.
func (*Conn) ConnectionState ¶
func (c *Conn) ConnectionState() ConnectionState
ConnectionState returns basic TLS details about the connection.
func (*Conn) Handshake ¶
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 Read or Write will call it automatically.
For control over canceling or setting a timeout on a handshake, use HandshakeContext or the Dialer's DialContext method instead.
func (*Conn) HandshakeContext ¶ added in v1.5.8
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 Read or Write will call it automatically.
func (*Conn) NetConn ¶ added in v1.5.8
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 ¶
OCSPResponse returns the stapled OCSP response from the TLS server, if any. (Only valid for client connections.)
func (*Conn) Read ¶
Read reads data from the connection.
As Read calls Handshake, in order to prevent indefinite blocking a deadline must be set for both Read and Write before Read is called when the handshake has not yet completed. See SetDeadline, SetReadDeadline, and SetWriteDeadline.
func (*Conn) RemoteAddr ¶
RemoteAddr returns the remote network address.
func (*Conn) SetDeadline ¶
SetDeadline sets the read and write deadlines associated with the connection. A zero value for t means Read and 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 ¶
SetReadDeadline sets the read deadline on the underlying connection. A zero value for t means Read will not time out.
func (*Conn) SetWriteDeadline ¶
SetWriteDeadline sets the write deadline on the underlying connection. A zero value for t means 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) VerifyHostname ¶
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.
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, this function will return an error.
There are conditions in which the returned values might not be unique to a connection. See the Security Considerations sections of RFC 5705 and RFC 7627, and https://mitls.org/pages/attacks/3SHAKE#channelbindings.
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) UnmarshalJSON ¶ added in v1.6.0
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 ( 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 )
type DelegatedCredentialsExtension ¶ added in v0.4.0
type DelegatedCredentialsExtension = FakeDelegatedCredentialsExtension
type Dialer ¶ added in v1.5.8
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 ¶ added in v1.5.8
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 DialContext.
func (*Dialer) DialContext ¶ added in v1.5.8
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 ¶ added in v1.6.0
type DisableActiveMigration struct{}
func (*DisableActiveMigration) ID ¶ added in v1.6.0
func (*DisableActiveMigration) ID() uint64
func (*DisableActiveMigration) Value ¶ added in v1.6.0
func (*DisableActiveMigration) Value() []byte
Its Value MUST ALWAYS be empty.
type ECHConfig ¶ added in v1.6.0
type ECHConfig struct { Version uint16 Length uint16 Contents ECHConfigContents // contains filtered or unexported fields }
func UnmarshalECHConfigs ¶ added in v1.6.0
UnmarshalECHConfigs parses a sequence of ECH configurations.
Ported from cloudflare/go
type ECHConfigContents ¶ added in v1.6.0
type ECHConfigContents struct { KeyConfig HPKEKeyConfig MaximumNameLength uint8 PublicName []byte // contains filtered or unexported fields }
func UnmarshalECHConfigContents ¶ added in v1.6.0
func UnmarshalECHConfigContents(contents []byte) (ECHConfigContents, error)
func (*ECHConfigContents) ParsePublicKey ¶ added in v1.6.0
func (echcc *ECHConfigContents) ParsePublicKey() error
type ECHExtension ¶ added in v1.6.0
type ECHExtension = EncryptedClientHelloExtension // alias
type EncryptedClientHelloExtension ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e *ExtendedMasterSecretExtension) Len() int
func (*ExtendedMasterSecretExtension) Read ¶ added in v1.6.0
func (e *ExtendedMasterSecretExtension) Read(b []byte) (int, error)
func (*ExtendedMasterSecretExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *ExtendedMasterSecretExtension) UnmarshalJSON(_ []byte) 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) UnmarshalJSON ¶ added in v1.6.0
func (e *FakeChannelIDExtension) UnmarshalJSON(_ []byte) error
type FakeDelegatedCredentialsExtension ¶ added in v1.6.0
type FakeDelegatedCredentialsExtension struct {
SupportedSignatureAlgorithms []SignatureScheme
}
func (*FakeDelegatedCredentialsExtension) Len ¶ added in v1.6.0
func (e *FakeDelegatedCredentialsExtension) Len() int
func (*FakeDelegatedCredentialsExtension) Read ¶ added in v1.6.0
func (e *FakeDelegatedCredentialsExtension) Read(b []byte) (int, error)
func (*FakeDelegatedCredentialsExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *FakeDelegatedCredentialsExtension) UnmarshalJSON(data []byte) error
Implementation copied from SignatureAlgorithmsExtension.UnmarshalJSON
type FakePreSharedKeyExtension ¶ added in v1.6.0
type FakePreSharedKeyExtension struct { bool }OmitEmptyPsk
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 ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon
func (*FakePreSharedKeyExtension) InitializeByUtls ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)
func (*FakePreSharedKeyExtension) IsInitialized ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) IsInitialized() bool
func (*FakePreSharedKeyExtension) Len ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) Len() int
func (*FakePreSharedKeyExtension) PatchBuiltHello ¶ added in v1.6.0
func (*FakePreSharedKeyExtension) PatchBuiltHello(*PubClientHelloMsg) error
func (*FakePreSharedKeyExtension) Read ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) Read(b []byte) (int, error)
func (*FakePreSharedKeyExtension) SetOmitEmptyPsk ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) SetOmitEmptyPsk(val bool)
func (*FakePreSharedKeyExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *FakePreSharedKeyExtension) UnmarshalJSON(data []byte) error
type FakeQUICTransportParameter ¶ added in v1.6.0
func (*FakeQUICTransportParameter) ID ¶ added in v1.6.0
func (f *FakeQUICTransportParameter) ID() uint64
func (*FakeQUICTransportParameter) Value ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e *FakeRecordSizeLimitExtension) UnmarshalJSON(data []byte) error
type FakeTokenBindingExtension ¶ added in v1.5.8
https://tools.ietf.org/html/rfc8472#section-2
func (*FakeTokenBindingExtension) Len ¶ added in v1.5.8
func (e *FakeTokenBindingExtension) Len() int
func (*FakeTokenBindingExtension) Read ¶ added in v1.5.8
func (e *FakeTokenBindingExtension) Read(b []byte) (int, error)
func (*FakeTokenBindingExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *FakeTokenBindingExtension) UnmarshalJSON(data []byte) error
type Fingerprinter ¶ added in v0.3.0
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 ¶ added in v0.3.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
type GREASEECHExtension = GREASEEncryptedClientHelloExtension // alias
type GREASEEncryptedClientHelloExtension ¶ added in v1.6.0
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 ¶ added in v1.6.0
func BoringGREASEECH() *GREASEEncryptedClientHelloExtension
func (*GREASEEncryptedClientHelloExtension) Configure ¶ added in v1.6.0
func (*GREASEEncryptedClientHelloExtension) Configure([]ECHConfig) error
func (*GREASEEncryptedClientHelloExtension) Len ¶ added in v1.6.0
func (g *GREASEEncryptedClientHelloExtension) Len() int
func (*GREASEEncryptedClientHelloExtension) MarshalClientHello ¶ added in v1.6.0
func (*GREASEEncryptedClientHelloExtension) MarshalClientHello(*UConn) error
type GREASEQUICBit ¶ added in v1.6.0
type GREASEQUICBit struct{}
func (*GREASEQUICBit) ID ¶ added in v1.6.0
func (*GREASEQUICBit) ID() uint64
func (*GREASEQUICBit) Value ¶ added in v1.6.0
func (*GREASEQUICBit) Value() []byte
Its Value MUST ALWAYS be empty.
type GREASETransportParameter ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (GREASETransportParameter) GetGREASEID() uint64
GetGREASEID returns a random valid GREASE ID for transport parameters.
func (*GREASETransportParameter) ID ¶ added in v1.6.0
func (g *GREASETransportParameter) ID() uint64
func (GREASETransportParameter) IsGREASEID ¶ added in v1.6.0
func (GREASETransportParameter) IsGREASEID(id uint64) bool
IsGREASEID returns true if id is a valid GREASE ID for transport parameters.
func (*GREASETransportParameter) Value ¶ added in v1.6.0
func (g *GREASETransportParameter) Value() []byte
type GenericExtension ¶
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) UnmarshalJSON ¶ added in v1.6.0
func (e *GenericExtension) UnmarshalJSON(b []byte) error
type HPKEKeyConfig ¶ added in v1.6.0
type HPKEKeyConfig struct { ConfigId uint8 KemId HPKE_KEM_ID PublicKey kem.PublicKey CipherSuites []HPKESymmetricCipherSuite // contains filtered or unexported fields }
type HPKERawPublicKey ¶ added in v1.6.0
type HPKERawPublicKey = []byte
type HPKESymmetricCipherSuite ¶ added in v1.6.0
type HPKESymmetricCipherSuite struct { KdfId HPKE_KDF_ID AeadId HPKE_AEAD_ID }
type HPKE_AEAD_ID ¶ added in v1.6.0
type HPKE_KDF_ID ¶ added in v1.6.0
type HPKE_KEM_ID ¶ added in v1.6.0
type ISessionTicketExtension ¶ added in v1.6.0
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 ¶ added in v1.6.0
type InitialMaxData uint64
func (InitialMaxData) ID ¶ added in v1.6.0
func (InitialMaxData) ID() uint64
func (InitialMaxData) Value ¶ added in v1.6.0
func (i InitialMaxData) Value() []byte
type InitialMaxStreamDataBidiLocal ¶ added in v1.6.0
type InitialMaxStreamDataBidiLocal uint64
func (InitialMaxStreamDataBidiLocal) ID ¶ added in v1.6.0
func (InitialMaxStreamDataBidiLocal) ID() uint64
func (InitialMaxStreamDataBidiLocal) Value ¶ added in v1.6.0
func (i InitialMaxStreamDataBidiLocal) Value() []byte
type InitialMaxStreamDataBidiRemote ¶ added in v1.6.0
type InitialMaxStreamDataBidiRemote uint64
func (InitialMaxStreamDataBidiRemote) ID ¶ added in v1.6.0
func (InitialMaxStreamDataBidiRemote) ID() uint64
func (InitialMaxStreamDataBidiRemote) Value ¶ added in v1.6.0
func (i InitialMaxStreamDataBidiRemote) Value() []byte
type InitialMaxStreamDataUni ¶ added in v1.6.0
type InitialMaxStreamDataUni uint64
func (InitialMaxStreamDataUni) ID ¶ added in v1.6.0
func (InitialMaxStreamDataUni) ID() uint64
func (InitialMaxStreamDataUni) Value ¶ added in v1.6.0
func (i InitialMaxStreamDataUni) Value() []byte
type InitialMaxStreamsBidi ¶ added in v1.6.0
type InitialMaxStreamsBidi uint64
func (InitialMaxStreamsBidi) ID ¶ added in v1.6.0
func (InitialMaxStreamsBidi) ID() uint64
func (InitialMaxStreamsBidi) Value ¶ added in v1.6.0
func (i InitialMaxStreamsBidi) Value() []byte
type InitialMaxStreamsUni ¶ added in v1.6.0
type InitialMaxStreamsUni uint64
func (InitialMaxStreamsUni) ID ¶ added in v1.6.0
func (InitialMaxStreamsUni) ID() uint64
func (InitialMaxStreamsUni) Value ¶ added in v1.6.0
func (i InitialMaxStreamsUni) Value() []byte
type InitialSourceConnectionID ¶ added in v1.6.0
type InitialSourceConnectionID []byte // if empty, will be set to the Connection ID used for the Initial packet.
func (InitialSourceConnectionID) ID ¶ added in v1.6.0
func (InitialSourceConnectionID) ID() uint64
func (InitialSourceConnectionID) Value ¶ added in v1.6.0
func (i InitialSourceConnectionID) Value() []byte
type Initializable ¶ added in v1.6.0
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 ¶ added in v1.6.0
type KemPrivateKey struct { SecretKey kem.PrivateKey CurveID CurveID }
func (*KemPrivateKey) ToPrivate ¶ added in v1.6.0
func (kpk *KemPrivateKey) ToPrivate() *kemPrivateKey
type KeyShareExtension ¶
type KeyShareExtension struct {
}KeyShareExtension implements key_share (51) and is for TLS 1.3 only.
func (*KeyShareExtension) Len ¶
func (e *KeyShareExtension) Len() int
func (*KeyShareExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *KeyShareExtension) UnmarshalJSON(b []byte) error
type KeySharesParameters ¶ added in v1.6.0
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 ¶ added in v1.6.0
func NewKeySharesParameters() *KeySharesParameters
func (*KeySharesParameters) AddEcdheKeypair ¶ added in v1.6.0
func (ksp *KeySharesParameters) AddEcdheKeypair(curveID CurveID, ecdheKey *ecdh.PrivateKey, ecdhePubKey *ecdh.PublicKey)
func (*KeySharesParameters) AddKemKeypair ¶ added in v1.6.0
func (ksp *KeySharesParameters) AddKemKeypair(curveID CurveID, kemKey kem.PrivateKey, kemPubKey kem.PublicKey)
func (*KeySharesParameters) GetEcdheKey ¶ added in v1.6.0
func (ksp *KeySharesParameters) GetEcdheKey(curveID CurveID) (ecdheKey *ecdh.PrivateKey, ok bool)
func (*KeySharesParameters) GetEcdhePubkey ¶ added in v1.6.0
func (ksp *KeySharesParameters) GetEcdhePubkey(curveID CurveID) (params *ecdh.PublicKey, ok bool)
func (*KeySharesParameters) GetKemKey ¶ added in v1.6.0
func (ksp *KeySharesParameters) GetKemKey(curveID CurveID) (kemKey kem.PrivateKey, ok bool)
func (*KeySharesParameters) GetKemPubkey ¶ added in v1.6.0
func (ksp *KeySharesParameters) GetKemPubkey(curveID CurveID) (params kem.PublicKey, ok bool)
type LoadSessionTrackerState ¶ added in v1.6.0
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 ¶ added in v1.6.0
type MaxAckDelay uint64
func (MaxAckDelay) ID ¶ added in v1.6.0
func (MaxAckDelay) ID() uint64
func (MaxAckDelay) Value ¶ added in v1.6.0
func (m MaxAckDelay) Value() []byte
type MaxDatagramFrameSize ¶ added in v1.6.0
type MaxDatagramFrameSize uint64
func (MaxDatagramFrameSize) ID ¶ added in v1.6.0
func (MaxDatagramFrameSize) ID() uint64
func (MaxDatagramFrameSize) Value ¶ added in v1.6.0
func (m MaxDatagramFrameSize) Value() []byte
type MaxIdleTimeout ¶ added in v1.6.0
type MaxIdleTimeout uint64 // in milliseconds
func (MaxIdleTimeout) ID ¶ added in v1.6.0
func (MaxIdleTimeout) ID() uint64
func (MaxIdleTimeout) Value ¶ added in v1.6.0
func (m MaxIdleTimeout) Value() []byte
type MaxUDPPayloadSize ¶ added in v1.6.0
type MaxUDPPayloadSize uint64
func (MaxUDPPayloadSize) ID ¶ added in v1.6.0
func (MaxUDPPayloadSize) ID() uint64
func (MaxUDPPayloadSize) Value ¶ added in v1.6.0
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) UnmarshalJSON ¶ added in v1.6.0
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.
type PRNGSeed ¶
type PRNGSeed [PRNGSeedLength]byte
PRNGSeed is a PRNG seed.
func NewPRNGSeed ¶
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 ¶ added in v1.6.0
func (e *PSKKeyExchangeModesExtension) UnmarshalJSON(b []byte) error
type PaddingTransportParameter ¶ added in v1.6.0
type PaddingTransportParameter []byte
func (PaddingTransportParameter) ID ¶ added in v1.6.0
func (PaddingTransportParameter) ID() uint64
func (PaddingTransportParameter) Value ¶ added in v1.6.0
func (p PaddingTransportParameter) Value() []byte
type PreSharedKeyCommon ¶ added in v1.6.0
type PreSharedKeyCommon struct {}
type PreSharedKeyExtension ¶ added in v0.4.0
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 // It initializes the extension using a real and valid TLS 1.3 session. InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity) GetPreSharedKeyCommon() PreSharedKeyCommon // 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 ¶ added in v1.6.0
type PskIdentities []PskIdentity
func (PskIdentities) ToPrivate ¶ added in v1.6.0
func (PSS PskIdentities) ToPrivate() []pskIdentity
type PskIdentity ¶ added in v1.6.0
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 ¶ added in v1.5.8
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 ¶ added in v1.5.8
type PubClientHandshakeState ¶ added in v1.5.8
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 ¶ added in v1.5.8
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 EarlyData bool PskModes []uint8 PskIdentities []PskIdentity PskBinders [][]byte QuicTransportParameters []byte // contains filtered or unexported fields }
func UnmarshalClientHello ¶ added in v0.3.0
func UnmarshalClientHello(data []byte) *PubClientHelloMsg
UnmarshalClientHello allows external code to parse raw client hellos. It returns nil on failure.
func (*PubClientHelloMsg) Marshal ¶ added in v1.5.8
func (chm *PubClientHelloMsg) Marshal() ([]byte, error)
Marshal allows external code to convert a ClientHello object back into raw bytes.
type PubServerHelloMsg ¶ added in v1.5.8
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 SelectedIdentityPresent bool SelectedIdentity uint16 Cookie []byte // HelloRetryRequest extension SelectedGroup CurveID // HelloRetryRequest extension }
type QUICConfig ¶ added in v1.6.0
type QUICConfig struct {
TLSConfig *Config
}
A QUICConfig configures a QUICConn.
type QUICConn ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
Close closes the connection and stops any in-progress handshake.
func (*QUICConn) ConnectionState ¶ added in v1.6.0
func (q *QUICConn) ConnectionState() ConnectionState
ConnectionState returns basic TLS details about the connection.
func (*QUICConn) HandleData ¶ added in v1.6.0
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 NextEvent.
func (*QUICConn) NextEvent ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (q *QUICConn) 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 (*QUICConn) SetTransportParameters ¶ added in v1.6.0
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.
type QUICEncryptionLevel ¶ added in v1.6.0
type QUICEncryptionLevel int
QUICEncryptionLevel represents a QUIC encryption level used to transmit handshake messages.
func (QUICEncryptionLevel) String ¶ added in v1.6.0
func (l QUICEncryptionLevel) String() string
type QUICEvent ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
type QUICSessionTicketOptions struct { // EarlyData specifies whether the ticket may be used for 0-RTT. EarlyData bool }
type QUICTransportParametersExtension ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e *QUICTransportParametersExtension) Len() int
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 }
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 ¶ added in v1.6.0
func (e *RenegotiationInfoExtension) UnmarshalJSON(_ []byte) 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 ¶
NewRoller creates Roller object with default range of HelloIDs to cycle through until a working/unblocked one is found.
func (*Roller) Dial ¶
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
why 6 ? https://github.com/refraction-networking/utls/compare/master...Mathtin:utls:master
func (*SCTExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *SCTExtension) UnmarshalJSON(_ []byte) 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) UnmarshalJSON ¶ added in v1.6.0
func (e *SNIExtension) UnmarshalJSON(_ []byte) error
type SessionState ¶ added in v1.6.0
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 a 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 ¶ added in v1.6.0
func ParseSessionState(data []byte) (*SessionState, error)
ParseSessionState parses a SessionState encoded by SessionState.Bytes.
func (*SessionState) Bytes ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e *SessionTicketExtension) GetSession() *SessionState
func (*SessionTicketExtension) GetTicket ¶ added in v1.6.0
func (e *SessionTicketExtension) GetTicket() []byte
func (*SessionTicketExtension) InitializeByUtls ¶ added in v1.6.0
func (e *SessionTicketExtension) InitializeByUtls(session *SessionState, ticket []byte)
func (*SessionTicketExtension) IsInitialized ¶ added in v1.6.0
func (e *SessionTicketExtension) IsInitialized() bool
func (*SessionTicketExtension) Len ¶
func (e *SessionTicketExtension) Len() int
func (*SessionTicketExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *SessionTicketExtension) UnmarshalJSON(_ []byte) error
type SignatureAlgorithmsCertExtension ¶ added in v0.5.0
type SignatureAlgorithmsCertExtension struct {
SupportedSignatureAlgorithms []SignatureScheme
}
SignatureAlgorithmsCertExtension implements signature_algorithms_cert (50)
func (*SignatureAlgorithmsCertExtension) Len ¶ added in v0.5.0
func (e *SignatureAlgorithmsCertExtension) Len() int
func (*SignatureAlgorithmsCertExtension) Read ¶ added in v0.5.0
func (e *SignatureAlgorithmsCertExtension) Read(b []byte) (int, error)
func (*SignatureAlgorithmsCertExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *SignatureAlgorithmsCertExtension) UnmarshalJSON(data []byte) error
Copied from SignatureAlgorithmsExtension.UnmarshalJSON
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 ¶ added in v1.6.0
func (e *SignatureAlgorithmsExtension) UnmarshalJSON(data []byte) 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 SHA224_RSA SignatureScheme = 0x0301 SHA224_ECDSA SignatureScheme = 0x0303 )
var ( FakePKCS1WithSHA224 SignatureScheme = 0x0301 FakeECDSAWithSHA224 SignatureScheme = 0x0303 FakeSHA1WithDSA SignatureScheme = 0x0202 FakeSHA256WithDSA SignatureScheme = 0x0402 )
newest signatures
func (SignatureScheme) String ¶ added in v1.5.8
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) UnmarshalJSON ¶ added in v1.6.0
func (e *StatusRequestExtension) UnmarshalJSON(_ []byte) error
type StatusRequestV2Extension ¶ added in v0.5.0
type StatusRequestV2Extension struct { }
StatusRequestV2Extension implements status_request_v2 (17)
func (*StatusRequestV2Extension) Len ¶ added in v0.5.0
func (e *StatusRequestV2Extension) Len() int
func (*StatusRequestV2Extension) Read ¶ added in v0.5.0
func (e *StatusRequestV2Extension) Read(b []byte) (int, error)
func (*StatusRequestV2Extension) UnmarshalJSON ¶ added in v1.6.0
func (e *StatusRequestV2Extension) UnmarshalJSON(_ []byte) error
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 ¶ added in v1.6.0
func (e *SupportedCurvesExtension) UnmarshalJSON(data []byte) 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 ¶ added in v1.6.0
func (e *SupportedPointsExtension) UnmarshalJSON(data []byte) 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 ¶ added in v1.6.0
func (e *SupportedVersionsExtension) UnmarshalJSON(b []byte) 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 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 ¶ added in v1.6.0
func ExtensionFromID(id uint16) TLSExtension
ExtensionFromID returns a TLSExtension for the given extension ID.
func ShuffleChromeTLSExtensions ¶ added in v1.6.0
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 ¶ added in v1.6.0
type TLSExtensionJSON interface { TLSExtension // UnmarshalJSON unmarshals the JSON-encoded data into the extension. UnmarshalJSON([]byte) error }
type TLSExtensionWriter ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (e *TLSExtensionsJSONUnmarshaler) Extensions() []TLSExtension
func (*TLSExtensionsJSONUnmarshaler) UnmarshalJSON ¶ added in v1.6.0
func (e *TLSExtensionsJSONUnmarshaler) UnmarshalJSON(jsonStr []byte) error
type TicketKey ¶ added in v0.3.0
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 ¶ added in v0.3.0
type TicketKeys ¶ added in v0.3.0
type TicketKeys []TicketKey
func (TicketKeys) ToPrivate ¶ added in v0.3.0
func (TKS TicketKeys) ToPrivate() []ticketKey
type TransportParameter ¶ added in v1.6.0
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 ¶ added in v1.6.0
type TransportParameters []TransportParameter
func (TransportParameters) Marshal ¶ added in v1.6.0
func (tps TransportParameters) Marshal() []byte
type UConn ¶
type UConn struct { *Conn Extensions []TLSExtension ClientHelloID ClientHelloID HandshakeState PubClientHandshakeState WithRandomTLSExtensionOrder bool WithForceHttp1 bool // contains filtered or unexported fields }
func UClient ¶
func UClient(conn net.Conn, config *Config, clientHelloID ClientHelloID, withRandomTLSExtensionOrder bool, withForceHttp1 bool) *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) 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 ¶
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, amd should only be called explicitly to inspect/change fields of default/mimicked ClientHello.
func (*UConn) DidTls12Resume ¶ added in v1.6.0
func (*UConn) GetOutKeystream ¶
get current state of cipher and encrypt zeros to get keystream
func (*UConn) GetUnderlyingConn ¶
func (*UConn) Handshake ¶
Handshake runs the client handshake using given clientHandshakeState Requires hs.hello, and, optionally, hs.session to be set.
func (*UConn) HandshakeContext ¶ added in v1.5.8
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) QUICGetTransportParameters ¶ added in v1.6.0
func (*UConn) QUICSetReadSecret ¶ added in v1.6.0
func (uc *UConn) QUICSetReadSecret(level QUICEncryptionLevel, suite uint16, secret []byte)
func (*UConn) QUICSetWriteSecret ¶ added in v1.6.0
func (uc *UConn) QUICSetWriteSecret(level QUICEncryptionLevel, suite uint16, secret []byte)
func (*UConn) RemoveSNIExtension ¶ added in v0.3.0
RemoveSNIExtension removes SNI from the list of extensions sent in ClientHello It returns an error when used with HelloGolang ClientHelloID
func (*UConn) SetClientRandom ¶
SetClientRandom sets client random explicitly. BuildHandshakeFirst() must be called before SetClientRandom. r must to be 32 bytes long.
func (*UConn) SetPskExtension ¶ added in v1.6.0
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) 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 ¶ added in v1.6.0
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:
- Provided minTLSVers, maxTLSVers
- specExtensions may have SupportedVersionsExtension
- [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 ¶
type UQUICConn ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (q *UQUICConn) ApplyPreset(p *ClientHelloSpec) error
func (*UQUICConn) Close ¶ added in v1.6.0
Close closes the connection and stops any in-progress handshake.
func (*UQUICConn) ConnectionState ¶ added in v1.6.0
func (q *UQUICConn) ConnectionState() ConnectionState
ConnectionState returns basic TLS details about the connection.
func (*UQUICConn) HandleData ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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 ¶ added in v1.6.0
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.
type UnimplementedECHExtension ¶ added in v1.6.0
type UnimplementedECHExtension struct{}
func (*UnimplementedECHExtension) Configure ¶ added in v1.6.0
func (*UnimplementedECHExtension) Configure([]ECHConfig) error
func (*UnimplementedECHExtension) Len ¶ added in v1.6.0
func (*UnimplementedECHExtension) Len() int
func (*UnimplementedECHExtension) MarshalClientHello ¶ added in v1.6.0
func (*UnimplementedECHExtension) MarshalClientHello(*UConn) error
type UnimplementedPreSharedKeyExtension ¶ added in v1.6.0
type UnimplementedPreSharedKeyExtension struct{}
func (*UnimplementedPreSharedKeyExtension) GetPreSharedKeyCommon ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon
func (*UnimplementedPreSharedKeyExtension) InitializeByUtls ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)
func (*UnimplementedPreSharedKeyExtension) IsInitialized ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) IsInitialized() bool
func (*UnimplementedPreSharedKeyExtension) Len ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) Len() int
func (*UnimplementedPreSharedKeyExtension) PatchBuiltHello ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) PatchBuiltHello(hello *PubClientHelloMsg) error
func (*UnimplementedPreSharedKeyExtension) Read ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) Read([]byte) (int, error)
func (*UnimplementedPreSharedKeyExtension) SetOmitEmptyPsk ¶ added in v1.6.0
func (*UnimplementedPreSharedKeyExtension) SetOmitEmptyPsk(val bool)
type UtlsCompressCertExtension ¶ added in v0.3.0
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 ¶ added in v0.3.0
func (e *UtlsCompressCertExtension) Len() int
func (*UtlsCompressCertExtension) Read ¶ added in v0.3.0
func (e *UtlsCompressCertExtension) Read(b []byte) (int, error)
func (*UtlsCompressCertExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *UtlsCompressCertExtension) UnmarshalJSON(b []byte) 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) UnmarshalJSON ¶ added in v1.6.0
func (e *UtlsGREASEExtension) UnmarshalJSON(b []byte) 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) UnmarshalJSON ¶ added in v1.6.0
func (e *UtlsPaddingExtension) UnmarshalJSON(b []byte) error
func (*UtlsPaddingExtension) Update ¶
func (e *UtlsPaddingExtension) Update(clientHelloUnpaddedLen int)
type UtlsPreSharedKeyExtension ¶ added in v1.6.0
type UtlsPreSharedKeyExtension struct { bool // contains filtered or unexported fields }OmitEmptyPsk
UtlsPreSharedKeyExtension is an extension used to set the PSK extension in the ClientHello.
func (*UtlsPreSharedKeyExtension) GetPreSharedKeyCommon ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) GetPreSharedKeyCommon() PreSharedKeyCommon
func (*UtlsPreSharedKeyExtension) InitializeByUtls ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) InitializeByUtls(session *SessionState, earlySecret []byte, binderKey []byte, identities []PskIdentity)
func (*UtlsPreSharedKeyExtension) IsInitialized ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) IsInitialized() bool
func (*UtlsPreSharedKeyExtension) Len ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) Len() int
func (*UtlsPreSharedKeyExtension) PatchBuiltHello ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) PatchBuiltHello(hello *PubClientHelloMsg) error
func (*UtlsPreSharedKeyExtension) Read ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) Read(b []byte) (int, error)
func (*UtlsPreSharedKeyExtension) SetOmitEmptyPsk ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) SetOmitEmptyPsk(val bool)
func (*UtlsPreSharedKeyExtension) UnmarshalJSON ¶ added in v1.6.0
func (e *UtlsPreSharedKeyExtension) UnmarshalJSON(_ []byte) error
type VersionInformation ¶ added in v1.6.0
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 ¶ added in v1.6.0
func (*VersionInformation) GetGREASEVersion() uint32
func (*VersionInformation) ID ¶ added in v1.6.0
func (v *VersionInformation) ID() uint64
func (*VersionInformation) Value ¶ added in v1.6.0
func (v *VersionInformation) Value() []byte
type Weights ¶ added in v1.6.0
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 Extensions_Append_ALPS float64 }
Notes ¶
Bugs ¶
The crypto/tls package only implements some countermeasures against Lucky13 attacks on CBC-mode encryption, and only on SHA1 variants. See http://www.isg.rhul.ac.uk/tls/TLStiming.pdf and https://www.imperialviolet.org/2013/02/04/luckythirteen.html.
Source Files
¶
- alert.go
- auth.go
- cache.go
- cfkem.go
- cipher_suites.go
- common.go
- common_string.go
- conn.go
- handshake_client.go
- handshake_client_tls13.go
- handshake_messages.go
- handshake_server.go
- handshake_server_tls13.go
- key_agreement.go
- key_schedule.go
- notboring.go
- prf.go
- quic.go
- ticket.go
- tls.go
- tls_cf.go
- u_alias.go
- u_clienthello_json.go
- u_common.go
- u_conn.go
- u_ech.go
- u_ech_config.go
- u_fingerprinter.go
- u_handshake_client.go
- u_handshake_messages.go
- u_hpke.go
- u_parrots.go
- u_pre_shared_key.go
- u_prng.go
- u_public.go
- u_quic.go
- u_quic_transport_parameters.go
- u_roller.go
- u_session_controller.go
- u_session_ticket.go
- u_tls_extensions.go
Directories
¶
Path | Synopsis |
---|---|
examples
|
|
internal
|
|
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. |