blob: e527185bb6571a44edbbc061faf12dd0d9f0449b [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
David Benjamin399e7c92015-07-30 23:01:27 -040098 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -050099 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
100 extensionRenegotiationInfo uint16 = 0xff01
101 extensionChannelID uint16 = 30032 // not IANA assigned
David Benjamin6f600d62016-12-21 16:06:54 -0500102 extensionShortHeader uint16 = 27463 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700103)
104
David Benjamin1286bee2016-10-07 15:25:06 -0400105// TLS ticket extension numbers
106const (
107 ticketExtensionCustom uint16 = 1234 // not IANA assigned
108)
109
Adam Langley95c29f32014-06-20 12:00:00 -0700110// TLS signaling cipher suite values
111const (
112 scsvRenegotiation uint16 = 0x00ff
113)
114
115// CurveID is the type of a TLS identifier for an elliptic curve. See
116// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
117type CurveID uint16
118
119const (
David Benjamincba2b622015-12-18 22:13:41 -0500120 CurveP224 CurveID = 21
121 CurveP256 CurveID = 23
122 CurveP384 CurveID = 24
123 CurveP521 CurveID = 25
124 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700125)
126
127// TLS Elliptic Curve Point Formats
128// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
129const (
David Benjamina81967b2016-12-22 09:16:57 -0500130 pointFormatUncompressed uint8 = 0
131 pointFormatCompressedPrime uint8 = 1
Adam Langley95c29f32014-06-20 12:00:00 -0700132)
133
134// TLS CertificateStatusType (RFC 3546)
135const (
136 statusTypeOCSP uint8 = 1
137)
138
139// Certificate types (for certificateRequestMsg)
140const (
David Benjamin7b030512014-07-08 17:30:11 -0400141 CertTypeRSASign = 1 // A certificate containing an RSA key
142 CertTypeDSSSign = 2 // A certificate containing a DSA key
143 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
144 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400147 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
148 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
149 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700150
151 // Rest of these are reserved by the TLS spec
152)
153
Nick Harper60edffd2016-06-21 15:19:24 -0700154// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
155// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
156// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
157// algorithms' throughout. We match the latter.
158type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700159
Adam Langley95c29f32014-06-20 12:00:00 -0700160const (
Nick Harper60edffd2016-06-21 15:19:24 -0700161 // RSASSA-PKCS1-v1_5 algorithms
162 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
163 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
164 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
165 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
166 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700167
Nick Harper60edffd2016-06-21 15:19:24 -0700168 // ECDSA algorithms
169 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
170 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
171 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
172 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
173
174 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400175 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
176 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
177 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700178
179 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400180 signatureEd25519 signatureAlgorithm = 0x0807
181 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700182)
Adam Langley95c29f32014-06-20 12:00:00 -0700183
David Benjamin7a41d372016-07-09 11:21:54 -0700184// supportedSignatureAlgorithms contains the default supported signature
185// algorithms.
186var supportedSignatureAlgorithms = []signatureAlgorithm{
187 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700188 signatureRSAPKCS1WithSHA256,
189 signatureECDSAWithP256AndSHA256,
190 signatureRSAPKCS1WithSHA1,
191 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700192}
193
David Benjaminca6c8262014-11-15 19:06:08 -0500194// SRTP protection profiles (See RFC 5764, section 4.1.2)
195const (
196 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
197 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
198)
199
David Benjamina128a552016-10-13 14:26:33 -0400200// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200201const (
Steven Valdez5b986082016-09-01 12:29:49 -0400202 pskKEMode = 0
203 pskDHEKEMode = 1
204)
205
Steven Valdezc4aa7272016-10-03 12:25:56 -0400206// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
207const (
208 keyUpdateNotRequested = 0
209 keyUpdateRequested = 1
210)
211
Adam Langley95c29f32014-06-20 12:00:00 -0700212// ConnectionState records basic TLS details about the connection.
213type ConnectionState struct {
214 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
215 HandshakeComplete bool // TLS handshake is complete
216 DidResume bool // connection resumes a previous TLS connection
217 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
218 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
219 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400220 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700221 ServerName string // server name requested by client, if any (server side only)
222 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
223 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400224 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500225 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400226 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100227 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700228 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400229 CurveID CurveID // the curve used in ECDHE
David Benjamin6f600d62016-12-21 16:06:54 -0500230 ShortHeader bool // whether the short header extension was negotiated
Adam Langley95c29f32014-06-20 12:00:00 -0700231}
232
233// ClientAuthType declares the policy the server will follow for
234// TLS Client Authentication.
235type ClientAuthType int
236
237const (
238 NoClientCert ClientAuthType = iota
239 RequestClientCert
240 RequireAnyClientCert
241 VerifyClientCertIfGiven
242 RequireAndVerifyClientCert
243)
244
245// ClientSessionState contains the state needed by clients to resume TLS
246// sessions.
247type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500248 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700249 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
250 vers uint16 // SSL/TLS version negotiated for the session
251 cipherSuite uint16 // Ciphersuite negotiated for the session
252 masterSecret []byte // MasterSecret generated by client on a full handshake
253 handshakeHash []byte // Handshake hash for Channel ID purposes.
254 serverCertificates []*x509.Certificate // Certificate chain presented by the server
255 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100256 sctList []byte
257 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700258 ticketCreationTime time.Time
259 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400260 ticketAgeAdd uint32
Adam Langley95c29f32014-06-20 12:00:00 -0700261}
262
263// ClientSessionCache is a cache of ClientSessionState objects that can be used
264// by a client to resume a TLS session with a given server. ClientSessionCache
265// implementations should expect to be called concurrently from different
266// goroutines.
267type ClientSessionCache interface {
268 // Get searches for a ClientSessionState associated with the given key.
269 // On return, ok is true if one was found.
270 Get(sessionKey string) (session *ClientSessionState, ok bool)
271
272 // Put adds the ClientSessionState to the cache with the given key.
273 Put(sessionKey string, cs *ClientSessionState)
274}
275
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500276// ServerSessionCache is a cache of sessionState objects that can be used by a
277// client to resume a TLS session with a given server. ServerSessionCache
278// implementations should expect to be called concurrently from different
279// goroutines.
280type ServerSessionCache interface {
281 // Get searches for a sessionState associated with the given session
282 // ID. On return, ok is true if one was found.
283 Get(sessionId string) (session *sessionState, ok bool)
284
285 // Put adds the sessionState to the cache with the given session ID.
286 Put(sessionId string, session *sessionState)
287}
288
Adam Langley95c29f32014-06-20 12:00:00 -0700289// A Config structure is used to configure a TLS client or server.
290// After one has been passed to a TLS function it must not be
291// modified. A Config may be reused; the tls package will also not
292// modify it.
293type Config struct {
294 // Rand provides the source of entropy for nonces and RSA blinding.
295 // If Rand is nil, TLS uses the cryptographic random reader in package
296 // crypto/rand.
297 // The Reader must be safe for use by multiple goroutines.
298 Rand io.Reader
299
300 // Time returns the current time as the number of seconds since the epoch.
301 // If Time is nil, TLS uses time.Now.
302 Time func() time.Time
303
304 // Certificates contains one or more certificate chains
305 // to present to the other side of the connection.
306 // Server configurations must include at least one certificate.
307 Certificates []Certificate
308
309 // NameToCertificate maps from a certificate name to an element of
310 // Certificates. Note that a certificate name can be of the form
311 // '*.example.com' and so doesn't have to be a domain name as such.
312 // See Config.BuildNameToCertificate
313 // The nil value causes the first element of Certificates to be used
314 // for all connections.
315 NameToCertificate map[string]*Certificate
316
317 // RootCAs defines the set of root certificate authorities
318 // that clients use when verifying server certificates.
319 // If RootCAs is nil, TLS uses the host's root CA set.
320 RootCAs *x509.CertPool
321
322 // NextProtos is a list of supported, application level protocols.
323 NextProtos []string
324
325 // ServerName is used to verify the hostname on the returned
326 // certificates unless InsecureSkipVerify is given. It is also included
327 // in the client's handshake to support virtual hosting.
328 ServerName string
329
330 // ClientAuth determines the server's policy for
331 // TLS Client Authentication. The default is NoClientCert.
332 ClientAuth ClientAuthType
333
334 // ClientCAs defines the set of root certificate authorities
335 // that servers use if required to verify a client certificate
336 // by the policy in ClientAuth.
337 ClientCAs *x509.CertPool
338
David Benjamin7b030512014-07-08 17:30:11 -0400339 // ClientCertificateTypes defines the set of allowed client certificate
340 // types. The default is CertTypeRSASign and CertTypeECDSASign.
341 ClientCertificateTypes []byte
342
Adam Langley95c29f32014-06-20 12:00:00 -0700343 // InsecureSkipVerify controls whether a client verifies the
344 // server's certificate chain and host name.
345 // If InsecureSkipVerify is true, TLS accepts any certificate
346 // presented by the server and any host name in that certificate.
347 // In this mode, TLS is susceptible to man-in-the-middle attacks.
348 // This should be used only for testing.
349 InsecureSkipVerify bool
350
351 // CipherSuites is a list of supported cipher suites. If CipherSuites
352 // is nil, TLS uses a list of suites supported by the implementation.
353 CipherSuites []uint16
354
355 // PreferServerCipherSuites controls whether the server selects the
356 // client's most preferred ciphersuite, or the server's most preferred
357 // ciphersuite. If true then the server's preference, as expressed in
358 // the order of elements in CipherSuites, is used.
359 PreferServerCipherSuites bool
360
361 // SessionTicketsDisabled may be set to true to disable session ticket
362 // (resumption) support.
363 SessionTicketsDisabled bool
364
365 // SessionTicketKey is used by TLS servers to provide session
366 // resumption. See RFC 5077. If zero, it will be filled with
367 // random data before the first server handshake.
368 //
369 // If multiple servers are terminating connections for the same host
370 // they should all have the same SessionTicketKey. If the
371 // SessionTicketKey leaks, previously recorded and future TLS
372 // connections using that key are compromised.
373 SessionTicketKey [32]byte
374
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500375 // ClientSessionCache is a cache of ClientSessionState entries
376 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700377 ClientSessionCache ClientSessionCache
378
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500379 // ServerSessionCache is a cache of sessionState entries for TLS session
380 // resumption.
381 ServerSessionCache ServerSessionCache
382
Adam Langley95c29f32014-06-20 12:00:00 -0700383 // MinVersion contains the minimum SSL/TLS version that is acceptable.
384 // If zero, then SSLv3 is taken as the minimum.
385 MinVersion uint16
386
387 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
388 // If zero, then the maximum version supported by this package is used,
389 // which is currently TLS 1.2.
390 MaxVersion uint16
391
392 // CurvePreferences contains the elliptic curves that will be used in
393 // an ECDHE handshake, in preference order. If empty, the default will
394 // be used.
395 CurvePreferences []CurveID
396
Nick Harperdcfbc672016-07-16 17:47:31 +0200397 // DefaultCurves contains the elliptic curves for which public values will
398 // be sent in the ClientHello's KeyShare extension. If this value is nil,
399 // all supported curves will have public values sent. This field is ignored
400 // on servers.
401 DefaultCurves []CurveID
402
David Benjamind30a9902014-08-24 01:44:23 -0400403 // ChannelID contains the ECDSA key for the client to use as
404 // its TLS Channel ID.
405 ChannelID *ecdsa.PrivateKey
406
407 // RequestChannelID controls whether the server requests a TLS
408 // Channel ID. If negotiated, the client's public key is
409 // returned in the ConnectionState.
410 RequestChannelID bool
411
David Benjamin48cae082014-10-27 01:06:24 -0400412 // PreSharedKey, if not nil, is the pre-shared key to use with
413 // the PSK cipher suites.
414 PreSharedKey []byte
415
416 // PreSharedKeyIdentity, if not empty, is the identity to use
417 // with the PSK cipher suites.
418 PreSharedKeyIdentity string
419
David Benjaminca6c8262014-11-15 19:06:08 -0500420 // SRTPProtectionProfiles, if not nil, is the list of SRTP
421 // protection profiles to offer in DTLS-SRTP.
422 SRTPProtectionProfiles []uint16
423
David Benjamin7a41d372016-07-09 11:21:54 -0700424 // SignSignatureAlgorithms, if not nil, overrides the default set of
425 // supported signature algorithms to sign with.
426 SignSignatureAlgorithms []signatureAlgorithm
427
428 // VerifySignatureAlgorithms, if not nil, overrides the default set of
429 // supported signature algorithms that are accepted.
430 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500431
Adam Langley95c29f32014-06-20 12:00:00 -0700432 // Bugs specifies optional misbehaviour to be used for testing other
433 // implementations.
434 Bugs ProtocolBugs
435
436 serverInitOnce sync.Once // guards calling (*Config).serverInit
437}
438
439type BadValue int
440
441const (
442 BadValueNone BadValue = iota
443 BadValueNegative
444 BadValueZero
445 BadValueLimit
446 BadValueLarge
447 NumBadValues
448)
449
David Benjaminb36a3952015-12-01 18:53:13 -0500450type RSABadValue int
451
452const (
453 RSABadValueNone RSABadValue = iota
454 RSABadValueCorrupt
455 RSABadValueTooLong
456 RSABadValueTooShort
457 RSABadValueWrongVersion
458 NumRSABadValues
459)
460
Adam Langley95c29f32014-06-20 12:00:00 -0700461type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400462 // InvalidSignature specifies that the signature in a ServerKeyExchange
463 // or CertificateVerify message should be invalid.
464 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400465
Steven Valdez5440fe02016-07-18 12:40:30 -0400466 // SendCurve, if non-zero, causes the server to send the specified curve
467 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
468 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400469 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700470
David Benjamin2b07fa42016-03-02 00:23:57 -0500471 // InvalidECDHPoint, if true, causes the ECC points in
472 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
473 InvalidECDHPoint bool
474
Adam Langley95c29f32014-06-20 12:00:00 -0700475 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
476 // can be invalid.
477 BadECDSAR BadValue
478 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700479
480 // MaxPadding causes CBC records to have the maximum possible padding.
481 MaxPadding bool
482 // PaddingFirstByteBad causes the first byte of the padding to be
483 // incorrect.
484 PaddingFirstByteBad bool
485 // PaddingFirstByteBadIf255 causes the first byte of padding to be
486 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
487 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700488
489 // FailIfNotFallbackSCSV causes a server handshake to fail if the
490 // client doesn't send the fallback SCSV value.
491 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400492
493 // DuplicateExtension causes an extra empty extension of bogus type to
494 // be emitted in either the ClientHello or the ServerHello.
495 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400496
497 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
498 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
499 // Certificate message is sent and no signature is added to
500 // ServerKeyExchange.
501 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400502
David Benjaminb80168e2015-02-08 18:30:14 -0500503 // SkipHelloVerifyRequest causes a DTLS server to skip the
504 // HelloVerifyRequest message.
505 SkipHelloVerifyRequest bool
506
David Benjamindcd979f2015-04-20 18:26:52 -0400507 // SkipCertificateStatus, if true, causes the server to skip the
508 // CertificateStatus message. This is legal because CertificateStatus is
509 // optional, even with a status_request in ServerHello.
510 SkipCertificateStatus bool
511
David Benjamin9c651c92014-07-12 13:27:45 -0400512 // SkipServerKeyExchange causes the server to skip sending
513 // ServerKeyExchange messages.
514 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400515
David Benjaminb80168e2015-02-08 18:30:14 -0500516 // SkipNewSessionTicket causes the server to skip sending the
517 // NewSessionTicket message despite promising to in ServerHello.
518 SkipNewSessionTicket bool
519
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500520 // SkipClientCertificate causes the client to skip the Certificate
521 // message.
522 SkipClientCertificate bool
523
David Benjamina0e52232014-07-19 17:39:58 -0400524 // SkipChangeCipherSpec causes the implementation to skip
525 // sending the ChangeCipherSpec message (and adjusting cipher
526 // state accordingly for the Finished message).
527 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400528
David Benjaminb80168e2015-02-08 18:30:14 -0500529 // SkipFinished causes the implementation to skip sending the Finished
530 // message.
531 SkipFinished bool
532
David Benjaminf3ec83d2014-07-21 22:42:34 -0400533 // EarlyChangeCipherSpec causes the client to send an early
534 // ChangeCipherSpec message before the ClientKeyExchange. A value of
535 // zero disables this behavior. One and two configure variants for 0.9.8
536 // and 1.0.1 modes, respectively.
537 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400538
David Benjamin8144f992016-06-22 17:05:13 -0400539 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
540 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
541 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
542 StrayChangeCipherSpec bool
543
David Benjamin86271ee2014-07-21 16:14:03 -0400544 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
545 // the Finished (or NextProto) message around the ChangeCipherSpec
546 // messages.
547 FragmentAcrossChangeCipherSpec bool
548
David Benjamin61672812016-07-14 23:10:43 -0400549 // SendUnencryptedFinished, if true, causes the Finished message to be
550 // send unencrypted before ChangeCipherSpec rather than after it.
551 SendUnencryptedFinished bool
552
David Benjamin7964b182016-07-14 23:36:30 -0400553 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
554 // 1.3 server to send part of EncryptedExtensions unencrypted
555 // in the same record as ServerHello.
556 PartialEncryptedExtensionsWithServerHello bool
557
558 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
559 // client to send part of Finished unencrypted in the same record as
560 // ClientHello.
561 PartialClientFinishedWithClientHello bool
562
David Benjamind86c7672014-08-02 04:07:12 -0400563 // SendV2ClientHello causes the client to send a V2ClientHello
564 // instead of a normal ClientHello.
565 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400566
567 // SendFallbackSCSV causes the client to include
568 // TLS_FALLBACK_SCSV in the ClientHello.
569 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400570
Adam Langley5021b222015-06-12 18:27:58 -0700571 // SendRenegotiationSCSV causes the client to include the renegotiation
572 // SCSV in the ClientHello.
573 SendRenegotiationSCSV bool
574
David Benjamin43ec06f2014-08-05 02:28:57 -0400575 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400576 // handshake record. Handshake messages will be split into multiple
577 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400578 // never be fragmented. For DTLS, it is the maximum handshake fragment
579 // size, not record size; DTLS allows multiple handshake fragments in a
580 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400581 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400582
David Benjamin98214542014-08-07 18:02:39 -0400583 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
584 // the first 6 bytes of the ClientHello.
585 FragmentClientVersion bool
586
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400587 // FragmentAlert will cause all alerts to be fragmented across
588 // two records.
589 FragmentAlert bool
590
David Benjamin0d3a8c62016-03-11 22:25:18 -0500591 // DoubleAlert will cause all alerts to be sent as two copies packed
592 // within one record.
593 DoubleAlert bool
594
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500595 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
596 // alert to be sent.
597 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400598
David Benjaminb36a3952015-12-01 18:53:13 -0500599 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
600 // ClientKeyExchange which would not pass padding checks.
601 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400602
603 // RenewTicketOnResume causes the server to renew the session ticket and
604 // send a NewSessionTicket message during an abbreviated handshake.
605 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400606
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400607 // SendClientVersion, if non-zero, causes the client to send the
608 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400609 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400610
Steven Valdezfdd10992016-09-15 16:27:05 -0400611 // OmitSupportedVersions, if true, causes the client to omit the
612 // supported versions extension.
613 OmitSupportedVersions bool
614
615 // SendSupportedVersions, if non-empty, causes the client to send a
616 // supported versions extension with the values from array.
617 SendSupportedVersions []uint16
618
David Benjamin1f61f0d2016-07-10 12:20:35 -0400619 // NegotiateVersion, if non-zero, causes the server to negotiate the
620 // specifed TLS version rather than the version supported by either
621 // peer.
622 NegotiateVersion uint16
623
David Benjamine7e36aa2016-08-08 12:39:41 -0400624 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
625 // the specified TLS version on renegotiation rather than retaining it.
626 NegotiateVersionOnRenego uint16
627
David Benjamine58c4f52014-08-24 03:47:07 -0400628 // ExpectFalseStart causes the server to, on full handshakes,
629 // expect the peer to False Start; the server Finished message
630 // isn't sent until we receive an application data record
631 // from the peer.
632 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400633
David Benjamin1c633152015-04-02 20:19:11 -0400634 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
635 // handshakes, send an alert just before reading the application data
636 // record to test False Start. This can be used in a negative False
637 // Start test to determine whether the peer processed the alert (and
638 // closed the connection) before or after sending app data.
639 AlertBeforeFalseStartTest alert
640
David Benjamine78bfde2014-09-06 12:45:15 -0400641 // ExpectServerName, if not empty, is the hostname the client
642 // must specify in the server_name extension.
643 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400644
David Benjamin76c2efc2015-08-31 14:24:29 -0400645 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
646 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400647 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400648
Adam Langleyefb0e162015-07-09 11:35:04 -0700649 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
650 // return.
651 ALPNProtocol *string
652
David Benjamin405da482016-08-08 17:25:07 -0400653 // AcceptAnySession causes the server to resume sessions regardless of
654 // the version associated with the session or cipher suite. It also
655 // causes the server to look in both TLS 1.2 and 1.3 extensions to
656 // process a ticket.
657 AcceptAnySession bool
658
659 // SendBothTickets, if true, causes the client to send tickets in both
660 // TLS 1.2 and 1.3 extensions.
661 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700662
David Benjamin4199b0d2016-11-01 13:58:25 -0400663 // FilterTicket, if not nil, causes the client to modify a session
664 // ticket before sending it in a resume handshake.
665 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700666
667 // OversizedSessionId causes the session id that is sent with a ticket
668 // resumption attempt to be too large (33 bytes).
669 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700670
David Benjamin405da482016-08-08 17:25:07 -0400671 // ExpectNoTLS12Session, if true, causes the server to fail the
672 // connection if either a session ID or TLS 1.2 ticket is offered.
673 ExpectNoTLS12Session bool
674
675 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
676 // if a TLS 1.3 PSK is offered.
677 ExpectNoTLS13PSK bool
678
Adam Langley75712922014-10-10 16:23:43 -0700679 // RequireExtendedMasterSecret, if true, requires that the peer support
680 // the extended master secret option.
681 RequireExtendedMasterSecret bool
682
David Benjaminca6554b2014-11-08 12:31:52 -0500683 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400684 // they didn't support an extended master secret in the initial
685 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700686 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700687
David Benjamin163c9562016-08-29 23:14:17 -0400688 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
689 // behave as if they didn't support an extended master secret in
690 // renegotiation handshakes.
691 NoExtendedMasterSecretOnRenegotiation bool
692
Adam Langley2ae77d22014-10-28 17:29:33 -0700693 // EmptyRenegotiationInfo causes the renegotiation extension to be
694 // empty in a renegotiation handshake.
695 EmptyRenegotiationInfo bool
696
697 // BadRenegotiationInfo causes the renegotiation extension value in a
698 // renegotiation handshake to be incorrect.
699 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500700
David Benjamin3e052de2015-11-25 20:10:31 -0500701 // NoRenegotiationInfo disables renegotiation info support in all
702 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500703 NoRenegotiationInfo bool
704
David Benjamin3e052de2015-11-25 20:10:31 -0500705 // NoRenegotiationInfoInInitial disables renegotiation info support in
706 // the initial handshake.
707 NoRenegotiationInfoInInitial bool
708
709 // NoRenegotiationInfoAfterInitial disables renegotiation info support
710 // in renegotiation handshakes.
711 NoRenegotiationInfoAfterInitial bool
712
Adam Langley5021b222015-06-12 18:27:58 -0700713 // RequireRenegotiationInfo, if true, causes the client to return an
714 // error if the server doesn't reply with the renegotiation extension.
715 RequireRenegotiationInfo bool
716
David Benjamin8e6db492015-07-25 18:29:23 -0400717 // SequenceNumberMapping, if non-nil, is the mapping function to apply
718 // to the sequence number of outgoing packets. For both TLS and DTLS,
719 // the two most-significant bytes in the resulting sequence number are
720 // ignored so that the DTLS epoch cannot be changed.
721 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500722
David Benjamina3e89492015-02-26 15:16:22 -0500723 // RSAEphemeralKey, if true, causes the server to send a
724 // ServerKeyExchange message containing an ephemeral key (as in
725 // RSA_EXPORT) in the plain RSA key exchange.
726 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500727
728 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
729 // client offers when negotiating SRTP. MKI support is still missing so
730 // the peer must still send none.
731 SRTPMasterKeyIdentifer string
732
733 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
734 // server sends in the ServerHello instead of the negotiated one.
735 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500736
Nick Harper60edffd2016-06-21 15:19:24 -0700737 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500738 // signature and hashes extension.
739 //
740 // For a server, it will cause an empty list to be sent in the
741 // CertificateRequest message. None the less, the configured set will
742 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700743 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500744
David Benjamin55a43642015-04-20 14:45:55 -0400745 // NoSupportedCurves, if true, causes the client to omit the
746 // supported_curves extension.
747 NoSupportedCurves bool
748
David Benjaminc44b1df2014-11-23 12:11:01 -0500749 // RequireSameRenegoClientVersion, if true, causes the server
750 // to require that all ClientHellos match in offered version
751 // across a renego.
752 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800753
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400754 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500755 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500756 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500757
David Benjamine6f22212016-11-08 14:28:24 -0500758 // SendRecordVersion, if non-zero, is the value to send as the
759 // record-layer version.
760 SendRecordVersion uint16
761
762 // SendInitialRecordVersion, if non-zero, is the value to send as the
763 // record-layer version before the protocol version is determined.
764 SendInitialRecordVersion uint16
765
David Benjamin13be1de2015-01-11 16:29:36 -0500766 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
767 // packet.
768 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500769
770 // SendCipherSuite, if non-zero, is the cipher suite value that the
771 // server will send in the ServerHello. This does not affect the cipher
772 // the server believes it has actually negotiated.
773 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500774
David Benjamin75f99142016-11-12 12:36:06 +0900775 // SendCipherSuites, if not nil, is the cipher suite list that the
776 // client will send in the ClientHello. This does not affect the cipher
777 // the client believes it has actually offered.
778 SendCipherSuites []uint16
779
David Benjamin4cf369b2015-08-22 01:35:43 -0400780 // AppDataBeforeHandshake, if not nil, causes application data to be
781 // sent immediately before the first handshake message.
782 AppDataBeforeHandshake []byte
783
784 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500785 // be sent immediately after ChangeCipherSpec.
786 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500787
David Benjamindc3da932015-03-12 15:09:02 -0400788 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
789 // immediately after ChangeCipherSpec.
790 AlertAfterChangeCipherSpec alert
791
David Benjamin83f90402015-01-27 01:09:43 -0500792 // TimeoutSchedule is the schedule of packet drops and simulated
793 // timeouts for before each handshake leg from the peer.
794 TimeoutSchedule []time.Duration
795
796 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
797 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500798
799 // ReorderHandshakeFragments, if true, causes handshake fragments in
800 // DTLS to overlap and be sent in the wrong order. It also causes
801 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
802 // Finished and will trigger a spurious retransmit.)
803 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500804
David Benjamin61672812016-07-14 23:10:43 -0400805 // ReverseHandshakeFragments, if true, causes handshake fragments in
806 // DTLS to be reversed within a flight.
807 ReverseHandshakeFragments bool
808
David Benjamin75381222015-03-02 19:30:30 -0500809 // MixCompleteMessageWithFragments, if true, causes handshake
810 // messages in DTLS to redundantly both fragment the message
811 // and include a copy of the full one.
812 MixCompleteMessageWithFragments bool
813
David Benjaminddb9f152015-02-03 15:44:39 -0500814 // SendInvalidRecordType, if true, causes a record with an invalid
815 // content type to be sent immediately following the handshake.
816 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500817
David Benjamin0b8d5da2016-07-15 00:39:56 -0400818 // SendWrongMessageType, if non-zero, causes messages of the specified
819 // type to be sent with the wrong value.
820 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500821
David Benjamin639846e2016-09-09 11:41:18 -0400822 // SendTrailingMessageData, if non-zero, causes messages of the
823 // specified type to be sent with trailing data.
824 SendTrailingMessageData byte
825
David Benjamin75381222015-03-02 19:30:30 -0500826 // FragmentMessageTypeMismatch, if true, causes all non-initial
827 // handshake fragments in DTLS to have the wrong message type.
828 FragmentMessageTypeMismatch bool
829
830 // FragmentMessageLengthMismatch, if true, causes all non-initial
831 // handshake fragments in DTLS to have the wrong message length.
832 FragmentMessageLengthMismatch bool
833
David Benjamin11fc66a2015-06-16 11:40:24 -0400834 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
835 // to be split across two records. The value of |SplitFragments| is the
836 // number of bytes in the first fragment.
837 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500838
839 // SendEmptyFragments, if true, causes handshakes to include empty
840 // fragments in DTLS.
841 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400842
David Benjamin9a41d1b2015-05-16 01:30:09 -0400843 // SendSplitAlert, if true, causes an alert to be sent with the header
844 // and record body split across multiple packets. The peer should
845 // discard these packets rather than process it.
846 SendSplitAlert bool
847
David Benjamin4b27d9f2015-05-12 22:42:52 -0400848 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
849 // client offers a resumption or the server accepts one.
850 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400851
David Benjamin67d1fb52015-03-16 15:16:23 -0400852 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
853 // preferences to be ignored.
854 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400855
856 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
857 // signature algorithm preferences to be ignored.
858 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400859
David Benjaminc574f412015-04-20 11:13:01 -0400860 // IgnorePeerCurvePreferences, if true, causes the peer's curve
861 // preferences to be ignored.
862 IgnorePeerCurvePreferences bool
863
David Benjamin513f0ea2015-04-02 19:33:31 -0400864 // BadFinished, if true, causes the Finished hash to be broken.
865 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700866
867 // DHGroupPrime, if not nil, is used to define the (finite field)
868 // Diffie-Hellman group. The generator used is always two.
869 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400870
David Benjamin582ba042016-07-07 12:33:25 -0700871 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
872 // to be packed into individual handshake records, up to the specified
873 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400874 PackHandshakeFragments int
875
David Benjamin582ba042016-07-07 12:33:25 -0700876 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
877 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400878 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400879
David Benjamin582ba042016-07-07 12:33:25 -0700880 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
881 // be packed into records, up to the largest size record available.
882 PackHandshakeFlight bool
883
David Benjamin5ecb88b2016-10-04 17:51:35 -0400884 // AdvertiseAllConfiguredCiphers, if true, causes the client to
885 // advertise all configured cipher suite values.
886 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400887
888 // EmptyCertificateList, if true, causes the server to send an empty
889 // certificate list in the Certificate message.
890 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400891
892 // ExpectNewTicket, if true, causes the client to abort if it does not
893 // receive a new ticket.
894 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700895
896 // RequireClientHelloSize, if not zero, is the required length in bytes
897 // of the ClientHello /record/. This is checked by the server.
898 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700899
900 // CustomExtension, if not empty, contains the contents of an extension
901 // that will be added to client/server hellos.
902 CustomExtension string
903
David Benjamin490469f2016-10-05 22:44:38 -0400904 // CustomUnencryptedExtension, if not empty, contains the contents of
905 // an extension that will be added to ServerHello in TLS 1.3.
906 CustomUnencryptedExtension string
907
Adam Langley09505632015-07-30 18:10:13 -0700908 // ExpectedCustomExtension, if not nil, contains the expected contents
909 // of a custom extension.
910 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400911
David Benjamin1286bee2016-10-07 15:25:06 -0400912 // CustomTicketExtension, if not empty, contains the contents of an
913 // extension what will be added to NewSessionTicket in TLS 1.3.
914 CustomTicketExtension string
915
David Benjamin3baa6e12016-10-07 21:10:38 -0400916 // CustomTicketExtension, if not empty, contains the contents of an
917 // extension what will be added to HelloRetryRequest in TLS 1.3.
918 CustomHelloRetryRequestExtension string
919
David Benjamin30789da2015-08-29 22:56:45 -0400920 // NoCloseNotify, if true, causes the close_notify alert to be skipped
921 // on connection shutdown.
922 NoCloseNotify bool
923
David Benjaminfa214e42016-05-10 17:03:10 -0400924 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
925 // close_notify on shutdown.
926 SendAlertOnShutdown alert
927
David Benjamin30789da2015-08-29 22:56:45 -0400928 // ExpectCloseNotify, if true, requires a close_notify from the peer on
929 // shutdown. Records from the peer received after close_notify is sent
930 // are not discard.
931 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400932
933 // SendLargeRecords, if true, allows outgoing records to be sent
934 // arbitrarily large.
935 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400936
937 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
938 // ALPN and NPN in the same connetion.
939 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400940
David Benjamin0c40a962016-08-01 12:05:50 -0400941 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400942 // string in the ALPN extension regardless of the content or presence of
943 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400944 SendALPN string
945
David Benjamin490469f2016-10-05 22:44:38 -0400946 // SendUnencryptedALPN, if non-empty, causes the server to send the
947 // specified string in a ServerHello ALPN extension in TLS 1.3.
948 SendUnencryptedALPN string
949
David Benjamindd6fed92015-10-23 17:41:12 -0400950 // SendEmptySessionTicket, if true, causes the server to send an empty
951 // session ticket.
952 SendEmptySessionTicket bool
953
Steven Valdeza833c352016-11-01 13:39:36 -0400954 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400955 // to send.
956 SendPSKKeyExchangeModes []byte
957
Steven Valdeza833c352016-11-01 13:39:36 -0400958 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
959 // receipt of a NewSessionTicket message.
960 ExpectNoNewSessionTicket bool
961
962 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
963 // server receives from the client.
964 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -0400965
David Benjamindd6fed92015-10-23 17:41:12 -0400966 // FailIfSessionOffered, if true, causes the server to fail any
967 // connections where the client offers a non-empty session ID or session
968 // ticket.
969 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800970
971 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
972 // HelloRequest handshake message to be sent before each application
973 // data record. This only makes sense for a server.
974 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800975
David Benjamin71dd6662016-07-08 14:10:48 -0700976 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
977 // HelloRequest handshake message to be sent before each handshake
978 // message. This only makes sense for a server.
979 SendHelloRequestBeforeEveryHandshakeMessage bool
980
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800981 // RequireDHPublicValueLen causes a fatal error if the length (in
982 // bytes) of the server's Diffie-Hellman public value is not equal to
983 // this.
984 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500985
986 // BadChangeCipherSpec, if not nil, is the body to be sent in
987 // ChangeCipherSpec records instead of {1}.
988 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -0500989
990 // BadHelloRequest, if not nil, is what to send instead of a
991 // HelloRequest.
992 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -0500993
994 // RequireSessionTickets, if true, causes the client to require new
995 // sessions use session tickets instead of session IDs.
996 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -0500997
998 // NullAllCiphers, if true, causes every cipher to behave like the null
999 // cipher.
1000 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -04001001
1002 // SendSCTListOnResume, if not nil, causes the server to send the
1003 // supplied SCT list in resumption handshakes.
1004 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -07001005
David Benjamindaa88502016-10-04 16:32:16 -04001006 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
1007 // OCSP stapling in resumption handshakes and, if applicable, send the
1008 // supplied stapled response.
1009 SendOCSPResponseOnResume []byte
1010
Steven Valdeza833c352016-11-01 13:39:36 -04001011 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1012 // supplied bytes in the extensions on the Certificate message.
1013 SendExtensionOnCertificate []byte
1014
1015 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1016 // supplied OCSP on intermediate certificates in the Certificate message.
1017 SendOCSPOnIntermediates []byte
1018
1019 // SendSCTOnIntermediates, if not nil, causes the server to send the
1020 // supplied SCT on intermediate certificates in the Certificate message.
1021 SendSCTOnIntermediates []byte
1022
1023 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1024 // copy of the OCSP/SCT extensions in the Certificate message.
1025 SendDuplicateCertExtensions bool
1026
1027 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1028 // reject extensions on intermediate certificates.
1029 ExpectNoExtensionsOnIntermediate bool
1030
David Benjaminc9ae27c2016-06-24 22:56:37 -04001031 // RecordPadding is the number of bytes of padding to add to each
1032 // encrypted record in TLS 1.3.
1033 RecordPadding int
1034
1035 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1036 // be missing their body and content type. Padding, if configured, is
1037 // still added.
1038 OmitRecordContents bool
1039
1040 // OuterRecordType, if non-zero, is the outer record type to use instead
1041 // of application data.
1042 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001043
1044 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1045 // with the given signature algorithm rather than the one negotiated.
1046 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001047
1048 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1049 // skipped.
1050 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001051
1052 // IgnoreSignatureVersionChecks, if true, causes all signature
1053 // algorithms to be enabled at all TLS versions.
1054 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001055
1056 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1057 // Renegotiation Info to be negotiated at all versions.
1058 NegotiateRenegotiationInfoAtAllVersions bool
1059
Steven Valdez143e8b32016-07-11 13:19:03 -04001060 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1061 // all versions.
1062 NegotiateNPNAtAllVersions bool
1063
1064 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1065 // all versions.
1066 NegotiateEMSAtAllVersions bool
1067
1068 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1069 // advertised in server extensions
1070 AdvertiseTicketExtension bool
1071
Steven Valdez803c77a2016-09-06 14:13:43 -04001072 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1073 // resumption.
1074 NegotiatePSKResumption bool
1075
David Benjamin7f78df42016-10-05 22:33:19 -04001076 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1077 // always acknowledge a session, regardless of one was offered.
1078 AlwaysSelectPSKIdentity bool
1079
1080 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1081 // the specified PSK identity index rather than the actual value.
1082 SelectPSKIdentityOnResume uint16
1083
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001084 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1085 // identity.
1086 ExtraPSKIdentity bool
1087
Steven Valdez143e8b32016-07-11 13:19:03 -04001088 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1089 // sending a key_share extension and use the zero ECDHE secret
1090 // instead.
1091 MissingKeyShare bool
1092
Steven Valdez5440fe02016-07-18 12:40:30 -04001093 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1094 // ClientHello to skip sending a key_share extension and use the zero
1095 // ECDHE secret instead.
1096 SecondClientHelloMissingKeyShare bool
1097
1098 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1099 // client to pretend the server requested a HelloRetryRequest with the
1100 // given curve rather than the actual one.
1101 MisinterpretHelloRetryRequestCurve CurveID
1102
Steven Valdez143e8b32016-07-11 13:19:03 -04001103 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1104 // copies of each KeyShareEntry.
1105 DuplicateKeyShares bool
1106
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001107 // SendEarlyAlert, if true, sends a fatal alert after the ClientHello.
1108 SendEarlyAlert bool
1109
1110 // SendEarlyDataLength, if non-zero, is the amount of early data to send after
1111 // the ClientHello.
1112 SendEarlyDataLength int
1113
1114 // OmitEarlyDataExtension, if true, causes the early data extension to
1115 // be omitted in the ClientHello.
1116 OmitEarlyDataExtension bool
1117
1118 // SendEarlyDataOnSecondClientHello, if true, causes the TLS 1.3 client to
1119 // send early data after the second ClientHello.
1120 SendEarlyDataOnSecondClientHello bool
1121
1122 // InterleaveEarlyData, if true, causes the TLS 1.3 client to send early
1123 // data interleaved with the second ClientHello and the client Finished.
1124 InterleaveEarlyData bool
1125
Steven Valdez143e8b32016-07-11 13:19:03 -04001126 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1127 // emit an empty EncryptedExtensions block.
1128 EmptyEncryptedExtensions bool
1129
1130 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1131 // include the KeyShare extension in the EncryptedExtensions block.
1132 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001133
David Benjamin3baa6e12016-10-07 21:10:38 -04001134 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1135 // be sent by the server, even if empty.
1136 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001137
1138 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1139 // two HelloRetryRequests instead of one.
1140 SecondHelloRetryRequest bool
1141
David Benjamin3baa6e12016-10-07 21:10:38 -04001142 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1143 // the specified curve in a HelloRetryRequest.
1144 SendHelloRetryRequestCurve CurveID
1145
1146 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1147 // sent by the server in HelloRetryRequest.
1148 SendHelloRetryRequestCookie []byte
1149
1150 // DuplicateHelloRetryRequestExtensions, if true, causes all
1151 // HelloRetryRequest extensions to be sent twice.
1152 DuplicateHelloRetryRequestExtensions bool
1153
Steven Valdez5440fe02016-07-18 12:40:30 -04001154 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001155 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001156 SendServerHelloVersion uint16
1157
1158 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1159 // HelloRetryRequest.
1160 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001161
1162 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1163 // HelloRequest in the same record as Finished.
1164 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001165
David Benjamine73c7f42016-08-17 00:29:33 -04001166 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1167 // connection if the selected curve appears in the client's initial
1168 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1169 ExpectMissingKeyShare bool
1170
David Benjamin02edcd02016-07-27 17:40:37 -04001171 // SendExtraFinished, if true, causes an extra Finished message to be
1172 // sent.
1173 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001174
1175 // SendRequestContext, if not empty, is the request context to send in
1176 // a TLS 1.3 CertificateRequest.
1177 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001178
1179 // SendSNIWarningAlert, if true, causes the server to send an
1180 // unrecognized_name alert before the ServerHello.
1181 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001182
1183 // SendCompressionMethods, if not nil, is the compression method list to
1184 // send in the ClientHello.
1185 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001186
1187 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1188 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1189 // hint is empty.
1190 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001191
1192 // TrailingKeyShareData, if true, causes the client key share list to
1193 // include a trailing byte.
1194 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001195
1196 // InvalidChannelIDSignature, if true, causes the client to generate an
1197 // invalid Channel ID signature.
1198 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001199
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001200 // ExpectGREASE, if true, causes messages without GREASE values to be
1201 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001202 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001203
1204 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1205 // that is one byte shorter than it should be.
1206 SendShortPSKBinder bool
1207
1208 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1209 // PSK binder.
1210 SendInvalidPSKBinder bool
1211
1212 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1213 SendNoPSKBinder bool
1214
David Benjaminaedf3032016-12-01 16:47:56 -05001215 // SendExtraPSKBinder, if true, causes the client to send an extra PSK
1216 // binder.
1217 SendExtraPSKBinder bool
1218
Steven Valdeza833c352016-11-01 13:39:36 -04001219 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1220 // extension as the first extension instead of the last extension.
1221 PSKBinderFirst bool
David Benjamin53210cb2016-11-16 09:01:48 +09001222
1223 // NoOCSPStapling, if true, causes the client to not request OCSP
1224 // stapling.
1225 NoOCSPStapling bool
1226
1227 // NoSignedCertificateTimestamps, if true, causes the client to not
1228 // request signed certificate timestamps.
1229 NoSignedCertificateTimestamps bool
David Benjamin6f600d62016-12-21 16:06:54 -05001230
1231 // EnableShortHeader, if true, causes the TLS 1.3 short header extension
1232 // to be enabled.
1233 EnableShortHeader bool
1234
1235 // AlwaysNegotiateShortHeader, if true, causes the server to always
1236 // negotiate the short header extension in ServerHello.
1237 AlwaysNegotiateShortHeader bool
1238
1239 // ClearShortHeaderBit, if true, causes the server to send short headers
1240 // without the high bit set.
1241 ClearShortHeaderBit bool
David Benjamina81967b2016-12-22 09:16:57 -05001242
1243 // SendSupportedPointFormats, if not nil, is the list of supported point
1244 // formats to send in ClientHello or ServerHello. If set to a non-nil
1245 // empty slice, no extension will be sent.
1246 SendSupportedPointFormats []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001247}
1248
1249func (c *Config) serverInit() {
1250 if c.SessionTicketsDisabled {
1251 return
1252 }
1253
1254 // If the key has already been set then we have nothing to do.
1255 for _, b := range c.SessionTicketKey {
1256 if b != 0 {
1257 return
1258 }
1259 }
1260
1261 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1262 c.SessionTicketsDisabled = true
1263 }
1264}
1265
1266func (c *Config) rand() io.Reader {
1267 r := c.Rand
1268 if r == nil {
1269 return rand.Reader
1270 }
1271 return r
1272}
1273
1274func (c *Config) time() time.Time {
1275 t := c.Time
1276 if t == nil {
1277 t = time.Now
1278 }
1279 return t()
1280}
1281
1282func (c *Config) cipherSuites() []uint16 {
1283 s := c.CipherSuites
1284 if s == nil {
1285 s = defaultCipherSuites()
1286 }
1287 return s
1288}
1289
David Benjamincecee272016-06-30 13:33:47 -04001290func (c *Config) minVersion(isDTLS bool) uint16 {
1291 ret := uint16(minVersion)
1292 if c != nil && c.MinVersion != 0 {
1293 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001294 }
David Benjamincecee272016-06-30 13:33:47 -04001295 if isDTLS {
1296 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1297 if ret < VersionTLS10 {
1298 return VersionTLS10
1299 }
1300 // There is no such thing as DTLS 1.1.
1301 if ret == VersionTLS11 {
1302 return VersionTLS12
1303 }
1304 }
1305 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001306}
1307
David Benjamincecee272016-06-30 13:33:47 -04001308func (c *Config) maxVersion(isDTLS bool) uint16 {
1309 ret := uint16(maxVersion)
1310 if c != nil && c.MaxVersion != 0 {
1311 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001312 }
David Benjamincecee272016-06-30 13:33:47 -04001313 if isDTLS {
1314 // We only implement up to DTLS 1.2.
1315 if ret > VersionTLS12 {
1316 return VersionTLS12
1317 }
1318 // There is no such thing as DTLS 1.1.
1319 if ret == VersionTLS11 {
1320 return VersionTLS10
1321 }
1322 }
1323 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001324}
1325
David Benjamincba2b622015-12-18 22:13:41 -05001326var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001327
1328func (c *Config) curvePreferences() []CurveID {
1329 if c == nil || len(c.CurvePreferences) == 0 {
1330 return defaultCurvePreferences
1331 }
1332 return c.CurvePreferences
1333}
1334
Nick Harperdcfbc672016-07-16 17:47:31 +02001335func (c *Config) defaultCurves() map[CurveID]bool {
1336 defaultCurves := make(map[CurveID]bool)
1337 curves := c.DefaultCurves
1338 if c == nil || c.DefaultCurves == nil {
1339 curves = c.curvePreferences()
1340 }
1341 for _, curveID := range curves {
1342 defaultCurves[curveID] = true
1343 }
1344 return defaultCurves
1345}
1346
Steven Valdezfdd10992016-09-15 16:27:05 -04001347// isSupportedVersion returns true if the specified protocol version is
1348// acceptable.
1349func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1350 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001351}
1352
1353// getCertificateForName returns the best certificate for the given name,
1354// defaulting to the first element of c.Certificates if there are no good
1355// options.
1356func (c *Config) getCertificateForName(name string) *Certificate {
1357 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1358 // There's only one choice, so no point doing any work.
1359 return &c.Certificates[0]
1360 }
1361
1362 name = strings.ToLower(name)
1363 for len(name) > 0 && name[len(name)-1] == '.' {
1364 name = name[:len(name)-1]
1365 }
1366
1367 if cert, ok := c.NameToCertificate[name]; ok {
1368 return cert
1369 }
1370
1371 // try replacing labels in the name with wildcards until we get a
1372 // match.
1373 labels := strings.Split(name, ".")
1374 for i := range labels {
1375 labels[i] = "*"
1376 candidate := strings.Join(labels, ".")
1377 if cert, ok := c.NameToCertificate[candidate]; ok {
1378 return cert
1379 }
1380 }
1381
1382 // If nothing matches, return the first certificate.
1383 return &c.Certificates[0]
1384}
1385
David Benjamin7a41d372016-07-09 11:21:54 -07001386func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1387 if c != nil && c.SignSignatureAlgorithms != nil {
1388 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001389 }
David Benjamin7a41d372016-07-09 11:21:54 -07001390 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001391}
1392
David Benjamin7a41d372016-07-09 11:21:54 -07001393func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1394 if c != nil && c.VerifySignatureAlgorithms != nil {
1395 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001396 }
David Benjamin7a41d372016-07-09 11:21:54 -07001397 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001398}
1399
Adam Langley95c29f32014-06-20 12:00:00 -07001400// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1401// from the CommonName and SubjectAlternateName fields of each of the leaf
1402// certificates.
1403func (c *Config) BuildNameToCertificate() {
1404 c.NameToCertificate = make(map[string]*Certificate)
1405 for i := range c.Certificates {
1406 cert := &c.Certificates[i]
1407 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1408 if err != nil {
1409 continue
1410 }
1411 if len(x509Cert.Subject.CommonName) > 0 {
1412 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1413 }
1414 for _, san := range x509Cert.DNSNames {
1415 c.NameToCertificate[san] = cert
1416 }
1417 }
1418}
1419
1420// A Certificate is a chain of one or more certificates, leaf first.
1421type Certificate struct {
1422 Certificate [][]byte
1423 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1424 // OCSPStaple contains an optional OCSP response which will be served
1425 // to clients that request it.
1426 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001427 // SignedCertificateTimestampList contains an optional encoded
1428 // SignedCertificateTimestampList structure which will be
1429 // served to clients that request it.
1430 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001431 // Leaf is the parsed form of the leaf certificate, which may be
1432 // initialized using x509.ParseCertificate to reduce per-handshake
1433 // processing for TLS clients doing client authentication. If nil, the
1434 // leaf certificate will be parsed as needed.
1435 Leaf *x509.Certificate
1436}
1437
1438// A TLS record.
1439type record struct {
1440 contentType recordType
1441 major, minor uint8
1442 payload []byte
1443}
1444
1445type handshakeMessage interface {
1446 marshal() []byte
1447 unmarshal([]byte) bool
1448}
1449
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001450// lruSessionCache is a client or server session cache implementation
1451// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001452type lruSessionCache struct {
1453 sync.Mutex
1454
1455 m map[string]*list.Element
1456 q *list.List
1457 capacity int
1458}
1459
1460type lruSessionCacheEntry struct {
1461 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001462 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001463}
1464
1465// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001466func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001467 c.Lock()
1468 defer c.Unlock()
1469
1470 if elem, ok := c.m[sessionKey]; ok {
1471 entry := elem.Value.(*lruSessionCacheEntry)
1472 entry.state = cs
1473 c.q.MoveToFront(elem)
1474 return
1475 }
1476
1477 if c.q.Len() < c.capacity {
1478 entry := &lruSessionCacheEntry{sessionKey, cs}
1479 c.m[sessionKey] = c.q.PushFront(entry)
1480 return
1481 }
1482
1483 elem := c.q.Back()
1484 entry := elem.Value.(*lruSessionCacheEntry)
1485 delete(c.m, entry.sessionKey)
1486 entry.sessionKey = sessionKey
1487 entry.state = cs
1488 c.q.MoveToFront(elem)
1489 c.m[sessionKey] = elem
1490}
1491
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001492// Get returns the value associated with a given key. It returns (nil,
1493// false) if no value is found.
1494func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001495 c.Lock()
1496 defer c.Unlock()
1497
1498 if elem, ok := c.m[sessionKey]; ok {
1499 c.q.MoveToFront(elem)
1500 return elem.Value.(*lruSessionCacheEntry).state, true
1501 }
1502 return nil, false
1503}
1504
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001505// lruClientSessionCache is a ClientSessionCache implementation that
1506// uses an LRU caching strategy.
1507type lruClientSessionCache struct {
1508 lruSessionCache
1509}
1510
1511func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1512 c.lruSessionCache.Put(sessionKey, cs)
1513}
1514
1515func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1516 cs, ok := c.lruSessionCache.Get(sessionKey)
1517 if !ok {
1518 return nil, false
1519 }
1520 return cs.(*ClientSessionState), true
1521}
1522
1523// lruServerSessionCache is a ServerSessionCache implementation that
1524// uses an LRU caching strategy.
1525type lruServerSessionCache struct {
1526 lruSessionCache
1527}
1528
1529func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1530 c.lruSessionCache.Put(sessionId, session)
1531}
1532
1533func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1534 cs, ok := c.lruSessionCache.Get(sessionId)
1535 if !ok {
1536 return nil, false
1537 }
1538 return cs.(*sessionState), true
1539}
1540
1541// NewLRUClientSessionCache returns a ClientSessionCache with the given
1542// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1543// is used instead.
1544func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1545 const defaultSessionCacheCapacity = 64
1546
1547 if capacity < 1 {
1548 capacity = defaultSessionCacheCapacity
1549 }
1550 return &lruClientSessionCache{
1551 lruSessionCache{
1552 m: make(map[string]*list.Element),
1553 q: list.New(),
1554 capacity: capacity,
1555 },
1556 }
1557}
1558
1559// NewLRUServerSessionCache returns a ServerSessionCache with the given
1560// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1561// is used instead.
1562func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1563 const defaultSessionCacheCapacity = 64
1564
1565 if capacity < 1 {
1566 capacity = defaultSessionCacheCapacity
1567 }
1568 return &lruServerSessionCache{
1569 lruSessionCache{
1570 m: make(map[string]*list.Element),
1571 q: list.New(),
1572 capacity: capacity,
1573 },
1574 }
1575}
1576
Adam Langley95c29f32014-06-20 12:00:00 -07001577// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1578type dsaSignature struct {
1579 R, S *big.Int
1580}
1581
1582type ecdsaSignature dsaSignature
1583
1584var emptyConfig Config
1585
1586func defaultConfig() *Config {
1587 return &emptyConfig
1588}
1589
1590var (
1591 once sync.Once
1592 varDefaultCipherSuites []uint16
1593)
1594
1595func defaultCipherSuites() []uint16 {
1596 once.Do(initDefaultCipherSuites)
1597 return varDefaultCipherSuites
1598}
1599
1600func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001601 for _, suite := range cipherSuites {
1602 if suite.flags&suitePSK == 0 {
1603 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1604 }
Adam Langley95c29f32014-06-20 12:00:00 -07001605 }
1606}
1607
1608func unexpectedMessageError(wanted, got interface{}) error {
1609 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1610}
David Benjamin000800a2014-11-14 01:43:59 -05001611
Nick Harper60edffd2016-06-21 15:19:24 -07001612func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1613 for _, s := range sigAlgs {
1614 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001615 return true
1616 }
1617 }
1618 return false
1619}
Nick Harper85f20c22016-07-04 10:11:59 -07001620
1621var (
David Benjamina128a552016-10-13 14:26:33 -04001622 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001623 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1624 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1625)