blob: 7ef1d43062d360b99cda3ef380d461afc786ee72 [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
Nick Harper4d90c102016-07-17 10:53:26 +020029// The draft version of TLS 1.3 that is implemented here and sent in the draft
30// indicator extension.
Nick Harper0b3625b2016-07-25 16:16:28 -070031const tls13DraftVersion = 14
Nick Harper4d90c102016-07-17 10:53:26 +020032
Adam Langley95c29f32014-06-20 12:00:00 -070033const (
David Benjamin83c0bc92014-08-04 01:23:53 -040034 maxPlaintext = 16384 // maximum plaintext payload length
35 maxCiphertext = 16384 + 2048 // maximum ciphertext payload length
36 tlsRecordHeaderLen = 5 // record header length
37 dtlsRecordHeaderLen = 13
38 maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB)
Adam Langley95c29f32014-06-20 12:00:00 -070039
40 minVersion = VersionSSL30
Nick Harper1fd39d82016-06-14 18:14:35 -070041 maxVersion = VersionTLS13
Adam Langley95c29f32014-06-20 12:00:00 -070042)
43
44// TLS record types.
45type recordType uint8
46
47const (
48 recordTypeChangeCipherSpec recordType = 20
49 recordTypeAlert recordType = 21
50 recordTypeHandshake recordType = 22
51 recordTypeApplicationData recordType = 23
52)
53
54// TLS handshake message types.
55const (
David Benjamincedff872016-06-30 18:55:18 -040056 typeHelloRequest uint8 = 0
57 typeClientHello uint8 = 1
58 typeServerHello uint8 = 2
59 typeHelloVerifyRequest uint8 = 3
60 typeNewSessionTicket uint8 = 4
61 typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-13
62 typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-13
63 typeCertificate uint8 = 11
64 typeServerKeyExchange uint8 = 12
65 typeCertificateRequest uint8 = 13
66 typeServerHelloDone uint8 = 14
67 typeCertificateVerify uint8 = 15
68 typeClientKeyExchange uint8 = 16
69 typeFinished uint8 = 20
70 typeCertificateStatus uint8 = 22
David Benjamin21c00282016-07-18 21:56:23 +020071 typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-13
David Benjamincedff872016-06-30 18:55:18 -040072 typeNextProtocol uint8 = 67 // Not IANA assigned
73 typeChannelID uint8 = 203 // Not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070074)
75
76// TLS compression types.
77const (
78 compressionNone uint8 = 0
79)
80
81// TLS extension numbers
82const (
David Benjamin61f95272014-11-25 01:55:35 -050083 extensionServerName uint16 = 0
84 extensionStatusRequest uint16 = 5
85 extensionSupportedCurves uint16 = 10
86 extensionSupportedPoints uint16 = 11
87 extensionSignatureAlgorithms uint16 = 13
88 extensionUseSRTP uint16 = 14
89 extensionALPN uint16 = 16
90 extensionSignedCertificateTimestamp uint16 = 18
91 extensionExtendedMasterSecret uint16 = 23
92 extensionSessionTicket uint16 = 35
David Benjamincedff872016-06-30 18:55:18 -040093 extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-13
94 extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-13
95 extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-13
96 extensionCookie uint16 = 44 // draft-ietf-tls-tls13-13
David Benjamin399e7c92015-07-30 23:01:27 -040097 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -050098 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
99 extensionRenegotiationInfo uint16 = 0xff01
Nick Harper4d90c102016-07-17 10:53:26 +0200100 extensionTLS13Draft uint16 = 0xff02
David Benjamin61f95272014-11-25 01:55:35 -0500101 extensionChannelID uint16 = 30032 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700102)
103
104// TLS signaling cipher suite values
105const (
106 scsvRenegotiation uint16 = 0x00ff
107)
108
109// CurveID is the type of a TLS identifier for an elliptic curve. See
110// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
111type CurveID uint16
112
113const (
David Benjamincba2b622015-12-18 22:13:41 -0500114 CurveP224 CurveID = 21
115 CurveP256 CurveID = 23
116 CurveP384 CurveID = 24
117 CurveP521 CurveID = 25
118 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700119)
120
121// TLS Elliptic Curve Point Formats
122// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
123const (
124 pointFormatUncompressed uint8 = 0
125)
126
127// TLS CertificateStatusType (RFC 3546)
128const (
129 statusTypeOCSP uint8 = 1
130)
131
132// Certificate types (for certificateRequestMsg)
133const (
David Benjamin7b030512014-07-08 17:30:11 -0400134 CertTypeRSASign = 1 // A certificate containing an RSA key
135 CertTypeDSSSign = 2 // A certificate containing a DSA key
136 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
137 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700138
139 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400140 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
141 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
142 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700143
144 // Rest of these are reserved by the TLS spec
145)
146
Nick Harper60edffd2016-06-21 15:19:24 -0700147// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
148// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
149// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
150// algorithms' throughout. We match the latter.
151type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700152
Adam Langley95c29f32014-06-20 12:00:00 -0700153const (
Nick Harper60edffd2016-06-21 15:19:24 -0700154 // RSASSA-PKCS1-v1_5 algorithms
155 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
156 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
157 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
158 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
159 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700160
Nick Harper60edffd2016-06-21 15:19:24 -0700161 // ECDSA algorithms
162 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
163 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
164 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
165 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
166
167 // RSASSA-PSS algorithms
168 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0700
169 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0701
170 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0702
171
172 // EdDSA algorithms
173 signatureEd25519 signatureAlgorithm = 0x0703
174 signatureEd448 signatureAlgorithm = 0x0704
175)
Adam Langley95c29f32014-06-20 12:00:00 -0700176
David Benjamin7a41d372016-07-09 11:21:54 -0700177// supportedSignatureAlgorithms contains the default supported signature
178// algorithms.
179var supportedSignatureAlgorithms = []signatureAlgorithm{
180 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700181 signatureRSAPKCS1WithSHA256,
182 signatureECDSAWithP256AndSHA256,
183 signatureRSAPKCS1WithSHA1,
184 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700185}
186
David Benjaminca6c8262014-11-15 19:06:08 -0500187// SRTP protection profiles (See RFC 5764, section 4.1.2)
188const (
189 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
190 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
191)
192
David Benjamin58104882016-07-18 01:25:41 +0200193// TicketFlags values (see draft-ietf-tls-tls13-14, section 4.4.1)
194const (
195 ticketAllowEarlyData = 1
196 ticketAllowDHEResumption = 2
197 ticketAllowPSKResumption = 4
198)
199
Adam Langley95c29f32014-06-20 12:00:00 -0700200// ConnectionState records basic TLS details about the connection.
201type ConnectionState struct {
202 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
203 HandshakeComplete bool // TLS handshake is complete
204 DidResume bool // connection resumes a previous TLS connection
205 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
206 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
207 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400208 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700209 ServerName string // server name requested by client, if any (server side only)
210 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
211 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400212 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500213 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400214 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100215 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700216 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400217 CurveID CurveID // the curve used in ECDHE
Adam Langley95c29f32014-06-20 12:00:00 -0700218}
219
220// ClientAuthType declares the policy the server will follow for
221// TLS Client Authentication.
222type ClientAuthType int
223
224const (
225 NoClientCert ClientAuthType = iota
226 RequestClientCert
227 RequireAnyClientCert
228 VerifyClientCertIfGiven
229 RequireAndVerifyClientCert
230)
231
232// ClientSessionState contains the state needed by clients to resume TLS
233// sessions.
234type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500235 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700236 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
237 vers uint16 // SSL/TLS version negotiated for the session
238 cipherSuite uint16 // Ciphersuite negotiated for the session
239 masterSecret []byte // MasterSecret generated by client on a full handshake
240 handshakeHash []byte // Handshake hash for Channel ID purposes.
241 serverCertificates []*x509.Certificate // Certificate chain presented by the server
242 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100243 sctList []byte
244 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700245 ticketCreationTime time.Time
246 ticketExpiration time.Time
247 ticketFlags uint32
248 ticketAgeAdd uint32
Adam Langley95c29f32014-06-20 12:00:00 -0700249}
250
251// ClientSessionCache is a cache of ClientSessionState objects that can be used
252// by a client to resume a TLS session with a given server. ClientSessionCache
253// implementations should expect to be called concurrently from different
254// goroutines.
255type ClientSessionCache interface {
256 // Get searches for a ClientSessionState associated with the given key.
257 // On return, ok is true if one was found.
258 Get(sessionKey string) (session *ClientSessionState, ok bool)
259
260 // Put adds the ClientSessionState to the cache with the given key.
261 Put(sessionKey string, cs *ClientSessionState)
262}
263
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500264// ServerSessionCache is a cache of sessionState objects that can be used by a
265// client to resume a TLS session with a given server. ServerSessionCache
266// implementations should expect to be called concurrently from different
267// goroutines.
268type ServerSessionCache interface {
269 // Get searches for a sessionState associated with the given session
270 // ID. On return, ok is true if one was found.
271 Get(sessionId string) (session *sessionState, ok bool)
272
273 // Put adds the sessionState to the cache with the given session ID.
274 Put(sessionId string, session *sessionState)
275}
276
Adam Langley95c29f32014-06-20 12:00:00 -0700277// A Config structure is used to configure a TLS client or server.
278// After one has been passed to a TLS function it must not be
279// modified. A Config may be reused; the tls package will also not
280// modify it.
281type Config struct {
282 // Rand provides the source of entropy for nonces and RSA blinding.
283 // If Rand is nil, TLS uses the cryptographic random reader in package
284 // crypto/rand.
285 // The Reader must be safe for use by multiple goroutines.
286 Rand io.Reader
287
288 // Time returns the current time as the number of seconds since the epoch.
289 // If Time is nil, TLS uses time.Now.
290 Time func() time.Time
291
292 // Certificates contains one or more certificate chains
293 // to present to the other side of the connection.
294 // Server configurations must include at least one certificate.
295 Certificates []Certificate
296
297 // NameToCertificate maps from a certificate name to an element of
298 // Certificates. Note that a certificate name can be of the form
299 // '*.example.com' and so doesn't have to be a domain name as such.
300 // See Config.BuildNameToCertificate
301 // The nil value causes the first element of Certificates to be used
302 // for all connections.
303 NameToCertificate map[string]*Certificate
304
305 // RootCAs defines the set of root certificate authorities
306 // that clients use when verifying server certificates.
307 // If RootCAs is nil, TLS uses the host's root CA set.
308 RootCAs *x509.CertPool
309
310 // NextProtos is a list of supported, application level protocols.
311 NextProtos []string
312
313 // ServerName is used to verify the hostname on the returned
314 // certificates unless InsecureSkipVerify is given. It is also included
315 // in the client's handshake to support virtual hosting.
316 ServerName string
317
318 // ClientAuth determines the server's policy for
319 // TLS Client Authentication. The default is NoClientCert.
320 ClientAuth ClientAuthType
321
322 // ClientCAs defines the set of root certificate authorities
323 // that servers use if required to verify a client certificate
324 // by the policy in ClientAuth.
325 ClientCAs *x509.CertPool
326
David Benjamin7b030512014-07-08 17:30:11 -0400327 // ClientCertificateTypes defines the set of allowed client certificate
328 // types. The default is CertTypeRSASign and CertTypeECDSASign.
329 ClientCertificateTypes []byte
330
Adam Langley95c29f32014-06-20 12:00:00 -0700331 // InsecureSkipVerify controls whether a client verifies the
332 // server's certificate chain and host name.
333 // If InsecureSkipVerify is true, TLS accepts any certificate
334 // presented by the server and any host name in that certificate.
335 // In this mode, TLS is susceptible to man-in-the-middle attacks.
336 // This should be used only for testing.
337 InsecureSkipVerify bool
338
339 // CipherSuites is a list of supported cipher suites. If CipherSuites
340 // is nil, TLS uses a list of suites supported by the implementation.
341 CipherSuites []uint16
342
343 // PreferServerCipherSuites controls whether the server selects the
344 // client's most preferred ciphersuite, or the server's most preferred
345 // ciphersuite. If true then the server's preference, as expressed in
346 // the order of elements in CipherSuites, is used.
347 PreferServerCipherSuites bool
348
349 // SessionTicketsDisabled may be set to true to disable session ticket
350 // (resumption) support.
351 SessionTicketsDisabled bool
352
353 // SessionTicketKey is used by TLS servers to provide session
354 // resumption. See RFC 5077. If zero, it will be filled with
355 // random data before the first server handshake.
356 //
357 // If multiple servers are terminating connections for the same host
358 // they should all have the same SessionTicketKey. If the
359 // SessionTicketKey leaks, previously recorded and future TLS
360 // connections using that key are compromised.
361 SessionTicketKey [32]byte
362
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500363 // ClientSessionCache is a cache of ClientSessionState entries
364 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700365 ClientSessionCache ClientSessionCache
366
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500367 // ServerSessionCache is a cache of sessionState entries for TLS session
368 // resumption.
369 ServerSessionCache ServerSessionCache
370
Adam Langley95c29f32014-06-20 12:00:00 -0700371 // MinVersion contains the minimum SSL/TLS version that is acceptable.
372 // If zero, then SSLv3 is taken as the minimum.
373 MinVersion uint16
374
375 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
376 // If zero, then the maximum version supported by this package is used,
377 // which is currently TLS 1.2.
378 MaxVersion uint16
379
380 // CurvePreferences contains the elliptic curves that will be used in
381 // an ECDHE handshake, in preference order. If empty, the default will
382 // be used.
383 CurvePreferences []CurveID
384
Nick Harperdcfbc672016-07-16 17:47:31 +0200385 // DefaultCurves contains the elliptic curves for which public values will
386 // be sent in the ClientHello's KeyShare extension. If this value is nil,
387 // all supported curves will have public values sent. This field is ignored
388 // on servers.
389 DefaultCurves []CurveID
390
David Benjamind30a9902014-08-24 01:44:23 -0400391 // ChannelID contains the ECDSA key for the client to use as
392 // its TLS Channel ID.
393 ChannelID *ecdsa.PrivateKey
394
395 // RequestChannelID controls whether the server requests a TLS
396 // Channel ID. If negotiated, the client's public key is
397 // returned in the ConnectionState.
398 RequestChannelID bool
399
David Benjamin48cae082014-10-27 01:06:24 -0400400 // PreSharedKey, if not nil, is the pre-shared key to use with
401 // the PSK cipher suites.
402 PreSharedKey []byte
403
404 // PreSharedKeyIdentity, if not empty, is the identity to use
405 // with the PSK cipher suites.
406 PreSharedKeyIdentity string
407
David Benjaminca6c8262014-11-15 19:06:08 -0500408 // SRTPProtectionProfiles, if not nil, is the list of SRTP
409 // protection profiles to offer in DTLS-SRTP.
410 SRTPProtectionProfiles []uint16
411
David Benjamin7a41d372016-07-09 11:21:54 -0700412 // SignSignatureAlgorithms, if not nil, overrides the default set of
413 // supported signature algorithms to sign with.
414 SignSignatureAlgorithms []signatureAlgorithm
415
416 // VerifySignatureAlgorithms, if not nil, overrides the default set of
417 // supported signature algorithms that are accepted.
418 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500419
Adam Langley95c29f32014-06-20 12:00:00 -0700420 // Bugs specifies optional misbehaviour to be used for testing other
421 // implementations.
422 Bugs ProtocolBugs
423
424 serverInitOnce sync.Once // guards calling (*Config).serverInit
425}
426
427type BadValue int
428
429const (
430 BadValueNone BadValue = iota
431 BadValueNegative
432 BadValueZero
433 BadValueLimit
434 BadValueLarge
435 NumBadValues
436)
437
David Benjaminb36a3952015-12-01 18:53:13 -0500438type RSABadValue int
439
440const (
441 RSABadValueNone RSABadValue = iota
442 RSABadValueCorrupt
443 RSABadValueTooLong
444 RSABadValueTooShort
445 RSABadValueWrongVersion
446 NumRSABadValues
447)
448
Adam Langley95c29f32014-06-20 12:00:00 -0700449type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400450 // InvalidSignature specifies that the signature in a ServerKeyExchange
451 // or CertificateVerify message should be invalid.
452 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400453
Steven Valdez5440fe02016-07-18 12:40:30 -0400454 // SendCurve, if non-zero, causes the server to send the specified curve
455 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
456 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400457 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700458
Steven Valdez5440fe02016-07-18 12:40:30 -0400459 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
460 // the specified curve in HelloRetryRequest rather than the negotiated
461 // one.
462 SendHelloRetryRequestCurve CurveID
463
David Benjamin2b07fa42016-03-02 00:23:57 -0500464 // InvalidECDHPoint, if true, causes the ECC points in
465 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
466 InvalidECDHPoint bool
467
Adam Langley95c29f32014-06-20 12:00:00 -0700468 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
469 // can be invalid.
470 BadECDSAR BadValue
471 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700472
473 // MaxPadding causes CBC records to have the maximum possible padding.
474 MaxPadding bool
475 // PaddingFirstByteBad causes the first byte of the padding to be
476 // incorrect.
477 PaddingFirstByteBad bool
478 // PaddingFirstByteBadIf255 causes the first byte of padding to be
479 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
480 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700481
482 // FailIfNotFallbackSCSV causes a server handshake to fail if the
483 // client doesn't send the fallback SCSV value.
484 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400485
486 // DuplicateExtension causes an extra empty extension of bogus type to
487 // be emitted in either the ClientHello or the ServerHello.
488 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400489
490 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
491 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
492 // Certificate message is sent and no signature is added to
493 // ServerKeyExchange.
494 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400495
David Benjaminb80168e2015-02-08 18:30:14 -0500496 // SkipHelloVerifyRequest causes a DTLS server to skip the
497 // HelloVerifyRequest message.
498 SkipHelloVerifyRequest bool
499
David Benjamindcd979f2015-04-20 18:26:52 -0400500 // SkipCertificateStatus, if true, causes the server to skip the
501 // CertificateStatus message. This is legal because CertificateStatus is
502 // optional, even with a status_request in ServerHello.
503 SkipCertificateStatus bool
504
David Benjamin9c651c92014-07-12 13:27:45 -0400505 // SkipServerKeyExchange causes the server to skip sending
506 // ServerKeyExchange messages.
507 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400508
David Benjaminb80168e2015-02-08 18:30:14 -0500509 // SkipNewSessionTicket causes the server to skip sending the
510 // NewSessionTicket message despite promising to in ServerHello.
511 SkipNewSessionTicket bool
512
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500513 // SkipClientCertificate causes the client to skip the Certificate
514 // message.
515 SkipClientCertificate bool
516
David Benjamina0e52232014-07-19 17:39:58 -0400517 // SkipChangeCipherSpec causes the implementation to skip
518 // sending the ChangeCipherSpec message (and adjusting cipher
519 // state accordingly for the Finished message).
520 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400521
David Benjaminb80168e2015-02-08 18:30:14 -0500522 // SkipFinished causes the implementation to skip sending the Finished
523 // message.
524 SkipFinished bool
525
David Benjaminf3ec83d2014-07-21 22:42:34 -0400526 // EarlyChangeCipherSpec causes the client to send an early
527 // ChangeCipherSpec message before the ClientKeyExchange. A value of
528 // zero disables this behavior. One and two configure variants for 0.9.8
529 // and 1.0.1 modes, respectively.
530 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400531
David Benjamin8144f992016-06-22 17:05:13 -0400532 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
533 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
534 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
535 StrayChangeCipherSpec bool
536
David Benjamin86271ee2014-07-21 16:14:03 -0400537 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
538 // the Finished (or NextProto) message around the ChangeCipherSpec
539 // messages.
540 FragmentAcrossChangeCipherSpec bool
541
David Benjamin61672812016-07-14 23:10:43 -0400542 // SendUnencryptedFinished, if true, causes the Finished message to be
543 // send unencrypted before ChangeCipherSpec rather than after it.
544 SendUnencryptedFinished bool
545
David Benjamin7964b182016-07-14 23:36:30 -0400546 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
547 // 1.3 server to send part of EncryptedExtensions unencrypted
548 // in the same record as ServerHello.
549 PartialEncryptedExtensionsWithServerHello bool
550
551 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
552 // client to send part of Finished unencrypted in the same record as
553 // ClientHello.
554 PartialClientFinishedWithClientHello bool
555
David Benjamind86c7672014-08-02 04:07:12 -0400556 // SendV2ClientHello causes the client to send a V2ClientHello
557 // instead of a normal ClientHello.
558 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400559
560 // SendFallbackSCSV causes the client to include
561 // TLS_FALLBACK_SCSV in the ClientHello.
562 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400563
Adam Langley5021b222015-06-12 18:27:58 -0700564 // SendRenegotiationSCSV causes the client to include the renegotiation
565 // SCSV in the ClientHello.
566 SendRenegotiationSCSV bool
567
David Benjamin43ec06f2014-08-05 02:28:57 -0400568 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400569 // handshake record. Handshake messages will be split into multiple
570 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400571 // never be fragmented. For DTLS, it is the maximum handshake fragment
572 // size, not record size; DTLS allows multiple handshake fragments in a
573 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400574 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400575
David Benjamin98214542014-08-07 18:02:39 -0400576 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
577 // the first 6 bytes of the ClientHello.
578 FragmentClientVersion bool
579
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400580 // FragmentAlert will cause all alerts to be fragmented across
581 // two records.
582 FragmentAlert bool
583
David Benjamin0d3a8c62016-03-11 22:25:18 -0500584 // DoubleAlert will cause all alerts to be sent as two copies packed
585 // within one record.
586 DoubleAlert bool
587
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500588 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
589 // alert to be sent.
590 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400591
David Benjaminb36a3952015-12-01 18:53:13 -0500592 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
593 // ClientKeyExchange which would not pass padding checks.
594 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400595
596 // RenewTicketOnResume causes the server to renew the session ticket and
597 // send a NewSessionTicket message during an abbreviated handshake.
598 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400599
600 // SendClientVersion, if non-zero, causes the client to send a different
601 // TLS version in the ClientHello than the maximum supported version.
602 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400603
David Benjamin1f61f0d2016-07-10 12:20:35 -0400604 // NegotiateVersion, if non-zero, causes the server to negotiate the
605 // specifed TLS version rather than the version supported by either
606 // peer.
607 NegotiateVersion uint16
608
David Benjamine7e36aa2016-08-08 12:39:41 -0400609 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
610 // the specified TLS version on renegotiation rather than retaining it.
611 NegotiateVersionOnRenego uint16
612
David Benjamine58c4f52014-08-24 03:47:07 -0400613 // ExpectFalseStart causes the server to, on full handshakes,
614 // expect the peer to False Start; the server Finished message
615 // isn't sent until we receive an application data record
616 // from the peer.
617 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400618
David Benjamin1c633152015-04-02 20:19:11 -0400619 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
620 // handshakes, send an alert just before reading the application data
621 // record to test False Start. This can be used in a negative False
622 // Start test to determine whether the peer processed the alert (and
623 // closed the connection) before or after sending app data.
624 AlertBeforeFalseStartTest alert
625
David Benjamine78bfde2014-09-06 12:45:15 -0400626 // ExpectServerName, if not empty, is the hostname the client
627 // must specify in the server_name extension.
628 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400629
David Benjamin76c2efc2015-08-31 14:24:29 -0400630 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
631 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400632 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400633
Adam Langleyefb0e162015-07-09 11:35:04 -0700634 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
635 // return.
636 ALPNProtocol *string
637
David Benjamin405da482016-08-08 17:25:07 -0400638 // AcceptAnySession causes the server to resume sessions regardless of
639 // the version associated with the session or cipher suite. It also
640 // causes the server to look in both TLS 1.2 and 1.3 extensions to
641 // process a ticket.
642 AcceptAnySession bool
643
644 // SendBothTickets, if true, causes the client to send tickets in both
645 // TLS 1.2 and 1.3 extensions.
646 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700647
648 // CorruptTicket causes a client to corrupt a session ticket before
649 // sending it in a resume handshake.
650 CorruptTicket bool
651
652 // OversizedSessionId causes the session id that is sent with a ticket
653 // resumption attempt to be too large (33 bytes).
654 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700655
David Benjamin405da482016-08-08 17:25:07 -0400656 // ExpectNoTLS12Session, if true, causes the server to fail the
657 // connection if either a session ID or TLS 1.2 ticket is offered.
658 ExpectNoTLS12Session bool
659
660 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
661 // if a TLS 1.3 PSK is offered.
662 ExpectNoTLS13PSK bool
663
Adam Langley75712922014-10-10 16:23:43 -0700664 // RequireExtendedMasterSecret, if true, requires that the peer support
665 // the extended master secret option.
666 RequireExtendedMasterSecret bool
667
David Benjaminca6554b2014-11-08 12:31:52 -0500668 // NoExtendedMasterSecret causes the client and server to behave as if
Adam Langley75712922014-10-10 16:23:43 -0700669 // they didn't support an extended master secret.
670 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700671
672 // EmptyRenegotiationInfo causes the renegotiation extension to be
673 // empty in a renegotiation handshake.
674 EmptyRenegotiationInfo bool
675
676 // BadRenegotiationInfo causes the renegotiation extension value in a
677 // renegotiation handshake to be incorrect.
678 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500679
David Benjamin3e052de2015-11-25 20:10:31 -0500680 // NoRenegotiationInfo disables renegotiation info support in all
681 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500682 NoRenegotiationInfo bool
683
David Benjamin3e052de2015-11-25 20:10:31 -0500684 // NoRenegotiationInfoInInitial disables renegotiation info support in
685 // the initial handshake.
686 NoRenegotiationInfoInInitial bool
687
688 // NoRenegotiationInfoAfterInitial disables renegotiation info support
689 // in renegotiation handshakes.
690 NoRenegotiationInfoAfterInitial bool
691
Adam Langley5021b222015-06-12 18:27:58 -0700692 // RequireRenegotiationInfo, if true, causes the client to return an
693 // error if the server doesn't reply with the renegotiation extension.
694 RequireRenegotiationInfo bool
695
David Benjamin8e6db492015-07-25 18:29:23 -0400696 // SequenceNumberMapping, if non-nil, is the mapping function to apply
697 // to the sequence number of outgoing packets. For both TLS and DTLS,
698 // the two most-significant bytes in the resulting sequence number are
699 // ignored so that the DTLS epoch cannot be changed.
700 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500701
David Benjamina3e89492015-02-26 15:16:22 -0500702 // RSAEphemeralKey, if true, causes the server to send a
703 // ServerKeyExchange message containing an ephemeral key (as in
704 // RSA_EXPORT) in the plain RSA key exchange.
705 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500706
707 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
708 // client offers when negotiating SRTP. MKI support is still missing so
709 // the peer must still send none.
710 SRTPMasterKeyIdentifer string
711
712 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
713 // server sends in the ServerHello instead of the negotiated one.
714 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500715
Nick Harper60edffd2016-06-21 15:19:24 -0700716 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500717 // signature and hashes extension.
718 //
719 // For a server, it will cause an empty list to be sent in the
720 // CertificateRequest message. None the less, the configured set will
721 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700722 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500723
David Benjamin55a43642015-04-20 14:45:55 -0400724 // NoSupportedCurves, if true, causes the client to omit the
725 // supported_curves extension.
726 NoSupportedCurves bool
727
David Benjaminc44b1df2014-11-23 12:11:01 -0500728 // RequireSameRenegoClientVersion, if true, causes the server
729 // to require that all ClientHellos match in offered version
730 // across a renego.
731 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800732
David Benjamin1e29a6b2014-12-10 02:27:24 -0500733 // ExpectInitialRecordVersion, if non-zero, is the expected
734 // version of the records before the version is determined.
735 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500736
737 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
738 // packet.
739 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500740
741 // SendCipherSuite, if non-zero, is the cipher suite value that the
742 // server will send in the ServerHello. This does not affect the cipher
743 // the server believes it has actually negotiated.
744 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500745
David Benjamin4cf369b2015-08-22 01:35:43 -0400746 // AppDataBeforeHandshake, if not nil, causes application data to be
747 // sent immediately before the first handshake message.
748 AppDataBeforeHandshake []byte
749
750 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500751 // be sent immediately after ChangeCipherSpec.
752 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500753
David Benjamindc3da932015-03-12 15:09:02 -0400754 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
755 // immediately after ChangeCipherSpec.
756 AlertAfterChangeCipherSpec alert
757
David Benjamin83f90402015-01-27 01:09:43 -0500758 // TimeoutSchedule is the schedule of packet drops and simulated
759 // timeouts for before each handshake leg from the peer.
760 TimeoutSchedule []time.Duration
761
762 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
763 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500764
765 // ReorderHandshakeFragments, if true, causes handshake fragments in
766 // DTLS to overlap and be sent in the wrong order. It also causes
767 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
768 // Finished and will trigger a spurious retransmit.)
769 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500770
David Benjamin61672812016-07-14 23:10:43 -0400771 // ReverseHandshakeFragments, if true, causes handshake fragments in
772 // DTLS to be reversed within a flight.
773 ReverseHandshakeFragments bool
774
David Benjamin75381222015-03-02 19:30:30 -0500775 // MixCompleteMessageWithFragments, if true, causes handshake
776 // messages in DTLS to redundantly both fragment the message
777 // and include a copy of the full one.
778 MixCompleteMessageWithFragments bool
779
David Benjaminddb9f152015-02-03 15:44:39 -0500780 // SendInvalidRecordType, if true, causes a record with an invalid
781 // content type to be sent immediately following the handshake.
782 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500783
David Benjamin0b8d5da2016-07-15 00:39:56 -0400784 // SendWrongMessageType, if non-zero, causes messages of the specified
785 // type to be sent with the wrong value.
786 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500787
788 // FragmentMessageTypeMismatch, if true, causes all non-initial
789 // handshake fragments in DTLS to have the wrong message type.
790 FragmentMessageTypeMismatch bool
791
792 // FragmentMessageLengthMismatch, if true, causes all non-initial
793 // handshake fragments in DTLS to have the wrong message length.
794 FragmentMessageLengthMismatch bool
795
David Benjamin11fc66a2015-06-16 11:40:24 -0400796 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
797 // to be split across two records. The value of |SplitFragments| is the
798 // number of bytes in the first fragment.
799 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500800
801 // SendEmptyFragments, if true, causes handshakes to include empty
802 // fragments in DTLS.
803 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400804
David Benjamin9a41d1b2015-05-16 01:30:09 -0400805 // SendSplitAlert, if true, causes an alert to be sent with the header
806 // and record body split across multiple packets. The peer should
807 // discard these packets rather than process it.
808 SendSplitAlert bool
809
David Benjamin4b27d9f2015-05-12 22:42:52 -0400810 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
811 // client offers a resumption or the server accepts one.
812 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400813
David Benjamin67d1fb52015-03-16 15:16:23 -0400814 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
815 // preferences to be ignored.
816 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400817
818 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
819 // signature algorithm preferences to be ignored.
820 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400821
David Benjaminc574f412015-04-20 11:13:01 -0400822 // IgnorePeerCurvePreferences, if true, causes the peer's curve
823 // preferences to be ignored.
824 IgnorePeerCurvePreferences bool
825
David Benjamin513f0ea2015-04-02 19:33:31 -0400826 // BadFinished, if true, causes the Finished hash to be broken.
827 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700828
829 // DHGroupPrime, if not nil, is used to define the (finite field)
830 // Diffie-Hellman group. The generator used is always two.
831 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400832
David Benjamin582ba042016-07-07 12:33:25 -0700833 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
834 // to be packed into individual handshake records, up to the specified
835 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400836 PackHandshakeFragments int
837
David Benjamin582ba042016-07-07 12:33:25 -0700838 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
839 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400840 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400841
David Benjamin582ba042016-07-07 12:33:25 -0700842 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
843 // be packed into records, up to the largest size record available.
844 PackHandshakeFlight bool
845
David Benjamin0407e762016-06-17 16:41:18 -0400846 // EnableAllCiphers, if true, causes all configured ciphers to be
847 // enabled.
848 EnableAllCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400849
850 // EmptyCertificateList, if true, causes the server to send an empty
851 // certificate list in the Certificate message.
852 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400853
854 // ExpectNewTicket, if true, causes the client to abort if it does not
855 // receive a new ticket.
856 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700857
858 // RequireClientHelloSize, if not zero, is the required length in bytes
859 // of the ClientHello /record/. This is checked by the server.
860 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700861
862 // CustomExtension, if not empty, contains the contents of an extension
863 // that will be added to client/server hellos.
864 CustomExtension string
865
866 // ExpectedCustomExtension, if not nil, contains the expected contents
867 // of a custom extension.
868 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400869
870 // NoCloseNotify, if true, causes the close_notify alert to be skipped
871 // on connection shutdown.
872 NoCloseNotify bool
873
David Benjaminfa214e42016-05-10 17:03:10 -0400874 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
875 // close_notify on shutdown.
876 SendAlertOnShutdown alert
877
David Benjamin30789da2015-08-29 22:56:45 -0400878 // ExpectCloseNotify, if true, requires a close_notify from the peer on
879 // shutdown. Records from the peer received after close_notify is sent
880 // are not discard.
881 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400882
883 // SendLargeRecords, if true, allows outgoing records to be sent
884 // arbitrarily large.
885 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400886
887 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
888 // ALPN and NPN in the same connetion.
889 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400890
David Benjamin0c40a962016-08-01 12:05:50 -0400891 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400892 // string in the ALPN extension regardless of the content or presence of
893 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400894 SendALPN string
895
David Benjamindd6fed92015-10-23 17:41:12 -0400896 // SendEmptySessionTicket, if true, causes the server to send an empty
897 // session ticket.
898 SendEmptySessionTicket bool
899
900 // FailIfSessionOffered, if true, causes the server to fail any
901 // connections where the client offers a non-empty session ID or session
902 // ticket.
903 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800904
905 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
906 // HelloRequest handshake message to be sent before each application
907 // data record. This only makes sense for a server.
908 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800909
David Benjamin71dd6662016-07-08 14:10:48 -0700910 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
911 // HelloRequest handshake message to be sent before each handshake
912 // message. This only makes sense for a server.
913 SendHelloRequestBeforeEveryHandshakeMessage bool
914
Steven Valdez1dc53d22016-07-26 12:27:38 -0400915 // SendKeyUpdateBeforeEveryAppDataRecord, if true, causes a KeyUpdate
916 // handshake message to be sent before each application data record.
917 SendKeyUpdateBeforeEveryAppDataRecord bool
918
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800919 // RequireDHPublicValueLen causes a fatal error if the length (in
920 // bytes) of the server's Diffie-Hellman public value is not equal to
921 // this.
922 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500923
924 // BadChangeCipherSpec, if not nil, is the body to be sent in
925 // ChangeCipherSpec records instead of {1}.
926 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -0500927
928 // BadHelloRequest, if not nil, is what to send instead of a
929 // HelloRequest.
930 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -0500931
932 // RequireSessionTickets, if true, causes the client to require new
933 // sessions use session tickets instead of session IDs.
934 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -0500935
936 // NullAllCiphers, if true, causes every cipher to behave like the null
937 // cipher.
938 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -0400939
940 // SendSCTListOnResume, if not nil, causes the server to send the
941 // supplied SCT list in resumption handshakes.
942 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -0700943
944 // CECPQ1BadX25519Part corrupts the X25519 part of a CECPQ1 key exchange, as
945 // a trivial proof that it is actually used.
946 CECPQ1BadX25519Part bool
947
948 // CECPQ1BadNewhopePart corrupts the Newhope part of a CECPQ1 key exchange,
949 // as a trivial proof that it is actually used.
950 CECPQ1BadNewhopePart bool
David Benjaminc9ae27c2016-06-24 22:56:37 -0400951
952 // RecordPadding is the number of bytes of padding to add to each
953 // encrypted record in TLS 1.3.
954 RecordPadding int
955
956 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
957 // be missing their body and content type. Padding, if configured, is
958 // still added.
959 OmitRecordContents bool
960
961 // OuterRecordType, if non-zero, is the outer record type to use instead
962 // of application data.
963 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -0700964
965 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
966 // with the given signature algorithm rather than the one negotiated.
967 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -0700968
969 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
970 // skipped.
971 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -0400972
973 // IgnoreSignatureVersionChecks, if true, causes all signature
974 // algorithms to be enabled at all TLS versions.
975 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -0400976
977 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
978 // Renegotiation Info to be negotiated at all versions.
979 NegotiateRenegotiationInfoAtAllVersions bool
980
981 // NegotiateChannelIDAtAllVersions, if true, causes Channel ID to be
982 // negotiated at all versions.
983 NegotiateChannelIDAtAllVersions bool
984
985 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
986 // all versions.
987 NegotiateNPNAtAllVersions bool
988
989 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
990 // all versions.
991 NegotiateEMSAtAllVersions bool
992
993 // AdvertiseTicketExtension, if true, causes the ticket extension to be
994 // advertised in server extensions
995 AdvertiseTicketExtension bool
996
997 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
998 // sending a key_share extension and use the zero ECDHE secret
999 // instead.
1000 MissingKeyShare bool
1001
Steven Valdez5440fe02016-07-18 12:40:30 -04001002 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1003 // ClientHello to skip sending a key_share extension and use the zero
1004 // ECDHE secret instead.
1005 SecondClientHelloMissingKeyShare bool
1006
1007 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1008 // client to pretend the server requested a HelloRetryRequest with the
1009 // given curve rather than the actual one.
1010 MisinterpretHelloRetryRequestCurve CurveID
1011
Steven Valdez143e8b32016-07-11 13:19:03 -04001012 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1013 // copies of each KeyShareEntry.
1014 DuplicateKeyShares bool
1015
1016 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1017 // emit an empty EncryptedExtensions block.
1018 EmptyEncryptedExtensions bool
1019
1020 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1021 // include the KeyShare extension in the EncryptedExtensions block.
1022 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001023
1024 // UnnecessaryHelloRetryRequest, if true, causes the TLS 1.3 server to
1025 // send a HelloRetryRequest regardless of whether it needs to.
1026 UnnecessaryHelloRetryRequest bool
1027
1028 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1029 // two HelloRetryRequests instead of one.
1030 SecondHelloRetryRequest bool
1031
1032 // SendServerHelloVersion, if non-zero, causes the server to send the
1033 // specified version in ServerHello rather than the true version.
1034 SendServerHelloVersion uint16
1035
1036 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1037 // HelloRetryRequest.
1038 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001039
1040 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1041 // HelloRequest in the same record as Finished.
1042 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001043
1044 // SendExtraFinished, if true, causes an extra Finished message to be
1045 // sent.
1046 SendExtraFinished bool
Adam Langley95c29f32014-06-20 12:00:00 -07001047}
1048
1049func (c *Config) serverInit() {
1050 if c.SessionTicketsDisabled {
1051 return
1052 }
1053
1054 // If the key has already been set then we have nothing to do.
1055 for _, b := range c.SessionTicketKey {
1056 if b != 0 {
1057 return
1058 }
1059 }
1060
1061 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1062 c.SessionTicketsDisabled = true
1063 }
1064}
1065
1066func (c *Config) rand() io.Reader {
1067 r := c.Rand
1068 if r == nil {
1069 return rand.Reader
1070 }
1071 return r
1072}
1073
1074func (c *Config) time() time.Time {
1075 t := c.Time
1076 if t == nil {
1077 t = time.Now
1078 }
1079 return t()
1080}
1081
1082func (c *Config) cipherSuites() []uint16 {
1083 s := c.CipherSuites
1084 if s == nil {
1085 s = defaultCipherSuites()
1086 }
1087 return s
1088}
1089
David Benjamincecee272016-06-30 13:33:47 -04001090func (c *Config) minVersion(isDTLS bool) uint16 {
1091 ret := uint16(minVersion)
1092 if c != nil && c.MinVersion != 0 {
1093 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001094 }
David Benjamincecee272016-06-30 13:33:47 -04001095 if isDTLS {
1096 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1097 if ret < VersionTLS10 {
1098 return VersionTLS10
1099 }
1100 // There is no such thing as DTLS 1.1.
1101 if ret == VersionTLS11 {
1102 return VersionTLS12
1103 }
1104 }
1105 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001106}
1107
David Benjamincecee272016-06-30 13:33:47 -04001108func (c *Config) maxVersion(isDTLS bool) uint16 {
1109 ret := uint16(maxVersion)
1110 if c != nil && c.MaxVersion != 0 {
1111 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001112 }
David Benjamincecee272016-06-30 13:33:47 -04001113 if isDTLS {
1114 // We only implement up to DTLS 1.2.
1115 if ret > VersionTLS12 {
1116 return VersionTLS12
1117 }
1118 // There is no such thing as DTLS 1.1.
1119 if ret == VersionTLS11 {
1120 return VersionTLS10
1121 }
1122 }
1123 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001124}
1125
David Benjamincba2b622015-12-18 22:13:41 -05001126var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001127
1128func (c *Config) curvePreferences() []CurveID {
1129 if c == nil || len(c.CurvePreferences) == 0 {
1130 return defaultCurvePreferences
1131 }
1132 return c.CurvePreferences
1133}
1134
Nick Harperdcfbc672016-07-16 17:47:31 +02001135func (c *Config) defaultCurves() map[CurveID]bool {
1136 defaultCurves := make(map[CurveID]bool)
1137 curves := c.DefaultCurves
1138 if c == nil || c.DefaultCurves == nil {
1139 curves = c.curvePreferences()
1140 }
1141 for _, curveID := range curves {
1142 defaultCurves[curveID] = true
1143 }
1144 return defaultCurves
1145}
1146
Adam Langley95c29f32014-06-20 12:00:00 -07001147// mutualVersion returns the protocol version to use given the advertised
1148// version of the peer.
David Benjamincecee272016-06-30 13:33:47 -04001149func (c *Config) mutualVersion(vers uint16, isDTLS bool) (uint16, bool) {
1150 // There is no such thing as DTLS 1.1.
1151 if isDTLS && vers == VersionTLS11 {
1152 vers = VersionTLS10
1153 }
1154
1155 minVersion := c.minVersion(isDTLS)
1156 maxVersion := c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001157
1158 if vers < minVersion {
1159 return 0, false
1160 }
1161 if vers > maxVersion {
1162 vers = maxVersion
1163 }
1164 return vers, true
1165}
1166
1167// getCertificateForName returns the best certificate for the given name,
1168// defaulting to the first element of c.Certificates if there are no good
1169// options.
1170func (c *Config) getCertificateForName(name string) *Certificate {
1171 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1172 // There's only one choice, so no point doing any work.
1173 return &c.Certificates[0]
1174 }
1175
1176 name = strings.ToLower(name)
1177 for len(name) > 0 && name[len(name)-1] == '.' {
1178 name = name[:len(name)-1]
1179 }
1180
1181 if cert, ok := c.NameToCertificate[name]; ok {
1182 return cert
1183 }
1184
1185 // try replacing labels in the name with wildcards until we get a
1186 // match.
1187 labels := strings.Split(name, ".")
1188 for i := range labels {
1189 labels[i] = "*"
1190 candidate := strings.Join(labels, ".")
1191 if cert, ok := c.NameToCertificate[candidate]; ok {
1192 return cert
1193 }
1194 }
1195
1196 // If nothing matches, return the first certificate.
1197 return &c.Certificates[0]
1198}
1199
David Benjamin7a41d372016-07-09 11:21:54 -07001200func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1201 if c != nil && c.SignSignatureAlgorithms != nil {
1202 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001203 }
David Benjamin7a41d372016-07-09 11:21:54 -07001204 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001205}
1206
David Benjamin7a41d372016-07-09 11:21:54 -07001207func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1208 if c != nil && c.VerifySignatureAlgorithms != nil {
1209 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001210 }
David Benjamin7a41d372016-07-09 11:21:54 -07001211 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001212}
1213
Adam Langley95c29f32014-06-20 12:00:00 -07001214// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1215// from the CommonName and SubjectAlternateName fields of each of the leaf
1216// certificates.
1217func (c *Config) BuildNameToCertificate() {
1218 c.NameToCertificate = make(map[string]*Certificate)
1219 for i := range c.Certificates {
1220 cert := &c.Certificates[i]
1221 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1222 if err != nil {
1223 continue
1224 }
1225 if len(x509Cert.Subject.CommonName) > 0 {
1226 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1227 }
1228 for _, san := range x509Cert.DNSNames {
1229 c.NameToCertificate[san] = cert
1230 }
1231 }
1232}
1233
1234// A Certificate is a chain of one or more certificates, leaf first.
1235type Certificate struct {
1236 Certificate [][]byte
1237 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1238 // OCSPStaple contains an optional OCSP response which will be served
1239 // to clients that request it.
1240 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001241 // SignedCertificateTimestampList contains an optional encoded
1242 // SignedCertificateTimestampList structure which will be
1243 // served to clients that request it.
1244 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001245 // Leaf is the parsed form of the leaf certificate, which may be
1246 // initialized using x509.ParseCertificate to reduce per-handshake
1247 // processing for TLS clients doing client authentication. If nil, the
1248 // leaf certificate will be parsed as needed.
1249 Leaf *x509.Certificate
1250}
1251
1252// A TLS record.
1253type record struct {
1254 contentType recordType
1255 major, minor uint8
1256 payload []byte
1257}
1258
1259type handshakeMessage interface {
1260 marshal() []byte
1261 unmarshal([]byte) bool
1262}
1263
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001264// lruSessionCache is a client or server session cache implementation
1265// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001266type lruSessionCache struct {
1267 sync.Mutex
1268
1269 m map[string]*list.Element
1270 q *list.List
1271 capacity int
1272}
1273
1274type lruSessionCacheEntry struct {
1275 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001276 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001277}
1278
1279// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001280func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001281 c.Lock()
1282 defer c.Unlock()
1283
1284 if elem, ok := c.m[sessionKey]; ok {
1285 entry := elem.Value.(*lruSessionCacheEntry)
1286 entry.state = cs
1287 c.q.MoveToFront(elem)
1288 return
1289 }
1290
1291 if c.q.Len() < c.capacity {
1292 entry := &lruSessionCacheEntry{sessionKey, cs}
1293 c.m[sessionKey] = c.q.PushFront(entry)
1294 return
1295 }
1296
1297 elem := c.q.Back()
1298 entry := elem.Value.(*lruSessionCacheEntry)
1299 delete(c.m, entry.sessionKey)
1300 entry.sessionKey = sessionKey
1301 entry.state = cs
1302 c.q.MoveToFront(elem)
1303 c.m[sessionKey] = elem
1304}
1305
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001306// Get returns the value associated with a given key. It returns (nil,
1307// false) if no value is found.
1308func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001309 c.Lock()
1310 defer c.Unlock()
1311
1312 if elem, ok := c.m[sessionKey]; ok {
1313 c.q.MoveToFront(elem)
1314 return elem.Value.(*lruSessionCacheEntry).state, true
1315 }
1316 return nil, false
1317}
1318
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001319// lruClientSessionCache is a ClientSessionCache implementation that
1320// uses an LRU caching strategy.
1321type lruClientSessionCache struct {
1322 lruSessionCache
1323}
1324
1325func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1326 c.lruSessionCache.Put(sessionKey, cs)
1327}
1328
1329func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1330 cs, ok := c.lruSessionCache.Get(sessionKey)
1331 if !ok {
1332 return nil, false
1333 }
1334 return cs.(*ClientSessionState), true
1335}
1336
1337// lruServerSessionCache is a ServerSessionCache implementation that
1338// uses an LRU caching strategy.
1339type lruServerSessionCache struct {
1340 lruSessionCache
1341}
1342
1343func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1344 c.lruSessionCache.Put(sessionId, session)
1345}
1346
1347func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1348 cs, ok := c.lruSessionCache.Get(sessionId)
1349 if !ok {
1350 return nil, false
1351 }
1352 return cs.(*sessionState), true
1353}
1354
1355// NewLRUClientSessionCache returns a ClientSessionCache with the given
1356// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1357// is used instead.
1358func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1359 const defaultSessionCacheCapacity = 64
1360
1361 if capacity < 1 {
1362 capacity = defaultSessionCacheCapacity
1363 }
1364 return &lruClientSessionCache{
1365 lruSessionCache{
1366 m: make(map[string]*list.Element),
1367 q: list.New(),
1368 capacity: capacity,
1369 },
1370 }
1371}
1372
1373// NewLRUServerSessionCache returns a ServerSessionCache with the given
1374// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1375// is used instead.
1376func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1377 const defaultSessionCacheCapacity = 64
1378
1379 if capacity < 1 {
1380 capacity = defaultSessionCacheCapacity
1381 }
1382 return &lruServerSessionCache{
1383 lruSessionCache{
1384 m: make(map[string]*list.Element),
1385 q: list.New(),
1386 capacity: capacity,
1387 },
1388 }
1389}
1390
Adam Langley95c29f32014-06-20 12:00:00 -07001391// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1392type dsaSignature struct {
1393 R, S *big.Int
1394}
1395
1396type ecdsaSignature dsaSignature
1397
1398var emptyConfig Config
1399
1400func defaultConfig() *Config {
1401 return &emptyConfig
1402}
1403
1404var (
1405 once sync.Once
1406 varDefaultCipherSuites []uint16
1407)
1408
1409func defaultCipherSuites() []uint16 {
1410 once.Do(initDefaultCipherSuites)
1411 return varDefaultCipherSuites
1412}
1413
1414func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001415 for _, suite := range cipherSuites {
1416 if suite.flags&suitePSK == 0 {
1417 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1418 }
Adam Langley95c29f32014-06-20 12:00:00 -07001419 }
1420}
1421
1422func unexpectedMessageError(wanted, got interface{}) error {
1423 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1424}
David Benjamin000800a2014-11-14 01:43:59 -05001425
Nick Harper60edffd2016-06-21 15:19:24 -07001426func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1427 for _, s := range sigAlgs {
1428 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001429 return true
1430 }
1431 }
1432 return false
1433}
Nick Harper85f20c22016-07-04 10:11:59 -07001434
1435var (
1436 // See draft-ietf-tls-tls13-13, section 6.3.1.2.
1437 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1438 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1439)