1 // Copyright 2010 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.
17 "golang.org/x/crypto/chacha20poly1305"
21 import "crypto/internal/boring"
23 // a keyAgreement implements the client and server side of a TLS key agreement
24 // protocol by generating and processing key exchange messages.
25 type keyAgreement interface {
26 // On the server side, the first two methods are called in order.
28 // In the case that the key agreement protocol doesn't use a
29 // ServerKeyExchange message, generateServerKeyExchange can return nil,
31 generateServerKeyExchange(*Config, *Certificate, *clientHelloMsg, *serverHelloMsg) (*serverKeyExchangeMsg, error)
32 processClientKeyExchange(*Config, *Certificate, *clientKeyExchangeMsg, uint16) ([]byte, error)
34 // On the client side, the next two methods are called in order.
36 // This method may not be called if the server doesn't send a
37 // ServerKeyExchange message.
38 processServerKeyExchange(*Config, *clientHelloMsg, *serverHelloMsg, *x509.Certificate, *serverKeyExchangeMsg) error
39 generateClientKeyExchange(*Config, *clientHelloMsg, *x509.Certificate) ([]byte, *clientKeyExchangeMsg, error)
43 // suiteECDH indicates that the cipher suite involves elliptic curve
44 // Diffie-Hellman. This means that it should only be selected when the
45 // client indicates that it supports ECC with a curve and point format
46 // that we're happy with.
47 suiteECDHE = 1 << iota
48 // suiteECSign indicates that the cipher suite involves an ECDSA or
49 // EdDSA signature and therefore may only be selected when the server's
50 // certificate is ECDSA or EdDSA. If this is not set then the cipher suite
53 // suiteTLS12 indicates that the cipher suite should only be advertised
54 // and accepted when using TLS 1.2.
56 // suiteSHA384 indicates that the cipher suite uses SHA384 as the
59 // suiteDefaultOff indicates that this cipher suite is not included by
64 // A cipherSuite is a specific combination of key agreement, cipher and MAC function.
65 type cipherSuite struct {
67 // the lengths, in bytes, of the key material needed for each component.
71 ka func(version uint16) keyAgreement
72 // flags is a bitmask of the suite* values, above.
74 cipher func(key, iv []byte, isRead bool) interface{}
75 mac func(version uint16, macKey []byte) macFunction
76 aead func(key, fixedNonce []byte) aead
79 var cipherSuites = []*cipherSuite{
80 // Ciphersuite order is chosen so that ECDHE comes before plain RSA and
81 // AEADs are the top preference.
82 {TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305, 32, 0, 12, ecdheRSAKA, suiteECDHE | suiteTLS12, nil, nil, aeadChaCha20Poly1305},
83 {TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305, 32, 0, 12, ecdheECDSAKA, suiteECDHE | suiteECSign | suiteTLS12, nil, nil, aeadChaCha20Poly1305},
84 {TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, 16, 0, 4, ecdheRSAKA, suiteECDHE | suiteTLS12, nil, nil, aeadAESGCM},
85 {TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, 16, 0, 4, ecdheECDSAKA, suiteECDHE | suiteECSign | suiteTLS12, nil, nil, aeadAESGCM},
86 {TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, 32, 0, 4, ecdheRSAKA, suiteECDHE | suiteTLS12 | suiteSHA384, nil, nil, aeadAESGCM},
87 {TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, 32, 0, 4, ecdheECDSAKA, suiteECDHE | suiteECSign | suiteTLS12 | suiteSHA384, nil, nil, aeadAESGCM},
88 {TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, 16, 32, 16, ecdheRSAKA, suiteECDHE | suiteTLS12 | suiteDefaultOff, cipherAES, macSHA256, nil},
89 {TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, 16, 20, 16, ecdheRSAKA, suiteECDHE, cipherAES, macSHA1, nil},
90 {TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, 16, 32, 16, ecdheECDSAKA, suiteECDHE | suiteECSign | suiteTLS12 | suiteDefaultOff, cipherAES, macSHA256, nil},
91 {TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, 16, 20, 16, ecdheECDSAKA, suiteECDHE | suiteECSign, cipherAES, macSHA1, nil},
92 {TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, 32, 20, 16, ecdheRSAKA, suiteECDHE, cipherAES, macSHA1, nil},
93 {TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, 32, 20, 16, ecdheECDSAKA, suiteECDHE | suiteECSign, cipherAES, macSHA1, nil},
94 {TLS_RSA_WITH_AES_128_GCM_SHA256, 16, 0, 4, rsaKA, suiteTLS12, nil, nil, aeadAESGCM},
95 {TLS_RSA_WITH_AES_256_GCM_SHA384, 32, 0, 4, rsaKA, suiteTLS12 | suiteSHA384, nil, nil, aeadAESGCM},
96 {TLS_RSA_WITH_AES_128_CBC_SHA256, 16, 32, 16, rsaKA, suiteTLS12 | suiteDefaultOff, cipherAES, macSHA256, nil},
97 {TLS_RSA_WITH_AES_128_CBC_SHA, 16, 20, 16, rsaKA, 0, cipherAES, macSHA1, nil},
98 {TLS_RSA_WITH_AES_256_CBC_SHA, 32, 20, 16, rsaKA, 0, cipherAES, macSHA1, nil},
99 {TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, 24, 20, 8, ecdheRSAKA, suiteECDHE, cipher3DES, macSHA1, nil},
100 {TLS_RSA_WITH_3DES_EDE_CBC_SHA, 24, 20, 8, rsaKA, 0, cipher3DES, macSHA1, nil},
102 // RC4-based cipher suites are disabled by default.
103 {TLS_RSA_WITH_RC4_128_SHA, 16, 20, 0, rsaKA, suiteDefaultOff, cipherRC4, macSHA1, nil},
104 {TLS_ECDHE_RSA_WITH_RC4_128_SHA, 16, 20, 0, ecdheRSAKA, suiteECDHE | suiteDefaultOff, cipherRC4, macSHA1, nil},
105 {TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, 16, 20, 0, ecdheECDSAKA, suiteECDHE | suiteECSign | suiteDefaultOff, cipherRC4, macSHA1, nil},
108 // A cipherSuiteTLS13 defines only the pair of the AEAD algorithm and hash
109 // algorithm to be used with HKDF. See RFC 8446, Appendix B.4.
110 type cipherSuiteTLS13 struct {
113 aead func(key, fixedNonce []byte) aead
117 var cipherSuitesTLS13 = []*cipherSuiteTLS13{
118 {TLS_AES_128_GCM_SHA256, 16, aeadAESGCMTLS13, crypto.SHA256},
119 {TLS_CHACHA20_POLY1305_SHA256, 32, aeadChaCha20Poly1305, crypto.SHA256},
120 {TLS_AES_256_GCM_SHA384, 32, aeadAESGCMTLS13, crypto.SHA384},
123 func cipherRC4(key, iv []byte, isRead bool) interface{} {
124 cipher, _ := rc4.NewCipher(key)
128 func cipher3DES(key, iv []byte, isRead bool) interface{} {
129 block, _ := des.NewTripleDESCipher(key)
131 return cipher.NewCBCDecrypter(block, iv)
133 return cipher.NewCBCEncrypter(block, iv)
136 func cipherAES(key, iv []byte, isRead bool) interface{} {
137 block, _ := aes.NewCipher(key)
139 return cipher.NewCBCDecrypter(block, iv)
141 return cipher.NewCBCEncrypter(block, iv)
144 // macSHA1 returns a macFunction for the given protocol version.
145 func macSHA1(version uint16, key []byte) macFunction {
147 // The BoringCrypto SHA1 does not have a constant-time
148 // checksum function, so don't try to use it.
150 h = newConstantTimeHash(h)
152 return tls10MAC{h: hmac.New(h, key)}
155 // macSHA256 returns a SHA-256 based MAC. These are only supported in TLS 1.2
156 // so the given version is ignored.
157 func macSHA256(version uint16, key []byte) macFunction {
158 return tls10MAC{h: hmac.New(sha256.New, key)}
161 type macFunction interface {
162 // Size returns the length of the MAC.
164 // MAC appends the MAC of (seq, header, data) to out. The extra data is fed
165 // into the MAC after obtaining the result to normalize timing. The result
166 // is only valid until the next invocation of MAC as the buffer is reused.
167 MAC(seq, header, data, extra []byte) []byte
170 type aead interface {
173 // explicitNonceLen returns the number of bytes of explicit nonce
174 // included in each record. This is eight for older AEADs and
175 // zero for modern ones.
176 explicitNonceLen() int
181 noncePrefixLength = 4
184 // prefixNonceAEAD wraps an AEAD and prefixes a fixed portion of the nonce to
186 type prefixNonceAEAD struct {
187 // nonce contains the fixed part of the nonce in the first four bytes.
188 nonce [aeadNonceLength]byte
192 func (f *prefixNonceAEAD) NonceSize() int { return aeadNonceLength - noncePrefixLength }
193 func (f *prefixNonceAEAD) Overhead() int { return f.aead.Overhead() }
194 func (f *prefixNonceAEAD) explicitNonceLen() int { return f.NonceSize() }
196 func (f *prefixNonceAEAD) Seal(out, nonce, plaintext, additionalData []byte) []byte {
197 copy(f.nonce[4:], nonce)
198 return f.aead.Seal(out, f.nonce[:], plaintext, additionalData)
201 func (f *prefixNonceAEAD) Open(out, nonce, ciphertext, additionalData []byte) ([]byte, error) {
202 copy(f.nonce[4:], nonce)
203 return f.aead.Open(out, f.nonce[:], ciphertext, additionalData)
206 // xoredNonceAEAD wraps an AEAD by XORing in a fixed pattern to the nonce
208 type xorNonceAEAD struct {
209 nonceMask [aeadNonceLength]byte
213 func (f *xorNonceAEAD) NonceSize() int { return 8 } // 64-bit sequence number
214 func (f *xorNonceAEAD) Overhead() int { return f.aead.Overhead() }
215 func (f *xorNonceAEAD) explicitNonceLen() int { return 0 }
217 func (f *xorNonceAEAD) Seal(out, nonce, plaintext, additionalData []byte) []byte {
218 for i, b := range nonce {
219 f.nonceMask[4+i] ^= b
221 result := f.aead.Seal(out, f.nonceMask[:], plaintext, additionalData)
222 for i, b := range nonce {
223 f.nonceMask[4+i] ^= b
229 func (f *xorNonceAEAD) Open(out, nonce, ciphertext, additionalData []byte) ([]byte, error) {
230 for i, b := range nonce {
231 f.nonceMask[4+i] ^= b
233 result, err := f.aead.Open(out, f.nonceMask[:], ciphertext, additionalData)
234 for i, b := range nonce {
235 f.nonceMask[4+i] ^= b
241 type gcmtls interface {
242 NewGCMTLS() (cipher.AEAD, error)
245 func aeadAESGCM(key, noncePrefix []byte) aead {
246 if len(noncePrefix) != noncePrefixLength {
247 panic("tls: internal error: wrong nonce length")
249 aes, err := aes.NewCipher(key)
254 if aesTLS, ok := aes.(gcmtls); ok {
255 aead, err = aesTLS.NewGCMTLS()
258 aead, err = cipher.NewGCM(aes)
264 ret := &prefixNonceAEAD{aead: aead}
265 copy(ret.nonce[:], noncePrefix)
269 func aeadAESGCMTLS13(key, nonceMask []byte) aead {
270 if len(nonceMask) != aeadNonceLength {
271 panic("tls: internal error: wrong nonce length")
273 aes, err := aes.NewCipher(key)
277 aead, err := cipher.NewGCM(aes)
282 ret := &xorNonceAEAD{aead: aead}
283 copy(ret.nonceMask[:], nonceMask)
287 func aeadChaCha20Poly1305(key, nonceMask []byte) aead {
288 if len(nonceMask) != aeadNonceLength {
289 panic("tls: internal error: wrong nonce length")
291 aead, err := chacha20poly1305.New(key)
296 ret := &xorNonceAEAD{aead: aead}
297 copy(ret.nonceMask[:], nonceMask)
301 type constantTimeHash interface {
303 ConstantTimeSum(b []byte) []byte
306 // cthWrapper wraps any hash.Hash that implements ConstantTimeSum, and replaces
307 // with that all calls to Sum. It's used to obtain a ConstantTimeSum-based HMAC.
308 type cthWrapper struct {
312 func (c *cthWrapper) Size() int { return c.h.Size() }
313 func (c *cthWrapper) BlockSize() int { return c.h.BlockSize() }
314 func (c *cthWrapper) Reset() { c.h.Reset() }
315 func (c *cthWrapper) Write(p []byte) (int, error) { return c.h.Write(p) }
316 func (c *cthWrapper) Sum(b []byte) []byte { return c.h.ConstantTimeSum(b) }
318 func newConstantTimeHash(h func() hash.Hash) func() hash.Hash {
320 return func() hash.Hash {
321 return &cthWrapper{h().(constantTimeHash)}
325 // tls10MAC implements the TLS 1.0 MAC function. RFC 2246, Section 6.2.3.
326 type tls10MAC struct {
331 func (s tls10MAC) Size() int {
335 // MAC is guaranteed to take constant time, as long as
336 // len(seq)+len(header)+len(data)+len(extra) is constant. extra is not fed into
337 // the MAC, but is only provided to make the timing profile constant.
338 func (s tls10MAC) MAC(seq, header, data, extra []byte) []byte {
343 res := s.h.Sum(s.buf[:0])
350 func rsaKA(version uint16) keyAgreement {
351 return rsaKeyAgreement{}
354 func ecdheECDSAKA(version uint16) keyAgreement {
355 return &ecdheKeyAgreement{
361 func ecdheRSAKA(version uint16) keyAgreement {
362 return &ecdheKeyAgreement{
368 // mutualCipherSuite returns a cipherSuite given a list of supported
369 // ciphersuites and the id requested by the peer.
370 func mutualCipherSuite(have []uint16, want uint16) *cipherSuite {
371 for _, id := range have {
373 return cipherSuiteByID(id)
379 func cipherSuiteByID(id uint16) *cipherSuite {
380 for _, cipherSuite := range cipherSuites {
381 if cipherSuite.id == id {
388 func mutualCipherSuiteTLS13(have []uint16, want uint16) *cipherSuiteTLS13 {
389 for _, id := range have {
391 return cipherSuiteTLS13ByID(id)
397 func cipherSuiteTLS13ByID(id uint16) *cipherSuiteTLS13 {
398 for _, cipherSuite := range cipherSuitesTLS13 {
399 if cipherSuite.id == id {
406 // A list of cipher suite IDs that are, or have been, implemented by this
409 // Taken from https://www.iana.org/assignments/tls-parameters/tls-parameters.xml
411 // TLS 1.0 - 1.2 cipher suites.
412 TLS_RSA_WITH_RC4_128_SHA uint16 = 0x0005
413 TLS_RSA_WITH_3DES_EDE_CBC_SHA uint16 = 0x000a
414 TLS_RSA_WITH_AES_128_CBC_SHA uint16 = 0x002f
415 TLS_RSA_WITH_AES_256_CBC_SHA uint16 = 0x0035
416 TLS_RSA_WITH_AES_128_CBC_SHA256 uint16 = 0x003c
417 TLS_RSA_WITH_AES_128_GCM_SHA256 uint16 = 0x009c
418 TLS_RSA_WITH_AES_256_GCM_SHA384 uint16 = 0x009d
419 TLS_ECDHE_ECDSA_WITH_RC4_128_SHA uint16 = 0xc007
420 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA uint16 = 0xc009
421 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA uint16 = 0xc00a
422 TLS_ECDHE_RSA_WITH_RC4_128_SHA uint16 = 0xc011
423 TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA uint16 = 0xc012
424 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA uint16 = 0xc013
425 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA uint16 = 0xc014
426 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 uint16 = 0xc023
427 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 uint16 = 0xc027
428 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 uint16 = 0xc02f
429 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 uint16 = 0xc02b
430 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 uint16 = 0xc030
431 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 uint16 = 0xc02c
432 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305 uint16 = 0xcca8
433 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 uint16 = 0xcca9
435 // TLS 1.3 cipher suites.
436 TLS_AES_128_GCM_SHA256 uint16 = 0x1301
437 TLS_AES_256_GCM_SHA384 uint16 = 0x1302
438 TLS_CHACHA20_POLY1305_SHA256 uint16 = 0x1303
440 // TLS_FALLBACK_SCSV isn't a standard cipher suite but an indicator
441 // that the client is doing version fallback. See RFC 7507.
442 TLS_FALLBACK_SCSV uint16 = 0x5600