blob: 9bd9c772be818cedb293480ac4090069ecc958ec [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001// Copyright 2009 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
Adam Langleydc7e9c42015-09-29 15:21:04 -07005package runner
Adam Langley95c29f32014-06-20 12:00:00 -07006
7import (
8 "container/list"
9 "crypto"
David Benjamind30a9902014-08-24 01:44:23 -040010 "crypto/ecdsa"
Adam Langley95c29f32014-06-20 12:00:00 -070011 "crypto/rand"
12 "crypto/x509"
13 "fmt"
14 "io"
15 "math/big"
16 "strings"
17 "sync"
18 "time"
19)
20
21const (
22 VersionSSL30 = 0x0300
23 VersionTLS10 = 0x0301
24 VersionTLS11 = 0x0302
25 VersionTLS12 = 0x0303
Nick Harper1fd39d82016-06-14 18:14:35 -070026 VersionTLS13 = 0x0304
Adam Langley95c29f32014-06-20 12:00:00 -070027)
28
David Benjamin353577c2017-06-29 15:54:58 -040029const (
30 VersionDTLS10 = 0xfeff
31 VersionDTLS12 = 0xfefd
32)
33
Steven Valdezfdd10992016-09-15 16:27:05 -040034// A draft version of TLS 1.3 that is sent over the wire for the current draft.
Steven Valdeza833c352016-11-01 13:39:36 -040035const tls13DraftVersion = 0x7f12
Nick Harper4d90c102016-07-17 10:53:26 +020036
Steven Valdezc94998a2017-06-20 10:55:02 -040037var allTLSWireVersions = []uint16{
38 tls13DraftVersion,
39 VersionTLS12,
40 VersionTLS11,
41 VersionTLS10,
42 VersionSSL30,
43}
44
45var allDTLSWireVersions = []uint16{
46 VersionDTLS12,
47 VersionDTLS10,
48}
49
Adam Langley95c29f32014-06-20 12:00:00 -070050const (
David Benjamin83c0bc92014-08-04 01:23:53 -040051 maxPlaintext = 16384 // maximum plaintext payload length
52 maxCiphertext = 16384 + 2048 // maximum ciphertext payload length
53 tlsRecordHeaderLen = 5 // record header length
54 dtlsRecordHeaderLen = 13
55 maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB)
Adam Langley95c29f32014-06-20 12:00:00 -070056
57 minVersion = VersionSSL30
Nick Harper1fd39d82016-06-14 18:14:35 -070058 maxVersion = VersionTLS13
Adam Langley95c29f32014-06-20 12:00:00 -070059)
60
61// TLS record types.
62type recordType uint8
63
64const (
65 recordTypeChangeCipherSpec recordType = 20
66 recordTypeAlert recordType = 21
67 recordTypeHandshake recordType = 22
68 recordTypeApplicationData recordType = 23
69)
70
71// TLS handshake message types.
72const (
David Benjamincedff872016-06-30 18:55:18 -040073 typeHelloRequest uint8 = 0
74 typeClientHello uint8 = 1
75 typeServerHello uint8 = 2
76 typeHelloVerifyRequest uint8 = 3
77 typeNewSessionTicket uint8 = 4
David Benjamina128a552016-10-13 14:26:33 -040078 typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-16
79 typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040080 typeCertificate uint8 = 11
81 typeServerKeyExchange uint8 = 12
82 typeCertificateRequest uint8 = 13
83 typeServerHelloDone uint8 = 14
84 typeCertificateVerify uint8 = 15
85 typeClientKeyExchange uint8 = 16
86 typeFinished uint8 = 20
87 typeCertificateStatus uint8 = 22
David Benjamina128a552016-10-13 14:26:33 -040088 typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040089 typeNextProtocol uint8 = 67 // Not IANA assigned
90 typeChannelID uint8 = 203 // Not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070091)
92
93// TLS compression types.
94const (
95 compressionNone uint8 = 0
96)
97
98// TLS extension numbers
99const (
David Benjamin61f95272014-11-25 01:55:35 -0500100 extensionServerName uint16 = 0
101 extensionStatusRequest uint16 = 5
102 extensionSupportedCurves uint16 = 10
103 extensionSupportedPoints uint16 = 11
104 extensionSignatureAlgorithms uint16 = 13
105 extensionUseSRTP uint16 = 14
106 extensionALPN uint16 = 16
107 extensionSignedCertificateTimestamp uint16 = 18
108 extensionExtendedMasterSecret uint16 = 23
109 extensionSessionTicket uint16 = 35
David Benjamina128a552016-10-13 14:26:33 -0400110 extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-16
111 extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-16
112 extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-16
Steven Valdezfdd10992016-09-15 16:27:05 -0400113 extensionSupportedVersions uint16 = 43 // draft-ietf-tls-tls13-16
David Benjamina128a552016-10-13 14:26:33 -0400114 extensionCookie uint16 = 44 // draft-ietf-tls-tls13-16
Steven Valdeza833c352016-11-01 13:39:36 -0400115 extensionPSKKeyExchangeModes uint16 = 45 // draft-ietf-tls-tls13-18
Steven Valdez08b65f42016-12-07 15:29:45 -0500116 extensionTicketEarlyDataInfo uint16 = 46 // draft-ietf-tls-tls13-18
David Benjamin399e7c92015-07-30 23:01:27 -0400117 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -0500118 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
119 extensionRenegotiationInfo uint16 = 0xff01
120 extensionChannelID uint16 = 30032 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700121)
122
123// TLS signaling cipher suite values
124const (
125 scsvRenegotiation uint16 = 0x00ff
126)
127
128// CurveID is the type of a TLS identifier for an elliptic curve. See
129// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
130type CurveID uint16
131
132const (
David Benjamincba2b622015-12-18 22:13:41 -0500133 CurveP224 CurveID = 21
134 CurveP256 CurveID = 23
135 CurveP384 CurveID = 24
136 CurveP521 CurveID = 25
137 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700138)
139
140// TLS Elliptic Curve Point Formats
141// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
142const (
David Benjamina81967b2016-12-22 09:16:57 -0500143 pointFormatUncompressed uint8 = 0
144 pointFormatCompressedPrime uint8 = 1
Adam Langley95c29f32014-06-20 12:00:00 -0700145)
146
147// TLS CertificateStatusType (RFC 3546)
148const (
149 statusTypeOCSP uint8 = 1
150)
151
152// Certificate types (for certificateRequestMsg)
153const (
David Benjamin7b030512014-07-08 17:30:11 -0400154 CertTypeRSASign = 1 // A certificate containing an RSA key
155 CertTypeDSSSign = 2 // A certificate containing a DSA key
156 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
157 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700158
159 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400160 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
161 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
162 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700163
164 // Rest of these are reserved by the TLS spec
165)
166
Nick Harper60edffd2016-06-21 15:19:24 -0700167// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
168// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
169// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
170// algorithms' throughout. We match the latter.
171type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700172
Adam Langley95c29f32014-06-20 12:00:00 -0700173const (
Nick Harper60edffd2016-06-21 15:19:24 -0700174 // RSASSA-PKCS1-v1_5 algorithms
175 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
176 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
177 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
178 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
179 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700180
Nick Harper60edffd2016-06-21 15:19:24 -0700181 // ECDSA algorithms
182 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
183 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
184 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
185 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
186
187 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400188 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
189 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
190 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700191
192 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400193 signatureEd25519 signatureAlgorithm = 0x0807
194 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700195)
Adam Langley95c29f32014-06-20 12:00:00 -0700196
David Benjamin7a41d372016-07-09 11:21:54 -0700197// supportedSignatureAlgorithms contains the default supported signature
198// algorithms.
199var supportedSignatureAlgorithms = []signatureAlgorithm{
200 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700201 signatureRSAPKCS1WithSHA256,
202 signatureECDSAWithP256AndSHA256,
203 signatureRSAPKCS1WithSHA1,
204 signatureECDSAWithSHA1,
David Benjamind768c5d2017-03-28 18:28:44 -0500205 signatureEd25519,
Adam Langley95c29f32014-06-20 12:00:00 -0700206}
207
David Benjaminca6c8262014-11-15 19:06:08 -0500208// SRTP protection profiles (See RFC 5764, section 4.1.2)
209const (
210 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
211 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
212)
213
David Benjamina128a552016-10-13 14:26:33 -0400214// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200215const (
Steven Valdez5b986082016-09-01 12:29:49 -0400216 pskKEMode = 0
217 pskDHEKEMode = 1
218)
219
Steven Valdezc4aa7272016-10-03 12:25:56 -0400220// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
221const (
222 keyUpdateNotRequested = 0
223 keyUpdateRequested = 1
224)
225
Adam Langley95c29f32014-06-20 12:00:00 -0700226// ConnectionState records basic TLS details about the connection.
227type ConnectionState struct {
228 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
229 HandshakeComplete bool // TLS handshake is complete
230 DidResume bool // connection resumes a previous TLS connection
231 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
232 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
233 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400234 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700235 ServerName string // server name requested by client, if any (server side only)
236 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
237 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400238 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500239 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400240 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100241 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700242 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400243 CurveID CurveID // the curve used in ECDHE
Adam Langley95c29f32014-06-20 12:00:00 -0700244}
245
246// ClientAuthType declares the policy the server will follow for
247// TLS Client Authentication.
248type ClientAuthType int
249
250const (
251 NoClientCert ClientAuthType = iota
252 RequestClientCert
253 RequireAnyClientCert
254 VerifyClientCertIfGiven
255 RequireAndVerifyClientCert
256)
257
258// ClientSessionState contains the state needed by clients to resume TLS
259// sessions.
260type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500261 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700262 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
263 vers uint16 // SSL/TLS version negotiated for the session
264 cipherSuite uint16 // Ciphersuite negotiated for the session
265 masterSecret []byte // MasterSecret generated by client on a full handshake
266 handshakeHash []byte // Handshake hash for Channel ID purposes.
267 serverCertificates []*x509.Certificate // Certificate chain presented by the server
268 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100269 sctList []byte
270 ocspResponse []byte
Steven Valdez2d850622017-01-11 11:34:52 -0500271 earlyALPN string
Nick Harper0b3625b2016-07-25 16:16:28 -0700272 ticketCreationTime time.Time
273 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400274 ticketAgeAdd uint32
Nick Harperf2511f12016-12-06 16:02:31 -0800275 maxEarlyDataSize uint32
Adam Langley95c29f32014-06-20 12:00:00 -0700276}
277
278// ClientSessionCache is a cache of ClientSessionState objects that can be used
279// by a client to resume a TLS session with a given server. ClientSessionCache
280// implementations should expect to be called concurrently from different
281// goroutines.
282type ClientSessionCache interface {
283 // Get searches for a ClientSessionState associated with the given key.
284 // On return, ok is true if one was found.
285 Get(sessionKey string) (session *ClientSessionState, ok bool)
286
287 // Put adds the ClientSessionState to the cache with the given key.
288 Put(sessionKey string, cs *ClientSessionState)
289}
290
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500291// ServerSessionCache is a cache of sessionState objects that can be used by a
292// client to resume a TLS session with a given server. ServerSessionCache
293// implementations should expect to be called concurrently from different
294// goroutines.
295type ServerSessionCache interface {
296 // Get searches for a sessionState associated with the given session
297 // ID. On return, ok is true if one was found.
298 Get(sessionId string) (session *sessionState, ok bool)
299
300 // Put adds the sessionState to the cache with the given session ID.
301 Put(sessionId string, session *sessionState)
302}
303
Adam Langley95c29f32014-06-20 12:00:00 -0700304// A Config structure is used to configure a TLS client or server.
305// After one has been passed to a TLS function it must not be
306// modified. A Config may be reused; the tls package will also not
307// modify it.
308type Config struct {
309 // Rand provides the source of entropy for nonces and RSA blinding.
310 // If Rand is nil, TLS uses the cryptographic random reader in package
311 // crypto/rand.
312 // The Reader must be safe for use by multiple goroutines.
313 Rand io.Reader
314
315 // Time returns the current time as the number of seconds since the epoch.
316 // If Time is nil, TLS uses time.Now.
317 Time func() time.Time
318
319 // Certificates contains one or more certificate chains
320 // to present to the other side of the connection.
321 // Server configurations must include at least one certificate.
322 Certificates []Certificate
323
324 // NameToCertificate maps from a certificate name to an element of
325 // Certificates. Note that a certificate name can be of the form
326 // '*.example.com' and so doesn't have to be a domain name as such.
327 // See Config.BuildNameToCertificate
328 // The nil value causes the first element of Certificates to be used
329 // for all connections.
330 NameToCertificate map[string]*Certificate
331
332 // RootCAs defines the set of root certificate authorities
333 // that clients use when verifying server certificates.
334 // If RootCAs is nil, TLS uses the host's root CA set.
335 RootCAs *x509.CertPool
336
337 // NextProtos is a list of supported, application level protocols.
338 NextProtos []string
339
340 // ServerName is used to verify the hostname on the returned
341 // certificates unless InsecureSkipVerify is given. It is also included
342 // in the client's handshake to support virtual hosting.
343 ServerName string
344
345 // ClientAuth determines the server's policy for
346 // TLS Client Authentication. The default is NoClientCert.
347 ClientAuth ClientAuthType
348
349 // ClientCAs defines the set of root certificate authorities
350 // that servers use if required to verify a client certificate
351 // by the policy in ClientAuth.
352 ClientCAs *x509.CertPool
353
David Benjamin7b030512014-07-08 17:30:11 -0400354 // ClientCertificateTypes defines the set of allowed client certificate
355 // types. The default is CertTypeRSASign and CertTypeECDSASign.
356 ClientCertificateTypes []byte
357
Adam Langley95c29f32014-06-20 12:00:00 -0700358 // InsecureSkipVerify controls whether a client verifies the
359 // server's certificate chain and host name.
360 // If InsecureSkipVerify is true, TLS accepts any certificate
361 // presented by the server and any host name in that certificate.
362 // In this mode, TLS is susceptible to man-in-the-middle attacks.
363 // This should be used only for testing.
364 InsecureSkipVerify bool
365
366 // CipherSuites is a list of supported cipher suites. If CipherSuites
367 // is nil, TLS uses a list of suites supported by the implementation.
368 CipherSuites []uint16
369
370 // PreferServerCipherSuites controls whether the server selects the
371 // client's most preferred ciphersuite, or the server's most preferred
372 // ciphersuite. If true then the server's preference, as expressed in
373 // the order of elements in CipherSuites, is used.
374 PreferServerCipherSuites bool
375
376 // SessionTicketsDisabled may be set to true to disable session ticket
377 // (resumption) support.
378 SessionTicketsDisabled bool
379
380 // SessionTicketKey is used by TLS servers to provide session
381 // resumption. See RFC 5077. If zero, it will be filled with
382 // random data before the first server handshake.
383 //
384 // If multiple servers are terminating connections for the same host
385 // they should all have the same SessionTicketKey. If the
386 // SessionTicketKey leaks, previously recorded and future TLS
387 // connections using that key are compromised.
388 SessionTicketKey [32]byte
389
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500390 // ClientSessionCache is a cache of ClientSessionState entries
391 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700392 ClientSessionCache ClientSessionCache
393
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500394 // ServerSessionCache is a cache of sessionState entries for TLS session
395 // resumption.
396 ServerSessionCache ServerSessionCache
397
Adam Langley95c29f32014-06-20 12:00:00 -0700398 // MinVersion contains the minimum SSL/TLS version that is acceptable.
399 // If zero, then SSLv3 is taken as the minimum.
400 MinVersion uint16
401
402 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
403 // If zero, then the maximum version supported by this package is used,
404 // which is currently TLS 1.2.
405 MaxVersion uint16
406
407 // CurvePreferences contains the elliptic curves that will be used in
408 // an ECDHE handshake, in preference order. If empty, the default will
409 // be used.
410 CurvePreferences []CurveID
411
Nick Harperdcfbc672016-07-16 17:47:31 +0200412 // DefaultCurves contains the elliptic curves for which public values will
413 // be sent in the ClientHello's KeyShare extension. If this value is nil,
414 // all supported curves will have public values sent. This field is ignored
415 // on servers.
416 DefaultCurves []CurveID
417
David Benjamind30a9902014-08-24 01:44:23 -0400418 // ChannelID contains the ECDSA key for the client to use as
419 // its TLS Channel ID.
420 ChannelID *ecdsa.PrivateKey
421
422 // RequestChannelID controls whether the server requests a TLS
423 // Channel ID. If negotiated, the client's public key is
424 // returned in the ConnectionState.
425 RequestChannelID bool
426
David Benjamin48cae082014-10-27 01:06:24 -0400427 // PreSharedKey, if not nil, is the pre-shared key to use with
428 // the PSK cipher suites.
429 PreSharedKey []byte
430
431 // PreSharedKeyIdentity, if not empty, is the identity to use
432 // with the PSK cipher suites.
433 PreSharedKeyIdentity string
434
Nick Harperab20cec2016-12-19 17:38:41 -0800435 // MaxEarlyDataSize controls the maximum number of bytes that the
436 // server will accept in early data and advertise in a
437 // NewSessionTicketMsg. If 0, no early data will be accepted and
438 // the TicketEarlyDataInfo extension in the NewSessionTicketMsg
439 // will be omitted.
440 MaxEarlyDataSize uint32
441
David Benjaminca6c8262014-11-15 19:06:08 -0500442 // SRTPProtectionProfiles, if not nil, is the list of SRTP
443 // protection profiles to offer in DTLS-SRTP.
444 SRTPProtectionProfiles []uint16
445
David Benjamin7a41d372016-07-09 11:21:54 -0700446 // SignSignatureAlgorithms, if not nil, overrides the default set of
447 // supported signature algorithms to sign with.
448 SignSignatureAlgorithms []signatureAlgorithm
449
450 // VerifySignatureAlgorithms, if not nil, overrides the default set of
451 // supported signature algorithms that are accepted.
452 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500453
Adam Langley95c29f32014-06-20 12:00:00 -0700454 // Bugs specifies optional misbehaviour to be used for testing other
455 // implementations.
456 Bugs ProtocolBugs
457
458 serverInitOnce sync.Once // guards calling (*Config).serverInit
459}
460
461type BadValue int
462
463const (
464 BadValueNone BadValue = iota
465 BadValueNegative
466 BadValueZero
467 BadValueLimit
468 BadValueLarge
469 NumBadValues
470)
471
David Benjaminb36a3952015-12-01 18:53:13 -0500472type RSABadValue int
473
474const (
475 RSABadValueNone RSABadValue = iota
476 RSABadValueCorrupt
477 RSABadValueTooLong
478 RSABadValueTooShort
479 RSABadValueWrongVersion
480 NumRSABadValues
481)
482
Adam Langley95c29f32014-06-20 12:00:00 -0700483type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400484 // InvalidSignature specifies that the signature in a ServerKeyExchange
485 // or CertificateVerify message should be invalid.
486 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400487
Steven Valdez5440fe02016-07-18 12:40:30 -0400488 // SendCurve, if non-zero, causes the server to send the specified curve
489 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
490 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400491 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700492
David Benjamin2b07fa42016-03-02 00:23:57 -0500493 // InvalidECDHPoint, if true, causes the ECC points in
494 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
495 InvalidECDHPoint bool
496
Adam Langley95c29f32014-06-20 12:00:00 -0700497 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
498 // can be invalid.
499 BadECDSAR BadValue
500 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700501
502 // MaxPadding causes CBC records to have the maximum possible padding.
503 MaxPadding bool
504 // PaddingFirstByteBad causes the first byte of the padding to be
505 // incorrect.
506 PaddingFirstByteBad bool
507 // PaddingFirstByteBadIf255 causes the first byte of padding to be
508 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
509 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700510
511 // FailIfNotFallbackSCSV causes a server handshake to fail if the
512 // client doesn't send the fallback SCSV value.
513 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400514
515 // DuplicateExtension causes an extra empty extension of bogus type to
516 // be emitted in either the ClientHello or the ServerHello.
517 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400518
519 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
520 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
521 // Certificate message is sent and no signature is added to
522 // ServerKeyExchange.
523 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400524
David Benjaminb80168e2015-02-08 18:30:14 -0500525 // SkipHelloVerifyRequest causes a DTLS server to skip the
526 // HelloVerifyRequest message.
527 SkipHelloVerifyRequest bool
528
David Benjamindcd979f2015-04-20 18:26:52 -0400529 // SkipCertificateStatus, if true, causes the server to skip the
530 // CertificateStatus message. This is legal because CertificateStatus is
531 // optional, even with a status_request in ServerHello.
532 SkipCertificateStatus bool
533
David Benjamin9c651c92014-07-12 13:27:45 -0400534 // SkipServerKeyExchange causes the server to skip sending
535 // ServerKeyExchange messages.
536 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400537
David Benjaminb80168e2015-02-08 18:30:14 -0500538 // SkipNewSessionTicket causes the server to skip sending the
539 // NewSessionTicket message despite promising to in ServerHello.
540 SkipNewSessionTicket bool
541
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500542 // SkipClientCertificate causes the client to skip the Certificate
543 // message.
544 SkipClientCertificate bool
545
David Benjamina0e52232014-07-19 17:39:58 -0400546 // SkipChangeCipherSpec causes the implementation to skip
547 // sending the ChangeCipherSpec message (and adjusting cipher
548 // state accordingly for the Finished message).
549 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400550
David Benjaminb80168e2015-02-08 18:30:14 -0500551 // SkipFinished causes the implementation to skip sending the Finished
552 // message.
553 SkipFinished bool
554
David Benjamin32c89272017-03-26 13:54:21 -0500555 // SkipEndOfEarlyData causes the implementation to skip the
556 // end_of_early_data alert.
557 SkipEndOfEarlyData bool
558
David Benjaminf3ec83d2014-07-21 22:42:34 -0400559 // EarlyChangeCipherSpec causes the client to send an early
560 // ChangeCipherSpec message before the ClientKeyExchange. A value of
561 // zero disables this behavior. One and two configure variants for 0.9.8
562 // and 1.0.1 modes, respectively.
563 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400564
David Benjamin8144f992016-06-22 17:05:13 -0400565 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
566 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
567 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
568 StrayChangeCipherSpec bool
569
David Benjamin86271ee2014-07-21 16:14:03 -0400570 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
571 // the Finished (or NextProto) message around the ChangeCipherSpec
572 // messages.
573 FragmentAcrossChangeCipherSpec bool
574
David Benjamin61672812016-07-14 23:10:43 -0400575 // SendUnencryptedFinished, if true, causes the Finished message to be
576 // send unencrypted before ChangeCipherSpec rather than after it.
577 SendUnencryptedFinished bool
578
David Benjamin7964b182016-07-14 23:36:30 -0400579 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
580 // 1.3 server to send part of EncryptedExtensions unencrypted
581 // in the same record as ServerHello.
582 PartialEncryptedExtensionsWithServerHello bool
583
584 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
585 // client to send part of Finished unencrypted in the same record as
586 // ClientHello.
587 PartialClientFinishedWithClientHello bool
588
David Benjamind86c7672014-08-02 04:07:12 -0400589 // SendV2ClientHello causes the client to send a V2ClientHello
590 // instead of a normal ClientHello.
591 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400592
593 // SendFallbackSCSV causes the client to include
594 // TLS_FALLBACK_SCSV in the ClientHello.
595 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400596
Adam Langley5021b222015-06-12 18:27:58 -0700597 // SendRenegotiationSCSV causes the client to include the renegotiation
598 // SCSV in the ClientHello.
599 SendRenegotiationSCSV bool
600
David Benjamin43ec06f2014-08-05 02:28:57 -0400601 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400602 // handshake record. Handshake messages will be split into multiple
603 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400604 // never be fragmented. For DTLS, it is the maximum handshake fragment
605 // size, not record size; DTLS allows multiple handshake fragments in a
606 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400607 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400608
David Benjamin98214542014-08-07 18:02:39 -0400609 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
610 // the first 6 bytes of the ClientHello.
611 FragmentClientVersion bool
612
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400613 // FragmentAlert will cause all alerts to be fragmented across
614 // two records.
615 FragmentAlert bool
616
David Benjamin0d3a8c62016-03-11 22:25:18 -0500617 // DoubleAlert will cause all alerts to be sent as two copies packed
618 // within one record.
619 DoubleAlert bool
620
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500621 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
622 // alert to be sent.
623 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400624
David Benjaminb36a3952015-12-01 18:53:13 -0500625 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
626 // ClientKeyExchange which would not pass padding checks.
627 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400628
629 // RenewTicketOnResume causes the server to renew the session ticket and
630 // send a NewSessionTicket message during an abbreviated handshake.
631 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400632
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400633 // SendClientVersion, if non-zero, causes the client to send the
634 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400635 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400636
Steven Valdezfdd10992016-09-15 16:27:05 -0400637 // OmitSupportedVersions, if true, causes the client to omit the
638 // supported versions extension.
639 OmitSupportedVersions bool
640
641 // SendSupportedVersions, if non-empty, causes the client to send a
642 // supported versions extension with the values from array.
643 SendSupportedVersions []uint16
644
David Benjamin1f61f0d2016-07-10 12:20:35 -0400645 // NegotiateVersion, if non-zero, causes the server to negotiate the
Steven Valdezc94998a2017-06-20 10:55:02 -0400646 // specifed wire version rather than the version supported by either
David Benjamin1f61f0d2016-07-10 12:20:35 -0400647 // peer.
648 NegotiateVersion uint16
649
David Benjamine7e36aa2016-08-08 12:39:41 -0400650 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
Steven Valdezc94998a2017-06-20 10:55:02 -0400651 // the specified wire version on renegotiation rather than retaining it.
David Benjamine7e36aa2016-08-08 12:39:41 -0400652 NegotiateVersionOnRenego uint16
653
David Benjamine58c4f52014-08-24 03:47:07 -0400654 // ExpectFalseStart causes the server to, on full handshakes,
655 // expect the peer to False Start; the server Finished message
656 // isn't sent until we receive an application data record
657 // from the peer.
658 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400659
David Benjamin1c633152015-04-02 20:19:11 -0400660 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
661 // handshakes, send an alert just before reading the application data
662 // record to test False Start. This can be used in a negative False
663 // Start test to determine whether the peer processed the alert (and
664 // closed the connection) before or after sending app data.
665 AlertBeforeFalseStartTest alert
666
David Benjamine78bfde2014-09-06 12:45:15 -0400667 // ExpectServerName, if not empty, is the hostname the client
668 // must specify in the server_name extension.
669 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400670
David Benjamin76c2efc2015-08-31 14:24:29 -0400671 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
672 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400673 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400674
Adam Langleyefb0e162015-07-09 11:35:04 -0700675 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
676 // return.
677 ALPNProtocol *string
678
David Benjamin405da482016-08-08 17:25:07 -0400679 // AcceptAnySession causes the server to resume sessions regardless of
680 // the version associated with the session or cipher suite. It also
681 // causes the server to look in both TLS 1.2 and 1.3 extensions to
682 // process a ticket.
683 AcceptAnySession bool
684
685 // SendBothTickets, if true, causes the client to send tickets in both
686 // TLS 1.2 and 1.3 extensions.
687 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700688
David Benjamin4199b0d2016-11-01 13:58:25 -0400689 // FilterTicket, if not nil, causes the client to modify a session
690 // ticket before sending it in a resume handshake.
691 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700692
David Benjamind4c349b2017-02-09 14:07:17 -0500693 // TicketSessionIDLength, if non-zero, is the length of the session ID
694 // to send with a ticket resumption offer.
695 TicketSessionIDLength int
696
697 // EmptyTicketSessionID, if true, causes the client to send an empty
698 // session ID with a ticket resumption offer. For simplicity, this will
699 // also cause the client to interpret a ServerHello with empty session
700 // ID as a resumption. (A client which sends empty session ID is
701 // normally expected to look ahead for ChangeCipherSpec.)
702 EmptyTicketSessionID bool
Adam Langley75712922014-10-10 16:23:43 -0700703
David Benjamin405da482016-08-08 17:25:07 -0400704 // ExpectNoTLS12Session, if true, causes the server to fail the
705 // connection if either a session ID or TLS 1.2 ticket is offered.
706 ExpectNoTLS12Session bool
707
708 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
709 // if a TLS 1.3 PSK is offered.
710 ExpectNoTLS13PSK bool
711
Adam Langley75712922014-10-10 16:23:43 -0700712 // RequireExtendedMasterSecret, if true, requires that the peer support
713 // the extended master secret option.
714 RequireExtendedMasterSecret bool
715
David Benjaminca6554b2014-11-08 12:31:52 -0500716 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400717 // they didn't support an extended master secret in the initial
718 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700719 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700720
David Benjamin163c9562016-08-29 23:14:17 -0400721 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
722 // behave as if they didn't support an extended master secret in
723 // renegotiation handshakes.
724 NoExtendedMasterSecretOnRenegotiation bool
725
Adam Langley2ae77d22014-10-28 17:29:33 -0700726 // EmptyRenegotiationInfo causes the renegotiation extension to be
727 // empty in a renegotiation handshake.
728 EmptyRenegotiationInfo bool
729
730 // BadRenegotiationInfo causes the renegotiation extension value in a
731 // renegotiation handshake to be incorrect.
732 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500733
David Benjamin3e052de2015-11-25 20:10:31 -0500734 // NoRenegotiationInfo disables renegotiation info support in all
735 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500736 NoRenegotiationInfo bool
737
David Benjamin3e052de2015-11-25 20:10:31 -0500738 // NoRenegotiationInfoInInitial disables renegotiation info support in
739 // the initial handshake.
740 NoRenegotiationInfoInInitial bool
741
742 // NoRenegotiationInfoAfterInitial disables renegotiation info support
743 // in renegotiation handshakes.
744 NoRenegotiationInfoAfterInitial bool
745
Adam Langley5021b222015-06-12 18:27:58 -0700746 // RequireRenegotiationInfo, if true, causes the client to return an
747 // error if the server doesn't reply with the renegotiation extension.
748 RequireRenegotiationInfo bool
749
David Benjamin8e6db492015-07-25 18:29:23 -0400750 // SequenceNumberMapping, if non-nil, is the mapping function to apply
751 // to the sequence number of outgoing packets. For both TLS and DTLS,
752 // the two most-significant bytes in the resulting sequence number are
753 // ignored so that the DTLS epoch cannot be changed.
754 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500755
David Benjamina3e89492015-02-26 15:16:22 -0500756 // RSAEphemeralKey, if true, causes the server to send a
757 // ServerKeyExchange message containing an ephemeral key (as in
758 // RSA_EXPORT) in the plain RSA key exchange.
759 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500760
761 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
762 // client offers when negotiating SRTP. MKI support is still missing so
763 // the peer must still send none.
764 SRTPMasterKeyIdentifer string
765
766 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
767 // server sends in the ServerHello instead of the negotiated one.
768 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500769
Nick Harper60edffd2016-06-21 15:19:24 -0700770 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500771 // signature and hashes extension.
772 //
773 // For a server, it will cause an empty list to be sent in the
774 // CertificateRequest message. None the less, the configured set will
775 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700776 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500777
David Benjamin55a43642015-04-20 14:45:55 -0400778 // NoSupportedCurves, if true, causes the client to omit the
779 // supported_curves extension.
780 NoSupportedCurves bool
781
David Benjaminc44b1df2014-11-23 12:11:01 -0500782 // RequireSameRenegoClientVersion, if true, causes the server
783 // to require that all ClientHellos match in offered version
784 // across a renego.
785 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800786
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400787 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500788 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500789 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500790
David Benjamine6f22212016-11-08 14:28:24 -0500791 // SendRecordVersion, if non-zero, is the value to send as the
792 // record-layer version.
793 SendRecordVersion uint16
794
795 // SendInitialRecordVersion, if non-zero, is the value to send as the
796 // record-layer version before the protocol version is determined.
797 SendInitialRecordVersion uint16
798
David Benjamin13be1de2015-01-11 16:29:36 -0500799 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
800 // packet.
801 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500802
803 // SendCipherSuite, if non-zero, is the cipher suite value that the
804 // server will send in the ServerHello. This does not affect the cipher
805 // the server believes it has actually negotiated.
806 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500807
David Benjamin75f99142016-11-12 12:36:06 +0900808 // SendCipherSuites, if not nil, is the cipher suite list that the
809 // client will send in the ClientHello. This does not affect the cipher
810 // the client believes it has actually offered.
811 SendCipherSuites []uint16
812
David Benjamin4cf369b2015-08-22 01:35:43 -0400813 // AppDataBeforeHandshake, if not nil, causes application data to be
814 // sent immediately before the first handshake message.
815 AppDataBeforeHandshake []byte
816
817 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500818 // be sent immediately after ChangeCipherSpec.
819 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500820
David Benjamindc3da932015-03-12 15:09:02 -0400821 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
822 // immediately after ChangeCipherSpec.
823 AlertAfterChangeCipherSpec alert
824
David Benjamin83f90402015-01-27 01:09:43 -0500825 // TimeoutSchedule is the schedule of packet drops and simulated
826 // timeouts for before each handshake leg from the peer.
827 TimeoutSchedule []time.Duration
828
829 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
830 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500831
832 // ReorderHandshakeFragments, if true, causes handshake fragments in
833 // DTLS to overlap and be sent in the wrong order. It also causes
834 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
835 // Finished and will trigger a spurious retransmit.)
836 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500837
David Benjamin61672812016-07-14 23:10:43 -0400838 // ReverseHandshakeFragments, if true, causes handshake fragments in
839 // DTLS to be reversed within a flight.
840 ReverseHandshakeFragments bool
841
David Benjamin75381222015-03-02 19:30:30 -0500842 // MixCompleteMessageWithFragments, if true, causes handshake
843 // messages in DTLS to redundantly both fragment the message
844 // and include a copy of the full one.
845 MixCompleteMessageWithFragments bool
846
David Benjaminddb9f152015-02-03 15:44:39 -0500847 // SendInvalidRecordType, if true, causes a record with an invalid
848 // content type to be sent immediately following the handshake.
849 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500850
David Benjamin0b8d5da2016-07-15 00:39:56 -0400851 // SendWrongMessageType, if non-zero, causes messages of the specified
852 // type to be sent with the wrong value.
853 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500854
David Benjamin639846e2016-09-09 11:41:18 -0400855 // SendTrailingMessageData, if non-zero, causes messages of the
856 // specified type to be sent with trailing data.
857 SendTrailingMessageData byte
858
David Benjamin75381222015-03-02 19:30:30 -0500859 // FragmentMessageTypeMismatch, if true, causes all non-initial
860 // handshake fragments in DTLS to have the wrong message type.
861 FragmentMessageTypeMismatch bool
862
863 // FragmentMessageLengthMismatch, if true, causes all non-initial
864 // handshake fragments in DTLS to have the wrong message length.
865 FragmentMessageLengthMismatch bool
866
David Benjamin11fc66a2015-06-16 11:40:24 -0400867 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
868 // to be split across two records. The value of |SplitFragments| is the
869 // number of bytes in the first fragment.
870 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500871
872 // SendEmptyFragments, if true, causes handshakes to include empty
873 // fragments in DTLS.
874 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400875
David Benjamin9a41d1b2015-05-16 01:30:09 -0400876 // SendSplitAlert, if true, causes an alert to be sent with the header
877 // and record body split across multiple packets. The peer should
878 // discard these packets rather than process it.
879 SendSplitAlert bool
880
David Benjamin4b27d9f2015-05-12 22:42:52 -0400881 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
882 // client offers a resumption or the server accepts one.
883 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400884
David Benjamin67d1fb52015-03-16 15:16:23 -0400885 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
886 // preferences to be ignored.
887 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400888
889 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
890 // signature algorithm preferences to be ignored.
891 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400892
David Benjaminc574f412015-04-20 11:13:01 -0400893 // IgnorePeerCurvePreferences, if true, causes the peer's curve
894 // preferences to be ignored.
895 IgnorePeerCurvePreferences bool
896
David Benjamin513f0ea2015-04-02 19:33:31 -0400897 // BadFinished, if true, causes the Finished hash to be broken.
898 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700899
David Benjamin582ba042016-07-07 12:33:25 -0700900 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
901 // to be packed into individual handshake records, up to the specified
902 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400903 PackHandshakeFragments int
904
David Benjamin582ba042016-07-07 12:33:25 -0700905 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
906 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400907 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400908
David Benjamin582ba042016-07-07 12:33:25 -0700909 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
910 // be packed into records, up to the largest size record available.
911 PackHandshakeFlight bool
912
David Benjamin5ecb88b2016-10-04 17:51:35 -0400913 // AdvertiseAllConfiguredCiphers, if true, causes the client to
914 // advertise all configured cipher suite values.
915 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400916
917 // EmptyCertificateList, if true, causes the server to send an empty
918 // certificate list in the Certificate message.
919 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400920
921 // ExpectNewTicket, if true, causes the client to abort if it does not
922 // receive a new ticket.
923 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700924
925 // RequireClientHelloSize, if not zero, is the required length in bytes
926 // of the ClientHello /record/. This is checked by the server.
927 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700928
929 // CustomExtension, if not empty, contains the contents of an extension
930 // that will be added to client/server hellos.
931 CustomExtension string
932
David Benjamin490469f2016-10-05 22:44:38 -0400933 // CustomUnencryptedExtension, if not empty, contains the contents of
934 // an extension that will be added to ServerHello in TLS 1.3.
935 CustomUnencryptedExtension string
936
Adam Langley09505632015-07-30 18:10:13 -0700937 // ExpectedCustomExtension, if not nil, contains the expected contents
938 // of a custom extension.
939 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400940
David Benjamin1286bee2016-10-07 15:25:06 -0400941 // CustomTicketExtension, if not empty, contains the contents of an
942 // extension what will be added to NewSessionTicket in TLS 1.3.
943 CustomTicketExtension string
944
David Benjamin3baa6e12016-10-07 21:10:38 -0400945 // CustomTicketExtension, if not empty, contains the contents of an
946 // extension what will be added to HelloRetryRequest in TLS 1.3.
947 CustomHelloRetryRequestExtension string
948
David Benjamin30789da2015-08-29 22:56:45 -0400949 // NoCloseNotify, if true, causes the close_notify alert to be skipped
950 // on connection shutdown.
951 NoCloseNotify bool
952
David Benjaminfa214e42016-05-10 17:03:10 -0400953 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
954 // close_notify on shutdown.
955 SendAlertOnShutdown alert
956
David Benjamin30789da2015-08-29 22:56:45 -0400957 // ExpectCloseNotify, if true, requires a close_notify from the peer on
958 // shutdown. Records from the peer received after close_notify is sent
959 // are not discard.
960 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400961
962 // SendLargeRecords, if true, allows outgoing records to be sent
963 // arbitrarily large.
964 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400965
966 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
967 // ALPN and NPN in the same connetion.
968 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400969
David Benjamin0c40a962016-08-01 12:05:50 -0400970 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400971 // string in the ALPN extension regardless of the content or presence of
972 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400973 SendALPN string
974
David Benjamin490469f2016-10-05 22:44:38 -0400975 // SendUnencryptedALPN, if non-empty, causes the server to send the
976 // specified string in a ServerHello ALPN extension in TLS 1.3.
977 SendUnencryptedALPN string
978
David Benjamindd6fed92015-10-23 17:41:12 -0400979 // SendEmptySessionTicket, if true, causes the server to send an empty
980 // session ticket.
981 SendEmptySessionTicket bool
982
Steven Valdeza833c352016-11-01 13:39:36 -0400983 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400984 // to send.
985 SendPSKKeyExchangeModes []byte
986
Steven Valdeza833c352016-11-01 13:39:36 -0400987 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
988 // receipt of a NewSessionTicket message.
989 ExpectNoNewSessionTicket bool
990
David Benjamin9c33ae82017-01-08 06:04:43 -0500991 // DuplicateTicketEarlyDataInfo causes an extra empty extension of
992 // ticket_early_data_info to be sent in NewSessionTicket.
993 DuplicateTicketEarlyDataInfo bool
994
Steven Valdez08b65f42016-12-07 15:29:45 -0500995 // ExpectTicketEarlyDataInfo, if true, means that the client will fail upon
996 // absence of the ticket_early_data_info extension.
997 ExpectTicketEarlyDataInfo bool
998
Steven Valdeza833c352016-11-01 13:39:36 -0400999 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
1000 // server receives from the client.
1001 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -04001002
David Benjamin35ac5b72017-03-03 15:05:56 -05001003 // SendTicketAge, if non-zero, is the ticket age to be sent by the
1004 // client.
1005 SendTicketAge time.Duration
1006
David Benjamindd6fed92015-10-23 17:41:12 -04001007 // FailIfSessionOffered, if true, causes the server to fail any
1008 // connections where the client offers a non-empty session ID or session
1009 // ticket.
1010 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -08001011
1012 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
1013 // HelloRequest handshake message to be sent before each application
1014 // data record. This only makes sense for a server.
1015 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -08001016
David Benjamin71dd6662016-07-08 14:10:48 -07001017 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
1018 // HelloRequest handshake message to be sent before each handshake
1019 // message. This only makes sense for a server.
1020 SendHelloRequestBeforeEveryHandshakeMessage bool
1021
David Benjamin8411b242015-11-26 12:07:28 -05001022 // BadChangeCipherSpec, if not nil, is the body to be sent in
1023 // ChangeCipherSpec records instead of {1}.
1024 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -05001025
1026 // BadHelloRequest, if not nil, is what to send instead of a
1027 // HelloRequest.
1028 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -05001029
1030 // RequireSessionTickets, if true, causes the client to require new
1031 // sessions use session tickets instead of session IDs.
1032 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -05001033
1034 // NullAllCiphers, if true, causes every cipher to behave like the null
1035 // cipher.
1036 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -04001037
1038 // SendSCTListOnResume, if not nil, causes the server to send the
1039 // supplied SCT list in resumption handshakes.
1040 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -07001041
David Benjamindaa88502016-10-04 16:32:16 -04001042 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
1043 // OCSP stapling in resumption handshakes and, if applicable, send the
1044 // supplied stapled response.
1045 SendOCSPResponseOnResume []byte
1046
Steven Valdeza833c352016-11-01 13:39:36 -04001047 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1048 // supplied bytes in the extensions on the Certificate message.
1049 SendExtensionOnCertificate []byte
1050
1051 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1052 // supplied OCSP on intermediate certificates in the Certificate message.
1053 SendOCSPOnIntermediates []byte
1054
1055 // SendSCTOnIntermediates, if not nil, causes the server to send the
1056 // supplied SCT on intermediate certificates in the Certificate message.
1057 SendSCTOnIntermediates []byte
1058
1059 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1060 // copy of the OCSP/SCT extensions in the Certificate message.
1061 SendDuplicateCertExtensions bool
1062
1063 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1064 // reject extensions on intermediate certificates.
1065 ExpectNoExtensionsOnIntermediate bool
1066
David Benjaminc9ae27c2016-06-24 22:56:37 -04001067 // RecordPadding is the number of bytes of padding to add to each
1068 // encrypted record in TLS 1.3.
1069 RecordPadding int
1070
1071 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1072 // be missing their body and content type. Padding, if configured, is
1073 // still added.
1074 OmitRecordContents bool
1075
1076 // OuterRecordType, if non-zero, is the outer record type to use instead
1077 // of application data.
1078 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001079
1080 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1081 // with the given signature algorithm rather than the one negotiated.
1082 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001083
1084 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1085 // skipped.
1086 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001087
1088 // IgnoreSignatureVersionChecks, if true, causes all signature
1089 // algorithms to be enabled at all TLS versions.
1090 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001091
1092 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1093 // Renegotiation Info to be negotiated at all versions.
1094 NegotiateRenegotiationInfoAtAllVersions bool
1095
Steven Valdez143e8b32016-07-11 13:19:03 -04001096 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1097 // all versions.
1098 NegotiateNPNAtAllVersions bool
1099
1100 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1101 // all versions.
1102 NegotiateEMSAtAllVersions bool
1103
1104 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1105 // advertised in server extensions
1106 AdvertiseTicketExtension bool
1107
Steven Valdez803c77a2016-09-06 14:13:43 -04001108 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1109 // resumption.
1110 NegotiatePSKResumption bool
1111
David Benjamin7f78df42016-10-05 22:33:19 -04001112 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1113 // always acknowledge a session, regardless of one was offered.
1114 AlwaysSelectPSKIdentity bool
1115
1116 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1117 // the specified PSK identity index rather than the actual value.
1118 SelectPSKIdentityOnResume uint16
1119
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001120 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1121 // identity.
1122 ExtraPSKIdentity bool
1123
Steven Valdez143e8b32016-07-11 13:19:03 -04001124 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1125 // sending a key_share extension and use the zero ECDHE secret
1126 // instead.
1127 MissingKeyShare bool
1128
Steven Valdez5440fe02016-07-18 12:40:30 -04001129 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1130 // ClientHello to skip sending a key_share extension and use the zero
1131 // ECDHE secret instead.
1132 SecondClientHelloMissingKeyShare bool
1133
1134 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1135 // client to pretend the server requested a HelloRetryRequest with the
1136 // given curve rather than the actual one.
1137 MisinterpretHelloRetryRequestCurve CurveID
1138
Steven Valdez143e8b32016-07-11 13:19:03 -04001139 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1140 // copies of each KeyShareEntry.
1141 DuplicateKeyShares bool
1142
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001143 // SendEarlyAlert, if true, sends a fatal alert after the ClientHello.
1144 SendEarlyAlert bool
1145
Nick Harperf2511f12016-12-06 16:02:31 -08001146 // SendFakeEarlyDataLength, if non-zero, is the amount of early data to
1147 // send after the ClientHello.
1148 SendFakeEarlyDataLength int
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001149
Steven Valdez681eb6a2016-12-19 13:19:29 -05001150 // SendStrayEarlyHandshake, if non-zero, causes the client to send a stray
1151 // handshake record before sending end of early data.
1152 SendStrayEarlyHandshake bool
1153
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001154 // OmitEarlyDataExtension, if true, causes the early data extension to
1155 // be omitted in the ClientHello.
1156 OmitEarlyDataExtension bool
1157
1158 // SendEarlyDataOnSecondClientHello, if true, causes the TLS 1.3 client to
1159 // send early data after the second ClientHello.
1160 SendEarlyDataOnSecondClientHello bool
1161
1162 // InterleaveEarlyData, if true, causes the TLS 1.3 client to send early
1163 // data interleaved with the second ClientHello and the client Finished.
1164 InterleaveEarlyData bool
1165
Nick Harperf2511f12016-12-06 16:02:31 -08001166 // SendEarlyData causes a TLS 1.3 client to send the provided data
1167 // in application data records immediately after the ClientHello,
Steven Valdez2d850622017-01-11 11:34:52 -05001168 // provided that the client offers a TLS 1.3 session. It will do this
1169 // whether or not the server advertised early data for the ticket.
Nick Harperf2511f12016-12-06 16:02:31 -08001170 SendEarlyData [][]byte
1171
Steven Valdez2d850622017-01-11 11:34:52 -05001172 // ExpectEarlyDataAccepted causes a TLS 1.3 client to check that early data
1173 // was accepted by the server.
1174 ExpectEarlyDataAccepted bool
1175
1176 // AlwaysAcceptEarlyData causes a TLS 1.3 server to always accept early data
1177 // regardless of ALPN mismatch.
1178 AlwaysAcceptEarlyData bool
1179
1180 // AlwaysRejectEarlyData causes a TLS 1.3 server to always reject early data.
1181 AlwaysRejectEarlyData bool
1182
1183 // SendEarlyDataExtension, if true, causes a TLS 1.3 server to send the
1184 // early_data extension in EncryptedExtensions, independent of whether
1185 // it was accepted.
1186 SendEarlyDataExtension bool
1187
Nick Harperab20cec2016-12-19 17:38:41 -08001188 // ExpectEarlyData causes a TLS 1.3 server to read application
1189 // data after the ClientHello (assuming the server is able to
1190 // derive the key under which the data is encrypted) before it
1191 // sends a ServerHello. It checks that the application data it
1192 // reads matches what is provided in ExpectEarlyData and errors if
1193 // the number of records or their content do not match.
1194 ExpectEarlyData [][]byte
1195
Steven Valdeze831a812017-03-09 14:56:07 -05001196 // ExpectLateEarlyData causes a TLS 1.3 server to read application
1197 // data after the ServerFinished (assuming the server is able to
1198 // derive the key under which the data is encrypted) before it
1199 // sends the ClientFinished. It checks that the application data it
1200 // reads matches what is provided in ExpectLateEarlyData and errors if
1201 // the number of records or their content do not match.
1202 ExpectLateEarlyData [][]byte
1203
Nick Harper7cd0a972016-12-02 11:08:40 -08001204 // SendHalfRTTData causes a TLS 1.3 server to send the provided
1205 // data in application data records before reading the client's
1206 // Finished message.
1207 SendHalfRTTData [][]byte
1208
David Benjamin794cc592017-03-25 22:24:23 -05001209 // ExpectHalfRTTData causes a TLS 1.3 client, if 0-RTT was accepted, to
1210 // read application data after reading the server's Finished message and
1211 // before sending any subsequent handshake messages. It checks that the
Nick Harper7cd0a972016-12-02 11:08:40 -08001212 // application data it reads matches what is provided in
1213 // ExpectHalfRTTData and errors if the number of records or their
1214 // content do not match.
1215 ExpectHalfRTTData [][]byte
1216
Steven Valdez143e8b32016-07-11 13:19:03 -04001217 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1218 // emit an empty EncryptedExtensions block.
1219 EmptyEncryptedExtensions bool
1220
1221 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1222 // include the KeyShare extension in the EncryptedExtensions block.
1223 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001224
David Benjamin3baa6e12016-10-07 21:10:38 -04001225 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1226 // be sent by the server, even if empty.
1227 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001228
1229 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1230 // two HelloRetryRequests instead of one.
1231 SecondHelloRetryRequest bool
1232
David Benjamin3baa6e12016-10-07 21:10:38 -04001233 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1234 // the specified curve in a HelloRetryRequest.
1235 SendHelloRetryRequestCurve CurveID
1236
1237 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1238 // sent by the server in HelloRetryRequest.
1239 SendHelloRetryRequestCookie []byte
1240
1241 // DuplicateHelloRetryRequestExtensions, if true, causes all
1242 // HelloRetryRequest extensions to be sent twice.
1243 DuplicateHelloRetryRequestExtensions bool
1244
Steven Valdez5440fe02016-07-18 12:40:30 -04001245 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001246 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001247 SendServerHelloVersion uint16
1248
1249 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1250 // HelloRetryRequest.
1251 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001252
1253 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1254 // HelloRequest in the same record as Finished.
1255 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001256
David Benjamine73c7f42016-08-17 00:29:33 -04001257 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1258 // connection if the selected curve appears in the client's initial
1259 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1260 ExpectMissingKeyShare bool
1261
David Benjamin02edcd02016-07-27 17:40:37 -04001262 // SendExtraFinished, if true, causes an extra Finished message to be
1263 // sent.
1264 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001265
1266 // SendRequestContext, if not empty, is the request context to send in
1267 // a TLS 1.3 CertificateRequest.
1268 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001269
1270 // SendSNIWarningAlert, if true, causes the server to send an
1271 // unrecognized_name alert before the ServerHello.
1272 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001273
1274 // SendCompressionMethods, if not nil, is the compression method list to
1275 // send in the ClientHello.
1276 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001277
1278 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1279 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1280 // hint is empty.
1281 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001282
1283 // TrailingKeyShareData, if true, causes the client key share list to
1284 // include a trailing byte.
1285 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001286
1287 // InvalidChannelIDSignature, if true, causes the client to generate an
1288 // invalid Channel ID signature.
1289 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001290
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001291 // ExpectGREASE, if true, causes messages without GREASE values to be
1292 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001293 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001294
1295 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1296 // that is one byte shorter than it should be.
1297 SendShortPSKBinder bool
1298
1299 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1300 // PSK binder.
1301 SendInvalidPSKBinder bool
1302
1303 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1304 SendNoPSKBinder bool
1305
David Benjaminaedf3032016-12-01 16:47:56 -05001306 // SendExtraPSKBinder, if true, causes the client to send an extra PSK
1307 // binder.
1308 SendExtraPSKBinder bool
1309
Steven Valdeza833c352016-11-01 13:39:36 -04001310 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1311 // extension as the first extension instead of the last extension.
1312 PSKBinderFirst bool
David Benjamin53210cb2016-11-16 09:01:48 +09001313
1314 // NoOCSPStapling, if true, causes the client to not request OCSP
1315 // stapling.
1316 NoOCSPStapling bool
1317
1318 // NoSignedCertificateTimestamps, if true, causes the client to not
1319 // request signed certificate timestamps.
1320 NoSignedCertificateTimestamps bool
David Benjamin6f600d62016-12-21 16:06:54 -05001321
David Benjamina81967b2016-12-22 09:16:57 -05001322 // SendSupportedPointFormats, if not nil, is the list of supported point
1323 // formats to send in ClientHello or ServerHello. If set to a non-nil
1324 // empty slice, no extension will be sent.
1325 SendSupportedPointFormats []byte
David Benjamine3fbb362017-01-06 16:19:28 -05001326
1327 // MaxReceivePlaintext, if non-zero, is the maximum plaintext record
1328 // length accepted from the peer.
1329 MaxReceivePlaintext int
David Benjamin17b30832017-01-28 14:00:32 -05001330
1331 // SendTicketLifetime, if non-zero, is the ticket lifetime to send in
1332 // NewSessionTicket messages.
1333 SendTicketLifetime time.Duration
David Benjamin023d4192017-02-06 13:49:07 -05001334
1335 // SendServerNameAck, if true, causes the server to acknowledge the SNI
1336 // extension.
1337 SendServerNameAck bool
Adam Langley2ff79332017-02-28 13:45:39 -08001338
1339 // ExpectCertificateReqNames, if not nil, contains the list of X.509
1340 // names that must be sent in a CertificateRequest from the server.
1341 ExpectCertificateReqNames [][]byte
David Benjamina58baaf2017-02-28 20:54:28 -05001342
1343 // RenegotiationCertificate, if not nil, is the certificate to use on
1344 // renegotiation handshakes.
1345 RenegotiationCertificate *Certificate
David Benjamin69522112017-03-28 15:38:29 -05001346
1347 // UseLegacySigningAlgorithm, if non-zero, is the signature algorithm
1348 // to use when signing in TLS 1.1 and earlier where algorithms are not
1349 // negotiated.
1350 UseLegacySigningAlgorithm signatureAlgorithm
David Benjaminebacdee2017-04-08 11:00:45 -04001351
1352 // SendServerHelloAsHelloRetryRequest, if true, causes the server to
1353 // send ServerHello messages with a HelloRetryRequest type field.
1354 SendServerHelloAsHelloRetryRequest bool
David Benjaminbbba9392017-04-06 12:54:12 -04001355
1356 // RejectUnsolicitedKeyUpdate, if true, causes all unsolicited
1357 // KeyUpdates from the peer to be rejected.
1358 RejectUnsolicitedKeyUpdate bool
Adam Langley95c29f32014-06-20 12:00:00 -07001359}
1360
1361func (c *Config) serverInit() {
1362 if c.SessionTicketsDisabled {
1363 return
1364 }
1365
1366 // If the key has already been set then we have nothing to do.
1367 for _, b := range c.SessionTicketKey {
1368 if b != 0 {
1369 return
1370 }
1371 }
1372
1373 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1374 c.SessionTicketsDisabled = true
1375 }
1376}
1377
1378func (c *Config) rand() io.Reader {
1379 r := c.Rand
1380 if r == nil {
1381 return rand.Reader
1382 }
1383 return r
1384}
1385
1386func (c *Config) time() time.Time {
1387 t := c.Time
1388 if t == nil {
1389 t = time.Now
1390 }
1391 return t()
1392}
1393
1394func (c *Config) cipherSuites() []uint16 {
1395 s := c.CipherSuites
1396 if s == nil {
1397 s = defaultCipherSuites()
1398 }
1399 return s
1400}
1401
David Benjamincecee272016-06-30 13:33:47 -04001402func (c *Config) minVersion(isDTLS bool) uint16 {
1403 ret := uint16(minVersion)
1404 if c != nil && c.MinVersion != 0 {
1405 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001406 }
David Benjamincecee272016-06-30 13:33:47 -04001407 if isDTLS {
1408 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1409 if ret < VersionTLS10 {
1410 return VersionTLS10
1411 }
1412 // There is no such thing as DTLS 1.1.
1413 if ret == VersionTLS11 {
1414 return VersionTLS12
1415 }
1416 }
1417 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001418}
1419
David Benjamincecee272016-06-30 13:33:47 -04001420func (c *Config) maxVersion(isDTLS bool) uint16 {
1421 ret := uint16(maxVersion)
1422 if c != nil && c.MaxVersion != 0 {
1423 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001424 }
David Benjamincecee272016-06-30 13:33:47 -04001425 if isDTLS {
1426 // We only implement up to DTLS 1.2.
1427 if ret > VersionTLS12 {
1428 return VersionTLS12
1429 }
1430 // There is no such thing as DTLS 1.1.
1431 if ret == VersionTLS11 {
1432 return VersionTLS10
1433 }
1434 }
1435 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001436}
1437
David Benjamincba2b622015-12-18 22:13:41 -05001438var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001439
1440func (c *Config) curvePreferences() []CurveID {
1441 if c == nil || len(c.CurvePreferences) == 0 {
1442 return defaultCurvePreferences
1443 }
1444 return c.CurvePreferences
1445}
1446
Nick Harperdcfbc672016-07-16 17:47:31 +02001447func (c *Config) defaultCurves() map[CurveID]bool {
1448 defaultCurves := make(map[CurveID]bool)
1449 curves := c.DefaultCurves
1450 if c == nil || c.DefaultCurves == nil {
1451 curves = c.curvePreferences()
1452 }
1453 for _, curveID := range curves {
1454 defaultCurves[curveID] = true
1455 }
1456 return defaultCurves
1457}
1458
Steven Valdezc94998a2017-06-20 10:55:02 -04001459// isSupportedVersion checks if the specified wire version is acceptable. If so,
1460// it returns true and the corresponding protocol version. Otherwise, it returns
1461// false.
1462func (c *Config) isSupportedVersion(wireVers uint16, isDTLS bool) (uint16, bool) {
1463 vers, ok := wireToVersion(wireVers, isDTLS)
1464 if !ok || c.minVersion(isDTLS) > vers || vers > c.maxVersion(isDTLS) {
1465 return 0, false
1466 }
1467 return vers, true
1468}
1469
1470func (c *Config) supportedVersions(isDTLS bool) []uint16 {
1471 versions := allTLSWireVersions
1472 if isDTLS {
1473 versions = allDTLSWireVersions
1474 }
1475 var ret []uint16
1476 for _, vers := range versions {
1477 if _, ok := c.isSupportedVersion(vers, isDTLS); ok {
1478 ret = append(ret, vers)
1479 }
1480 }
1481 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001482}
1483
1484// getCertificateForName returns the best certificate for the given name,
1485// defaulting to the first element of c.Certificates if there are no good
1486// options.
1487func (c *Config) getCertificateForName(name string) *Certificate {
1488 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1489 // There's only one choice, so no point doing any work.
1490 return &c.Certificates[0]
1491 }
1492
1493 name = strings.ToLower(name)
1494 for len(name) > 0 && name[len(name)-1] == '.' {
1495 name = name[:len(name)-1]
1496 }
1497
1498 if cert, ok := c.NameToCertificate[name]; ok {
1499 return cert
1500 }
1501
1502 // try replacing labels in the name with wildcards until we get a
1503 // match.
1504 labels := strings.Split(name, ".")
1505 for i := range labels {
1506 labels[i] = "*"
1507 candidate := strings.Join(labels, ".")
1508 if cert, ok := c.NameToCertificate[candidate]; ok {
1509 return cert
1510 }
1511 }
1512
1513 // If nothing matches, return the first certificate.
1514 return &c.Certificates[0]
1515}
1516
David Benjamin7a41d372016-07-09 11:21:54 -07001517func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1518 if c != nil && c.SignSignatureAlgorithms != nil {
1519 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001520 }
David Benjamin7a41d372016-07-09 11:21:54 -07001521 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001522}
1523
David Benjamin7a41d372016-07-09 11:21:54 -07001524func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1525 if c != nil && c.VerifySignatureAlgorithms != nil {
1526 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001527 }
David Benjamin7a41d372016-07-09 11:21:54 -07001528 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001529}
1530
Adam Langley95c29f32014-06-20 12:00:00 -07001531// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1532// from the CommonName and SubjectAlternateName fields of each of the leaf
1533// certificates.
1534func (c *Config) BuildNameToCertificate() {
1535 c.NameToCertificate = make(map[string]*Certificate)
1536 for i := range c.Certificates {
1537 cert := &c.Certificates[i]
1538 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1539 if err != nil {
1540 continue
1541 }
1542 if len(x509Cert.Subject.CommonName) > 0 {
1543 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1544 }
1545 for _, san := range x509Cert.DNSNames {
1546 c.NameToCertificate[san] = cert
1547 }
1548 }
1549}
1550
1551// A Certificate is a chain of one or more certificates, leaf first.
1552type Certificate struct {
1553 Certificate [][]byte
1554 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1555 // OCSPStaple contains an optional OCSP response which will be served
1556 // to clients that request it.
1557 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001558 // SignedCertificateTimestampList contains an optional encoded
1559 // SignedCertificateTimestampList structure which will be
1560 // served to clients that request it.
1561 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001562 // Leaf is the parsed form of the leaf certificate, which may be
1563 // initialized using x509.ParseCertificate to reduce per-handshake
1564 // processing for TLS clients doing client authentication. If nil, the
1565 // leaf certificate will be parsed as needed.
1566 Leaf *x509.Certificate
1567}
1568
1569// A TLS record.
1570type record struct {
1571 contentType recordType
1572 major, minor uint8
1573 payload []byte
1574}
1575
1576type handshakeMessage interface {
1577 marshal() []byte
1578 unmarshal([]byte) bool
1579}
1580
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001581// lruSessionCache is a client or server session cache implementation
1582// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001583type lruSessionCache struct {
1584 sync.Mutex
1585
1586 m map[string]*list.Element
1587 q *list.List
1588 capacity int
1589}
1590
1591type lruSessionCacheEntry struct {
1592 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001593 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001594}
1595
1596// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001597func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001598 c.Lock()
1599 defer c.Unlock()
1600
1601 if elem, ok := c.m[sessionKey]; ok {
1602 entry := elem.Value.(*lruSessionCacheEntry)
1603 entry.state = cs
1604 c.q.MoveToFront(elem)
1605 return
1606 }
1607
1608 if c.q.Len() < c.capacity {
1609 entry := &lruSessionCacheEntry{sessionKey, cs}
1610 c.m[sessionKey] = c.q.PushFront(entry)
1611 return
1612 }
1613
1614 elem := c.q.Back()
1615 entry := elem.Value.(*lruSessionCacheEntry)
1616 delete(c.m, entry.sessionKey)
1617 entry.sessionKey = sessionKey
1618 entry.state = cs
1619 c.q.MoveToFront(elem)
1620 c.m[sessionKey] = elem
1621}
1622
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001623// Get returns the value associated with a given key. It returns (nil,
1624// false) if no value is found.
1625func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001626 c.Lock()
1627 defer c.Unlock()
1628
1629 if elem, ok := c.m[sessionKey]; ok {
1630 c.q.MoveToFront(elem)
1631 return elem.Value.(*lruSessionCacheEntry).state, true
1632 }
1633 return nil, false
1634}
1635
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001636// lruClientSessionCache is a ClientSessionCache implementation that
1637// uses an LRU caching strategy.
1638type lruClientSessionCache struct {
1639 lruSessionCache
1640}
1641
1642func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1643 c.lruSessionCache.Put(sessionKey, cs)
1644}
1645
1646func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1647 cs, ok := c.lruSessionCache.Get(sessionKey)
1648 if !ok {
1649 return nil, false
1650 }
1651 return cs.(*ClientSessionState), true
1652}
1653
1654// lruServerSessionCache is a ServerSessionCache implementation that
1655// uses an LRU caching strategy.
1656type lruServerSessionCache struct {
1657 lruSessionCache
1658}
1659
1660func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1661 c.lruSessionCache.Put(sessionId, session)
1662}
1663
1664func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1665 cs, ok := c.lruSessionCache.Get(sessionId)
1666 if !ok {
1667 return nil, false
1668 }
1669 return cs.(*sessionState), true
1670}
1671
1672// NewLRUClientSessionCache returns a ClientSessionCache with the given
1673// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1674// is used instead.
1675func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1676 const defaultSessionCacheCapacity = 64
1677
1678 if capacity < 1 {
1679 capacity = defaultSessionCacheCapacity
1680 }
1681 return &lruClientSessionCache{
1682 lruSessionCache{
1683 m: make(map[string]*list.Element),
1684 q: list.New(),
1685 capacity: capacity,
1686 },
1687 }
1688}
1689
1690// NewLRUServerSessionCache returns a ServerSessionCache with the given
1691// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1692// is used instead.
1693func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1694 const defaultSessionCacheCapacity = 64
1695
1696 if capacity < 1 {
1697 capacity = defaultSessionCacheCapacity
1698 }
1699 return &lruServerSessionCache{
1700 lruSessionCache{
1701 m: make(map[string]*list.Element),
1702 q: list.New(),
1703 capacity: capacity,
1704 },
1705 }
1706}
1707
Adam Langley95c29f32014-06-20 12:00:00 -07001708// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1709type dsaSignature struct {
1710 R, S *big.Int
1711}
1712
1713type ecdsaSignature dsaSignature
1714
1715var emptyConfig Config
1716
1717func defaultConfig() *Config {
1718 return &emptyConfig
1719}
1720
1721var (
1722 once sync.Once
1723 varDefaultCipherSuites []uint16
1724)
1725
1726func defaultCipherSuites() []uint16 {
1727 once.Do(initDefaultCipherSuites)
1728 return varDefaultCipherSuites
1729}
1730
1731func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001732 for _, suite := range cipherSuites {
1733 if suite.flags&suitePSK == 0 {
1734 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1735 }
Adam Langley95c29f32014-06-20 12:00:00 -07001736 }
1737}
1738
1739func unexpectedMessageError(wanted, got interface{}) error {
1740 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1741}
David Benjamin000800a2014-11-14 01:43:59 -05001742
Nick Harper60edffd2016-06-21 15:19:24 -07001743func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1744 for _, s := range sigAlgs {
1745 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001746 return true
1747 }
1748 }
1749 return false
1750}
Nick Harper85f20c22016-07-04 10:11:59 -07001751
1752var (
David Benjamina128a552016-10-13 14:26:33 -04001753 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001754 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1755 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1756)
Steven Valdezc94998a2017-06-20 10:55:02 -04001757
1758func containsGREASE(values []uint16) bool {
1759 for _, v := range values {
1760 if isGREASEValue(v) {
1761 return true
1762 }
1763 }
1764 return false
1765}