blob: 4dd710cce3bd207b4918c763810b42b0ff33c92d [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
5package main
6
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
26)
27
28const (
David Benjamin83c0bc92014-08-04 01:23:53 -040029 maxPlaintext = 16384 // maximum plaintext payload length
30 maxCiphertext = 16384 + 2048 // maximum ciphertext payload length
31 tlsRecordHeaderLen = 5 // record header length
32 dtlsRecordHeaderLen = 13
33 maxHandshake = 65536 // maximum handshake we support (protocol max is 16 MB)
Adam Langley95c29f32014-06-20 12:00:00 -070034
35 minVersion = VersionSSL30
36 maxVersion = VersionTLS12
37)
38
39// TLS record types.
40type recordType uint8
41
42const (
43 recordTypeChangeCipherSpec recordType = 20
44 recordTypeAlert recordType = 21
45 recordTypeHandshake recordType = 22
46 recordTypeApplicationData recordType = 23
47)
48
49// TLS handshake message types.
50const (
Adam Langley2ae77d22014-10-28 17:29:33 -070051 typeHelloRequest uint8 = 0
David Benjamind30a9902014-08-24 01:44:23 -040052 typeClientHello uint8 = 1
53 typeServerHello uint8 = 2
54 typeHelloVerifyRequest uint8 = 3
55 typeNewSessionTicket uint8 = 4
56 typeCertificate uint8 = 11
57 typeServerKeyExchange uint8 = 12
58 typeCertificateRequest uint8 = 13
59 typeServerHelloDone uint8 = 14
60 typeCertificateVerify uint8 = 15
61 typeClientKeyExchange uint8 = 16
62 typeFinished uint8 = 20
63 typeCertificateStatus uint8 = 22
64 typeNextProtocol uint8 = 67 // Not IANA assigned
65 typeEncryptedExtensions uint8 = 203 // Not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070066)
67
68// TLS compression types.
69const (
70 compressionNone uint8 = 0
71)
72
73// TLS extension numbers
74const (
David Benjamin61f95272014-11-25 01:55:35 -050075 extensionServerName uint16 = 0
76 extensionStatusRequest uint16 = 5
77 extensionSupportedCurves uint16 = 10
78 extensionSupportedPoints uint16 = 11
79 extensionSignatureAlgorithms uint16 = 13
80 extensionUseSRTP uint16 = 14
81 extensionALPN uint16 = 16
82 extensionSignedCertificateTimestamp uint16 = 18
83 extensionExtendedMasterSecret uint16 = 23
84 extensionSessionTicket uint16 = 35
85 extensionNextProtoNeg uint16 = 13172 // not IANA assigned
86 extensionRenegotiationInfo uint16 = 0xff01
87 extensionChannelID uint16 = 30032 // not IANA assigned
Adam Langley95c29f32014-06-20 12:00:00 -070088)
89
90// TLS signaling cipher suite values
91const (
92 scsvRenegotiation uint16 = 0x00ff
93)
94
95// CurveID is the type of a TLS identifier for an elliptic curve. See
96// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-8
97type CurveID uint16
98
99const (
100 CurveP256 CurveID = 23
101 CurveP384 CurveID = 24
102 CurveP521 CurveID = 25
103)
104
105// TLS Elliptic Curve Point Formats
106// http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-9
107const (
108 pointFormatUncompressed uint8 = 0
109)
110
111// TLS CertificateStatusType (RFC 3546)
112const (
113 statusTypeOCSP uint8 = 1
114)
115
116// Certificate types (for certificateRequestMsg)
117const (
David Benjamin7b030512014-07-08 17:30:11 -0400118 CertTypeRSASign = 1 // A certificate containing an RSA key
119 CertTypeDSSSign = 2 // A certificate containing a DSA key
120 CertTypeRSAFixedDH = 3 // A certificate containing a static DH key
121 CertTypeDSSFixedDH = 4 // A certificate containing a static DH key
Adam Langley95c29f32014-06-20 12:00:00 -0700122
123 // See RFC4492 sections 3 and 5.5.
David Benjamin7b030512014-07-08 17:30:11 -0400124 CertTypeECDSASign = 64 // A certificate containing an ECDSA-capable public key, signed with ECDSA.
125 CertTypeRSAFixedECDH = 65 // A certificate containing an ECDH-capable public key, signed with RSA.
126 CertTypeECDSAFixedECDH = 66 // A certificate containing an ECDH-capable public key, signed with ECDSA.
Adam Langley95c29f32014-06-20 12:00:00 -0700127
128 // Rest of these are reserved by the TLS spec
129)
130
131// Hash functions for TLS 1.2 (See RFC 5246, section A.4.1)
132const (
David Benjamin000800a2014-11-14 01:43:59 -0500133 hashMD5 uint8 = 1
Adam Langley95c29f32014-06-20 12:00:00 -0700134 hashSHA1 uint8 = 2
David Benjamin000800a2014-11-14 01:43:59 -0500135 hashSHA224 uint8 = 3
Adam Langley95c29f32014-06-20 12:00:00 -0700136 hashSHA256 uint8 = 4
David Benjamin000800a2014-11-14 01:43:59 -0500137 hashSHA384 uint8 = 5
138 hashSHA512 uint8 = 6
Adam Langley95c29f32014-06-20 12:00:00 -0700139)
140
141// Signature algorithms for TLS 1.2 (See RFC 5246, section A.4.1)
142const (
143 signatureRSA uint8 = 1
144 signatureECDSA uint8 = 3
145)
146
147// signatureAndHash mirrors the TLS 1.2, SignatureAndHashAlgorithm struct. See
148// RFC 5246, section A.4.1.
149type signatureAndHash struct {
David Benjamine098ec22014-08-27 23:13:20 -0400150 signature, hash uint8
Adam Langley95c29f32014-06-20 12:00:00 -0700151}
152
153// supportedSKXSignatureAlgorithms contains the signature and hash algorithms
154// that the code advertises as supported in a TLS 1.2 ClientHello.
155var supportedSKXSignatureAlgorithms = []signatureAndHash{
David Benjamine098ec22014-08-27 23:13:20 -0400156 {signatureRSA, hashSHA256},
157 {signatureECDSA, hashSHA256},
158 {signatureRSA, hashSHA1},
159 {signatureECDSA, hashSHA1},
Adam Langley95c29f32014-06-20 12:00:00 -0700160}
161
162// supportedClientCertSignatureAlgorithms contains the signature and hash
163// algorithms that the code advertises as supported in a TLS 1.2
164// CertificateRequest.
165var supportedClientCertSignatureAlgorithms = []signatureAndHash{
David Benjamine098ec22014-08-27 23:13:20 -0400166 {signatureRSA, hashSHA256},
167 {signatureECDSA, hashSHA256},
Adam Langley95c29f32014-06-20 12:00:00 -0700168}
169
David Benjaminca6c8262014-11-15 19:06:08 -0500170// SRTP protection profiles (See RFC 5764, section 4.1.2)
171const (
172 SRTP_AES128_CM_HMAC_SHA1_80 uint16 = 0x0001
173 SRTP_AES128_CM_HMAC_SHA1_32 = 0x0002
174)
175
Adam Langley95c29f32014-06-20 12:00:00 -0700176// ConnectionState records basic TLS details about the connection.
177type ConnectionState struct {
178 Version uint16 // TLS version used by the connection (e.g. VersionTLS12)
179 HandshakeComplete bool // TLS handshake is complete
180 DidResume bool // connection resumes a previous TLS connection
181 CipherSuite uint16 // cipher suite in use (TLS_RSA_WITH_RC4_128_SHA, ...)
182 NegotiatedProtocol string // negotiated next protocol (from Config.NextProtos)
183 NegotiatedProtocolIsMutual bool // negotiated protocol was advertised by server
David Benjaminfc7b0862014-09-06 13:21:53 -0400184 NegotiatedProtocolFromALPN bool // protocol negotiated with ALPN
Adam Langley95c29f32014-06-20 12:00:00 -0700185 ServerName string // server name requested by client, if any (server side only)
186 PeerCertificates []*x509.Certificate // certificate chain presented by remote peer
187 VerifiedChains [][]*x509.Certificate // verified chains built from PeerCertificates
David Benjamind30a9902014-08-24 01:44:23 -0400188 ChannelID *ecdsa.PublicKey // the channel ID for this connection
David Benjaminca6c8262014-11-15 19:06:08 -0500189 SRTPProtectionProfile uint16 // the negotiated DTLS-SRTP protection profile
Adam Langley95c29f32014-06-20 12:00:00 -0700190}
191
192// ClientAuthType declares the policy the server will follow for
193// TLS Client Authentication.
194type ClientAuthType int
195
196const (
197 NoClientCert ClientAuthType = iota
198 RequestClientCert
199 RequireAnyClientCert
200 VerifyClientCertIfGiven
201 RequireAndVerifyClientCert
202)
203
204// ClientSessionState contains the state needed by clients to resume TLS
205// sessions.
206type ClientSessionState struct {
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500207 sessionId []uint8 // Session ID supplied by the server. nil if the session has a ticket.
Adam Langley75712922014-10-10 16:23:43 -0700208 sessionTicket []uint8 // Encrypted ticket used for session resumption with server
209 vers uint16 // SSL/TLS version negotiated for the session
210 cipherSuite uint16 // Ciphersuite negotiated for the session
211 masterSecret []byte // MasterSecret generated by client on a full handshake
212 handshakeHash []byte // Handshake hash for Channel ID purposes.
213 serverCertificates []*x509.Certificate // Certificate chain presented by the server
214 extendedMasterSecret bool // Whether an extended master secret was used to generate the session
Adam Langley95c29f32014-06-20 12:00:00 -0700215}
216
217// ClientSessionCache is a cache of ClientSessionState objects that can be used
218// by a client to resume a TLS session with a given server. ClientSessionCache
219// implementations should expect to be called concurrently from different
220// goroutines.
221type ClientSessionCache interface {
222 // Get searches for a ClientSessionState associated with the given key.
223 // On return, ok is true if one was found.
224 Get(sessionKey string) (session *ClientSessionState, ok bool)
225
226 // Put adds the ClientSessionState to the cache with the given key.
227 Put(sessionKey string, cs *ClientSessionState)
228}
229
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500230// ServerSessionCache is a cache of sessionState objects that can be used by a
231// client to resume a TLS session with a given server. ServerSessionCache
232// implementations should expect to be called concurrently from different
233// goroutines.
234type ServerSessionCache interface {
235 // Get searches for a sessionState associated with the given session
236 // ID. On return, ok is true if one was found.
237 Get(sessionId string) (session *sessionState, ok bool)
238
239 // Put adds the sessionState to the cache with the given session ID.
240 Put(sessionId string, session *sessionState)
241}
242
Adam Langley95c29f32014-06-20 12:00:00 -0700243// A Config structure is used to configure a TLS client or server.
244// After one has been passed to a TLS function it must not be
245// modified. A Config may be reused; the tls package will also not
246// modify it.
247type Config struct {
248 // Rand provides the source of entropy for nonces and RSA blinding.
249 // If Rand is nil, TLS uses the cryptographic random reader in package
250 // crypto/rand.
251 // The Reader must be safe for use by multiple goroutines.
252 Rand io.Reader
253
254 // Time returns the current time as the number of seconds since the epoch.
255 // If Time is nil, TLS uses time.Now.
256 Time func() time.Time
257
258 // Certificates contains one or more certificate chains
259 // to present to the other side of the connection.
260 // Server configurations must include at least one certificate.
261 Certificates []Certificate
262
263 // NameToCertificate maps from a certificate name to an element of
264 // Certificates. Note that a certificate name can be of the form
265 // '*.example.com' and so doesn't have to be a domain name as such.
266 // See Config.BuildNameToCertificate
267 // The nil value causes the first element of Certificates to be used
268 // for all connections.
269 NameToCertificate map[string]*Certificate
270
271 // RootCAs defines the set of root certificate authorities
272 // that clients use when verifying server certificates.
273 // If RootCAs is nil, TLS uses the host's root CA set.
274 RootCAs *x509.CertPool
275
276 // NextProtos is a list of supported, application level protocols.
277 NextProtos []string
278
279 // ServerName is used to verify the hostname on the returned
280 // certificates unless InsecureSkipVerify is given. It is also included
281 // in the client's handshake to support virtual hosting.
282 ServerName string
283
284 // ClientAuth determines the server's policy for
285 // TLS Client Authentication. The default is NoClientCert.
286 ClientAuth ClientAuthType
287
288 // ClientCAs defines the set of root certificate authorities
289 // that servers use if required to verify a client certificate
290 // by the policy in ClientAuth.
291 ClientCAs *x509.CertPool
292
David Benjamin7b030512014-07-08 17:30:11 -0400293 // ClientCertificateTypes defines the set of allowed client certificate
294 // types. The default is CertTypeRSASign and CertTypeECDSASign.
295 ClientCertificateTypes []byte
296
Adam Langley95c29f32014-06-20 12:00:00 -0700297 // InsecureSkipVerify controls whether a client verifies the
298 // server's certificate chain and host name.
299 // If InsecureSkipVerify is true, TLS accepts any certificate
300 // presented by the server and any host name in that certificate.
301 // In this mode, TLS is susceptible to man-in-the-middle attacks.
302 // This should be used only for testing.
303 InsecureSkipVerify bool
304
305 // CipherSuites is a list of supported cipher suites. If CipherSuites
306 // is nil, TLS uses a list of suites supported by the implementation.
307 CipherSuites []uint16
308
309 // PreferServerCipherSuites controls whether the server selects the
310 // client's most preferred ciphersuite, or the server's most preferred
311 // ciphersuite. If true then the server's preference, as expressed in
312 // the order of elements in CipherSuites, is used.
313 PreferServerCipherSuites bool
314
315 // SessionTicketsDisabled may be set to true to disable session ticket
316 // (resumption) support.
317 SessionTicketsDisabled bool
318
319 // SessionTicketKey is used by TLS servers to provide session
320 // resumption. See RFC 5077. If zero, it will be filled with
321 // random data before the first server handshake.
322 //
323 // If multiple servers are terminating connections for the same host
324 // they should all have the same SessionTicketKey. If the
325 // SessionTicketKey leaks, previously recorded and future TLS
326 // connections using that key are compromised.
327 SessionTicketKey [32]byte
328
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500329 // ClientSessionCache is a cache of ClientSessionState entries
330 // for TLS session resumption.
Adam Langley95c29f32014-06-20 12:00:00 -0700331 ClientSessionCache ClientSessionCache
332
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500333 // ServerSessionCache is a cache of sessionState entries for TLS session
334 // resumption.
335 ServerSessionCache ServerSessionCache
336
Adam Langley95c29f32014-06-20 12:00:00 -0700337 // MinVersion contains the minimum SSL/TLS version that is acceptable.
338 // If zero, then SSLv3 is taken as the minimum.
339 MinVersion uint16
340
341 // MaxVersion contains the maximum SSL/TLS version that is acceptable.
342 // If zero, then the maximum version supported by this package is used,
343 // which is currently TLS 1.2.
344 MaxVersion uint16
345
346 // CurvePreferences contains the elliptic curves that will be used in
347 // an ECDHE handshake, in preference order. If empty, the default will
348 // be used.
349 CurvePreferences []CurveID
350
David Benjamind30a9902014-08-24 01:44:23 -0400351 // ChannelID contains the ECDSA key for the client to use as
352 // its TLS Channel ID.
353 ChannelID *ecdsa.PrivateKey
354
355 // RequestChannelID controls whether the server requests a TLS
356 // Channel ID. If negotiated, the client's public key is
357 // returned in the ConnectionState.
358 RequestChannelID bool
359
David Benjamin48cae082014-10-27 01:06:24 -0400360 // PreSharedKey, if not nil, is the pre-shared key to use with
361 // the PSK cipher suites.
362 PreSharedKey []byte
363
364 // PreSharedKeyIdentity, if not empty, is the identity to use
365 // with the PSK cipher suites.
366 PreSharedKeyIdentity string
367
David Benjaminca6c8262014-11-15 19:06:08 -0500368 // SRTPProtectionProfiles, if not nil, is the list of SRTP
369 // protection profiles to offer in DTLS-SRTP.
370 SRTPProtectionProfiles []uint16
371
David Benjamin000800a2014-11-14 01:43:59 -0500372 // SignatureAndHashes, if not nil, overrides the default set of
373 // supported signature and hash algorithms to advertise in
374 // CertificateRequest.
375 SignatureAndHashes []signatureAndHash
376
Adam Langley95c29f32014-06-20 12:00:00 -0700377 // Bugs specifies optional misbehaviour to be used for testing other
378 // implementations.
379 Bugs ProtocolBugs
380
381 serverInitOnce sync.Once // guards calling (*Config).serverInit
382}
383
384type BadValue int
385
386const (
387 BadValueNone BadValue = iota
388 BadValueNegative
389 BadValueZero
390 BadValueLimit
391 BadValueLarge
392 NumBadValues
393)
394
395type ProtocolBugs struct {
396 // InvalidSKXSignature specifies that the signature in a
397 // ServerKeyExchange message should be invalid.
398 InvalidSKXSignature bool
399
400 // InvalidSKXCurve causes the curve ID in the ServerKeyExchange message
401 // to be wrong.
402 InvalidSKXCurve bool
403
404 // BadECDSAR controls ways in which the 'r' value of an ECDSA signature
405 // can be invalid.
406 BadECDSAR BadValue
407 BadECDSAS BadValue
Adam Langley80842bd2014-06-20 12:00:00 -0700408
409 // MaxPadding causes CBC records to have the maximum possible padding.
410 MaxPadding bool
411 // PaddingFirstByteBad causes the first byte of the padding to be
412 // incorrect.
413 PaddingFirstByteBad bool
414 // PaddingFirstByteBadIf255 causes the first byte of padding to be
415 // incorrect if there's a maximum amount of padding (i.e. 255 bytes).
416 PaddingFirstByteBadIf255 bool
Adam Langleyac61fa32014-06-23 12:03:11 -0700417
418 // FailIfNotFallbackSCSV causes a server handshake to fail if the
419 // client doesn't send the fallback SCSV value.
420 FailIfNotFallbackSCSV bool
David Benjamin35a7a442014-07-05 00:23:20 -0400421
422 // DuplicateExtension causes an extra empty extension of bogus type to
423 // be emitted in either the ClientHello or the ServerHello.
424 DuplicateExtension bool
David Benjamin1c375dd2014-07-12 00:48:23 -0400425
426 // UnauthenticatedECDH causes the server to pretend ECDHE_RSA
427 // and ECDHE_ECDSA cipher suites are actually ECDH_anon. No
428 // Certificate message is sent and no signature is added to
429 // ServerKeyExchange.
430 UnauthenticatedECDH bool
David Benjamin9c651c92014-07-12 13:27:45 -0400431
432 // SkipServerKeyExchange causes the server to skip sending
433 // ServerKeyExchange messages.
434 SkipServerKeyExchange bool
David Benjamina0e52232014-07-19 17:39:58 -0400435
436 // SkipChangeCipherSpec causes the implementation to skip
437 // sending the ChangeCipherSpec message (and adjusting cipher
438 // state accordingly for the Finished message).
439 SkipChangeCipherSpec bool
David Benjaminf3ec83d2014-07-21 22:42:34 -0400440
441 // EarlyChangeCipherSpec causes the client to send an early
442 // ChangeCipherSpec message before the ClientKeyExchange. A value of
443 // zero disables this behavior. One and two configure variants for 0.9.8
444 // and 1.0.1 modes, respectively.
445 EarlyChangeCipherSpec int
David Benjamind23f4122014-07-23 15:09:48 -0400446
David Benjamin86271ee2014-07-21 16:14:03 -0400447 // FragmentAcrossChangeCipherSpec causes the implementation to fragment
448 // the Finished (or NextProto) message around the ChangeCipherSpec
449 // messages.
450 FragmentAcrossChangeCipherSpec bool
451
David Benjamind23f4122014-07-23 15:09:48 -0400452 // SkipNewSessionTicket causes the server to skip sending the
453 // NewSessionTicket message despite promising to in ServerHello.
454 SkipNewSessionTicket bool
David Benjamind86c7672014-08-02 04:07:12 -0400455
456 // SendV2ClientHello causes the client to send a V2ClientHello
457 // instead of a normal ClientHello.
458 SendV2ClientHello bool
David Benjaminbef270a2014-08-02 04:22:02 -0400459
460 // SendFallbackSCSV causes the client to include
461 // TLS_FALLBACK_SCSV in the ClientHello.
462 SendFallbackSCSV bool
David Benjamin43ec06f2014-08-05 02:28:57 -0400463
464 // MaxHandshakeRecordLength, if non-zero, is the maximum size of a
David Benjamin98214542014-08-07 18:02:39 -0400465 // handshake record. Handshake messages will be split into multiple
466 // records at the specified size, except that the client_version will
467 // never be fragmented.
David Benjamin43ec06f2014-08-05 02:28:57 -0400468 MaxHandshakeRecordLength int
David Benjamina8e3e0e2014-08-06 22:11:10 -0400469
David Benjamin98214542014-08-07 18:02:39 -0400470 // FragmentClientVersion will allow MaxHandshakeRecordLength to apply to
471 // the first 6 bytes of the ClientHello.
472 FragmentClientVersion bool
473
Alex Chernyakhovsky4cd8c432014-11-01 19:39:08 -0400474 // FragmentAlert will cause all alerts to be fragmented across
475 // two records.
476 FragmentAlert bool
477
478 // SendSpuriousAlert will cause an spurious, unwanted alert to be sent.
479 SendSpuriousAlert bool
480
David Benjamina8e3e0e2014-08-06 22:11:10 -0400481 // RsaClientKeyExchangeVersion, if non-zero, causes the client to send a
482 // ClientKeyExchange with the specified version rather than the
483 // client_version when performing the RSA key exchange.
484 RsaClientKeyExchangeVersion uint16
David Benjaminbed9aae2014-08-07 19:13:38 -0400485
486 // RenewTicketOnResume causes the server to renew the session ticket and
487 // send a NewSessionTicket message during an abbreviated handshake.
488 RenewTicketOnResume bool
David Benjamin98e882e2014-08-08 13:24:34 -0400489
490 // SendClientVersion, if non-zero, causes the client to send a different
491 // TLS version in the ClientHello than the maximum supported version.
492 SendClientVersion uint16
David Benjamin83c0bc92014-08-04 01:23:53 -0400493
494 // SkipHelloVerifyRequest causes a DTLS server to skip the
495 // HelloVerifyRequest message.
496 SkipHelloVerifyRequest bool
David Benjamine58c4f52014-08-24 03:47:07 -0400497
498 // ExpectFalseStart causes the server to, on full handshakes,
499 // expect the peer to False Start; the server Finished message
500 // isn't sent until we receive an application data record
501 // from the peer.
502 ExpectFalseStart bool
David Benjamin5c24a1d2014-08-31 00:59:27 -0400503
504 // SSL3RSAKeyExchange causes the client to always send an RSA
505 // ClientKeyExchange message without the two-byte length
506 // prefix, as if it were SSL3.
507 SSL3RSAKeyExchange bool
David Benjamin39ebf532014-08-31 02:23:49 -0400508
509 // SkipCipherVersionCheck causes the server to negotiate
510 // TLS 1.2 ciphers in earlier versions of TLS.
511 SkipCipherVersionCheck bool
David Benjamine78bfde2014-09-06 12:45:15 -0400512
513 // ExpectServerName, if not empty, is the hostname the client
514 // must specify in the server_name extension.
515 ExpectServerName string
David Benjaminfc7b0862014-09-06 13:21:53 -0400516
517 // SwapNPNAndALPN switches the relative order between NPN and
518 // ALPN on the server. This is to test that server preference
519 // of ALPN works regardless of their relative order.
520 SwapNPNAndALPN bool
David Benjamin01fe8202014-09-24 15:21:44 -0400521
522 // AllowSessionVersionMismatch causes the server to resume sessions
523 // regardless of the version associated with the session.
524 AllowSessionVersionMismatch bool
Adam Langley38311732014-10-16 19:04:35 -0700525
526 // CorruptTicket causes a client to corrupt a session ticket before
527 // sending it in a resume handshake.
528 CorruptTicket bool
529
530 // OversizedSessionId causes the session id that is sent with a ticket
531 // resumption attempt to be too large (33 bytes).
532 OversizedSessionId bool
Adam Langley75712922014-10-10 16:23:43 -0700533
534 // RequireExtendedMasterSecret, if true, requires that the peer support
535 // the extended master secret option.
536 RequireExtendedMasterSecret bool
537
David Benjaminca6554b2014-11-08 12:31:52 -0500538 // NoExtendedMasterSecret causes the client and server to behave as if
Adam Langley75712922014-10-10 16:23:43 -0700539 // they didn't support an extended master secret.
540 NoExtendedMasterSecret bool
Adam Langley2ae77d22014-10-28 17:29:33 -0700541
542 // EmptyRenegotiationInfo causes the renegotiation extension to be
543 // empty in a renegotiation handshake.
544 EmptyRenegotiationInfo bool
545
546 // BadRenegotiationInfo causes the renegotiation extension value in a
547 // renegotiation handshake to be incorrect.
548 BadRenegotiationInfo bool
David Benjamin5e961c12014-11-07 01:48:35 -0500549
David Benjaminca6554b2014-11-08 12:31:52 -0500550 // NoRenegotiationInfo causes the client to behave as if it
551 // didn't support the renegotiation info extension.
552 NoRenegotiationInfo bool
553
David Benjamin5e961c12014-11-07 01:48:35 -0500554 // SequenceNumberIncrement, if non-zero, causes outgoing sequence
555 // numbers in DTLS to increment by that value rather by 1. This is to
556 // stress the replay bitmap window by simulating extreme packet loss and
557 // retransmit at the record layer.
558 SequenceNumberIncrement uint64
David Benjamin9114fae2014-11-08 11:41:14 -0500559
560 // RSAServerKeyExchange, if true, causes the server to send a
561 // ServerKeyExchange message in the plain RSA key exchange.
562 RSAServerKeyExchange bool
David Benjaminca6c8262014-11-15 19:06:08 -0500563
564 // SRTPMasterKeyIdentifer, if not empty, is the SRTP MKI value that the
565 // client offers when negotiating SRTP. MKI support is still missing so
566 // the peer must still send none.
567 SRTPMasterKeyIdentifer string
568
569 // SendSRTPProtectionProfile, if non-zero, is the SRTP profile that the
570 // server sends in the ServerHello instead of the negotiated one.
571 SendSRTPProtectionProfile uint16
David Benjamin000800a2014-11-14 01:43:59 -0500572
573 // NoSignatureAndHashes, if true, causes the client to omit the
574 // signature and hashes extension.
575 //
576 // For a server, it will cause an empty list to be sent in the
577 // CertificateRequest message. None the less, the configured set will
578 // still be enforced.
579 NoSignatureAndHashes bool
David Benjaminc44b1df2014-11-23 12:11:01 -0500580
581 // RequireSameRenegoClientVersion, if true, causes the server
582 // to require that all ClientHellos match in offered version
583 // across a renego.
584 RequireSameRenegoClientVersion bool
Feng Lu41aa3252014-11-21 22:47:56 -0800585
586 // RequireFastradioPadding, if true, requires that ClientHello messages
587 // be at least 1000 bytes long.
588 RequireFastradioPadding bool
David Benjamin1e29a6b2014-12-10 02:27:24 -0500589
590 // ExpectInitialRecordVersion, if non-zero, is the expected
591 // version of the records before the version is determined.
592 ExpectInitialRecordVersion uint16
Adam Langley95c29f32014-06-20 12:00:00 -0700593}
594
595func (c *Config) serverInit() {
596 if c.SessionTicketsDisabled {
597 return
598 }
599
600 // If the key has already been set then we have nothing to do.
601 for _, b := range c.SessionTicketKey {
602 if b != 0 {
603 return
604 }
605 }
606
607 if _, err := io.ReadFull(c.rand(), c.SessionTicketKey[:]); err != nil {
608 c.SessionTicketsDisabled = true
609 }
610}
611
612func (c *Config) rand() io.Reader {
613 r := c.Rand
614 if r == nil {
615 return rand.Reader
616 }
617 return r
618}
619
620func (c *Config) time() time.Time {
621 t := c.Time
622 if t == nil {
623 t = time.Now
624 }
625 return t()
626}
627
628func (c *Config) cipherSuites() []uint16 {
629 s := c.CipherSuites
630 if s == nil {
631 s = defaultCipherSuites()
632 }
633 return s
634}
635
636func (c *Config) minVersion() uint16 {
637 if c == nil || c.MinVersion == 0 {
638 return minVersion
639 }
640 return c.MinVersion
641}
642
643func (c *Config) maxVersion() uint16 {
644 if c == nil || c.MaxVersion == 0 {
645 return maxVersion
646 }
647 return c.MaxVersion
648}
649
650var defaultCurvePreferences = []CurveID{CurveP256, CurveP384, CurveP521}
651
652func (c *Config) curvePreferences() []CurveID {
653 if c == nil || len(c.CurvePreferences) == 0 {
654 return defaultCurvePreferences
655 }
656 return c.CurvePreferences
657}
658
659// mutualVersion returns the protocol version to use given the advertised
660// version of the peer.
661func (c *Config) mutualVersion(vers uint16) (uint16, bool) {
662 minVersion := c.minVersion()
663 maxVersion := c.maxVersion()
664
665 if vers < minVersion {
666 return 0, false
667 }
668 if vers > maxVersion {
669 vers = maxVersion
670 }
671 return vers, true
672}
673
674// getCertificateForName returns the best certificate for the given name,
675// defaulting to the first element of c.Certificates if there are no good
676// options.
677func (c *Config) getCertificateForName(name string) *Certificate {
678 if len(c.Certificates) == 1 || c.NameToCertificate == nil {
679 // There's only one choice, so no point doing any work.
680 return &c.Certificates[0]
681 }
682
683 name = strings.ToLower(name)
684 for len(name) > 0 && name[len(name)-1] == '.' {
685 name = name[:len(name)-1]
686 }
687
688 if cert, ok := c.NameToCertificate[name]; ok {
689 return cert
690 }
691
692 // try replacing labels in the name with wildcards until we get a
693 // match.
694 labels := strings.Split(name, ".")
695 for i := range labels {
696 labels[i] = "*"
697 candidate := strings.Join(labels, ".")
698 if cert, ok := c.NameToCertificate[candidate]; ok {
699 return cert
700 }
701 }
702
703 // If nothing matches, return the first certificate.
704 return &c.Certificates[0]
705}
706
David Benjamin000800a2014-11-14 01:43:59 -0500707func (c *Config) signatureAndHashesForServer() []signatureAndHash {
708 if c != nil && c.SignatureAndHashes != nil {
709 return c.SignatureAndHashes
710 }
711 return supportedClientCertSignatureAlgorithms
712}
713
714func (c *Config) signatureAndHashesForClient() []signatureAndHash {
715 if c != nil && c.SignatureAndHashes != nil {
716 return c.SignatureAndHashes
717 }
718 return supportedSKXSignatureAlgorithms
719}
720
Adam Langley95c29f32014-06-20 12:00:00 -0700721// BuildNameToCertificate parses c.Certificates and builds c.NameToCertificate
722// from the CommonName and SubjectAlternateName fields of each of the leaf
723// certificates.
724func (c *Config) BuildNameToCertificate() {
725 c.NameToCertificate = make(map[string]*Certificate)
726 for i := range c.Certificates {
727 cert := &c.Certificates[i]
728 x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
729 if err != nil {
730 continue
731 }
732 if len(x509Cert.Subject.CommonName) > 0 {
733 c.NameToCertificate[x509Cert.Subject.CommonName] = cert
734 }
735 for _, san := range x509Cert.DNSNames {
736 c.NameToCertificate[san] = cert
737 }
738 }
739}
740
741// A Certificate is a chain of one or more certificates, leaf first.
742type Certificate struct {
743 Certificate [][]byte
744 PrivateKey crypto.PrivateKey // supported types: *rsa.PrivateKey, *ecdsa.PrivateKey
745 // OCSPStaple contains an optional OCSP response which will be served
746 // to clients that request it.
747 OCSPStaple []byte
David Benjamin61f95272014-11-25 01:55:35 -0500748 // SignedCertificateTimestampList contains an optional encoded
749 // SignedCertificateTimestampList structure which will be
750 // served to clients that request it.
751 SignedCertificateTimestampList []byte
Adam Langley95c29f32014-06-20 12:00:00 -0700752 // Leaf is the parsed form of the leaf certificate, which may be
753 // initialized using x509.ParseCertificate to reduce per-handshake
754 // processing for TLS clients doing client authentication. If nil, the
755 // leaf certificate will be parsed as needed.
756 Leaf *x509.Certificate
757}
758
759// A TLS record.
760type record struct {
761 contentType recordType
762 major, minor uint8
763 payload []byte
764}
765
766type handshakeMessage interface {
767 marshal() []byte
768 unmarshal([]byte) bool
769}
770
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500771// lruSessionCache is a client or server session cache implementation
772// that uses an LRU caching strategy.
Adam Langley95c29f32014-06-20 12:00:00 -0700773type lruSessionCache struct {
774 sync.Mutex
775
776 m map[string]*list.Element
777 q *list.List
778 capacity int
779}
780
781type lruSessionCacheEntry struct {
782 sessionKey string
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500783 state interface{}
Adam Langley95c29f32014-06-20 12:00:00 -0700784}
785
786// Put adds the provided (sessionKey, cs) pair to the cache.
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500787func (c *lruSessionCache) Put(sessionKey string, cs interface{}) {
Adam Langley95c29f32014-06-20 12:00:00 -0700788 c.Lock()
789 defer c.Unlock()
790
791 if elem, ok := c.m[sessionKey]; ok {
792 entry := elem.Value.(*lruSessionCacheEntry)
793 entry.state = cs
794 c.q.MoveToFront(elem)
795 return
796 }
797
798 if c.q.Len() < c.capacity {
799 entry := &lruSessionCacheEntry{sessionKey, cs}
800 c.m[sessionKey] = c.q.PushFront(entry)
801 return
802 }
803
804 elem := c.q.Back()
805 entry := elem.Value.(*lruSessionCacheEntry)
806 delete(c.m, entry.sessionKey)
807 entry.sessionKey = sessionKey
808 entry.state = cs
809 c.q.MoveToFront(elem)
810 c.m[sessionKey] = elem
811}
812
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500813// Get returns the value associated with a given key. It returns (nil,
814// false) if no value is found.
815func (c *lruSessionCache) Get(sessionKey string) (interface{}, bool) {
Adam Langley95c29f32014-06-20 12:00:00 -0700816 c.Lock()
817 defer c.Unlock()
818
819 if elem, ok := c.m[sessionKey]; ok {
820 c.q.MoveToFront(elem)
821 return elem.Value.(*lruSessionCacheEntry).state, true
822 }
823 return nil, false
824}
825
David Benjaminfe8eb9a2014-11-17 03:19:02 -0500826// lruClientSessionCache is a ClientSessionCache implementation that
827// uses an LRU caching strategy.
828type lruClientSessionCache struct {
829 lruSessionCache
830}
831
832func (c *lruClientSessionCache) Put(sessionKey string, cs *ClientSessionState) {
833 c.lruSessionCache.Put(sessionKey, cs)
834}
835
836func (c *lruClientSessionCache) Get(sessionKey string) (*ClientSessionState, bool) {
837 cs, ok := c.lruSessionCache.Get(sessionKey)
838 if !ok {
839 return nil, false
840 }
841 return cs.(*ClientSessionState), true
842}
843
844// lruServerSessionCache is a ServerSessionCache implementation that
845// uses an LRU caching strategy.
846type lruServerSessionCache struct {
847 lruSessionCache
848}
849
850func (c *lruServerSessionCache) Put(sessionId string, session *sessionState) {
851 c.lruSessionCache.Put(sessionId, session)
852}
853
854func (c *lruServerSessionCache) Get(sessionId string) (*sessionState, bool) {
855 cs, ok := c.lruSessionCache.Get(sessionId)
856 if !ok {
857 return nil, false
858 }
859 return cs.(*sessionState), true
860}
861
862// NewLRUClientSessionCache returns a ClientSessionCache with the given
863// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
864// is used instead.
865func NewLRUClientSessionCache(capacity int) ClientSessionCache {
866 const defaultSessionCacheCapacity = 64
867
868 if capacity < 1 {
869 capacity = defaultSessionCacheCapacity
870 }
871 return &lruClientSessionCache{
872 lruSessionCache{
873 m: make(map[string]*list.Element),
874 q: list.New(),
875 capacity: capacity,
876 },
877 }
878}
879
880// NewLRUServerSessionCache returns a ServerSessionCache with the given
881// capacity that uses an LRU strategy. If capacity is < 1, a default capacity
882// is used instead.
883func NewLRUServerSessionCache(capacity int) ServerSessionCache {
884 const defaultSessionCacheCapacity = 64
885
886 if capacity < 1 {
887 capacity = defaultSessionCacheCapacity
888 }
889 return &lruServerSessionCache{
890 lruSessionCache{
891 m: make(map[string]*list.Element),
892 q: list.New(),
893 capacity: capacity,
894 },
895 }
896}
897
Adam Langley95c29f32014-06-20 12:00:00 -0700898// TODO(jsing): Make these available to both crypto/x509 and crypto/tls.
899type dsaSignature struct {
900 R, S *big.Int
901}
902
903type ecdsaSignature dsaSignature
904
905var emptyConfig Config
906
907func defaultConfig() *Config {
908 return &emptyConfig
909}
910
911var (
912 once sync.Once
913 varDefaultCipherSuites []uint16
914)
915
916func defaultCipherSuites() []uint16 {
917 once.Do(initDefaultCipherSuites)
918 return varDefaultCipherSuites
919}
920
921func initDefaultCipherSuites() {
David Benjamin48cae082014-10-27 01:06:24 -0400922 for _, suite := range cipherSuites {
923 if suite.flags&suitePSK == 0 {
924 varDefaultCipherSuites = append(varDefaultCipherSuites, suite.id)
925 }
Adam Langley95c29f32014-06-20 12:00:00 -0700926 }
927}
928
929func unexpectedMessageError(wanted, got interface{}) error {
930 return fmt.Errorf("tls: received unexpected handshake message of type %T when waiting for %T", got, wanted)
931}
David Benjamin000800a2014-11-14 01:43:59 -0500932
933func isSupportedSignatureAndHash(sigHash signatureAndHash, sigHashes []signatureAndHash) bool {
934 for _, s := range sigHashes {
935 if s == sigHash {
936 return true
937 }
938 }
939 return false
940}