src/crypto/tls/cipher_suites.go

   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.
   4
   5 package tls
   6
   7 import (
   8         "crypto/aes"
   9         "crypto/cipher"
  10         "crypto/des"
  11         "crypto/hmac"
  12         "crypto/internal/boring"
  13         "crypto/rc4"
  14         "crypto/sha1"
  15         "crypto/sha256"
  16         "crypto/x509"
  17         "hash"
  18
  19         "golang_org/x/crypto/chacha20poly1305"
  20 )
  21
  22 // a keyAgreement implements the client and server side of a TLS key agreement
  23 // protocol by generating and processing key exchange messages.
  24 type keyAgreement interface {
  25         // On the server side, the first two methods are called in order.
  26
  27         // In the case that the key agreement protocol doesn't use a
  28         // ServerKeyExchange message, generateServerKeyExchange can return nil,
  29         // nil.
  30         generateServerKeyExchange(*Config, *Certificate, *clientHelloMsg, *serverHelloMsg) (*serverKeyExchangeMsg, error)
  31         processClientKeyExchange(*Config, *Certificate, *clientKeyExchangeMsg, uint16) ([]byte, error)
  32
  33         // On the client side, the next two methods are called in order.
  34
  35         // This method may not be called if the server doesn't send a
  36         // ServerKeyExchange message.
  37         processServerKeyExchange(*Config, *clientHelloMsg, *serverHelloMsg, *x509.Certificate, *serverKeyExchangeMsg) error
  38         generateClientKeyExchange(*Config, *clientHelloMsg, *x509.Certificate) ([]byte, *clientKeyExchangeMsg, error)
  39 }
  40
  41 const (
  42         // suiteECDH indicates that the cipher suite involves elliptic curve
  43         // Diffie-Hellman. This means that it should only be selected when the
  44         // client indicates that it supports ECC with a curve and point format
  45         // that we're happy with.
  46         suiteECDHE = 1 << iota
  47         // suiteECDSA indicates that the cipher suite involves an ECDSA
  48         // signature and therefore may only be selected when the server's
  49         // certificate is ECDSA. If this is not set then the cipher suite is
  50         // RSA based.
  51         suiteECDSA
  52         // suiteTLS12 indicates that the cipher suite should only be advertised
  53         // and accepted when using TLS 1.2.
  54         suiteTLS12
  55         // suiteSHA384 indicates that the cipher suite uses SHA384 as the
  56         // handshake hash.
  57         suiteSHA384
  58         // suiteDefaultOff indicates that this cipher suite is not included by
  59         // default.
  60         suiteDefaultOff
  61 )
  62
  63 // A cipherSuite is a specific combination of key agreement, cipher and MAC
  64 // function. All cipher suites currently assume RSA key agreement.
  65 type cipherSuite struct {
  66         id uint16
  67         // the lengths, in bytes, of the key material needed for each component.
  68         keyLen int
  69         macLen int
  70         ivLen  int
  71         ka     func(version uint16) keyAgreement
  72         // flags is a bitmask of the suite* values, above.
  73         flags  int
  74         cipher func(key, iv []byte, isRead bool) interface{}
  75         mac    func(version uint16, macKey []byte) macFunction
  76         aead   func(key, fixedNonce []byte) cipher.AEAD
  77 }
  78
  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 | suiteECDSA | 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 | suiteECDSA | 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 | suiteECDSA | 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 | suiteECDSA | suiteTLS12 | suiteDefaultOff, cipherAES, macSHA256, nil},
  91         {TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, 16, 20, 16, ecdheECDSAKA, suiteECDHE | suiteECDSA, 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 | suiteECDSA, 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},
 101
 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 | suiteECDSA | suiteDefaultOff, cipherRC4, macSHA1, nil},
 106 }
 107
 108 func cipherRC4(key, iv []byte, isRead bool) interface{} {
 109         cipher, _ := rc4.NewCipher(key)
 110         return cipher
 111 }
 112
 113 func cipher3DES(key, iv []byte, isRead bool) interface{} {
 114         block, _ := des.NewTripleDESCipher(key)
 115         if isRead {
 116                 return cipher.NewCBCDecrypter(block, iv)
 117         }
 118         return cipher.NewCBCEncrypter(block, iv)
 119 }
 120
 121 func cipherAES(key, iv []byte, isRead bool) interface{} {
 122         block, _ := aes.NewCipher(key)
 123         if isRead {
 124                 return cipher.NewCBCDecrypter(block, iv)
 125         }
 126         return cipher.NewCBCEncrypter(block, iv)
 127 }
 128
 129 // macSHA1 returns a macFunction for the given protocol version.
 130 func macSHA1(version uint16, key []byte) macFunction {
 131         if version == VersionSSL30 {
 132                 mac := ssl30MAC{
 133                         h:   sha1.New(),
 134                         key: make([]byte, len(key)),
 135                 }
 136                 copy(mac.key, key)
 137                 return mac
 138         }
 139         return tls10MAC{hmac.New(newConstantTimeHash(sha1.New), key)}
 140 }
 141
 142 // macSHA256 returns a SHA-256 based MAC. These are only supported in TLS 1.2
 143 // so the given version is ignored.
 144 func macSHA256(version uint16, key []byte) macFunction {
 145         return tls10MAC{hmac.New(sha256.New, key)}
 146 }
 147
 148 type macFunction interface {
 149         Size() int
 150         MAC(digestBuf, seq, header, data, extra []byte) []byte
 151 }
 152
 153 type aead interface {
 154         cipher.AEAD
 155
 156         // explicitIVLen returns the number of bytes used by the explicit nonce
 157         // that is included in the record. This is eight for older AEADs and
 158         // zero for modern ones.
 159         explicitNonceLen() int
 160 }
 161
 162 // fixedNonceAEAD wraps an AEAD and prefixes a fixed portion of the nonce to
 163 // each call.
 164 type fixedNonceAEAD struct {
 165         // nonce contains the fixed part of the nonce in the first four bytes.
 166         nonce [12]byte
 167         aead  cipher.AEAD
 168 }
 169
 170 func (f *fixedNonceAEAD) NonceSize() int        { return 8 }
 171 func (f *fixedNonceAEAD) Overhead() int         { return f.aead.Overhead() }
 172 func (f *fixedNonceAEAD) explicitNonceLen() int { return 8 }
 173
 174 func (f *fixedNonceAEAD) Seal(out, nonce, plaintext, additionalData []byte) []byte {
 175         copy(f.nonce[4:], nonce)
 176         return f.aead.Seal(out, f.nonce[:], plaintext, additionalData)
 177 }
 178
 179 func (f *fixedNonceAEAD) Open(out, nonce, plaintext, additionalData []byte) ([]byte, error) {
 180         copy(f.nonce[4:], nonce)
 181         return f.aead.Open(out, f.nonce[:], plaintext, additionalData)
 182 }
 183
 184 // xoredNonceAEAD wraps an AEAD by XORing in a fixed pattern to the nonce
 185 // before each call.
 186 type xorNonceAEAD struct {
 187         nonceMask [12]byte
 188         aead      cipher.AEAD
 189 }
 190
 191 func (f *xorNonceAEAD) NonceSize() int        { return 8 }
 192 func (f *xorNonceAEAD) Overhead() int         { return f.aead.Overhead() }
 193 func (f *xorNonceAEAD) explicitNonceLen() int { return 0 }
 194
 195 func (f *xorNonceAEAD) Seal(out, nonce, plaintext, additionalData []byte) []byte {
 196         for i, b := range nonce {
 197                 f.nonceMask[4+i] ^= b
 198         }
 199         result := f.aead.Seal(out, f.nonceMask[:], plaintext, additionalData)
 200         for i, b := range nonce {
 201                 f.nonceMask[4+i] ^= b
 202         }
 203
 204         return result
 205 }
 206
 207 func (f *xorNonceAEAD) Open(out, nonce, plaintext, additionalData []byte) ([]byte, error) {
 208         for i, b := range nonce {
 209                 f.nonceMask[4+i] ^= b
 210         }
 211         result, err := f.aead.Open(out, f.nonceMask[:], plaintext, additionalData)
 212         for i, b := range nonce {
 213                 f.nonceMask[4+i] ^= b
 214         }
 215
 216         return result, err
 217 }
 218
 219 func aeadAESGCM(key, fixedNonce []byte) cipher.AEAD {
 220         aes, err := aes.NewCipher(key)
 221         if err != nil {
 222                 panic(err)
 223         }
 224         aead, err := cipher.NewGCM(aes)
 225         if err != nil {
 226                 panic(err)
 227         }
 228
 229         ret := &fixedNonceAEAD{aead: aead}
 230         copy(ret.nonce[:], fixedNonce)
 231         return ret
 232 }
 233
 234 func aeadChaCha20Poly1305(key, fixedNonce []byte) cipher.AEAD {
 235         aead, err := chacha20poly1305.New(key)
 236         if err != nil {
 237                 panic(err)
 238         }
 239
 240         ret := &xorNonceAEAD{aead: aead}
 241         copy(ret.nonceMask[:], fixedNonce)
 242         return ret
 243 }
 244
 245 // ssl30MAC implements the SSLv3 MAC function, as defined in
 246 // www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt section 5.2.3.1
 247 type ssl30MAC struct {
 248         h   hash.Hash
 249         key []byte
 250 }
 251
 252 func (s ssl30MAC) Size() int {
 253         return s.h.Size()
 254 }
 255
 256 var ssl30Pad1 = [48]byte{0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36}
 257
 258 var ssl30Pad2 = [48]byte{0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c}
 259
 260 // MAC does not offer constant timing guarantees for SSL v3.0, since it's deemed
 261 // useless considering the similar, protocol-level POODLE vulnerability.
 262 func (s ssl30MAC) MAC(digestBuf, seq, header, data, extra []byte) []byte {
 263         padLength := 48
 264         if s.h.Size() == 20 {
 265                 padLength = 40
 266         }
 267
 268         s.h.Reset()
 269         s.h.Write(s.key)
 270         s.h.Write(ssl30Pad1[:padLength])
 271         s.h.Write(seq)
 272         s.h.Write(header[:1])
 273         s.h.Write(header[3:5])
 274         s.h.Write(data)
 275         digestBuf = s.h.Sum(digestBuf[:0])
 276
 277         s.h.Reset()
 278         s.h.Write(s.key)
 279         s.h.Write(ssl30Pad2[:padLength])
 280         s.h.Write(digestBuf)
 281         return s.h.Sum(digestBuf[:0])
 282 }
 283
 284 type constantTimeHash interface {
 285         hash.Hash
 286         ConstantTimeSum(b []byte) []byte
 287 }
 288
 289 // cthWrapper wraps any hash.Hash that implements ConstantTimeSum, and replaces
 290 // with that all calls to Sum. It's used to obtain a ConstantTimeSum-based HMAC.
 291 type cthWrapper struct {
 292         h constantTimeHash
 293 }
 294
 295 func (c *cthWrapper) Size() int                   { return c.h.Size() }
 296 func (c *cthWrapper) BlockSize() int              { return c.h.BlockSize() }
 297 func (c *cthWrapper) Reset()                      { c.h.Reset() }
 298 func (c *cthWrapper) Write(p []byte) (int, error) { return c.h.Write(p) }
 299 func (c *cthWrapper) Sum(b []byte) []byte         { return c.h.ConstantTimeSum(b) }
 300
 301 func newConstantTimeHash(h func() hash.Hash) func() hash.Hash {
 302         if boring.Enabled {
 303                 // The BoringCrypto SHA1 does not have a constant-time
 304                 // checksum function, so don't try to use it.
 305                 return h
 306         }
 307         return func() hash.Hash {
 308                 return &cthWrapper{h().(constantTimeHash)}
 309         }
 310 }
 311
 312 // tls10MAC implements the TLS 1.0 MAC function. RFC 2246, section 6.2.3.
 313 type tls10MAC struct {
 314         h hash.Hash
 315 }
 316
 317 func (s tls10MAC) Size() int {
 318         return s.h.Size()
 319 }
 320
 321 // MAC is guaranteed to take constant time, as long as
 322 // len(seq)+len(header)+len(data)+len(extra) is constant. extra is not fed into
 323 // the MAC, but is only provided to make the timing profile constant.
 324 func (s tls10MAC) MAC(digestBuf, seq, header, data, extra []byte) []byte {
 325         s.h.Reset()
 326         s.h.Write(seq)
 327         s.h.Write(header)
 328         s.h.Write(data)
 329         res := s.h.Sum(digestBuf[:0])
 330         if extra != nil {
 331                 s.h.Write(extra)
 332         }
 333         return res
 334 }
 335
 336 func rsaKA(version uint16) keyAgreement {
 337         return rsaKeyAgreement{}
 338 }
 339
 340 func ecdheECDSAKA(version uint16) keyAgreement {
 341         return &ecdheKeyAgreement{
 342                 sigType: signatureECDSA,
 343                 version: version,
 344         }
 345 }
 346
 347 func ecdheRSAKA(version uint16) keyAgreement {
 348         return &ecdheKeyAgreement{
 349                 sigType: signatureRSA,
 350                 version: version,
 351         }
 352 }
 353
 354 // mutualCipherSuite returns a cipherSuite given a list of supported
 355 // ciphersuites and the id requested by the peer.
 356 func mutualCipherSuite(have []uint16, want uint16) *cipherSuite {
 357         for _, id := range have {
 358                 if id == want {
 359                         for _, suite := range cipherSuites {
 360                                 if suite.id == want {
 361                                         return suite
 362                                 }
 363                         }
 364                         return nil
 365                 }
 366         }
 367         return nil
 368 }
 369
 370 // A list of cipher suite IDs that are, or have been, implemented by this
 371 // package.
 372 //
 373 // Taken from http://www.iana.org/assignments/tls-parameters/tls-parameters.xml
 374 const (
 375         TLS_RSA_WITH_RC4_128_SHA                uint16 = 0x0005
 376         TLS_RSA_WITH_3DES_EDE_CBC_SHA           uint16 = 0x000a
 377         TLS_RSA_WITH_AES_128_CBC_SHA            uint16 = 0x002f
 378         TLS_RSA_WITH_AES_256_CBC_SHA            uint16 = 0x0035
 379         TLS_RSA_WITH_AES_128_CBC_SHA256         uint16 = 0x003c
 380         TLS_RSA_WITH_AES_128_GCM_SHA256         uint16 = 0x009c
 381         TLS_RSA_WITH_AES_256_GCM_SHA384         uint16 = 0x009d
 382         TLS_ECDHE_ECDSA_WITH_RC4_128_SHA        uint16 = 0xc007
 383         TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA    uint16 = 0xc009
 384         TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA    uint16 = 0xc00a
 385         TLS_ECDHE_RSA_WITH_RC4_128_SHA          uint16 = 0xc011
 386         TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA     uint16 = 0xc012
 387         TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA      uint16 = 0xc013
 388         TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA      uint16 = 0xc014
 389         TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 uint16 = 0xc023
 390         TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256   uint16 = 0xc027
 391         TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256   uint16 = 0xc02f
 392         TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 uint16 = 0xc02b
 393         TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384   uint16 = 0xc030
 394         TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 uint16 = 0xc02c
 395         TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305    uint16 = 0xcca8
 396         TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305  uint16 = 0xcca9
 397
 398         // TLS_FALLBACK_SCSV isn't a standard cipher suite but an indicator
 399         // that the client is doing version fallback. See
 400         // https://tools.ietf.org/html/rfc7507.
 401         TLS_FALLBACK_SCSV uint16 = 0x5600
 402 )