blob: 921b03b41637de054e2c67de6d141a03f9606a53 [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.
David Benjamina128a552016-10-13 14:26:33 -040030const tls13DraftVersion = 0x7f10
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
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
David Benjamina128a552016-10-13 14:26:33 -0400197// PskKeyExchangeMode values (see draft-ietf-tls-tls13-16)
David Benjamin58104882016-07-18 01:25:41 +0200198const (
Steven Valdez5b986082016-09-01 12:29:49 -0400199 pskKEMode = 0
200 pskDHEKEMode = 1
201)
202
David Benjamina128a552016-10-13 14:26:33 -0400203// PskAuthenticationMode values (see draft-ietf-tls-tls13-16)
Steven Valdez5b986082016-09-01 12:29:49 -0400204const (
205 pskAuthMode = 0
206 pskSignAuthMode = 1
David Benjamin58104882016-07-18 01:25:41 +0200207)
208
Steven Valdezc4aa7272016-10-03 12:25:56 -0400209// KeyUpdateRequest values (see draft-ietf-tls-tls13-16, section 4.5.3)
210const (
211 keyUpdateNotRequested = 0
212 keyUpdateRequested = 1
213)
214
Adam Langley95c29f32014-06-20 12:00:00 -0700215// ConnectionState records basic TLS details about the connection.
216type ConnectionState struct {
217 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
218 HandshakeComplete bool // TLS handshake is complete
219 DidResume bool // connection resumes a previous TLS connection
220 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
221 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
222 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400223 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700224 ServerName string // server name requested by client, if any (server side only)
225 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
226 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400227 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500228 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
David Benjaminc0577622015-09-12 18:28:38 -0400229 TLSUnique []byte // the tls-unique channel binding
Paul Lietar4fac72e2015-09-09 13:44:55 +0100230 SCTList []byte // signed certificate timestamp list
Nick Harper60edffd2016-06-21 15:19:24 -0700231 PeerSignatureAlgorithm signatureAlgorithm // algorithm used by the peer in the handshake
Steven Valdez5440fe02016-07-18 12:40:30 -0400232 CurveID CurveID // the curve used in ECDHE
Adam Langley95c29f32014-06-20 12:00:00 -0700233}
234
235// ClientAuthType declares the policy the server will follow for
236// TLS Client Authentication.
237type ClientAuthType int
238
239const (
240 NoClientCert ClientAuthType = iota
241 RequestClientCert
242 RequireAnyClientCert
243 VerifyClientCertIfGiven
244 RequireAndVerifyClientCert
245)
246
247// ClientSessionState contains the state needed by clients to resume TLS
248// sessions.
249type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500250 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700251 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
252 vers uint16 // SSL/TLS version negotiated for the session
253 cipherSuite uint16 // Ciphersuite negotiated for the session
254 masterSecret []byte // MasterSecret generated by client on a full handshake
255 handshakeHash []byte // Handshake hash for Channel ID purposes.
256 serverCertificates []*x509.Certificate // Certificate chain presented by the server
257 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Paul Lietar62be8ac2015-09-16 10:03:30 +0100258 sctList []byte
259 ocspResponse []byte
Nick Harper0b3625b2016-07-25 16:16:28 -0700260 ticketCreationTime time.Time
261 ticketExpiration time.Time
Adam Langley95c29f32014-06-20 12:00:00 -0700262}
263
264// ClientSessionCache is a cache of ClientSessionState objects that can be used
265// by a client to resume a TLS session with a given server. ClientSessionCache
266// implementations should expect to be called concurrently from different
267// goroutines.
268type ClientSessionCache interface {
269 // Get searches for a ClientSessionState associated with the given key.
270 // On return, ok is true if one was found.
271 Get(sessionKey string) (session *ClientSessionState, ok bool)
272
273 // Put adds the ClientSessionState to the cache with the given key.
274 Put(sessionKey string, cs *ClientSessionState)
275}
276
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500277// ServerSessionCache is a cache of sessionState objects that can be used by a
278// client to resume a TLS session with a given server. ServerSessionCache
279// implementations should expect to be called concurrently from different
280// goroutines.
281type ServerSessionCache interface {
282 // Get searches for a sessionState associated with the given session
283 // ID. On return, ok is true if one was found.
284 Get(sessionId string) (session *sessionState, ok bool)
285
286 // Put adds the sessionState to the cache with the given session ID.
287 Put(sessionId string, session *sessionState)
288}
289
Adam Langley95c29f32014-06-20 12:00:00 -0700290// A Config structure is used to configure a TLS client or server.
291// After one has been passed to a TLS function it must not be
292// modified. A Config may be reused; the tls package will also not
293// modify it.
294type Config struct {
295 // Rand provides the source of entropy for nonces and RSA blinding.
296 // If Rand is nil, TLS uses the cryptographic random reader in package
297 // crypto/rand.
298 // The Reader must be safe for use by multiple goroutines.
299 Rand io.Reader
300
301 // Time returns the current time as the number of seconds since the epoch.
302 // If Time is nil, TLS uses time.Now.
303 Time func() time.Time
304
305 // Certificates contains one or more certificate chains
306 // to present to the other side of the connection.
307 // Server configurations must include at least one certificate.
308 Certificates []Certificate
309
310 // NameToCertificate maps from a certificate name to an element of
311 // Certificates. Note that a certificate name can be of the form
312 // '*.example.com' and so doesn't have to be a domain name as such.
313 // See Config.BuildNameToCertificate
314 // The nil value causes the first element of Certificates to be used
315 // for all connections.
316 NameToCertificate map[string]*Certificate
317
318 // RootCAs defines the set of root certificate authorities
319 // that clients use when verifying server certificates.
320 // If RootCAs is nil, TLS uses the host's root CA set.
321 RootCAs *x509.CertPool
322
323 // NextProtos is a list of supported, application level protocols.
324 NextProtos []string
325
326 // ServerName is used to verify the hostname on the returned
327 // certificates unless InsecureSkipVerify is given. It is also included
328 // in the client's handshake to support virtual hosting.
329 ServerName string
330
331 // ClientAuth determines the server's policy for
332 // TLS Client Authentication. The default is NoClientCert.
333 ClientAuth ClientAuthType
334
335 // ClientCAs defines the set of root certificate authorities
336 // that servers use if required to verify a client certificate
337 // by the policy in ClientAuth.
338 ClientCAs *x509.CertPool
339
David Benjamin7b030512014-07-08 17:30:11 -0400340 // ClientCertificateTypes defines the set of allowed client certificate
341 // types. The default is CertTypeRSASign and CertTypeECDSASign.
342 ClientCertificateTypes []byte
343
Adam Langley95c29f32014-06-20 12:00:00 -0700344 // InsecureSkipVerify controls whether a client verifies the
345 // server's certificate chain and host name.
346 // If InsecureSkipVerify is true, TLS accepts any certificate
347 // presented by the server and any host name in that certificate.
348 // In this mode, TLS is susceptible to man-in-the-middle attacks.
349 // This should be used only for testing.
350 InsecureSkipVerify bool
351
352 // CipherSuites is a list of supported cipher suites. If CipherSuites
353 // is nil, TLS uses a list of suites supported by the implementation.
354 CipherSuites []uint16
355
356 // PreferServerCipherSuites controls whether the server selects the
357 // client's most preferred ciphersuite, or the server's most preferred
358 // ciphersuite. If true then the server's preference, as expressed in
359 // the order of elements in CipherSuites, is used.
360 PreferServerCipherSuites bool
361
362 // SessionTicketsDisabled may be set to true to disable session ticket
363 // (resumption) support.
364 SessionTicketsDisabled bool
365
366 // SessionTicketKey is used by TLS servers to provide session
367 // resumption. See RFC 5077. If zero, it will be filled with
368 // random data before the first server handshake.
369 //
370 // If multiple servers are terminating connections for the same host
371 // they should all have the same SessionTicketKey. If the
372 // SessionTicketKey leaks, previously recorded and future TLS
373 // connections using that key are compromised.
374 SessionTicketKey [32]byte
375
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500376 // ClientSessionCache is a cache of ClientSessionState entries
377 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700378 ClientSessionCache ClientSessionCache
379
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500380 // ServerSessionCache is a cache of sessionState entries for TLS session
381 // resumption.
382 ServerSessionCache ServerSessionCache
383
Adam Langley95c29f32014-06-20 12:00:00 -0700384 // MinVersion contains the minimum SSL/TLS version that is acceptable.
385 // If zero, then SSLv3 is taken as the minimum.
386 MinVersion uint16
387
388 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
389 // If zero, then the maximum version supported by this package is used,
390 // which is currently TLS 1.2.
391 MaxVersion uint16
392
393 // CurvePreferences contains the elliptic curves that will be used in
394 // an ECDHE handshake, in preference order. If empty, the default will
395 // be used.
396 CurvePreferences []CurveID
397
Nick Harperdcfbc672016-07-16 17:47:31 +0200398 // DefaultCurves contains the elliptic curves for which public values will
399 // be sent in the ClientHello's KeyShare extension. If this value is nil,
400 // all supported curves will have public values sent. This field is ignored
401 // on servers.
402 DefaultCurves []CurveID
403
David Benjamind30a9902014-08-24 01:44:23 -0400404 // ChannelID contains the ECDSA key for the client to use as
405 // its TLS Channel ID.
406 ChannelID *ecdsa.PrivateKey
407
408 // RequestChannelID controls whether the server requests a TLS
409 // Channel ID. If negotiated, the client's public key is
410 // returned in the ConnectionState.
411 RequestChannelID bool
412
David Benjamin48cae082014-10-27 01:06:24 -0400413 // PreSharedKey, if not nil, is the pre-shared key to use with
414 // the PSK cipher suites.
415 PreSharedKey []byte
416
417 // PreSharedKeyIdentity, if not empty, is the identity to use
418 // with the PSK cipher suites.
419 PreSharedKeyIdentity string
420
David Benjaminca6c8262014-11-15 19:06:08 -0500421 // SRTPProtectionProfiles, if not nil, is the list of SRTP
422 // protection profiles to offer in DTLS-SRTP.
423 SRTPProtectionProfiles []uint16
424
David Benjamin7a41d372016-07-09 11:21:54 -0700425 // SignSignatureAlgorithms, if not nil, overrides the default set of
426 // supported signature algorithms to sign with.
427 SignSignatureAlgorithms []signatureAlgorithm
428
429 // VerifySignatureAlgorithms, if not nil, overrides the default set of
430 // supported signature algorithms that are accepted.
431 VerifySignatureAlgorithms []signatureAlgorithm
David Benjamin000800a2014-11-14 01:43:59 -0500432
Adam Langley95c29f32014-06-20 12:00:00 -0700433 // Bugs specifies optional misbehaviour to be used for testing other
434 // implementations.
435 Bugs ProtocolBugs
436
437 serverInitOnce sync.Once // guards calling (*Config).serverInit
438}
439
440type BadValue int
441
442const (
443 BadValueNone BadValue = iota
444 BadValueNegative
445 BadValueZero
446 BadValueLimit
447 BadValueLarge
448 NumBadValues
449)
450
David Benjaminb36a3952015-12-01 18:53:13 -0500451type RSABadValue int
452
453const (
454 RSABadValueNone RSABadValue = iota
455 RSABadValueCorrupt
456 RSABadValueTooLong
457 RSABadValueTooShort
458 RSABadValueWrongVersion
459 NumRSABadValues
460)
461
Adam Langley95c29f32014-06-20 12:00:00 -0700462type ProtocolBugs struct {
David Benjamin5208fd42016-07-13 21:43:25 -0400463 // InvalidSignature specifies that the signature in a ServerKeyExchange
464 // or CertificateVerify message should be invalid.
465 InvalidSignature bool
David Benjamin6de0e532015-07-28 22:43:19 -0400466
Steven Valdez5440fe02016-07-18 12:40:30 -0400467 // SendCurve, if non-zero, causes the server to send the specified curve
468 // ID in ServerKeyExchange (TLS 1.2) or ServerHello (TLS 1.3) rather
469 // than the negotiated one.
David Benjamin4c3ddf72016-06-29 18:13:53 -0400470 SendCurve CurveID
Adam Langley95c29f32014-06-20 12:00:00 -0700471
David Benjamin2b07fa42016-03-02 00:23:57 -0500472 // InvalidECDHPoint, if true, causes the ECC points in
473 // ServerKeyExchange or ClientKeyExchange messages to be invalid.
474 InvalidECDHPoint bool
475
Adam Langley95c29f32014-06-20 12:00:00 -0700476 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
477 // can be invalid.
478 BadECDSAR BadValue
479 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700480
481 // MaxPadding causes CBC records to have the maximum possible padding.
482 MaxPadding bool
483 // PaddingFirstByteBad causes the first byte of the padding to be
484 // incorrect.
485 PaddingFirstByteBad bool
486 // PaddingFirstByteBadIf255 causes the first byte of padding to be
487 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
488 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700489
490 // FailIfNotFallbackSCSV causes a server handshake to fail if the
491 // client doesn't send the fallback SCSV value.
492 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400493
494 // DuplicateExtension causes an extra empty extension of bogus type to
495 // be emitted in either the ClientHello or the ServerHello.
496 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400497
498 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
499 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
500 // Certificate message is sent and no signature is added to
501 // ServerKeyExchange.
502 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400503
David Benjaminb80168e2015-02-08 18:30:14 -0500504 // SkipHelloVerifyRequest causes a DTLS server to skip the
505 // HelloVerifyRequest message.
506 SkipHelloVerifyRequest bool
507
David Benjamindcd979f2015-04-20 18:26:52 -0400508 // SkipCertificateStatus, if true, causes the server to skip the
509 // CertificateStatus message. This is legal because CertificateStatus is
510 // optional, even with a status_request in ServerHello.
511 SkipCertificateStatus bool
512
David Benjamin9c651c92014-07-12 13:27:45 -0400513 // SkipServerKeyExchange causes the server to skip sending
514 // ServerKeyExchange messages.
515 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400516
David Benjaminb80168e2015-02-08 18:30:14 -0500517 // SkipNewSessionTicket causes the server to skip sending the
518 // NewSessionTicket message despite promising to in ServerHello.
519 SkipNewSessionTicket bool
520
David Benjamin0b7ca7d2016-03-10 15:44:22 -0500521 // SkipClientCertificate causes the client to skip the Certificate
522 // message.
523 SkipClientCertificate bool
524
David Benjamina0e52232014-07-19 17:39:58 -0400525 // SkipChangeCipherSpec causes the implementation to skip
526 // sending the ChangeCipherSpec message (and adjusting cipher
527 // state accordingly for the Finished message).
528 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400529
David Benjaminb80168e2015-02-08 18:30:14 -0500530 // SkipFinished causes the implementation to skip sending the Finished
531 // message.
532 SkipFinished bool
533
David Benjaminf3ec83d2014-07-21 22:42:34 -0400534 // EarlyChangeCipherSpec causes the client to send an early
535 // ChangeCipherSpec message before the ClientKeyExchange. A value of
536 // zero disables this behavior. One and two configure variants for 0.9.8
537 // and 1.0.1 modes, respectively.
538 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400539
David Benjamin8144f992016-06-22 17:05:13 -0400540 // StrayChangeCipherSpec causes every pre-ChangeCipherSpec handshake
541 // message in DTLS to be prefaced by stray ChangeCipherSpec record. This
542 // may be used to test DTLS's handling of reordered ChangeCipherSpec.
543 StrayChangeCipherSpec bool
544
David Benjamin86271ee2014-07-21 16:14:03 -0400545 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
546 // the Finished (or NextProto) message around the ChangeCipherSpec
547 // messages.
548 FragmentAcrossChangeCipherSpec bool
549
David Benjamin61672812016-07-14 23:10:43 -0400550 // SendUnencryptedFinished, if true, causes the Finished message to be
551 // send unencrypted before ChangeCipherSpec rather than after it.
552 SendUnencryptedFinished bool
553
David Benjamin7964b182016-07-14 23:36:30 -0400554 // PartialEncryptedExtensionsWithServerHello, if true, causes the TLS
555 // 1.3 server to send part of EncryptedExtensions unencrypted
556 // in the same record as ServerHello.
557 PartialEncryptedExtensionsWithServerHello bool
558
559 // PartialClientFinishedWithClientHello, if true, causes the TLS 1.3
560 // client to send part of Finished unencrypted in the same record as
561 // ClientHello.
562 PartialClientFinishedWithClientHello bool
563
David Benjamind86c7672014-08-02 04:07:12 -0400564 // SendV2ClientHello causes the client to send a V2ClientHello
565 // instead of a normal ClientHello.
566 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400567
568 // SendFallbackSCSV causes the client to include
569 // TLS_FALLBACK_SCSV in the ClientHello.
570 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400571
Adam Langley5021b222015-06-12 18:27:58 -0700572 // SendRenegotiationSCSV causes the client to include the renegotiation
573 // SCSV in the ClientHello.
574 SendRenegotiationSCSV bool
575
David Benjamin43ec06f2014-08-05 02:28:57 -0400576 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400577 // handshake record. Handshake messages will be split into multiple
578 // records at the specified size, except that the client_version will
David Benjaminbd15a8e2015-05-29 18:48:16 -0400579 // never be fragmented. For DTLS, it is the maximum handshake fragment
580 // size, not record size; DTLS allows multiple handshake fragments in a
581 // single handshake record. See |PackHandshakeFragments|.
David Benjamin43ec06f2014-08-05 02:28:57 -0400582 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400583
David Benjamin98214542014-08-07 18:02:39 -0400584 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
585 // the first 6 bytes of the ClientHello.
586 FragmentClientVersion bool
587
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400588 // FragmentAlert will cause all alerts to be fragmented across
589 // two records.
590 FragmentAlert bool
591
David Benjamin0d3a8c62016-03-11 22:25:18 -0500592 // DoubleAlert will cause all alerts to be sent as two copies packed
593 // within one record.
594 DoubleAlert bool
595
David Benjamin3fd1fbd2015-02-03 16:07:32 -0500596 // SendSpuriousAlert, if non-zero, will cause an spurious, unwanted
597 // alert to be sent.
598 SendSpuriousAlert alert
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400599
David Benjaminb36a3952015-12-01 18:53:13 -0500600 // BadRSAClientKeyExchange causes the client to send a corrupted RSA
601 // ClientKeyExchange which would not pass padding checks.
602 BadRSAClientKeyExchange RSABadValue
David Benjaminbed9aae2014-08-07 19:13:38 -0400603
604 // RenewTicketOnResume causes the server to renew the session ticket and
605 // send a NewSessionTicket message during an abbreviated handshake.
606 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400607
David Benjamin3c6a1ea2016-09-26 18:30:05 -0400608 // SendClientVersion, if non-zero, causes the client to send the
609 // specified value in the ClientHello version field.
David Benjamin98e882e2014-08-08 13:24:34 -0400610 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400611
Steven Valdezfdd10992016-09-15 16:27:05 -0400612 // OmitSupportedVersions, if true, causes the client to omit the
613 // supported versions extension.
614 OmitSupportedVersions bool
615
616 // SendSupportedVersions, if non-empty, causes the client to send a
617 // supported versions extension with the values from array.
618 SendSupportedVersions []uint16
619
David Benjamin1f61f0d2016-07-10 12:20:35 -0400620 // NegotiateVersion, if non-zero, causes the server to negotiate the
621 // specifed TLS version rather than the version supported by either
622 // peer.
623 NegotiateVersion uint16
624
David Benjamine7e36aa2016-08-08 12:39:41 -0400625 // NegotiateVersionOnRenego, if non-zero, causes the server to negotiate
626 // the specified TLS version on renegotiation rather than retaining it.
627 NegotiateVersionOnRenego uint16
628
David Benjamine58c4f52014-08-24 03:47:07 -0400629 // ExpectFalseStart causes the server to, on full handshakes,
630 // expect the peer to False Start; the server Finished message
631 // isn't sent until we receive an application data record
632 // from the peer.
633 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400634
David Benjamin1c633152015-04-02 20:19:11 -0400635 // AlertBeforeFalseStartTest, if non-zero, causes the server to, on full
636 // handshakes, send an alert just before reading the application data
637 // record to test False Start. This can be used in a negative False
638 // Start test to determine whether the peer processed the alert (and
639 // closed the connection) before or after sending app data.
640 AlertBeforeFalseStartTest alert
641
David Benjamine78bfde2014-09-06 12:45:15 -0400642 // ExpectServerName, if not empty, is the hostname the client
643 // must specify in the server_name extension.
644 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400645
David Benjamin76c2efc2015-08-31 14:24:29 -0400646 // SwapNPNAndALPN switches the relative order between NPN and ALPN in
647 // both ClientHello and ServerHello.
David Benjaminfc7b0862014-09-06 13:21:53 -0400648 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400649
Adam Langleyefb0e162015-07-09 11:35:04 -0700650 // ALPNProtocol, if not nil, sets the ALPN protocol that a server will
651 // return.
652 ALPNProtocol *string
653
David Benjamin405da482016-08-08 17:25:07 -0400654 // AcceptAnySession causes the server to resume sessions regardless of
655 // the version associated with the session or cipher suite. It also
656 // causes the server to look in both TLS 1.2 and 1.3 extensions to
657 // process a ticket.
658 AcceptAnySession bool
659
660 // SendBothTickets, if true, causes the client to send tickets in both
661 // TLS 1.2 and 1.3 extensions.
662 SendBothTickets bool
Adam Langley38311732014-10-16 19:04:35 -0700663
664 // CorruptTicket causes a client to corrupt a session ticket before
665 // sending it in a resume handshake.
666 CorruptTicket bool
667
668 // OversizedSessionId causes the session id that is sent with a ticket
669 // resumption attempt to be too large (33 bytes).
670 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700671
David Benjamin405da482016-08-08 17:25:07 -0400672 // ExpectNoTLS12Session, if true, causes the server to fail the
673 // connection if either a session ID or TLS 1.2 ticket is offered.
674 ExpectNoTLS12Session bool
675
676 // ExpectNoTLS13PSK, if true, causes the server to fail the connection
677 // if a TLS 1.3 PSK is offered.
678 ExpectNoTLS13PSK bool
679
Adam Langley75712922014-10-10 16:23:43 -0700680 // RequireExtendedMasterSecret, if true, requires that the peer support
681 // the extended master secret option.
682 RequireExtendedMasterSecret bool
683
David Benjaminca6554b2014-11-08 12:31:52 -0500684 // NoExtendedMasterSecret causes the client and server to behave as if
David Benjamin163c9562016-08-29 23:14:17 -0400685 // they didn't support an extended master secret in the initial
686 // handshake.
Adam Langley75712922014-10-10 16:23:43 -0700687 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700688
David Benjamin163c9562016-08-29 23:14:17 -0400689 // NoExtendedMasterSecretOnRenegotiation causes the client and server to
690 // behave as if they didn't support an extended master secret in
691 // renegotiation handshakes.
692 NoExtendedMasterSecretOnRenegotiation bool
693
Adam Langley2ae77d22014-10-28 17:29:33 -0700694 // EmptyRenegotiationInfo causes the renegotiation extension to be
695 // empty in a renegotiation handshake.
696 EmptyRenegotiationInfo bool
697
698 // BadRenegotiationInfo causes the renegotiation extension value in a
699 // renegotiation handshake to be incorrect.
700 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500701
David Benjamin3e052de2015-11-25 20:10:31 -0500702 // NoRenegotiationInfo disables renegotiation info support in all
703 // handshakes.
David Benjaminca6554b2014-11-08 12:31:52 -0500704 NoRenegotiationInfo bool
705
David Benjamin3e052de2015-11-25 20:10:31 -0500706 // NoRenegotiationInfoInInitial disables renegotiation info support in
707 // the initial handshake.
708 NoRenegotiationInfoInInitial bool
709
710 // NoRenegotiationInfoAfterInitial disables renegotiation info support
711 // in renegotiation handshakes.
712 NoRenegotiationInfoAfterInitial bool
713
Adam Langley5021b222015-06-12 18:27:58 -0700714 // RequireRenegotiationInfo, if true, causes the client to return an
715 // error if the server doesn't reply with the renegotiation extension.
716 RequireRenegotiationInfo bool
717
David Benjamin8e6db492015-07-25 18:29:23 -0400718 // SequenceNumberMapping, if non-nil, is the mapping function to apply
719 // to the sequence number of outgoing packets. For both TLS and DTLS,
720 // the two most-significant bytes in the resulting sequence number are
721 // ignored so that the DTLS epoch cannot be changed.
722 SequenceNumberMapping func(uint64) uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500723
David Benjamina3e89492015-02-26 15:16:22 -0500724 // RSAEphemeralKey, if true, causes the server to send a
725 // ServerKeyExchange message containing an ephemeral key (as in
726 // RSA_EXPORT) in the plain RSA key exchange.
727 RSAEphemeralKey bool
David Benjaminca6c8262014-11-15 19:06:08 -0500728
729 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
730 // client offers when negotiating SRTP. MKI support is still missing so
731 // the peer must still send none.
732 SRTPMasterKeyIdentifer string
733
734 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
735 // server sends in the ServerHello instead of the negotiated one.
736 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500737
Nick Harper60edffd2016-06-21 15:19:24 -0700738 // NoSignatureAlgorithms, if true, causes the client to omit the
David Benjamin000800a2014-11-14 01:43:59 -0500739 // signature and hashes extension.
740 //
741 // For a server, it will cause an empty list to be sent in the
742 // CertificateRequest message. None the less, the configured set will
743 // still be enforced.
Nick Harper60edffd2016-06-21 15:19:24 -0700744 NoSignatureAlgorithms bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500745
David Benjamin55a43642015-04-20 14:45:55 -0400746 // NoSupportedCurves, if true, causes the client to omit the
747 // supported_curves extension.
748 NoSupportedCurves bool
749
David Benjaminc44b1df2014-11-23 12:11:01 -0500750 // RequireSameRenegoClientVersion, if true, causes the server
751 // to require that all ClientHellos match in offered version
752 // across a renego.
753 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800754
David Benjaminb1dd8cd2016-09-26 19:20:48 -0400755 // ExpectInitialRecordVersion, if non-zero, is the expected value of
756 // record-layer version field before the version is determined.
David Benjamin1e29a6b2014-12-10 02:27:24 -0500757 ExpectInitialRecordVersion uint16
David Benjamin13be1de2015-01-11 16:29:36 -0500758
759 // MaxPacketLength, if non-zero, is the maximum acceptable size for a
760 // packet.
761 MaxPacketLength int
David Benjamin6095de82014-12-27 01:50:38 -0500762
763 // SendCipherSuite, if non-zero, is the cipher suite value that the
764 // server will send in the ServerHello. This does not affect the cipher
765 // the server believes it has actually negotiated.
766 SendCipherSuite uint16
David Benjamin4189bd92015-01-25 23:52:39 -0500767
David Benjamin4cf369b2015-08-22 01:35:43 -0400768 // AppDataBeforeHandshake, if not nil, causes application data to be
769 // sent immediately before the first handshake message.
770 AppDataBeforeHandshake []byte
771
772 // AppDataAfterChangeCipherSpec, if not nil, causes application data to
David Benjamin4189bd92015-01-25 23:52:39 -0500773 // be sent immediately after ChangeCipherSpec.
774 AppDataAfterChangeCipherSpec []byte
David Benjamin83f90402015-01-27 01:09:43 -0500775
David Benjamindc3da932015-03-12 15:09:02 -0400776 // AlertAfterChangeCipherSpec, if non-zero, causes an alert to be sent
777 // immediately after ChangeCipherSpec.
778 AlertAfterChangeCipherSpec alert
779
David Benjamin83f90402015-01-27 01:09:43 -0500780 // TimeoutSchedule is the schedule of packet drops and simulated
781 // timeouts for before each handshake leg from the peer.
782 TimeoutSchedule []time.Duration
783
784 // PacketAdaptor is the packetAdaptor to use to simulate timeouts.
785 PacketAdaptor *packetAdaptor
David Benjaminb3774b92015-01-31 17:16:01 -0500786
787 // ReorderHandshakeFragments, if true, causes handshake fragments in
788 // DTLS to overlap and be sent in the wrong order. It also causes
789 // pre-CCS flights to be sent twice. (Post-CCS flights consist of
790 // Finished and will trigger a spurious retransmit.)
791 ReorderHandshakeFragments bool
David Benjaminddb9f152015-02-03 15:44:39 -0500792
David Benjamin61672812016-07-14 23:10:43 -0400793 // ReverseHandshakeFragments, if true, causes handshake fragments in
794 // DTLS to be reversed within a flight.
795 ReverseHandshakeFragments bool
796
David Benjamin75381222015-03-02 19:30:30 -0500797 // MixCompleteMessageWithFragments, if true, causes handshake
798 // messages in DTLS to redundantly both fragment the message
799 // and include a copy of the full one.
800 MixCompleteMessageWithFragments bool
801
David Benjaminddb9f152015-02-03 15:44:39 -0500802 // SendInvalidRecordType, if true, causes a record with an invalid
803 // content type to be sent immediately following the handshake.
804 SendInvalidRecordType bool
David Benjaminbcb2d912015-02-24 23:45:43 -0500805
David Benjamin0b8d5da2016-07-15 00:39:56 -0400806 // SendWrongMessageType, if non-zero, causes messages of the specified
807 // type to be sent with the wrong value.
808 SendWrongMessageType byte
David Benjamin75381222015-03-02 19:30:30 -0500809
David Benjamin639846e2016-09-09 11:41:18 -0400810 // SendTrailingMessageData, if non-zero, causes messages of the
811 // specified type to be sent with trailing data.
812 SendTrailingMessageData byte
813
David Benjamin75381222015-03-02 19:30:30 -0500814 // FragmentMessageTypeMismatch, if true, causes all non-initial
815 // handshake fragments in DTLS to have the wrong message type.
816 FragmentMessageTypeMismatch bool
817
818 // FragmentMessageLengthMismatch, if true, causes all non-initial
819 // handshake fragments in DTLS to have the wrong message length.
820 FragmentMessageLengthMismatch bool
821
David Benjamin11fc66a2015-06-16 11:40:24 -0400822 // SplitFragments, if non-zero, causes the handshake fragments in DTLS
823 // to be split across two records. The value of |SplitFragments| is the
824 // number of bytes in the first fragment.
825 SplitFragments int
David Benjamin75381222015-03-02 19:30:30 -0500826
827 // SendEmptyFragments, if true, causes handshakes to include empty
828 // fragments in DTLS.
829 SendEmptyFragments bool
David Benjamincdea40c2015-03-19 14:09:43 -0400830
David Benjamin9a41d1b2015-05-16 01:30:09 -0400831 // SendSplitAlert, if true, causes an alert to be sent with the header
832 // and record body split across multiple packets. The peer should
833 // discard these packets rather than process it.
834 SendSplitAlert bool
835
David Benjamin4b27d9f2015-05-12 22:42:52 -0400836 // FailIfResumeOnRenego, if true, causes renegotiations to fail if the
837 // client offers a resumption or the server accepts one.
838 FailIfResumeOnRenego bool
David Benjamin3c9746a2015-03-19 15:00:10 -0400839
David Benjamin67d1fb52015-03-16 15:16:23 -0400840 // IgnorePeerCipherPreferences, if true, causes the peer's cipher
841 // preferences to be ignored.
842 IgnorePeerCipherPreferences bool
David Benjamin72dc7832015-03-16 17:49:43 -0400843
844 // IgnorePeerSignatureAlgorithmPreferences, if true, causes the peer's
845 // signature algorithm preferences to be ignored.
846 IgnorePeerSignatureAlgorithmPreferences bool
David Benjamin340d5ed2015-03-21 02:21:37 -0400847
David Benjaminc574f412015-04-20 11:13:01 -0400848 // IgnorePeerCurvePreferences, if true, causes the peer's curve
849 // preferences to be ignored.
850 IgnorePeerCurvePreferences bool
851
David Benjamin513f0ea2015-04-02 19:33:31 -0400852 // BadFinished, if true, causes the Finished hash to be broken.
853 BadFinished bool
Adam Langleya7997f12015-05-14 17:38:50 -0700854
855 // DHGroupPrime, if not nil, is used to define the (finite field)
856 // Diffie-Hellman group. The generator used is always two.
857 DHGroupPrime *big.Int
David Benjaminbd15a8e2015-05-29 18:48:16 -0400858
David Benjamin582ba042016-07-07 12:33:25 -0700859 // PackHandshakeFragments, if true, causes handshake fragments in DTLS
860 // to be packed into individual handshake records, up to the specified
861 // record size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400862 PackHandshakeFragments int
863
David Benjamin582ba042016-07-07 12:33:25 -0700864 // PackHandshakeRecords, if true, causes handshake records in DTLS to be
865 // packed into individual packets, up to the specified packet size.
David Benjaminbd15a8e2015-05-29 18:48:16 -0400866 PackHandshakeRecords int
David Benjamin0fa40122015-05-30 17:13:12 -0400867
David Benjamin582ba042016-07-07 12:33:25 -0700868 // PackHandshakeFlight, if true, causes each handshake flight in TLS to
869 // be packed into records, up to the largest size record available.
870 PackHandshakeFlight bool
871
David Benjamin5ecb88b2016-10-04 17:51:35 -0400872 // AdvertiseAllConfiguredCiphers, if true, causes the client to
873 // advertise all configured cipher suite values.
874 AdvertiseAllConfiguredCiphers bool
David Benjamin8923c0b2015-06-07 11:42:34 -0400875
876 // EmptyCertificateList, if true, causes the server to send an empty
877 // certificate list in the Certificate message.
878 EmptyCertificateList bool
David Benjamind98452d2015-06-16 14:16:23 -0400879
880 // ExpectNewTicket, if true, causes the client to abort if it does not
881 // receive a new ticket.
882 ExpectNewTicket bool
Adam Langley33ad2b52015-07-20 17:43:53 -0700883
884 // RequireClientHelloSize, if not zero, is the required length in bytes
885 // of the ClientHello /record/. This is checked by the server.
886 RequireClientHelloSize int
Adam Langley09505632015-07-30 18:10:13 -0700887
888 // CustomExtension, if not empty, contains the contents of an extension
889 // that will be added to client/server hellos.
890 CustomExtension string
891
David Benjamin490469f2016-10-05 22:44:38 -0400892 // CustomUnencryptedExtension, if not empty, contains the contents of
893 // an extension that will be added to ServerHello in TLS 1.3.
894 CustomUnencryptedExtension string
895
Adam Langley09505632015-07-30 18:10:13 -0700896 // ExpectedCustomExtension, if not nil, contains the expected contents
897 // of a custom extension.
898 ExpectedCustomExtension *string
David Benjamin30789da2015-08-29 22:56:45 -0400899
David Benjamin1286bee2016-10-07 15:25:06 -0400900 // CustomTicketExtension, if not empty, contains the contents of an
901 // extension what will be added to NewSessionTicket in TLS 1.3.
902 CustomTicketExtension string
903
David Benjamin3baa6e12016-10-07 21:10:38 -0400904 // CustomTicketExtension, if not empty, contains the contents of an
905 // extension what will be added to HelloRetryRequest in TLS 1.3.
906 CustomHelloRetryRequestExtension string
907
David Benjamin30789da2015-08-29 22:56:45 -0400908 // NoCloseNotify, if true, causes the close_notify alert to be skipped
909 // on connection shutdown.
910 NoCloseNotify bool
911
David Benjaminfa214e42016-05-10 17:03:10 -0400912 // SendAlertOnShutdown, if non-zero, is the alert to send instead of
913 // close_notify on shutdown.
914 SendAlertOnShutdown alert
915
David Benjamin30789da2015-08-29 22:56:45 -0400916 // ExpectCloseNotify, if true, requires a close_notify from the peer on
917 // shutdown. Records from the peer received after close_notify is sent
918 // are not discard.
919 ExpectCloseNotify bool
David Benjamin2c99d282015-09-01 10:23:00 -0400920
921 // SendLargeRecords, if true, allows outgoing records to be sent
922 // arbitrarily large.
923 SendLargeRecords bool
David Benjamin76c2efc2015-08-31 14:24:29 -0400924
925 // NegotiateALPNAndNPN, if true, causes the server to negotiate both
926 // ALPN and NPN in the same connetion.
927 NegotiateALPNAndNPN bool
David Benjamindd6fed92015-10-23 17:41:12 -0400928
David Benjamin0c40a962016-08-01 12:05:50 -0400929 // SendALPN, if non-empty, causes the server to send the specified
David Benjamin3e517572016-08-11 11:52:23 -0400930 // string in the ALPN extension regardless of the content or presence of
931 // the client offer.
David Benjamin0c40a962016-08-01 12:05:50 -0400932 SendALPN string
933
David Benjamin490469f2016-10-05 22:44:38 -0400934 // SendUnencryptedALPN, if non-empty, causes the server to send the
935 // specified string in a ServerHello ALPN extension in TLS 1.3.
936 SendUnencryptedALPN string
937
David Benjamindd6fed92015-10-23 17:41:12 -0400938 // SendEmptySessionTicket, if true, causes the server to send an empty
939 // session ticket.
940 SendEmptySessionTicket bool
941
Steven Valdez5b986082016-09-01 12:29:49 -0400942 // SnedPSKKeyExchangeModes, if present, determines the PSK key exchange modes
943 // to send.
944 SendPSKKeyExchangeModes []byte
945
946 // SendPSKAuthModes, if present, determines the PSK auth modes to send.
947 SendPSKAuthModes []byte
948
David Benjamindd6fed92015-10-23 17:41:12 -0400949 // FailIfSessionOffered, if true, causes the server to fail any
950 // connections where the client offers a non-empty session ID or session
951 // ticket.
952 FailIfSessionOffered bool
Adam Langley27a0d082015-11-03 13:34:10 -0800953
954 // SendHelloRequestBeforeEveryAppDataRecord, if true, causes a
955 // HelloRequest handshake message to be sent before each application
956 // data record. This only makes sense for a server.
957 SendHelloRequestBeforeEveryAppDataRecord bool
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800958
David Benjamin71dd6662016-07-08 14:10:48 -0700959 // SendHelloRequestBeforeEveryHandshakeMessage, if true, causes a
960 // HelloRequest handshake message to be sent before each handshake
961 // message. This only makes sense for a server.
962 SendHelloRequestBeforeEveryHandshakeMessage bool
963
Adam Langleyc4f25ce2015-11-26 16:39:08 -0800964 // RequireDHPublicValueLen causes a fatal error if the length (in
965 // bytes) of the server's Diffie-Hellman public value is not equal to
966 // this.
967 RequireDHPublicValueLen int
David Benjamin8411b242015-11-26 12:07:28 -0500968
969 // BadChangeCipherSpec, if not nil, is the body to be sent in
970 // ChangeCipherSpec records instead of {1}.
971 BadChangeCipherSpec []byte
David Benjaminef5dfd22015-12-06 13:17:07 -0500972
973 // BadHelloRequest, if not nil, is what to send instead of a
974 // HelloRequest.
975 BadHelloRequest []byte
David Benjaminef1b0092015-11-21 14:05:44 -0500976
977 // RequireSessionTickets, if true, causes the client to require new
978 // sessions use session tickets instead of session IDs.
979 RequireSessionTickets bool
David Benjaminf2b83632016-03-01 22:57:46 -0500980
981 // NullAllCiphers, if true, causes every cipher to behave like the null
982 // cipher.
983 NullAllCiphers bool
David Benjamin80d1b352016-05-04 19:19:06 -0400984
985 // SendSCTListOnResume, if not nil, causes the server to send the
986 // supplied SCT list in resumption handshakes.
987 SendSCTListOnResume []byte
Matt Braithwaite54217e42016-06-13 13:03:47 -0700988
David Benjamindaa88502016-10-04 16:32:16 -0400989 // SendOCSPResponseOnResume, if not nil, causes the server to advertise
990 // OCSP stapling in resumption handshakes and, if applicable, send the
991 // supplied stapled response.
992 SendOCSPResponseOnResume []byte
993
Matt Braithwaite54217e42016-06-13 13:03:47 -0700994 // CECPQ1BadX25519Part corrupts the X25519 part of a CECPQ1 key exchange, as
995 // a trivial proof that it is actually used.
996 CECPQ1BadX25519Part bool
997
998 // CECPQ1BadNewhopePart corrupts the Newhope part of a CECPQ1 key exchange,
999 // as a trivial proof that it is actually used.
1000 CECPQ1BadNewhopePart bool
David Benjaminc9ae27c2016-06-24 22:56:37 -04001001
1002 // RecordPadding is the number of bytes of padding to add to each
1003 // encrypted record in TLS 1.3.
1004 RecordPadding int
1005
1006 // OmitRecordContents, if true, causes encrypted records in TLS 1.3 to
1007 // be missing their body and content type. Padding, if configured, is
1008 // still added.
1009 OmitRecordContents bool
1010
1011 // OuterRecordType, if non-zero, is the outer record type to use instead
1012 // of application data.
1013 OuterRecordType recordType
David Benjamina95e9f32016-07-08 16:28:04 -07001014
1015 // SendSignatureAlgorithm, if non-zero, causes all signatures to be sent
1016 // with the given signature algorithm rather than the one negotiated.
1017 SendSignatureAlgorithm signatureAlgorithm
David Benjamin1fb125c2016-07-08 18:52:12 -07001018
1019 // SkipECDSACurveCheck, if true, causes all ECDSA curve checks to be
1020 // skipped.
1021 SkipECDSACurveCheck bool
David Benjaminfd5c45f2016-06-30 18:30:40 -04001022
1023 // IgnoreSignatureVersionChecks, if true, causes all signature
1024 // algorithms to be enabled at all TLS versions.
1025 IgnoreSignatureVersionChecks bool
Steven Valdez143e8b32016-07-11 13:19:03 -04001026
1027 // NegotiateRenegotiationInfoAtAllVersions, if true, causes
1028 // Renegotiation Info to be negotiated at all versions.
1029 NegotiateRenegotiationInfoAtAllVersions bool
1030
Steven Valdez143e8b32016-07-11 13:19:03 -04001031 // NegotiateNPNAtAllVersions, if true, causes NPN to be negotiated at
1032 // all versions.
1033 NegotiateNPNAtAllVersions bool
1034
1035 // NegotiateEMSAtAllVersions, if true, causes EMS to be negotiated at
1036 // all versions.
1037 NegotiateEMSAtAllVersions bool
1038
1039 // AdvertiseTicketExtension, if true, causes the ticket extension to be
1040 // advertised in server extensions
1041 AdvertiseTicketExtension bool
1042
Steven Valdez803c77a2016-09-06 14:13:43 -04001043 // NegotiatePSKResumption, if true, causes the server to attempt pure PSK
1044 // resumption.
1045 NegotiatePSKResumption bool
1046
David Benjamin7f78df42016-10-05 22:33:19 -04001047 // AlwaysSelectPSKIdentity, if true, causes the server in TLS 1.3 to
1048 // always acknowledge a session, regardless of one was offered.
1049 AlwaysSelectPSKIdentity bool
1050
1051 // SelectPSKIdentityOnResume, if non-zero, causes the server to select
1052 // the specified PSK identity index rather than the actual value.
1053 SelectPSKIdentityOnResume uint16
1054
Steven Valdezaf3b8a92016-11-01 12:49:22 -04001055 // ExtraPSKIdentity, if true, causes the client to send an extra PSK
1056 // identity.
1057 ExtraPSKIdentity bool
1058
Steven Valdez803c77a2016-09-06 14:13:43 -04001059 // OmitServerHelloSignatureAlgorithms, if true, causes the server to omit the
1060 // signature_algorithms extension in the ServerHello.
1061 OmitServerHelloSignatureAlgorithms bool
1062
1063 // IncludeServerHelloSignatureAlgorithms, if true, causes the server to
1064 // include the signature_algorithms extension in all ServerHellos.
1065 IncludeServerHelloSignatureAlgorithms bool
1066
Steven Valdez143e8b32016-07-11 13:19:03 -04001067 // MissingKeyShare, if true, causes the TLS 1.3 implementation to skip
1068 // sending a key_share extension and use the zero ECDHE secret
1069 // instead.
1070 MissingKeyShare bool
1071
Steven Valdez5440fe02016-07-18 12:40:30 -04001072 // SecondClientHelloMissingKeyShare, if true, causes the second TLS 1.3
1073 // ClientHello to skip sending a key_share extension and use the zero
1074 // ECDHE secret instead.
1075 SecondClientHelloMissingKeyShare bool
1076
1077 // MisinterpretHelloRetryRequestCurve, if non-zero, causes the TLS 1.3
1078 // client to pretend the server requested a HelloRetryRequest with the
1079 // given curve rather than the actual one.
1080 MisinterpretHelloRetryRequestCurve CurveID
1081
Steven Valdez143e8b32016-07-11 13:19:03 -04001082 // DuplicateKeyShares, if true, causes the TLS 1.3 client to send two
1083 // copies of each KeyShareEntry.
1084 DuplicateKeyShares bool
1085
1086 // EmptyEncryptedExtensions, if true, causes the TLS 1.3 server to
1087 // emit an empty EncryptedExtensions block.
1088 EmptyEncryptedExtensions bool
1089
1090 // EncryptedExtensionsWithKeyShare, if true, causes the TLS 1.3 server to
1091 // include the KeyShare extension in the EncryptedExtensions block.
1092 EncryptedExtensionsWithKeyShare bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001093
David Benjamin3baa6e12016-10-07 21:10:38 -04001094 // AlwaysSendHelloRetryRequest, if true, causes a HelloRetryRequest to
1095 // be sent by the server, even if empty.
1096 AlwaysSendHelloRetryRequest bool
Steven Valdez5440fe02016-07-18 12:40:30 -04001097
1098 // SecondHelloRetryRequest, if true, causes the TLS 1.3 server to send
1099 // two HelloRetryRequests instead of one.
1100 SecondHelloRetryRequest bool
1101
David Benjamin3baa6e12016-10-07 21:10:38 -04001102 // SendHelloRetryRequestCurve, if non-zero, causes the server to send
1103 // the specified curve in a HelloRetryRequest.
1104 SendHelloRetryRequestCurve CurveID
1105
1106 // SendHelloRetryRequestCookie, if not nil, contains a cookie to be
1107 // sent by the server in HelloRetryRequest.
1108 SendHelloRetryRequestCookie []byte
1109
1110 // DuplicateHelloRetryRequestExtensions, if true, causes all
1111 // HelloRetryRequest extensions to be sent twice.
1112 DuplicateHelloRetryRequestExtensions bool
1113
Steven Valdez5440fe02016-07-18 12:40:30 -04001114 // SendServerHelloVersion, if non-zero, causes the server to send the
David Benjamin3c6a1ea2016-09-26 18:30:05 -04001115 // specified value in ServerHello version field.
Steven Valdez5440fe02016-07-18 12:40:30 -04001116 SendServerHelloVersion uint16
1117
1118 // SkipHelloRetryRequest, if true, causes the TLS 1.3 server to not send
1119 // HelloRetryRequest.
1120 SkipHelloRetryRequest bool
David Benjamin12d2c482016-07-24 10:56:51 -04001121
1122 // PackHelloRequestWithFinished, if true, causes the TLS server to send
1123 // HelloRequest in the same record as Finished.
1124 PackHelloRequestWithFinished bool
David Benjamin02edcd02016-07-27 17:40:37 -04001125
David Benjamine73c7f42016-08-17 00:29:33 -04001126 // ExpectMissingKeyShare, if true, causes the TLS server to fail the
1127 // connection if the selected curve appears in the client's initial
1128 // ClientHello. That is, it requires that a HelloRetryRequest be sent.
1129 ExpectMissingKeyShare bool
1130
David Benjamin02edcd02016-07-27 17:40:37 -04001131 // SendExtraFinished, if true, causes an extra Finished message to be
1132 // sent.
1133 SendExtraFinished bool
David Benjamin8a8349b2016-08-18 02:32:23 -04001134
1135 // SendRequestContext, if not empty, is the request context to send in
1136 // a TLS 1.3 CertificateRequest.
1137 SendRequestContext []byte
David Benjaminabe94e32016-09-04 14:18:58 -04001138
1139 // SendSNIWarningAlert, if true, causes the server to send an
1140 // unrecognized_name alert before the ServerHello.
1141 SendSNIWarningAlert bool
David Benjaminc241d792016-09-09 10:34:20 -04001142
1143 // SendCompressionMethods, if not nil, is the compression method list to
1144 // send in the ClientHello.
1145 SendCompressionMethods []byte
David Benjamin78679342016-09-16 19:42:05 -04001146
1147 // AlwaysSendPreSharedKeyIdentityHint, if true, causes the server to
1148 // always send a ServerKeyExchange for PSK ciphers, even if the identity
1149 // hint is empty.
1150 AlwaysSendPreSharedKeyIdentityHint bool
David Benjamin7e1f9842016-09-20 19:24:40 -04001151
1152 // TrailingKeyShareData, if true, causes the client key share list to
1153 // include a trailing byte.
1154 TrailingKeyShareData bool
David Benjamin196df5b2016-09-21 16:23:27 -04001155
1156 // InvalidChannelIDSignature, if true, causes the client to generate an
1157 // invalid Channel ID signature.
1158 InvalidChannelIDSignature bool
David Benjamin65ac9972016-09-02 21:35:25 -04001159
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001160 // ExpectGREASE, if true, causes messages without GREASE values to be
1161 // rejected. See draft-davidben-tls-grease-01.
David Benjamin65ac9972016-09-02 21:35:25 -04001162 ExpectGREASE bool
Adam Langley95c29f32014-06-20 12:00:00 -07001163}
1164
1165func (c *Config) serverInit() {
1166 if c.SessionTicketsDisabled {
1167 return
1168 }
1169
1170 // If the key has already been set then we have nothing to do.
1171 for _, b := range c.SessionTicketKey {
1172 if b != 0 {
1173 return
1174 }
1175 }
1176
1177 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
1178 c.SessionTicketsDisabled = true
1179 }
1180}
1181
1182func (c *Config) rand() io.Reader {
1183 r := c.Rand
1184 if r == nil {
1185 return rand.Reader
1186 }
1187 return r
1188}
1189
1190func (c *Config) time() time.Time {
1191 t := c.Time
1192 if t == nil {
1193 t = time.Now
1194 }
1195 return t()
1196}
1197
1198func (c *Config) cipherSuites() []uint16 {
1199 s := c.CipherSuites
1200 if s == nil {
1201 s = defaultCipherSuites()
1202 }
1203 return s
1204}
1205
David Benjamincecee272016-06-30 13:33:47 -04001206func (c *Config) minVersion(isDTLS bool) uint16 {
1207 ret := uint16(minVersion)
1208 if c != nil && c.MinVersion != 0 {
1209 ret = c.MinVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001210 }
David Benjamincecee272016-06-30 13:33:47 -04001211 if isDTLS {
1212 // The lowest version of DTLS is 1.0. There is no DSSL 3.0.
1213 if ret < VersionTLS10 {
1214 return VersionTLS10
1215 }
1216 // There is no such thing as DTLS 1.1.
1217 if ret == VersionTLS11 {
1218 return VersionTLS12
1219 }
1220 }
1221 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001222}
1223
David Benjamincecee272016-06-30 13:33:47 -04001224func (c *Config) maxVersion(isDTLS bool) uint16 {
1225 ret := uint16(maxVersion)
1226 if c != nil && c.MaxVersion != 0 {
1227 ret = c.MaxVersion
Adam Langley95c29f32014-06-20 12:00:00 -07001228 }
David Benjamincecee272016-06-30 13:33:47 -04001229 if isDTLS {
1230 // We only implement up to DTLS 1.2.
1231 if ret > VersionTLS12 {
1232 return VersionTLS12
1233 }
1234 // There is no such thing as DTLS 1.1.
1235 if ret == VersionTLS11 {
1236 return VersionTLS10
1237 }
1238 }
1239 return ret
Adam Langley95c29f32014-06-20 12:00:00 -07001240}
1241
David Benjamincba2b622015-12-18 22:13:41 -05001242var defaultCurvePreferences = []CurveID{CurveX25519, CurveP256, CurveP384, CurveP521}
Adam Langley95c29f32014-06-20 12:00:00 -07001243
1244func (c *Config) curvePreferences() []CurveID {
1245 if c == nil || len(c.CurvePreferences) == 0 {
1246 return defaultCurvePreferences
1247 }
1248 return c.CurvePreferences
1249}
1250
Nick Harperdcfbc672016-07-16 17:47:31 +02001251func (c *Config) defaultCurves() map[CurveID]bool {
1252 defaultCurves := make(map[CurveID]bool)
1253 curves := c.DefaultCurves
1254 if c == nil || c.DefaultCurves == nil {
1255 curves = c.curvePreferences()
1256 }
1257 for _, curveID := range curves {
1258 defaultCurves[curveID] = true
1259 }
1260 return defaultCurves
1261}
1262
Steven Valdezfdd10992016-09-15 16:27:05 -04001263// isSupportedVersion returns true if the specified protocol version is
1264// acceptable.
1265func (c *Config) isSupportedVersion(vers uint16, isDTLS bool) bool {
1266 return c.minVersion(isDTLS) <= vers && vers <= c.maxVersion(isDTLS)
Adam Langley95c29f32014-06-20 12:00:00 -07001267}
1268
1269// getCertificateForName returns the best certificate for the given name,
1270// defaulting to the first element of c.Certificates if there are no good
1271// options.
1272func (c *Config) getCertificateForName(name string) *Certificate {
1273 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
1274 // There's only one choice, so no point doing any work.
1275 return &c.Certificates[0]
1276 }
1277
1278 name = strings.ToLower(name)
1279 for len(name) > 0 && name[len(name)-1] == '.' {
1280 name = name[:len(name)-1]
1281 }
1282
1283 if cert, ok := c.NameToCertificate[name]; ok {
1284 return cert
1285 }
1286
1287 // try replacing labels in the name with wildcards until we get a
1288 // match.
1289 labels := strings.Split(name, ".")
1290 for i := range labels {
1291 labels[i] = "*"
1292 candidate := strings.Join(labels, ".")
1293 if cert, ok := c.NameToCertificate[candidate]; ok {
1294 return cert
1295 }
1296 }
1297
1298 // If nothing matches, return the first certificate.
1299 return &c.Certificates[0]
1300}
1301
David Benjamin7a41d372016-07-09 11:21:54 -07001302func (c *Config) signSignatureAlgorithms() []signatureAlgorithm {
1303 if c != nil && c.SignSignatureAlgorithms != nil {
1304 return c.SignSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001305 }
David Benjamin7a41d372016-07-09 11:21:54 -07001306 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001307}
1308
David Benjamin7a41d372016-07-09 11:21:54 -07001309func (c *Config) verifySignatureAlgorithms() []signatureAlgorithm {
1310 if c != nil && c.VerifySignatureAlgorithms != nil {
1311 return c.VerifySignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001312 }
David Benjamin7a41d372016-07-09 11:21:54 -07001313 return supportedSignatureAlgorithms
David Benjamin000800a2014-11-14 01:43:59 -05001314}
1315
Adam Langley95c29f32014-06-20 12:00:00 -07001316// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
1317// from the CommonName and SubjectAlternateName fields of each of the leaf
1318// certificates.
1319func (c *Config) BuildNameToCertificate() {
1320 c.NameToCertificate = make(map[string]*Certificate)
1321 for i := range c.Certificates {
1322 cert := &c.Certificates[i]
1323 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
1324 if err != nil {
1325 continue
1326 }
1327 if len(x509Cert.Subject.CommonName) > 0 {
1328 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
1329 }
1330 for _, san := range x509Cert.DNSNames {
1331 c.NameToCertificate[san] = cert
1332 }
1333 }
1334}
1335
1336// A Certificate is a chain of one or more certificates, leaf first.
1337type Certificate struct {
1338 Certificate [][]byte
1339 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
1340 // OCSPStaple contains an optional OCSP response which will be served
1341 // to clients that request it.
1342 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -05001343 // SignedCertificateTimestampList contains an optional encoded
1344 // SignedCertificateTimestampList structure which will be
1345 // served to clients that request it.
1346 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -07001347 // Leaf is the parsed form of the leaf certificate, which may be
1348 // initialized using x509.ParseCertificate to reduce per-handshake
1349 // processing for TLS clients doing client authentication. If nil, the
1350 // leaf certificate will be parsed as needed.
1351 Leaf *x509.Certificate
1352}
1353
1354// A TLS record.
1355type record struct {
1356 contentType recordType
1357 major, minor uint8
1358 payload []byte
1359}
1360
1361type handshakeMessage interface {
1362 marshal() []byte
1363 unmarshal([]byte) bool
1364}
1365
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001366// lruSessionCache is a client or server session cache implementation
1367// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -07001368type lruSessionCache struct {
1369 sync.Mutex
1370
1371 m map[string]*list.Element
1372 q *list.List
1373 capacity int
1374}
1375
1376type lruSessionCacheEntry struct {
1377 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001378 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -07001379}
1380
1381// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001382func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -07001383 c.Lock()
1384 defer c.Unlock()
1385
1386 if elem, ok := c.m[sessionKey]; ok {
1387 entry := elem.Value.(*lruSessionCacheEntry)
1388 entry.state = cs
1389 c.q.MoveToFront(elem)
1390 return
1391 }
1392
1393 if c.q.Len() < c.capacity {
1394 entry := &lruSessionCacheEntry{sessionKey, cs}
1395 c.m[sessionKey] = c.q.PushFront(entry)
1396 return
1397 }
1398
1399 elem := c.q.Back()
1400 entry := elem.Value.(*lruSessionCacheEntry)
1401 delete(c.m, entry.sessionKey)
1402 entry.sessionKey = sessionKey
1403 entry.state = cs
1404 c.q.MoveToFront(elem)
1405 c.m[sessionKey] = elem
1406}
1407
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001408// Get returns the value associated with a given key. It returns (nil,
1409// false) if no value is found.
1410func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -07001411 c.Lock()
1412 defer c.Unlock()
1413
1414 if elem, ok := c.m[sessionKey]; ok {
1415 c.q.MoveToFront(elem)
1416 return elem.Value.(*lruSessionCacheEntry).state, true
1417 }
1418 return nil, false
1419}
1420
David Benjaminfe8eb9a2014-11-17 03:19:02 -05001421// lruClientSessionCache is a ClientSessionCache implementation that
1422// uses an LRU caching strategy.
1423type lruClientSessionCache struct {
1424 lruSessionCache
1425}
1426
1427func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
1428 c.lruSessionCache.Put(sessionKey, cs)
1429}
1430
1431func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
1432 cs, ok := c.lruSessionCache.Get(sessionKey)
1433 if !ok {
1434 return nil, false
1435 }
1436 return cs.(*ClientSessionState), true
1437}
1438
1439// lruServerSessionCache is a ServerSessionCache implementation that
1440// uses an LRU caching strategy.
1441type lruServerSessionCache struct {
1442 lruSessionCache
1443}
1444
1445func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
1446 c.lruSessionCache.Put(sessionId, session)
1447}
1448
1449func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
1450 cs, ok := c.lruSessionCache.Get(sessionId)
1451 if !ok {
1452 return nil, false
1453 }
1454 return cs.(*sessionState), true
1455}
1456
1457// NewLRUClientSessionCache returns a ClientSessionCache with the given
1458// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1459// is used instead.
1460func NewLRUClientSessionCache(capacity int) ClientSessionCache {
1461 const defaultSessionCacheCapacity = 64
1462
1463 if capacity < 1 {
1464 capacity = defaultSessionCacheCapacity
1465 }
1466 return &lruClientSessionCache{
1467 lruSessionCache{
1468 m: make(map[string]*list.Element),
1469 q: list.New(),
1470 capacity: capacity,
1471 },
1472 }
1473}
1474
1475// NewLRUServerSessionCache returns a ServerSessionCache with the given
1476// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
1477// is used instead.
1478func NewLRUServerSessionCache(capacity int) ServerSessionCache {
1479 const defaultSessionCacheCapacity = 64
1480
1481 if capacity < 1 {
1482 capacity = defaultSessionCacheCapacity
1483 }
1484 return &lruServerSessionCache{
1485 lruSessionCache{
1486 m: make(map[string]*list.Element),
1487 q: list.New(),
1488 capacity: capacity,
1489 },
1490 }
1491}
1492
Adam Langley95c29f32014-06-20 12:00:00 -07001493// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
1494type dsaSignature struct {
1495 R, S *big.Int
1496}
1497
1498type ecdsaSignature dsaSignature
1499
1500var emptyConfig Config
1501
1502func defaultConfig() *Config {
1503 return &emptyConfig
1504}
1505
1506var (
1507 once sync.Once
1508 varDefaultCipherSuites []uint16
1509)
1510
1511func defaultCipherSuites() []uint16 {
1512 once.Do(initDefaultCipherSuites)
1513 return varDefaultCipherSuites
1514}
1515
1516func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -04001517 for _, suite := range cipherSuites {
1518 if suite.flags&suitePSK == 0 {
1519 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
1520 }
Adam Langley95c29f32014-06-20 12:00:00 -07001521 }
1522}
1523
1524func unexpectedMessageError(wanted, got interface{}) error {
1525 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
1526}
David Benjamin000800a2014-11-14 01:43:59 -05001527
Nick Harper60edffd2016-06-21 15:19:24 -07001528func isSupportedSignatureAlgorithm(sigAlg signatureAlgorithm, sigAlgs []signatureAlgorithm) bool {
1529 for _, s := range sigAlgs {
1530 if s == sigAlg {
David Benjamin000800a2014-11-14 01:43:59 -05001531 return true
1532 }
1533 }
1534 return false
1535}
Nick Harper85f20c22016-07-04 10:11:59 -07001536
1537var (
David Benjamina128a552016-10-13 14:26:33 -04001538 // See draft-ietf-tls-tls13-16, section 6.3.1.2.
Nick Harper85f20c22016-07-04 10:11:59 -07001539 downgradeTLS13 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x01}
1540 downgradeTLS12 = []byte{0x44, 0x4f, 0x57, 0x4e, 0x47, 0x52, 0x44, 0x00}
1541)