blob: 668f78ced418212c4b4b501449404e840510d19f [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001// Copyright 2009 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
Adam Langleydc7e9c42015-09-29 15:21:04 -07005package runner
Adam Langley95c29f32014-06-20 12:00:00 -07006
7import (
8 "container/list"
9 "crypto"
David Benjamind30a9902014-08-24 01:44:23 -040010 "crypto/ecdsa"
Adam Langley95c29f32014-06-20 12:00:00 -070011 "crypto/rand"
12 "crypto/x509"
13 "fmt"
14 "io"
15 "math/big"
16 "strings"
17 "sync"
18 "time"
19)
20
21const (
22 VersionSSL30 = 0x0300
23 VersionTLS10 = 0x0301
24 VersionTLS11 = 0x0302
25 VersionTLS12 = 0x0303
Nick Harper1fd39d82016-06-14 18:14:35 -070026 VersionTLS13 = 0x0304
Adam Langley95c29f32014-06-20 12:00:00 -070027)
28
Steven Valdezfdd10992016-09-15 16:27:05 -040029// A draft version of TLS 1.3 that is sent over the wire for the current draft.
Steven Valdeza833c352016-11-01 13:39:36 -040030const tls13DraftVersion = 0x7f12
Nick Harper4d90c102016-07-17 10:53:26 +020031
Adam Langley95c29f32014-06-20 12:00:00 -070032const (
David Benjamin83c0bc92014-08-04 01:23:53 -040033 maxPlaintext = 16384 // maximum plaintext payload length
34 maxCiphertext = 16384 + 2048 // maximum ciphertext payload length
35 tlsRecordHeaderLen = 5 // record header length
36 dtlsRecordHeaderLen = 13
37 maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB)
Adam Langley95c29f32014-06-20 12:00:00 -070038
39 minVersion = VersionSSL30
Nick Harper1fd39d82016-06-14 18:14:35 -070040 maxVersion = VersionTLS13
Adam Langley95c29f32014-06-20 12:00:00 -070041)
42
43// TLS record types.
44type recordType uint8
45
46const (
47 recordTypeChangeCipherSpec recordType = 20
48 recordTypeAlert recordType = 21
49 recordTypeHandshake recordType = 22
50 recordTypeApplicationData recordType = 23
51)
52
53// TLS handshake message types.
54const (
David Benjamincedff872016-06-30 18:55:18 -040055 typeHelloRequest uint8 = 0
56 typeClientHello uint8 = 1
57 typeServerHello uint8 = 2
58 typeHelloVerifyRequest uint8 = 3
59 typeNewSessionTicket uint8 = 4
David Benjamina128a552016-10-13 14:26:33 -040060 typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-16
61 typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040062 typeCertificate uint8 = 11
63 typeServerKeyExchange uint8 = 12
64 typeCertificateRequest uint8 = 13
65 typeServerHelloDone uint8 = 14
66 typeCertificateVerify uint8 = 15
67 typeClientKeyExchange uint8 = 16
68 typeFinished uint8 = 20
69 typeCertificateStatus uint8 = 22
David Benjamina128a552016-10-13 14:26:33 -040070 typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040071 typeNextProtocol uint8 = 67 // Not IANA assigned
72 typeChannelID uint8 = 203 // Not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070073)
74
75// TLS compression types.
76const (
77 compressionNone uint8 = 0
78)
79
80// TLS extension numbers
81const (
David Benjamin61f95272014-11-25 01:55:35 -050082 extensionServerName uint16 = 0
83 extensionStatusRequest uint16 = 5
84 extensionSupportedCurves uint16 = 10
85 extensionSupportedPoints uint16 = 11
86 extensionSignatureAlgorithms uint16 = 13
87 extensionUseSRTP uint16 = 14
88 extensionALPN uint16 = 16
89 extensionSignedCertificateTimestamp uint16 = 18
90 extensionExtendedMasterSecret uint16 = 23
91 extensionSessionTicket uint16 = 35
David Benjamina128a552016-10-13 14:26:33 -040092 extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-16
93 extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-16
94 extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-16
Steven Valdezfdd10992016-09-15 16:27:05 -040095 extensionSupportedVersions uint16 = 43 // draft-ietf-tls-tls13-16
David Benjamina128a552016-10-13 14:26:33 -040096 extensionCookie uint16 = 44 // draft-ietf-tls-tls13-16
Steven Valdeza833c352016-11-01 13:39:36 -040097 extensionPSKKeyExchangeModes uint16 = 45 // draft-ietf-tls-tls13-18
Steven Valdez08b65f42016-12-07 15:29:45 -050098 extensionTicketEarlyDataInfo uint16 = 46 // draft-ietf-tls-tls13-18
David Benjamin399e7c92015-07-30 23:01:27 -040099 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -0500100 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
101 extensionRenegotiationInfo uint16 = 0xff01
102 extensionChannelID uint16 = 30032 // not IANA assigned
David Benjamin6f600d62016-12-21 16:06:54 -0500103 extensionShortHeader uint16 = 27463 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700104)
105
106// TLS signaling cipher suite values
107const (
108 scsvRenegotiation uint16 = 0x00ff
109)
110
111// CurveID is the type of a TLS identifier for an elliptic curve. See
112// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
113type CurveID uint16
114
115const (
David Benjamincba2b622015-12-18 22:13:41 -0500116 CurveP224 CurveID = 21
117 CurveP256 CurveID = 23
118 CurveP384 CurveID = 24
119 CurveP521 CurveID = 25
120 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700121)
122
123// TLS Elliptic Curve Point Formats
124// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
125const (
David Benjamina81967b2016-12-22 09:16:57 -0500126 pointFormatUncompressed uint8 = 0
127 pointFormatCompressedPrime uint8 = 1
Adam Langley95c29f32014-06-20 12:00:00 -0700128)
129
130// TLS CertificateStatusType (RFC 3546)
131const (
132 statusTypeOCSP uint8 = 1
133)
134
135// Certificate types (for certificateRequestMsg)
136const (
David Benjamin7b030512014-07-08 17:30:11 -0400137 CertTypeRSASign = 1 // A certificate containing an RSA key
138 CertTypeDSSSign = 2 // A certificate containing a DSA key
139 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
140 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700141
142 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400143 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
144 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
145 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700146
147 // Rest of these are reserved by the TLS spec
148)
149
Nick Harper60edffd2016-06-21 15:19:24 -0700150// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
151// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
152// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
153// algorithms' throughout. We match the latter.
154type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700155
Adam Langley95c29f32014-06-20 12:00:00 -0700156const (
Nick Harper60edffd2016-06-21 15:19:24 -0700157 // RSASSA-PKCS1-v1_5 algorithms
158 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
159 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
160 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
161 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
162 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700163
Nick Harper60edffd2016-06-21 15:19:24 -0700164 // ECDSA algorithms
165 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
166 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
167 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
168 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
169
170 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400171 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
172 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
173 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700174
175 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400176 signatureEd25519 signatureAlgorithm = 0x0807
177 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700178)
Adam Langley95c29f32014-06-20 12:00:00 -0700179
David Benjamin7a41d372016-07-09 11:21:54 -0700180// supportedSignatureAlgorithms contains the default supported signature
181// algorithms.
182var supportedSignatureAlgorithms = []signatureAlgorithm{
183 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700184 signatureRSAPKCS1WithSHA256,
185 signatureECDSAWithP256AndSHA256,
186 signatureRSAPKCS1WithSHA1,
187 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700188}
189
David Benjaminca6c8262014-11-15 19:06:08 -0500190// SRTP protection profiles (See RFC 5764, section 4.1.2)
191const (
192 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
193 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
194)
195
David Benjamina128a552016-10-13 14:26:33 -0400196// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200197const (
Steven Valdez5b986082016-09-01 12:29:49 -0400198 pskKEMode = 0
199 pskDHEKEMode = 1
200)
201
Steven Valdezc4aa7272016-10-03 12:25:56 -0400202// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
203const (
204 keyUpdateNotRequested = 0
205 keyUpdateRequested = 1
206)
207
Adam Langley95c29f32014-06-20 12:00:00 -0700208// ConnectionState records basic TLS details about the connection.
209type ConnectionState struct {
210 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
211 HandshakeComplete bool // TLS handshake is complete
212 DidResume bool // connection resumes a previous TLS connection
213 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
214 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
215 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400216 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700217 ServerName string // server name requested by client, if any (server side only)
218 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
219 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400220 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500221 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400222 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100223 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700224 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400225 CurveID CurveID // the curve used in ECDHE
David Benjamin6f600d62016-12-21 16:06:54 -0500226 ShortHeader bool // whether the short header extension was negotiated
Adam Langley95c29f32014-06-20 12:00:00 -0700227}
228
229// ClientAuthType declares the policy the server will follow for
230// TLS Client Authentication.
231type ClientAuthType int
232
233const (
234 NoClientCert ClientAuthType = iota
235 RequestClientCert
236 RequireAnyClientCert
237 VerifyClientCertIfGiven
238 RequireAndVerifyClientCert
239)
240
241// ClientSessionState contains the state needed by clients to resume TLS
242// sessions.
243type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500244 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700245 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
246 vers uint16 // SSL/TLS version negotiated for the session
247 cipherSuite uint16 // Ciphersuite negotiated for the session
248 masterSecret []byte // MasterSecret generated by client on a full handshake
249 handshakeHash []byte // Handshake hash for Channel ID purposes.
250 serverCertificates []*x509.Certificate // Certificate chain presented by the server
251 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100252 sctList []byte
253 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700254 ticketCreationTime time.Time
255 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400256 ticketAgeAdd uint32
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 Benjaminf3ec83d2014-07-21 22:42:34 -0400537 // EarlyChangeCipherSpec causes the client to send an early
538 // ChangeCipherSpec message before the ClientKeyExchange. A value of
539 // zero disables this behavior. One and two configure variants for 0.9.8
540 // and 1.0.1 modes, respectively.
541 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400542
David Benjamin8144f992016-06-22 17:05:13 -0400543 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
544 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
545 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
546 StrayChangeCipherSpec bool
547
David Benjamin86271ee2014-07-21 16:14:03 -0400548 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
549 // the Finished (or NextProto) message around the ChangeCipherSpec
550 // messages.
551 FragmentAcrossChangeCipherSpec bool
552
David Benjamin61672812016-07-14 23:10:43 -0400553 // SendUnencryptedFinished, if true, causes the Finished message to be
554 // send unencrypted before ChangeCipherSpec rather than after it.
555 SendUnencryptedFinished bool
556
David Benjamin7964b182016-07-14 23:36:30 -0400557 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
558 // 1.3 server to send part of EncryptedExtensions unencrypted
559 // in the same record as ServerHello.
560 PartialEncryptedExtensionsWithServerHello bool
561
562 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
563 // client to send part of Finished unencrypted in the same record as
564 // ClientHello.
565 PartialClientFinishedWithClientHello bool
566
David Benjamind86c7672014-08-02 04:07:12 -0400567 // SendV2ClientHello causes the client to send a V2ClientHello
568 // instead of a normal ClientHello.
569 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400570
571 // SendFallbackSCSV causes the client to include
572 // TLS_FALLBACK_SCSV in the ClientHello.
573 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400574
Adam Langley5021b222015-06-12 18:27:58 -0700575 // SendRenegotiationSCSV causes the client to include the renegotiation
576 // SCSV in the ClientHello.
577 SendRenegotiationSCSV bool
578
David Benjamin43ec06f2014-08-05 02:28:57 -0400579 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400580 // handshake record. Handshake messages will be split into multiple
581 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400582 // never be fragmented. For DTLS, it is the maximum handshake fragment
583 // size, not record size; DTLS allows multiple handshake fragments in a
584 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400585 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400586
David Benjamin98214542014-08-07 18:02:39 -0400587 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
588 // the first 6 bytes of the ClientHello.
589 FragmentClientVersion bool
590
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400591 // FragmentAlert will cause all alerts to be fragmented across
592 // two records.
593 FragmentAlert bool
594
David Benjamin0d3a8c62016-03-11 22:25:18 -0500595 // DoubleAlert will cause all alerts to be sent as two copies packed
596 // within one record.
597 DoubleAlert bool
598
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500599 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
600 // alert to be sent.
601 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400602
David Benjaminb36a3952015-12-01 18:53:13 -0500603 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
604 // ClientKeyExchange which would not pass padding checks.
605 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400606
607 // RenewTicketOnResume causes the server to renew the session ticket and
608 // send a NewSessionTicket message during an abbreviated handshake.
609 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400610
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400611 // SendClientVersion, if non-zero, causes the client to send the
612 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400613 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400614
Steven Valdezfdd10992016-09-15 16:27:05 -0400615 // OmitSupportedVersions, if true, causes the client to omit the
616 // supported versions extension.
617 OmitSupportedVersions bool
618
619 // SendSupportedVersions, if non-empty, causes the client to send a
620 // supported versions extension with the values from array.
621 SendSupportedVersions []uint16
622
David Benjamin1f61f0d2016-07-10 12:20:35 -0400623 // NegotiateVersion, if non-zero, causes the server to negotiate the
624 // specifed TLS version rather than the version supported by either
625 // peer.
626 NegotiateVersion uint16
627
David Benjamine7e36aa2016-08-08 12:39:41 -0400628 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
629 // the specified TLS version on renegotiation rather than retaining it.
630 NegotiateVersionOnRenego uint16
631
David Benjamine58c4f52014-08-24 03:47:07 -0400632 // ExpectFalseStart causes the server to, on full handshakes,
633 // expect the peer to False Start; the server Finished message
634 // isn't sent until we receive an application data record
635 // from the peer.
636 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400637
David Benjamin1c633152015-04-02 20:19:11 -0400638 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
639 // handshakes, send an alert just before reading the application data
640 // record to test False Start. This can be used in a negative False
641 // Start test to determine whether the peer processed the alert (and
642 // closed the connection) before or after sending app data.
643 AlertBeforeFalseStartTest alert
644
David Benjamine78bfde2014-09-06 12:45:15 -0400645 // ExpectServerName, if not empty, is the hostname the client
646 // must specify in the server_name extension.
647 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400648
David Benjamin76c2efc2015-08-31 14:24:29 -0400649 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
650 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400651 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400652
Adam Langleyefb0e162015-07-09 11:35:04 -0700653 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
654 // return.
655 ALPNProtocol *string
656
David Benjamin405da482016-08-08 17:25:07 -0400657 // AcceptAnySession causes the server to resume sessions regardless of
658 // the version associated with the session or cipher suite. It also
659 // causes the server to look in both TLS 1.2 and 1.3 extensions to
660 // process a ticket.
661 AcceptAnySession bool
662
663 // SendBothTickets, if true, causes the client to send tickets in both
664 // TLS 1.2 and 1.3 extensions.
665 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700666
David Benjamin4199b0d2016-11-01 13:58:25 -0400667 // FilterTicket, if not nil, causes the client to modify a session
668 // ticket before sending it in a resume handshake.
669 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700670
671 // OversizedSessionId causes the session id that is sent with a ticket
672 // resumption attempt to be too large (33 bytes).
673 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700674
David Benjamin405da482016-08-08 17:25:07 -0400675 // ExpectNoTLS12Session, if true, causes the server to fail the
676 // connection if either a session ID or TLS 1.2 ticket is offered.
677 ExpectNoTLS12Session bool
678
679 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
680 // if a TLS 1.3 PSK is offered.
681 ExpectNoTLS13PSK bool
682
Adam Langley75712922014-10-10 16:23:43 -0700683 // RequireExtendedMasterSecret, if true, requires that the peer support
684 // the extended master secret option.
685 RequireExtendedMasterSecret bool
686
David Benjaminca6554b2014-11-08 12:31:52 -0500687 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400688 // they didn't support an extended master secret in the initial
689 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700690 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700691
David Benjamin163c9562016-08-29 23:14:17 -0400692 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
693 // behave as if they didn't support an extended master secret in
694 // renegotiation handshakes.
695 NoExtendedMasterSecretOnRenegotiation bool
696
Adam Langley2ae77d22014-10-28 17:29:33 -0700697 // EmptyRenegotiationInfo causes the renegotiation extension to be
698 // empty in a renegotiation handshake.
699 EmptyRenegotiationInfo bool
700
701 // BadRenegotiationInfo causes the renegotiation extension value in a
702 // renegotiation handshake to be incorrect.
703 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500704
David Benjamin3e052de2015-11-25 20:10:31 -0500705 // NoRenegotiationInfo disables renegotiation info support in all
706 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500707 NoRenegotiationInfo bool
708
David Benjamin3e052de2015-11-25 20:10:31 -0500709 // NoRenegotiationInfoInInitial disables renegotiation info support in
710 // the initial handshake.
711 NoRenegotiationInfoInInitial bool
712
713 // NoRenegotiationInfoAfterInitial disables renegotiation info support
714 // in renegotiation handshakes.
715 NoRenegotiationInfoAfterInitial bool
716
Adam Langley5021b222015-06-12 18:27:58 -0700717 // RequireRenegotiationInfo, if true, causes the client to return an
718 // error if the server doesn't reply with the renegotiation extension.
719 RequireRenegotiationInfo bool
720
David Benjamin8e6db492015-07-25 18:29:23 -0400721 // SequenceNumberMapping, if non-nil, is the mapping function to apply
722 // to the sequence number of outgoing packets. For both TLS and DTLS,
723 // the two most-significant bytes in the resulting sequence number are
724 // ignored so that the DTLS epoch cannot be changed.
725 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500726
David Benjamina3e89492015-02-26 15:16:22 -0500727 // RSAEphemeralKey, if true, causes the server to send a
728 // ServerKeyExchange message containing an ephemeral key (as in
729 // RSA_EXPORT) in the plain RSA key exchange.
730 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500731
732 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
733 // client offers when negotiating SRTP. MKI support is still missing so
734 // the peer must still send none.
735 SRTPMasterKeyIdentifer string
736
737 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
738 // server sends in the ServerHello instead of the negotiated one.
739 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500740
Nick Harper60edffd2016-06-21 15:19:24 -0700741 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500742 // signature and hashes extension.
743 //
744 // For a server, it will cause an empty list to be sent in the
745 // CertificateRequest message. None the less, the configured set will
746 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700747 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500748
David Benjamin55a43642015-04-20 14:45:55 -0400749 // NoSupportedCurves, if true, causes the client to omit the
750 // supported_curves extension.
751 NoSupportedCurves bool
752
David Benjaminc44b1df2014-11-23 12:11:01 -0500753 // RequireSameRenegoClientVersion, if true, causes the server
754 // to require that all ClientHellos match in offered version
755 // across a renego.
756 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800757
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400758 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500759 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500760 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500761
David Benjamine6f22212016-11-08 14:28:24 -0500762 // SendRecordVersion, if non-zero, is the value to send as the
763 // record-layer version.
764 SendRecordVersion uint16
765
766 // SendInitialRecordVersion, if non-zero, is the value to send as the
767 // record-layer version before the protocol version is determined.
768 SendInitialRecordVersion uint16
769
David Benjamin13be1de2015-01-11 16:29:36 -0500770 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
771 // packet.
772 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500773
774 // SendCipherSuite, if non-zero, is the cipher suite value that the
775 // server will send in the ServerHello. This does not affect the cipher
776 // the server believes it has actually negotiated.
777 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500778
David Benjamin75f99142016-11-12 12:36:06 +0900779 // SendCipherSuites, if not nil, is the cipher suite list that the
780 // client will send in the ClientHello. This does not affect the cipher
781 // the client believes it has actually offered.
782 SendCipherSuites []uint16
783
David Benjamin4cf369b2015-08-22 01:35:43 -0400784 // AppDataBeforeHandshake, if not nil, causes application data to be
785 // sent immediately before the first handshake message.
786 AppDataBeforeHandshake []byte
787
788 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500789 // be sent immediately after ChangeCipherSpec.
790 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500791
David Benjamindc3da932015-03-12 15:09:02 -0400792 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
793 // immediately after ChangeCipherSpec.
794 AlertAfterChangeCipherSpec alert
795
David Benjamin83f90402015-01-27 01:09:43 -0500796 // TimeoutSchedule is the schedule of packet drops and simulated
797 // timeouts for before each handshake leg from the peer.
798 TimeoutSchedule []time.Duration
799
800 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
801 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500802
803 // ReorderHandshakeFragments, if true, causes handshake fragments in
804 // DTLS to overlap and be sent in the wrong order. It also causes
805 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
806 // Finished and will trigger a spurious retransmit.)
807 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500808
David Benjamin61672812016-07-14 23:10:43 -0400809 // ReverseHandshakeFragments, if true, causes handshake fragments in
810 // DTLS to be reversed within a flight.
811 ReverseHandshakeFragments bool
812
David Benjamin75381222015-03-02 19:30:30 -0500813 // MixCompleteMessageWithFragments, if true, causes handshake
814 // messages in DTLS to redundantly both fragment the message
815 // and include a copy of the full one.
816 MixCompleteMessageWithFragments bool
817
David Benjaminddb9f152015-02-03 15:44:39 -0500818 // SendInvalidRecordType, if true, causes a record with an invalid
819 // content type to be sent immediately following the handshake.
820 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500821
David Benjamin0b8d5da2016-07-15 00:39:56 -0400822 // SendWrongMessageType, if non-zero, causes messages of the specified
823 // type to be sent with the wrong value.
824 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500825
David Benjamin639846e2016-09-09 11:41:18 -0400826 // SendTrailingMessageData, if non-zero, causes messages of the
827 // specified type to be sent with trailing data.
828 SendTrailingMessageData byte
829
David Benjamin75381222015-03-02 19:30:30 -0500830 // FragmentMessageTypeMismatch, if true, causes all non-initial
831 // handshake fragments in DTLS to have the wrong message type.
832 FragmentMessageTypeMismatch bool
833
834 // FragmentMessageLengthMismatch, if true, causes all non-initial
835 // handshake fragments in DTLS to have the wrong message length.
836 FragmentMessageLengthMismatch bool
837
David Benjamin11fc66a2015-06-16 11:40:24 -0400838 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
839 // to be split across two records. The value of |SplitFragments| is the
840 // number of bytes in the first fragment.
841 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500842
843 // SendEmptyFragments, if true, causes handshakes to include empty
844 // fragments in DTLS.
845 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400846
David Benjamin9a41d1b2015-05-16 01:30:09 -0400847 // SendSplitAlert, if true, causes an alert to be sent with the header
848 // and record body split across multiple packets. The peer should
849 // discard these packets rather than process it.
850 SendSplitAlert bool
851
David Benjamin4b27d9f2015-05-12 22:42:52 -0400852 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
853 // client offers a resumption or the server accepts one.
854 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400855
David Benjamin67d1fb52015-03-16 15:16:23 -0400856 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
857 // preferences to be ignored.
858 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400859
860 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
861 // signature algorithm preferences to be ignored.
862 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400863
David Benjaminc574f412015-04-20 11:13:01 -0400864 // IgnorePeerCurvePreferences, if true, causes the peer's curve
865 // preferences to be ignored.
866 IgnorePeerCurvePreferences bool
867
David Benjamin513f0ea2015-04-02 19:33:31 -0400868 // BadFinished, if true, causes the Finished hash to be broken.
869 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700870
871 // DHGroupPrime, if not nil, is used to define the (finite field)
872 // Diffie-Hellman group. The generator used is always two.
873 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400874
David Benjamin582ba042016-07-07 12:33:25 -0700875 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
876 // to be packed into individual handshake records, up to the specified
877 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400878 PackHandshakeFragments int
879
David Benjamin582ba042016-07-07 12:33:25 -0700880 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
881 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400882 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400883
David Benjamin582ba042016-07-07 12:33:25 -0700884 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
885 // be packed into records, up to the largest size record available.
886 PackHandshakeFlight bool
887
David Benjamin5ecb88b2016-10-04 17:51:35 -0400888 // AdvertiseAllConfiguredCiphers, if true, causes the client to
889 // advertise all configured cipher suite values.
890 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400891
892 // EmptyCertificateList, if true, causes the server to send an empty
893 // certificate list in the Certificate message.
894 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400895
896 // ExpectNewTicket, if true, causes the client to abort if it does not
897 // receive a new ticket.
898 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700899
900 // RequireClientHelloSize, if not zero, is the required length in bytes
901 // of the ClientHello /record/. This is checked by the server.
902 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700903
904 // CustomExtension, if not empty, contains the contents of an extension
905 // that will be added to client/server hellos.
906 CustomExtension string
907
David Benjamin490469f2016-10-05 22:44:38 -0400908 // CustomUnencryptedExtension, if not empty, contains the contents of
909 // an extension that will be added to ServerHello in TLS 1.3.
910 CustomUnencryptedExtension string
911
Adam Langley09505632015-07-30 18:10:13 -0700912 // ExpectedCustomExtension, if not nil, contains the expected contents
913 // of a custom extension.
914 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400915
David Benjamin1286bee2016-10-07 15:25:06 -0400916 // CustomTicketExtension, if not empty, contains the contents of an
917 // extension what will be added to NewSessionTicket in TLS 1.3.
918 CustomTicketExtension string
919
David Benjamin3baa6e12016-10-07 21:10:38 -0400920 // CustomTicketExtension, if not empty, contains the contents of an
921 // extension what will be added to HelloRetryRequest in TLS 1.3.
922 CustomHelloRetryRequestExtension string
923
David Benjamin30789da2015-08-29 22:56:45 -0400924 // NoCloseNotify, if true, causes the close_notify alert to be skipped
925 // on connection shutdown.
926 NoCloseNotify bool
927
David Benjaminfa214e42016-05-10 17:03:10 -0400928 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
929 // close_notify on shutdown.
930 SendAlertOnShutdown alert
931
David Benjamin30789da2015-08-29 22:56:45 -0400932 // ExpectCloseNotify, if true, requires a close_notify from the peer on
933 // shutdown. Records from the peer received after close_notify is sent
934 // are not discard.
935 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400936
937 // SendLargeRecords, if true, allows outgoing records to be sent
938 // arbitrarily large.
939 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400940
941 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
942 // ALPN and NPN in the same connetion.
943 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400944
David Benjamin0c40a962016-08-01 12:05:50 -0400945 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400946 // string in the ALPN extension regardless of the content or presence of
947 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400948 SendALPN string
949
David Benjamin490469f2016-10-05 22:44:38 -0400950 // SendUnencryptedALPN, if non-empty, causes the server to send the
951 // specified string in a ServerHello ALPN extension in TLS 1.3.
952 SendUnencryptedALPN string
953
David Benjamindd6fed92015-10-23 17:41:12 -0400954 // SendEmptySessionTicket, if true, causes the server to send an empty
955 // session ticket.
956 SendEmptySessionTicket bool
957
Steven Valdeza833c352016-11-01 13:39:36 -0400958 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400959 // to send.
960 SendPSKKeyExchangeModes []byte
961
Steven Valdeza833c352016-11-01 13:39:36 -0400962 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
963 // receipt of a NewSessionTicket message.
964 ExpectNoNewSessionTicket bool
965
David Benjamin9c33ae82017-01-08 06:04:43 -0500966 // DuplicateTicketEarlyDataInfo causes an extra empty extension of
967 // ticket_early_data_info to be sent in NewSessionTicket.
968 DuplicateTicketEarlyDataInfo bool
969
Steven Valdez08b65f42016-12-07 15:29:45 -0500970 // ExpectTicketEarlyDataInfo, if true, means that the client will fail upon
971 // absence of the ticket_early_data_info extension.
972 ExpectTicketEarlyDataInfo bool
973
Steven Valdeza833c352016-11-01 13:39:36 -0400974 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
975 // server receives from the client.
976 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -0400977
David Benjamindd6fed92015-10-23 17:41:12 -0400978 // FailIfSessionOffered, if true, causes the server to fail any
979 // connections where the client offers a non-empty session ID or session
980 // ticket.
981 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800982
983 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
984 // HelloRequest handshake message to be sent before each application
985 // data record. This only makes sense for a server.
986 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800987
David Benjamin71dd6662016-07-08 14:10:48 -0700988 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
989 // HelloRequest handshake message to be sent before each handshake
990 // message. This only makes sense for a server.
991 SendHelloRequestBeforeEveryHandshakeMessage bool
992
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800993 // RequireDHPublicValueLen causes a fatal error if the length (in
994 // bytes) of the server's Diffie-Hellman public value is not equal to
995 // this.
996 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500997
998 // BadChangeCipherSpec, if not nil, is the body to be sent in
999 // ChangeCipherSpec records instead of {1}.
1000 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -05001001
1002 // BadHelloRequest, if not nil, is what to send instead of a
1003 // HelloRequest.
1004 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -05001005
1006 // RequireSessionTickets, if true, causes the client to require new
1007 // sessions use session tickets instead of session IDs.
1008 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -05001009
1010 // NullAllCiphers, if true, causes every cipher to behave like the null
1011 // cipher.
1012 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -04001013
1014 // SendSCTListOnResume, if not nil, causes the server to send the
1015 // supplied SCT list in resumption handshakes.
1016 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -07001017
David Benjamindaa88502016-10-04 16:32:16 -04001018 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
1019 // OCSP stapling in resumption handshakes and, if applicable, send the
1020 // supplied stapled response.
1021 SendOCSPResponseOnResume []byte
1022
Steven Valdeza833c352016-11-01 13:39:36 -04001023 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1024 // supplied bytes in the extensions on the Certificate message.
1025 SendExtensionOnCertificate []byte
1026
1027 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1028 // supplied OCSP on intermediate certificates in the Certificate message.
1029 SendOCSPOnIntermediates []byte
1030
1031 // SendSCTOnIntermediates, if not nil, causes the server to send the
1032 // supplied SCT on intermediate certificates in the Certificate message.
1033 SendSCTOnIntermediates []byte
1034
1035 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1036 // copy of the OCSP/SCT extensions in the Certificate message.
1037 SendDuplicateCertExtensions bool
1038
1039 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1040 // reject extensions on intermediate certificates.
1041 ExpectNoExtensionsOnIntermediate bool
1042
David Benjaminc9ae27c2016-06-24 22:56:37 -04001043 // RecordPadding is the number of bytes of padding to add to each
1044 // encrypted record in TLS 1.3.
1045 RecordPadding int
1046
1047 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1048 // be missing their body and content type. Padding, if configured, is
1049 // still added.
1050 OmitRecordContents bool
1051
1052 // OuterRecordType, if non-zero, is the outer record type to use instead
1053 // of application data.
1054 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001055
1056 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1057 // with the given signature algorithm rather than the one negotiated.
1058 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001059
1060 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1061 // skipped.
1062 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001063
1064 // IgnoreSignatureVersionChecks, if true, causes all signature
1065 // algorithms to be enabled at all TLS versions.
1066 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001067
1068 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1069 // Renegotiation Info to be negotiated at all versions.
1070 NegotiateRenegotiationInfoAtAllVersions bool
1071
Steven Valdez143e8b32016-07-11 13:19:03 -04001072 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1073 // all versions.
1074 NegotiateNPNAtAllVersions bool
1075
1076 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1077 // all versions.
1078 NegotiateEMSAtAllVersions bool
1079
1080 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1081 // advertised in server extensions
1082 AdvertiseTicketExtension bool
1083
Steven Valdez803c77a2016-09-06 14:13:43 -04001084 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1085 // resumption.
1086 NegotiatePSKResumption bool
1087
David Benjamin7f78df42016-10-05 22:33:19 -04001088 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1089 // always acknowledge a session, regardless of one was offered.
1090 AlwaysSelectPSKIdentity bool
1091
1092 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1093 // the specified PSK identity index rather than the actual value.
1094 SelectPSKIdentityOnResume uint16
1095
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001096 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1097 // identity.
1098 ExtraPSKIdentity bool
1099
Steven Valdez143e8b32016-07-11 13:19:03 -04001100 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1101 // sending a key_share extension and use the zero ECDHE secret
1102 // instead.
1103 MissingKeyShare bool
1104
Steven Valdez5440fe02016-07-18 12:40:30 -04001105 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1106 // ClientHello to skip sending a key_share extension and use the zero
1107 // ECDHE secret instead.
1108 SecondClientHelloMissingKeyShare bool
1109
1110 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1111 // client to pretend the server requested a HelloRetryRequest with the
1112 // given curve rather than the actual one.
1113 MisinterpretHelloRetryRequestCurve CurveID
1114
Steven Valdez143e8b32016-07-11 13:19:03 -04001115 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1116 // copies of each KeyShareEntry.
1117 DuplicateKeyShares bool
1118
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001119 // SendEarlyAlert, if true, sends a fatal alert after the ClientHello.
1120 SendEarlyAlert bool
1121
Nick Harperf2511f12016-12-06 16:02:31 -08001122 // SendFakeEarlyDataLength, if non-zero, is the amount of early data to
1123 // send after the ClientHello.
1124 SendFakeEarlyDataLength int
Steven Valdeza4ee74d2016-11-29 13:36:45 -05001125
1126 // OmitEarlyDataExtension, if true, causes the early data extension to
1127 // be omitted in the ClientHello.
1128 OmitEarlyDataExtension bool
1129
1130 // SendEarlyDataOnSecondClientHello, if true, causes the TLS 1.3 client to
1131 // send early data after the second ClientHello.
1132 SendEarlyDataOnSecondClientHello bool
1133
1134 // InterleaveEarlyData, if true, causes the TLS 1.3 client to send early
1135 // data interleaved with the second ClientHello and the client Finished.
1136 InterleaveEarlyData bool
1137
Nick Harperf2511f12016-12-06 16:02:31 -08001138 // SendEarlyData causes a TLS 1.3 client to send the provided data
1139 // in application data records immediately after the ClientHello,
1140 // provided that the client has a PSK that is appropriate for sending
1141 // early data and includes that PSK in its ClientHello.
1142 SendEarlyData [][]byte
1143
Nick Harperab20cec2016-12-19 17:38:41 -08001144 // ExpectEarlyData causes a TLS 1.3 server to read application
1145 // data after the ClientHello (assuming the server is able to
1146 // derive the key under which the data is encrypted) before it
1147 // sends a ServerHello. It checks that the application data it
1148 // reads matches what is provided in ExpectEarlyData and errors if
1149 // the number of records or their content do not match.
1150 ExpectEarlyData [][]byte
1151
Nick Harper7cd0a972016-12-02 11:08:40 -08001152 // SendHalfRTTData causes a TLS 1.3 server to send the provided
1153 // data in application data records before reading the client's
1154 // Finished message.
1155 SendHalfRTTData [][]byte
1156
1157 // ExpectHalfRTTData causes a TLS 1.3 client to read application
1158 // data after reading the server's Finished message and before
1159 // sending any other handshake messages. It checks that the
1160 // application data it reads matches what is provided in
1161 // ExpectHalfRTTData and errors if the number of records or their
1162 // content do not match.
1163 ExpectHalfRTTData [][]byte
1164
Steven Valdez143e8b32016-07-11 13:19:03 -04001165 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1166 // emit an empty EncryptedExtensions block.
1167 EmptyEncryptedExtensions bool
1168
1169 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1170 // include the KeyShare extension in the EncryptedExtensions block.
1171 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001172
David Benjamin3baa6e12016-10-07 21:10:38 -04001173 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1174 // be sent by the server, even if empty.
1175 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001176
1177 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1178 // two HelloRetryRequests instead of one.
1179 SecondHelloRetryRequest bool
1180
David Benjamin3baa6e12016-10-07 21:10:38 -04001181 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1182 // the specified curve in a HelloRetryRequest.
1183 SendHelloRetryRequestCurve CurveID
1184
1185 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1186 // sent by the server in HelloRetryRequest.
1187 SendHelloRetryRequestCookie []byte
1188
1189 // DuplicateHelloRetryRequestExtensions, if true, causes all
1190 // HelloRetryRequest extensions to be sent twice.
1191 DuplicateHelloRetryRequestExtensions bool
1192
Steven Valdez5440fe02016-07-18 12:40:30 -04001193 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001194 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001195 SendServerHelloVersion uint16
1196
1197 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1198 // HelloRetryRequest.
1199 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001200
1201 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1202 // HelloRequest in the same record as Finished.
1203 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001204
David Benjamine73c7f42016-08-17 00:29:33 -04001205 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1206 // connection if the selected curve appears in the client's initial
1207 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1208 ExpectMissingKeyShare bool
1209
David Benjamin02edcd02016-07-27 17:40:37 -04001210 // SendExtraFinished, if true, causes an extra Finished message to be
1211 // sent.
1212 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001213
1214 // SendRequestContext, if not empty, is the request context to send in
1215 // a TLS 1.3 CertificateRequest.
1216 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001217
1218 // SendSNIWarningAlert, if true, causes the server to send an
1219 // unrecognized_name alert before the ServerHello.
1220 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001221
1222 // SendCompressionMethods, if not nil, is the compression method list to
1223 // send in the ClientHello.
1224 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001225
1226 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1227 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1228 // hint is empty.
1229 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001230
1231 // TrailingKeyShareData, if true, causes the client key share list to
1232 // include a trailing byte.
1233 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001234
1235 // InvalidChannelIDSignature, if true, causes the client to generate an
1236 // invalid Channel ID signature.
1237 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001238
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001239 // ExpectGREASE, if true, causes messages without GREASE values to be
1240 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001241 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001242
1243 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1244 // that is one byte shorter than it should be.
1245 SendShortPSKBinder bool
1246
1247 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1248 // PSK binder.
1249 SendInvalidPSKBinder bool
1250
1251 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1252 SendNoPSKBinder bool
1253
David Benjaminaedf3032016-12-01 16:47:56 -05001254 // SendExtraPSKBinder, if true, causes the client to send an extra PSK
1255 // binder.
1256 SendExtraPSKBinder bool
1257
Steven Valdeza833c352016-11-01 13:39:36 -04001258 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1259 // extension as the first extension instead of the last extension.
1260 PSKBinderFirst bool
David Benjamin53210cb2016-11-16 09:01:48 +09001261
1262 // NoOCSPStapling, if true, causes the client to not request OCSP
1263 // stapling.
1264 NoOCSPStapling bool
1265
1266 // NoSignedCertificateTimestamps, if true, causes the client to not
1267 // request signed certificate timestamps.
1268 NoSignedCertificateTimestamps bool
David Benjamin6f600d62016-12-21 16:06:54 -05001269
1270 // EnableShortHeader, if true, causes the TLS 1.3 short header extension
1271 // to be enabled.
1272 EnableShortHeader bool
1273
1274 // AlwaysNegotiateShortHeader, if true, causes the server to always
1275 // negotiate the short header extension in ServerHello.
1276 AlwaysNegotiateShortHeader bool
1277
1278 // ClearShortHeaderBit, if true, causes the server to send short headers
1279 // without the high bit set.
1280 ClearShortHeaderBit bool
David Benjamina81967b2016-12-22 09:16:57 -05001281
1282 // SendSupportedPointFormats, if not nil, is the list of supported point
1283 // formats to send in ClientHello or ServerHello. If set to a non-nil
1284 // empty slice, no extension will be sent.
1285 SendSupportedPointFormats []byte
David Benjamine3fbb362017-01-06 16:19:28 -05001286
1287 // MaxReceivePlaintext, if non-zero, is the maximum plaintext record
1288 // length accepted from the peer.
1289 MaxReceivePlaintext int
David Benjamin17b30832017-01-28 14:00:32 -05001290
1291 // SendTicketLifetime, if non-zero, is the ticket lifetime to send in
1292 // NewSessionTicket messages.
1293 SendTicketLifetime time.Duration
Adam Langley95c29f32014-06-20 12:00:00 -07001294}
1295
1296func (c *Config) serverInit() {
1297 if c.SessionTicketsDisabled {
1298 return
1299 }
1300
1301 // If the key has already been set then we have nothing to do.
1302 for _, b := range c.SessionTicketKey {
1303 if b != 0 {
1304 return
1305 }
1306 }
1307
1308 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1309 c.SessionTicketsDisabled = true
1310 }
1311}
1312
1313func (c *Config) rand() io.Reader {
1314 r := c.Rand
1315 if r == nil {
1316 return rand.Reader
1317 }
1318 return r
1319}
1320
1321func (c *Config) time() time.Time {
1322 t := c.Time
1323 if t == nil {
1324 t = time.Now
1325 }
1326 return t()
1327}
1328
1329func (c *Config) cipherSuites() []uint16 {
1330 s := c.CipherSuites
1331 if s == nil {
1332 s = defaultCipherSuites()
1333 }
1334 return s
1335}
1336
David Benjamincecee272016-06-30 13:33:47 -04001337func (c *Config) minVersion(isDTLS bool) uint16 {
1338 ret := uint16(minVersion)
1339 if c != nil && c.MinVersion != 0 {
1340 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001341 }
David Benjamincecee272016-06-30 13:33:47 -04001342 if isDTLS {
1343 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1344 if ret < VersionTLS10 {
1345 return VersionTLS10
1346 }
1347 // There is no such thing as DTLS 1.1.
1348 if ret == VersionTLS11 {
1349 return VersionTLS12
1350 }
1351 }
1352 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001353}
1354
David Benjamincecee272016-06-30 13:33:47 -04001355func (c *Config) maxVersion(isDTLS bool) uint16 {
1356 ret := uint16(maxVersion)
1357 if c != nil && c.MaxVersion != 0 {
1358 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001359 }
David Benjamincecee272016-06-30 13:33:47 -04001360 if isDTLS {
1361 // We only implement up to DTLS 1.2.
1362 if ret > VersionTLS12 {
1363 return VersionTLS12
1364 }
1365 // There is no such thing as DTLS 1.1.
1366 if ret == VersionTLS11 {
1367 return VersionTLS10
1368 }
1369 }
1370 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001371}
1372
David Benjamincba2b622015-12-18 22:13:41 -05001373var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001374
1375func (c *Config) curvePreferences() []CurveID {
1376 if c == nil || len(c.CurvePreferences) == 0 {
1377 return defaultCurvePreferences
1378 }
1379 return c.CurvePreferences
1380}
1381
Nick Harperdcfbc672016-07-16 17:47:31 +02001382func (c *Config) defaultCurves() map[CurveID]bool {
1383 defaultCurves := make(map[CurveID]bool)
1384 curves := c.DefaultCurves
1385 if c == nil || c.DefaultCurves == nil {
1386 curves = c.curvePreferences()
1387 }
1388 for _, curveID := range curves {
1389 defaultCurves[curveID] = true
1390 }
1391 return defaultCurves
1392}
1393
Steven Valdezfdd10992016-09-15 16:27:05 -04001394// isSupportedVersion returns true if the specified protocol version is
1395// acceptable.
1396func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1397 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001398}
1399
1400// getCertificateForName returns the best certificate for the given name,
1401// defaulting to the first element of c.Certificates if there are no good
1402// options.
1403func (c *Config) getCertificateForName(name string) *Certificate {
1404 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1405 // There's only one choice, so no point doing any work.
1406 return &c.Certificates[0]
1407 }
1408
1409 name = strings.ToLower(name)
1410 for len(name) > 0 && name[len(name)-1] == '.' {
1411 name = name[:len(name)-1]
1412 }
1413
1414 if cert, ok := c.NameToCertificate[name]; ok {
1415 return cert
1416 }
1417
1418 // try replacing labels in the name with wildcards until we get a
1419 // match.
1420 labels := strings.Split(name, ".")
1421 for i := range labels {
1422 labels[i] = "*"
1423 candidate := strings.Join(labels, ".")
1424 if cert, ok := c.NameToCertificate[candidate]; ok {
1425 return cert
1426 }
1427 }
1428
1429 // If nothing matches, return the first certificate.
1430 return &c.Certificates[0]
1431}
1432
David Benjamin7a41d372016-07-09 11:21:54 -07001433func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1434 if c != nil && c.SignSignatureAlgorithms != nil {
1435 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001436 }
David Benjamin7a41d372016-07-09 11:21:54 -07001437 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001438}
1439
David Benjamin7a41d372016-07-09 11:21:54 -07001440func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1441 if c != nil && c.VerifySignatureAlgorithms != nil {
1442 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001443 }
David Benjamin7a41d372016-07-09 11:21:54 -07001444 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001445}
1446
Adam Langley95c29f32014-06-20 12:00:00 -07001447// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1448// from the CommonName and SubjectAlternateName fields of each of the leaf
1449// certificates.
1450func (c *Config) BuildNameToCertificate() {
1451 c.NameToCertificate = make(map[string]*Certificate)
1452 for i := range c.Certificates {
1453 cert := &c.Certificates[i]
1454 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1455 if err != nil {
1456 continue
1457 }
1458 if len(x509Cert.Subject.CommonName) > 0 {
1459 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1460 }
1461 for _, san := range x509Cert.DNSNames {
1462 c.NameToCertificate[san] = cert
1463 }
1464 }
1465}
1466
1467// A Certificate is a chain of one or more certificates, leaf first.
1468type Certificate struct {
1469 Certificate [][]byte
1470 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1471 // OCSPStaple contains an optional OCSP response which will be served
1472 // to clients that request it.
1473 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001474 // SignedCertificateTimestampList contains an optional encoded
1475 // SignedCertificateTimestampList structure which will be
1476 // served to clients that request it.
1477 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001478 // Leaf is the parsed form of the leaf certificate, which may be
1479 // initialized using x509.ParseCertificate to reduce per-handshake
1480 // processing for TLS clients doing client authentication. If nil, the
1481 // leaf certificate will be parsed as needed.
1482 Leaf *x509.Certificate
1483}
1484
1485// A TLS record.
1486type record struct {
1487 contentType recordType
1488 major, minor uint8
1489 payload []byte
1490}
1491
1492type handshakeMessage interface {
1493 marshal() []byte
1494 unmarshal([]byte) bool
1495}
1496
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001497// lruSessionCache is a client or server session cache implementation
1498// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001499type lruSessionCache struct {
1500 sync.Mutex
1501
1502 m map[string]*list.Element
1503 q *list.List
1504 capacity int
1505}
1506
1507type lruSessionCacheEntry struct {
1508 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001509 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001510}
1511
1512// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001513func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001514 c.Lock()
1515 defer c.Unlock()
1516
1517 if elem, ok := c.m[sessionKey]; ok {
1518 entry := elem.Value.(*lruSessionCacheEntry)
1519 entry.state = cs
1520 c.q.MoveToFront(elem)
1521 return
1522 }
1523
1524 if c.q.Len() < c.capacity {
1525 entry := &lruSessionCacheEntry{sessionKey, cs}
1526 c.m[sessionKey] = c.q.PushFront(entry)
1527 return
1528 }
1529
1530 elem := c.q.Back()
1531 entry := elem.Value.(*lruSessionCacheEntry)
1532 delete(c.m, entry.sessionKey)
1533 entry.sessionKey = sessionKey
1534 entry.state = cs
1535 c.q.MoveToFront(elem)
1536 c.m[sessionKey] = elem
1537}
1538
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001539// Get returns the value associated with a given key. It returns (nil,
1540// false) if no value is found.
1541func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001542 c.Lock()
1543 defer c.Unlock()
1544
1545 if elem, ok := c.m[sessionKey]; ok {
1546 c.q.MoveToFront(elem)
1547 return elem.Value.(*lruSessionCacheEntry).state, true
1548 }
1549 return nil, false
1550}
1551
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001552// lruClientSessionCache is a ClientSessionCache implementation that
1553// uses an LRU caching strategy.
1554type lruClientSessionCache struct {
1555 lruSessionCache
1556}
1557
1558func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1559 c.lruSessionCache.Put(sessionKey, cs)
1560}
1561
1562func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1563 cs, ok := c.lruSessionCache.Get(sessionKey)
1564 if !ok {
1565 return nil, false
1566 }
1567 return cs.(*ClientSessionState), true
1568}
1569
1570// lruServerSessionCache is a ServerSessionCache implementation that
1571// uses an LRU caching strategy.
1572type lruServerSessionCache struct {
1573 lruSessionCache
1574}
1575
1576func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1577 c.lruSessionCache.Put(sessionId, session)
1578}
1579
1580func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1581 cs, ok := c.lruSessionCache.Get(sessionId)
1582 if !ok {
1583 return nil, false
1584 }
1585 return cs.(*sessionState), true
1586}
1587
1588// NewLRUClientSessionCache returns a ClientSessionCache with the given
1589// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1590// is used instead.
1591func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1592 const defaultSessionCacheCapacity = 64
1593
1594 if capacity < 1 {
1595 capacity = defaultSessionCacheCapacity
1596 }
1597 return &lruClientSessionCache{
1598 lruSessionCache{
1599 m: make(map[string]*list.Element),
1600 q: list.New(),
1601 capacity: capacity,
1602 },
1603 }
1604}
1605
1606// NewLRUServerSessionCache returns a ServerSessionCache with the given
1607// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1608// is used instead.
1609func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1610 const defaultSessionCacheCapacity = 64
1611
1612 if capacity < 1 {
1613 capacity = defaultSessionCacheCapacity
1614 }
1615 return &lruServerSessionCache{
1616 lruSessionCache{
1617 m: make(map[string]*list.Element),
1618 q: list.New(),
1619 capacity: capacity,
1620 },
1621 }
1622}
1623
Adam Langley95c29f32014-06-20 12:00:00 -07001624// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1625type dsaSignature struct {
1626 R, S *big.Int
1627}
1628
1629type ecdsaSignature dsaSignature
1630
1631var emptyConfig Config
1632
1633func defaultConfig() *Config {
1634 return &emptyConfig
1635}
1636
1637var (
1638 once sync.Once
1639 varDefaultCipherSuites []uint16
1640)
1641
1642func defaultCipherSuites() []uint16 {
1643 once.Do(initDefaultCipherSuites)
1644 return varDefaultCipherSuites
1645}
1646
1647func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001648 for _, suite := range cipherSuites {
1649 if suite.flags&suitePSK == 0 {
1650 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1651 }
Adam Langley95c29f32014-06-20 12:00:00 -07001652 }
1653}
1654
1655func unexpectedMessageError(wanted, got interface{}) error {
1656 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1657}
David Benjamin000800a2014-11-14 01:43:59 -05001658
Nick Harper60edffd2016-06-21 15:19:24 -07001659func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1660 for _, s := range sigAlgs {
1661 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001662 return true
1663 }
1664 }
1665 return false
1666}
Nick Harper85f20c22016-07-04 10:11:59 -07001667
1668var (
David Benjamina128a552016-10-13 14:26:33 -04001669 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001670 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1671 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1672)