prf.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  1. // 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. package tls
  5. import (
  6. "crypto"
  7. "crypto/hmac"
  8. "crypto/md5"
  9. "crypto/sha1"
  10. "crypto/sha256"
  11. "crypto/sha512"
  12. "errors"
  13. "fmt"
  14. "hash"
  15. )
  16. // Split a premaster secret in two as specified in RFC 4346, Section 5.
  17. func splitPreMasterSecret(secret []byte) (s1, s2 []byte) {
  18. s1 = secret[0 : (len(secret)+1)/2]
  19. s2 = secret[len(secret)/2:]
  20. return
  21. }
  22. // pHash implements the P_hash function, as defined in RFC 4346, Section 5.
  23. func pHash(result, secret, seed []byte, hash func() hash.Hash) {
  24. h := hmac.New(hash, secret)
  25. h.Write(seed)
  26. a := h.Sum(nil)
  27. j := 0
  28. for j < len(result) {
  29. h.Reset()
  30. h.Write(a)
  31. h.Write(seed)
  32. b := h.Sum(nil)
  33. copy(result[j:], b)
  34. j += len(b)
  35. h.Reset()
  36. h.Write(a)
  37. a = h.Sum(nil)
  38. }
  39. }
  40. // prf10 implements the TLS 1.0 pseudo-random function, as defined in RFC 2246, Section 5.
  41. func prf10(result, secret, label, seed []byte) {
  42. hashSHA1 := sha1.New
  43. hashMD5 := md5.New
  44. labelAndSeed := make([]byte, len(label)+len(seed))
  45. copy(labelAndSeed, label)
  46. copy(labelAndSeed[len(label):], seed)
  47. s1, s2 := splitPreMasterSecret(secret)
  48. pHash(result, s1, labelAndSeed, hashMD5)
  49. result2 := make([]byte, len(result))
  50. pHash(result2, s2, labelAndSeed, hashSHA1)
  51. for i, b := range result2 {
  52. result[i] ^= b
  53. }
  54. }
  55. // prf12 implements the TLS 1.2 pseudo-random function, as defined in RFC 5246, Section 5.
  56. func prf12(hashFunc func() hash.Hash) func(result, secret, label, seed []byte) {
  57. return func(result, secret, label, seed []byte) {
  58. labelAndSeed := make([]byte, len(label)+len(seed))
  59. copy(labelAndSeed, label)
  60. copy(labelAndSeed[len(label):], seed)
  61. pHash(result, secret, labelAndSeed, hashFunc)
  62. }
  63. }
  64. // prf30 implements the SSL 3.0 pseudo-random function, as defined in
  65. // www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt section 6.
  66. func prf30(result, secret, label, seed []byte) {
  67. hashSHA1 := sha1.New()
  68. hashMD5 := md5.New()
  69. done := 0
  70. i := 0
  71. // RFC 5246 section 6.3 says that the largest PRF output needed is 128
  72. // bytes. Since no more ciphersuites will be added to SSLv3, this will
  73. // remain true. Each iteration gives us 16 bytes so 10 iterations will
  74. // be sufficient.
  75. var b [11]byte
  76. for done < len(result) {
  77. for j := 0; j <= i; j++ {
  78. b[j] = 'A' + byte(i)
  79. }
  80. hashSHA1.Reset()
  81. hashSHA1.Write(b[:i+1])
  82. hashSHA1.Write(secret)
  83. hashSHA1.Write(seed)
  84. digest := hashSHA1.Sum(nil)
  85. hashMD5.Reset()
  86. hashMD5.Write(secret)
  87. hashMD5.Write(digest)
  88. done += copy(result[done:], hashMD5.Sum(nil))
  89. i++
  90. }
  91. }
  92. const (
  93. masterSecretLength = 48 // Length of a master secret in TLS 1.1.
  94. finishedVerifyLength = 12 // Length of verify_data in a Finished message.
  95. )
  96. var masterSecretLabel = []byte("master secret")
  97. var keyExpansionLabel = []byte("key expansion")
  98. var clientFinishedLabel = []byte("client finished")
  99. var serverFinishedLabel = []byte("server finished")
  100. func prfAndHashForVersion(version uint16, suite *cipherSuite) (func(result, secret, label, seed []byte), crypto.Hash) {
  101. switch version {
  102. case VersionSSL30:
  103. return prf30, crypto.Hash(0)
  104. case VersionTLS10, VersionTLS11:
  105. return prf10, crypto.Hash(0)
  106. case VersionTLS12:
  107. if suite.flags&suiteSHA384 != 0 {
  108. return prf12(sha512.New384), crypto.SHA384
  109. }
  110. return prf12(sha256.New), crypto.SHA256
  111. default:
  112. panic("unknown version")
  113. }
  114. }
  115. func prfForVersion(version uint16, suite *cipherSuite) func(result, secret, label, seed []byte) {
  116. prf, _ := prfAndHashForVersion(version, suite)
  117. return prf
  118. }
  119. // masterFromPreMasterSecret generates the master secret from the pre-master
  120. // secret. See RFC 5246, Section 8.1.
  121. func masterFromPreMasterSecret(version uint16, suite *cipherSuite, preMasterSecret, clientRandom, serverRandom []byte) []byte {
  122. seed := make([]byte, 0, len(clientRandom)+len(serverRandom))
  123. seed = append(seed, clientRandom...)
  124. seed = append(seed, serverRandom...)
  125. masterSecret := make([]byte, masterSecretLength)
  126. prfForVersion(version, suite)(masterSecret, preMasterSecret, masterSecretLabel, seed)
  127. return masterSecret
  128. }
  129. // keysFromMasterSecret generates the connection keys from the master
  130. // secret, given the lengths of the MAC key, cipher key and IV, as defined in
  131. // RFC 2246, Section 6.3.
  132. func keysFromMasterSecret(version uint16, suite *cipherSuite, masterSecret, clientRandom, serverRandom []byte, macLen, keyLen, ivLen int) (clientMAC, serverMAC, clientKey, serverKey, clientIV, serverIV []byte) {
  133. seed := make([]byte, 0, len(serverRandom)+len(clientRandom))
  134. seed = append(seed, serverRandom...)
  135. seed = append(seed, clientRandom...)
  136. n := 2*macLen + 2*keyLen + 2*ivLen
  137. keyMaterial := make([]byte, n)
  138. prfForVersion(version, suite)(keyMaterial, masterSecret, keyExpansionLabel, seed)
  139. clientMAC = keyMaterial[:macLen]
  140. keyMaterial = keyMaterial[macLen:]
  141. serverMAC = keyMaterial[:macLen]
  142. keyMaterial = keyMaterial[macLen:]
  143. clientKey = keyMaterial[:keyLen]
  144. keyMaterial = keyMaterial[keyLen:]
  145. serverKey = keyMaterial[:keyLen]
  146. keyMaterial = keyMaterial[keyLen:]
  147. clientIV = keyMaterial[:ivLen]
  148. keyMaterial = keyMaterial[ivLen:]
  149. serverIV = keyMaterial[:ivLen]
  150. return
  151. }
  152. // hashFromSignatureScheme returns the corresponding crypto.Hash for a given
  153. // hash from a TLS SignatureScheme.
  154. func hashFromSignatureScheme(signatureAlgorithm SignatureScheme) (crypto.Hash, error) {
  155. switch signatureAlgorithm {
  156. case PKCS1WithSHA1, ECDSAWithSHA1:
  157. return crypto.SHA1, nil
  158. case PKCS1WithSHA256, PSSWithSHA256, ECDSAWithP256AndSHA256:
  159. return crypto.SHA256, nil
  160. case PKCS1WithSHA384, PSSWithSHA384, ECDSAWithP384AndSHA384:
  161. return crypto.SHA384, nil
  162. case PKCS1WithSHA512, PSSWithSHA512, ECDSAWithP521AndSHA512:
  163. return crypto.SHA512, nil
  164. default:
  165. return 0, fmt.Errorf("tls: unsupported signature algorithm: %#04x", signatureAlgorithm)
  166. }
  167. }
  168. func newFinishedHash(version uint16, cipherSuite *cipherSuite) finishedHash {
  169. var buffer []byte
  170. if version == VersionSSL30 || version >= VersionTLS12 {
  171. buffer = []byte{}
  172. }
  173. prf, hash := prfAndHashForVersion(version, cipherSuite)
  174. if hash != 0 {
  175. return finishedHash{hash.New(), hash.New(), nil, nil, buffer, version, prf}
  176. }
  177. return finishedHash{sha1.New(), sha1.New(), md5.New(), md5.New(), buffer, version, prf}
  178. }
  179. // A finishedHash calculates the hash of a set of handshake messages suitable
  180. // for including in a Finished message.
  181. type finishedHash struct {
  182. client hash.Hash
  183. server hash.Hash
  184. // Prior to TLS 1.2, an additional MD5 hash is required.
  185. clientMD5 hash.Hash
  186. serverMD5 hash.Hash
  187. // In TLS 1.2, a full buffer is sadly required.
  188. buffer []byte
  189. version uint16
  190. prf func(result, secret, label, seed []byte)
  191. }
  192. func (h *finishedHash) Write(msg []byte) (n int, err error) {
  193. h.client.Write(msg)
  194. h.server.Write(msg)
  195. if h.version < VersionTLS12 {
  196. h.clientMD5.Write(msg)
  197. h.serverMD5.Write(msg)
  198. }
  199. if h.buffer != nil {
  200. h.buffer = append(h.buffer, msg...)
  201. }
  202. return len(msg), nil
  203. }
  204. func (h finishedHash) Sum() []byte {
  205. if h.version >= VersionTLS12 {
  206. return h.client.Sum(nil)
  207. }
  208. out := make([]byte, 0, md5.Size+sha1.Size)
  209. out = h.clientMD5.Sum(out)
  210. return h.client.Sum(out)
  211. }
  212. // finishedSum30 calculates the contents of the verify_data member of a SSLv3
  213. // Finished message given the MD5 and SHA1 hashes of a set of handshake
  214. // messages.
  215. func finishedSum30(md5, sha1 hash.Hash, masterSecret []byte, magic []byte) []byte {
  216. md5.Write(magic)
  217. md5.Write(masterSecret)
  218. md5.Write(ssl30Pad1[:])
  219. md5Digest := md5.Sum(nil)
  220. md5.Reset()
  221. md5.Write(masterSecret)
  222. md5.Write(ssl30Pad2[:])
  223. md5.Write(md5Digest)
  224. md5Digest = md5.Sum(nil)
  225. sha1.Write(magic)
  226. sha1.Write(masterSecret)
  227. sha1.Write(ssl30Pad1[:40])
  228. sha1Digest := sha1.Sum(nil)
  229. sha1.Reset()
  230. sha1.Write(masterSecret)
  231. sha1.Write(ssl30Pad2[:40])
  232. sha1.Write(sha1Digest)
  233. sha1Digest = sha1.Sum(nil)
  234. ret := make([]byte, len(md5Digest)+len(sha1Digest))
  235. copy(ret, md5Digest)
  236. copy(ret[len(md5Digest):], sha1Digest)
  237. return ret
  238. }
  239. var ssl3ClientFinishedMagic = [4]byte{0x43, 0x4c, 0x4e, 0x54}
  240. var ssl3ServerFinishedMagic = [4]byte{0x53, 0x52, 0x56, 0x52}
  241. // clientSum returns the contents of the verify_data member of a client's
  242. // Finished message.
  243. func (h finishedHash) clientSum(masterSecret []byte) []byte {
  244. if h.version == VersionSSL30 {
  245. return finishedSum30(h.clientMD5, h.client, masterSecret, ssl3ClientFinishedMagic[:])
  246. }
  247. out := make([]byte, finishedVerifyLength)
  248. h.prf(out, masterSecret, clientFinishedLabel, h.Sum())
  249. return out
  250. }
  251. // serverSum returns the contents of the verify_data member of a server's
  252. // Finished message.
  253. func (h finishedHash) serverSum(masterSecret []byte) []byte {
  254. if h.version == VersionSSL30 {
  255. return finishedSum30(h.serverMD5, h.server, masterSecret, ssl3ServerFinishedMagic[:])
  256. }
  257. out := make([]byte, finishedVerifyLength)
  258. h.prf(out, masterSecret, serverFinishedLabel, h.Sum())
  259. return out
  260. }
  261. // hashForClientCertificate returns a digest over the handshake messages so far,
  262. // suitable for signing by a TLS client certificate.
  263. func (h finishedHash) hashForClientCertificate(sigType uint8, hashAlg crypto.Hash, masterSecret []byte) ([]byte, error) {
  264. if (h.version == VersionSSL30 || h.version >= VersionTLS12) && h.buffer == nil {
  265. panic("a handshake hash for a client-certificate was requested after discarding the handshake buffer")
  266. }
  267. if h.version == VersionSSL30 {
  268. if sigType != signaturePKCS1v15 {
  269. return nil, errors.New("tls: unsupported signature type for client certificate")
  270. }
  271. md5Hash := md5.New()
  272. md5Hash.Write(h.buffer)
  273. sha1Hash := sha1.New()
  274. sha1Hash.Write(h.buffer)
  275. return finishedSum30(md5Hash, sha1Hash, masterSecret, nil), nil
  276. }
  277. if h.version >= VersionTLS12 {
  278. hash := hashAlg.New()
  279. hash.Write(h.buffer)
  280. return hash.Sum(nil), nil
  281. }
  282. if sigType == signatureECDSA {
  283. return h.server.Sum(nil), nil
  284. }
  285. return h.Sum(), nil
  286. }
  287. // discardHandshakeBuffer is called when there is no more need to
  288. // buffer the entirety of the handshake messages.
  289. func (h *finishedHash) discardHandshakeBuffer() {
  290. h.buffer = nil
  291. }
  292. // noExportedKeyingMaterial is used as a value of
  293. // ConnectionState.ekm when renegotation is enabled and thus
  294. // we wish to fail all key-material export requests.
  295. func noExportedKeyingMaterial(label string, context []byte, length int) ([]byte, error) {
  296. return nil, errors.New("crypto/tls: ExportKeyingMaterial is unavailable when renegotiation is enabled")
  297. }
  298. // ekmFromMasterSecret generates exported keying material as defined in RFC 5705.
  299. func ekmFromMasterSecret(version uint16, suite *cipherSuite, masterSecret, clientRandom, serverRandom []byte) func(string, []byte, int) ([]byte, error) {
  300. return func(label string, context []byte, length int) ([]byte, error) {
  301. switch label {
  302. case "client finished", "server finished", "master secret", "key expansion":
  303. // These values are reserved and may not be used.
  304. return nil, fmt.Errorf("crypto/tls: reserved ExportKeyingMaterial label: %s", label)
  305. }
  306. seedLen := len(serverRandom) + len(clientRandom)
  307. if context != nil {
  308. seedLen += 2 + len(context)
  309. }
  310. seed := make([]byte, 0, seedLen)
  311. seed = append(seed, clientRandom...)
  312. seed = append(seed, serverRandom...)
  313. if context != nil {
  314. if len(context) >= 1<<16 {
  315. return nil, fmt.Errorf("crypto/tls: ExportKeyingMaterial context too long")
  316. }
  317. seed = append(seed, byte(len(context)>>8), byte(len(context)))
  318. seed = append(seed, context...)
  319. }
  320. keyMaterial := make([]byte, length)
  321. prfForVersion(version, suite)(keyMaterial, masterSecret, []byte(label), seed)
  322. return keyMaterial, nil
  323. }
  324. }