blob: 8fe61a43a20e2ac4a9d6fa817137e220e911c185 [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 Valdez803c77a2016-09-06 14:13:43 -040030const tls13DraftVersion = 0x7f0f
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
60 typeHelloRetryRequest uint8 = 6 // draft-ietf-tls-tls13-13
61 typeEncryptedExtensions uint8 = 8 // draft-ietf-tls-tls13-13
62 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 Benjamin21c00282016-07-18 21:56:23 +020070 typeKeyUpdate uint8 = 24 // draft-ietf-tls-tls13-13
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 Benjamincedff872016-06-30 18:55:18 -040092 extensionKeyShare uint16 = 40 // draft-ietf-tls-tls13-13
93 extensionPreSharedKey uint16 = 41 // draft-ietf-tls-tls13-13
94 extensionEarlyData uint16 = 42 // draft-ietf-tls-tls13-13
Steven Valdezfdd10992016-09-15 16:27:05 -040095 extensionSupportedVersions uint16 = 43 // draft-ietf-tls-tls13-16
David Benjamincedff872016-06-30 18:55:18 -040096 extensionCookie uint16 = 44 // draft-ietf-tls-tls13-13
David Benjamin399e7c92015-07-30 23:01:27 -040097 extensionCustom uint16 = 1234 // not IANA assigned
David Benjamin61f95272014-11-25 01:55:35 -050098 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
99 extensionRenegotiationInfo uint16 = 0xff01
100 extensionChannelID uint16 = 30032 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -0700101)
102
David Benjamin1286bee2016-10-07 15:25:06 -0400103// TLS ticket extension numbers
104const (
105 ticketExtensionCustom uint16 = 1234 // not IANA assigned
106)
107
Adam Langley95c29f32014-06-20 12:00:00 -0700108// TLS signaling cipher suite values
109const (
110 scsvRenegotiation uint16 = 0x00ff
111)
112
113// CurveID is the type of a TLS identifier for an elliptic curve. See
114// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
115type CurveID uint16
116
117const (
David Benjamincba2b622015-12-18 22:13:41 -0500118 CurveP224 CurveID = 21
119 CurveP256 CurveID = 23
120 CurveP384 CurveID = 24
121 CurveP521 CurveID = 25
122 CurveX25519 CurveID = 29
Adam Langley95c29f32014-06-20 12:00:00 -0700123)
124
125// TLS Elliptic Curve Point Formats
126// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
127const (
128 pointFormatUncompressed uint8 = 0
129)
130
131// TLS CertificateStatusType (RFC 3546)
132const (
133 statusTypeOCSP uint8 = 1
134)
135
136// Certificate types (for certificateRequestMsg)
137const (
David Benjamin7b030512014-07-08 17:30:11 -0400138 CertTypeRSASign = 1 // A certificate containing an RSA key
139 CertTypeDSSSign = 2 // A certificate containing a DSA key
140 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
141 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700142
143 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400144 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
145 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
146 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700147
148 // Rest of these are reserved by the TLS spec
149)
150
Nick Harper60edffd2016-06-21 15:19:24 -0700151// signatureAlgorithm corresponds to a SignatureScheme value from TLS 1.3. Note
152// that TLS 1.3 names the production 'SignatureScheme' to avoid colliding with
153// TLS 1.2's SignatureAlgorithm but otherwise refers to them as 'signature
154// algorithms' throughout. We match the latter.
155type signatureAlgorithm uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700156
Adam Langley95c29f32014-06-20 12:00:00 -0700157const (
Nick Harper60edffd2016-06-21 15:19:24 -0700158 // RSASSA-PKCS1-v1_5 algorithms
159 signatureRSAPKCS1WithMD5 signatureAlgorithm = 0x0101
160 signatureRSAPKCS1WithSHA1 signatureAlgorithm = 0x0201
161 signatureRSAPKCS1WithSHA256 signatureAlgorithm = 0x0401
162 signatureRSAPKCS1WithSHA384 signatureAlgorithm = 0x0501
163 signatureRSAPKCS1WithSHA512 signatureAlgorithm = 0x0601
Adam Langley95c29f32014-06-20 12:00:00 -0700164
Nick Harper60edffd2016-06-21 15:19:24 -0700165 // ECDSA algorithms
166 signatureECDSAWithSHA1 signatureAlgorithm = 0x0203
167 signatureECDSAWithP256AndSHA256 signatureAlgorithm = 0x0403
168 signatureECDSAWithP384AndSHA384 signatureAlgorithm = 0x0503
169 signatureECDSAWithP521AndSHA512 signatureAlgorithm = 0x0603
170
171 // RSASSA-PSS algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400172 signatureRSAPSSWithSHA256 signatureAlgorithm = 0x0804
173 signatureRSAPSSWithSHA384 signatureAlgorithm = 0x0805
174 signatureRSAPSSWithSHA512 signatureAlgorithm = 0x0806
Nick Harper60edffd2016-06-21 15:19:24 -0700175
176 // EdDSA algorithms
David Benjaminaf56fbd2016-09-21 14:38:06 -0400177 signatureEd25519 signatureAlgorithm = 0x0807
178 signatureEd448 signatureAlgorithm = 0x0808
Nick Harper60edffd2016-06-21 15:19:24 -0700179)
Adam Langley95c29f32014-06-20 12:00:00 -0700180
David Benjamin7a41d372016-07-09 11:21:54 -0700181// supportedSignatureAlgorithms contains the default supported signature
182// algorithms.
183var supportedSignatureAlgorithms = []signatureAlgorithm{
184 signatureRSAPSSWithSHA256,
Nick Harper60edffd2016-06-21 15:19:24 -0700185 signatureRSAPKCS1WithSHA256,
186 signatureECDSAWithP256AndSHA256,
187 signatureRSAPKCS1WithSHA1,
188 signatureECDSAWithSHA1,
Adam Langley95c29f32014-06-20 12:00:00 -0700189}
190
David Benjaminca6c8262014-11-15 19:06:08 -0500191// SRTP protection profiles (See RFC 5764, section 4.1.2)
192const (
193 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
194 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
195)
196
Steven Valdez5b986082016-09-01 12:29:49 -0400197// PskKeyExchangeMode values (see draft-ietf-tls-tls13-15)
David Benjamin58104882016-07-18 01:25:41 +0200198const (
Steven Valdez5b986082016-09-01 12:29:49 -0400199 pskKEMode = 0
200 pskDHEKEMode = 1
201)
202
203// PskAuthenticationMode values (see draft-ietf-tls-tls13-15)
204const (
205 pskAuthMode = 0
206 pskSignAuthMode = 1
David Benjamin58104882016-07-18 01:25:41 +0200207)
208
Adam Langley95c29f32014-06-20 12:00:00 -0700209// ConnectionState records basic TLS details about the connection.
210type ConnectionState struct {
211 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
212 HandshakeComplete bool // TLS handshake is complete
213 DidResume bool // connection resumes a previous TLS connection
214 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
215 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
216 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400217 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700218 ServerName string // server name requested by client, if any (server side only)
219 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
220 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400221 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500222 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400223 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100224 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700225 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400226 CurveID CurveID // the curve used in ECDHE
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
Adam Langley95c29f32014-06-20 12:00:00 -0700256}
257
258// ClientSessionCache is a cache of ClientSessionState objects that can be used
259// by a client to resume a TLS session with a given server. ClientSessionCache
260// implementations should expect to be called concurrently from different
261// goroutines.
262type ClientSessionCache interface {
263 // Get searches for a ClientSessionState associated with the given key.
264 // On return, ok is true if one was found.
265 Get(sessionKey string) (session *ClientSessionState, ok bool)
266
267 // Put adds the ClientSessionState to the cache with the given key.
268 Put(sessionKey string, cs *ClientSessionState)
269}
270
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500271// ServerSessionCache is a cache of sessionState objects that can be used by a
272// client to resume a TLS session with a given server. ServerSessionCache
273// implementations should expect to be called concurrently from different
274// goroutines.
275type ServerSessionCache interface {
276 // Get searches for a sessionState associated with the given session
277 // ID. On return, ok is true if one was found.
278 Get(sessionId string) (session *sessionState, ok bool)
279
280 // Put adds the sessionState to the cache with the given session ID.
281 Put(sessionId string, session *sessionState)
282}
283
Adam Langley95c29f32014-06-20 12:00:00 -0700284// A Config structure is used to configure a TLS client or server.
285// After one has been passed to a TLS function it must not be
286// modified. A Config may be reused; the tls package will also not
287// modify it.
288type Config struct {
289 // Rand provides the source of entropy for nonces and RSA blinding.
290 // If Rand is nil, TLS uses the cryptographic random reader in package
291 // crypto/rand.
292 // The Reader must be safe for use by multiple goroutines.
293 Rand io.Reader
294
295 // Time returns the current time as the number of seconds since the epoch.
296 // If Time is nil, TLS uses time.Now.
297 Time func() time.Time
298
299 // Certificates contains one or more certificate chains
300 // to present to the other side of the connection.
301 // Server configurations must include at least one certificate.
302 Certificates []Certificate
303
304 // NameToCertificate maps from a certificate name to an element of
305 // Certificates. Note that a certificate name can be of the form
306 // '*.example.com' and so doesn't have to be a domain name as such.
307 // See Config.BuildNameToCertificate
308 // The nil value causes the first element of Certificates to be used
309 // for all connections.
310 NameToCertificate map[string]*Certificate
311
312 // RootCAs defines the set of root certificate authorities
313 // that clients use when verifying server certificates.
314 // If RootCAs is nil, TLS uses the host's root CA set.
315 RootCAs *x509.CertPool
316
317 // NextProtos is a list of supported, application level protocols.
318 NextProtos []string
319
320 // ServerName is used to verify the hostname on the returned
321 // certificates unless InsecureSkipVerify is given. It is also included
322 // in the client's handshake to support virtual hosting.
323 ServerName string
324
325 // ClientAuth determines the server's policy for
326 // TLS Client Authentication. The default is NoClientCert.
327 ClientAuth ClientAuthType
328
329 // ClientCAs defines the set of root certificate authorities
330 // that servers use if required to verify a client certificate
331 // by the policy in ClientAuth.
332 ClientCAs *x509.CertPool
333
David Benjamin7b030512014-07-08 17:30:11 -0400334 // ClientCertificateTypes defines the set of allowed client certificate
335 // types. The default is CertTypeRSASign and CertTypeECDSASign.
336 ClientCertificateTypes []byte
337
Adam Langley95c29f32014-06-20 12:00:00 -0700338 // InsecureSkipVerify controls whether a client verifies the
339 // server's certificate chain and host name.
340 // If InsecureSkipVerify is true, TLS accepts any certificate
341 // presented by the server and any host name in that certificate.
342 // In this mode, TLS is susceptible to man-in-the-middle attacks.
343 // This should be used only for testing.
344 InsecureSkipVerify bool
345
346 // CipherSuites is a list of supported cipher suites. If CipherSuites
347 // is nil, TLS uses a list of suites supported by the implementation.
348 CipherSuites []uint16
349
350 // PreferServerCipherSuites controls whether the server selects the
351 // client's most preferred ciphersuite, or the server's most preferred
352 // ciphersuite. If true then the server's preference, as expressed in
353 // the order of elements in CipherSuites, is used.
354 PreferServerCipherSuites bool
355
356 // SessionTicketsDisabled may be set to true to disable session ticket
357 // (resumption) support.
358 SessionTicketsDisabled bool
359
360 // SessionTicketKey is used by TLS servers to provide session
361 // resumption. See RFC 5077. If zero, it will be filled with
362 // random data before the first server handshake.
363 //
364 // If multiple servers are terminating connections for the same host
365 // they should all have the same SessionTicketKey. If the
366 // SessionTicketKey leaks, previously recorded and future TLS
367 // connections using that key are compromised.
368 SessionTicketKey [32]byte
369
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500370 // ClientSessionCache is a cache of ClientSessionState entries
371 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700372 ClientSessionCache ClientSessionCache
373
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500374 // ServerSessionCache is a cache of sessionState entries for TLS session
375 // resumption.
376 ServerSessionCache ServerSessionCache
377
Adam Langley95c29f32014-06-20 12:00:00 -0700378 // MinVersion contains the minimum SSL/TLS version that is acceptable.
379 // If zero, then SSLv3 is taken as the minimum.
380 MinVersion uint16
381
382 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
383 // If zero, then the maximum version supported by this package is used,
384 // which is currently TLS 1.2.
385 MaxVersion uint16
386
387 // CurvePreferences contains the elliptic curves that will be used in
388 // an ECDHE handshake, in preference order. If empty, the default will
389 // be used.
390 CurvePreferences []CurveID
391
Nick Harperdcfbc672016-07-16 17:47:31 +0200392 // DefaultCurves contains the elliptic curves for which public values will
393 // be sent in the ClientHello's KeyShare extension. If this value is nil,
394 // all supported curves will have public values sent. This field is ignored
395 // on servers.
396 DefaultCurves []CurveID
397
David Benjamind30a9902014-08-24 01:44:23 -0400398 // ChannelID contains the ECDSA key for the client to use as
399 // its TLS Channel ID.
400 ChannelID *ecdsa.PrivateKey
401
402 // RequestChannelID controls whether the server requests a TLS
403 // Channel ID. If negotiated, the client's public key is
404 // returned in the ConnectionState.
405 RequestChannelID bool
406
David Benjamin48cae082014-10-27 01:06:24 -0400407 // PreSharedKey, if not nil, is the pre-shared key to use with
408 // the PSK cipher suites.
409 PreSharedKey []byte
410
411 // PreSharedKeyIdentity, if not empty, is the identity to use
412 // with the PSK cipher suites.
413 PreSharedKeyIdentity string
414
David Benjaminca6c8262014-11-15 19:06:08 -0500415 // SRTPProtectionProfiles, if not nil, is the list of SRTP
416 // protection profiles to offer in DTLS-SRTP.
417 SRTPProtectionProfiles []uint16
418
David Benjamin7a41d372016-07-09 11:21:54 -0700419 // SignSignatureAlgorithms, if not nil, overrides the default set of
420 // supported signature algorithms to sign with.
421 SignSignatureAlgorithms []signatureAlgorithm
422
423 // VerifySignatureAlgorithms, if not nil, overrides the default set of
424 // supported signature algorithms that are accepted.
425 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500426
Adam Langley95c29f32014-06-20 12:00:00 -0700427 // Bugs specifies optional misbehaviour to be used for testing other
428 // implementations.
429 Bugs ProtocolBugs
430
431 serverInitOnce sync.Once // guards calling (*Config).serverInit
432}
433
434type BadValue int
435
436const (
437 BadValueNone BadValue = iota
438 BadValueNegative
439 BadValueZero
440 BadValueLimit
441 BadValueLarge
442 NumBadValues
443)
444
David Benjaminb36a3952015-12-01 18:53:13 -0500445type RSABadValue int
446
447const (
448 RSABadValueNone RSABadValue = iota
449 RSABadValueCorrupt
450 RSABadValueTooLong
451 RSABadValueTooShort
452 RSABadValueWrongVersion
453 NumRSABadValues
454)
455
Adam Langley95c29f32014-06-20 12:00:00 -0700456type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400457 // InvalidSignature specifies that the signature in a ServerKeyExchange
458 // or CertificateVerify message should be invalid.
459 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400460
Steven Valdez5440fe02016-07-18 12:40:30 -0400461 // SendCurve, if non-zero, causes the server to send the specified curve
462 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
463 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400464 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700465
Steven Valdez5440fe02016-07-18 12:40:30 -0400466 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
467 // the specified curve in HelloRetryRequest rather than the negotiated
468 // one.
469 SendHelloRetryRequestCurve CurveID
470
David Benjamin2b07fa42016-03-02 00:23:57 -0500471 // InvalidECDHPoint, if true, causes the ECC points in
472 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
473 InvalidECDHPoint bool
474
Adam Langley95c29f32014-06-20 12:00:00 -0700475 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
476 // can be invalid.
477 BadECDSAR BadValue
478 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700479
480 // MaxPadding causes CBC records to have the maximum possible padding.
481 MaxPadding bool
482 // PaddingFirstByteBad causes the first byte of the padding to be
483 // incorrect.
484 PaddingFirstByteBad bool
485 // PaddingFirstByteBadIf255 causes the first byte of padding to be
486 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
487 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700488
489 // FailIfNotFallbackSCSV causes a server handshake to fail if the
490 // client doesn't send the fallback SCSV value.
491 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400492
493 // DuplicateExtension causes an extra empty extension of bogus type to
494 // be emitted in either the ClientHello or the ServerHello.
495 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400496
497 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
498 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
499 // Certificate message is sent and no signature is added to
500 // ServerKeyExchange.
501 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400502
David Benjaminb80168e2015-02-08 18:30:14 -0500503 // SkipHelloVerifyRequest causes a DTLS server to skip the
504 // HelloVerifyRequest message.
505 SkipHelloVerifyRequest bool
506
David Benjamindcd979f2015-04-20 18:26:52 -0400507 // SkipCertificateStatus, if true, causes the server to skip the
508 // CertificateStatus message. This is legal because CertificateStatus is
509 // optional, even with a status_request in ServerHello.
510 SkipCertificateStatus bool
511
David Benjamin9c651c92014-07-12 13:27:45 -0400512 // SkipServerKeyExchange causes the server to skip sending
513 // ServerKeyExchange messages.
514 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400515
David Benjaminb80168e2015-02-08 18:30:14 -0500516 // SkipNewSessionTicket causes the server to skip sending the
517 // NewSessionTicket message despite promising to in ServerHello.
518 SkipNewSessionTicket bool
519
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500520 // SkipClientCertificate causes the client to skip the Certificate
521 // message.
522 SkipClientCertificate bool
523
David Benjamina0e52232014-07-19 17:39:58 -0400524 // SkipChangeCipherSpec causes the implementation to skip
525 // sending the ChangeCipherSpec message (and adjusting cipher
526 // state accordingly for the Finished message).
527 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400528
David Benjaminb80168e2015-02-08 18:30:14 -0500529 // SkipFinished causes the implementation to skip sending the Finished
530 // message.
531 SkipFinished bool
532
David Benjaminf3ec83d2014-07-21 22:42:34 -0400533 // EarlyChangeCipherSpec causes the client to send an early
534 // ChangeCipherSpec message before the ClientKeyExchange. A value of
535 // zero disables this behavior. One and two configure variants for 0.9.8
536 // and 1.0.1 modes, respectively.
537 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400538
David Benjamin8144f992016-06-22 17:05:13 -0400539 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
540 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
541 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
542 StrayChangeCipherSpec bool
543
David Benjamin86271ee2014-07-21 16:14:03 -0400544 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
545 // the Finished (or NextProto) message around the ChangeCipherSpec
546 // messages.
547 FragmentAcrossChangeCipherSpec bool
548
David Benjamin61672812016-07-14 23:10:43 -0400549 // SendUnencryptedFinished, if true, causes the Finished message to be
550 // send unencrypted before ChangeCipherSpec rather than after it.
551 SendUnencryptedFinished bool
552
David Benjamin7964b182016-07-14 23:36:30 -0400553 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
554 // 1.3 server to send part of EncryptedExtensions unencrypted
555 // in the same record as ServerHello.
556 PartialEncryptedExtensionsWithServerHello bool
557
558 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
559 // client to send part of Finished unencrypted in the same record as
560 // ClientHello.
561 PartialClientFinishedWithClientHello bool
562
David Benjamind86c7672014-08-02 04:07:12 -0400563 // SendV2ClientHello causes the client to send a V2ClientHello
564 // instead of a normal ClientHello.
565 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400566
567 // SendFallbackSCSV causes the client to include
568 // TLS_FALLBACK_SCSV in the ClientHello.
569 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400570
Adam Langley5021b222015-06-12 18:27:58 -0700571 // SendRenegotiationSCSV causes the client to include the renegotiation
572 // SCSV in the ClientHello.
573 SendRenegotiationSCSV bool
574
David Benjamin43ec06f2014-08-05 02:28:57 -0400575 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400576 // handshake record. Handshake messages will be split into multiple
577 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400578 // never be fragmented. For DTLS, it is the maximum handshake fragment
579 // size, not record size; DTLS allows multiple handshake fragments in a
580 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400581 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400582
David Benjamin98214542014-08-07 18:02:39 -0400583 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
584 // the first 6 bytes of the ClientHello.
585 FragmentClientVersion bool
586
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400587 // FragmentAlert will cause all alerts to be fragmented across
588 // two records.
589 FragmentAlert bool
590
David Benjamin0d3a8c62016-03-11 22:25:18 -0500591 // DoubleAlert will cause all alerts to be sent as two copies packed
592 // within one record.
593 DoubleAlert bool
594
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500595 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
596 // alert to be sent.
597 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400598
David Benjaminb36a3952015-12-01 18:53:13 -0500599 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
600 // ClientKeyExchange which would not pass padding checks.
601 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400602
603 // RenewTicketOnResume causes the server to renew the session ticket and
604 // send a NewSessionTicket message during an abbreviated handshake.
605 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400606
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400607 // SendClientVersion, if non-zero, causes the client to send the
608 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400609 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400610
Steven Valdezfdd10992016-09-15 16:27:05 -0400611 // OmitSupportedVersions, if true, causes the client to omit the
612 // supported versions extension.
613 OmitSupportedVersions bool
614
615 // SendSupportedVersions, if non-empty, causes the client to send a
616 // supported versions extension with the values from array.
617 SendSupportedVersions []uint16
618
David Benjamin1f61f0d2016-07-10 12:20:35 -0400619 // NegotiateVersion, if non-zero, causes the server to negotiate the
620 // specifed TLS version rather than the version supported by either
621 // peer.
622 NegotiateVersion uint16
623
David Benjamine7e36aa2016-08-08 12:39:41 -0400624 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
625 // the specified TLS version on renegotiation rather than retaining it.
626 NegotiateVersionOnRenego uint16
627
David Benjamine58c4f52014-08-24 03:47:07 -0400628 // ExpectFalseStart causes the server to, on full handshakes,
629 // expect the peer to False Start; the server Finished message
630 // isn't sent until we receive an application data record
631 // from the peer.
632 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400633
David Benjamin1c633152015-04-02 20:19:11 -0400634 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
635 // handshakes, send an alert just before reading the application data
636 // record to test False Start. This can be used in a negative False
637 // Start test to determine whether the peer processed the alert (and
638 // closed the connection) before or after sending app data.
639 AlertBeforeFalseStartTest alert
640
David Benjamine78bfde2014-09-06 12:45:15 -0400641 // ExpectServerName, if not empty, is the hostname the client
642 // must specify in the server_name extension.
643 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400644
David Benjamin76c2efc2015-08-31 14:24:29 -0400645 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
646 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400647 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400648
Adam Langleyefb0e162015-07-09 11:35:04 -0700649 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
650 // return.
651 ALPNProtocol *string
652
David Benjamin405da482016-08-08 17:25:07 -0400653 // AcceptAnySession causes the server to resume sessions regardless of
654 // the version associated with the session or cipher suite. It also
655 // causes the server to look in both TLS 1.2 and 1.3 extensions to
656 // process a ticket.
657 AcceptAnySession bool
658
659 // SendBothTickets, if true, causes the client to send tickets in both
660 // TLS 1.2 and 1.3 extensions.
661 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700662
663 // CorruptTicket causes a client to corrupt a session ticket before
664 // sending it in a resume handshake.
665 CorruptTicket bool
666
667 // OversizedSessionId causes the session id that is sent with a ticket
668 // resumption attempt to be too large (33 bytes).
669 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700670
David Benjamin405da482016-08-08 17:25:07 -0400671 // ExpectNoTLS12Session, if true, causes the server to fail the
672 // connection if either a session ID or TLS 1.2 ticket is offered.
673 ExpectNoTLS12Session bool
674
675 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
676 // if a TLS 1.3 PSK is offered.
677 ExpectNoTLS13PSK bool
678
Adam Langley75712922014-10-10 16:23:43 -0700679 // RequireExtendedMasterSecret, if true, requires that the peer support
680 // the extended master secret option.
681 RequireExtendedMasterSecret bool
682
David Benjaminca6554b2014-11-08 12:31:52 -0500683 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400684 // they didn't support an extended master secret in the initial
685 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700686 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700687
David Benjamin163c9562016-08-29 23:14:17 -0400688 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
689 // behave as if they didn't support an extended master secret in
690 // renegotiation handshakes.
691 NoExtendedMasterSecretOnRenegotiation bool
692
Adam Langley2ae77d22014-10-28 17:29:33 -0700693 // EmptyRenegotiationInfo causes the renegotiation extension to be
694 // empty in a renegotiation handshake.
695 EmptyRenegotiationInfo bool
696
697 // BadRenegotiationInfo causes the renegotiation extension value in a
698 // renegotiation handshake to be incorrect.
699 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500700
David Benjamin3e052de2015-11-25 20:10:31 -0500701 // NoRenegotiationInfo disables renegotiation info support in all
702 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500703 NoRenegotiationInfo bool
704
David Benjamin3e052de2015-11-25 20:10:31 -0500705 // NoRenegotiationInfoInInitial disables renegotiation info support in
706 // the initial handshake.
707 NoRenegotiationInfoInInitial bool
708
709 // NoRenegotiationInfoAfterInitial disables renegotiation info support
710 // in renegotiation handshakes.
711 NoRenegotiationInfoAfterInitial bool
712
Adam Langley5021b222015-06-12 18:27:58 -0700713 // RequireRenegotiationInfo, if true, causes the client to return an
714 // error if the server doesn't reply with the renegotiation extension.
715 RequireRenegotiationInfo bool
716
David Benjamin8e6db492015-07-25 18:29:23 -0400717 // SequenceNumberMapping, if non-nil, is the mapping function to apply
718 // to the sequence number of outgoing packets. For both TLS and DTLS,
719 // the two most-significant bytes in the resulting sequence number are
720 // ignored so that the DTLS epoch cannot be changed.
721 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500722
David Benjamina3e89492015-02-26 15:16:22 -0500723 // RSAEphemeralKey, if true, causes the server to send a
724 // ServerKeyExchange message containing an ephemeral key (as in
725 // RSA_EXPORT) in the plain RSA key exchange.
726 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500727
728 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
729 // client offers when negotiating SRTP. MKI support is still missing so
730 // the peer must still send none.
731 SRTPMasterKeyIdentifer string
732
733 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
734 // server sends in the ServerHello instead of the negotiated one.
735 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500736
Nick Harper60edffd2016-06-21 15:19:24 -0700737 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500738 // signature and hashes extension.
739 //
740 // For a server, it will cause an empty list to be sent in the
741 // CertificateRequest message. None the less, the configured set will
742 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700743 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500744
David Benjamin55a43642015-04-20 14:45:55 -0400745 // NoSupportedCurves, if true, causes the client to omit the
746 // supported_curves extension.
747 NoSupportedCurves bool
748
David Benjaminc44b1df2014-11-23 12:11:01 -0500749 // RequireSameRenegoClientVersion, if true, causes the server
750 // to require that all ClientHellos match in offered version
751 // across a renego.
752 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800753
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400754 // ExpectInitialRecordVersion, if non-zero, is the expected value of
755 // record-layer version field before the version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500756 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500757
758 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
759 // packet.
760 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500761
762 // SendCipherSuite, if non-zero, is the cipher suite value that the
763 // server will send in the ServerHello. This does not affect the cipher
764 // the server believes it has actually negotiated.
765 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500766
David Benjamin4cf369b2015-08-22 01:35:43 -0400767 // AppDataBeforeHandshake, if not nil, causes application data to be
768 // sent immediately before the first handshake message.
769 AppDataBeforeHandshake []byte
770
771 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500772 // be sent immediately after ChangeCipherSpec.
773 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500774
David Benjamindc3da932015-03-12 15:09:02 -0400775 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
776 // immediately after ChangeCipherSpec.
777 AlertAfterChangeCipherSpec alert
778
David Benjamin83f90402015-01-27 01:09:43 -0500779 // TimeoutSchedule is the schedule of packet drops and simulated
780 // timeouts for before each handshake leg from the peer.
781 TimeoutSchedule []time.Duration
782
783 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
784 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500785
786 // ReorderHandshakeFragments, if true, causes handshake fragments in
787 // DTLS to overlap and be sent in the wrong order. It also causes
788 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
789 // Finished and will trigger a spurious retransmit.)
790 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500791
David Benjamin61672812016-07-14 23:10:43 -0400792 // ReverseHandshakeFragments, if true, causes handshake fragments in
793 // DTLS to be reversed within a flight.
794 ReverseHandshakeFragments bool
795
David Benjamin75381222015-03-02 19:30:30 -0500796 // MixCompleteMessageWithFragments, if true, causes handshake
797 // messages in DTLS to redundantly both fragment the message
798 // and include a copy of the full one.
799 MixCompleteMessageWithFragments bool
800
David Benjaminddb9f152015-02-03 15:44:39 -0500801 // SendInvalidRecordType, if true, causes a record with an invalid
802 // content type to be sent immediately following the handshake.
803 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500804
David Benjamin0b8d5da2016-07-15 00:39:56 -0400805 // SendWrongMessageType, if non-zero, causes messages of the specified
806 // type to be sent with the wrong value.
807 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500808
David Benjamin639846e2016-09-09 11:41:18 -0400809 // SendTrailingMessageData, if non-zero, causes messages of the
810 // specified type to be sent with trailing data.
811 SendTrailingMessageData byte
812
David Benjamin75381222015-03-02 19:30:30 -0500813 // FragmentMessageTypeMismatch, if true, causes all non-initial
814 // handshake fragments in DTLS to have the wrong message type.
815 FragmentMessageTypeMismatch bool
816
817 // FragmentMessageLengthMismatch, if true, causes all non-initial
818 // handshake fragments in DTLS to have the wrong message length.
819 FragmentMessageLengthMismatch bool
820
David Benjamin11fc66a2015-06-16 11:40:24 -0400821 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
822 // to be split across two records. The value of |SplitFragments| is the
823 // number of bytes in the first fragment.
824 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500825
826 // SendEmptyFragments, if true, causes handshakes to include empty
827 // fragments in DTLS.
828 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400829
David Benjamin9a41d1b2015-05-16 01:30:09 -0400830 // SendSplitAlert, if true, causes an alert to be sent with the header
831 // and record body split across multiple packets. The peer should
832 // discard these packets rather than process it.
833 SendSplitAlert bool
834
David Benjamin4b27d9f2015-05-12 22:42:52 -0400835 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
836 // client offers a resumption or the server accepts one.
837 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400838
David Benjamin67d1fb52015-03-16 15:16:23 -0400839 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
840 // preferences to be ignored.
841 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400842
843 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
844 // signature algorithm preferences to be ignored.
845 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400846
David Benjaminc574f412015-04-20 11:13:01 -0400847 // IgnorePeerCurvePreferences, if true, causes the peer's curve
848 // preferences to be ignored.
849 IgnorePeerCurvePreferences bool
850
David Benjamin513f0ea2015-04-02 19:33:31 -0400851 // BadFinished, if true, causes the Finished hash to be broken.
852 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700853
854 // DHGroupPrime, if not nil, is used to define the (finite field)
855 // Diffie-Hellman group. The generator used is always two.
856 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400857
David Benjamin582ba042016-07-07 12:33:25 -0700858 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
859 // to be packed into individual handshake records, up to the specified
860 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400861 PackHandshakeFragments int
862
David Benjamin582ba042016-07-07 12:33:25 -0700863 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
864 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400865 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400866
David Benjamin582ba042016-07-07 12:33:25 -0700867 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
868 // be packed into records, up to the largest size record available.
869 PackHandshakeFlight bool
870
David Benjamin5ecb88b2016-10-04 17:51:35 -0400871 // AdvertiseAllConfiguredCiphers, if true, causes the client to
872 // advertise all configured cipher suite values.
873 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400874
875 // EmptyCertificateList, if true, causes the server to send an empty
876 // certificate list in the Certificate message.
877 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400878
879 // ExpectNewTicket, if true, causes the client to abort if it does not
880 // receive a new ticket.
881 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700882
883 // RequireClientHelloSize, if not zero, is the required length in bytes
884 // of the ClientHello /record/. This is checked by the server.
885 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700886
887 // CustomExtension, if not empty, contains the contents of an extension
888 // that will be added to client/server hellos.
889 CustomExtension string
890
David Benjamin490469f2016-10-05 22:44:38 -0400891 // CustomUnencryptedExtension, if not empty, contains the contents of
892 // an extension that will be added to ServerHello in TLS 1.3.
893 CustomUnencryptedExtension string
894
Adam Langley09505632015-07-30 18:10:13 -0700895 // ExpectedCustomExtension, if not nil, contains the expected contents
896 // of a custom extension.
897 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400898
David Benjamin1286bee2016-10-07 15:25:06 -0400899 // CustomTicketExtension, if not empty, contains the contents of an
900 // extension what will be added to NewSessionTicket in TLS 1.3.
901 CustomTicketExtension string
902
David Benjamin30789da2015-08-29 22:56:45 -0400903 // NoCloseNotify, if true, causes the close_notify alert to be skipped
904 // on connection shutdown.
905 NoCloseNotify bool
906
David Benjaminfa214e42016-05-10 17:03:10 -0400907 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
908 // close_notify on shutdown.
909 SendAlertOnShutdown alert
910
David Benjamin30789da2015-08-29 22:56:45 -0400911 // ExpectCloseNotify, if true, requires a close_notify from the peer on
912 // shutdown. Records from the peer received after close_notify is sent
913 // are not discard.
914 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400915
916 // SendLargeRecords, if true, allows outgoing records to be sent
917 // arbitrarily large.
918 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400919
920 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
921 // ALPN and NPN in the same connetion.
922 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400923
David Benjamin0c40a962016-08-01 12:05:50 -0400924 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400925 // string in the ALPN extension regardless of the content or presence of
926 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400927 SendALPN string
928
David Benjamin490469f2016-10-05 22:44:38 -0400929 // SendUnencryptedALPN, if non-empty, causes the server to send the
930 // specified string in a ServerHello ALPN extension in TLS 1.3.
931 SendUnencryptedALPN string
932
David Benjamindd6fed92015-10-23 17:41:12 -0400933 // SendEmptySessionTicket, if true, causes the server to send an empty
934 // session ticket.
935 SendEmptySessionTicket bool
936
Steven Valdez5b986082016-09-01 12:29:49 -0400937 // SnedPSKKeyExchangeModes, if present, determines the PSK key exchange modes
938 // to send.
939 SendPSKKeyExchangeModes []byte
940
941 // SendPSKAuthModes, if present, determines the PSK auth modes to send.
942 SendPSKAuthModes []byte
943
David Benjamindd6fed92015-10-23 17:41:12 -0400944 // FailIfSessionOffered, if true, causes the server to fail any
945 // connections where the client offers a non-empty session ID or session
946 // ticket.
947 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800948
949 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
950 // HelloRequest handshake message to be sent before each application
951 // data record. This only makes sense for a server.
952 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800953
David Benjamin71dd6662016-07-08 14:10:48 -0700954 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
955 // HelloRequest handshake message to be sent before each handshake
956 // message. This only makes sense for a server.
957 SendHelloRequestBeforeEveryHandshakeMessage bool
958
Steven Valdez1dc53d22016-07-26 12:27:38 -0400959 // SendKeyUpdateBeforeEveryAppDataRecord, if true, causes a KeyUpdate
960 // handshake message to be sent before each application data record.
961 SendKeyUpdateBeforeEveryAppDataRecord bool
962
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800963 // RequireDHPublicValueLen causes a fatal error if the length (in
964 // bytes) of the server's Diffie-Hellman public value is not equal to
965 // this.
966 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500967
968 // BadChangeCipherSpec, if not nil, is the body to be sent in
969 // ChangeCipherSpec records instead of {1}.
970 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -0500971
972 // BadHelloRequest, if not nil, is what to send instead of a
973 // HelloRequest.
974 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -0500975
976 // RequireSessionTickets, if true, causes the client to require new
977 // sessions use session tickets instead of session IDs.
978 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -0500979
980 // NullAllCiphers, if true, causes every cipher to behave like the null
981 // cipher.
982 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -0400983
984 // SendSCTListOnResume, if not nil, causes the server to send the
985 // supplied SCT list in resumption handshakes.
986 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -0700987
David Benjamindaa88502016-10-04 16:32:16 -0400988 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
989 // OCSP stapling in resumption handshakes and, if applicable, send the
990 // supplied stapled response.
991 SendOCSPResponseOnResume []byte
992
Matt Braithwaite54217e42016-06-13 13:03:47 -0700993 // CECPQ1BadX25519Part corrupts the X25519 part of a CECPQ1 key exchange, as
994 // a trivial proof that it is actually used.
995 CECPQ1BadX25519Part bool
996
997 // CECPQ1BadNewhopePart corrupts the Newhope part of a CECPQ1 key exchange,
998 // as a trivial proof that it is actually used.
999 CECPQ1BadNewhopePart bool
David Benjaminc9ae27c2016-06-24 22:56:37 -04001000
1001 // RecordPadding is the number of bytes of padding to add to each
1002 // encrypted record in TLS 1.3.
1003 RecordPadding int
1004
1005 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1006 // be missing their body and content type. Padding, if configured, is
1007 // still added.
1008 OmitRecordContents bool
1009
1010 // OuterRecordType, if non-zero, is the outer record type to use instead
1011 // of application data.
1012 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001013
1014 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1015 // with the given signature algorithm rather than the one negotiated.
1016 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001017
1018 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1019 // skipped.
1020 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001021
1022 // IgnoreSignatureVersionChecks, if true, causes all signature
1023 // algorithms to be enabled at all TLS versions.
1024 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001025
1026 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1027 // Renegotiation Info to be negotiated at all versions.
1028 NegotiateRenegotiationInfoAtAllVersions bool
1029
1030 // NegotiateChannelIDAtAllVersions, if true, causes Channel ID to be
1031 // negotiated at all versions.
1032 NegotiateChannelIDAtAllVersions bool
1033
1034 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1035 // all versions.
1036 NegotiateNPNAtAllVersions bool
1037
1038 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1039 // all versions.
1040 NegotiateEMSAtAllVersions bool
1041
1042 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1043 // advertised in server extensions
1044 AdvertiseTicketExtension bool
1045
Steven Valdez803c77a2016-09-06 14:13:43 -04001046 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1047 // resumption.
1048 NegotiatePSKResumption bool
1049
David Benjamin7f78df42016-10-05 22:33:19 -04001050 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1051 // always acknowledge a session, regardless of one was offered.
1052 AlwaysSelectPSKIdentity bool
1053
1054 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1055 // the specified PSK identity index rather than the actual value.
1056 SelectPSKIdentityOnResume uint16
1057
Steven Valdez803c77a2016-09-06 14:13:43 -04001058 // OmitServerHelloSignatureAlgorithms, if true, causes the server to omit the
1059 // signature_algorithms extension in the ServerHello.
1060 OmitServerHelloSignatureAlgorithms bool
1061
1062 // IncludeServerHelloSignatureAlgorithms, if true, causes the server to
1063 // include the signature_algorithms extension in all ServerHellos.
1064 IncludeServerHelloSignatureAlgorithms bool
1065
Steven Valdez143e8b32016-07-11 13:19:03 -04001066 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1067 // sending a key_share extension and use the zero ECDHE secret
1068 // instead.
1069 MissingKeyShare bool
1070
Steven Valdez5440fe02016-07-18 12:40:30 -04001071 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1072 // ClientHello to skip sending a key_share extension and use the zero
1073 // ECDHE secret instead.
1074 SecondClientHelloMissingKeyShare bool
1075
1076 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1077 // client to pretend the server requested a HelloRetryRequest with the
1078 // given curve rather than the actual one.
1079 MisinterpretHelloRetryRequestCurve CurveID
1080
Steven Valdez143e8b32016-07-11 13:19:03 -04001081 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1082 // copies of each KeyShareEntry.
1083 DuplicateKeyShares bool
1084
1085 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1086 // emit an empty EncryptedExtensions block.
1087 EmptyEncryptedExtensions bool
1088
1089 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1090 // include the KeyShare extension in the EncryptedExtensions block.
1091 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001092
1093 // UnnecessaryHelloRetryRequest, if true, causes the TLS 1.3 server to
1094 // send a HelloRetryRequest regardless of whether it needs to.
1095 UnnecessaryHelloRetryRequest bool
1096
1097 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1098 // two HelloRetryRequests instead of one.
1099 SecondHelloRetryRequest bool
1100
1101 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001102 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001103 SendServerHelloVersion uint16
1104
1105 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1106 // HelloRetryRequest.
1107 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001108
1109 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1110 // HelloRequest in the same record as Finished.
1111 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001112
David Benjamine73c7f42016-08-17 00:29:33 -04001113 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1114 // connection if the selected curve appears in the client's initial
1115 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1116 ExpectMissingKeyShare bool
1117
David Benjamin02edcd02016-07-27 17:40:37 -04001118 // SendExtraFinished, if true, causes an extra Finished message to be
1119 // sent.
1120 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001121
1122 // SendRequestContext, if not empty, is the request context to send in
1123 // a TLS 1.3 CertificateRequest.
1124 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001125
1126 // SendSNIWarningAlert, if true, causes the server to send an
1127 // unrecognized_name alert before the ServerHello.
1128 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001129
1130 // SendCompressionMethods, if not nil, is the compression method list to
1131 // send in the ClientHello.
1132 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001133
1134 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1135 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1136 // hint is empty.
1137 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001138
1139 // TrailingKeyShareData, if true, causes the client key share list to
1140 // include a trailing byte.
1141 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001142
1143 // InvalidChannelIDSignature, if true, causes the client to generate an
1144 // invalid Channel ID signature.
1145 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001146
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001147 // ExpectGREASE, if true, causes messages without GREASE values to be
1148 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001149 ExpectGREASE bool
Adam Langley95c29f32014-06-20 12:00:00 -07001150}
1151
1152func (c *Config) serverInit() {
1153 if c.SessionTicketsDisabled {
1154 return
1155 }
1156
1157 // If the key has already been set then we have nothing to do.
1158 for _, b := range c.SessionTicketKey {
1159 if b != 0 {
1160 return
1161 }
1162 }
1163
1164 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1165 c.SessionTicketsDisabled = true
1166 }
1167}
1168
1169func (c *Config) rand() io.Reader {
1170 r := c.Rand
1171 if r == nil {
1172 return rand.Reader
1173 }
1174 return r
1175}
1176
1177func (c *Config) time() time.Time {
1178 t := c.Time
1179 if t == nil {
1180 t = time.Now
1181 }
1182 return t()
1183}
1184
1185func (c *Config) cipherSuites() []uint16 {
1186 s := c.CipherSuites
1187 if s == nil {
1188 s = defaultCipherSuites()
1189 }
1190 return s
1191}
1192
David Benjamincecee272016-06-30 13:33:47 -04001193func (c *Config) minVersion(isDTLS bool) uint16 {
1194 ret := uint16(minVersion)
1195 if c != nil && c.MinVersion != 0 {
1196 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001197 }
David Benjamincecee272016-06-30 13:33:47 -04001198 if isDTLS {
1199 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1200 if ret < VersionTLS10 {
1201 return VersionTLS10
1202 }
1203 // There is no such thing as DTLS 1.1.
1204 if ret == VersionTLS11 {
1205 return VersionTLS12
1206 }
1207 }
1208 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001209}
1210
David Benjamincecee272016-06-30 13:33:47 -04001211func (c *Config) maxVersion(isDTLS bool) uint16 {
1212 ret := uint16(maxVersion)
1213 if c != nil && c.MaxVersion != 0 {
1214 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001215 }
David Benjamincecee272016-06-30 13:33:47 -04001216 if isDTLS {
1217 // We only implement up to DTLS 1.2.
1218 if ret > VersionTLS12 {
1219 return VersionTLS12
1220 }
1221 // There is no such thing as DTLS 1.1.
1222 if ret == VersionTLS11 {
1223 return VersionTLS10
1224 }
1225 }
1226 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001227}
1228
David Benjamincba2b622015-12-18 22:13:41 -05001229var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001230
1231func (c *Config) curvePreferences() []CurveID {
1232 if c == nil || len(c.CurvePreferences) == 0 {
1233 return defaultCurvePreferences
1234 }
1235 return c.CurvePreferences
1236}
1237
Nick Harperdcfbc672016-07-16 17:47:31 +02001238func (c *Config) defaultCurves() map[CurveID]bool {
1239 defaultCurves := make(map[CurveID]bool)
1240 curves := c.DefaultCurves
1241 if c == nil || c.DefaultCurves == nil {
1242 curves = c.curvePreferences()
1243 }
1244 for _, curveID := range curves {
1245 defaultCurves[curveID] = true
1246 }
1247 return defaultCurves
1248}
1249
Steven Valdezfdd10992016-09-15 16:27:05 -04001250// isSupportedVersion returns true if the specified protocol version is
1251// acceptable.
1252func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1253 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001254}
1255
1256// getCertificateForName returns the best certificate for the given name,
1257// defaulting to the first element of c.Certificates if there are no good
1258// options.
1259func (c *Config) getCertificateForName(name string) *Certificate {
1260 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1261 // There's only one choice, so no point doing any work.
1262 return &c.Certificates[0]
1263 }
1264
1265 name = strings.ToLower(name)
1266 for len(name) > 0 && name[len(name)-1] == '.' {
1267 name = name[:len(name)-1]
1268 }
1269
1270 if cert, ok := c.NameToCertificate[name]; ok {
1271 return cert
1272 }
1273
1274 // try replacing labels in the name with wildcards until we get a
1275 // match.
1276 labels := strings.Split(name, ".")
1277 for i := range labels {
1278 labels[i] = "*"
1279 candidate := strings.Join(labels, ".")
1280 if cert, ok := c.NameToCertificate[candidate]; ok {
1281 return cert
1282 }
1283 }
1284
1285 // If nothing matches, return the first certificate.
1286 return &c.Certificates[0]
1287}
1288
David Benjamin7a41d372016-07-09 11:21:54 -07001289func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1290 if c != nil && c.SignSignatureAlgorithms != nil {
1291 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001292 }
David Benjamin7a41d372016-07-09 11:21:54 -07001293 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001294}
1295
David Benjamin7a41d372016-07-09 11:21:54 -07001296func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1297 if c != nil && c.VerifySignatureAlgorithms != nil {
1298 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001299 }
David Benjamin7a41d372016-07-09 11:21:54 -07001300 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001301}
1302
Adam Langley95c29f32014-06-20 12:00:00 -07001303// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1304// from the CommonName and SubjectAlternateName fields of each of the leaf
1305// certificates.
1306func (c *Config) BuildNameToCertificate() {
1307 c.NameToCertificate = make(map[string]*Certificate)
1308 for i := range c.Certificates {
1309 cert := &c.Certificates[i]
1310 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1311 if err != nil {
1312 continue
1313 }
1314 if len(x509Cert.Subject.CommonName) > 0 {
1315 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1316 }
1317 for _, san := range x509Cert.DNSNames {
1318 c.NameToCertificate[san] = cert
1319 }
1320 }
1321}
1322
1323// A Certificate is a chain of one or more certificates, leaf first.
1324type Certificate struct {
1325 Certificate [][]byte
1326 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1327 // OCSPStaple contains an optional OCSP response which will be served
1328 // to clients that request it.
1329 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001330 // SignedCertificateTimestampList contains an optional encoded
1331 // SignedCertificateTimestampList structure which will be
1332 // served to clients that request it.
1333 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001334 // Leaf is the parsed form of the leaf certificate, which may be
1335 // initialized using x509.ParseCertificate to reduce per-handshake
1336 // processing for TLS clients doing client authentication. If nil, the
1337 // leaf certificate will be parsed as needed.
1338 Leaf *x509.Certificate
1339}
1340
1341// A TLS record.
1342type record struct {
1343 contentType recordType
1344 major, minor uint8
1345 payload []byte
1346}
1347
1348type handshakeMessage interface {
1349 marshal() []byte
1350 unmarshal([]byte) bool
1351}
1352
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001353// lruSessionCache is a client or server session cache implementation
1354// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001355type lruSessionCache struct {
1356 sync.Mutex
1357
1358 m map[string]*list.Element
1359 q *list.List
1360 capacity int
1361}
1362
1363type lruSessionCacheEntry struct {
1364 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001365 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001366}
1367
1368// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001369func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001370 c.Lock()
1371 defer c.Unlock()
1372
1373 if elem, ok := c.m[sessionKey]; ok {
1374 entry := elem.Value.(*lruSessionCacheEntry)
1375 entry.state = cs
1376 c.q.MoveToFront(elem)
1377 return
1378 }
1379
1380 if c.q.Len() < c.capacity {
1381 entry := &lruSessionCacheEntry{sessionKey, cs}
1382 c.m[sessionKey] = c.q.PushFront(entry)
1383 return
1384 }
1385
1386 elem := c.q.Back()
1387 entry := elem.Value.(*lruSessionCacheEntry)
1388 delete(c.m, entry.sessionKey)
1389 entry.sessionKey = sessionKey
1390 entry.state = cs
1391 c.q.MoveToFront(elem)
1392 c.m[sessionKey] = elem
1393}
1394
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001395// Get returns the value associated with a given key. It returns (nil,
1396// false) if no value is found.
1397func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001398 c.Lock()
1399 defer c.Unlock()
1400
1401 if elem, ok := c.m[sessionKey]; ok {
1402 c.q.MoveToFront(elem)
1403 return elem.Value.(*lruSessionCacheEntry).state, true
1404 }
1405 return nil, false
1406}
1407
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001408// lruClientSessionCache is a ClientSessionCache implementation that
1409// uses an LRU caching strategy.
1410type lruClientSessionCache struct {
1411 lruSessionCache
1412}
1413
1414func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1415 c.lruSessionCache.Put(sessionKey, cs)
1416}
1417
1418func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1419 cs, ok := c.lruSessionCache.Get(sessionKey)
1420 if !ok {
1421 return nil, false
1422 }
1423 return cs.(*ClientSessionState), true
1424}
1425
1426// lruServerSessionCache is a ServerSessionCache implementation that
1427// uses an LRU caching strategy.
1428type lruServerSessionCache struct {
1429 lruSessionCache
1430}
1431
1432func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1433 c.lruSessionCache.Put(sessionId, session)
1434}
1435
1436func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1437 cs, ok := c.lruSessionCache.Get(sessionId)
1438 if !ok {
1439 return nil, false
1440 }
1441 return cs.(*sessionState), true
1442}
1443
1444// NewLRUClientSessionCache returns a ClientSessionCache with the given
1445// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1446// is used instead.
1447func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1448 const defaultSessionCacheCapacity = 64
1449
1450 if capacity < 1 {
1451 capacity = defaultSessionCacheCapacity
1452 }
1453 return &lruClientSessionCache{
1454 lruSessionCache{
1455 m: make(map[string]*list.Element),
1456 q: list.New(),
1457 capacity: capacity,
1458 },
1459 }
1460}
1461
1462// NewLRUServerSessionCache returns a ServerSessionCache with the given
1463// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1464// is used instead.
1465func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1466 const defaultSessionCacheCapacity = 64
1467
1468 if capacity < 1 {
1469 capacity = defaultSessionCacheCapacity
1470 }
1471 return &lruServerSessionCache{
1472 lruSessionCache{
1473 m: make(map[string]*list.Element),
1474 q: list.New(),
1475 capacity: capacity,
1476 },
1477 }
1478}
1479
Adam Langley95c29f32014-06-20 12:00:00 -07001480// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1481type dsaSignature struct {
1482 R, S *big.Int
1483}
1484
1485type ecdsaSignature dsaSignature
1486
1487var emptyConfig Config
1488
1489func defaultConfig() *Config {
1490 return &emptyConfig
1491}
1492
1493var (
1494 once sync.Once
1495 varDefaultCipherSuites []uint16
1496)
1497
1498func defaultCipherSuites() []uint16 {
1499 once.Do(initDefaultCipherSuites)
1500 return varDefaultCipherSuites
1501}
1502
1503func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001504 for _, suite := range cipherSuites {
1505 if suite.flags&suitePSK == 0 {
1506 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1507 }
Adam Langley95c29f32014-06-20 12:00:00 -07001508 }
1509}
1510
1511func unexpectedMessageError(wanted, got interface{}) error {
1512 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1513}
David Benjamin000800a2014-11-14 01:43:59 -05001514
Nick Harper60edffd2016-06-21 15:19:24 -07001515func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1516 for _, s := range sigAlgs {
1517 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001518 return true
1519 }
1520 }
1521 return false
1522}
Nick Harper85f20c22016-07-04 10:11:59 -07001523
1524var (
1525 // See draft-ietf-tls-tls13-13, section 6.3.1.2.
1526 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1527 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1528)