key_agreement.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  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. package tls
  5. import (
  6. "crypto"
  7. "crypto/md5"
  8. "crypto/rsa"
  9. "crypto/sha1"
  10. "crypto/x509"
  11. "errors"
  12. "fmt"
  13. "io"
  14. )
  15. // a keyAgreement implements the client and server side of a TLS key agreement
  16. // protocol by generating and processing key exchange messages.
  17. type keyAgreement interface {
  18. // On the server side, the first two methods are called in order.
  19. // In the case that the key agreement protocol doesn't use a
  20. // ServerKeyExchange message, generateServerKeyExchange can return nil,
  21. // nil.
  22. generateServerKeyExchange(*Config, *Certificate, *clientHelloMsg, *serverHelloMsg) (*serverKeyExchangeMsg, error)
  23. processClientKeyExchange(*Config, *Certificate, *clientKeyExchangeMsg, uint16) ([]byte, error)
  24. // On the client side, the next two methods are called in order.
  25. // This method may not be called if the server doesn't send a
  26. // ServerKeyExchange message.
  27. processServerKeyExchange(*Config, *clientHelloMsg, *serverHelloMsg, *x509.Certificate, *serverKeyExchangeMsg) error
  28. generateClientKeyExchange(*Config, *clientHelloMsg, *x509.Certificate) ([]byte, *clientKeyExchangeMsg, error)
  29. }
  30. var (
  31. errClientKeyExchange = errors.New("tls: invalid ClientKeyExchange message")
  32. errServerKeyExchange = errors.New("tls: invalid ServerKeyExchange message")
  33. )
  34. // rsaKeyAgreement implements the standard TLS key agreement where the client
  35. // encrypts the pre-master secret to the server's public key.
  36. type rsaKeyAgreement struct{}
  37. func (ka rsaKeyAgreement) generateServerKeyExchange(config *Config, cert *Certificate, clientHello *clientHelloMsg, hello *serverHelloMsg) (*serverKeyExchangeMsg, error) {
  38. return nil, nil
  39. }
  40. func (ka rsaKeyAgreement) processClientKeyExchange(config *Config, cert *Certificate, ckx *clientKeyExchangeMsg, version uint16) ([]byte, error) {
  41. if len(ckx.ciphertext) < 2 {
  42. return nil, errClientKeyExchange
  43. }
  44. ciphertextLen := int(ckx.ciphertext[0])<<8 | int(ckx.ciphertext[1])
  45. if ciphertextLen != len(ckx.ciphertext)-2 {
  46. return nil, errClientKeyExchange
  47. }
  48. ciphertext := ckx.ciphertext[2:]
  49. priv, ok := cert.PrivateKey.(crypto.Decrypter)
  50. if !ok {
  51. return nil, errors.New("tls: certificate private key does not implement crypto.Decrypter")
  52. }
  53. // Perform constant time RSA PKCS #1 v1.5 decryption
  54. preMasterSecret, err := priv.Decrypt(config.rand(), ciphertext, &rsa.PKCS1v15DecryptOptions{SessionKeyLen: 48})
  55. if err != nil {
  56. return nil, err
  57. }
  58. // We don't check the version number in the premaster secret. For one,
  59. // by checking it, we would leak information about the validity of the
  60. // encrypted pre-master secret. Secondly, it provides only a small
  61. // benefit against a downgrade attack and some implementations send the
  62. // wrong version anyway. See the discussion at the end of section
  63. // 7.4.7.1 of RFC 4346.
  64. return preMasterSecret, nil
  65. }
  66. func (ka rsaKeyAgreement) processServerKeyExchange(config *Config, clientHello *clientHelloMsg, serverHello *serverHelloMsg, cert *x509.Certificate, skx *serverKeyExchangeMsg) error {
  67. return errors.New("tls: unexpected ServerKeyExchange")
  68. }
  69. func (ka rsaKeyAgreement) generateClientKeyExchange(config *Config, clientHello *clientHelloMsg, cert *x509.Certificate) ([]byte, *clientKeyExchangeMsg, error) {
  70. preMasterSecret := make([]byte, 48)
  71. preMasterSecret[0] = byte(clientHello.vers >> 8)
  72. preMasterSecret[1] = byte(clientHello.vers)
  73. _, err := io.ReadFull(config.rand(), preMasterSecret[2:])
  74. if err != nil {
  75. return nil, nil, err
  76. }
  77. rsaKey, ok := cert.PublicKey.(*rsa.PublicKey)
  78. if !ok {
  79. return nil, nil, errors.New("tls: server certificate contains incorrect key type for selected ciphersuite")
  80. }
  81. encrypted, err := rsa.EncryptPKCS1v15(config.rand(), rsaKey, preMasterSecret)
  82. if err != nil {
  83. return nil, nil, err
  84. }
  85. ckx := new(clientKeyExchangeMsg)
  86. ckx.ciphertext = make([]byte, len(encrypted)+2)
  87. ckx.ciphertext[0] = byte(len(encrypted) >> 8)
  88. ckx.ciphertext[1] = byte(len(encrypted))
  89. copy(ckx.ciphertext[2:], encrypted)
  90. return preMasterSecret, ckx, nil
  91. }
  92. // sha1Hash calculates a SHA1 hash over the given byte slices.
  93. func sha1Hash(slices [][]byte) []byte {
  94. hsha1 := sha1.New()
  95. for _, slice := range slices {
  96. hsha1.Write(slice)
  97. }
  98. return hsha1.Sum(nil)
  99. }
  100. // md5SHA1Hash implements TLS 1.0's hybrid hash function which consists of the
  101. // concatenation of an MD5 and SHA1 hash.
  102. func md5SHA1Hash(slices [][]byte) []byte {
  103. md5sha1 := make([]byte, md5.Size+sha1.Size)
  104. hmd5 := md5.New()
  105. for _, slice := range slices {
  106. hmd5.Write(slice)
  107. }
  108. copy(md5sha1, hmd5.Sum(nil))
  109. copy(md5sha1[md5.Size:], sha1Hash(slices))
  110. return md5sha1
  111. }
  112. // hashForServerKeyExchange hashes the given slices and returns their digest
  113. // using the given hash function (for >= TLS 1.2) or using a default based on
  114. // the sigType (for earlier TLS versions). For Ed25519 signatures, which don't
  115. // do pre-hashing, it returns the concatenation of the slices.
  116. func hashForServerKeyExchange(sigType uint8, hashFunc crypto.Hash, version uint16, slices ...[]byte) []byte {
  117. if sigType == signatureEd25519 || circlSchemeBySigType(sigType) != nil {
  118. var signed []byte
  119. for _, slice := range slices {
  120. signed = append(signed, slice...)
  121. }
  122. return signed
  123. }
  124. if version >= VersionTLS12 {
  125. h := hashFunc.New()
  126. for _, slice := range slices {
  127. h.Write(slice)
  128. }
  129. digest := h.Sum(nil)
  130. return digest
  131. }
  132. if sigType == signatureECDSA {
  133. return sha1Hash(slices)
  134. }
  135. return md5SHA1Hash(slices)
  136. }
  137. // ecdheKeyAgreement implements a TLS key agreement where the server
  138. // generates an ephemeral EC public/private key pair and signs it. The
  139. // pre-master secret is then calculated using ECDH. The signature may
  140. // be ECDSA, Ed25519 or RSA.
  141. type ecdheKeyAgreement struct {
  142. version uint16
  143. isRSA bool
  144. params ecdheParameters
  145. // ckx and preMasterSecret are generated in processServerKeyExchange
  146. // and returned in generateClientKeyExchange.
  147. ckx *clientKeyExchangeMsg
  148. preMasterSecret []byte
  149. }
  150. func (ka *ecdheKeyAgreement) generateServerKeyExchange(config *Config, cert *Certificate, clientHello *clientHelloMsg, hello *serverHelloMsg) (*serverKeyExchangeMsg, error) {
  151. var curveID CurveID
  152. for _, c := range clientHello.supportedCurves {
  153. if config.supportsCurve(c) && curveIdToCirclScheme(c) == nil {
  154. curveID = c
  155. break
  156. }
  157. }
  158. if curveID == 0 {
  159. return nil, errors.New("tls: no supported elliptic curves offered")
  160. }
  161. if _, ok := curveForCurveID(curveID); curveID != X25519 && !ok {
  162. return nil, errors.New("tls: CurvePreferences includes unsupported curve")
  163. }
  164. params, err := generateECDHEParameters(config.rand(), curveID)
  165. if err != nil {
  166. return nil, err
  167. }
  168. ka.params = params
  169. // See RFC 4492, Section 5.4.
  170. ecdhePublic := params.PublicKey()
  171. serverECDHEParams := make([]byte, 1+2+1+len(ecdhePublic))
  172. serverECDHEParams[0] = 3 // named curve
  173. serverECDHEParams[1] = byte(curveID >> 8)
  174. serverECDHEParams[2] = byte(curveID)
  175. serverECDHEParams[3] = byte(len(ecdhePublic))
  176. copy(serverECDHEParams[4:], ecdhePublic)
  177. priv, ok := cert.PrivateKey.(crypto.Signer)
  178. if !ok {
  179. return nil, fmt.Errorf("tls: certificate private key of type %T does not implement crypto.Signer", cert.PrivateKey)
  180. }
  181. var signatureAlgorithm SignatureScheme
  182. var sigType uint8
  183. var sigHash crypto.Hash
  184. if ka.version >= VersionTLS12 {
  185. signatureAlgorithm, err = selectSignatureScheme(ka.version, cert, clientHello.supportedSignatureAlgorithms)
  186. if err != nil {
  187. return nil, err
  188. }
  189. sigType, sigHash, err = typeAndHashFromSignatureScheme(signatureAlgorithm)
  190. if err != nil {
  191. return nil, err
  192. }
  193. } else {
  194. sigType, sigHash, err = legacyTypeAndHashFromPublicKey(priv.Public())
  195. if err != nil {
  196. return nil, err
  197. }
  198. }
  199. if (sigType == signaturePKCS1v15 || sigType == signatureRSAPSS) != ka.isRSA {
  200. return nil, errors.New("tls: certificate cannot be used with the selected cipher suite")
  201. }
  202. signed := hashForServerKeyExchange(sigType, sigHash, ka.version, clientHello.random, hello.random, serverECDHEParams)
  203. signOpts := crypto.SignerOpts(sigHash)
  204. if sigType == signatureRSAPSS {
  205. signOpts = &rsa.PSSOptions{SaltLength: rsa.PSSSaltLengthEqualsHash, Hash: sigHash}
  206. }
  207. sig, err := priv.Sign(config.rand(), signed, signOpts)
  208. if err != nil {
  209. return nil, errors.New("tls: failed to sign ECDHE parameters: " + err.Error())
  210. }
  211. skx := new(serverKeyExchangeMsg)
  212. sigAndHashLen := 0
  213. if ka.version >= VersionTLS12 {
  214. sigAndHashLen = 2
  215. }
  216. skx.key = make([]byte, len(serverECDHEParams)+sigAndHashLen+2+len(sig))
  217. copy(skx.key, serverECDHEParams)
  218. k := skx.key[len(serverECDHEParams):]
  219. if ka.version >= VersionTLS12 {
  220. k[0] = byte(signatureAlgorithm >> 8)
  221. k[1] = byte(signatureAlgorithm)
  222. k = k[2:]
  223. }
  224. k[0] = byte(len(sig) >> 8)
  225. k[1] = byte(len(sig))
  226. copy(k[2:], sig)
  227. return skx, nil
  228. }
  229. func (ka *ecdheKeyAgreement) processClientKeyExchange(config *Config, cert *Certificate, ckx *clientKeyExchangeMsg, version uint16) ([]byte, error) {
  230. if len(ckx.ciphertext) == 0 || int(ckx.ciphertext[0]) != len(ckx.ciphertext)-1 {
  231. return nil, errClientKeyExchange
  232. }
  233. preMasterSecret := ka.params.SharedKey(ckx.ciphertext[1:])
  234. if preMasterSecret == nil {
  235. return nil, errClientKeyExchange
  236. }
  237. return preMasterSecret, nil
  238. }
  239. func (ka *ecdheKeyAgreement) processServerKeyExchange(config *Config, clientHello *clientHelloMsg, serverHello *serverHelloMsg, cert *x509.Certificate, skx *serverKeyExchangeMsg) error {
  240. if len(skx.key) < 4 {
  241. return errServerKeyExchange
  242. }
  243. if skx.key[0] != 3 { // named curve
  244. return errors.New("tls: server selected unsupported curve")
  245. }
  246. curveID := CurveID(skx.key[1])<<8 | CurveID(skx.key[2])
  247. publicLen := int(skx.key[3])
  248. if publicLen+4 > len(skx.key) {
  249. return errServerKeyExchange
  250. }
  251. serverECDHEParams := skx.key[:4+publicLen]
  252. publicKey := serverECDHEParams[4:]
  253. sig := skx.key[4+publicLen:]
  254. if len(sig) < 2 {
  255. return errServerKeyExchange
  256. }
  257. if _, ok := curveForCurveID(curveID); curveID != X25519 && !ok {
  258. return errors.New("tls: server selected unsupported curve")
  259. }
  260. params, err := generateECDHEParameters(config.rand(), curveID)
  261. if err != nil {
  262. return err
  263. }
  264. ka.params = params
  265. ka.preMasterSecret = params.SharedKey(publicKey)
  266. if ka.preMasterSecret == nil {
  267. return errServerKeyExchange
  268. }
  269. ourPublicKey := params.PublicKey()
  270. ka.ckx = new(clientKeyExchangeMsg)
  271. ka.ckx.ciphertext = make([]byte, 1+len(ourPublicKey))
  272. ka.ckx.ciphertext[0] = byte(len(ourPublicKey))
  273. copy(ka.ckx.ciphertext[1:], ourPublicKey)
  274. var sigType uint8
  275. var sigHash crypto.Hash
  276. if ka.version >= VersionTLS12 {
  277. signatureAlgorithm := SignatureScheme(sig[0])<<8 | SignatureScheme(sig[1])
  278. sig = sig[2:]
  279. if len(sig) < 2 {
  280. return errServerKeyExchange
  281. }
  282. if !isSupportedSignatureAlgorithm(signatureAlgorithm, clientHello.supportedSignatureAlgorithms) {
  283. return errors.New("tls: certificate used with invalid signature algorithm")
  284. }
  285. sigType, sigHash, err = typeAndHashFromSignatureScheme(signatureAlgorithm)
  286. if err != nil {
  287. return err
  288. }
  289. } else {
  290. sigType, sigHash, err = legacyTypeAndHashFromPublicKey(cert.PublicKey)
  291. if err != nil {
  292. return err
  293. }
  294. }
  295. if (sigType == signaturePKCS1v15 || sigType == signatureRSAPSS) != ka.isRSA {
  296. return errServerKeyExchange
  297. }
  298. sigLen := int(sig[0])<<8 | int(sig[1])
  299. if sigLen+2 != len(sig) {
  300. return errServerKeyExchange
  301. }
  302. sig = sig[2:]
  303. signed := hashForServerKeyExchange(sigType, sigHash, ka.version, clientHello.random, serverHello.random, serverECDHEParams)
  304. if err := verifyHandshakeSignature(sigType, cert.PublicKey, sigHash, signed, sig); err != nil {
  305. return errors.New("tls: invalid signature by the server certificate: " + err.Error())
  306. }
  307. return nil
  308. }
  309. func (ka *ecdheKeyAgreement) generateClientKeyExchange(config *Config, clientHello *clientHelloMsg, cert *x509.Certificate) ([]byte, *clientKeyExchangeMsg, error) {
  310. if ka.ckx == nil {
  311. return nil, nil, errors.New("tls: missing ServerKeyExchange message")
  312. }
  313. return ka.preMasterSecret, ka.ckx, nil
  314. }