Пакет tls
Обзор
Пакет tls частично реализует TLS 1.2, определённый в RFC 5246, и TLS 1.3, определённый в RFC 8446.
Режим FIPS 140-3
Когда программа работает в режиме FIPS 140-3, этот пакет ведёт себя так, как если бы были реализованы только версии протоколов, наборы шифров, алгоритмы подписи, типы и размеры открытых ключей сертификатов, а также алгоритмы обмена и выработки ключей, одобренные согласно SP 800-140C и SP 800-140D. Остальные варианты молча игнорируются и не согласовываются либо отклоняются. Этот набор может зависеть от алгоритмов, поддерживаемых криптографическим модулем Go FIPS 140-3, выбранным с помощью GOFIPS140, и может меняться в разных версиях Go.
Указатель
Примеры
Файлы пакета
alert.go auth.go cache.go cipher_suites.go common.go common_string.go conn.go defaults.go defaults_fips140.go ech.go handshake_client.go handshake_client_tls13.go handshake_messages.go handshake_server.go handshake_server_tls13.go key_agreement.go key_schedule.go prf.go quic.go ticket.go tls.go
Константы
Список идентификаторов наборов шифров, реализованных этим пакетом сейчас или ранее.
См. https://www.iana.org/assignments/tls-parameters/tls-parameters.xml
const (
// TLS 1.0 - 1.2 cipher suites.
TLS_RSA_WITH_RC4_128_SHA uint16 = 0x0005
TLS_RSA_WITH_3DES_EDE_CBC_SHA uint16 = 0x000a
TLS_RSA_WITH_AES_128_CBC_SHA uint16 = 0x002f
TLS_RSA_WITH_AES_256_CBC_SHA uint16 = 0x0035
TLS_RSA_WITH_AES_128_CBC_SHA256 uint16 = 0x003c
TLS_RSA_WITH_AES_128_GCM_SHA256 uint16 = 0x009c
TLS_RSA_WITH_AES_256_GCM_SHA384 uint16 = 0x009d
TLS_ECDHE_ECDSA_WITH_RC4_128_SHA uint16 = 0xc007
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA uint16 = 0xc009
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA uint16 = 0xc00a
TLS_ECDHE_RSA_WITH_RC4_128_SHA uint16 = 0xc011
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA uint16 = 0xc012
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA uint16 = 0xc013
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA uint16 = 0xc014
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 uint16 = 0xc023
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 uint16 = 0xc027
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 uint16 = 0xc02f
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 uint16 = 0xc02b
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 uint16 = 0xc030
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 uint16 = 0xc02c
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 uint16 = 0xcca8
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 uint16 = 0xcca9
// TLS 1.3 cipher suites.
TLS_AES_128_GCM_SHA256 uint16 = 0x1301
TLS_AES_256_GCM_SHA384 uint16 = 0x1302
TLS_CHACHA20_POLY1305_SHA256 uint16 = 0x1303
// TLS_FALLBACK_SCSV isn't a standard cipher suite but an indicator
// that the client is doing version fallback. See RFC 7507.
TLS_FALLBACK_SCSV uint16 = 0x5600
// Legacy names for the corresponding cipher suites with the correct _SHA256
// suffix, retained for backward compatibility.
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305 = TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 = TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
) 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 (
QUICEncryptionLevelInitial = QUICEncryptionLevel(iota)
QUICEncryptionLevelEarly
QUICEncryptionLevelHandshake
QUICEncryptionLevelApplication
) func CipherSuiteName 1.14
func CipherSuiteName(id uint16) string
CipherSuiteName возвращает стандартное имя для переданного идентификатора набора шифров (например, "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256") или альтернативное представление значения идентификатора, если этот набор шифров не реализован в пакете.
func Listen
func Listen(network, laddr string, config *Config) (net.Listener, error)
Listen создает TLS-слушатель, принимающий соединения по указанному сетевому адресу с помощью net.Listen. Конфигурация config не должна быть nil и должна содержать как минимум один сертификат либо задавать GetCertificate.
func NewListener
func NewListener(inner net.Listener, config *Config) net.Listener
NewListener создает Listener, который принимает соединения от внутреннего Listener и оборачивает каждое соединение в Server. Конфигурация config не должна быть nil и должна содержать как минимум один сертификат либо задавать GetCertificate.
func VersionName 1.21
func VersionName(version uint16) string
VersionName возвращает имя для указанного номера версии TLS (например, "TLS 1.3") или альтернативное представление значения, если эта версия не реализована в пакете.
type AlertError 1.21
AlertError представляет собой оповещение TLS.
При использовании транспорта QUIC методы QUICConn возвращают ошибку, оборачивающую AlertError, вместо отправки оповещения TLS.
type AlertError uint8
func (AlertError) Error 1.21
func (e AlertError) Error() string
type Certificate
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, Ed25519
// (TLS 1.2+), or ML-DSA (TLS 1.3) PublicKey.
//
// For a server up to TLS 1.2, it can also implement crypto.Decrypter with
// an RSA PublicKey.
//
// If it implements [crypto.MessageSigner], SignMessage will be used instead
// of Sign for TLS 1.2 and later.
PrivateKey crypto.PrivateKey
// SupportedSignatureAlgorithms is an optional list restricting what
// signature algorithms the PrivateKey can be used for.
SupportedSignatureAlgorithms []SignatureScheme // Go 1.14
// 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 // Go 1.5
// 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
}
func LoadX509KeyPair
func LoadX509KeyPair(certFile, keyFile string) (Certificate, error)
LoadX509KeyPair считывает и анализирует пару открытого и закрытого ключей из двух файлов. Файлы должны содержать данные в формате PEM. Файл сертификата может содержать промежуточные сертификаты после конечного сертификата, образуя цепочку сертификатов. При успешном возврате поле Certificate.Leaf будет заполнено.
Пример
Код:
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
func X509KeyPair
func X509KeyPair(certPEMBlock, keyPEMBlock []byte) (Certificate, error)
X509KeyPair анализирует пару открытого и закрытого ключей из двух фрагментов данных в формате PEM. При успешном возврате поле Certificate.Leaf будет заполнено.
Пример
Код:
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
Пример (HttpServer)
Код:
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("", ""))
type CertificateRequestInfo 1.8
CertificateRequestInfo содержит сведения из сообщения CertificateRequest сервера, которое используется для запроса сертификата и подтверждения владения им от клиента.
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 // Go 1.14
// contains filtered or unexported fields
}
func (*CertificateRequestInfo) Context 1.17
func (c *CertificateRequestInfo) Context() context.Context
Context возвращает контекст текущего рукопожатия. Этот контекст является дочерним по отношению к контексту, переданному в HandshakeContext, если он был передан, и отменяется по завершении рукопожатия.
func (*CertificateRequestInfo) SupportsCertificate 1.14
func (cri *CertificateRequestInfo) SupportsCertificate(c *Certificate) error
SupportsCertificate возвращает nil, если указанный сертификат поддерживается сервером, отправившим CertificateRequest. В противном случае возвращается ошибка с описанием причины несовместимости.
type CertificateVerificationError 1.20
CertificateVerificationError возвращается, если во время рукопожатия не удается проверить сертификат.
type CertificateVerificationError struct {
// UnverifiedCertificates and its contents should not be modified.
UnverifiedCertificates []*x509.Certificate
Err error
}
func (*CertificateVerificationError) Error 1.20
func (e *CertificateVerificationError) Error() string
func (*CertificateVerificationError) Unwrap 1.20
func (e *CertificateVerificationError) Unwrap() error
type CipherSuite 1.14
CipherSuite — это набор шифров TLS. Обратите внимание: большинство функций этого пакета принимают и возвращают идентификаторы наборов шифров, а не значения этого типа.
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
}
func CipherSuites 1.14
func CipherSuites() []*CipherSuite
CipherSuites возвращает список наборов шифров, реализованных в настоящее время этим пакетом, исключая наборы с проблемами безопасности; такие наборы возвращаются функцией InsecureCipherSuites.
Список отсортирован по идентификатору. Обратите внимание: наборы шифров, выбираемые пакетом по умолчанию, могут зависеть от логики, которую невозможно отразить в статическом списке, и могут отличаться от возвращаемых этой функцией.
func InsecureCipherSuites 1.14
func InsecureCipherSuites() []*CipherSuite
InsecureCipherSuites возвращает список наборов шифров, реализованных в настоящее время этим пакетом и имеющих проблемы безопасности.
Большинству приложений не следует использовать наборы шифров из этого списка; следует использовать только наборы, возвращаемые функцией CipherSuites.
type ClientAuthType
ClientAuthType определяет политику, которой сервер будет следовать при TLS-аутентификации клиента.
type ClientAuthType int
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 1.15
func (i ClientAuthType) String() string
type ClientHelloInfo 1.4
ClientHelloInfo содержит сведения из сообщения ClientHello, используемые для управления логикой приложения в функциях обратного вызова GetCertificate и GetConfigForClient.
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 key exchange mechanisms supported by the
// client. It was renamed to "supported groups" in TLS 1.3, see RFC 8446,
// Section 4.2.7 and [CurveID].
//
// SupportedCurves may be nil in TLS 1.2 and lower if the Supported Elliptic
// Curves Extension is not 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 // Go 1.8
// 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 // Go 1.8
// 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 // Go 1.8
// Extensions lists the IDs of the extensions presented by the client
// in the ClientHello.
Extensions []uint16 // Go 1.24
// 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 // Go 1.8
// HelloRetryRequest indicates whether the ClientHello was sent in response
// to a HelloRetryRequest message.
HelloRetryRequest bool // Go 1.26
// contains filtered or unexported fields
}
func (*ClientHelloInfo) Context 1.17
func (c *ClientHelloInfo) Context() context.Context
Context возвращает контекст выполняющегося в данный момент рукопожатия. Этот контекст является дочерним по отношению к контексту, переданному в HandshakeContext, если он был передан, и отменяется по завершении рукопожатия.
func (*ClientHelloInfo) SupportsCertificate 1.14
func (chi *ClientHelloInfo) SupportsCertificate(c *Certificate) error
SupportsCertificate возвращает nil, если предоставленный сертификат поддерживается клиентом, отправившим ClientHello. В противном случае возвращается ошибка с описанием причины несовместимости.
Если этот ClientHelloInfo был передан в callback GetConfigForClient или GetCertificate, этот метод учитывает связанную с ним Config. Обратите внимание: если GetConfigForClient возвращает другую Config, этот метод не сможет учесть это изменение.
Эта функция вызывает x509.ParseCertificate, если не задано c.Leaf, что может привести к значительным затратам производительности.
type ClientSessionCache 1.3
ClientSessionCache — это кэш объектов ClientSessionState, который клиент может использовать для возобновления TLS-сеанса с указанным сервером. Реализации ClientSessionCache должны быть готовы к одновременным вызовам из разных горутин. До TLS 1.2 поддерживалось возобновление только на основе билетов, но не на основе SessionID. В TLS 1.3 они были объединены в режимы PSK, поддерживаемые этим интерфейсом.
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)
} func NewLRUClientSessionCache 1.3
func NewLRUClientSessionCache(capacity int) ClientSessionCache
NewLRUClientSessionCache возвращает ClientSessionCache с указанной емкостью, использующий стратегию LRU. Если емкость меньше 1, вместо нее используется емкость по умолчанию.
type ClientSessionState 1.3
ClientSessionState содержит состояние, необходимое клиенту для возобновления предыдущего TLS-сеанса.
type ClientSessionState struct {
// contains filtered or unexported fields
}
func NewResumptionState 1.21
func NewResumptionState(ticket []byte, state *SessionState) (*ClientSessionState, error)
NewResumptionState возвращает значение состояния, которое можно вернуть из ClientSessionCache.Get для возобновления предыдущего сеанса.
state должно быть возвращено из ParseSessionState, а билет и состояние сеанса должны быть возвращены из ClientSessionState.ResumptionState.
func (*ClientSessionState) ResumptionState 1.21
func (cs *ClientSessionState) ResumptionState() (ticket []byte, state *SessionState, err error)
ResumptionState возвращает билет сеанса, отправленный сервером (также известный как идентификатор сеанса), и состояние, необходимое для возобновления этого сеанса.
Этот метод можно вызвать из ClientSessionCache.Put, чтобы сериализовать (с помощью SessionState.Bytes) и сохранить сеанс.
type Config
Структура Config используется для настройки TLS-клиента или сервера. После передачи функции TLS ее нельзя изменять. Config можно использовать повторно; пакет tls также не изменяет ее.
type Config struct {
// Rand provides the source of entropy for the connection.
// If Rand is nil, TLS uses the cryptographic random reader in package
// crypto/rand. The Reader must be safe for use by multiple goroutines.
//
// Deprecated: this should be left nil in production. Not all TLS
// configurations are guaranteed to use Rand. Test code can use
// [testing/cryptotest.SetGlobalRandom] instead.
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) // Go 1.4
// 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) // Go 1.8
// 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 is explicitly set on the returned Config, or if
// SetSessionTicketKeys is 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). WARNING: this allows session
// resumption of connections originally established with the parent (or a
// sibling) Config, which may bypass the [Config.VerifyPeerCertificate]
// value of the returned Config.
GetConfigForClient func(*ClientHelloInfo) (*Config, error) // Go 1.8
// 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. WARNING: this
// includes connections resumed across Configs returned by [Config.Clone] or
// [Config.GetConfigForClient] and their parents. If that is not intended,
// use [Config.VerifyConnection] instead, or set [Config.SessionTicketsDisabled].
//
// verifiedChains and its contents should not be modified.
VerifyPeerCertificate func(rawCerts [][]byte, verifiedChains [][]*x509.Certificate) error // Go 1.8
// 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 // Go 1.15
// 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
// 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
// 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 // Go 1.1
// 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 // Go 1.1
// 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 // Go 1.1
// ClientSessionCache is a cache of ClientSessionState entries for TLS
// session resumption. It is only used by clients.
ClientSessionCache ClientSessionCache // Go 1.3
// 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) // Go 1.21
// 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) // Go 1.21
// MinVersion contains the minimum TLS version that is acceptable.
//
// By default, TLS 1.2 is currently used as the minimum. TLS 1.0 is the
// minimum supported by this package.
MinVersion uint16 // Go 1.2
// 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 // Go 1.2
// CurvePreferences contains a set of supported key exchange mechanisms.
// The name refers to elliptic curves for legacy reasons, see [CurveID].
// The order of the list is ignored, and key exchange mechanisms are chosen
// from this list using an internal preference order. If empty, the default
// will be used.
//
// From Go 1.24, the default includes the [X25519MLKEM768] hybrid
// post-quantum key exchange. To disable it, set CurvePreferences explicitly
// or use the GODEBUG=tlsmlkem=0 environment variable.
//
// From Go 1.26, the default includes the [SecP256r1MLKEM768] and
// [SecP384r1MLKEM1024] hybrid post-quantum key exchanges, too. To disable
// them, set CurvePreferences explicitly or use either the
// GODEBUG=tlsmlkem=0 or the GODEBUG=tlssecpmlkem=0 environment variable.
CurvePreferences []CurveID // Go 1.3
// 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 // Go 1.7
// Renegotiation controls what types of renegotiation are supported.
// The default, none, is correct for the vast majority of applications.
Renegotiation RenegotiationSupport // Go 1.7
// 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://datatracker.ietf.org/doc/draft-ietf-tls-keylogfile/.
// Use of KeyLogWriter compromises security and should only be
// used for debugging.
KeyLogWriter io.Writer // Go 1.8
// EncryptedClientHelloConfigList is a serialized ECHConfigList. If
// provided, clients will attempt to connect to servers using Encrypted
// Client Hello (ECH) using one of the provided ECHConfigs.
//
// Servers do not use this field. In order to configure ECH for servers, see
// the EncryptedClientHelloKeys field.
//
// If the list contains no valid ECH configs, the handshake will fail
// and return an error.
//
// If EncryptedClientHelloConfigList is set, MinVersion, if set, must
// be VersionTLS13.
//
// When EncryptedClientHelloConfigList is set, the handshake will only
// succeed if ECH is successfully negotiated. If the server rejects ECH,
// an ECHRejectionError error will be returned, which may contain a new
// ECHConfigList that the server suggests using.
//
// How this field is parsed may change in future Go versions, if the
// encoding described in the final Encrypted Client Hello RFC changes.
EncryptedClientHelloConfigList []byte // Go 1.23
// EncryptedClientHelloRejectionVerify, if not nil, is called when ECH is
// rejected by the remote server, in order to verify the ECH provider
// certificate in the outer ClientHello. If it returns a non-nil error, the
// handshake is aborted and that error results.
//
// On the server side this field is not used.
//
// Unlike VerifyPeerCertificate and VerifyConnection, normal certificate
// verification will not be performed before calling
// EncryptedClientHelloRejectionVerify.
//
// If EncryptedClientHelloRejectionVerify is nil and ECH is rejected, the
// roots in RootCAs will be used to verify the ECH providers public
// certificate. VerifyPeerCertificate and VerifyConnection are not called
// when ECH is rejected, even if set, and InsecureSkipVerify is ignored.
EncryptedClientHelloRejectionVerify func(ConnectionState) error // Go 1.23
// GetEncryptedClientHelloKeys, if not nil, is called when by a server when
// a client attempts ECH.
//
// If GetEncryptedClientHelloKeys is not nil, [EncryptedClientHelloKeys] is
// ignored.
//
// If GetEncryptedClientHelloKeys returns an error, the handshake will be
// aborted and the error will be returned. Otherwise,
// GetEncryptedClientHelloKeys must return a non-nil slice of
// [EncryptedClientHelloKey] that represents the acceptable ECH keys.
//
// For further details, see [EncryptedClientHelloKeys].
GetEncryptedClientHelloKeys func(*ClientHelloInfo) ([]EncryptedClientHelloKey, error) // Go 1.25
// EncryptedClientHelloKeys are the ECH keys to use when a client
// attempts ECH.
//
// If EncryptedClientHelloKeys is set, MinVersion, if set, must be
// VersionTLS13.
//
// If a client attempts ECH, but it is rejected by the server, the server
// will send a list of configs to retry based on the set of
// EncryptedClientHelloKeys which have the SendAsRetry field set.
//
// If GetEncryptedClientHelloKeys is non-nil, EncryptedClientHelloKeys is
// ignored.
//
// On the client side, this field is ignored. In order to configure ECH for
// clients, see the EncryptedClientHelloConfigList field.
EncryptedClientHelloKeys []EncryptedClientHelloKey // Go 1.24
// contains filtered or unexported fields
}
Пример (KeyLogWriter)
Код:
// Debugging TLS applications by decrypting a network traffic capture.
// WARNING: Use of KeyLogWriter compromises security and should only be
// used for debugging.
server := httptest.NewUnstartedServer(http.HandlerFunc(
func(w http.ResponseWriter, r *http.Request) {}))
server.StartTLS()
defer server.Close()
pool := x509.NewCertPool()
pool.AddCert(server.Certificate())
// 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,
RootCAs: pool,
},
},
}
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.
Пример (VerifyConnection)
Код:
// 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.
func (*Config) BuildNameToCertificate
func (c *Config) BuildNameToCertificate()
BuildNameToCertificate анализирует c.Certificates и формирует c.NameToCertificate на основе полей CommonName и SubjectAlternateName каждого сертификата конечного субъекта.
Устарело: NameToCertificate позволяет связать с заданным именем только один сертификат. Оставьте это поле равным nil, чтобы библиотека выбрала первую совместимую цепочку из Certificates.
func (*Config) Clone 1.8
func (c *Config) Clone() *Config
Clone возвращает поверхностную копию c или nil, если c равно nil. Можно безопасно клонировать Config, одновременно используемую TLS-клиентом или сервером.
Возвращаемая Config может совместно использовать ключи билетов сеанса с исходной Config, что означает возможность возобновления соединений между этими двумя Config. ВНИМАНИЕ: Config.VerifyPeerCertificate не вызывается для возобновленных соединений, включая соединения, изначально установленные с родительской Config. Если это нежелательно, используйте вместо этого Config.VerifyConnection или задайте Config.SessionTicketsDisabled.
func (*Config) DecryptTicket 1.21
func (c *Config) DecryptTicket(identity []byte, cs ConnectionState) (*SessionState, error)
DecryptTicket расшифровывает билет, зашифрованный с помощью Config.EncryptTicket. Этот метод можно использовать в качестве реализации Config.UnwrapSession.
Если билет не удается расшифровать или разобрать, DecryptTicket возвращает (nil, nil).
func (*Config) EncryptTicket 1.21
func (c *Config) EncryptTicket(cs ConnectionState, ss *SessionState) ([]byte, error)
EncryptTicket шифрует билет с помощью настроенных (или используемых по умолчанию) ключей билетов сеанса Config. Этот метод можно использовать в качестве реализации Config.WrapSession.
func (*Config) SetSessionTicketKeys 1.5
func (c *Config) SetSessionTicketKeys(keys [][32]byte)
SetSessionTicketKeys обновляет ключи билетов сеанса для сервера.
Первый ключ будет использоваться при создании новых билетов, а все ключи можно использовать для расшифровки билетов. Эту функцию можно безопасно вызывать во время работы сервера для ротации ключей билетов сеанса. Если keys пуст, функция вызывает панику.
Вызов этой функции отключает автоматическую ротацию ключей билетов сеанса.
Если несколько серверов завершают соединения для одного и того же хоста, у них должны быть одинаковые ключи билетов сеанса. Утечка ключей билетов сеанса может поставить под угрозу ранее записанные и будущие TLS-соединения, использующие эти ключи.
type Conn
Conn представляет защищенное соединение. Он реализует интерфейс net.Conn.
type Conn struct {
// contains filtered or unexported fields
}
func Client
func Client(conn net.Conn, config *Config) *Conn
Client возвращает новое соединение на стороне TLS-клиента, использующее conn в качестве базового транспорта. config не может быть равен nil: пользователь должен задать в конфигурации либо ServerName, либо InsecureSkipVerify.
func Dial
func Dial(network, addr string, config *Config) (*Conn, error)
Dial устанавливает соединение с указанным сетевым адресом с помощью net.Dial, затем инициирует TLS-рукопожатие и возвращает полученное TLS-соединение. Dial считает nil-конфигурацию эквивалентной нулевой конфигурации; значения по умолчанию см. в документации Config.
Пример
Код:
// 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()
func DialWithDialer 1.3
func DialWithDialer(dialer *net.Dialer, network, addr string, config *Config) (*Conn, error)
DialWithDialer подключается к указанному сетевому адресу с помощью dialer.Dial, а затем выполняет рукопожатие TLS и возвращает полученное TLS-соединение. Любые тайм-ауты или крайние сроки, заданные в dialer, применяются ко всему процессу подключения и рукопожатия TLS.
DialWithDialer трактует nil-конфигурацию как нулевую конфигурацию; значения по умолчанию см. в документации Config.
DialWithDialer использует внутри context.Background; чтобы указать контекст, используйте Dialer.DialContext, задав нужный dialer в NetDialer.
func Server
func Server(conn net.Conn, config *Config) *Conn
Server возвращает новое серверное TLS-соединение, использующее conn в качестве базового транспорта. Конфигурация config не должна быть nil и должна содержать хотя бы один сертификат; в противном случае необходимо задать GetCertificate.
func (*Conn) Close
func (c *Conn) Close() error
Close закрывает соединение.
func (*Conn) CloseWrite 1.8
func (c *Conn) CloseWrite() error
CloseWrite отключает запись в соединение. Вызывать этот метод следует только после завершения рукопожатия; он не вызывает CloseWrite для базового соединения. В большинстве случаев достаточно использовать Conn.Close.
func (*Conn) ConnectionState
func (c *Conn) ConnectionState() ConnectionState
ConnectionState возвращает основные сведения TLS о соединении.
Возвращаемое значение ConnectionState имеет смысл только после завершения рукопожатия, о котором сообщает ConnectionState.HandshakeComplete; до этого его поля не заполнены. Рукопожатие выполняется автоматически при первом вызове Conn.Read или Conn.Write, либо его можно запустить явно с помощью Conn.Handshake.
func (*Conn) Handshake
func (c *Conn) Handshake() error
Handshake выполняет протокол рукопожатия клиента или сервера, если он ещё не был выполнен.
В большинстве случаев при использовании этого пакета не нужно вызывать Handshake явно: первый вызов Conn.Read или Conn.Write сделает это автоматически.
Чтобы управлять отменой рукопожатия или задавать для него тайм-аут, используйте Conn.HandshakeContext либо метод DialContext у Dialer.
Для защиты от атак типа «отказ в обслуживании» максимальный размер ключа RSA в сертификатах, отправляемых сервером или клиентом TLS, ограничен 8192 битами. Это ограничение можно изменить, задав tlsmaxrsasize в переменной окружения GODEBUG (например, GODEBUG=tlsmaxrsasize=4096).
func (*Conn) HandshakeContext 1.17
func (c *Conn) HandshakeContext(ctx context.Context) error
HandshakeContext выполняет протокол рукопожатия клиента или сервера, если он ещё не был выполнен.
Переданный Context не должен быть nil. Если контекст отменён до завершения рукопожатия, рукопожатие прерывается и возвращается ошибка. После завершения рукопожатия отмена контекста не повлияет на соединение.
В большинстве случаев при использовании этого пакета не нужно вызывать HandshakeContext явно: первый вызов Conn.Read или Conn.Write сделает это автоматически.
func (*Conn) LocalAddr
func (c *Conn) LocalAddr() net.Addr
LocalAddr возвращает локальный сетевой адрес.
func (*Conn) NetConn 1.18
func (c *Conn) NetConn() net.Conn
NetConn возвращает базовое соединение, обёрнутое в c. Учтите, что непосредственная запись в это соединение или чтение из него нарушит работу сеанса TLS.
func (*Conn) OCSPResponse
func (c *Conn) OCSPResponse() []byte
OCSPResponse возвращает прикреплённый ответ OCSP от TLS-сервера, если он есть. (Действительно только для клиентских соединений.)
func (*Conn) Read
func (c *Conn) Read(b []byte) (int, error)
Read читает данные из соединения.
Поскольку Read вызывает Conn.Handshake, чтобы избежать бесконечной блокировки, до вызова Read необходимо задать крайний срок как для Read, так и для Conn.Write, если рукопожатие ещё не завершено. См. Conn.SetDeadline, Conn.SetReadDeadline и Conn.SetWriteDeadline.
func (*Conn) RemoteAddr
func (c *Conn) RemoteAddr() net.Addr
RemoteAddr возвращает удалённый сетевой адрес.
func (*Conn) SetDeadline
func (c *Conn) SetDeadline(t time.Time) error
SetDeadline задаёт крайние сроки чтения и записи для соединения. Нулевое значение t означает, что Conn.Read и Conn.Write не будут завершаться по тайм-ауту. Если для Write истёк тайм-аут, состояние TLS становится некорректным, и все последующие операции записи будут возвращать ту же ошибку.
func (*Conn) SetReadDeadline
func (c *Conn) SetReadDeadline(t time.Time) error
SetReadDeadline задаёт крайний срок чтения для базового соединения. Нулевое значение t означает, что Conn.Read не будет завершаться по тайм-ауту.
func (*Conn) SetWriteDeadline
func (c *Conn) SetWriteDeadline(t time.Time) error
SetWriteDeadline задаёт крайний срок записи для базового соединения. Нулевое значение t означает, что Conn.Write не будет завершаться по тайм-ауту. Если для Conn.Write истёк тайм-аут, состояние TLS становится некорректным, и все последующие операции записи будут возвращать ту же ошибку.
func (*Conn) VerifyHostname
func (c *Conn) VerifyHostname(host string) error
VerifyHostname проверяет, подходит ли цепочка сертификатов узла для подключения к host. Если подходит, метод возвращает nil; в противном случае возвращается ошибка с описанием проблемы.
func (*Conn) Write
func (c *Conn) Write(b []byte) (int, error)
Write записывает данные в соединение.
Поскольку Write вызывает Conn.Handshake, чтобы избежать бесконечной блокировки, до вызова Write необходимо задать крайний срок как для Conn.Read, так и для Write, если рукопожатие ещё не завершено. См. Conn.SetDeadline, Conn.SetReadDeadline и Conn.SetWriteDeadline.
type ConnectionState
ConnectionState содержит основные сведения TLS о соединении.
type ConnectionState struct {
// Version is the TLS version used by the connection (e.g. VersionTLS12).
Version uint16 // Go 1.3
// 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 // Go 1.1
// 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
// CurveID is the key exchange mechanism used for the connection. The name
// refers to elliptic curves for legacy reasons, see [CurveID]. If a legacy
// RSA key exchange is used, this value is zero.
CurveID CurveID // Go 1.25
// 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
// 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 // Go 1.5
// OCSPResponse is a stapled Online Certificate Status Protocol (OCSP)
// response provided by the peer for the leaf certificate, if any.
OCSPResponse []byte // Go 1.5
// 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 // Go 1.4
// ECHAccepted indicates if Encrypted Client Hello was offered by the client
// and accepted by the server. Currently, ECH is supported only on the
// client side.
ECHAccepted bool // Go 1.23
// HelloRetryRequest indicates whether we sent a HelloRetryRequest if we
// are a server, or if we received a HelloRetryRequest if we are a client.
HelloRetryRequest bool // Go 1.26
// LocalCertificate is the certificate chain presented to the peer, if any,
// during the handshake. This field is only populated for connections which
// are not resumed (DidResume is false).
LocalCertificate [][]byte // Go 1.27
// contains filtered or unexported fields
}
func (*ConnectionState) ExportKeyingMaterial 1.11
func (cs *ConnectionState) ExportKeyingMaterial(label string, context []byte, length int) ([]byte, error)
ExportKeyingMaterial возвращает в новом срезе length байт экспортированного ключевого материала, определённого в RFC 5705. Если context равен nil, он не используется как часть начального значения. Если для соединения разрешена повторная аутентификация через Config.Renegotiation или оно не поддерживает ни TLS 1.3, ни Extended Master Secret, функция возвращает ошибку.
type CurveID 1.3
CurveID — это тип идентификатора TLS для механизма обмена ключами. См. https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8.
В TLS 1.2 этот реестр поддерживал только эллиптические кривые. В TLS 1.3 он был расширен за счёт других групп и переименован в NamedGroup. См. RFC 8446, раздел 4.2.7. Позже он был также расширен за счёт других механизмов, таких как гибридные постквантовые KEM.
type CurveID uint16
const (
CurveP256 CurveID = 23
CurveP384 CurveID = 24
CurveP521 CurveID = 25
X25519 CurveID = 29
X25519MLKEM768 CurveID = 4588
SecP256r1MLKEM768 CurveID = 4587
SecP384r1MLKEM1024 CurveID = 4589
MLKEM1024 CurveID = 514
) func (CurveID) String 1.15
func (i CurveID) String() string
type Dialer 1.15
Dialer устанавливает TLS-соединения, используя конфигурацию и Dialer для базового соединения.
type Dialer struct {
// NetDialer is the optional dialer to use for the TLS connections'
// underlying TCP connections.
// A nil NetDialer is equivalent to the net.Dialer zero value.
NetDialer *net.Dialer
// Config is the TLS configuration to use for new connections.
// A nil configuration is equivalent to the zero
// configuration; see the documentation of Config for the
// defaults.
Config *Config
}
func (*Dialer) Dial 1.15
func (d *Dialer) Dial(network, addr string) (net.Conn, error)
Dial подключается к указанному сетевому адресу и инициирует TLS-рукопожатие, возвращая полученное TLS-соединение.
Возвращаемое значение Conn, если оно есть, всегда будет иметь тип *Conn.
Dial использует внутри себя context.Background; чтобы указать контекст, используйте Dialer.DialContext.
func (*Dialer) DialContext 1.15
func (d *Dialer) DialContext(ctx context.Context, network, addr string) (net.Conn, error)
DialContext подключается к указанному сетевому адресу и инициирует TLS-рукопожатие, возвращая полученное TLS-соединение.
Передаваемый Context не должен быть nil. Если срок действия контекста истекает до завершения соединения, возвращается ошибка. После успешного установления соединения истечение срока действия контекста не влияет на соединение.
Возвращаемое значение Conn, если оно есть, всегда будет иметь тип *Conn.
type ECHRejectionError 1.23
ECHRejectionError — это тип ошибки, возвращаемой, когда удалённый сервер отклоняет ECH. Если сервер предложил ECHConfigList для повторных попыток, поле RetryConfigList будет содержать этот список.
Клиент может считать ECHRejectionError с пустым набором RetryConfigs безопасным сигналом от сервера.
type ECHRejectionError struct {
RetryConfigList []byte
}
func (*ECHRejectionError) Error 1.23
func (e *ECHRejectionError) Error() string
type EncryptedClientHelloKey 1.24
EncryptedClientHelloKey содержит закрытый ключ, связанный с определённой конфигурацией ECH, известной клиенту.
type EncryptedClientHelloKey struct {
// Config should be a marshalled ECHConfig associated with PrivateKey. This
// must match the config provided to clients byte-for-byte. The config must
// use as KEM one of
//
// - DHKEM(P-256, HKDF-SHA256) (0x0010)
// - DHKEM(P-384, HKDF-SHA384) (0x0011)
// - DHKEM(P-521, HKDF-SHA512) (0x0012)
// - DHKEM(X25519, HKDF-SHA256) (0x0020)
// - ML-KEM-768 (0x0041)
// - ML-KEM-1024 (0x0042)
// - MLKEM768-P256 (0x0050)
// - MLKEM1024-P384 (0x0051)
// - MLKEM768-X25519 (0x647a)
//
// and as KDF one of
//
// - HKDF-SHA256 (0x0001)
// - HKDF-SHA384 (0x0002)
// - HKDF-SHA512 (0x0003)
//
// and as AEAD one of
//
// - AES-128-GCM (0x0001)
// - AES-256-GCM (0x0002)
// - ChaCha20Poly1305 (0x0003)
//
Config []byte
// PrivateKey should be a marshalled private key, in the format expected by
// HPKE's DeserializePrivateKey (see RFC 9180), for the KEM used in Config.
PrivateKey []byte
// SendAsRetry indicates if Config should be sent as part of the list of
// retry configs when ECH is requested by the client but rejected by the
// server.
SendAsRetry bool
}
type QUICConfig 1.21
QUICConfig задаёт конфигурацию для QUICConn.
type QUICConfig struct {
TLSConfig *Config
// EnableSessionEvents may be set to true to enable the
// [QUICStoreSession] and [QUICResumeSession] events for client connections.
// When this event is enabled, sessions are not automatically
// stored in the client session cache.
// The application should use [QUICConn.StoreSession] to store sessions.
EnableSessionEvents bool // Go 1.23
// ClientHelloInfoConn is the net.Conn to use for the ClientHelloInfo.Conn field.
ClientHelloInfoConn net.Conn // Go 1.27
}
type QUICConn 1.21
QUICConn представляет соединение, использующее реализацию QUIC в качестве базового транспорта, как описано в RFC 9001.
Методы QUICConn небезопасны для параллельного использования.
type QUICConn struct {
// contains filtered or unexported fields
}
func QUICClient 1.21
func QUICClient(config *QUICConfig) *QUICConn
QUICClient возвращает новое соединение TLS на стороне клиента, использующее QUICTransport в качестве базового транспорта. Конфигурация не может быть nil.
func QUICServer 1.21
func QUICServer(config *QUICConfig) *QUICConn
QUICServer возвращает новое соединение TLS на стороне сервера, использующее QUICTransport в качестве базового транспорта. Конфигурация не может быть nil.
func (*QUICConn) Close 1.21
func (q *QUICConn) Close() error
Close закрывает соединение и останавливает любое выполняющееся рукопожатие.
func (*QUICConn) ConnectionState 1.21
func (q *QUICConn) ConnectionState() ConnectionState
ConnectionState возвращает основные сведения TLS о соединении.
func (*QUICConn) HandleData 1.21
func (q *QUICConn) HandleData(level QUICEncryptionLevel, data []byte) error
HandleData обрабатывает байты рукопожатия, полученные от узла-партнёра. При этом могут возникать события соединения, которые можно прочитать с помощью QUICConn.NextEvent.
func (*QUICConn) NextEvent 1.21
func (q *QUICConn) NextEvent() QUICEvent
NextEvent возвращает следующее событие, происходящее в соединении. Если доступных событий нет, он возвращает событие с Kind, равным QUICNoEvent.
func (*QUICConn) SendSessionTicket 1.21
func (q *QUICConn) SendSessionTicket(opts QUICSessionTicketOptions) error
SendSessionTicket отправляет клиенту билет сеанса. При этом возникают события соединения, которые можно прочитать с помощью QUICConn.NextEvent. В настоящее время этот метод можно вызвать только один раз.
func (*QUICConn) SetTransportParameters 1.21
func (q *QUICConn) SetTransportParameters(params []byte)
SetTransportParameters задаёт транспортные параметры для отправки узлу-партнёру.
Серверные соединения могут отложить задание транспортных параметров до получения транспортных параметров клиента. См. QUICTransportParametersRequired.
func (*QUICConn) Start 1.21
func (q *QUICConn) Start(ctx context.Context) error
Start запускает протокол рукопожатия клиента или сервера. При этом могут возникать события соединения, которые можно прочитать с помощью QUICConn.NextEvent.
Start можно вызвать не более одного раза.
func (*QUICConn) StoreSession 1.23
func (q *QUICConn) StoreSession(session *SessionState) error
StoreSession сохраняет сеанс, ранее полученный в событии QUICStoreSession, в ClientSessionCache. Приложение может обработать дополнительные события или изменить SessionState перед сохранением сеанса.
type QUICEncryptionLevel 1.21
QUICEncryptionLevel представляет уровень шифрования QUIC, используемый для передачи сообщений рукопожатия.
type QUICEncryptionLevel int
func (QUICEncryptionLevel) String 1.21
func (l QUICEncryptionLevel) String() string
type QUICEvent 1.21
QUICEvent — это событие, происходящее в QUIC-соединении.
Тип события задаётся полем Kind. Содержимое остальных полей зависит от типа события.
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
// Set for QUICResumeSession and QUICStoreSession.
SessionState *SessionState // Go 1.23
// Set for QUICErrorEvent.
// The error will wrap AlertError.
Err error // Go 1.26
}
type QUICEventKind 1.21
QUICEventKind — это тип операции в QUIC-соединении.
type QUICEventKind int
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.
// This event only occurs on client connections.
QUICRejectedEarlyData
// QUICHandshakeDone indicates that the TLS handshake has completed.
QUICHandshakeDone
// QUICResumeSession indicates that a client is attempting to resume a previous session.
// [QUICEvent.SessionState] is set.
//
// For client connections, this event occurs when the session ticket is selected.
// For server connections, this event occurs when receiving the client's session ticket.
//
// The application may set [QUICEvent.SessionState.EarlyData] to false before the
// next call to [QUICConn.NextEvent] to decline 0-RTT even if the session supports it.
QUICResumeSession
// QUICStoreSession indicates that the server has provided state permitting
// the client to resume the session.
// [QUICEvent.SessionState] is set.
// The application should use [QUICConn.StoreSession] session to store the [SessionState].
// The application may modify the [SessionState] before storing it.
// This event only occurs on client connections.
QUICStoreSession
// QUICErrorEvent indicates that a fatal error has occurred.
// The handshake cannot proceed and the connection must be closed.
// QUICEvent.Err is set.
QUICErrorEvent
) type QUICSessionTicketOptions 1.21
type QUICSessionTicketOptions struct {
// EarlyData specifies whether the ticket may be used for 0-RTT.
EarlyData bool
Extra [][]byte // Go 1.23
}
type RecordHeaderError 1.6
RecordHeaderError возвращается, когда заголовок записи TLS недействителен.
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 // Go 1.12
}
func (RecordHeaderError) Error 1.6
func (e RecordHeaderError) Error() string
type RenegotiationSupport 1.7
RenegotiationSupport перечисляет различные уровни поддержки повторного согласования TLS. Повторное согласование TLS — это выполнение последующих рукопожатий в соединении после первого. Это значительно усложняет конечный автомат и стало причиной множества трудноуловимых проблем безопасности. Инициировать повторное согласование нельзя, но можно включить поддержку принятия запросов на повторное согласование.
Даже если эта поддержка включена, сервер не может менять свою идентичность между рукопожатиями (то есть конечный сертификат должен оставаться тем же). Кроме того, параллельная передача данных рукопожатия и данных приложения не допускается, поэтому повторное согласование можно использовать только с протоколами, синхронизирующимися с ним, например HTTPS.
Повторное согласование не определено в TLS 1.3.
type RenegotiationSupport int
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 SessionState 1.21
SessionState — это возобновляемый сеанс.
type SessionState struct {
// Extra is ignored by crypto/tls, but is encoded by [SessionState.Bytes]
// and parsed by [ParseSessionState].
//
// This allows [Config.UnwrapSession]/[Config.WrapSession] and
// [ClientSessionCache] implementations to store and retrieve additional
// data alongside this session.
//
// To allow different layers in a protocol stack to share this field,
// applications must only append to it, not replace it, and must use entries
// that can be recognized even if out of order (for example, by starting
// with an id and version prefix).
Extra [][]byte
// EarlyData indicates whether the ticket can be used for 0-RTT in a QUIC
// connection. The application may set this to false if it is true to
// decline to offer 0-RTT even if supported.
EarlyData bool
// contains filtered or unexported fields
}
func ParseSessionState 1.21
func ParseSessionState(data []byte) (*SessionState, error)
ParseSessionState разбирает SessionState, закодированный методом SessionState.Bytes.
func (*SessionState) Bytes 1.21
func (s *SessionState) Bytes() ([]byte, error)
Bytes кодирует сеанс, включая любые закрытые поля, чтобы его можно было разобрать с помощью ParseSessionState. Кодировка содержит секретные значения, критически важные для безопасности будущих и, возможно, прошлых сеансов.
Конкретную кодировку следует считать непрозрачной; она может несовместимо изменяться между версиями Go.
type SignatureScheme 1.8
SignatureScheme определяет алгоритм подписи, поддерживаемый TLS. См. RFC 8446, раздел 4.2.3.
type SignatureScheme uint16
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
// ML-DSA algorithms.
MLDSA44 SignatureScheme = 0x0904
MLDSA65 SignatureScheme = 0x0905
MLDSA87 SignatureScheme = 0x0906
// Legacy signature and hash algorithms for TLS 1.2.
PKCS1WithSHA1 SignatureScheme = 0x0201
ECDSAWithSHA1 SignatureScheme = 0x0203
) func (SignatureScheme) String 1.15
func (i SignatureScheme) String() string
Ошибки
- ☞
Пакет crypto/tls реализует лишь некоторые меры противодействия атакам Lucky13 на шифрование в режиме CBC и только для вариантов с SHA1. См. http://www.isg.rhul.ac.uk/tls/TLStiming.pdf и https://www.imperialviolet.org/2013/02/04/luckythirteen.html.
Подкаталоги
| Имя | Описание |
|---|---|
| .. | |
| fipsonly | Пакет fipsonly ограничивает все настройки TLS параметрами, одобренными FIPS. |
© Google, Inc.
Licensed under the Creative Commons Attribution License 3.0.
http://golang.org/pkg/crypto/tls/
