blob: e9c13343428dce78bb41c788c949299c05fa7533 [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,
David Benjamind768c5d2017-03-28 18:28:44 -0500187 signatureEd25519,
Adam Langley95c29f32014-06-20 12:00:00 -0700188}
189
David Benjaminca6c8262014-11-15 19:06:08 -0500190// SRTP protection profiles (See RFC 5764, section 4.1.2)
191const (
192 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
193 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
194)
195
David Benjamina128a552016-10-13 14:26:33 -0400196// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200197const (
Steven Valdez5b986082016-09-01 12:29:49 -0400198 pskKEMode = 0
199 pskDHEKEMode = 1
200)
201
Steven Valdezc4aa7272016-10-03 12:25:56 -0400202// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
203const (
204 keyUpdateNotRequested = 0
205 keyUpdateRequested = 1
206)
207
Adam Langley95c29f32014-06-20 12:00:00 -0700208// ConnectionState records basic TLS details about the connection.
209type ConnectionState struct {
210 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
211 HandshakeComplete bool // TLS handshake is complete
212 DidResume bool // connection resumes a previous TLS connection
213 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
214 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
215 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400216 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700217 ServerName string // server name requested by client, if any (server side only)
218 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
219 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400220 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500221 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400222 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100223 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700224 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400225 CurveID CurveID // the curve used in ECDHE
Adam Langley95c29f32014-06-20 12:00:00 -0700226}
227
228// ClientAuthType declares the policy the server will follow for
229// TLS Client Authentication.
230type ClientAuthType int
231
232const (
233 NoClientCert ClientAuthType = iota
234 RequestClientCert
235 RequireAnyClientCert
236 VerifyClientCertIfGiven
237 RequireAndVerifyClientCert
238)
239
240// ClientSessionState contains the state needed by clients to resume TLS
241// sessions.
242type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500243 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700244 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
245 vers uint16 // SSL/TLS version negotiated for the session
246 cipherSuite uint16 // Ciphersuite negotiated for the session
247 masterSecret []byte // MasterSecret generated by client on a full handshake
248 handshakeHash []byte // Handshake hash for Channel ID purposes.
249 serverCertificates []*x509.Certificate // Certificate chain presented by the server
250 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100251 sctList []byte
252 ocspResponse []byte
Steven Valdez2d850622017-01-11 11:34:52 -0500253 earlyALPN string
Nick Harper0b3625b2016-07-25 16:16:28 -0700254 ticketCreationTime time.Time
255 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400256 ticketAgeAdd uint32
Nick Harperf2511f12016-12-06 16:02:31 -0800257 maxEarlyDataSize uint32
Adam Langley95c29f32014-06-20 12:00:00 -0700258}
259
260// ClientSessionCache is a cache of ClientSessionState objects that can be used
261// by a client to resume a TLS session with a given server. ClientSessionCache
262// implementations should expect to be called concurrently from different
263// goroutines.
264type ClientSessionCache interface {
265 // Get searches for a ClientSessionState associated with the given key.
266 // On return, ok is true if one was found.
267 Get(sessionKey string) (session *ClientSessionState, ok bool)
268
269 // Put adds the ClientSessionState to the cache with the given key.
270 Put(sessionKey string, cs *ClientSessionState)
271}
272
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500273// ServerSessionCache is a cache of sessionState objects that can be used by a
274// client to resume a TLS session with a given server. ServerSessionCache
275// implementations should expect to be called concurrently from different
276// goroutines.
277type ServerSessionCache interface {
278 // Get searches for a sessionState associated with the given session
279 // ID. On return, ok is true if one was found.
280 Get(sessionId string) (session *sessionState, ok bool)
281
282 // Put adds the sessionState to the cache with the given session ID.
283 Put(sessionId string, session *sessionState)
284}
285
Adam Langley95c29f32014-06-20 12:00:00 -0700286// A Config structure is used to configure a TLS client or server.
287// After one has been passed to a TLS function it must not be
288// modified. A Config may be reused; the tls package will also not
289// modify it.
290type Config struct {
291 // Rand provides the source of entropy for nonces and RSA blinding.
292 // If Rand is nil, TLS uses the cryptographic random reader in package
293 // crypto/rand.
294 // The Reader must be safe for use by multiple goroutines.
295 Rand io.Reader
296
297 // Time returns the current time as the number of seconds since the epoch.
298 // If Time is nil, TLS uses time.Now.
299 Time func() time.Time
300
301 // Certificates contains one or more certificate chains
302 // to present to the other side of the connection.
303 // Server configurations must include at least one certificate.
304 Certificates []Certificate
305
306 // NameToCertificate maps from a certificate name to an element of
307 // Certificates. Note that a certificate name can be of the form
308 // '*.example.com' and so doesn't have to be a domain name as such.
309 // See Config.BuildNameToCertificate
310 // The nil value causes the first element of Certificates to be used
311 // for all connections.
312 NameToCertificate map[string]*Certificate
313
314 // RootCAs defines the set of root certificate authorities
315 // that clients use when verifying server certificates.
316 // If RootCAs is nil, TLS uses the host's root CA set.
317 RootCAs *x509.CertPool
318
319 // NextProtos is a list of supported, application level protocols.
320 NextProtos []string
321
322 // ServerName is used to verify the hostname on the returned
323 // certificates unless InsecureSkipVerify is given. It is also included
324 // in the client's handshake to support virtual hosting.
325 ServerName string
326
327 // ClientAuth determines the server's policy for
328 // TLS Client Authentication. The default is NoClientCert.
329 ClientAuth ClientAuthType
330
331 // ClientCAs defines the set of root certificate authorities
332 // that servers use if required to verify a client certificate
333 // by the policy in ClientAuth.
334 ClientCAs *x509.CertPool
335
David Benjamin7b030512014-07-08 17:30:11 -0400336 // ClientCertificateTypes defines the set of allowed client certificate
337 // types. The default is CertTypeRSASign and CertTypeECDSASign.
338 ClientCertificateTypes []byte
339
Adam Langley95c29f32014-06-20 12:00:00 -0700340 // InsecureSkipVerify controls whether a client verifies the
341 // server's certificate chain and host name.
342 // If InsecureSkipVerify is true, TLS accepts any certificate
343 // presented by the server and any host name in that certificate.
344 // In this mode, TLS is susceptible to man-in-the-middle attacks.
345 // This should be used only for testing.
346 InsecureSkipVerify bool
347
348 // CipherSuites is a list of supported cipher suites. If CipherSuites
349 // is nil, TLS uses a list of suites supported by the implementation.
350 CipherSuites []uint16
351
352 // PreferServerCipherSuites controls whether the server selects the
353 // client's most preferred ciphersuite, or the server's most preferred
354 // ciphersuite. If true then the server's preference, as expressed in
355 // the order of elements in CipherSuites, is used.
356 PreferServerCipherSuites bool
357
358 // SessionTicketsDisabled may be set to true to disable session ticket
359 // (resumption) support.
360 SessionTicketsDisabled bool
361
362 // SessionTicketKey is used by TLS servers to provide session
363 // resumption. See RFC 5077. If zero, it will be filled with
364 // random data before the first server handshake.
365 //
366 // If multiple servers are terminating connections for the same host
367 // they should all have the same SessionTicketKey. If the
368 // SessionTicketKey leaks, previously recorded and future TLS
369 // connections using that key are compromised.
370 SessionTicketKey [32]byte
371
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500372 // ClientSessionCache is a cache of ClientSessionState entries
373 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700374 ClientSessionCache ClientSessionCache
375
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500376 // ServerSessionCache is a cache of sessionState entries for TLS session
377 // resumption.
378 ServerSessionCache ServerSessionCache
379
Adam Langley95c29f32014-06-20 12:00:00 -0700380 // MinVersion contains the minimum SSL/TLS version that is acceptable.
381 // If zero, then SSLv3 is taken as the minimum.
382 MinVersion uint16
383
384 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
385 // If zero, then the maximum version supported by this package is used,
386 // which is currently TLS 1.2.
387 MaxVersion uint16
388
389 // CurvePreferences contains the elliptic curves that will be used in
390 // an ECDHE handshake, in preference order. If empty, the default will
391 // be used.
392 CurvePreferences []CurveID
393
Nick Harperdcfbc672016-07-16 17:47:31 +0200394 // DefaultCurves contains the elliptic curves for which public values will
395 // be sent in the ClientHello's KeyShare extension. If this value is nil,
396 // all supported curves will have public values sent. This field is ignored
397 // on servers.
398 DefaultCurves []CurveID
399
David Benjamind30a9902014-08-24 01:44:23 -0400400 // ChannelID contains the ECDSA key for the client to use as
401 // its TLS Channel ID.
402 ChannelID *ecdsa.PrivateKey
403
404 // RequestChannelID controls whether the server requests a TLS
405 // Channel ID. If negotiated, the client's public key is
406 // returned in the ConnectionState.
407 RequestChannelID bool
408
David Benjamin48cae082014-10-27 01:06:24 -0400409 // PreSharedKey, if not nil, is the pre-shared key to use with
410 // the PSK cipher suites.
411 PreSharedKey []byte
412
413 // PreSharedKeyIdentity, if not empty, is the identity to use
414 // with the PSK cipher suites.
415 PreSharedKeyIdentity string
416
Nick Harperab20cec2016-12-19 17:38:41 -0800417 // MaxEarlyDataSize controls the maximum number of bytes that the
418 // server will accept in early data and advertise in a
419 // NewSessionTicketMsg. If 0, no early data will be accepted and
420 // the TicketEarlyDataInfo extension in the NewSessionTicketMsg
421 // will be omitted.
422 MaxEarlyDataSize uint32
423
David Benjaminca6c8262014-11-15 19:06:08 -0500424 // SRTPProtectionProfiles, if not nil, is the list of SRTP
425 // protection profiles to offer in DTLS-SRTP.
426 SRTPProtectionProfiles []uint16
427
David Benjamin7a41d372016-07-09 11:21:54 -0700428 // SignSignatureAlgorithms, if not nil, overrides the default set of
429 // supported signature algorithms to sign with.
430 SignSignatureAlgorithms []signatureAlgorithm
431
432 // VerifySignatureAlgorithms, if not nil, overrides the default set of
433 // supported signature algorithms that are accepted.
434 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500435
Adam Langley95c29f32014-06-20 12:00:00 -0700436 // Bugs specifies optional misbehaviour to be used for testing other
437 // implementations.
438 Bugs ProtocolBugs
439
440 serverInitOnce sync.Once // guards calling (*Config).serverInit
441}
442
443type BadValue int
444
445const (
446 BadValueNone BadValue = iota
447 BadValueNegative
448 BadValueZero
449 BadValueLimit
450 BadValueLarge
451 NumBadValues
452)
453
David Benjaminb36a3952015-12-01 18:53:13 -0500454type RSABadValue int
455
456const (
457 RSABadValueNone RSABadValue = iota
458 RSABadValueCorrupt
459 RSABadValueTooLong
460 RSABadValueTooShort
461 RSABadValueWrongVersion
462 NumRSABadValues
463)
464
Adam Langley95c29f32014-06-20 12:00:00 -0700465type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400466 // InvalidSignature specifies that the signature in a ServerKeyExchange
467 // or CertificateVerify message should be invalid.
468 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400469
Steven Valdez5440fe02016-07-18 12:40:30 -0400470 // SendCurve, if non-zero, causes the server to send the specified curve
471 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
472 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400473 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700474
David Benjamin2b07fa42016-03-02 00:23:57 -0500475 // InvalidECDHPoint, if true, causes the ECC points in
476 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
477 InvalidECDHPoint bool
478
Adam Langley95c29f32014-06-20 12:00:00 -0700479 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
480 // can be invalid.
481 BadECDSAR BadValue
482 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700483
484 // MaxPadding causes CBC records to have the maximum possible padding.
485 MaxPadding bool
486 // PaddingFirstByteBad causes the first byte of the padding to be
487 // incorrect.
488 PaddingFirstByteBad bool
489 // PaddingFirstByteBadIf255 causes the first byte of padding to be
490 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
491 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700492
493 // FailIfNotFallbackSCSV causes a server handshake to fail if the
494 // client doesn't send the fallback SCSV value.
495 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400496
497 // DuplicateExtension causes an extra empty extension of bogus type to
498 // be emitted in either the ClientHello or the ServerHello.
499 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400500
501 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
502 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
503 // Certificate message is sent and no signature is added to
504 // ServerKeyExchange.
505 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400506
David Benjaminb80168e2015-02-08 18:30:14 -0500507 // SkipHelloVerifyRequest causes a DTLS server to skip the
508 // HelloVerifyRequest message.
509 SkipHelloVerifyRequest bool
510
David Benjamindcd979f2015-04-20 18:26:52 -0400511 // SkipCertificateStatus, if true, causes the server to skip the
512 // CertificateStatus message. This is legal because CertificateStatus is
513 // optional, even with a status_request in ServerHello.
514 SkipCertificateStatus bool
515
David Benjamin9c651c92014-07-12 13:27:45 -0400516 // SkipServerKeyExchange causes the server to skip sending
517 // ServerKeyExchange messages.
518 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400519
David Benjaminb80168e2015-02-08 18:30:14 -0500520 // SkipNewSessionTicket causes the server to skip sending the
521 // NewSessionTicket message despite promising to in ServerHello.
522 SkipNewSessionTicket bool
523
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500524 // SkipClientCertificate causes the client to skip the Certificate
525 // message.
526 SkipClientCertificate bool
527
David Benjamina0e52232014-07-19 17:39:58 -0400528 // SkipChangeCipherSpec causes the implementation to skip
529 // sending the ChangeCipherSpec message (and adjusting cipher
530 // state accordingly for the Finished message).
531 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400532
David Benjaminb80168e2015-02-08 18:30:14 -0500533 // SkipFinished causes the implementation to skip sending the Finished
534 // message.
535 SkipFinished bool
536
David Benjamin32c89272017-03-26 13:54:21 -0500537 // SkipEndOfEarlyData causes the implementation to skip the
538 // end_of_early_data alert.
539 SkipEndOfEarlyData bool
540
David Benjaminf3ec83d2014-07-21 22:42:34 -0400541 // EarlyChangeCipherSpec causes the client to send an early
542 // ChangeCipherSpec message before the ClientKeyExchange. A value of
543 // zero disables this behavior. One and two configure variants for 0.9.8
544 // and 1.0.1 modes, respectively.
545 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400546
David Benjamin8144f992016-06-22 17:05:13 -0400547 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
548 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
549 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
550 StrayChangeCipherSpec bool
551
David Benjamin86271ee2014-07-21 16:14:03 -0400552 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
553 // the Finished (or NextProto) message around the ChangeCipherSpec
554 // messages.
555 FragmentAcrossChangeCipherSpec bool
556
David Benjamin61672812016-07-14 23:10:43 -0400557 // SendUnencryptedFinished, if true, causes the Finished message to be
558 // send unencrypted before ChangeCipherSpec rather than after it.
559 SendUnencryptedFinished bool
560
David Benjamin7964b182016-07-14 23:36:30 -0400561 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
562 // 1.3 server to send part of EncryptedExtensions unencrypted
563 // in the same record as ServerHello.
564 PartialEncryptedExtensionsWithServerHello bool
565
566 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
567 // client to send part of Finished unencrypted in the same record as
568 // ClientHello.
569 PartialClientFinishedWithClientHello bool
570
David Benjamind86c7672014-08-02 04:07:12 -0400571 // SendV2ClientHello causes the client to send a V2ClientHello
572 // instead of a normal ClientHello.
573 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400574
575 // SendFallbackSCSV causes the client to include
576 // TLS_FALLBACK_SCSV in the ClientHello.
577 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400578
Adam Langley5021b222015-06-12 18:27:58 -0700579 // SendRenegotiationSCSV causes the client to include the renegotiation
580 // SCSV in the ClientHello.
581 SendRenegotiationSCSV bool
582
David Benjamin43ec06f2014-08-05 02:28:57 -0400583 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400584 // handshake record. Handshake messages will be split into multiple
585 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400586 // never be fragmented. For DTLS, it is the maximum handshake fragment
587 // size, not record size; DTLS allows multiple handshake fragments in a
588 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400589 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400590
David Benjamin98214542014-08-07 18:02:39 -0400591 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
592 // the first 6 bytes of the ClientHello.
593 FragmentClientVersion bool
594
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400595 // FragmentAlert will cause all alerts to be fragmented across
596 // two records.
597 FragmentAlert bool
598
David Benjamin0d3a8c62016-03-11 22:25:18 -0500599 // DoubleAlert will cause all alerts to be sent as two copies packed
600 // within one record.
601 DoubleAlert bool
602
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500603 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
604 // alert to be sent.
605 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400606
David Benjaminb36a3952015-12-01 18:53:13 -0500607 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
608 // ClientKeyExchange which would not pass padding checks.
609 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400610
611 // RenewTicketOnResume causes the server to renew the session ticket and
612 // send a NewSessionTicket message during an abbreviated handshake.
613 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400614
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400615 // SendClientVersion, if non-zero, causes the client to send the
616 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400617 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400618
Steven Valdezfdd10992016-09-15 16:27:05 -0400619 // OmitSupportedVersions, if true, causes the client to omit the
620 // supported versions extension.
621 OmitSupportedVersions bool
622
623 // SendSupportedVersions, if non-empty, causes the client to send a
624 // supported versions extension with the values from array.
625 SendSupportedVersions []uint16
626
David Benjamin1f61f0d2016-07-10 12:20:35 -0400627 // NegotiateVersion, if non-zero, causes the server to negotiate the
628 // specifed TLS version rather than the version supported by either
629 // peer.
630 NegotiateVersion uint16
631
David Benjamine7e36aa2016-08-08 12:39:41 -0400632 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
633 // the specified TLS version on renegotiation rather than retaining it.
634 NegotiateVersionOnRenego uint16
635
David Benjamine58c4f52014-08-24 03:47:07 -0400636 // ExpectFalseStart causes the server to, on full handshakes,
637 // expect the peer to False Start; the server Finished message
638 // isn't sent until we receive an application data record
639 // from the peer.
640 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400641
David Benjamin1c633152015-04-02 20:19:11 -0400642 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
643 // handshakes, send an alert just before reading the application data
644 // record to test False Start. This can be used in a negative False
645 // Start test to determine whether the peer processed the alert (and
646 // closed the connection) before or after sending app data.
647 AlertBeforeFalseStartTest alert
648
David Benjamine78bfde2014-09-06 12:45:15 -0400649 // ExpectServerName, if not empty, is the hostname the client
650 // must specify in the server_name extension.
651 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400652
David Benjamin76c2efc2015-08-31 14:24:29 -0400653 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
654 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400655 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400656
Adam Langleyefb0e162015-07-09 11:35:04 -0700657 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
658 // return.
659 ALPNProtocol *string
660
David Benjamin405da482016-08-08 17:25:07 -0400661 // AcceptAnySession causes the server to resume sessions regardless of
662 // the version associated with the session or cipher suite. It also
663 // causes the server to look in both TLS 1.2 and 1.3 extensions to
664 // process a ticket.
665 AcceptAnySession bool
666
667 // SendBothTickets, if true, causes the client to send tickets in both
668 // TLS 1.2 and 1.3 extensions.
669 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700670
David Benjamin4199b0d2016-11-01 13:58:25 -0400671 // FilterTicket, if not nil, causes the client to modify a session
672 // ticket before sending it in a resume handshake.
673 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700674
David Benjamind4c349b2017-02-09 14:07:17 -0500675 // TicketSessionIDLength, if non-zero, is the length of the session ID
676 // to send with a ticket resumption offer.
677 TicketSessionIDLength int
678
679 // EmptyTicketSessionID, if true, causes the client to send an empty
680 // session ID with a ticket resumption offer. For simplicity, this will
681 // also cause the client to interpret a ServerHello with empty session
682 // ID as a resumption. (A client which sends empty session ID is
683 // normally expected to look ahead for ChangeCipherSpec.)
684 EmptyTicketSessionID bool
Adam Langley75712922014-10-10 16:23:43 -0700685
David Benjamin405da482016-08-08 17:25:07 -0400686 // ExpectNoTLS12Session, if true, causes the server to fail the
687 // connection if either a session ID or TLS 1.2 ticket is offered.
688 ExpectNoTLS12Session bool
689
690 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
691 // if a TLS 1.3 PSK is offered.
692 ExpectNoTLS13PSK bool
693
Adam Langley75712922014-10-10 16:23:43 -0700694 // RequireExtendedMasterSecret, if true, requires that the peer support
695 // the extended master secret option.
696 RequireExtendedMasterSecret bool
697
David Benjaminca6554b2014-11-08 12:31:52 -0500698 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400699 // they didn't support an extended master secret in the initial
700 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700701 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700702
David Benjamin163c9562016-08-29 23:14:17 -0400703 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
704 // behave as if they didn't support an extended master secret in
705 // renegotiation handshakes.
706 NoExtendedMasterSecretOnRenegotiation bool
707
Adam Langley2ae77d22014-10-28 17:29:33 -0700708 // EmptyRenegotiationInfo causes the renegotiation extension to be
709 // empty in a renegotiation handshake.
710 EmptyRenegotiationInfo bool
711
712 // BadRenegotiationInfo causes the renegotiation extension value in a
713 // renegotiation handshake to be incorrect.
714 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500715
David Benjamin3e052de2015-11-25 20:10:31 -0500716 // NoRenegotiationInfo disables renegotiation info support in all
717 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500718 NoRenegotiationInfo bool
719
David Benjamin3e052de2015-11-25 20:10:31 -0500720 // NoRenegotiationInfoInInitial disables renegotiation info support in
721 // the initial handshake.
722 NoRenegotiationInfoInInitial bool
723
724 // NoRenegotiationInfoAfterInitial disables renegotiation info support
725 // in renegotiation handshakes.
726 NoRenegotiationInfoAfterInitial bool
727
Adam Langley5021b222015-06-12 18:27:58 -0700728 // RequireRenegotiationInfo, if true, causes the client to return an
729 // error if the server doesn't reply with the renegotiation extension.
730 RequireRenegotiationInfo bool
731
David Benjamin8e6db492015-07-25 18:29:23 -0400732 // SequenceNumberMapping, if non-nil, is the mapping function to apply
733 // to the sequence number of outgoing packets. For both TLS and DTLS,
734 // the two most-significant bytes in the resulting sequence number are
735 // ignored so that the DTLS epoch cannot be changed.
736 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500737
David Benjamina3e89492015-02-26 15:16:22 -0500738 // RSAEphemeralKey, if true, causes the server to send a
739 // ServerKeyExchange message containing an ephemeral key (as in
740 // RSA_EXPORT) in the plain RSA key exchange.
741 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500742
743 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
744 // client offers when negotiating SRTP. MKI support is still missing so
745 // the peer must still send none.
746 SRTPMasterKeyIdentifer string
747
748 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
749 // server sends in the ServerHello instead of the negotiated one.
750 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500751
Nick Harper60edffd2016-06-21 15:19:24 -0700752 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500753 // signature and hashes extension.
754 //
755 // For a server, it will cause an empty list to be sent in the
756 // CertificateRequest message. None the less, the configured set will
757 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700758 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500759
David Benjamin55a43642015-04-20 14:45:55 -0400760 // NoSupportedCurves, if true, causes the client to omit the
761 // supported_curves extension.
762 NoSupportedCurves bool
763
David Benjaminc44b1df2014-11-23 12:11:01 -0500764 // RequireSameRenegoClientVersion, if true, causes the server
765 // to require that all ClientHellos match in offered version
766 // across a renego.
767 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800768
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400769 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500770 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500771 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500772
David Benjamine6f22212016-11-08 14:28:24 -0500773 // SendRecordVersion, if non-zero, is the value to send as the
774 // record-layer version.
775 SendRecordVersion uint16
776
777 // SendInitialRecordVersion, if non-zero, is the value to send as the
778 // record-layer version before the protocol version is determined.
779 SendInitialRecordVersion uint16
780
David Benjamin13be1de2015-01-11 16:29:36 -0500781 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
782 // packet.
783 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500784
785 // SendCipherSuite, if non-zero, is the cipher suite value that the
786 // server will send in the ServerHello. This does not affect the cipher
787 // the server believes it has actually negotiated.
788 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500789
David Benjamin75f99142016-11-12 12:36:06 +0900790 // SendCipherSuites, if not nil, is the cipher suite list that the
791 // client will send in the ClientHello. This does not affect the cipher
792 // the client believes it has actually offered.
793 SendCipherSuites []uint16
794
David Benjamin4cf369b2015-08-22 01:35:43 -0400795 // AppDataBeforeHandshake, if not nil, causes application data to be
796 // sent immediately before the first handshake message.
797 AppDataBeforeHandshake []byte
798
799 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500800 // be sent immediately after ChangeCipherSpec.
801 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500802
David Benjamindc3da932015-03-12 15:09:02 -0400803 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
804 // immediately after ChangeCipherSpec.
805 AlertAfterChangeCipherSpec alert
806
David Benjamin83f90402015-01-27 01:09:43 -0500807 // TimeoutSchedule is the schedule of packet drops and simulated
808 // timeouts for before each handshake leg from the peer.
809 TimeoutSchedule []time.Duration
810
811 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
812 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500813
814 // ReorderHandshakeFragments, if true, causes handshake fragments in
815 // DTLS to overlap and be sent in the wrong order. It also causes
816 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
817 // Finished and will trigger a spurious retransmit.)
818 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500819
David Benjamin61672812016-07-14 23:10:43 -0400820 // ReverseHandshakeFragments, if true, causes handshake fragments in
821 // DTLS to be reversed within a flight.
822 ReverseHandshakeFragments bool
823
David Benjamin75381222015-03-02 19:30:30 -0500824 // MixCompleteMessageWithFragments, if true, causes handshake
825 // messages in DTLS to redundantly both fragment the message
826 // and include a copy of the full one.
827 MixCompleteMessageWithFragments bool
828
David Benjaminddb9f152015-02-03 15:44:39 -0500829 // SendInvalidRecordType, if true, causes a record with an invalid
830 // content type to be sent immediately following the handshake.
831 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500832
David Benjamin0b8d5da2016-07-15 00:39:56 -0400833 // SendWrongMessageType, if non-zero, causes messages of the specified
834 // type to be sent with the wrong value.
835 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500836
David Benjamin639846e2016-09-09 11:41:18 -0400837 // SendTrailingMessageData, if non-zero, causes messages of the
838 // specified type to be sent with trailing data.
839 SendTrailingMessageData byte
840
David Benjamin75381222015-03-02 19:30:30 -0500841 // FragmentMessageTypeMismatch, if true, causes all non-initial
842 // handshake fragments in DTLS to have the wrong message type.
843 FragmentMessageTypeMismatch bool
844
845 // FragmentMessageLengthMismatch, if true, causes all non-initial
846 // handshake fragments in DTLS to have the wrong message length.
847 FragmentMessageLengthMismatch bool
848
David Benjamin11fc66a2015-06-16 11:40:24 -0400849 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
850 // to be split across two records. The value of |SplitFragments| is the
851 // number of bytes in the first fragment.
852 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500853
854 // SendEmptyFragments, if true, causes handshakes to include empty
855 // fragments in DTLS.
856 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400857
David Benjamin9a41d1b2015-05-16 01:30:09 -0400858 // SendSplitAlert, if true, causes an alert to be sent with the header
859 // and record body split across multiple packets. The peer should
860 // discard these packets rather than process it.
861 SendSplitAlert bool
862
David Benjamin4b27d9f2015-05-12 22:42:52 -0400863 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
864 // client offers a resumption or the server accepts one.
865 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400866
David Benjamin67d1fb52015-03-16 15:16:23 -0400867 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
868 // preferences to be ignored.
869 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400870
871 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
872 // signature algorithm preferences to be ignored.
873 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400874
David Benjaminc574f412015-04-20 11:13:01 -0400875 // IgnorePeerCurvePreferences, if true, causes the peer's curve
876 // preferences to be ignored.
877 IgnorePeerCurvePreferences bool
878
David Benjamin513f0ea2015-04-02 19:33:31 -0400879 // BadFinished, if true, causes the Finished hash to be broken.
880 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700881
882 // DHGroupPrime, if not nil, is used to define the (finite field)
883 // Diffie-Hellman group. The generator used is always two.
884 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400885
David Benjamin582ba042016-07-07 12:33:25 -0700886 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
887 // to be packed into individual handshake records, up to the specified
888 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400889 PackHandshakeFragments int
890
David Benjamin582ba042016-07-07 12:33:25 -0700891 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
892 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400893 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400894
David Benjamin582ba042016-07-07 12:33:25 -0700895 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
896 // be packed into records, up to the largest size record available.
897 PackHandshakeFlight bool
898
David Benjamin5ecb88b2016-10-04 17:51:35 -0400899 // AdvertiseAllConfiguredCiphers, if true, causes the client to
900 // advertise all configured cipher suite values.
901 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400902
903 // EmptyCertificateList, if true, causes the server to send an empty
904 // certificate list in the Certificate message.
905 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400906
907 // ExpectNewTicket, if true, causes the client to abort if it does not
908 // receive a new ticket.
909 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700910
911 // RequireClientHelloSize, if not zero, is the required length in bytes
912 // of the ClientHello /record/. This is checked by the server.
913 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700914
915 // CustomExtension, if not empty, contains the contents of an extension
916 // that will be added to client/server hellos.
917 CustomExtension string
918
David Benjamin490469f2016-10-05 22:44:38 -0400919 // CustomUnencryptedExtension, if not empty, contains the contents of
920 // an extension that will be added to ServerHello in TLS 1.3.
921 CustomUnencryptedExtension string
922
Adam Langley09505632015-07-30 18:10:13 -0700923 // ExpectedCustomExtension, if not nil, contains the expected contents
924 // of a custom extension.
925 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400926
David Benjamin1286bee2016-10-07 15:25:06 -0400927 // CustomTicketExtension, if not empty, contains the contents of an
928 // extension what will be added to NewSessionTicket in TLS 1.3.
929 CustomTicketExtension string
930
David Benjamin3baa6e12016-10-07 21:10:38 -0400931 // CustomTicketExtension, if not empty, contains the contents of an
932 // extension what will be added to HelloRetryRequest in TLS 1.3.
933 CustomHelloRetryRequestExtension string
934
David Benjamin30789da2015-08-29 22:56:45 -0400935 // NoCloseNotify, if true, causes the close_notify alert to be skipped
936 // on connection shutdown.
937 NoCloseNotify bool
938
David Benjaminfa214e42016-05-10 17:03:10 -0400939 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
940 // close_notify on shutdown.
941 SendAlertOnShutdown alert
942
David Benjamin30789da2015-08-29 22:56:45 -0400943 // ExpectCloseNotify, if true, requires a close_notify from the peer on
944 // shutdown. Records from the peer received after close_notify is sent
945 // are not discard.
946 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400947
948 // SendLargeRecords, if true, allows outgoing records to be sent
949 // arbitrarily large.
950 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400951
952 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
953 // ALPN and NPN in the same connetion.
954 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400955
David Benjamin0c40a962016-08-01 12:05:50 -0400956 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400957 // string in the ALPN extension regardless of the content or presence of
958 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400959 SendALPN string
960
David Benjamin490469f2016-10-05 22:44:38 -0400961 // SendUnencryptedALPN, if non-empty, causes the server to send the
962 // specified string in a ServerHello ALPN extension in TLS 1.3.
963 SendUnencryptedALPN string
964
David Benjamindd6fed92015-10-23 17:41:12 -0400965 // SendEmptySessionTicket, if true, causes the server to send an empty
966 // session ticket.
967 SendEmptySessionTicket bool
968
Steven Valdeza833c352016-11-01 13:39:36 -0400969 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400970 // to send.
971 SendPSKKeyExchangeModes []byte
972
Steven Valdeza833c352016-11-01 13:39:36 -0400973 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
974 // receipt of a NewSessionTicket message.
975 ExpectNoNewSessionTicket bool
976
David Benjamin9c33ae82017-01-08 06:04:43 -0500977 // DuplicateTicketEarlyDataInfo causes an extra empty extension of
978 // ticket_early_data_info to be sent in NewSessionTicket.
979 DuplicateTicketEarlyDataInfo bool
980
Steven Valdez08b65f42016-12-07 15:29:45 -0500981 // ExpectTicketEarlyDataInfo, if true, means that the client will fail upon
982 // absence of the ticket_early_data_info extension.
983 ExpectTicketEarlyDataInfo bool
984
Steven Valdeza833c352016-11-01 13:39:36 -0400985 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
986 // server receives from the client.
987 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -0400988
David Benjamin35ac5b72017-03-03 15:05:56 -0500989 // SendTicketAge, if non-zero, is the ticket age to be sent by the
990 // client.
991 SendTicketAge time.Duration
992
David Benjamindd6fed92015-10-23 17:41:12 -0400993 // FailIfSessionOffered, if true, causes the server to fail any
994 // connections where the client offers a non-empty session ID or session
995 // ticket.
996 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800997
998 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
999 // HelloRequest handshake message to be sent before each application
1000 // data record. This only makes sense for a server.
1001 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -08001002
David Benjamin71dd6662016-07-08 14:10:48 -07001003 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
1004 // HelloRequest handshake message to be sent before each handshake
1005 // message. This only makes sense for a server.
1006 SendHelloRequestBeforeEveryHandshakeMessage bool
1007
Adam Langleyc4f25ce2015-11-26 16:39:08 -08001008 // RequireDHPublicValueLen causes a fatal error if the length (in
1009 // bytes) of the server's Diffie-Hellman public value is not equal to
1010 // this.
1011 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -05001012
1013 // BadChangeCipherSpec, if not nil, is the body to be sent in
1014 // ChangeCipherSpec records instead of {1}.
1015 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -05001016
1017 // BadHelloRequest, if not nil, is what to send instead of a
1018 // HelloRequest.
1019 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -05001020
1021 // RequireSessionTickets, if true, causes the client to require new
1022 // sessions use session tickets instead of session IDs.
1023 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -05001024
1025 // NullAllCiphers, if true, causes every cipher to behave like the null
1026 // cipher.
1027 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -04001028
1029 // SendSCTListOnResume, if not nil, causes the server to send the
1030 // supplied SCT list in resumption handshakes.
1031 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -07001032
David Benjamindaa88502016-10-04 16:32:16 -04001033 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
1034 // OCSP stapling in resumption handshakes and, if applicable, send the
1035 // supplied stapled response.
1036 SendOCSPResponseOnResume []byte
1037
Steven Valdeza833c352016-11-01 13:39:36 -04001038 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1039 // supplied bytes in the extensions on the Certificate message.
1040 SendExtensionOnCertificate []byte
1041
1042 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1043 // supplied OCSP on intermediate certificates in the Certificate message.
1044 SendOCSPOnIntermediates []byte
1045
1046 // SendSCTOnIntermediates, if not nil, causes the server to send the
1047 // supplied SCT on intermediate certificates in the Certificate message.
1048 SendSCTOnIntermediates []byte
1049
1050 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1051 // copy of the OCSP/SCT extensions in the Certificate message.
1052 SendDuplicateCertExtensions bool
1053
1054 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1055 // reject extensions on intermediate certificates.
1056 ExpectNoExtensionsOnIntermediate bool
1057
David Benjaminc9ae27c2016-06-24 22:56:37 -04001058 // RecordPadding is the number of bytes of padding to add to each
1059 // encrypted record in TLS 1.3.
1060 RecordPadding int
1061
1062 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1063 // be missing their body and content type. Padding, if configured, is
1064 // still added.
1065 OmitRecordContents bool
1066
1067 // OuterRecordType, if non-zero, is the outer record type to use instead
1068 // of application data.
1069 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001070
1071 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1072 // with the given signature algorithm rather than the one negotiated.
1073 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001074
1075 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1076 // skipped.
1077 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001078
1079 // IgnoreSignatureVersionChecks, if true, causes all signature
1080 // algorithms to be enabled at all TLS versions.
1081 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001082
1083 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1084 // Renegotiation Info to be negotiated at all versions.
1085 NegotiateRenegotiationInfoAtAllVersions bool
1086
Steven Valdez143e8b32016-07-11 13:19:03 -04001087 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1088 // all versions.
1089 NegotiateNPNAtAllVersions bool
1090
1091 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1092 // all versions.
1093 NegotiateEMSAtAllVersions bool
1094
1095 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1096 // advertised in server extensions
1097 AdvertiseTicketExtension bool
1098
Steven Valdez803c77a2016-09-06 14:13:43 -04001099 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1100 // resumption.
1101 NegotiatePSKResumption bool
1102
David Benjamin7f78df42016-10-05 22:33:19 -04001103 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1104 // always acknowledge a session, regardless of one was offered.
1105 AlwaysSelectPSKIdentity bool
1106
1107 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1108 // the specified PSK identity index rather than the actual value.
1109 SelectPSKIdentityOnResume uint16
1110
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001111 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1112 // identity.
1113 ExtraPSKIdentity bool
1114
Steven Valdez143e8b32016-07-11 13:19:03 -04001115 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1116 // sending a key_share extension and use the zero ECDHE secret
1117 // instead.
1118 MissingKeyShare bool
1119
Steven Valdez5440fe02016-07-18 12:40:30 -04001120 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1121 // ClientHello to skip sending a key_share extension and use the zero
1122 // ECDHE secret instead.
1123 SecondClientHelloMissingKeyShare bool
1124
1125 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1126 // client to pretend the server requested a HelloRetryRequest with the
1127 // given curve rather than the actual one.
1128 MisinterpretHelloRetryRequestCurve CurveID
1129
Steven Valdez143e8b32016-07-11 13:19:03 -04001130 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1131 // copies of each KeyShareEntry.
1132 DuplicateKeyShares bool
1133
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001134 // SendEarlyAlert, if true, sends a fatal alert after the ClientHello.
1135 SendEarlyAlert bool
1136
Nick Harperf2511f12016-12-06 16:02:31 -08001137 // SendFakeEarlyDataLength, if non-zero, is the amount of early data to
1138 // send after the ClientHello.
1139 SendFakeEarlyDataLength int
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001140
Steven Valdez681eb6a2016-12-19 13:19:29 -05001141 // SendStrayEarlyHandshake, if non-zero, causes the client to send a stray
1142 // handshake record before sending end of early data.
1143 SendStrayEarlyHandshake bool
1144
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001145 // OmitEarlyDataExtension, if true, causes the early data extension to
1146 // be omitted in the ClientHello.
1147 OmitEarlyDataExtension bool
1148
1149 // SendEarlyDataOnSecondClientHello, if true, causes the TLS 1.3 client to
1150 // send early data after the second ClientHello.
1151 SendEarlyDataOnSecondClientHello bool
1152
1153 // InterleaveEarlyData, if true, causes the TLS 1.3 client to send early
1154 // data interleaved with the second ClientHello and the client Finished.
1155 InterleaveEarlyData bool
1156
Nick Harperf2511f12016-12-06 16:02:31 -08001157 // SendEarlyData causes a TLS 1.3 client to send the provided data
1158 // in application data records immediately after the ClientHello,
Steven Valdez2d850622017-01-11 11:34:52 -05001159 // provided that the client offers a TLS 1.3 session. It will do this
1160 // whether or not the server advertised early data for the ticket.
Nick Harperf2511f12016-12-06 16:02:31 -08001161 SendEarlyData [][]byte
1162
Steven Valdez2d850622017-01-11 11:34:52 -05001163 // ExpectEarlyDataAccepted causes a TLS 1.3 client to check that early data
1164 // was accepted by the server.
1165 ExpectEarlyDataAccepted bool
1166
1167 // AlwaysAcceptEarlyData causes a TLS 1.3 server to always accept early data
1168 // regardless of ALPN mismatch.
1169 AlwaysAcceptEarlyData bool
1170
1171 // AlwaysRejectEarlyData causes a TLS 1.3 server to always reject early data.
1172 AlwaysRejectEarlyData bool
1173
1174 // SendEarlyDataExtension, if true, causes a TLS 1.3 server to send the
1175 // early_data extension in EncryptedExtensions, independent of whether
1176 // it was accepted.
1177 SendEarlyDataExtension bool
1178
Nick Harperab20cec2016-12-19 17:38:41 -08001179 // ExpectEarlyData causes a TLS 1.3 server to read application
1180 // data after the ClientHello (assuming the server is able to
1181 // derive the key under which the data is encrypted) before it
1182 // sends a ServerHello. It checks that the application data it
1183 // reads matches what is provided in ExpectEarlyData and errors if
1184 // the number of records or their content do not match.
1185 ExpectEarlyData [][]byte
1186
Nick Harper7cd0a972016-12-02 11:08:40 -08001187 // SendHalfRTTData causes a TLS 1.3 server to send the provided
1188 // data in application data records before reading the client's
1189 // Finished message.
1190 SendHalfRTTData [][]byte
1191
David Benjamin794cc592017-03-25 22:24:23 -05001192 // ExpectHalfRTTData causes a TLS 1.3 client, if 0-RTT was accepted, to
1193 // read application data after reading the server's Finished message and
1194 // before sending any subsequent handshake messages. It checks that the
Nick Harper7cd0a972016-12-02 11:08:40 -08001195 // application data it reads matches what is provided in
1196 // ExpectHalfRTTData and errors if the number of records or their
1197 // content do not match.
1198 ExpectHalfRTTData [][]byte
1199
Steven Valdez143e8b32016-07-11 13:19:03 -04001200 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1201 // emit an empty EncryptedExtensions block.
1202 EmptyEncryptedExtensions bool
1203
1204 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1205 // include the KeyShare extension in the EncryptedExtensions block.
1206 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001207
David Benjamin3baa6e12016-10-07 21:10:38 -04001208 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1209 // be sent by the server, even if empty.
1210 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001211
1212 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1213 // two HelloRetryRequests instead of one.
1214 SecondHelloRetryRequest bool
1215
David Benjamin3baa6e12016-10-07 21:10:38 -04001216 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1217 // the specified curve in a HelloRetryRequest.
1218 SendHelloRetryRequestCurve CurveID
1219
1220 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1221 // sent by the server in HelloRetryRequest.
1222 SendHelloRetryRequestCookie []byte
1223
1224 // DuplicateHelloRetryRequestExtensions, if true, causes all
1225 // HelloRetryRequest extensions to be sent twice.
1226 DuplicateHelloRetryRequestExtensions bool
1227
Steven Valdez5440fe02016-07-18 12:40:30 -04001228 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001229 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001230 SendServerHelloVersion uint16
1231
1232 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1233 // HelloRetryRequest.
1234 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001235
1236 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1237 // HelloRequest in the same record as Finished.
1238 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001239
David Benjamine73c7f42016-08-17 00:29:33 -04001240 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1241 // connection if the selected curve appears in the client's initial
1242 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1243 ExpectMissingKeyShare bool
1244
David Benjamin02edcd02016-07-27 17:40:37 -04001245 // SendExtraFinished, if true, causes an extra Finished message to be
1246 // sent.
1247 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001248
1249 // SendRequestContext, if not empty, is the request context to send in
1250 // a TLS 1.3 CertificateRequest.
1251 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001252
1253 // SendSNIWarningAlert, if true, causes the server to send an
1254 // unrecognized_name alert before the ServerHello.
1255 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001256
1257 // SendCompressionMethods, if not nil, is the compression method list to
1258 // send in the ClientHello.
1259 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001260
1261 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1262 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1263 // hint is empty.
1264 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001265
1266 // TrailingKeyShareData, if true, causes the client key share list to
1267 // include a trailing byte.
1268 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001269
1270 // InvalidChannelIDSignature, if true, causes the client to generate an
1271 // invalid Channel ID signature.
1272 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001273
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001274 // ExpectGREASE, if true, causes messages without GREASE values to be
1275 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001276 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001277
1278 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1279 // that is one byte shorter than it should be.
1280 SendShortPSKBinder bool
1281
1282 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1283 // PSK binder.
1284 SendInvalidPSKBinder bool
1285
1286 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1287 SendNoPSKBinder bool
1288
David Benjaminaedf3032016-12-01 16:47:56 -05001289 // SendExtraPSKBinder, if true, causes the client to send an extra PSK
1290 // binder.
1291 SendExtraPSKBinder bool
1292
Steven Valdeza833c352016-11-01 13:39:36 -04001293 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1294 // extension as the first extension instead of the last extension.
1295 PSKBinderFirst bool
David Benjamin53210cb2016-11-16 09:01:48 +09001296
1297 // NoOCSPStapling, if true, causes the client to not request OCSP
1298 // stapling.
1299 NoOCSPStapling bool
1300
1301 // NoSignedCertificateTimestamps, if true, causes the client to not
1302 // request signed certificate timestamps.
1303 NoSignedCertificateTimestamps bool
David Benjamin6f600d62016-12-21 16:06:54 -05001304
David Benjamina81967b2016-12-22 09:16:57 -05001305 // SendSupportedPointFormats, if not nil, is the list of supported point
1306 // formats to send in ClientHello or ServerHello. If set to a non-nil
1307 // empty slice, no extension will be sent.
1308 SendSupportedPointFormats []byte
David Benjamine3fbb362017-01-06 16:19:28 -05001309
1310 // MaxReceivePlaintext, if non-zero, is the maximum plaintext record
1311 // length accepted from the peer.
1312 MaxReceivePlaintext int
David Benjamin17b30832017-01-28 14:00:32 -05001313
1314 // SendTicketLifetime, if non-zero, is the ticket lifetime to send in
1315 // NewSessionTicket messages.
1316 SendTicketLifetime time.Duration
David Benjamin023d4192017-02-06 13:49:07 -05001317
1318 // SendServerNameAck, if true, causes the server to acknowledge the SNI
1319 // extension.
1320 SendServerNameAck bool
Adam Langley2ff79332017-02-28 13:45:39 -08001321
1322 // ExpectCertificateReqNames, if not nil, contains the list of X.509
1323 // names that must be sent in a CertificateRequest from the server.
1324 ExpectCertificateReqNames [][]byte
David Benjamina58baaf2017-02-28 20:54:28 -05001325
1326 // RenegotiationCertificate, if not nil, is the certificate to use on
1327 // renegotiation handshakes.
1328 RenegotiationCertificate *Certificate
David Benjamin69522112017-03-28 15:38:29 -05001329
1330 // UseLegacySigningAlgorithm, if non-zero, is the signature algorithm
1331 // to use when signing in TLS 1.1 and earlier where algorithms are not
1332 // negotiated.
1333 UseLegacySigningAlgorithm signatureAlgorithm
Adam Langley95c29f32014-06-20 12:00:00 -07001334}
1335
1336func (c *Config) serverInit() {
1337 if c.SessionTicketsDisabled {
1338 return
1339 }
1340
1341 // If the key has already been set then we have nothing to do.
1342 for _, b := range c.SessionTicketKey {
1343 if b != 0 {
1344 return
1345 }
1346 }
1347
1348 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1349 c.SessionTicketsDisabled = true
1350 }
1351}
1352
1353func (c *Config) rand() io.Reader {
1354 r := c.Rand
1355 if r == nil {
1356 return rand.Reader
1357 }
1358 return r
1359}
1360
1361func (c *Config) time() time.Time {
1362 t := c.Time
1363 if t == nil {
1364 t = time.Now
1365 }
1366 return t()
1367}
1368
1369func (c *Config) cipherSuites() []uint16 {
1370 s := c.CipherSuites
1371 if s == nil {
1372 s = defaultCipherSuites()
1373 }
1374 return s
1375}
1376
David Benjamincecee272016-06-30 13:33:47 -04001377func (c *Config) minVersion(isDTLS bool) uint16 {
1378 ret := uint16(minVersion)
1379 if c != nil && c.MinVersion != 0 {
1380 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001381 }
David Benjamincecee272016-06-30 13:33:47 -04001382 if isDTLS {
1383 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1384 if ret < VersionTLS10 {
1385 return VersionTLS10
1386 }
1387 // There is no such thing as DTLS 1.1.
1388 if ret == VersionTLS11 {
1389 return VersionTLS12
1390 }
1391 }
1392 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001393}
1394
David Benjamincecee272016-06-30 13:33:47 -04001395func (c *Config) maxVersion(isDTLS bool) uint16 {
1396 ret := uint16(maxVersion)
1397 if c != nil && c.MaxVersion != 0 {
1398 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001399 }
David Benjamincecee272016-06-30 13:33:47 -04001400 if isDTLS {
1401 // We only implement up to DTLS 1.2.
1402 if ret > VersionTLS12 {
1403 return VersionTLS12
1404 }
1405 // There is no such thing as DTLS 1.1.
1406 if ret == VersionTLS11 {
1407 return VersionTLS10
1408 }
1409 }
1410 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001411}
1412
David Benjamincba2b622015-12-18 22:13:41 -05001413var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001414
1415func (c *Config) curvePreferences() []CurveID {
1416 if c == nil || len(c.CurvePreferences) == 0 {
1417 return defaultCurvePreferences
1418 }
1419 return c.CurvePreferences
1420}
1421
Nick Harperdcfbc672016-07-16 17:47:31 +02001422func (c *Config) defaultCurves() map[CurveID]bool {
1423 defaultCurves := make(map[CurveID]bool)
1424 curves := c.DefaultCurves
1425 if c == nil || c.DefaultCurves == nil {
1426 curves = c.curvePreferences()
1427 }
1428 for _, curveID := range curves {
1429 defaultCurves[curveID] = true
1430 }
1431 return defaultCurves
1432}
1433
Steven Valdezfdd10992016-09-15 16:27:05 -04001434// isSupportedVersion returns true if the specified protocol version is
1435// acceptable.
1436func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1437 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001438}
1439
1440// getCertificateForName returns the best certificate for the given name,
1441// defaulting to the first element of c.Certificates if there are no good
1442// options.
1443func (c *Config) getCertificateForName(name string) *Certificate {
1444 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1445 // There's only one choice, so no point doing any work.
1446 return &c.Certificates[0]
1447 }
1448
1449 name = strings.ToLower(name)
1450 for len(name) > 0 && name[len(name)-1] == '.' {
1451 name = name[:len(name)-1]
1452 }
1453
1454 if cert, ok := c.NameToCertificate[name]; ok {
1455 return cert
1456 }
1457
1458 // try replacing labels in the name with wildcards until we get a
1459 // match.
1460 labels := strings.Split(name, ".")
1461 for i := range labels {
1462 labels[i] = "*"
1463 candidate := strings.Join(labels, ".")
1464 if cert, ok := c.NameToCertificate[candidate]; ok {
1465 return cert
1466 }
1467 }
1468
1469 // If nothing matches, return the first certificate.
1470 return &c.Certificates[0]
1471}
1472
David Benjamin7a41d372016-07-09 11:21:54 -07001473func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1474 if c != nil && c.SignSignatureAlgorithms != nil {
1475 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001476 }
David Benjamin7a41d372016-07-09 11:21:54 -07001477 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001478}
1479
David Benjamin7a41d372016-07-09 11:21:54 -07001480func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1481 if c != nil && c.VerifySignatureAlgorithms != nil {
1482 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001483 }
David Benjamin7a41d372016-07-09 11:21:54 -07001484 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001485}
1486
Adam Langley95c29f32014-06-20 12:00:00 -07001487// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1488// from the CommonName and SubjectAlternateName fields of each of the leaf
1489// certificates.
1490func (c *Config) BuildNameToCertificate() {
1491 c.NameToCertificate = make(map[string]*Certificate)
1492 for i := range c.Certificates {
1493 cert := &c.Certificates[i]
1494 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1495 if err != nil {
1496 continue
1497 }
1498 if len(x509Cert.Subject.CommonName) > 0 {
1499 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1500 }
1501 for _, san := range x509Cert.DNSNames {
1502 c.NameToCertificate[san] = cert
1503 }
1504 }
1505}
1506
1507// A Certificate is a chain of one or more certificates, leaf first.
1508type Certificate struct {
1509 Certificate [][]byte
1510 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1511 // OCSPStaple contains an optional OCSP response which will be served
1512 // to clients that request it.
1513 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001514 // SignedCertificateTimestampList contains an optional encoded
1515 // SignedCertificateTimestampList structure which will be
1516 // served to clients that request it.
1517 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001518 // Leaf is the parsed form of the leaf certificate, which may be
1519 // initialized using x509.ParseCertificate to reduce per-handshake
1520 // processing for TLS clients doing client authentication. If nil, the
1521 // leaf certificate will be parsed as needed.
1522 Leaf *x509.Certificate
1523}
1524
1525// A TLS record.
1526type record struct {
1527 contentType recordType
1528 major, minor uint8
1529 payload []byte
1530}
1531
1532type handshakeMessage interface {
1533 marshal() []byte
1534 unmarshal([]byte) bool
1535}
1536
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001537// lruSessionCache is a client or server session cache implementation
1538// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001539type lruSessionCache struct {
1540 sync.Mutex
1541
1542 m map[string]*list.Element
1543 q *list.List
1544 capacity int
1545}
1546
1547type lruSessionCacheEntry struct {
1548 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001549 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001550}
1551
1552// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001553func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001554 c.Lock()
1555 defer c.Unlock()
1556
1557 if elem, ok := c.m[sessionKey]; ok {
1558 entry := elem.Value.(*lruSessionCacheEntry)
1559 entry.state = cs
1560 c.q.MoveToFront(elem)
1561 return
1562 }
1563
1564 if c.q.Len() < c.capacity {
1565 entry := &lruSessionCacheEntry{sessionKey, cs}
1566 c.m[sessionKey] = c.q.PushFront(entry)
1567 return
1568 }
1569
1570 elem := c.q.Back()
1571 entry := elem.Value.(*lruSessionCacheEntry)
1572 delete(c.m, entry.sessionKey)
1573 entry.sessionKey = sessionKey
1574 entry.state = cs
1575 c.q.MoveToFront(elem)
1576 c.m[sessionKey] = elem
1577}
1578
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001579// Get returns the value associated with a given key. It returns (nil,
1580// false) if no value is found.
1581func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001582 c.Lock()
1583 defer c.Unlock()
1584
1585 if elem, ok := c.m[sessionKey]; ok {
1586 c.q.MoveToFront(elem)
1587 return elem.Value.(*lruSessionCacheEntry).state, true
1588 }
1589 return nil, false
1590}
1591
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001592// lruClientSessionCache is a ClientSessionCache implementation that
1593// uses an LRU caching strategy.
1594type lruClientSessionCache struct {
1595 lruSessionCache
1596}
1597
1598func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1599 c.lruSessionCache.Put(sessionKey, cs)
1600}
1601
1602func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1603 cs, ok := c.lruSessionCache.Get(sessionKey)
1604 if !ok {
1605 return nil, false
1606 }
1607 return cs.(*ClientSessionState), true
1608}
1609
1610// lruServerSessionCache is a ServerSessionCache implementation that
1611// uses an LRU caching strategy.
1612type lruServerSessionCache struct {
1613 lruSessionCache
1614}
1615
1616func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1617 c.lruSessionCache.Put(sessionId, session)
1618}
1619
1620func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1621 cs, ok := c.lruSessionCache.Get(sessionId)
1622 if !ok {
1623 return nil, false
1624 }
1625 return cs.(*sessionState), true
1626}
1627
1628// NewLRUClientSessionCache returns a ClientSessionCache with the given
1629// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1630// is used instead.
1631func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1632 const defaultSessionCacheCapacity = 64
1633
1634 if capacity < 1 {
1635 capacity = defaultSessionCacheCapacity
1636 }
1637 return &lruClientSessionCache{
1638 lruSessionCache{
1639 m: make(map[string]*list.Element),
1640 q: list.New(),
1641 capacity: capacity,
1642 },
1643 }
1644}
1645
1646// NewLRUServerSessionCache returns a ServerSessionCache with the given
1647// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1648// is used instead.
1649func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1650 const defaultSessionCacheCapacity = 64
1651
1652 if capacity < 1 {
1653 capacity = defaultSessionCacheCapacity
1654 }
1655 return &lruServerSessionCache{
1656 lruSessionCache{
1657 m: make(map[string]*list.Element),
1658 q: list.New(),
1659 capacity: capacity,
1660 },
1661 }
1662}
1663
Adam Langley95c29f32014-06-20 12:00:00 -07001664// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1665type dsaSignature struct {
1666 R, S *big.Int
1667}
1668
1669type ecdsaSignature dsaSignature
1670
1671var emptyConfig Config
1672
1673func defaultConfig() *Config {
1674 return &emptyConfig
1675}
1676
1677var (
1678 once sync.Once
1679 varDefaultCipherSuites []uint16
1680)
1681
1682func defaultCipherSuites() []uint16 {
1683 once.Do(initDefaultCipherSuites)
1684 return varDefaultCipherSuites
1685}
1686
1687func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001688 for _, suite := range cipherSuites {
1689 if suite.flags&suitePSK == 0 {
1690 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1691 }
Adam Langley95c29f32014-06-20 12:00:00 -07001692 }
1693}
1694
1695func unexpectedMessageError(wanted, got interface{}) error {
1696 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1697}
David Benjamin000800a2014-11-14 01:43:59 -05001698
Nick Harper60edffd2016-06-21 15:19:24 -07001699func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1700 for _, s := range sigAlgs {
1701 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001702 return true
1703 }
1704 }
1705 return false
1706}
Nick Harper85f20c22016-07-04 10:11:59 -07001707
1708var (
David Benjamina128a552016-10-13 14:26:33 -04001709 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001710 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1711 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1712)