blob: 446c8dc1bae24c31baf76d5163122bc0b653094b [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001// Copyright 2009 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
Adam Langleydc7e9c42015-09-29 15:21:04 -07005package runner
Adam Langley95c29f32014-06-20 12:00:00 -07006
7import (
8 "container/list"
9 "crypto"
David Benjamind30a9902014-08-24 01:44:23 -040010 "crypto/ecdsa"
Adam Langley95c29f32014-06-20 12:00:00 -070011 "crypto/rand"
12 "crypto/x509"
13 "fmt"
14 "io"
15 "math/big"
16 "strings"
17 "sync"
18 "time"
19)
20
21const (
22 VersionSSL30 = 0x0300
23 VersionTLS10 = 0x0301
24 VersionTLS11 = 0x0302
25 VersionTLS12 = 0x0303
Nick Harper1fd39d82016-06-14 18:14:35 -070026 VersionTLS13 = 0x0304
Adam Langley95c29f32014-06-20 12:00:00 -070027)
28
Steven Valdezfdd10992016-09-15 16:27:05 -040029// A draft version of TLS 1.3 that is sent over the wire for the current draft.
Steven Valdeza833c352016-11-01 13:39:36 -040030const tls13DraftVersion = 0x7f12
Nick Harper4d90c102016-07-17 10:53:26 +020031
Adam Langley95c29f32014-06-20 12:00:00 -070032const (
David Benjamin83c0bc92014-08-04 01:23:53 -040033 maxPlaintext = 16384 // maximum plaintext payload length
34 maxCiphertext = 16384 + 2048 // maximum ciphertext payload length
35 tlsRecordHeaderLen = 5 // record header length
36 dtlsRecordHeaderLen = 13
37 maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB)
Adam Langley95c29f32014-06-20 12:00:00 -070038
39 minVersion = VersionSSL30
Nick Harper1fd39d82016-06-14 18:14:35 -070040 maxVersion = VersionTLS13
Adam Langley95c29f32014-06-20 12:00:00 -070041)
42
43// TLS record types.
44type recordType uint8
45
46const (
47 recordTypeChangeCipherSpec recordType = 20
48 recordTypeAlert recordType = 21
49 recordTypeHandshake recordType = 22
50 recordTypeApplicationData recordType = 23
51)
52
53// TLS handshake message types.
54const (
David Benjamincedff872016-06-30 18:55:18 -040055 typeHelloRequest uint8 = 0
56 typeClientHello uint8 = 1
57 typeServerHello uint8 = 2
58 typeHelloVerifyRequest uint8 = 3
59 typeNewSessionTicket uint8 = 4
David Benjamina128a552016-10-13 14:26:33 -040060 typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-16
61 typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040062 typeCertificate uint8 = 11
63 typeServerKeyExchange uint8 = 12
64 typeCertificateRequest uint8 = 13
65 typeServerHelloDone uint8 = 14
66 typeCertificateVerify uint8 = 15
67 typeClientKeyExchange uint8 = 16
68 typeFinished uint8 = 20
69 typeCertificateStatus uint8 = 22
David Benjamina128a552016-10-13 14:26:33 -040070 typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040071 typeNextProtocol uint8 = 67 // Not IANA assigned
72 typeChannelID uint8 = 203 // Not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070073)
74
75// TLS compression types.
76const (
77 compressionNone uint8 = 0
78)
79
80// TLS extension numbers
81const (
David Benjamin61f95272014-11-25 01:55:35 -050082 extensionServerName uint16 = 0
83 extensionStatusRequest uint16 = 5
84 extensionSupportedCurves uint16 = 10
85 extensionSupportedPoints uint16 = 11
86 extensionSignatureAlgorithms uint16 = 13
87 extensionUseSRTP uint16 = 14
88 extensionALPN uint16 = 16
89 extensionSignedCertificateTimestamp uint16 = 18
90 extensionExtendedMasterSecret uint16 = 23
91 extensionSessionTicket uint16 = 35
David Benjamina128a552016-10-13 14:26:33 -040092 extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-16
93 extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-16
94 extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-16
Steven Valdezfdd10992016-09-15 16:27:05 -040095 extensionSupportedVersions uint16 = 43 // draft-ietf-tls-tls13-16
David Benjamina128a552016-10-13 14:26:33 -040096 extensionCookie uint16 = 44 // draft-ietf-tls-tls13-16
Steven Valdeza833c352016-11-01 13:39:36 -040097 extensionPSKKeyExchangeModes uint16 = 45 // draft-ietf-tls-tls13-18
David Benjamin399e7c92015-07-30 23:01:27 -040098 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -050099 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
100 extensionRenegotiationInfo uint16 = 0xff01
101 extensionChannelID uint16 = 30032 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700102)
103
David Benjamin1286bee2016-10-07 15:25:06 -0400104// TLS ticket extension numbers
105const (
106 ticketExtensionCustom uint16 = 1234 // not IANA assigned
107)
108
Adam Langley95c29f32014-06-20 12:00:00 -0700109// TLS signaling cipher suite values
110const (
111 scsvRenegotiation uint16 = 0x00ff
112)
113
114// CurveID is the type of a TLS identifier for an elliptic curve. See
115// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
116type CurveID uint16
117
118const (
David Benjamincba2b622015-12-18 22:13:41 -0500119 CurveP224 CurveID = 21
120 CurveP256 CurveID = 23
121 CurveP384 CurveID = 24
122 CurveP521 CurveID = 25
123 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700124)
125
126// TLS Elliptic Curve Point Formats
127// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
128const (
129 pointFormatUncompressed uint8 = 0
130)
131
132// TLS CertificateStatusType (RFC 3546)
133const (
134 statusTypeOCSP uint8 = 1
135)
136
137// Certificate types (for certificateRequestMsg)
138const (
David Benjamin7b030512014-07-08 17:30:11 -0400139 CertTypeRSASign = 1 // A certificate containing an RSA key
140 CertTypeDSSSign = 2 // A certificate containing a DSA key
141 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
142 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700143
144 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400145 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
146 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
147 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700148
149 // Rest of these are reserved by the TLS spec
150)
151
Nick Harper60edffd2016-06-21 15:19:24 -0700152// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
153// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
154// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
155// algorithms' throughout. We match the latter.
156type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700157
Adam Langley95c29f32014-06-20 12:00:00 -0700158const (
Nick Harper60edffd2016-06-21 15:19:24 -0700159 // RSASSA-PKCS1-v1_5 algorithms
160 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
161 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
162 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
163 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
164 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700165
Nick Harper60edffd2016-06-21 15:19:24 -0700166 // ECDSA algorithms
167 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
168 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
169 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
170 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
171
172 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400173 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
174 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
175 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700176
177 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400178 signatureEd25519 signatureAlgorithm = 0x0807
179 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700180)
Adam Langley95c29f32014-06-20 12:00:00 -0700181
David Benjamin7a41d372016-07-09 11:21:54 -0700182// supportedSignatureAlgorithms contains the default supported signature
183// algorithms.
184var supportedSignatureAlgorithms = []signatureAlgorithm{
185 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700186 signatureRSAPKCS1WithSHA256,
187 signatureECDSAWithP256AndSHA256,
188 signatureRSAPKCS1WithSHA1,
189 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700190}
191
David Benjaminca6c8262014-11-15 19:06:08 -0500192// SRTP protection profiles (See RFC 5764, section 4.1.2)
193const (
194 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
195 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
196)
197
David Benjamina128a552016-10-13 14:26:33 -0400198// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200199const (
Steven Valdez5b986082016-09-01 12:29:49 -0400200 pskKEMode = 0
201 pskDHEKEMode = 1
202)
203
Steven Valdezc4aa7272016-10-03 12:25:56 -0400204// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
205const (
206 keyUpdateNotRequested = 0
207 keyUpdateRequested = 1
208)
209
Adam Langley95c29f32014-06-20 12:00:00 -0700210// ConnectionState records basic TLS details about the connection.
211type ConnectionState struct {
212 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
213 HandshakeComplete bool // TLS handshake is complete
214 DidResume bool // connection resumes a previous TLS connection
215 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
216 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
217 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400218 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700219 ServerName string // server name requested by client, if any (server side only)
220 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
221 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400222 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500223 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400224 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100225 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700226 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400227 CurveID CurveID // the curve used in ECDHE
Adam Langley95c29f32014-06-20 12:00:00 -0700228}
229
230// ClientAuthType declares the policy the server will follow for
231// TLS Client Authentication.
232type ClientAuthType int
233
234const (
235 NoClientCert ClientAuthType = iota
236 RequestClientCert
237 RequireAnyClientCert
238 VerifyClientCertIfGiven
239 RequireAndVerifyClientCert
240)
241
242// ClientSessionState contains the state needed by clients to resume TLS
243// sessions.
244type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500245 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700246 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
247 vers uint16 // SSL/TLS version negotiated for the session
248 cipherSuite uint16 // Ciphersuite negotiated for the session
249 masterSecret []byte // MasterSecret generated by client on a full handshake
250 handshakeHash []byte // Handshake hash for Channel ID purposes.
251 serverCertificates []*x509.Certificate // Certificate chain presented by the server
252 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100253 sctList []byte
254 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700255 ticketCreationTime time.Time
256 ticketExpiration time.Time
Steven Valdeza833c352016-11-01 13:39:36 -0400257 ticketAgeAdd 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
David Benjaminca6c8262014-11-15 19:06:08 -0500417 // SRTPProtectionProfiles, if not nil, is the list of SRTP
418 // protection profiles to offer in DTLS-SRTP.
419 SRTPProtectionProfiles []uint16
420
David Benjamin7a41d372016-07-09 11:21:54 -0700421 // SignSignatureAlgorithms, if not nil, overrides the default set of
422 // supported signature algorithms to sign with.
423 SignSignatureAlgorithms []signatureAlgorithm
424
425 // VerifySignatureAlgorithms, if not nil, overrides the default set of
426 // supported signature algorithms that are accepted.
427 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500428
Adam Langley95c29f32014-06-20 12:00:00 -0700429 // Bugs specifies optional misbehaviour to be used for testing other
430 // implementations.
431 Bugs ProtocolBugs
432
433 serverInitOnce sync.Once // guards calling (*Config).serverInit
434}
435
436type BadValue int
437
438const (
439 BadValueNone BadValue = iota
440 BadValueNegative
441 BadValueZero
442 BadValueLimit
443 BadValueLarge
444 NumBadValues
445)
446
David Benjaminb36a3952015-12-01 18:53:13 -0500447type RSABadValue int
448
449const (
450 RSABadValueNone RSABadValue = iota
451 RSABadValueCorrupt
452 RSABadValueTooLong
453 RSABadValueTooShort
454 RSABadValueWrongVersion
455 NumRSABadValues
456)
457
Adam Langley95c29f32014-06-20 12:00:00 -0700458type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400459 // InvalidSignature specifies that the signature in a ServerKeyExchange
460 // or CertificateVerify message should be invalid.
461 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400462
Steven Valdez5440fe02016-07-18 12:40:30 -0400463 // SendCurve, if non-zero, causes the server to send the specified curve
464 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
465 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400466 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700467
David Benjamin2b07fa42016-03-02 00:23:57 -0500468 // InvalidECDHPoint, if true, causes the ECC points in
469 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
470 InvalidECDHPoint bool
471
Adam Langley95c29f32014-06-20 12:00:00 -0700472 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
473 // can be invalid.
474 BadECDSAR BadValue
475 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700476
477 // MaxPadding causes CBC records to have the maximum possible padding.
478 MaxPadding bool
479 // PaddingFirstByteBad causes the first byte of the padding to be
480 // incorrect.
481 PaddingFirstByteBad bool
482 // PaddingFirstByteBadIf255 causes the first byte of padding to be
483 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
484 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700485
486 // FailIfNotFallbackSCSV causes a server handshake to fail if the
487 // client doesn't send the fallback SCSV value.
488 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400489
490 // DuplicateExtension causes an extra empty extension of bogus type to
491 // be emitted in either the ClientHello or the ServerHello.
492 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400493
494 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
495 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
496 // Certificate message is sent and no signature is added to
497 // ServerKeyExchange.
498 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400499
David Benjaminb80168e2015-02-08 18:30:14 -0500500 // SkipHelloVerifyRequest causes a DTLS server to skip the
501 // HelloVerifyRequest message.
502 SkipHelloVerifyRequest bool
503
David Benjamindcd979f2015-04-20 18:26:52 -0400504 // SkipCertificateStatus, if true, causes the server to skip the
505 // CertificateStatus message. This is legal because CertificateStatus is
506 // optional, even with a status_request in ServerHello.
507 SkipCertificateStatus bool
508
David Benjamin9c651c92014-07-12 13:27:45 -0400509 // SkipServerKeyExchange causes the server to skip sending
510 // ServerKeyExchange messages.
511 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400512
David Benjaminb80168e2015-02-08 18:30:14 -0500513 // SkipNewSessionTicket causes the server to skip sending the
514 // NewSessionTicket message despite promising to in ServerHello.
515 SkipNewSessionTicket bool
516
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500517 // SkipClientCertificate causes the client to skip the Certificate
518 // message.
519 SkipClientCertificate bool
520
David Benjamina0e52232014-07-19 17:39:58 -0400521 // SkipChangeCipherSpec causes the implementation to skip
522 // sending the ChangeCipherSpec message (and adjusting cipher
523 // state accordingly for the Finished message).
524 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400525
David Benjaminb80168e2015-02-08 18:30:14 -0500526 // SkipFinished causes the implementation to skip sending the Finished
527 // message.
528 SkipFinished bool
529
David Benjaminf3ec83d2014-07-21 22:42:34 -0400530 // EarlyChangeCipherSpec causes the client to send an early
531 // ChangeCipherSpec message before the ClientKeyExchange. A value of
532 // zero disables this behavior. One and two configure variants for 0.9.8
533 // and 1.0.1 modes, respectively.
534 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400535
David Benjamin8144f992016-06-22 17:05:13 -0400536 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
537 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
538 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
539 StrayChangeCipherSpec bool
540
David Benjamin86271ee2014-07-21 16:14:03 -0400541 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
542 // the Finished (or NextProto) message around the ChangeCipherSpec
543 // messages.
544 FragmentAcrossChangeCipherSpec bool
545
David Benjamin61672812016-07-14 23:10:43 -0400546 // SendUnencryptedFinished, if true, causes the Finished message to be
547 // send unencrypted before ChangeCipherSpec rather than after it.
548 SendUnencryptedFinished bool
549
David Benjamin7964b182016-07-14 23:36:30 -0400550 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
551 // 1.3 server to send part of EncryptedExtensions unencrypted
552 // in the same record as ServerHello.
553 PartialEncryptedExtensionsWithServerHello bool
554
555 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
556 // client to send part of Finished unencrypted in the same record as
557 // ClientHello.
558 PartialClientFinishedWithClientHello bool
559
David Benjamind86c7672014-08-02 04:07:12 -0400560 // SendV2ClientHello causes the client to send a V2ClientHello
561 // instead of a normal ClientHello.
562 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400563
564 // SendFallbackSCSV causes the client to include
565 // TLS_FALLBACK_SCSV in the ClientHello.
566 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400567
Adam Langley5021b222015-06-12 18:27:58 -0700568 // SendRenegotiationSCSV causes the client to include the renegotiation
569 // SCSV in the ClientHello.
570 SendRenegotiationSCSV bool
571
David Benjamin43ec06f2014-08-05 02:28:57 -0400572 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400573 // handshake record. Handshake messages will be split into multiple
574 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400575 // never be fragmented. For DTLS, it is the maximum handshake fragment
576 // size, not record size; DTLS allows multiple handshake fragments in a
577 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400578 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400579
David Benjamin98214542014-08-07 18:02:39 -0400580 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
581 // the first 6 bytes of the ClientHello.
582 FragmentClientVersion bool
583
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400584 // FragmentAlert will cause all alerts to be fragmented across
585 // two records.
586 FragmentAlert bool
587
David Benjamin0d3a8c62016-03-11 22:25:18 -0500588 // DoubleAlert will cause all alerts to be sent as two copies packed
589 // within one record.
590 DoubleAlert bool
591
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500592 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
593 // alert to be sent.
594 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400595
David Benjaminb36a3952015-12-01 18:53:13 -0500596 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
597 // ClientKeyExchange which would not pass padding checks.
598 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400599
600 // RenewTicketOnResume causes the server to renew the session ticket and
601 // send a NewSessionTicket message during an abbreviated handshake.
602 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400603
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400604 // SendClientVersion, if non-zero, causes the client to send the
605 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400606 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400607
Steven Valdezfdd10992016-09-15 16:27:05 -0400608 // OmitSupportedVersions, if true, causes the client to omit the
609 // supported versions extension.
610 OmitSupportedVersions bool
611
612 // SendSupportedVersions, if non-empty, causes the client to send a
613 // supported versions extension with the values from array.
614 SendSupportedVersions []uint16
615
David Benjamin1f61f0d2016-07-10 12:20:35 -0400616 // NegotiateVersion, if non-zero, causes the server to negotiate the
617 // specifed TLS version rather than the version supported by either
618 // peer.
619 NegotiateVersion uint16
620
David Benjamine7e36aa2016-08-08 12:39:41 -0400621 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
622 // the specified TLS version on renegotiation rather than retaining it.
623 NegotiateVersionOnRenego uint16
624
David Benjamine58c4f52014-08-24 03:47:07 -0400625 // ExpectFalseStart causes the server to, on full handshakes,
626 // expect the peer to False Start; the server Finished message
627 // isn't sent until we receive an application data record
628 // from the peer.
629 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400630
David Benjamin1c633152015-04-02 20:19:11 -0400631 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
632 // handshakes, send an alert just before reading the application data
633 // record to test False Start. This can be used in a negative False
634 // Start test to determine whether the peer processed the alert (and
635 // closed the connection) before or after sending app data.
636 AlertBeforeFalseStartTest alert
637
David Benjamine78bfde2014-09-06 12:45:15 -0400638 // ExpectServerName, if not empty, is the hostname the client
639 // must specify in the server_name extension.
640 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400641
David Benjamin76c2efc2015-08-31 14:24:29 -0400642 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
643 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400644 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400645
Adam Langleyefb0e162015-07-09 11:35:04 -0700646 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
647 // return.
648 ALPNProtocol *string
649
David Benjamin405da482016-08-08 17:25:07 -0400650 // AcceptAnySession causes the server to resume sessions regardless of
651 // the version associated with the session or cipher suite. It also
652 // causes the server to look in both TLS 1.2 and 1.3 extensions to
653 // process a ticket.
654 AcceptAnySession bool
655
656 // SendBothTickets, if true, causes the client to send tickets in both
657 // TLS 1.2 and 1.3 extensions.
658 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700659
David Benjamin4199b0d2016-11-01 13:58:25 -0400660 // FilterTicket, if not nil, causes the client to modify a session
661 // ticket before sending it in a resume handshake.
662 FilterTicket func([]byte) ([]byte, error)
Adam Langley38311732014-10-16 19:04:35 -0700663
664 // OversizedSessionId causes the session id that is sent with a ticket
665 // resumption attempt to be too large (33 bytes).
666 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700667
David Benjamin405da482016-08-08 17:25:07 -0400668 // ExpectNoTLS12Session, if true, causes the server to fail the
669 // connection if either a session ID or TLS 1.2 ticket is offered.
670 ExpectNoTLS12Session bool
671
672 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
673 // if a TLS 1.3 PSK is offered.
674 ExpectNoTLS13PSK bool
675
Adam Langley75712922014-10-10 16:23:43 -0700676 // RequireExtendedMasterSecret, if true, requires that the peer support
677 // the extended master secret option.
678 RequireExtendedMasterSecret bool
679
David Benjaminca6554b2014-11-08 12:31:52 -0500680 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400681 // they didn't support an extended master secret in the initial
682 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700683 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700684
David Benjamin163c9562016-08-29 23:14:17 -0400685 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
686 // behave as if they didn't support an extended master secret in
687 // renegotiation handshakes.
688 NoExtendedMasterSecretOnRenegotiation bool
689
Adam Langley2ae77d22014-10-28 17:29:33 -0700690 // EmptyRenegotiationInfo causes the renegotiation extension to be
691 // empty in a renegotiation handshake.
692 EmptyRenegotiationInfo bool
693
694 // BadRenegotiationInfo causes the renegotiation extension value in a
695 // renegotiation handshake to be incorrect.
696 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500697
David Benjamin3e052de2015-11-25 20:10:31 -0500698 // NoRenegotiationInfo disables renegotiation info support in all
699 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500700 NoRenegotiationInfo bool
701
David Benjamin3e052de2015-11-25 20:10:31 -0500702 // NoRenegotiationInfoInInitial disables renegotiation info support in
703 // the initial handshake.
704 NoRenegotiationInfoInInitial bool
705
706 // NoRenegotiationInfoAfterInitial disables renegotiation info support
707 // in renegotiation handshakes.
708 NoRenegotiationInfoAfterInitial bool
709
Adam Langley5021b222015-06-12 18:27:58 -0700710 // RequireRenegotiationInfo, if true, causes the client to return an
711 // error if the server doesn't reply with the renegotiation extension.
712 RequireRenegotiationInfo bool
713
David Benjamin8e6db492015-07-25 18:29:23 -0400714 // SequenceNumberMapping, if non-nil, is the mapping function to apply
715 // to the sequence number of outgoing packets. For both TLS and DTLS,
716 // the two most-significant bytes in the resulting sequence number are
717 // ignored so that the DTLS epoch cannot be changed.
718 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500719
David Benjamina3e89492015-02-26 15:16:22 -0500720 // RSAEphemeralKey, if true, causes the server to send a
721 // ServerKeyExchange message containing an ephemeral key (as in
722 // RSA_EXPORT) in the plain RSA key exchange.
723 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500724
725 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
726 // client offers when negotiating SRTP. MKI support is still missing so
727 // the peer must still send none.
728 SRTPMasterKeyIdentifer string
729
730 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
731 // server sends in the ServerHello instead of the negotiated one.
732 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500733
Nick Harper60edffd2016-06-21 15:19:24 -0700734 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500735 // signature and hashes extension.
736 //
737 // For a server, it will cause an empty list to be sent in the
738 // CertificateRequest message. None the less, the configured set will
739 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700740 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500741
David Benjamin55a43642015-04-20 14:45:55 -0400742 // NoSupportedCurves, if true, causes the client to omit the
743 // supported_curves extension.
744 NoSupportedCurves bool
745
David Benjaminc44b1df2014-11-23 12:11:01 -0500746 // RequireSameRenegoClientVersion, if true, causes the server
747 // to require that all ClientHellos match in offered version
748 // across a renego.
749 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800750
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400751 // ExpectInitialRecordVersion, if non-zero, is the expected value of
David Benjamine6f22212016-11-08 14:28:24 -0500752 // record-layer version field before the protocol version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500753 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500754
David Benjamine6f22212016-11-08 14:28:24 -0500755 // SendRecordVersion, if non-zero, is the value to send as the
756 // record-layer version.
757 SendRecordVersion uint16
758
759 // SendInitialRecordVersion, if non-zero, is the value to send as the
760 // record-layer version before the protocol version is determined.
761 SendInitialRecordVersion uint16
762
David Benjamin13be1de2015-01-11 16:29:36 -0500763 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
764 // packet.
765 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500766
767 // SendCipherSuite, if non-zero, is the cipher suite value that the
768 // server will send in the ServerHello. This does not affect the cipher
769 // the server believes it has actually negotiated.
770 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500771
David Benjamin4cf369b2015-08-22 01:35:43 -0400772 // AppDataBeforeHandshake, if not nil, causes application data to be
773 // sent immediately before the first handshake message.
774 AppDataBeforeHandshake []byte
775
776 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500777 // be sent immediately after ChangeCipherSpec.
778 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500779
David Benjamindc3da932015-03-12 15:09:02 -0400780 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
781 // immediately after ChangeCipherSpec.
782 AlertAfterChangeCipherSpec alert
783
David Benjamin83f90402015-01-27 01:09:43 -0500784 // TimeoutSchedule is the schedule of packet drops and simulated
785 // timeouts for before each handshake leg from the peer.
786 TimeoutSchedule []time.Duration
787
788 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
789 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500790
791 // ReorderHandshakeFragments, if true, causes handshake fragments in
792 // DTLS to overlap and be sent in the wrong order. It also causes
793 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
794 // Finished and will trigger a spurious retransmit.)
795 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500796
David Benjamin61672812016-07-14 23:10:43 -0400797 // ReverseHandshakeFragments, if true, causes handshake fragments in
798 // DTLS to be reversed within a flight.
799 ReverseHandshakeFragments bool
800
David Benjamin75381222015-03-02 19:30:30 -0500801 // MixCompleteMessageWithFragments, if true, causes handshake
802 // messages in DTLS to redundantly both fragment the message
803 // and include a copy of the full one.
804 MixCompleteMessageWithFragments bool
805
David Benjaminddb9f152015-02-03 15:44:39 -0500806 // SendInvalidRecordType, if true, causes a record with an invalid
807 // content type to be sent immediately following the handshake.
808 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500809
David Benjamin0b8d5da2016-07-15 00:39:56 -0400810 // SendWrongMessageType, if non-zero, causes messages of the specified
811 // type to be sent with the wrong value.
812 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500813
David Benjamin639846e2016-09-09 11:41:18 -0400814 // SendTrailingMessageData, if non-zero, causes messages of the
815 // specified type to be sent with trailing data.
816 SendTrailingMessageData byte
817
David Benjamin75381222015-03-02 19:30:30 -0500818 // FragmentMessageTypeMismatch, if true, causes all non-initial
819 // handshake fragments in DTLS to have the wrong message type.
820 FragmentMessageTypeMismatch bool
821
822 // FragmentMessageLengthMismatch, if true, causes all non-initial
823 // handshake fragments in DTLS to have the wrong message length.
824 FragmentMessageLengthMismatch bool
825
David Benjamin11fc66a2015-06-16 11:40:24 -0400826 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
827 // to be split across two records. The value of |SplitFragments| is the
828 // number of bytes in the first fragment.
829 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500830
831 // SendEmptyFragments, if true, causes handshakes to include empty
832 // fragments in DTLS.
833 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400834
David Benjamin9a41d1b2015-05-16 01:30:09 -0400835 // SendSplitAlert, if true, causes an alert to be sent with the header
836 // and record body split across multiple packets. The peer should
837 // discard these packets rather than process it.
838 SendSplitAlert bool
839
David Benjamin4b27d9f2015-05-12 22:42:52 -0400840 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
841 // client offers a resumption or the server accepts one.
842 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400843
David Benjamin67d1fb52015-03-16 15:16:23 -0400844 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
845 // preferences to be ignored.
846 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400847
848 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
849 // signature algorithm preferences to be ignored.
850 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400851
David Benjaminc574f412015-04-20 11:13:01 -0400852 // IgnorePeerCurvePreferences, if true, causes the peer's curve
853 // preferences to be ignored.
854 IgnorePeerCurvePreferences bool
855
David Benjamin513f0ea2015-04-02 19:33:31 -0400856 // BadFinished, if true, causes the Finished hash to be broken.
857 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700858
859 // DHGroupPrime, if not nil, is used to define the (finite field)
860 // Diffie-Hellman group. The generator used is always two.
861 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400862
David Benjamin582ba042016-07-07 12:33:25 -0700863 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
864 // to be packed into individual handshake records, up to the specified
865 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400866 PackHandshakeFragments int
867
David Benjamin582ba042016-07-07 12:33:25 -0700868 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
869 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400870 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400871
David Benjamin582ba042016-07-07 12:33:25 -0700872 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
873 // be packed into records, up to the largest size record available.
874 PackHandshakeFlight bool
875
David Benjamin5ecb88b2016-10-04 17:51:35 -0400876 // AdvertiseAllConfiguredCiphers, if true, causes the client to
877 // advertise all configured cipher suite values.
878 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400879
880 // EmptyCertificateList, if true, causes the server to send an empty
881 // certificate list in the Certificate message.
882 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400883
884 // ExpectNewTicket, if true, causes the client to abort if it does not
885 // receive a new ticket.
886 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700887
888 // RequireClientHelloSize, if not zero, is the required length in bytes
889 // of the ClientHello /record/. This is checked by the server.
890 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700891
892 // CustomExtension, if not empty, contains the contents of an extension
893 // that will be added to client/server hellos.
894 CustomExtension string
895
David Benjamin490469f2016-10-05 22:44:38 -0400896 // CustomUnencryptedExtension, if not empty, contains the contents of
897 // an extension that will be added to ServerHello in TLS 1.3.
898 CustomUnencryptedExtension string
899
Adam Langley09505632015-07-30 18:10:13 -0700900 // ExpectedCustomExtension, if not nil, contains the expected contents
901 // of a custom extension.
902 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400903
David Benjamin1286bee2016-10-07 15:25:06 -0400904 // CustomTicketExtension, if not empty, contains the contents of an
905 // extension what will be added to NewSessionTicket in TLS 1.3.
906 CustomTicketExtension string
907
David Benjamin3baa6e12016-10-07 21:10:38 -0400908 // CustomTicketExtension, if not empty, contains the contents of an
909 // extension what will be added to HelloRetryRequest in TLS 1.3.
910 CustomHelloRetryRequestExtension string
911
David Benjamin30789da2015-08-29 22:56:45 -0400912 // NoCloseNotify, if true, causes the close_notify alert to be skipped
913 // on connection shutdown.
914 NoCloseNotify bool
915
David Benjaminfa214e42016-05-10 17:03:10 -0400916 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
917 // close_notify on shutdown.
918 SendAlertOnShutdown alert
919
David Benjamin30789da2015-08-29 22:56:45 -0400920 // ExpectCloseNotify, if true, requires a close_notify from the peer on
921 // shutdown. Records from the peer received after close_notify is sent
922 // are not discard.
923 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400924
925 // SendLargeRecords, if true, allows outgoing records to be sent
926 // arbitrarily large.
927 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400928
929 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
930 // ALPN and NPN in the same connetion.
931 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400932
David Benjamin0c40a962016-08-01 12:05:50 -0400933 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400934 // string in the ALPN extension regardless of the content or presence of
935 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400936 SendALPN string
937
David Benjamin490469f2016-10-05 22:44:38 -0400938 // SendUnencryptedALPN, if non-empty, causes the server to send the
939 // specified string in a ServerHello ALPN extension in TLS 1.3.
940 SendUnencryptedALPN string
941
David Benjamindd6fed92015-10-23 17:41:12 -0400942 // SendEmptySessionTicket, if true, causes the server to send an empty
943 // session ticket.
944 SendEmptySessionTicket bool
945
Steven Valdeza833c352016-11-01 13:39:36 -0400946 // SendPSKKeyExchangeModes, if present, determines the PSK key exchange modes
Steven Valdez5b986082016-09-01 12:29:49 -0400947 // to send.
948 SendPSKKeyExchangeModes []byte
949
Steven Valdeza833c352016-11-01 13:39:36 -0400950 // ExpectNoNewSessionTicket, if present, means that the client will fail upon
951 // receipt of a NewSessionTicket message.
952 ExpectNoNewSessionTicket bool
953
954 // ExpectTicketAge, if non-zero, is the expected age of the ticket that the
955 // server receives from the client.
956 ExpectTicketAge time.Duration
Steven Valdez5b986082016-09-01 12:29:49 -0400957
David Benjamindd6fed92015-10-23 17:41:12 -0400958 // FailIfSessionOffered, if true, causes the server to fail any
959 // connections where the client offers a non-empty session ID or session
960 // ticket.
961 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800962
963 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
964 // HelloRequest handshake message to be sent before each application
965 // data record. This only makes sense for a server.
966 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800967
David Benjamin71dd6662016-07-08 14:10:48 -0700968 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
969 // HelloRequest handshake message to be sent before each handshake
970 // message. This only makes sense for a server.
971 SendHelloRequestBeforeEveryHandshakeMessage bool
972
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800973 // RequireDHPublicValueLen causes a fatal error if the length (in
974 // bytes) of the server's Diffie-Hellman public value is not equal to
975 // this.
976 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500977
978 // BadChangeCipherSpec, if not nil, is the body to be sent in
979 // ChangeCipherSpec records instead of {1}.
980 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -0500981
982 // BadHelloRequest, if not nil, is what to send instead of a
983 // HelloRequest.
984 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -0500985
986 // RequireSessionTickets, if true, causes the client to require new
987 // sessions use session tickets instead of session IDs.
988 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -0500989
990 // NullAllCiphers, if true, causes every cipher to behave like the null
991 // cipher.
992 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -0400993
994 // SendSCTListOnResume, if not nil, causes the server to send the
995 // supplied SCT list in resumption handshakes.
996 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -0700997
David Benjamindaa88502016-10-04 16:32:16 -0400998 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
999 // OCSP stapling in resumption handshakes and, if applicable, send the
1000 // supplied stapled response.
1001 SendOCSPResponseOnResume []byte
1002
Steven Valdeza833c352016-11-01 13:39:36 -04001003 // SendExtensionOnCertificate, if not nil, causes the runner to send the
1004 // supplied bytes in the extensions on the Certificate message.
1005 SendExtensionOnCertificate []byte
1006
1007 // SendOCSPOnIntermediates, if not nil, causes the server to send the
1008 // supplied OCSP on intermediate certificates in the Certificate message.
1009 SendOCSPOnIntermediates []byte
1010
1011 // SendSCTOnIntermediates, if not nil, causes the server to send the
1012 // supplied SCT on intermediate certificates in the Certificate message.
1013 SendSCTOnIntermediates []byte
1014
1015 // SendDuplicateCertExtensions, if true, causes the server to send an extra
1016 // copy of the OCSP/SCT extensions in the Certificate message.
1017 SendDuplicateCertExtensions bool
1018
1019 // ExpectNoExtensionsOnIntermediate, if true, causes the client to
1020 // reject extensions on intermediate certificates.
1021 ExpectNoExtensionsOnIntermediate bool
1022
Matt Braithwaite54217e42016-06-13 13:03:47 -07001023 // CECPQ1BadX25519Part corrupts the X25519 part of a CECPQ1 key exchange, as
1024 // a trivial proof that it is actually used.
1025 CECPQ1BadX25519Part bool
1026
1027 // CECPQ1BadNewhopePart corrupts the Newhope part of a CECPQ1 key exchange,
1028 // as a trivial proof that it is actually used.
1029 CECPQ1BadNewhopePart bool
David Benjaminc9ae27c2016-06-24 22:56:37 -04001030
1031 // RecordPadding is the number of bytes of padding to add to each
1032 // encrypted record in TLS 1.3.
1033 RecordPadding int
1034
1035 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1036 // be missing their body and content type. Padding, if configured, is
1037 // still added.
1038 OmitRecordContents bool
1039
1040 // OuterRecordType, if non-zero, is the outer record type to use instead
1041 // of application data.
1042 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001043
1044 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1045 // with the given signature algorithm rather than the one negotiated.
1046 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001047
1048 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1049 // skipped.
1050 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001051
1052 // IgnoreSignatureVersionChecks, if true, causes all signature
1053 // algorithms to be enabled at all TLS versions.
1054 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001055
1056 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1057 // Renegotiation Info to be negotiated at all versions.
1058 NegotiateRenegotiationInfoAtAllVersions bool
1059
Steven Valdez143e8b32016-07-11 13:19:03 -04001060 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1061 // all versions.
1062 NegotiateNPNAtAllVersions bool
1063
1064 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1065 // all versions.
1066 NegotiateEMSAtAllVersions bool
1067
1068 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1069 // advertised in server extensions
1070 AdvertiseTicketExtension bool
1071
Steven Valdez803c77a2016-09-06 14:13:43 -04001072 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1073 // resumption.
1074 NegotiatePSKResumption bool
1075
David Benjamin7f78df42016-10-05 22:33:19 -04001076 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1077 // always acknowledge a session, regardless of one was offered.
1078 AlwaysSelectPSKIdentity bool
1079
1080 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1081 // the specified PSK identity index rather than the actual value.
1082 SelectPSKIdentityOnResume uint16
1083
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001084 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1085 // identity.
1086 ExtraPSKIdentity bool
1087
Steven Valdez143e8b32016-07-11 13:19:03 -04001088 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1089 // sending a key_share extension and use the zero ECDHE secret
1090 // instead.
1091 MissingKeyShare bool
1092
Steven Valdez5440fe02016-07-18 12:40:30 -04001093 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1094 // ClientHello to skip sending a key_share extension and use the zero
1095 // ECDHE secret instead.
1096 SecondClientHelloMissingKeyShare bool
1097
1098 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1099 // client to pretend the server requested a HelloRetryRequest with the
1100 // given curve rather than the actual one.
1101 MisinterpretHelloRetryRequestCurve CurveID
1102
Steven Valdez143e8b32016-07-11 13:19:03 -04001103 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1104 // copies of each KeyShareEntry.
1105 DuplicateKeyShares bool
1106
1107 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1108 // emit an empty EncryptedExtensions block.
1109 EmptyEncryptedExtensions bool
1110
1111 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1112 // include the KeyShare extension in the EncryptedExtensions block.
1113 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001114
David Benjamin3baa6e12016-10-07 21:10:38 -04001115 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1116 // be sent by the server, even if empty.
1117 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001118
1119 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1120 // two HelloRetryRequests instead of one.
1121 SecondHelloRetryRequest bool
1122
David Benjamin3baa6e12016-10-07 21:10:38 -04001123 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1124 // the specified curve in a HelloRetryRequest.
1125 SendHelloRetryRequestCurve CurveID
1126
1127 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1128 // sent by the server in HelloRetryRequest.
1129 SendHelloRetryRequestCookie []byte
1130
1131 // DuplicateHelloRetryRequestExtensions, if true, causes all
1132 // HelloRetryRequest extensions to be sent twice.
1133 DuplicateHelloRetryRequestExtensions bool
1134
Steven Valdez5440fe02016-07-18 12:40:30 -04001135 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001136 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001137 SendServerHelloVersion uint16
1138
1139 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1140 // HelloRetryRequest.
1141 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001142
1143 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1144 // HelloRequest in the same record as Finished.
1145 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001146
David Benjamine73c7f42016-08-17 00:29:33 -04001147 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1148 // connection if the selected curve appears in the client's initial
1149 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1150 ExpectMissingKeyShare bool
1151
David Benjamin02edcd02016-07-27 17:40:37 -04001152 // SendExtraFinished, if true, causes an extra Finished message to be
1153 // sent.
1154 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001155
1156 // SendRequestContext, if not empty, is the request context to send in
1157 // a TLS 1.3 CertificateRequest.
1158 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001159
1160 // SendSNIWarningAlert, if true, causes the server to send an
1161 // unrecognized_name alert before the ServerHello.
1162 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001163
1164 // SendCompressionMethods, if not nil, is the compression method list to
1165 // send in the ClientHello.
1166 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001167
1168 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1169 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1170 // hint is empty.
1171 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001172
1173 // TrailingKeyShareData, if true, causes the client key share list to
1174 // include a trailing byte.
1175 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001176
1177 // InvalidChannelIDSignature, if true, causes the client to generate an
1178 // invalid Channel ID signature.
1179 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001180
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001181 // ExpectGREASE, if true, causes messages without GREASE values to be
1182 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001183 ExpectGREASE bool
Steven Valdeza833c352016-11-01 13:39:36 -04001184
1185 // SendShortPSKBinder, if true, causes the client to send a PSK binder
1186 // that is one byte shorter than it should be.
1187 SendShortPSKBinder bool
1188
1189 // SendInvalidPSKBinder, if true, causes the client to send an invalid
1190 // PSK binder.
1191 SendInvalidPSKBinder bool
1192
1193 // SendNoPSKBinder, if true, causes the client to send no PSK binders.
1194 SendNoPSKBinder bool
1195
1196 // PSKBinderFirst, if true, causes the client to send the PSK Binder
1197 // extension as the first extension instead of the last extension.
1198 PSKBinderFirst bool
Adam Langley95c29f32014-06-20 12:00:00 -07001199}
1200
1201func (c *Config) serverInit() {
1202 if c.SessionTicketsDisabled {
1203 return
1204 }
1205
1206 // If the key has already been set then we have nothing to do.
1207 for _, b := range c.SessionTicketKey {
1208 if b != 0 {
1209 return
1210 }
1211 }
1212
1213 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1214 c.SessionTicketsDisabled = true
1215 }
1216}
1217
1218func (c *Config) rand() io.Reader {
1219 r := c.Rand
1220 if r == nil {
1221 return rand.Reader
1222 }
1223 return r
1224}
1225
1226func (c *Config) time() time.Time {
1227 t := c.Time
1228 if t == nil {
1229 t = time.Now
1230 }
1231 return t()
1232}
1233
1234func (c *Config) cipherSuites() []uint16 {
1235 s := c.CipherSuites
1236 if s == nil {
1237 s = defaultCipherSuites()
1238 }
1239 return s
1240}
1241
David Benjamincecee272016-06-30 13:33:47 -04001242func (c *Config) minVersion(isDTLS bool) uint16 {
1243 ret := uint16(minVersion)
1244 if c != nil && c.MinVersion != 0 {
1245 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001246 }
David Benjamincecee272016-06-30 13:33:47 -04001247 if isDTLS {
1248 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1249 if ret < VersionTLS10 {
1250 return VersionTLS10
1251 }
1252 // There is no such thing as DTLS 1.1.
1253 if ret == VersionTLS11 {
1254 return VersionTLS12
1255 }
1256 }
1257 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001258}
1259
David Benjamincecee272016-06-30 13:33:47 -04001260func (c *Config) maxVersion(isDTLS bool) uint16 {
1261 ret := uint16(maxVersion)
1262 if c != nil && c.MaxVersion != 0 {
1263 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001264 }
David Benjamincecee272016-06-30 13:33:47 -04001265 if isDTLS {
1266 // We only implement up to DTLS 1.2.
1267 if ret > VersionTLS12 {
1268 return VersionTLS12
1269 }
1270 // There is no such thing as DTLS 1.1.
1271 if ret == VersionTLS11 {
1272 return VersionTLS10
1273 }
1274 }
1275 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001276}
1277
David Benjamincba2b622015-12-18 22:13:41 -05001278var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001279
1280func (c *Config) curvePreferences() []CurveID {
1281 if c == nil || len(c.CurvePreferences) == 0 {
1282 return defaultCurvePreferences
1283 }
1284 return c.CurvePreferences
1285}
1286
Nick Harperdcfbc672016-07-16 17:47:31 +02001287func (c *Config) defaultCurves() map[CurveID]bool {
1288 defaultCurves := make(map[CurveID]bool)
1289 curves := c.DefaultCurves
1290 if c == nil || c.DefaultCurves == nil {
1291 curves = c.curvePreferences()
1292 }
1293 for _, curveID := range curves {
1294 defaultCurves[curveID] = true
1295 }
1296 return defaultCurves
1297}
1298
Steven Valdezfdd10992016-09-15 16:27:05 -04001299// isSupportedVersion returns true if the specified protocol version is
1300// acceptable.
1301func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1302 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001303}
1304
1305// getCertificateForName returns the best certificate for the given name,
1306// defaulting to the first element of c.Certificates if there are no good
1307// options.
1308func (c *Config) getCertificateForName(name string) *Certificate {
1309 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1310 // There's only one choice, so no point doing any work.
1311 return &c.Certificates[0]
1312 }
1313
1314 name = strings.ToLower(name)
1315 for len(name) > 0 && name[len(name)-1] == '.' {
1316 name = name[:len(name)-1]
1317 }
1318
1319 if cert, ok := c.NameToCertificate[name]; ok {
1320 return cert
1321 }
1322
1323 // try replacing labels in the name with wildcards until we get a
1324 // match.
1325 labels := strings.Split(name, ".")
1326 for i := range labels {
1327 labels[i] = "*"
1328 candidate := strings.Join(labels, ".")
1329 if cert, ok := c.NameToCertificate[candidate]; ok {
1330 return cert
1331 }
1332 }
1333
1334 // If nothing matches, return the first certificate.
1335 return &c.Certificates[0]
1336}
1337
David Benjamin7a41d372016-07-09 11:21:54 -07001338func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1339 if c != nil && c.SignSignatureAlgorithms != nil {
1340 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001341 }
David Benjamin7a41d372016-07-09 11:21:54 -07001342 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001343}
1344
David Benjamin7a41d372016-07-09 11:21:54 -07001345func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1346 if c != nil && c.VerifySignatureAlgorithms != nil {
1347 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001348 }
David Benjamin7a41d372016-07-09 11:21:54 -07001349 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001350}
1351
Adam Langley95c29f32014-06-20 12:00:00 -07001352// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1353// from the CommonName and SubjectAlternateName fields of each of the leaf
1354// certificates.
1355func (c *Config) BuildNameToCertificate() {
1356 c.NameToCertificate = make(map[string]*Certificate)
1357 for i := range c.Certificates {
1358 cert := &c.Certificates[i]
1359 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1360 if err != nil {
1361 continue
1362 }
1363 if len(x509Cert.Subject.CommonName) > 0 {
1364 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1365 }
1366 for _, san := range x509Cert.DNSNames {
1367 c.NameToCertificate[san] = cert
1368 }
1369 }
1370}
1371
1372// A Certificate is a chain of one or more certificates, leaf first.
1373type Certificate struct {
1374 Certificate [][]byte
1375 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1376 // OCSPStaple contains an optional OCSP response which will be served
1377 // to clients that request it.
1378 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001379 // SignedCertificateTimestampList contains an optional encoded
1380 // SignedCertificateTimestampList structure which will be
1381 // served to clients that request it.
1382 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001383 // Leaf is the parsed form of the leaf certificate, which may be
1384 // initialized using x509.ParseCertificate to reduce per-handshake
1385 // processing for TLS clients doing client authentication. If nil, the
1386 // leaf certificate will be parsed as needed.
1387 Leaf *x509.Certificate
1388}
1389
1390// A TLS record.
1391type record struct {
1392 contentType recordType
1393 major, minor uint8
1394 payload []byte
1395}
1396
1397type handshakeMessage interface {
1398 marshal() []byte
1399 unmarshal([]byte) bool
1400}
1401
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001402// lruSessionCache is a client or server session cache implementation
1403// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001404type lruSessionCache struct {
1405 sync.Mutex
1406
1407 m map[string]*list.Element
1408 q *list.List
1409 capacity int
1410}
1411
1412type lruSessionCacheEntry struct {
1413 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001414 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001415}
1416
1417// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001418func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001419 c.Lock()
1420 defer c.Unlock()
1421
1422 if elem, ok := c.m[sessionKey]; ok {
1423 entry := elem.Value.(*lruSessionCacheEntry)
1424 entry.state = cs
1425 c.q.MoveToFront(elem)
1426 return
1427 }
1428
1429 if c.q.Len() < c.capacity {
1430 entry := &lruSessionCacheEntry{sessionKey, cs}
1431 c.m[sessionKey] = c.q.PushFront(entry)
1432 return
1433 }
1434
1435 elem := c.q.Back()
1436 entry := elem.Value.(*lruSessionCacheEntry)
1437 delete(c.m, entry.sessionKey)
1438 entry.sessionKey = sessionKey
1439 entry.state = cs
1440 c.q.MoveToFront(elem)
1441 c.m[sessionKey] = elem
1442}
1443
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001444// Get returns the value associated with a given key. It returns (nil,
1445// false) if no value is found.
1446func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001447 c.Lock()
1448 defer c.Unlock()
1449
1450 if elem, ok := c.m[sessionKey]; ok {
1451 c.q.MoveToFront(elem)
1452 return elem.Value.(*lruSessionCacheEntry).state, true
1453 }
1454 return nil, false
1455}
1456
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001457// lruClientSessionCache is a ClientSessionCache implementation that
1458// uses an LRU caching strategy.
1459type lruClientSessionCache struct {
1460 lruSessionCache
1461}
1462
1463func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1464 c.lruSessionCache.Put(sessionKey, cs)
1465}
1466
1467func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1468 cs, ok := c.lruSessionCache.Get(sessionKey)
1469 if !ok {
1470 return nil, false
1471 }
1472 return cs.(*ClientSessionState), true
1473}
1474
1475// lruServerSessionCache is a ServerSessionCache implementation that
1476// uses an LRU caching strategy.
1477type lruServerSessionCache struct {
1478 lruSessionCache
1479}
1480
1481func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1482 c.lruSessionCache.Put(sessionId, session)
1483}
1484
1485func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1486 cs, ok := c.lruSessionCache.Get(sessionId)
1487 if !ok {
1488 return nil, false
1489 }
1490 return cs.(*sessionState), true
1491}
1492
1493// NewLRUClientSessionCache returns a ClientSessionCache with the given
1494// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1495// is used instead.
1496func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1497 const defaultSessionCacheCapacity = 64
1498
1499 if capacity < 1 {
1500 capacity = defaultSessionCacheCapacity
1501 }
1502 return &lruClientSessionCache{
1503 lruSessionCache{
1504 m: make(map[string]*list.Element),
1505 q: list.New(),
1506 capacity: capacity,
1507 },
1508 }
1509}
1510
1511// NewLRUServerSessionCache returns a ServerSessionCache with the given
1512// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1513// is used instead.
1514func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1515 const defaultSessionCacheCapacity = 64
1516
1517 if capacity < 1 {
1518 capacity = defaultSessionCacheCapacity
1519 }
1520 return &lruServerSessionCache{
1521 lruSessionCache{
1522 m: make(map[string]*list.Element),
1523 q: list.New(),
1524 capacity: capacity,
1525 },
1526 }
1527}
1528
Adam Langley95c29f32014-06-20 12:00:00 -07001529// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1530type dsaSignature struct {
1531 R, S *big.Int
1532}
1533
1534type ecdsaSignature dsaSignature
1535
1536var emptyConfig Config
1537
1538func defaultConfig() *Config {
1539 return &emptyConfig
1540}
1541
1542var (
1543 once sync.Once
1544 varDefaultCipherSuites []uint16
1545)
1546
1547func defaultCipherSuites() []uint16 {
1548 once.Do(initDefaultCipherSuites)
1549 return varDefaultCipherSuites
1550}
1551
1552func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001553 for _, suite := range cipherSuites {
1554 if suite.flags&suitePSK == 0 {
1555 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1556 }
Adam Langley95c29f32014-06-20 12:00:00 -07001557 }
1558}
1559
1560func unexpectedMessageError(wanted, got interface{}) error {
1561 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1562}
David Benjamin000800a2014-11-14 01:43:59 -05001563
Nick Harper60edffd2016-06-21 15:19:24 -07001564func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1565 for _, s := range sigAlgs {
1566 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001567 return true
1568 }
1569 }
1570 return false
1571}
Nick Harper85f20c22016-07-04 10:11:59 -07001572
1573var (
David Benjamina128a552016-10-13 14:26:33 -04001574 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001575 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1576 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1577)