blob: 167e872b0bbae0e426e77ba9d3461ab178fb9329 [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
Adam Langley95c29f32014-06-20 12:00:00 -0700103)
104
105// TLS signaling cipher suite values
106const (
107 scsvRenegotiation uint16 = 0x00ff
108)
109
110// CurveID is the type of a TLS identifier for an elliptic curve. See
111// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
112type CurveID uint16
113
114const (
David Benjamincba2b622015-12-18 22:13:41 -0500115 CurveP224 CurveID = 21
116 CurveP256 CurveID = 23
117 CurveP384 CurveID = 24
118 CurveP521 CurveID = 25
119 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700120)
121
122// TLS Elliptic Curve Point Formats
123// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
124const (
David Benjamina81967b2016-12-22 09:16:57 -0500125 pointFormatUncompressed uint8 = 0
126 pointFormatCompressedPrime uint8 = 1
Adam Langley95c29f32014-06-20 12:00:00 -0700127)
128
129// TLS CertificateStatusType (RFC 3546)
130const (
131 statusTypeOCSP uint8 = 1
132)
133
134// Certificate types (for certificateRequestMsg)
135const (
David Benjamin7b030512014-07-08 17:30:11 -0400136 CertTypeRSASign = 1 // A certificate containing an RSA key
137 CertTypeDSSSign = 2 // A certificate containing a DSA key
138 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
139 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700140
141 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400142 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
143 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
144 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146 // Rest of these are reserved by the TLS spec
147)
148
Nick Harper60edffd2016-06-21 15:19:24 -0700149// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
150// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
151// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
152// algorithms' throughout. We match the latter.
153type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700154
Adam Langley95c29f32014-06-20 12:00:00 -0700155const (
Nick Harper60edffd2016-06-21 15:19:24 -0700156 // RSASSA-PKCS1-v1_5 algorithms
157 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
158 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
159 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
160 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
161 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700162
Nick Harper60edffd2016-06-21 15:19:24 -0700163 // ECDSA algorithms
164 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
165 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
166 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
167 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
168
169 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400170 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
171 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
172 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700173
174 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400175 signatureEd25519 signatureAlgorithm = 0x0807
176 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700177)
Adam Langley95c29f32014-06-20 12:00:00 -0700178
David Benjamin7a41d372016-07-09 11:21:54 -0700179// supportedSignatureAlgorithms contains the default supported signature
180// algorithms.
181var supportedSignatureAlgorithms = []signatureAlgorithm{
182 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700183 signatureRSAPKCS1WithSHA256,
184 signatureECDSAWithP256AndSHA256,
185 signatureRSAPKCS1WithSHA1,
186 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700187}
188
David Benjaminca6c8262014-11-15 19:06:08 -0500189// SRTP protection profiles (See RFC 5764, section 4.1.2)
190const (
191 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
192 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
193)
194
David Benjamina128a552016-10-13 14:26:33 -0400195// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200196const (
Steven Valdez5b986082016-09-01 12:29:49 -0400197 pskKEMode = 0
198 pskDHEKEMode = 1
199)
200
Steven Valdezc4aa7272016-10-03 12:25:56 -0400201// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
202const (
203 keyUpdateNotRequested = 0
204 keyUpdateRequested = 1
205)
206
Adam Langley95c29f32014-06-20 12:00:00 -0700207// ConnectionState records basic TLS details about the connection.
208type ConnectionState struct {
209 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
210 HandshakeComplete bool // TLS handshake is complete
211 DidResume bool // connection resumes a previous TLS connection
212 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
213 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
214 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400215 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700216 ServerName string // server name requested by client, if any (server side only)
217 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
218 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400219 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500220 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400221 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100222 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700223 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400224 CurveID CurveID // the curve used in ECDHE
Adam Langley95c29f32014-06-20 12:00:00 -0700225}
226
227// ClientAuthType declares the policy the server will follow for
228// TLS Client Authentication.
229type ClientAuthType int
230
231const (
232 NoClientCert ClientAuthType = iota
233 RequestClientCert
234 RequireAnyClientCert
235 VerifyClientCertIfGiven
236 RequireAndVerifyClientCert
237)
238
239// ClientSessionState contains the state needed by clients to resume TLS
240// sessions.
241type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500242 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700243 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
244 vers uint16 // SSL/TLS version negotiated for the session
245 cipherSuite uint16 // Ciphersuite negotiated for the session
246 masterSecret []byte // MasterSecret generated by client on a full handshake
247 handshakeHash []byte // Handshake hash for Channel ID purposes.
248 serverCertificates []*x509.Certificate // Certificate chain presented by the server
249 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100250 sctList []byte
251 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700252 ticketCreationTime time.Time
253 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400254 ticketAgeAdd uint32
Nick Harperf2511f12016-12-06 16:02:31 -0800255 maxEarlyDataSize uint32
Adam Langley95c29f32014-06-20 12:00:00 -0700256}
257
258// ClientSessionCache is a cache of ClientSessionState objects that can be used
259// by a client to resume a TLS session with a given server. ClientSessionCache
260// implementations should expect to be called concurrently from different
261// goroutines.
262type ClientSessionCache interface {
263 // Get searches for a ClientSessionState associated with the given key.
264 // On return, ok is true if one was found.
265 Get(sessionKey string) (session *ClientSessionState, ok bool)
266
267 // Put adds the ClientSessionState to the cache with the given key.
268 Put(sessionKey string, cs *ClientSessionState)
269}
270
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500271// ServerSessionCache is a cache of sessionState objects that can be used by a
272// client to resume a TLS session with a given server. ServerSessionCache
273// implementations should expect to be called concurrently from different
274// goroutines.
275type ServerSessionCache interface {
276 // Get searches for a sessionState associated with the given session
277 // ID. On return, ok is true if one was found.
278 Get(sessionId string) (session *sessionState, ok bool)
279
280 // Put adds the sessionState to the cache with the given session ID.
281 Put(sessionId string, session *sessionState)
282}
283
Adam Langley95c29f32014-06-20 12:00:00 -0700284// A Config structure is used to configure a TLS client or server.
285// After one has been passed to a TLS function it must not be
286// modified. A Config may be reused; the tls package will also not
287// modify it.
288type Config struct {
289 // Rand provides the source of entropy for nonces and RSA blinding.
290 // If Rand is nil, TLS uses the cryptographic random reader in package
291 // crypto/rand.
292 // The Reader must be safe for use by multiple goroutines.
293 Rand io.Reader
294
295 // Time returns the current time as the number of seconds since the epoch.
296 // If Time is nil, TLS uses time.Now.
297 Time func() time.Time
298
299 // Certificates contains one or more certificate chains
300 // to present to the other side of the connection.
301 // Server configurations must include at least one certificate.
302 Certificates []Certificate
303
304 // NameToCertificate maps from a certificate name to an element of
305 // Certificates. Note that a certificate name can be of the form
306 // '*.example.com' and so doesn't have to be a domain name as such.
307 // See Config.BuildNameToCertificate
308 // The nil value causes the first element of Certificates to be used
309 // for all connections.
310 NameToCertificate map[string]*Certificate
311
312 // RootCAs defines the set of root certificate authorities
313 // that clients use when verifying server certificates.
314 // If RootCAs is nil, TLS uses the host's root CA set.
315 RootCAs *x509.CertPool
316
317 // NextProtos is a list of supported, application level protocols.
318 NextProtos []string
319
320 // ServerName is used to verify the hostname on the returned
321 // certificates unless InsecureSkipVerify is given. It is also included
322 // in the client's handshake to support virtual hosting.
323 ServerName string
324
325 // ClientAuth determines the server's policy for
326 // TLS Client Authentication. The default is NoClientCert.
327 ClientAuth ClientAuthType
328
329 // ClientCAs defines the set of root certificate authorities
330 // that servers use if required to verify a client certificate
331 // by the policy in ClientAuth.
332 ClientCAs *x509.CertPool
333
David Benjamin7b030512014-07-08 17:30:11 -0400334 // ClientCertificateTypes defines the set of allowed client certificate
335 // types. The default is CertTypeRSASign and CertTypeECDSASign.
336 ClientCertificateTypes []byte
337
Adam Langley95c29f32014-06-20 12:00:00 -0700338 // InsecureSkipVerify controls whether a client verifies the
339 // server's certificate chain and host name.
340 // If InsecureSkipVerify is true, TLS accepts any certificate
341 // presented by the server and any host name in that certificate.
342 // In this mode, TLS is susceptible to man-in-the-middle attacks.
343 // This should be used only for testing.
344 InsecureSkipVerify bool
345
346 // CipherSuites is a list of supported cipher suites. If CipherSuites
347 // is nil, TLS uses a list of suites supported by the implementation.
348 CipherSuites []uint16
349
350 // PreferServerCipherSuites controls whether the server selects the
351 // client's most preferred ciphersuite, or the server's most preferred
352 // ciphersuite. If true then the server's preference, as expressed in
353 // the order of elements in CipherSuites, is used.
354 PreferServerCipherSuites bool
355
356 // SessionTicketsDisabled may be set to true to disable session ticket
357 // (resumption) support.
358 SessionTicketsDisabled bool
359
360 // SessionTicketKey is used by TLS servers to provide session
361 // resumption. See RFC 5077. If zero, it will be filled with
362 // random data before the first server handshake.
363 //
364 // If multiple servers are terminating connections for the same host
365 // they should all have the same SessionTicketKey. If the
366 // SessionTicketKey leaks, previously recorded and future TLS
367 // connections using that key are compromised.
368 SessionTicketKey [32]byte
369
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500370 // ClientSessionCache is a cache of ClientSessionState entries
371 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700372 ClientSessionCache ClientSessionCache
373
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500374 // ServerSessionCache is a cache of sessionState entries for TLS session
375 // resumption.
376 ServerSessionCache ServerSessionCache
377
Adam Langley95c29f32014-06-20 12:00:00 -0700378 // MinVersion contains the minimum SSL/TLS version that is acceptable.
379 // If zero, then SSLv3 is taken as the minimum.
380 MinVersion uint16
381
382 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
383 // If zero, then the maximum version supported by this package is used,
384 // which is currently TLS 1.2.
385 MaxVersion uint16
386
387 // CurvePreferences contains the elliptic curves that will be used in
388 // an ECDHE handshake, in preference order. If empty, the default will
389 // be used.
390 CurvePreferences []CurveID
391
Nick Harperdcfbc672016-07-16 17:47:31 +0200392 // DefaultCurves contains the elliptic curves for which public values will
393 // be sent in the ClientHello's KeyShare extension. If this value is nil,
394 // all supported curves will have public values sent. This field is ignored
395 // on servers.
396 DefaultCurves []CurveID
397
David Benjamind30a9902014-08-24 01:44:23 -0400398 // ChannelID contains the ECDSA key for the client to use as
399 // its TLS Channel ID.
400 ChannelID *ecdsa.PrivateKey
401
402 // RequestChannelID controls whether the server requests a TLS
403 // Channel ID. If negotiated, the client's public key is
404 // returned in the ConnectionState.
405 RequestChannelID bool
406
David Benjamin48cae082014-10-27 01:06:24 -0400407 // PreSharedKey, if not nil, is the pre-shared key to use with
408 // the PSK cipher suites.
409 PreSharedKey []byte
410
411 // PreSharedKeyIdentity, if not empty, is the identity to use
412 // with the PSK cipher suites.
413 PreSharedKeyIdentity string
414
Nick Harperab20cec2016-12-19 17:38:41 -0800415 // MaxEarlyDataSize controls the maximum number of bytes that the
416 // server will accept in early data and advertise in a
417 // NewSessionTicketMsg. If 0, no early data will be accepted and
418 // the TicketEarlyDataInfo extension in the NewSessionTicketMsg
419 // will be omitted.
420 MaxEarlyDataSize uint32
421
David Benjaminca6c8262014-11-15 19:06:08 -0500422 // SRTPProtectionProfiles, if not nil, is the list of SRTP
423 // protection profiles to offer in DTLS-SRTP.
424 SRTPProtectionProfiles []uint16
425
David Benjamin7a41d372016-07-09 11:21:54 -0700426 // SignSignatureAlgorithms, if not nil, overrides the default set of
427 // supported signature algorithms to sign with.
428 SignSignatureAlgorithms []signatureAlgorithm
429
430 // VerifySignatureAlgorithms, if not nil, overrides the default set of
431 // supported signature algorithms that are accepted.
432 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500433
Adam Langley95c29f32014-06-20 12:00:00 -0700434 // Bugs specifies optional misbehaviour to be used for testing other
435 // implementations.
436 Bugs ProtocolBugs
437
438 serverInitOnce sync.Once // guards calling (*Config).serverInit
439}
440
441type BadValue int
442
443const (
444 BadValueNone BadValue = iota
445 BadValueNegative
446 BadValueZero
447 BadValueLimit
448 BadValueLarge
449 NumBadValues
450)
451
David Benjaminb36a3952015-12-01 18:53:13 -0500452type RSABadValue int
453
454const (
455 RSABadValueNone RSABadValue = iota
456 RSABadValueCorrupt
457 RSABadValueTooLong
458 RSABadValueTooShort
459 RSABadValueWrongVersion
460 NumRSABadValues
461)
462
Adam Langley95c29f32014-06-20 12:00:00 -0700463type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400464 // InvalidSignature specifies that the signature in a ServerKeyExchange
465 // or CertificateVerify message should be invalid.
466 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400467
Steven Valdez5440fe02016-07-18 12:40:30 -0400468 // SendCurve, if non-zero, causes the server to send the specified curve
469 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
470 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400471 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700472
David Benjamin2b07fa42016-03-02 00:23:57 -0500473 // InvalidECDHPoint, if true, causes the ECC points in
474 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
475 InvalidECDHPoint bool
476
Adam Langley95c29f32014-06-20 12:00:00 -0700477 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
478 // can be invalid.
479 BadECDSAR BadValue
480 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700481
482 // MaxPadding causes CBC records to have the maximum possible padding.
483 MaxPadding bool
484 // PaddingFirstByteBad causes the first byte of the padding to be
485 // incorrect.
486 PaddingFirstByteBad bool
487 // PaddingFirstByteBadIf255 causes the first byte of padding to be
488 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
489 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700490
491 // FailIfNotFallbackSCSV causes a server handshake to fail if the
492 // client doesn't send the fallback SCSV value.
493 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400494
495 // DuplicateExtension causes an extra empty extension of bogus type to
496 // be emitted in either the ClientHello or the ServerHello.
497 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400498
499 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
500 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
501 // Certificate message is sent and no signature is added to
502 // ServerKeyExchange.
503 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400504
David Benjaminb80168e2015-02-08 18:30:14 -0500505 // SkipHelloVerifyRequest causes a DTLS server to skip the
506 // HelloVerifyRequest message.
507 SkipHelloVerifyRequest bool
508
David Benjamindcd979f2015-04-20 18:26:52 -0400509 // SkipCertificateStatus, if true, causes the server to skip the
510 // CertificateStatus message. This is legal because CertificateStatus is
511 // optional, even with a status_request in ServerHello.
512 SkipCertificateStatus bool
513
David Benjamin9c651c92014-07-12 13:27:45 -0400514 // SkipServerKeyExchange causes the server to skip sending
515 // ServerKeyExchange messages.
516 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400517
David Benjaminb80168e2015-02-08 18:30:14 -0500518 // SkipNewSessionTicket causes the server to skip sending the
519 // NewSessionTicket message despite promising to in ServerHello.
520 SkipNewSessionTicket bool
521
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500522 // SkipClientCertificate causes the client to skip the Certificate
523 // message.
524 SkipClientCertificate bool
525
David Benjamina0e52232014-07-19 17:39:58 -0400526 // SkipChangeCipherSpec causes the implementation to skip
527 // sending the ChangeCipherSpec message (and adjusting cipher
528 // state accordingly for the Finished message).
529 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400530
David Benjaminb80168e2015-02-08 18:30:14 -0500531 // SkipFinished causes the implementation to skip sending the Finished
532 // message.
533 SkipFinished bool
534
David Benjaminf3ec83d2014-07-21 22:42:34 -0400535 // EarlyChangeCipherSpec causes the client to send an early
536 // ChangeCipherSpec message before the ClientKeyExchange. A value of
537 // zero disables this behavior. One and two configure variants for 0.9.8
538 // and 1.0.1 modes, respectively.
539 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400540
David Benjamin8144f992016-06-22 17:05:13 -0400541 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
542 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
543 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
544 StrayChangeCipherSpec bool
545
David Benjamin86271ee2014-07-21 16:14:03 -0400546 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
547 // the Finished (or NextProto) message around the ChangeCipherSpec
548 // messages.
549 FragmentAcrossChangeCipherSpec bool
550
David Benjamin61672812016-07-14 23:10:43 -0400551 // SendUnencryptedFinished, if true, causes the Finished message to be
552 // send unencrypted before ChangeCipherSpec rather than after it.
553 SendUnencryptedFinished bool
554
David Benjamin7964b182016-07-14 23:36:30 -0400555 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
556 // 1.3 server to send part of EncryptedExtensions unencrypted
557 // in the same record as ServerHello.
558 PartialEncryptedExtensionsWithServerHello bool
559
560 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
561 // client to send part of Finished unencrypted in the same record as
562 // ClientHello.
563 PartialClientFinishedWithClientHello bool
564
David Benjamind86c7672014-08-02 04:07:12 -0400565 // SendV2ClientHello causes the client to send a V2ClientHello
566 // instead of a normal ClientHello.
567 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400568
569 // SendFallbackSCSV causes the client to include
570 // TLS_FALLBACK_SCSV in the ClientHello.
571 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400572
Adam Langley5021b222015-06-12 18:27:58 -0700573 // SendRenegotiationSCSV causes the client to include the renegotiation
574 // SCSV in the ClientHello.
575 SendRenegotiationSCSV bool
576
David Benjamin43ec06f2014-08-05 02:28:57 -0400577 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400578 // handshake record. Handshake messages will be split into multiple
579 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400580 // never be fragmented. For DTLS, it is the maximum handshake fragment
581 // size, not record size; DTLS allows multiple handshake fragments in a
582 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400583 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400584
David Benjamin98214542014-08-07 18:02:39 -0400585 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
586 // the first 6 bytes of the ClientHello.
587 FragmentClientVersion bool
588
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400589 // FragmentAlert will cause all alerts to be fragmented across
590 // two records.
591 FragmentAlert bool
592
David Benjamin0d3a8c62016-03-11 22:25:18 -0500593 // DoubleAlert will cause all alerts to be sent as two copies packed
594 // within one record.
595 DoubleAlert bool
596
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500597 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
598 // alert to be sent.
599 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400600
David Benjaminb36a3952015-12-01 18:53:13 -0500601 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
602 // ClientKeyExchange which would not pass padding checks.
603 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400604
605 // RenewTicketOnResume causes the server to renew the session ticket and
606 // send a NewSessionTicket message during an abbreviated handshake.
607 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400608
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400609 // SendClientVersion, if non-zero, causes the client to send the
610 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400611 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400612
Steven Valdezfdd10992016-09-15 16:27:05 -0400613 // OmitSupportedVersions, if true, causes the client to omit the
614 // supported versions extension.
615 OmitSupportedVersions bool
616
617 // SendSupportedVersions, if non-empty, causes the client to send a
618 // supported versions extension with the values from array.
619 SendSupportedVersions []uint16
620
David Benjamin1f61f0d2016-07-10 12:20:35 -0400621 // NegotiateVersion, if non-zero, causes the server to negotiate the
622 // specifed TLS version rather than the version supported by either
623 // peer.
624 NegotiateVersion uint16
625
David Benjamine7e36aa2016-08-08 12:39:41 -0400626 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
627 // the specified TLS version on renegotiation rather than retaining it.
628 NegotiateVersionOnRenego uint16
629
David Benjamine58c4f52014-08-24 03:47:07 -0400630 // ExpectFalseStart causes the server to, on full handshakes,
631 // expect the peer to False Start; the server Finished message
632 // isn't sent until we receive an application data record
633 // from the peer.
634 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400635
David Benjamin1c633152015-04-02 20:19:11 -0400636 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
637 // handshakes, send an alert just before reading the application data
638 // record to test False Start. This can be used in a negative False
639 // Start test to determine whether the peer processed the alert (and
640 // closed the connection) before or after sending app data.
641 AlertBeforeFalseStartTest alert
642
David Benjamine78bfde2014-09-06 12:45:15 -0400643 // ExpectServerName, if not empty, is the hostname the client
644 // must specify in the server_name extension.
645 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400646
David Benjamin76c2efc2015-08-31 14:24:29 -0400647 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
648 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400649 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400650
Adam Langleyefb0e162015-07-09 11:35:04 -0700651 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
652 // return.
653 ALPNProtocol *string
654
David Benjamin405da482016-08-08 17:25:07 -0400655 // AcceptAnySession causes the server to resume sessions regardless of
656 // the version associated with the session or cipher suite. It also
657 // causes the server to look in both TLS 1.2 and 1.3 extensions to
658 // process a ticket.
659 AcceptAnySession bool
660
661 // SendBothTickets, if true, causes the client to send tickets in both
662 // TLS 1.2 and 1.3 extensions.
663 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700664
David Benjamin4199b0d2016-11-01 13:58:25 -0400665 // FilterTicket, if not nil, causes the client to modify a session
666 // ticket before sending it in a resume handshake.
667 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700668
David Benjamind4c349b2017-02-09 14:07:17 -0500669 // TicketSessionIDLength, if non-zero, is the length of the session ID
670 // to send with a ticket resumption offer.
671 TicketSessionIDLength int
672
673 // EmptyTicketSessionID, if true, causes the client to send an empty
674 // session ID with a ticket resumption offer. For simplicity, this will
675 // also cause the client to interpret a ServerHello with empty session
676 // ID as a resumption. (A client which sends empty session ID is
677 // normally expected to look ahead for ChangeCipherSpec.)
678 EmptyTicketSessionID bool
Adam Langley75712922014-10-10 16:23:43 -0700679
David Benjamin405da482016-08-08 17:25:07 -0400680 // ExpectNoTLS12Session, if true, causes the server to fail the
681 // connection if either a session ID or TLS 1.2 ticket is offered.
682 ExpectNoTLS12Session bool
683
684 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
685 // if a TLS 1.3 PSK is offered.
686 ExpectNoTLS13PSK bool
687
Adam Langley75712922014-10-10 16:23:43 -0700688 // RequireExtendedMasterSecret, if true, requires that the peer support
689 // the extended master secret option.
690 RequireExtendedMasterSecret bool
691
David Benjaminca6554b2014-11-08 12:31:52 -0500692 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400693 // they didn't support an extended master secret in the initial
694 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700695 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700696
David Benjamin163c9562016-08-29 23:14:17 -0400697 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
698 // behave as if they didn't support an extended master secret in
699 // renegotiation handshakes.
700 NoExtendedMasterSecretOnRenegotiation bool
701
Adam Langley2ae77d22014-10-28 17:29:33 -0700702 // EmptyRenegotiationInfo causes the renegotiation extension to be
703 // empty in a renegotiation handshake.
704 EmptyRenegotiationInfo bool
705
706 // BadRenegotiationInfo causes the renegotiation extension value in a
707 // renegotiation handshake to be incorrect.
708 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500709
David Benjamin3e052de2015-11-25 20:10:31 -0500710 // NoRenegotiationInfo disables renegotiation info support in all
711 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500712 NoRenegotiationInfo bool
713
David Benjamin3e052de2015-11-25 20:10:31 -0500714 // NoRenegotiationInfoInInitial disables renegotiation info support in
715 // the initial handshake.
716 NoRenegotiationInfoInInitial bool
717
718 // NoRenegotiationInfoAfterInitial disables renegotiation info support
719 // in renegotiation handshakes.
720 NoRenegotiationInfoAfterInitial bool
721
Adam Langley5021b222015-06-12 18:27:58 -0700722 // RequireRenegotiationInfo, if true, causes the client to return an
723 // error if the server doesn't reply with the renegotiation extension.
724 RequireRenegotiationInfo bool
725
David Benjamin8e6db492015-07-25 18:29:23 -0400726 // SequenceNumberMapping, if non-nil, is the mapping function to apply
727 // to the sequence number of outgoing packets. For both TLS and DTLS,
728 // the two most-significant bytes in the resulting sequence number are
729 // ignored so that the DTLS epoch cannot be changed.
730 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500731
David Benjamina3e89492015-02-26 15:16:22 -0500732 // RSAEphemeralKey, if true, causes the server to send a
733 // ServerKeyExchange message containing an ephemeral key (as in
734 // RSA_EXPORT) in the plain RSA key exchange.
735 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500736
737 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
738 // client offers when negotiating SRTP. MKI support is still missing so
739 // the peer must still send none.
740 SRTPMasterKeyIdentifer string
741
742 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
743 // server sends in the ServerHello instead of the negotiated one.
744 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500745
Nick Harper60edffd2016-06-21 15:19:24 -0700746 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500747 // signature and hashes extension.
748 //
749 // For a server, it will cause an empty list to be sent in the
750 // CertificateRequest message. None the less, the configured set will
751 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700752 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500753
David Benjamin55a43642015-04-20 14:45:55 -0400754 // NoSupportedCurves, if true, causes the client to omit the
755 // supported_curves extension.
756 NoSupportedCurves bool
757
David Benjaminc44b1df2014-11-23 12:11:01 -0500758 // RequireSameRenegoClientVersion, if true, causes the server
759 // to require that all ClientHellos match in offered version
760 // across a renego.
761 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800762
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400763 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500764 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500765 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500766
David Benjamine6f22212016-11-08 14:28:24 -0500767 // SendRecordVersion, if non-zero, is the value to send as the
768 // record-layer version.
769 SendRecordVersion uint16
770
771 // SendInitialRecordVersion, if non-zero, is the value to send as the
772 // record-layer version before the protocol version is determined.
773 SendInitialRecordVersion uint16
774
David Benjamin13be1de2015-01-11 16:29:36 -0500775 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
776 // packet.
777 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500778
779 // SendCipherSuite, if non-zero, is the cipher suite value that the
780 // server will send in the ServerHello. This does not affect the cipher
781 // the server believes it has actually negotiated.
782 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500783
David Benjamin75f99142016-11-12 12:36:06 +0900784 // SendCipherSuites, if not nil, is the cipher suite list that the
785 // client will send in the ClientHello. This does not affect the cipher
786 // the client believes it has actually offered.
787 SendCipherSuites []uint16
788
David Benjamin4cf369b2015-08-22 01:35:43 -0400789 // AppDataBeforeHandshake, if not nil, causes application data to be
790 // sent immediately before the first handshake message.
791 AppDataBeforeHandshake []byte
792
793 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500794 // be sent immediately after ChangeCipherSpec.
795 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500796
David Benjamindc3da932015-03-12 15:09:02 -0400797 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
798 // immediately after ChangeCipherSpec.
799 AlertAfterChangeCipherSpec alert
800
David Benjamin83f90402015-01-27 01:09:43 -0500801 // TimeoutSchedule is the schedule of packet drops and simulated
802 // timeouts for before each handshake leg from the peer.
803 TimeoutSchedule []time.Duration
804
805 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
806 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500807
808 // ReorderHandshakeFragments, if true, causes handshake fragments in
809 // DTLS to overlap and be sent in the wrong order. It also causes
810 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
811 // Finished and will trigger a spurious retransmit.)
812 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500813
David Benjamin61672812016-07-14 23:10:43 -0400814 // ReverseHandshakeFragments, if true, causes handshake fragments in
815 // DTLS to be reversed within a flight.
816 ReverseHandshakeFragments bool
817
David Benjamin75381222015-03-02 19:30:30 -0500818 // MixCompleteMessageWithFragments, if true, causes handshake
819 // messages in DTLS to redundantly both fragment the message
820 // and include a copy of the full one.
821 MixCompleteMessageWithFragments bool
822
David Benjaminddb9f152015-02-03 15:44:39 -0500823 // SendInvalidRecordType, if true, causes a record with an invalid
824 // content type to be sent immediately following the handshake.
825 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500826
David Benjamin0b8d5da2016-07-15 00:39:56 -0400827 // SendWrongMessageType, if non-zero, causes messages of the specified
828 // type to be sent with the wrong value.
829 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500830
David Benjamin639846e2016-09-09 11:41:18 -0400831 // SendTrailingMessageData, if non-zero, causes messages of the
832 // specified type to be sent with trailing data.
833 SendTrailingMessageData byte
834
David Benjamin75381222015-03-02 19:30:30 -0500835 // FragmentMessageTypeMismatch, if true, causes all non-initial
836 // handshake fragments in DTLS to have the wrong message type.
837 FragmentMessageTypeMismatch bool
838
839 // FragmentMessageLengthMismatch, if true, causes all non-initial
840 // handshake fragments in DTLS to have the wrong message length.
841 FragmentMessageLengthMismatch bool
842
David Benjamin11fc66a2015-06-16 11:40:24 -0400843 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
844 // to be split across two records. The value of |SplitFragments| is the
845 // number of bytes in the first fragment.
846 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500847
848 // SendEmptyFragments, if true, causes handshakes to include empty
849 // fragments in DTLS.
850 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400851
David Benjamin9a41d1b2015-05-16 01:30:09 -0400852 // SendSplitAlert, if true, causes an alert to be sent with the header
853 // and record body split across multiple packets. The peer should
854 // discard these packets rather than process it.
855 SendSplitAlert bool
856
David Benjamin4b27d9f2015-05-12 22:42:52 -0400857 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
858 // client offers a resumption or the server accepts one.
859 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400860
David Benjamin67d1fb52015-03-16 15:16:23 -0400861 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
862 // preferences to be ignored.
863 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400864
865 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
866 // signature algorithm preferences to be ignored.
867 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400868
David Benjaminc574f412015-04-20 11:13:01 -0400869 // IgnorePeerCurvePreferences, if true, causes the peer's curve
870 // preferences to be ignored.
871 IgnorePeerCurvePreferences bool
872
David Benjamin513f0ea2015-04-02 19:33:31 -0400873 // BadFinished, if true, causes the Finished hash to be broken.
874 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700875
876 // DHGroupPrime, if not nil, is used to define the (finite field)
877 // Diffie-Hellman group. The generator used is always two.
878 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400879
David Benjamin582ba042016-07-07 12:33:25 -0700880 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
881 // to be packed into individual handshake records, up to the specified
882 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400883 PackHandshakeFragments int
884
David Benjamin582ba042016-07-07 12:33:25 -0700885 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
886 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400887 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400888
David Benjamin582ba042016-07-07 12:33:25 -0700889 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
890 // be packed into records, up to the largest size record available.
891 PackHandshakeFlight bool
892
David Benjamin5ecb88b2016-10-04 17:51:35 -0400893 // AdvertiseAllConfiguredCiphers, if true, causes the client to
894 // advertise all configured cipher suite values.
895 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400896
897 // EmptyCertificateList, if true, causes the server to send an empty
898 // certificate list in the Certificate message.
899 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400900
901 // ExpectNewTicket, if true, causes the client to abort if it does not
902 // receive a new ticket.
903 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700904
905 // RequireClientHelloSize, if not zero, is the required length in bytes
906 // of the ClientHello /record/. This is checked by the server.
907 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700908
909 // CustomExtension, if not empty, contains the contents of an extension
910 // that will be added to client/server hellos.
911 CustomExtension string
912
David Benjamin490469f2016-10-05 22:44:38 -0400913 // CustomUnencryptedExtension, if not empty, contains the contents of
914 // an extension that will be added to ServerHello in TLS 1.3.
915 CustomUnencryptedExtension string
916
Adam Langley09505632015-07-30 18:10:13 -0700917 // ExpectedCustomExtension, if not nil, contains the expected contents
918 // of a custom extension.
919 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400920
David Benjamin1286bee2016-10-07 15:25:06 -0400921 // CustomTicketExtension, if not empty, contains the contents of an
922 // extension what will be added to NewSessionTicket in TLS 1.3.
923 CustomTicketExtension string
924
David Benjamin3baa6e12016-10-07 21:10:38 -0400925 // CustomTicketExtension, if not empty, contains the contents of an
926 // extension what will be added to HelloRetryRequest in TLS 1.3.
927 CustomHelloRetryRequestExtension string
928
David Benjamin30789da2015-08-29 22:56:45 -0400929 // NoCloseNotify, if true, causes the close_notify alert to be skipped
930 // on connection shutdown.
931 NoCloseNotify bool
932
David Benjaminfa214e42016-05-10 17:03:10 -0400933 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
934 // close_notify on shutdown.
935 SendAlertOnShutdown alert
936
David Benjamin30789da2015-08-29 22:56:45 -0400937 // ExpectCloseNotify, if true, requires a close_notify from the peer on
938 // shutdown. Records from the peer received after close_notify is sent
939 // are not discard.
940 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400941
942 // SendLargeRecords, if true, allows outgoing records to be sent
943 // arbitrarily large.
944 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400945
946 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
947 // ALPN and NPN in the same connetion.
948 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400949
David Benjamin0c40a962016-08-01 12:05:50 -0400950 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400951 // string in the ALPN extension regardless of the content or presence of
952 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400953 SendALPN string
954
David Benjamin490469f2016-10-05 22:44:38 -0400955 // SendUnencryptedALPN, if non-empty, causes the server to send the
956 // specified string in a ServerHello ALPN extension in TLS 1.3.
957 SendUnencryptedALPN string
958
David Benjamindd6fed92015-10-23 17:41:12 -0400959 // SendEmptySessionTicket, if true, causes the server to send an empty
960 // session ticket.
961 SendEmptySessionTicket bool
962
Steven Valdeza833c352016-11-01 13:39:36 -0400963 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400964 // to send.
965 SendPSKKeyExchangeModes []byte
966
Steven Valdeza833c352016-11-01 13:39:36 -0400967 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
968 // receipt of a NewSessionTicket message.
969 ExpectNoNewSessionTicket bool
970
David Benjamin9c33ae82017-01-08 06:04:43 -0500971 // DuplicateTicketEarlyDataInfo causes an extra empty extension of
972 // ticket_early_data_info to be sent in NewSessionTicket.
973 DuplicateTicketEarlyDataInfo bool
974
Steven Valdez08b65f42016-12-07 15:29:45 -0500975 // ExpectTicketEarlyDataInfo, if true, means that the client will fail upon
976 // absence of the ticket_early_data_info extension.
977 ExpectTicketEarlyDataInfo bool
978
Steven Valdeza833c352016-11-01 13:39:36 -0400979 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
980 // server receives from the client.
981 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -0400982
David Benjamin35ac5b72017-03-03 15:05:56 -0500983 // SendTicketAge, if non-zero, is the ticket age to be sent by the
984 // client.
985 SendTicketAge time.Duration
986
David Benjamindd6fed92015-10-23 17:41:12 -0400987 // FailIfSessionOffered, if true, causes the server to fail any
988 // connections where the client offers a non-empty session ID or session
989 // ticket.
990 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800991
992 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
993 // HelloRequest handshake message to be sent before each application
994 // data record. This only makes sense for a server.
995 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800996
David Benjamin71dd6662016-07-08 14:10:48 -0700997 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
998 // HelloRequest handshake message to be sent before each handshake
999 // message. This only makes sense for a server.
1000 SendHelloRequestBeforeEveryHandshakeMessage bool
1001
Adam Langleyc4f25ce2015-11-26 16:39:08 -08001002 // RequireDHPublicValueLen causes a fatal error if the length (in
1003 // bytes) of the server's Diffie-Hellman public value is not equal to
1004 // this.
1005 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -05001006
1007 // BadChangeCipherSpec, if not nil, is the body to be sent in
1008 // ChangeCipherSpec records instead of {1}.
1009 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -05001010
1011 // BadHelloRequest, if not nil, is what to send instead of a
1012 // HelloRequest.
1013 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -05001014
1015 // RequireSessionTickets, if true, causes the client to require new
1016 // sessions use session tickets instead of session IDs.
1017 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -05001018
1019 // NullAllCiphers, if true, causes every cipher to behave like the null
1020 // cipher.
1021 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -04001022
1023 // SendSCTListOnResume, if not nil, causes the server to send the
1024 // supplied SCT list in resumption handshakes.
1025 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -07001026
David Benjamindaa88502016-10-04 16:32:16 -04001027 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
1028 // OCSP stapling in resumption handshakes and, if applicable, send the
1029 // supplied stapled response.
1030 SendOCSPResponseOnResume []byte
1031
Steven Valdeza833c352016-11-01 13:39:36 -04001032 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1033 // supplied bytes in the extensions on the Certificate message.
1034 SendExtensionOnCertificate []byte
1035
1036 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1037 // supplied OCSP on intermediate certificates in the Certificate message.
1038 SendOCSPOnIntermediates []byte
1039
1040 // SendSCTOnIntermediates, if not nil, causes the server to send the
1041 // supplied SCT on intermediate certificates in the Certificate message.
1042 SendSCTOnIntermediates []byte
1043
1044 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1045 // copy of the OCSP/SCT extensions in the Certificate message.
1046 SendDuplicateCertExtensions bool
1047
1048 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1049 // reject extensions on intermediate certificates.
1050 ExpectNoExtensionsOnIntermediate bool
1051
David Benjaminc9ae27c2016-06-24 22:56:37 -04001052 // RecordPadding is the number of bytes of padding to add to each
1053 // encrypted record in TLS 1.3.
1054 RecordPadding int
1055
1056 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1057 // be missing their body and content type. Padding, if configured, is
1058 // still added.
1059 OmitRecordContents bool
1060
1061 // OuterRecordType, if non-zero, is the outer record type to use instead
1062 // of application data.
1063 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001064
1065 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1066 // with the given signature algorithm rather than the one negotiated.
1067 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001068
1069 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1070 // skipped.
1071 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001072
1073 // IgnoreSignatureVersionChecks, if true, causes all signature
1074 // algorithms to be enabled at all TLS versions.
1075 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001076
1077 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1078 // Renegotiation Info to be negotiated at all versions.
1079 NegotiateRenegotiationInfoAtAllVersions bool
1080
Steven Valdez143e8b32016-07-11 13:19:03 -04001081 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1082 // all versions.
1083 NegotiateNPNAtAllVersions bool
1084
1085 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1086 // all versions.
1087 NegotiateEMSAtAllVersions bool
1088
1089 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1090 // advertised in server extensions
1091 AdvertiseTicketExtension bool
1092
Steven Valdez803c77a2016-09-06 14:13:43 -04001093 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1094 // resumption.
1095 NegotiatePSKResumption bool
1096
David Benjamin7f78df42016-10-05 22:33:19 -04001097 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1098 // always acknowledge a session, regardless of one was offered.
1099 AlwaysSelectPSKIdentity bool
1100
1101 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1102 // the specified PSK identity index rather than the actual value.
1103 SelectPSKIdentityOnResume uint16
1104
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001105 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1106 // identity.
1107 ExtraPSKIdentity bool
1108
Steven Valdez143e8b32016-07-11 13:19:03 -04001109 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1110 // sending a key_share extension and use the zero ECDHE secret
1111 // instead.
1112 MissingKeyShare bool
1113
Steven Valdez5440fe02016-07-18 12:40:30 -04001114 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1115 // ClientHello to skip sending a key_share extension and use the zero
1116 // ECDHE secret instead.
1117 SecondClientHelloMissingKeyShare bool
1118
1119 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1120 // client to pretend the server requested a HelloRetryRequest with the
1121 // given curve rather than the actual one.
1122 MisinterpretHelloRetryRequestCurve CurveID
1123
Steven Valdez143e8b32016-07-11 13:19:03 -04001124 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1125 // copies of each KeyShareEntry.
1126 DuplicateKeyShares bool
1127
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001128 // SendEarlyAlert, if true, sends a fatal alert after the ClientHello.
1129 SendEarlyAlert bool
1130
Nick Harperf2511f12016-12-06 16:02:31 -08001131 // SendFakeEarlyDataLength, if non-zero, is the amount of early data to
1132 // send after the ClientHello.
1133 SendFakeEarlyDataLength int
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001134
1135 // OmitEarlyDataExtension, if true, causes the early data extension to
1136 // be omitted in the ClientHello.
1137 OmitEarlyDataExtension bool
1138
1139 // SendEarlyDataOnSecondClientHello, if true, causes the TLS 1.3 client to
1140 // send early data after the second ClientHello.
1141 SendEarlyDataOnSecondClientHello bool
1142
1143 // InterleaveEarlyData, if true, causes the TLS 1.3 client to send early
1144 // data interleaved with the second ClientHello and the client Finished.
1145 InterleaveEarlyData bool
1146
Nick Harperf2511f12016-12-06 16:02:31 -08001147 // SendEarlyData causes a TLS 1.3 client to send the provided data
1148 // in application data records immediately after the ClientHello,
1149 // provided that the client has a PSK that is appropriate for sending
1150 // early data and includes that PSK in its ClientHello.
1151 SendEarlyData [][]byte
1152
Nick Harperab20cec2016-12-19 17:38:41 -08001153 // ExpectEarlyData causes a TLS 1.3 server to read application
1154 // data after the ClientHello (assuming the server is able to
1155 // derive the key under which the data is encrypted) before it
1156 // sends a ServerHello. It checks that the application data it
1157 // reads matches what is provided in ExpectEarlyData and errors if
1158 // the number of records or their content do not match.
1159 ExpectEarlyData [][]byte
1160
Nick Harper7cd0a972016-12-02 11:08:40 -08001161 // SendHalfRTTData causes a TLS 1.3 server to send the provided
1162 // data in application data records before reading the client's
1163 // Finished message.
1164 SendHalfRTTData [][]byte
1165
1166 // ExpectHalfRTTData causes a TLS 1.3 client to read application
1167 // data after reading the server's Finished message and before
1168 // sending any other handshake messages. It checks that the
1169 // application data it reads matches what is provided in
1170 // ExpectHalfRTTData and errors if the number of records or their
1171 // content do not match.
1172 ExpectHalfRTTData [][]byte
1173
Steven Valdez143e8b32016-07-11 13:19:03 -04001174 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1175 // emit an empty EncryptedExtensions block.
1176 EmptyEncryptedExtensions bool
1177
1178 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1179 // include the KeyShare extension in the EncryptedExtensions block.
1180 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001181
David Benjamin3baa6e12016-10-07 21:10:38 -04001182 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1183 // be sent by the server, even if empty.
1184 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001185
1186 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1187 // two HelloRetryRequests instead of one.
1188 SecondHelloRetryRequest bool
1189
David Benjamin3baa6e12016-10-07 21:10:38 -04001190 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1191 // the specified curve in a HelloRetryRequest.
1192 SendHelloRetryRequestCurve CurveID
1193
1194 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1195 // sent by the server in HelloRetryRequest.
1196 SendHelloRetryRequestCookie []byte
1197
1198 // DuplicateHelloRetryRequestExtensions, if true, causes all
1199 // HelloRetryRequest extensions to be sent twice.
1200 DuplicateHelloRetryRequestExtensions bool
1201
Steven Valdez5440fe02016-07-18 12:40:30 -04001202 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001203 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001204 SendServerHelloVersion uint16
1205
1206 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1207 // HelloRetryRequest.
1208 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001209
1210 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1211 // HelloRequest in the same record as Finished.
1212 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001213
David Benjamine73c7f42016-08-17 00:29:33 -04001214 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1215 // connection if the selected curve appears in the client's initial
1216 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1217 ExpectMissingKeyShare bool
1218
David Benjamin02edcd02016-07-27 17:40:37 -04001219 // SendExtraFinished, if true, causes an extra Finished message to be
1220 // sent.
1221 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001222
1223 // SendRequestContext, if not empty, is the request context to send in
1224 // a TLS 1.3 CertificateRequest.
1225 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001226
1227 // SendSNIWarningAlert, if true, causes the server to send an
1228 // unrecognized_name alert before the ServerHello.
1229 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001230
1231 // SendCompressionMethods, if not nil, is the compression method list to
1232 // send in the ClientHello.
1233 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001234
1235 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1236 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1237 // hint is empty.
1238 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001239
1240 // TrailingKeyShareData, if true, causes the client key share list to
1241 // include a trailing byte.
1242 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001243
1244 // InvalidChannelIDSignature, if true, causes the client to generate an
1245 // invalid Channel ID signature.
1246 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001247
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001248 // ExpectGREASE, if true, causes messages without GREASE values to be
1249 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001250 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001251
1252 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1253 // that is one byte shorter than it should be.
1254 SendShortPSKBinder bool
1255
1256 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1257 // PSK binder.
1258 SendInvalidPSKBinder bool
1259
1260 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1261 SendNoPSKBinder bool
1262
David Benjaminaedf3032016-12-01 16:47:56 -05001263 // SendExtraPSKBinder, if true, causes the client to send an extra PSK
1264 // binder.
1265 SendExtraPSKBinder bool
1266
Steven Valdeza833c352016-11-01 13:39:36 -04001267 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1268 // extension as the first extension instead of the last extension.
1269 PSKBinderFirst bool
David Benjamin53210cb2016-11-16 09:01:48 +09001270
1271 // NoOCSPStapling, if true, causes the client to not request OCSP
1272 // stapling.
1273 NoOCSPStapling bool
1274
1275 // NoSignedCertificateTimestamps, if true, causes the client to not
1276 // request signed certificate timestamps.
1277 NoSignedCertificateTimestamps bool
David Benjamin6f600d62016-12-21 16:06:54 -05001278
David Benjamina81967b2016-12-22 09:16:57 -05001279 // SendSupportedPointFormats, if not nil, is the list of supported point
1280 // formats to send in ClientHello or ServerHello. If set to a non-nil
1281 // empty slice, no extension will be sent.
1282 SendSupportedPointFormats []byte
David Benjamine3fbb362017-01-06 16:19:28 -05001283
1284 // MaxReceivePlaintext, if non-zero, is the maximum plaintext record
1285 // length accepted from the peer.
1286 MaxReceivePlaintext int
David Benjamin17b30832017-01-28 14:00:32 -05001287
1288 // SendTicketLifetime, if non-zero, is the ticket lifetime to send in
1289 // NewSessionTicket messages.
1290 SendTicketLifetime time.Duration
David Benjamin023d4192017-02-06 13:49:07 -05001291
1292 // SendServerNameAck, if true, causes the server to acknowledge the SNI
1293 // extension.
1294 SendServerNameAck bool
Adam Langley2ff79332017-02-28 13:45:39 -08001295
1296 // ExpectCertificateReqNames, if not nil, contains the list of X.509
1297 // names that must be sent in a CertificateRequest from the server.
1298 ExpectCertificateReqNames [][]byte
David Benjamina58baaf2017-02-28 20:54:28 -05001299
1300 // RenegotiationCertificate, if not nil, is the certificate to use on
1301 // renegotiation handshakes.
1302 RenegotiationCertificate *Certificate
Adam Langley95c29f32014-06-20 12:00:00 -07001303}
1304
1305func (c *Config) serverInit() {
1306 if c.SessionTicketsDisabled {
1307 return
1308 }
1309
1310 // If the key has already been set then we have nothing to do.
1311 for _, b := range c.SessionTicketKey {
1312 if b != 0 {
1313 return
1314 }
1315 }
1316
1317 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1318 c.SessionTicketsDisabled = true
1319 }
1320}
1321
1322func (c *Config) rand() io.Reader {
1323 r := c.Rand
1324 if r == nil {
1325 return rand.Reader
1326 }
1327 return r
1328}
1329
1330func (c *Config) time() time.Time {
1331 t := c.Time
1332 if t == nil {
1333 t = time.Now
1334 }
1335 return t()
1336}
1337
1338func (c *Config) cipherSuites() []uint16 {
1339 s := c.CipherSuites
1340 if s == nil {
1341 s = defaultCipherSuites()
1342 }
1343 return s
1344}
1345
David Benjamincecee272016-06-30 13:33:47 -04001346func (c *Config) minVersion(isDTLS bool) uint16 {
1347 ret := uint16(minVersion)
1348 if c != nil && c.MinVersion != 0 {
1349 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001350 }
David Benjamincecee272016-06-30 13:33:47 -04001351 if isDTLS {
1352 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1353 if ret < VersionTLS10 {
1354 return VersionTLS10
1355 }
1356 // There is no such thing as DTLS 1.1.
1357 if ret == VersionTLS11 {
1358 return VersionTLS12
1359 }
1360 }
1361 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001362}
1363
David Benjamincecee272016-06-30 13:33:47 -04001364func (c *Config) maxVersion(isDTLS bool) uint16 {
1365 ret := uint16(maxVersion)
1366 if c != nil && c.MaxVersion != 0 {
1367 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001368 }
David Benjamincecee272016-06-30 13:33:47 -04001369 if isDTLS {
1370 // We only implement up to DTLS 1.2.
1371 if ret > VersionTLS12 {
1372 return VersionTLS12
1373 }
1374 // There is no such thing as DTLS 1.1.
1375 if ret == VersionTLS11 {
1376 return VersionTLS10
1377 }
1378 }
1379 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001380}
1381
David Benjamincba2b622015-12-18 22:13:41 -05001382var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001383
1384func (c *Config) curvePreferences() []CurveID {
1385 if c == nil || len(c.CurvePreferences) == 0 {
1386 return defaultCurvePreferences
1387 }
1388 return c.CurvePreferences
1389}
1390
Nick Harperdcfbc672016-07-16 17:47:31 +02001391func (c *Config) defaultCurves() map[CurveID]bool {
1392 defaultCurves := make(map[CurveID]bool)
1393 curves := c.DefaultCurves
1394 if c == nil || c.DefaultCurves == nil {
1395 curves = c.curvePreferences()
1396 }
1397 for _, curveID := range curves {
1398 defaultCurves[curveID] = true
1399 }
1400 return defaultCurves
1401}
1402
Steven Valdezfdd10992016-09-15 16:27:05 -04001403// isSupportedVersion returns true if the specified protocol version is
1404// acceptable.
1405func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1406 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001407}
1408
1409// getCertificateForName returns the best certificate for the given name,
1410// defaulting to the first element of c.Certificates if there are no good
1411// options.
1412func (c *Config) getCertificateForName(name string) *Certificate {
1413 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1414 // There's only one choice, so no point doing any work.
1415 return &c.Certificates[0]
1416 }
1417
1418 name = strings.ToLower(name)
1419 for len(name) > 0 && name[len(name)-1] == '.' {
1420 name = name[:len(name)-1]
1421 }
1422
1423 if cert, ok := c.NameToCertificate[name]; ok {
1424 return cert
1425 }
1426
1427 // try replacing labels in the name with wildcards until we get a
1428 // match.
1429 labels := strings.Split(name, ".")
1430 for i := range labels {
1431 labels[i] = "*"
1432 candidate := strings.Join(labels, ".")
1433 if cert, ok := c.NameToCertificate[candidate]; ok {
1434 return cert
1435 }
1436 }
1437
1438 // If nothing matches, return the first certificate.
1439 return &c.Certificates[0]
1440}
1441
David Benjamin7a41d372016-07-09 11:21:54 -07001442func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1443 if c != nil && c.SignSignatureAlgorithms != nil {
1444 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001445 }
David Benjamin7a41d372016-07-09 11:21:54 -07001446 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001447}
1448
David Benjamin7a41d372016-07-09 11:21:54 -07001449func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1450 if c != nil && c.VerifySignatureAlgorithms != nil {
1451 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001452 }
David Benjamin7a41d372016-07-09 11:21:54 -07001453 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001454}
1455
Adam Langley95c29f32014-06-20 12:00:00 -07001456// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1457// from the CommonName and SubjectAlternateName fields of each of the leaf
1458// certificates.
1459func (c *Config) BuildNameToCertificate() {
1460 c.NameToCertificate = make(map[string]*Certificate)
1461 for i := range c.Certificates {
1462 cert := &c.Certificates[i]
1463 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1464 if err != nil {
1465 continue
1466 }
1467 if len(x509Cert.Subject.CommonName) > 0 {
1468 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1469 }
1470 for _, san := range x509Cert.DNSNames {
1471 c.NameToCertificate[san] = cert
1472 }
1473 }
1474}
1475
1476// A Certificate is a chain of one or more certificates, leaf first.
1477type Certificate struct {
1478 Certificate [][]byte
1479 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1480 // OCSPStaple contains an optional OCSP response which will be served
1481 // to clients that request it.
1482 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001483 // SignedCertificateTimestampList contains an optional encoded
1484 // SignedCertificateTimestampList structure which will be
1485 // served to clients that request it.
1486 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001487 // Leaf is the parsed form of the leaf certificate, which may be
1488 // initialized using x509.ParseCertificate to reduce per-handshake
1489 // processing for TLS clients doing client authentication. If nil, the
1490 // leaf certificate will be parsed as needed.
1491 Leaf *x509.Certificate
1492}
1493
1494// A TLS record.
1495type record struct {
1496 contentType recordType
1497 major, minor uint8
1498 payload []byte
1499}
1500
1501type handshakeMessage interface {
1502 marshal() []byte
1503 unmarshal([]byte) bool
1504}
1505
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001506// lruSessionCache is a client or server session cache implementation
1507// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001508type lruSessionCache struct {
1509 sync.Mutex
1510
1511 m map[string]*list.Element
1512 q *list.List
1513 capacity int
1514}
1515
1516type lruSessionCacheEntry struct {
1517 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001518 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001519}
1520
1521// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001522func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001523 c.Lock()
1524 defer c.Unlock()
1525
1526 if elem, ok := c.m[sessionKey]; ok {
1527 entry := elem.Value.(*lruSessionCacheEntry)
1528 entry.state = cs
1529 c.q.MoveToFront(elem)
1530 return
1531 }
1532
1533 if c.q.Len() < c.capacity {
1534 entry := &lruSessionCacheEntry{sessionKey, cs}
1535 c.m[sessionKey] = c.q.PushFront(entry)
1536 return
1537 }
1538
1539 elem := c.q.Back()
1540 entry := elem.Value.(*lruSessionCacheEntry)
1541 delete(c.m, entry.sessionKey)
1542 entry.sessionKey = sessionKey
1543 entry.state = cs
1544 c.q.MoveToFront(elem)
1545 c.m[sessionKey] = elem
1546}
1547
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001548// Get returns the value associated with a given key. It returns (nil,
1549// false) if no value is found.
1550func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001551 c.Lock()
1552 defer c.Unlock()
1553
1554 if elem, ok := c.m[sessionKey]; ok {
1555 c.q.MoveToFront(elem)
1556 return elem.Value.(*lruSessionCacheEntry).state, true
1557 }
1558 return nil, false
1559}
1560
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001561// lruClientSessionCache is a ClientSessionCache implementation that
1562// uses an LRU caching strategy.
1563type lruClientSessionCache struct {
1564 lruSessionCache
1565}
1566
1567func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1568 c.lruSessionCache.Put(sessionKey, cs)
1569}
1570
1571func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1572 cs, ok := c.lruSessionCache.Get(sessionKey)
1573 if !ok {
1574 return nil, false
1575 }
1576 return cs.(*ClientSessionState), true
1577}
1578
1579// lruServerSessionCache is a ServerSessionCache implementation that
1580// uses an LRU caching strategy.
1581type lruServerSessionCache struct {
1582 lruSessionCache
1583}
1584
1585func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1586 c.lruSessionCache.Put(sessionId, session)
1587}
1588
1589func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1590 cs, ok := c.lruSessionCache.Get(sessionId)
1591 if !ok {
1592 return nil, false
1593 }
1594 return cs.(*sessionState), true
1595}
1596
1597// NewLRUClientSessionCache returns a ClientSessionCache with the given
1598// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1599// is used instead.
1600func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1601 const defaultSessionCacheCapacity = 64
1602
1603 if capacity < 1 {
1604 capacity = defaultSessionCacheCapacity
1605 }
1606 return &lruClientSessionCache{
1607 lruSessionCache{
1608 m: make(map[string]*list.Element),
1609 q: list.New(),
1610 capacity: capacity,
1611 },
1612 }
1613}
1614
1615// NewLRUServerSessionCache returns a ServerSessionCache with the given
1616// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1617// is used instead.
1618func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1619 const defaultSessionCacheCapacity = 64
1620
1621 if capacity < 1 {
1622 capacity = defaultSessionCacheCapacity
1623 }
1624 return &lruServerSessionCache{
1625 lruSessionCache{
1626 m: make(map[string]*list.Element),
1627 q: list.New(),
1628 capacity: capacity,
1629 },
1630 }
1631}
1632
Adam Langley95c29f32014-06-20 12:00:00 -07001633// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1634type dsaSignature struct {
1635 R, S *big.Int
1636}
1637
1638type ecdsaSignature dsaSignature
1639
1640var emptyConfig Config
1641
1642func defaultConfig() *Config {
1643 return &emptyConfig
1644}
1645
1646var (
1647 once sync.Once
1648 varDefaultCipherSuites []uint16
1649)
1650
1651func defaultCipherSuites() []uint16 {
1652 once.Do(initDefaultCipherSuites)
1653 return varDefaultCipherSuites
1654}
1655
1656func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001657 for _, suite := range cipherSuites {
1658 if suite.flags&suitePSK == 0 {
1659 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1660 }
Adam Langley95c29f32014-06-20 12:00:00 -07001661 }
1662}
1663
1664func unexpectedMessageError(wanted, got interface{}) error {
1665 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1666}
David Benjamin000800a2014-11-14 01:43:59 -05001667
Nick Harper60edffd2016-06-21 15:19:24 -07001668func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1669 for _, s := range sigAlgs {
1670 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001671 return true
1672 }
1673 }
1674 return false
1675}
Nick Harper85f20c22016-07-04 10:11:59 -07001676
1677var (
David Benjamina128a552016-10-13 14:26:33 -04001678 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001679 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1680 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1681)