blob: 92f3e15fd23328e1d4a5a2613c0c9fad480093ec [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
Steven Valdezfdd10992016-09-15 16:27:05 -040029// A draft version of TLS 1.3 that is sent over the wire for the current draft.
Steven Valdeza833c352016-11-01 13:39:36 -040030const tls13DraftVersion = 0x7f12
Nick Harper4d90c102016-07-17 10:53:26 +020031
Adam Langley95c29f32014-06-20 12:00:00 -070032const (
David Benjamin83c0bc92014-08-04 01:23:53 -040033 maxPlaintext = 16384 // maximum plaintext payload length
34 maxCiphertext = 16384 + 2048 // maximum ciphertext payload length
35 tlsRecordHeaderLen = 5 // record header length
36 dtlsRecordHeaderLen = 13
37 maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB)
Adam Langley95c29f32014-06-20 12:00:00 -070038
39 minVersion = VersionSSL30
Nick Harper1fd39d82016-06-14 18:14:35 -070040 maxVersion = VersionTLS13
Adam Langley95c29f32014-06-20 12:00:00 -070041)
42
43// TLS record types.
44type recordType uint8
45
46const (
47 recordTypeChangeCipherSpec recordType = 20
48 recordTypeAlert recordType = 21
49 recordTypeHandshake recordType = 22
50 recordTypeApplicationData recordType = 23
51)
52
53// TLS handshake message types.
54const (
David Benjamincedff872016-06-30 18:55:18 -040055 typeHelloRequest uint8 = 0
56 typeClientHello uint8 = 1
57 typeServerHello uint8 = 2
58 typeHelloVerifyRequest uint8 = 3
59 typeNewSessionTicket uint8 = 4
David Benjamina128a552016-10-13 14:26:33 -040060 typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-16
61 typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040062 typeCertificate uint8 = 11
63 typeServerKeyExchange uint8 = 12
64 typeCertificateRequest uint8 = 13
65 typeServerHelloDone uint8 = 14
66 typeCertificateVerify uint8 = 15
67 typeClientKeyExchange uint8 = 16
68 typeFinished uint8 = 20
69 typeCertificateStatus uint8 = 22
David Benjamina128a552016-10-13 14:26:33 -040070 typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040071 typeNextProtocol uint8 = 67 // Not IANA assigned
72 typeChannelID uint8 = 203 // Not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070073)
74
75// TLS compression types.
76const (
77 compressionNone uint8 = 0
78)
79
80// TLS extension numbers
81const (
David Benjamin61f95272014-11-25 01:55:35 -050082 extensionServerName uint16 = 0
83 extensionStatusRequest uint16 = 5
84 extensionSupportedCurves uint16 = 10
85 extensionSupportedPoints uint16 = 11
86 extensionSignatureAlgorithms uint16 = 13
87 extensionUseSRTP uint16 = 14
88 extensionALPN uint16 = 16
89 extensionSignedCertificateTimestamp uint16 = 18
90 extensionExtendedMasterSecret uint16 = 23
91 extensionSessionTicket uint16 = 35
David Benjamina128a552016-10-13 14:26:33 -040092 extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-16
93 extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-16
94 extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-16
Steven Valdezfdd10992016-09-15 16:27:05 -040095 extensionSupportedVersions uint16 = 43 // draft-ietf-tls-tls13-16
David Benjamina128a552016-10-13 14:26:33 -040096 extensionCookie uint16 = 44 // draft-ietf-tls-tls13-16
Steven Valdeza833c352016-11-01 13:39:36 -040097 extensionPSKKeyExchangeModes uint16 = 45 // draft-ietf-tls-tls13-18
Steven Valdez08b65f42016-12-07 15:29:45 -050098 extensionTicketEarlyDataInfo uint16 = 46 // draft-ietf-tls-tls13-18
David Benjamin399e7c92015-07-30 23:01:27 -040099 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -0500100 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
101 extensionRenegotiationInfo uint16 = 0xff01
102 extensionChannelID uint16 = 30032 // not IANA assigned
David Benjamin6f600d62016-12-21 16:06:54 -0500103 extensionShortHeader uint16 = 27463 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700104)
105
106// TLS signaling cipher suite values
107const (
108 scsvRenegotiation uint16 = 0x00ff
109)
110
111// CurveID is the type of a TLS identifier for an elliptic curve. See
112// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
113type CurveID uint16
114
115const (
David Benjamincba2b622015-12-18 22:13:41 -0500116 CurveP224 CurveID = 21
117 CurveP256 CurveID = 23
118 CurveP384 CurveID = 24
119 CurveP521 CurveID = 25
120 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700121)
122
123// TLS Elliptic Curve Point Formats
124// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
125const (
David Benjamina81967b2016-12-22 09:16:57 -0500126 pointFormatUncompressed uint8 = 0
127 pointFormatCompressedPrime uint8 = 1
Adam Langley95c29f32014-06-20 12:00:00 -0700128)
129
130// TLS CertificateStatusType (RFC 3546)
131const (
132 statusTypeOCSP uint8 = 1
133)
134
135// Certificate types (for certificateRequestMsg)
136const (
David Benjamin7b030512014-07-08 17:30:11 -0400137 CertTypeRSASign = 1 // A certificate containing an RSA key
138 CertTypeDSSSign = 2 // A certificate containing a DSA key
139 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
140 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700141
142 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400143 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
144 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
145 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700146
147 // Rest of these are reserved by the TLS spec
148)
149
Nick Harper60edffd2016-06-21 15:19:24 -0700150// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
151// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
152// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
153// algorithms' throughout. We match the latter.
154type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700155
Adam Langley95c29f32014-06-20 12:00:00 -0700156const (
Nick Harper60edffd2016-06-21 15:19:24 -0700157 // RSASSA-PKCS1-v1_5 algorithms
158 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
159 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
160 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
161 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
162 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700163
Nick Harper60edffd2016-06-21 15:19:24 -0700164 // ECDSA algorithms
165 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
166 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
167 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
168 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
169
170 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400171 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
172 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
173 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700174
175 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400176 signatureEd25519 signatureAlgorithm = 0x0807
177 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700178)
Adam Langley95c29f32014-06-20 12:00:00 -0700179
David Benjamin7a41d372016-07-09 11:21:54 -0700180// supportedSignatureAlgorithms contains the default supported signature
181// algorithms.
182var supportedSignatureAlgorithms = []signatureAlgorithm{
183 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700184 signatureRSAPKCS1WithSHA256,
185 signatureECDSAWithP256AndSHA256,
186 signatureRSAPKCS1WithSHA1,
187 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700188}
189
David Benjaminca6c8262014-11-15 19:06:08 -0500190// SRTP protection profiles (See RFC 5764, section 4.1.2)
191const (
192 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
193 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
194)
195
David Benjamina128a552016-10-13 14:26:33 -0400196// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200197const (
Steven Valdez5b986082016-09-01 12:29:49 -0400198 pskKEMode = 0
199 pskDHEKEMode = 1
200)
201
Steven Valdezc4aa7272016-10-03 12:25:56 -0400202// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
203const (
204 keyUpdateNotRequested = 0
205 keyUpdateRequested = 1
206)
207
Adam Langley95c29f32014-06-20 12:00:00 -0700208// ConnectionState records basic TLS details about the connection.
209type ConnectionState struct {
210 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
211 HandshakeComplete bool // TLS handshake is complete
212 DidResume bool // connection resumes a previous TLS connection
213 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
214 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
215 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400216 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700217 ServerName string // server name requested by client, if any (server side only)
218 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
219 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400220 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500221 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400222 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100223 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700224 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400225 CurveID CurveID // the curve used in ECDHE
David Benjamin6f600d62016-12-21 16:06:54 -0500226 ShortHeader bool // whether the short header extension was negotiated
Adam Langley95c29f32014-06-20 12:00:00 -0700227}
228
229// ClientAuthType declares the policy the server will follow for
230// TLS Client Authentication.
231type ClientAuthType int
232
233const (
234 NoClientCert ClientAuthType = iota
235 RequestClientCert
236 RequireAnyClientCert
237 VerifyClientCertIfGiven
238 RequireAndVerifyClientCert
239)
240
241// ClientSessionState contains the state needed by clients to resume TLS
242// sessions.
243type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500244 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700245 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
246 vers uint16 // SSL/TLS version negotiated for the session
247 cipherSuite uint16 // Ciphersuite negotiated for the session
248 masterSecret []byte // MasterSecret generated by client on a full handshake
249 handshakeHash []byte // Handshake hash for Channel ID purposes.
250 serverCertificates []*x509.Certificate // Certificate chain presented by the server
251 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100252 sctList []byte
253 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700254 ticketCreationTime time.Time
255 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400256 ticketAgeAdd uint32
Adam Langley95c29f32014-06-20 12:00:00 -0700257}
258
259// ClientSessionCache is a cache of ClientSessionState objects that can be used
260// by a client to resume a TLS session with a given server. ClientSessionCache
261// implementations should expect to be called concurrently from different
262// goroutines.
263type ClientSessionCache interface {
264 // Get searches for a ClientSessionState associated with the given key.
265 // On return, ok is true if one was found.
266 Get(sessionKey string) (session *ClientSessionState, ok bool)
267
268 // Put adds the ClientSessionState to the cache with the given key.
269 Put(sessionKey string, cs *ClientSessionState)
270}
271
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500272// ServerSessionCache is a cache of sessionState objects that can be used by a
273// client to resume a TLS session with a given server. ServerSessionCache
274// implementations should expect to be called concurrently from different
275// goroutines.
276type ServerSessionCache interface {
277 // Get searches for a sessionState associated with the given session
278 // ID. On return, ok is true if one was found.
279 Get(sessionId string) (session *sessionState, ok bool)
280
281 // Put adds the sessionState to the cache with the given session ID.
282 Put(sessionId string, session *sessionState)
283}
284
Adam Langley95c29f32014-06-20 12:00:00 -0700285// A Config structure is used to configure a TLS client or server.
286// After one has been passed to a TLS function it must not be
287// modified. A Config may be reused; the tls package will also not
288// modify it.
289type Config struct {
290 // Rand provides the source of entropy for nonces and RSA blinding.
291 // If Rand is nil, TLS uses the cryptographic random reader in package
292 // crypto/rand.
293 // The Reader must be safe for use by multiple goroutines.
294 Rand io.Reader
295
296 // Time returns the current time as the number of seconds since the epoch.
297 // If Time is nil, TLS uses time.Now.
298 Time func() time.Time
299
300 // Certificates contains one or more certificate chains
301 // to present to the other side of the connection.
302 // Server configurations must include at least one certificate.
303 Certificates []Certificate
304
305 // NameToCertificate maps from a certificate name to an element of
306 // Certificates. Note that a certificate name can be of the form
307 // '*.example.com' and so doesn't have to be a domain name as such.
308 // See Config.BuildNameToCertificate
309 // The nil value causes the first element of Certificates to be used
310 // for all connections.
311 NameToCertificate map[string]*Certificate
312
313 // RootCAs defines the set of root certificate authorities
314 // that clients use when verifying server certificates.
315 // If RootCAs is nil, TLS uses the host's root CA set.
316 RootCAs *x509.CertPool
317
318 // NextProtos is a list of supported, application level protocols.
319 NextProtos []string
320
321 // ServerName is used to verify the hostname on the returned
322 // certificates unless InsecureSkipVerify is given. It is also included
323 // in the client's handshake to support virtual hosting.
324 ServerName string
325
326 // ClientAuth determines the server's policy for
327 // TLS Client Authentication. The default is NoClientCert.
328 ClientAuth ClientAuthType
329
330 // ClientCAs defines the set of root certificate authorities
331 // that servers use if required to verify a client certificate
332 // by the policy in ClientAuth.
333 ClientCAs *x509.CertPool
334
David Benjamin7b030512014-07-08 17:30:11 -0400335 // ClientCertificateTypes defines the set of allowed client certificate
336 // types. The default is CertTypeRSASign and CertTypeECDSASign.
337 ClientCertificateTypes []byte
338
Adam Langley95c29f32014-06-20 12:00:00 -0700339 // InsecureSkipVerify controls whether a client verifies the
340 // server's certificate chain and host name.
341 // If InsecureSkipVerify is true, TLS accepts any certificate
342 // presented by the server and any host name in that certificate.
343 // In this mode, TLS is susceptible to man-in-the-middle attacks.
344 // This should be used only for testing.
345 InsecureSkipVerify bool
346
347 // CipherSuites is a list of supported cipher suites. If CipherSuites
348 // is nil, TLS uses a list of suites supported by the implementation.
349 CipherSuites []uint16
350
351 // PreferServerCipherSuites controls whether the server selects the
352 // client's most preferred ciphersuite, or the server's most preferred
353 // ciphersuite. If true then the server's preference, as expressed in
354 // the order of elements in CipherSuites, is used.
355 PreferServerCipherSuites bool
356
357 // SessionTicketsDisabled may be set to true to disable session ticket
358 // (resumption) support.
359 SessionTicketsDisabled bool
360
361 // SessionTicketKey is used by TLS servers to provide session
362 // resumption. See RFC 5077. If zero, it will be filled with
363 // random data before the first server handshake.
364 //
365 // If multiple servers are terminating connections for the same host
366 // they should all have the same SessionTicketKey. If the
367 // SessionTicketKey leaks, previously recorded and future TLS
368 // connections using that key are compromised.
369 SessionTicketKey [32]byte
370
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500371 // ClientSessionCache is a cache of ClientSessionState entries
372 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700373 ClientSessionCache ClientSessionCache
374
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500375 // ServerSessionCache is a cache of sessionState entries for TLS session
376 // resumption.
377 ServerSessionCache ServerSessionCache
378
Adam Langley95c29f32014-06-20 12:00:00 -0700379 // MinVersion contains the minimum SSL/TLS version that is acceptable.
380 // If zero, then SSLv3 is taken as the minimum.
381 MinVersion uint16
382
383 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
384 // If zero, then the maximum version supported by this package is used,
385 // which is currently TLS 1.2.
386 MaxVersion uint16
387
388 // CurvePreferences contains the elliptic curves that will be used in
389 // an ECDHE handshake, in preference order. If empty, the default will
390 // be used.
391 CurvePreferences []CurveID
392
Nick Harperdcfbc672016-07-16 17:47:31 +0200393 // DefaultCurves contains the elliptic curves for which public values will
394 // be sent in the ClientHello's KeyShare extension. If this value is nil,
395 // all supported curves will have public values sent. This field is ignored
396 // on servers.
397 DefaultCurves []CurveID
398
David Benjamind30a9902014-08-24 01:44:23 -0400399 // ChannelID contains the ECDSA key for the client to use as
400 // its TLS Channel ID.
401 ChannelID *ecdsa.PrivateKey
402
403 // RequestChannelID controls whether the server requests a TLS
404 // Channel ID. If negotiated, the client's public key is
405 // returned in the ConnectionState.
406 RequestChannelID bool
407
David Benjamin48cae082014-10-27 01:06:24 -0400408 // PreSharedKey, if not nil, is the pre-shared key to use with
409 // the PSK cipher suites.
410 PreSharedKey []byte
411
412 // PreSharedKeyIdentity, if not empty, is the identity to use
413 // with the PSK cipher suites.
414 PreSharedKeyIdentity string
415
David Benjaminca6c8262014-11-15 19:06:08 -0500416 // SRTPProtectionProfiles, if not nil, is the list of SRTP
417 // protection profiles to offer in DTLS-SRTP.
418 SRTPProtectionProfiles []uint16
419
David Benjamin7a41d372016-07-09 11:21:54 -0700420 // SignSignatureAlgorithms, if not nil, overrides the default set of
421 // supported signature algorithms to sign with.
422 SignSignatureAlgorithms []signatureAlgorithm
423
424 // VerifySignatureAlgorithms, if not nil, overrides the default set of
425 // supported signature algorithms that are accepted.
426 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500427
Adam Langley95c29f32014-06-20 12:00:00 -0700428 // Bugs specifies optional misbehaviour to be used for testing other
429 // implementations.
430 Bugs ProtocolBugs
431
432 serverInitOnce sync.Once // guards calling (*Config).serverInit
433}
434
435type BadValue int
436
437const (
438 BadValueNone BadValue = iota
439 BadValueNegative
440 BadValueZero
441 BadValueLimit
442 BadValueLarge
443 NumBadValues
444)
445
David Benjaminb36a3952015-12-01 18:53:13 -0500446type RSABadValue int
447
448const (
449 RSABadValueNone RSABadValue = iota
450 RSABadValueCorrupt
451 RSABadValueTooLong
452 RSABadValueTooShort
453 RSABadValueWrongVersion
454 NumRSABadValues
455)
456
Adam Langley95c29f32014-06-20 12:00:00 -0700457type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400458 // InvalidSignature specifies that the signature in a ServerKeyExchange
459 // or CertificateVerify message should be invalid.
460 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400461
Steven Valdez5440fe02016-07-18 12:40:30 -0400462 // SendCurve, if non-zero, causes the server to send the specified curve
463 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
464 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400465 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700466
David Benjamin2b07fa42016-03-02 00:23:57 -0500467 // InvalidECDHPoint, if true, causes the ECC points in
468 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
469 InvalidECDHPoint bool
470
Adam Langley95c29f32014-06-20 12:00:00 -0700471 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
472 // can be invalid.
473 BadECDSAR BadValue
474 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700475
476 // MaxPadding causes CBC records to have the maximum possible padding.
477 MaxPadding bool
478 // PaddingFirstByteBad causes the first byte of the padding to be
479 // incorrect.
480 PaddingFirstByteBad bool
481 // PaddingFirstByteBadIf255 causes the first byte of padding to be
482 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
483 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700484
485 // FailIfNotFallbackSCSV causes a server handshake to fail if the
486 // client doesn't send the fallback SCSV value.
487 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400488
489 // DuplicateExtension causes an extra empty extension of bogus type to
490 // be emitted in either the ClientHello or the ServerHello.
491 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400492
493 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
494 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
495 // Certificate message is sent and no signature is added to
496 // ServerKeyExchange.
497 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400498
David Benjaminb80168e2015-02-08 18:30:14 -0500499 // SkipHelloVerifyRequest causes a DTLS server to skip the
500 // HelloVerifyRequest message.
501 SkipHelloVerifyRequest bool
502
David Benjamindcd979f2015-04-20 18:26:52 -0400503 // SkipCertificateStatus, if true, causes the server to skip the
504 // CertificateStatus message. This is legal because CertificateStatus is
505 // optional, even with a status_request in ServerHello.
506 SkipCertificateStatus bool
507
David Benjamin9c651c92014-07-12 13:27:45 -0400508 // SkipServerKeyExchange causes the server to skip sending
509 // ServerKeyExchange messages.
510 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400511
David Benjaminb80168e2015-02-08 18:30:14 -0500512 // SkipNewSessionTicket causes the server to skip sending the
513 // NewSessionTicket message despite promising to in ServerHello.
514 SkipNewSessionTicket bool
515
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500516 // SkipClientCertificate causes the client to skip the Certificate
517 // message.
518 SkipClientCertificate bool
519
David Benjamina0e52232014-07-19 17:39:58 -0400520 // SkipChangeCipherSpec causes the implementation to skip
521 // sending the ChangeCipherSpec message (and adjusting cipher
522 // state accordingly for the Finished message).
523 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400524
David Benjaminb80168e2015-02-08 18:30:14 -0500525 // SkipFinished causes the implementation to skip sending the Finished
526 // message.
527 SkipFinished bool
528
David Benjaminf3ec83d2014-07-21 22:42:34 -0400529 // EarlyChangeCipherSpec causes the client to send an early
530 // ChangeCipherSpec message before the ClientKeyExchange. A value of
531 // zero disables this behavior. One and two configure variants for 0.9.8
532 // and 1.0.1 modes, respectively.
533 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400534
David Benjamin8144f992016-06-22 17:05:13 -0400535 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
536 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
537 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
538 StrayChangeCipherSpec bool
539
David Benjamin86271ee2014-07-21 16:14:03 -0400540 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
541 // the Finished (or NextProto) message around the ChangeCipherSpec
542 // messages.
543 FragmentAcrossChangeCipherSpec bool
544
David Benjamin61672812016-07-14 23:10:43 -0400545 // SendUnencryptedFinished, if true, causes the Finished message to be
546 // send unencrypted before ChangeCipherSpec rather than after it.
547 SendUnencryptedFinished bool
548
David Benjamin7964b182016-07-14 23:36:30 -0400549 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
550 // 1.3 server to send part of EncryptedExtensions unencrypted
551 // in the same record as ServerHello.
552 PartialEncryptedExtensionsWithServerHello bool
553
554 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
555 // client to send part of Finished unencrypted in the same record as
556 // ClientHello.
557 PartialClientFinishedWithClientHello bool
558
David Benjamind86c7672014-08-02 04:07:12 -0400559 // SendV2ClientHello causes the client to send a V2ClientHello
560 // instead of a normal ClientHello.
561 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400562
563 // SendFallbackSCSV causes the client to include
564 // TLS_FALLBACK_SCSV in the ClientHello.
565 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400566
Adam Langley5021b222015-06-12 18:27:58 -0700567 // SendRenegotiationSCSV causes the client to include the renegotiation
568 // SCSV in the ClientHello.
569 SendRenegotiationSCSV bool
570
David Benjamin43ec06f2014-08-05 02:28:57 -0400571 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400572 // handshake record. Handshake messages will be split into multiple
573 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400574 // never be fragmented. For DTLS, it is the maximum handshake fragment
575 // size, not record size; DTLS allows multiple handshake fragments in a
576 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400577 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400578
David Benjamin98214542014-08-07 18:02:39 -0400579 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
580 // the first 6 bytes of the ClientHello.
581 FragmentClientVersion bool
582
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400583 // FragmentAlert will cause all alerts to be fragmented across
584 // two records.
585 FragmentAlert bool
586
David Benjamin0d3a8c62016-03-11 22:25:18 -0500587 // DoubleAlert will cause all alerts to be sent as two copies packed
588 // within one record.
589 DoubleAlert bool
590
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500591 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
592 // alert to be sent.
593 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400594
David Benjaminb36a3952015-12-01 18:53:13 -0500595 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
596 // ClientKeyExchange which would not pass padding checks.
597 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400598
599 // RenewTicketOnResume causes the server to renew the session ticket and
600 // send a NewSessionTicket message during an abbreviated handshake.
601 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400602
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400603 // SendClientVersion, if non-zero, causes the client to send the
604 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400605 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400606
Steven Valdezfdd10992016-09-15 16:27:05 -0400607 // OmitSupportedVersions, if true, causes the client to omit the
608 // supported versions extension.
609 OmitSupportedVersions bool
610
611 // SendSupportedVersions, if non-empty, causes the client to send a
612 // supported versions extension with the values from array.
613 SendSupportedVersions []uint16
614
David Benjamin1f61f0d2016-07-10 12:20:35 -0400615 // NegotiateVersion, if non-zero, causes the server to negotiate the
616 // specifed TLS version rather than the version supported by either
617 // peer.
618 NegotiateVersion uint16
619
David Benjamine7e36aa2016-08-08 12:39:41 -0400620 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
621 // the specified TLS version on renegotiation rather than retaining it.
622 NegotiateVersionOnRenego uint16
623
David Benjamine58c4f52014-08-24 03:47:07 -0400624 // ExpectFalseStart causes the server to, on full handshakes,
625 // expect the peer to False Start; the server Finished message
626 // isn't sent until we receive an application data record
627 // from the peer.
628 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400629
David Benjamin1c633152015-04-02 20:19:11 -0400630 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
631 // handshakes, send an alert just before reading the application data
632 // record to test False Start. This can be used in a negative False
633 // Start test to determine whether the peer processed the alert (and
634 // closed the connection) before or after sending app data.
635 AlertBeforeFalseStartTest alert
636
David Benjamine78bfde2014-09-06 12:45:15 -0400637 // ExpectServerName, if not empty, is the hostname the client
638 // must specify in the server_name extension.
639 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400640
David Benjamin76c2efc2015-08-31 14:24:29 -0400641 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
642 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400643 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400644
Adam Langleyefb0e162015-07-09 11:35:04 -0700645 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
646 // return.
647 ALPNProtocol *string
648
David Benjamin405da482016-08-08 17:25:07 -0400649 // AcceptAnySession causes the server to resume sessions regardless of
650 // the version associated with the session or cipher suite. It also
651 // causes the server to look in both TLS 1.2 and 1.3 extensions to
652 // process a ticket.
653 AcceptAnySession bool
654
655 // SendBothTickets, if true, causes the client to send tickets in both
656 // TLS 1.2 and 1.3 extensions.
657 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700658
David Benjamin4199b0d2016-11-01 13:58:25 -0400659 // FilterTicket, if not nil, causes the client to modify a session
660 // ticket before sending it in a resume handshake.
661 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700662
663 // OversizedSessionId causes the session id that is sent with a ticket
664 // resumption attempt to be too large (33 bytes).
665 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700666
David Benjamin405da482016-08-08 17:25:07 -0400667 // ExpectNoTLS12Session, if true, causes the server to fail the
668 // connection if either a session ID or TLS 1.2 ticket is offered.
669 ExpectNoTLS12Session bool
670
671 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
672 // if a TLS 1.3 PSK is offered.
673 ExpectNoTLS13PSK bool
674
Adam Langley75712922014-10-10 16:23:43 -0700675 // RequireExtendedMasterSecret, if true, requires that the peer support
676 // the extended master secret option.
677 RequireExtendedMasterSecret bool
678
David Benjaminca6554b2014-11-08 12:31:52 -0500679 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400680 // they didn't support an extended master secret in the initial
681 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700682 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700683
David Benjamin163c9562016-08-29 23:14:17 -0400684 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
685 // behave as if they didn't support an extended master secret in
686 // renegotiation handshakes.
687 NoExtendedMasterSecretOnRenegotiation bool
688
Adam Langley2ae77d22014-10-28 17:29:33 -0700689 // EmptyRenegotiationInfo causes the renegotiation extension to be
690 // empty in a renegotiation handshake.
691 EmptyRenegotiationInfo bool
692
693 // BadRenegotiationInfo causes the renegotiation extension value in a
694 // renegotiation handshake to be incorrect.
695 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500696
David Benjamin3e052de2015-11-25 20:10:31 -0500697 // NoRenegotiationInfo disables renegotiation info support in all
698 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500699 NoRenegotiationInfo bool
700
David Benjamin3e052de2015-11-25 20:10:31 -0500701 // NoRenegotiationInfoInInitial disables renegotiation info support in
702 // the initial handshake.
703 NoRenegotiationInfoInInitial bool
704
705 // NoRenegotiationInfoAfterInitial disables renegotiation info support
706 // in renegotiation handshakes.
707 NoRenegotiationInfoAfterInitial bool
708
Adam Langley5021b222015-06-12 18:27:58 -0700709 // RequireRenegotiationInfo, if true, causes the client to return an
710 // error if the server doesn't reply with the renegotiation extension.
711 RequireRenegotiationInfo bool
712
David Benjamin8e6db492015-07-25 18:29:23 -0400713 // SequenceNumberMapping, if non-nil, is the mapping function to apply
714 // to the sequence number of outgoing packets. For both TLS and DTLS,
715 // the two most-significant bytes in the resulting sequence number are
716 // ignored so that the DTLS epoch cannot be changed.
717 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500718
David Benjamina3e89492015-02-26 15:16:22 -0500719 // RSAEphemeralKey, if true, causes the server to send a
720 // ServerKeyExchange message containing an ephemeral key (as in
721 // RSA_EXPORT) in the plain RSA key exchange.
722 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500723
724 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
725 // client offers when negotiating SRTP. MKI support is still missing so
726 // the peer must still send none.
727 SRTPMasterKeyIdentifer string
728
729 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
730 // server sends in the ServerHello instead of the negotiated one.
731 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500732
Nick Harper60edffd2016-06-21 15:19:24 -0700733 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500734 // signature and hashes extension.
735 //
736 // For a server, it will cause an empty list to be sent in the
737 // CertificateRequest message. None the less, the configured set will
738 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700739 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500740
David Benjamin55a43642015-04-20 14:45:55 -0400741 // NoSupportedCurves, if true, causes the client to omit the
742 // supported_curves extension.
743 NoSupportedCurves bool
744
David Benjaminc44b1df2014-11-23 12:11:01 -0500745 // RequireSameRenegoClientVersion, if true, causes the server
746 // to require that all ClientHellos match in offered version
747 // across a renego.
748 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800749
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400750 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500751 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500752 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500753
David Benjamine6f22212016-11-08 14:28:24 -0500754 // SendRecordVersion, if non-zero, is the value to send as the
755 // record-layer version.
756 SendRecordVersion uint16
757
758 // SendInitialRecordVersion, if non-zero, is the value to send as the
759 // record-layer version before the protocol version is determined.
760 SendInitialRecordVersion uint16
761
David Benjamin13be1de2015-01-11 16:29:36 -0500762 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
763 // packet.
764 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500765
766 // SendCipherSuite, if non-zero, is the cipher suite value that the
767 // server will send in the ServerHello. This does not affect the cipher
768 // the server believes it has actually negotiated.
769 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500770
David Benjamin75f99142016-11-12 12:36:06 +0900771 // SendCipherSuites, if not nil, is the cipher suite list that the
772 // client will send in the ClientHello. This does not affect the cipher
773 // the client believes it has actually offered.
774 SendCipherSuites []uint16
775
David Benjamin4cf369b2015-08-22 01:35:43 -0400776 // AppDataBeforeHandshake, if not nil, causes application data to be
777 // sent immediately before the first handshake message.
778 AppDataBeforeHandshake []byte
779
780 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500781 // be sent immediately after ChangeCipherSpec.
782 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500783
David Benjamindc3da932015-03-12 15:09:02 -0400784 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
785 // immediately after ChangeCipherSpec.
786 AlertAfterChangeCipherSpec alert
787
David Benjamin83f90402015-01-27 01:09:43 -0500788 // TimeoutSchedule is the schedule of packet drops and simulated
789 // timeouts for before each handshake leg from the peer.
790 TimeoutSchedule []time.Duration
791
792 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
793 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500794
795 // ReorderHandshakeFragments, if true, causes handshake fragments in
796 // DTLS to overlap and be sent in the wrong order. It also causes
797 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
798 // Finished and will trigger a spurious retransmit.)
799 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500800
David Benjamin61672812016-07-14 23:10:43 -0400801 // ReverseHandshakeFragments, if true, causes handshake fragments in
802 // DTLS to be reversed within a flight.
803 ReverseHandshakeFragments bool
804
David Benjamin75381222015-03-02 19:30:30 -0500805 // MixCompleteMessageWithFragments, if true, causes handshake
806 // messages in DTLS to redundantly both fragment the message
807 // and include a copy of the full one.
808 MixCompleteMessageWithFragments bool
809
David Benjaminddb9f152015-02-03 15:44:39 -0500810 // SendInvalidRecordType, if true, causes a record with an invalid
811 // content type to be sent immediately following the handshake.
812 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500813
David Benjamin0b8d5da2016-07-15 00:39:56 -0400814 // SendWrongMessageType, if non-zero, causes messages of the specified
815 // type to be sent with the wrong value.
816 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500817
David Benjamin639846e2016-09-09 11:41:18 -0400818 // SendTrailingMessageData, if non-zero, causes messages of the
819 // specified type to be sent with trailing data.
820 SendTrailingMessageData byte
821
David Benjamin75381222015-03-02 19:30:30 -0500822 // FragmentMessageTypeMismatch, if true, causes all non-initial
823 // handshake fragments in DTLS to have the wrong message type.
824 FragmentMessageTypeMismatch bool
825
826 // FragmentMessageLengthMismatch, if true, causes all non-initial
827 // handshake fragments in DTLS to have the wrong message length.
828 FragmentMessageLengthMismatch bool
829
David Benjamin11fc66a2015-06-16 11:40:24 -0400830 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
831 // to be split across two records. The value of |SplitFragments| is the
832 // number of bytes in the first fragment.
833 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500834
835 // SendEmptyFragments, if true, causes handshakes to include empty
836 // fragments in DTLS.
837 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400838
David Benjamin9a41d1b2015-05-16 01:30:09 -0400839 // SendSplitAlert, if true, causes an alert to be sent with the header
840 // and record body split across multiple packets. The peer should
841 // discard these packets rather than process it.
842 SendSplitAlert bool
843
David Benjamin4b27d9f2015-05-12 22:42:52 -0400844 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
845 // client offers a resumption or the server accepts one.
846 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400847
David Benjamin67d1fb52015-03-16 15:16:23 -0400848 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
849 // preferences to be ignored.
850 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400851
852 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
853 // signature algorithm preferences to be ignored.
854 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400855
David Benjaminc574f412015-04-20 11:13:01 -0400856 // IgnorePeerCurvePreferences, if true, causes the peer's curve
857 // preferences to be ignored.
858 IgnorePeerCurvePreferences bool
859
David Benjamin513f0ea2015-04-02 19:33:31 -0400860 // BadFinished, if true, causes the Finished hash to be broken.
861 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700862
863 // DHGroupPrime, if not nil, is used to define the (finite field)
864 // Diffie-Hellman group. The generator used is always two.
865 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400866
David Benjamin582ba042016-07-07 12:33:25 -0700867 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
868 // to be packed into individual handshake records, up to the specified
869 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400870 PackHandshakeFragments int
871
David Benjamin582ba042016-07-07 12:33:25 -0700872 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
873 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400874 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400875
David Benjamin582ba042016-07-07 12:33:25 -0700876 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
877 // be packed into records, up to the largest size record available.
878 PackHandshakeFlight bool
879
David Benjamin5ecb88b2016-10-04 17:51:35 -0400880 // AdvertiseAllConfiguredCiphers, if true, causes the client to
881 // advertise all configured cipher suite values.
882 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400883
884 // EmptyCertificateList, if true, causes the server to send an empty
885 // certificate list in the Certificate message.
886 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400887
888 // ExpectNewTicket, if true, causes the client to abort if it does not
889 // receive a new ticket.
890 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700891
892 // RequireClientHelloSize, if not zero, is the required length in bytes
893 // of the ClientHello /record/. This is checked by the server.
894 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700895
896 // CustomExtension, if not empty, contains the contents of an extension
897 // that will be added to client/server hellos.
898 CustomExtension string
899
David Benjamin490469f2016-10-05 22:44:38 -0400900 // CustomUnencryptedExtension, if not empty, contains the contents of
901 // an extension that will be added to ServerHello in TLS 1.3.
902 CustomUnencryptedExtension string
903
Adam Langley09505632015-07-30 18:10:13 -0700904 // ExpectedCustomExtension, if not nil, contains the expected contents
905 // of a custom extension.
906 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400907
David Benjamin1286bee2016-10-07 15:25:06 -0400908 // CustomTicketExtension, if not empty, contains the contents of an
909 // extension what will be added to NewSessionTicket in TLS 1.3.
910 CustomTicketExtension string
911
David Benjamin3baa6e12016-10-07 21:10:38 -0400912 // CustomTicketExtension, if not empty, contains the contents of an
913 // extension what will be added to HelloRetryRequest in TLS 1.3.
914 CustomHelloRetryRequestExtension string
915
David Benjamin30789da2015-08-29 22:56:45 -0400916 // NoCloseNotify, if true, causes the close_notify alert to be skipped
917 // on connection shutdown.
918 NoCloseNotify bool
919
David Benjaminfa214e42016-05-10 17:03:10 -0400920 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
921 // close_notify on shutdown.
922 SendAlertOnShutdown alert
923
David Benjamin30789da2015-08-29 22:56:45 -0400924 // ExpectCloseNotify, if true, requires a close_notify from the peer on
925 // shutdown. Records from the peer received after close_notify is sent
926 // are not discard.
927 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400928
929 // SendLargeRecords, if true, allows outgoing records to be sent
930 // arbitrarily large.
931 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400932
933 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
934 // ALPN and NPN in the same connetion.
935 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400936
David Benjamin0c40a962016-08-01 12:05:50 -0400937 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400938 // string in the ALPN extension regardless of the content or presence of
939 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400940 SendALPN string
941
David Benjamin490469f2016-10-05 22:44:38 -0400942 // SendUnencryptedALPN, if non-empty, causes the server to send the
943 // specified string in a ServerHello ALPN extension in TLS 1.3.
944 SendUnencryptedALPN string
945
David Benjamindd6fed92015-10-23 17:41:12 -0400946 // SendEmptySessionTicket, if true, causes the server to send an empty
947 // session ticket.
948 SendEmptySessionTicket bool
949
Steven Valdeza833c352016-11-01 13:39:36 -0400950 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400951 // to send.
952 SendPSKKeyExchangeModes []byte
953
Steven Valdeza833c352016-11-01 13:39:36 -0400954 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
955 // receipt of a NewSessionTicket message.
956 ExpectNoNewSessionTicket bool
957
Steven Valdez08b65f42016-12-07 15:29:45 -0500958 // SendTicketEarlyDataInfo, if non-zero, is the maximum amount of data that we
959 // will accept as early data, and gets sent in the ticket_early_data_info
960 // extension of the NewSessionTicket message.
961 SendTicketEarlyDataInfo uint32
962
David Benjamin9c33ae82017-01-08 06:04:43 -0500963 // DuplicateTicketEarlyDataInfo causes an extra empty extension of
964 // ticket_early_data_info to be sent in NewSessionTicket.
965 DuplicateTicketEarlyDataInfo bool
966
Steven Valdez08b65f42016-12-07 15:29:45 -0500967 // ExpectTicketEarlyDataInfo, if true, means that the client will fail upon
968 // absence of the ticket_early_data_info extension.
969 ExpectTicketEarlyDataInfo bool
970
Steven Valdeza833c352016-11-01 13:39:36 -0400971 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
972 // server receives from the client.
973 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -0400974
David Benjamindd6fed92015-10-23 17:41:12 -0400975 // FailIfSessionOffered, if true, causes the server to fail any
976 // connections where the client offers a non-empty session ID or session
977 // ticket.
978 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800979
980 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
981 // HelloRequest handshake message to be sent before each application
982 // data record. This only makes sense for a server.
983 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800984
David Benjamin71dd6662016-07-08 14:10:48 -0700985 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
986 // HelloRequest handshake message to be sent before each handshake
987 // message. This only makes sense for a server.
988 SendHelloRequestBeforeEveryHandshakeMessage bool
989
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800990 // RequireDHPublicValueLen causes a fatal error if the length (in
991 // bytes) of the server's Diffie-Hellman public value is not equal to
992 // this.
993 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500994
995 // BadChangeCipherSpec, if not nil, is the body to be sent in
996 // ChangeCipherSpec records instead of {1}.
997 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -0500998
999 // BadHelloRequest, if not nil, is what to send instead of a
1000 // HelloRequest.
1001 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -05001002
1003 // RequireSessionTickets, if true, causes the client to require new
1004 // sessions use session tickets instead of session IDs.
1005 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -05001006
1007 // NullAllCiphers, if true, causes every cipher to behave like the null
1008 // cipher.
1009 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -04001010
1011 // SendSCTListOnResume, if not nil, causes the server to send the
1012 // supplied SCT list in resumption handshakes.
1013 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -07001014
David Benjamindaa88502016-10-04 16:32:16 -04001015 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
1016 // OCSP stapling in resumption handshakes and, if applicable, send the
1017 // supplied stapled response.
1018 SendOCSPResponseOnResume []byte
1019
Steven Valdeza833c352016-11-01 13:39:36 -04001020 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1021 // supplied bytes in the extensions on the Certificate message.
1022 SendExtensionOnCertificate []byte
1023
1024 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1025 // supplied OCSP on intermediate certificates in the Certificate message.
1026 SendOCSPOnIntermediates []byte
1027
1028 // SendSCTOnIntermediates, if not nil, causes the server to send the
1029 // supplied SCT on intermediate certificates in the Certificate message.
1030 SendSCTOnIntermediates []byte
1031
1032 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1033 // copy of the OCSP/SCT extensions in the Certificate message.
1034 SendDuplicateCertExtensions bool
1035
1036 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1037 // reject extensions on intermediate certificates.
1038 ExpectNoExtensionsOnIntermediate bool
1039
David Benjaminc9ae27c2016-06-24 22:56:37 -04001040 // RecordPadding is the number of bytes of padding to add to each
1041 // encrypted record in TLS 1.3.
1042 RecordPadding int
1043
1044 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1045 // be missing their body and content type. Padding, if configured, is
1046 // still added.
1047 OmitRecordContents bool
1048
1049 // OuterRecordType, if non-zero, is the outer record type to use instead
1050 // of application data.
1051 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001052
1053 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1054 // with the given signature algorithm rather than the one negotiated.
1055 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001056
1057 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1058 // skipped.
1059 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001060
1061 // IgnoreSignatureVersionChecks, if true, causes all signature
1062 // algorithms to be enabled at all TLS versions.
1063 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001064
1065 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1066 // Renegotiation Info to be negotiated at all versions.
1067 NegotiateRenegotiationInfoAtAllVersions bool
1068
Steven Valdez143e8b32016-07-11 13:19:03 -04001069 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1070 // all versions.
1071 NegotiateNPNAtAllVersions bool
1072
1073 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1074 // all versions.
1075 NegotiateEMSAtAllVersions bool
1076
1077 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1078 // advertised in server extensions
1079 AdvertiseTicketExtension bool
1080
Steven Valdez803c77a2016-09-06 14:13:43 -04001081 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1082 // resumption.
1083 NegotiatePSKResumption bool
1084
David Benjamin7f78df42016-10-05 22:33:19 -04001085 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1086 // always acknowledge a session, regardless of one was offered.
1087 AlwaysSelectPSKIdentity bool
1088
1089 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1090 // the specified PSK identity index rather than the actual value.
1091 SelectPSKIdentityOnResume uint16
1092
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001093 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1094 // identity.
1095 ExtraPSKIdentity bool
1096
Steven Valdez143e8b32016-07-11 13:19:03 -04001097 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1098 // sending a key_share extension and use the zero ECDHE secret
1099 // instead.
1100 MissingKeyShare bool
1101
Steven Valdez5440fe02016-07-18 12:40:30 -04001102 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1103 // ClientHello to skip sending a key_share extension and use the zero
1104 // ECDHE secret instead.
1105 SecondClientHelloMissingKeyShare bool
1106
1107 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1108 // client to pretend the server requested a HelloRetryRequest with the
1109 // given curve rather than the actual one.
1110 MisinterpretHelloRetryRequestCurve CurveID
1111
Steven Valdez143e8b32016-07-11 13:19:03 -04001112 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1113 // copies of each KeyShareEntry.
1114 DuplicateKeyShares bool
1115
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001116 // SendEarlyAlert, if true, sends a fatal alert after the ClientHello.
1117 SendEarlyAlert bool
1118
1119 // SendEarlyDataLength, if non-zero, is the amount of early data to send after
1120 // the ClientHello.
1121 SendEarlyDataLength int
1122
1123 // OmitEarlyDataExtension, if true, causes the early data extension to
1124 // be omitted in the ClientHello.
1125 OmitEarlyDataExtension bool
1126
1127 // SendEarlyDataOnSecondClientHello, if true, causes the TLS 1.3 client to
1128 // send early data after the second ClientHello.
1129 SendEarlyDataOnSecondClientHello bool
1130
1131 // InterleaveEarlyData, if true, causes the TLS 1.3 client to send early
1132 // data interleaved with the second ClientHello and the client Finished.
1133 InterleaveEarlyData bool
1134
Nick Harper7cd0a972016-12-02 11:08:40 -08001135 // SendHalfRTTData causes a TLS 1.3 server to send the provided
1136 // data in application data records before reading the client's
1137 // Finished message.
1138 SendHalfRTTData [][]byte
1139
1140 // ExpectHalfRTTData causes a TLS 1.3 client to read application
1141 // data after reading the server's Finished message and before
1142 // sending any other handshake messages. It checks that the
1143 // application data it reads matches what is provided in
1144 // ExpectHalfRTTData and errors if the number of records or their
1145 // content do not match.
1146 ExpectHalfRTTData [][]byte
1147
Steven Valdez143e8b32016-07-11 13:19:03 -04001148 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1149 // emit an empty EncryptedExtensions block.
1150 EmptyEncryptedExtensions bool
1151
1152 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1153 // include the KeyShare extension in the EncryptedExtensions block.
1154 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001155
David Benjamin3baa6e12016-10-07 21:10:38 -04001156 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1157 // be sent by the server, even if empty.
1158 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001159
1160 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1161 // two HelloRetryRequests instead of one.
1162 SecondHelloRetryRequest bool
1163
David Benjamin3baa6e12016-10-07 21:10:38 -04001164 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1165 // the specified curve in a HelloRetryRequest.
1166 SendHelloRetryRequestCurve CurveID
1167
1168 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1169 // sent by the server in HelloRetryRequest.
1170 SendHelloRetryRequestCookie []byte
1171
1172 // DuplicateHelloRetryRequestExtensions, if true, causes all
1173 // HelloRetryRequest extensions to be sent twice.
1174 DuplicateHelloRetryRequestExtensions bool
1175
Steven Valdez5440fe02016-07-18 12:40:30 -04001176 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001177 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001178 SendServerHelloVersion uint16
1179
1180 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1181 // HelloRetryRequest.
1182 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001183
1184 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1185 // HelloRequest in the same record as Finished.
1186 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001187
David Benjamine73c7f42016-08-17 00:29:33 -04001188 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1189 // connection if the selected curve appears in the client's initial
1190 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1191 ExpectMissingKeyShare bool
1192
David Benjamin02edcd02016-07-27 17:40:37 -04001193 // SendExtraFinished, if true, causes an extra Finished message to be
1194 // sent.
1195 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001196
1197 // SendRequestContext, if not empty, is the request context to send in
1198 // a TLS 1.3 CertificateRequest.
1199 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001200
1201 // SendSNIWarningAlert, if true, causes the server to send an
1202 // unrecognized_name alert before the ServerHello.
1203 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001204
1205 // SendCompressionMethods, if not nil, is the compression method list to
1206 // send in the ClientHello.
1207 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001208
1209 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1210 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1211 // hint is empty.
1212 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001213
1214 // TrailingKeyShareData, if true, causes the client key share list to
1215 // include a trailing byte.
1216 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001217
1218 // InvalidChannelIDSignature, if true, causes the client to generate an
1219 // invalid Channel ID signature.
1220 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001221
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001222 // ExpectGREASE, if true, causes messages without GREASE values to be
1223 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001224 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001225
1226 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1227 // that is one byte shorter than it should be.
1228 SendShortPSKBinder bool
1229
1230 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1231 // PSK binder.
1232 SendInvalidPSKBinder bool
1233
1234 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1235 SendNoPSKBinder bool
1236
David Benjaminaedf3032016-12-01 16:47:56 -05001237 // SendExtraPSKBinder, if true, causes the client to send an extra PSK
1238 // binder.
1239 SendExtraPSKBinder bool
1240
Steven Valdeza833c352016-11-01 13:39:36 -04001241 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1242 // extension as the first extension instead of the last extension.
1243 PSKBinderFirst bool
David Benjamin53210cb2016-11-16 09:01:48 +09001244
1245 // NoOCSPStapling, if true, causes the client to not request OCSP
1246 // stapling.
1247 NoOCSPStapling bool
1248
1249 // NoSignedCertificateTimestamps, if true, causes the client to not
1250 // request signed certificate timestamps.
1251 NoSignedCertificateTimestamps bool
David Benjamin6f600d62016-12-21 16:06:54 -05001252
1253 // EnableShortHeader, if true, causes the TLS 1.3 short header extension
1254 // to be enabled.
1255 EnableShortHeader bool
1256
1257 // AlwaysNegotiateShortHeader, if true, causes the server to always
1258 // negotiate the short header extension in ServerHello.
1259 AlwaysNegotiateShortHeader bool
1260
1261 // ClearShortHeaderBit, if true, causes the server to send short headers
1262 // without the high bit set.
1263 ClearShortHeaderBit bool
David Benjamina81967b2016-12-22 09:16:57 -05001264
1265 // SendSupportedPointFormats, if not nil, is the list of supported point
1266 // formats to send in ClientHello or ServerHello. If set to a non-nil
1267 // empty slice, no extension will be sent.
1268 SendSupportedPointFormats []byte
David Benjamine3fbb362017-01-06 16:19:28 -05001269
1270 // MaxReceivePlaintext, if non-zero, is the maximum plaintext record
1271 // length accepted from the peer.
1272 MaxReceivePlaintext int
David Benjamin17b30832017-01-28 14:00:32 -05001273
1274 // SendTicketLifetime, if non-zero, is the ticket lifetime to send in
1275 // NewSessionTicket messages.
1276 SendTicketLifetime time.Duration
Adam Langley95c29f32014-06-20 12:00:00 -07001277}
1278
1279func (c *Config) serverInit() {
1280 if c.SessionTicketsDisabled {
1281 return
1282 }
1283
1284 // If the key has already been set then we have nothing to do.
1285 for _, b := range c.SessionTicketKey {
1286 if b != 0 {
1287 return
1288 }
1289 }
1290
1291 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1292 c.SessionTicketsDisabled = true
1293 }
1294}
1295
1296func (c *Config) rand() io.Reader {
1297 r := c.Rand
1298 if r == nil {
1299 return rand.Reader
1300 }
1301 return r
1302}
1303
1304func (c *Config) time() time.Time {
1305 t := c.Time
1306 if t == nil {
1307 t = time.Now
1308 }
1309 return t()
1310}
1311
1312func (c *Config) cipherSuites() []uint16 {
1313 s := c.CipherSuites
1314 if s == nil {
1315 s = defaultCipherSuites()
1316 }
1317 return s
1318}
1319
David Benjamincecee272016-06-30 13:33:47 -04001320func (c *Config) minVersion(isDTLS bool) uint16 {
1321 ret := uint16(minVersion)
1322 if c != nil && c.MinVersion != 0 {
1323 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001324 }
David Benjamincecee272016-06-30 13:33:47 -04001325 if isDTLS {
1326 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1327 if ret < VersionTLS10 {
1328 return VersionTLS10
1329 }
1330 // There is no such thing as DTLS 1.1.
1331 if ret == VersionTLS11 {
1332 return VersionTLS12
1333 }
1334 }
1335 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001336}
1337
David Benjamincecee272016-06-30 13:33:47 -04001338func (c *Config) maxVersion(isDTLS bool) uint16 {
1339 ret := uint16(maxVersion)
1340 if c != nil && c.MaxVersion != 0 {
1341 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001342 }
David Benjamincecee272016-06-30 13:33:47 -04001343 if isDTLS {
1344 // We only implement up to DTLS 1.2.
1345 if ret > VersionTLS12 {
1346 return VersionTLS12
1347 }
1348 // There is no such thing as DTLS 1.1.
1349 if ret == VersionTLS11 {
1350 return VersionTLS10
1351 }
1352 }
1353 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001354}
1355
David Benjamincba2b622015-12-18 22:13:41 -05001356var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001357
1358func (c *Config) curvePreferences() []CurveID {
1359 if c == nil || len(c.CurvePreferences) == 0 {
1360 return defaultCurvePreferences
1361 }
1362 return c.CurvePreferences
1363}
1364
Nick Harperdcfbc672016-07-16 17:47:31 +02001365func (c *Config) defaultCurves() map[CurveID]bool {
1366 defaultCurves := make(map[CurveID]bool)
1367 curves := c.DefaultCurves
1368 if c == nil || c.DefaultCurves == nil {
1369 curves = c.curvePreferences()
1370 }
1371 for _, curveID := range curves {
1372 defaultCurves[curveID] = true
1373 }
1374 return defaultCurves
1375}
1376
Steven Valdezfdd10992016-09-15 16:27:05 -04001377// isSupportedVersion returns true if the specified protocol version is
1378// acceptable.
1379func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1380 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001381}
1382
1383// getCertificateForName returns the best certificate for the given name,
1384// defaulting to the first element of c.Certificates if there are no good
1385// options.
1386func (c *Config) getCertificateForName(name string) *Certificate {
1387 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1388 // There's only one choice, so no point doing any work.
1389 return &c.Certificates[0]
1390 }
1391
1392 name = strings.ToLower(name)
1393 for len(name) > 0 && name[len(name)-1] == '.' {
1394 name = name[:len(name)-1]
1395 }
1396
1397 if cert, ok := c.NameToCertificate[name]; ok {
1398 return cert
1399 }
1400
1401 // try replacing labels in the name with wildcards until we get a
1402 // match.
1403 labels := strings.Split(name, ".")
1404 for i := range labels {
1405 labels[i] = "*"
1406 candidate := strings.Join(labels, ".")
1407 if cert, ok := c.NameToCertificate[candidate]; ok {
1408 return cert
1409 }
1410 }
1411
1412 // If nothing matches, return the first certificate.
1413 return &c.Certificates[0]
1414}
1415
David Benjamin7a41d372016-07-09 11:21:54 -07001416func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1417 if c != nil && c.SignSignatureAlgorithms != nil {
1418 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001419 }
David Benjamin7a41d372016-07-09 11:21:54 -07001420 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001421}
1422
David Benjamin7a41d372016-07-09 11:21:54 -07001423func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1424 if c != nil && c.VerifySignatureAlgorithms != nil {
1425 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001426 }
David Benjamin7a41d372016-07-09 11:21:54 -07001427 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001428}
1429
Adam Langley95c29f32014-06-20 12:00:00 -07001430// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1431// from the CommonName and SubjectAlternateName fields of each of the leaf
1432// certificates.
1433func (c *Config) BuildNameToCertificate() {
1434 c.NameToCertificate = make(map[string]*Certificate)
1435 for i := range c.Certificates {
1436 cert := &c.Certificates[i]
1437 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1438 if err != nil {
1439 continue
1440 }
1441 if len(x509Cert.Subject.CommonName) > 0 {
1442 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1443 }
1444 for _, san := range x509Cert.DNSNames {
1445 c.NameToCertificate[san] = cert
1446 }
1447 }
1448}
1449
1450// A Certificate is a chain of one or more certificates, leaf first.
1451type Certificate struct {
1452 Certificate [][]byte
1453 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1454 // OCSPStaple contains an optional OCSP response which will be served
1455 // to clients that request it.
1456 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001457 // SignedCertificateTimestampList contains an optional encoded
1458 // SignedCertificateTimestampList structure which will be
1459 // served to clients that request it.
1460 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001461 // Leaf is the parsed form of the leaf certificate, which may be
1462 // initialized using x509.ParseCertificate to reduce per-handshake
1463 // processing for TLS clients doing client authentication. If nil, the
1464 // leaf certificate will be parsed as needed.
1465 Leaf *x509.Certificate
1466}
1467
1468// A TLS record.
1469type record struct {
1470 contentType recordType
1471 major, minor uint8
1472 payload []byte
1473}
1474
1475type handshakeMessage interface {
1476 marshal() []byte
1477 unmarshal([]byte) bool
1478}
1479
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001480// lruSessionCache is a client or server session cache implementation
1481// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001482type lruSessionCache struct {
1483 sync.Mutex
1484
1485 m map[string]*list.Element
1486 q *list.List
1487 capacity int
1488}
1489
1490type lruSessionCacheEntry struct {
1491 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001492 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001493}
1494
1495// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001496func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001497 c.Lock()
1498 defer c.Unlock()
1499
1500 if elem, ok := c.m[sessionKey]; ok {
1501 entry := elem.Value.(*lruSessionCacheEntry)
1502 entry.state = cs
1503 c.q.MoveToFront(elem)
1504 return
1505 }
1506
1507 if c.q.Len() < c.capacity {
1508 entry := &lruSessionCacheEntry{sessionKey, cs}
1509 c.m[sessionKey] = c.q.PushFront(entry)
1510 return
1511 }
1512
1513 elem := c.q.Back()
1514 entry := elem.Value.(*lruSessionCacheEntry)
1515 delete(c.m, entry.sessionKey)
1516 entry.sessionKey = sessionKey
1517 entry.state = cs
1518 c.q.MoveToFront(elem)
1519 c.m[sessionKey] = elem
1520}
1521
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001522// Get returns the value associated with a given key. It returns (nil,
1523// false) if no value is found.
1524func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001525 c.Lock()
1526 defer c.Unlock()
1527
1528 if elem, ok := c.m[sessionKey]; ok {
1529 c.q.MoveToFront(elem)
1530 return elem.Value.(*lruSessionCacheEntry).state, true
1531 }
1532 return nil, false
1533}
1534
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001535// lruClientSessionCache is a ClientSessionCache implementation that
1536// uses an LRU caching strategy.
1537type lruClientSessionCache struct {
1538 lruSessionCache
1539}
1540
1541func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1542 c.lruSessionCache.Put(sessionKey, cs)
1543}
1544
1545func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1546 cs, ok := c.lruSessionCache.Get(sessionKey)
1547 if !ok {
1548 return nil, false
1549 }
1550 return cs.(*ClientSessionState), true
1551}
1552
1553// lruServerSessionCache is a ServerSessionCache implementation that
1554// uses an LRU caching strategy.
1555type lruServerSessionCache struct {
1556 lruSessionCache
1557}
1558
1559func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1560 c.lruSessionCache.Put(sessionId, session)
1561}
1562
1563func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1564 cs, ok := c.lruSessionCache.Get(sessionId)
1565 if !ok {
1566 return nil, false
1567 }
1568 return cs.(*sessionState), true
1569}
1570
1571// NewLRUClientSessionCache returns a ClientSessionCache with the given
1572// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1573// is used instead.
1574func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1575 const defaultSessionCacheCapacity = 64
1576
1577 if capacity < 1 {
1578 capacity = defaultSessionCacheCapacity
1579 }
1580 return &lruClientSessionCache{
1581 lruSessionCache{
1582 m: make(map[string]*list.Element),
1583 q: list.New(),
1584 capacity: capacity,
1585 },
1586 }
1587}
1588
1589// NewLRUServerSessionCache returns a ServerSessionCache with the given
1590// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1591// is used instead.
1592func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1593 const defaultSessionCacheCapacity = 64
1594
1595 if capacity < 1 {
1596 capacity = defaultSessionCacheCapacity
1597 }
1598 return &lruServerSessionCache{
1599 lruSessionCache{
1600 m: make(map[string]*list.Element),
1601 q: list.New(),
1602 capacity: capacity,
1603 },
1604 }
1605}
1606
Adam Langley95c29f32014-06-20 12:00:00 -07001607// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1608type dsaSignature struct {
1609 R, S *big.Int
1610}
1611
1612type ecdsaSignature dsaSignature
1613
1614var emptyConfig Config
1615
1616func defaultConfig() *Config {
1617 return &emptyConfig
1618}
1619
1620var (
1621 once sync.Once
1622 varDefaultCipherSuites []uint16
1623)
1624
1625func defaultCipherSuites() []uint16 {
1626 once.Do(initDefaultCipherSuites)
1627 return varDefaultCipherSuites
1628}
1629
1630func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001631 for _, suite := range cipherSuites {
1632 if suite.flags&suitePSK == 0 {
1633 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1634 }
Adam Langley95c29f32014-06-20 12:00:00 -07001635 }
1636}
1637
1638func unexpectedMessageError(wanted, got interface{}) error {
1639 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1640}
David Benjamin000800a2014-11-14 01:43:59 -05001641
Nick Harper60edffd2016-06-21 15:19:24 -07001642func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1643 for _, s := range sigAlgs {
1644 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001645 return true
1646 }
1647 }
1648 return false
1649}
Nick Harper85f20c22016-07-04 10:11:59 -07001650
1651var (
David Benjamina128a552016-10-13 14:26:33 -04001652 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001653 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1654 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1655)