handshake_messages.go 62 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339
  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. "errors"
  7. "fmt"
  8. "slices"
  9. "strings"
  10. "github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/prng"
  11. "golang.org/x/crypto/cryptobyte"
  12. )
  13. // The marshalingFunction type is an adapter to allow the use of ordinary
  14. // functions as cryptobyte.MarshalingValue.
  15. type marshalingFunction func(b *cryptobyte.Builder) error
  16. func (f marshalingFunction) Marshal(b *cryptobyte.Builder) error {
  17. return f(b)
  18. }
  19. // addBytesWithLength appends a sequence of bytes to the cryptobyte.Builder. If
  20. // the length of the sequence is not the value specified, it produces an error.
  21. func addBytesWithLength(b *cryptobyte.Builder, v []byte, n int) {
  22. b.AddValue(marshalingFunction(func(b *cryptobyte.Builder) error {
  23. if len(v) != n {
  24. return fmt.Errorf("invalid value length: expected %d, got %d", n, len(v))
  25. }
  26. b.AddBytes(v)
  27. return nil
  28. }))
  29. }
  30. // addUint64 appends a big-endian, 64-bit value to the cryptobyte.Builder.
  31. func addUint64(b *cryptobyte.Builder, v uint64) {
  32. b.AddUint32(uint32(v >> 32))
  33. b.AddUint32(uint32(v))
  34. }
  35. // readUint64 decodes a big-endian, 64-bit value into out and advances over it.
  36. // It reports whether the read was successful.
  37. func readUint64(s *cryptobyte.String, out *uint64) bool {
  38. var hi, lo uint32
  39. if !s.ReadUint32(&hi) || !s.ReadUint32(&lo) {
  40. return false
  41. }
  42. *out = uint64(hi)<<32 | uint64(lo)
  43. return true
  44. }
  45. // readUint8LengthPrefixed acts like s.ReadUint8LengthPrefixed, but targets a
  46. // []byte instead of a cryptobyte.String.
  47. func readUint8LengthPrefixed(s *cryptobyte.String, out *[]byte) bool {
  48. return s.ReadUint8LengthPrefixed((*cryptobyte.String)(out))
  49. }
  50. // readUint16LengthPrefixed acts like s.ReadUint16LengthPrefixed, but targets a
  51. // []byte instead of a cryptobyte.String.
  52. func readUint16LengthPrefixed(s *cryptobyte.String, out *[]byte) bool {
  53. return s.ReadUint16LengthPrefixed((*cryptobyte.String)(out))
  54. }
  55. // readUint24LengthPrefixed acts like s.ReadUint24LengthPrefixed, but targets a
  56. // []byte instead of a cryptobyte.String.
  57. func readUint24LengthPrefixed(s *cryptobyte.String, out *[]byte) bool {
  58. return s.ReadUint24LengthPrefixed((*cryptobyte.String)(out))
  59. }
  60. type clientHelloMsg struct {
  61. original []byte
  62. vers uint16
  63. random []byte
  64. sessionId []byte
  65. cipherSuites []uint16
  66. compressionMethods []uint8
  67. serverName string
  68. ocspStapling bool
  69. supportedCurves []CurveID
  70. supportedPoints []uint8
  71. ticketSupported bool
  72. sessionTicket []uint8
  73. supportedSignatureAlgorithms []SignatureScheme
  74. supportedSignatureAlgorithmsCert []SignatureScheme
  75. secureRenegotiationSupported bool
  76. secureRenegotiation []byte
  77. extendedMasterSecret bool
  78. alpnProtocols []string
  79. scts bool
  80. supportedVersions []uint16
  81. cookie []byte
  82. keyShares []keyShare
  83. earlyData bool
  84. pskModes []uint8
  85. pskIdentities []pskIdentity
  86. pskBinders [][]byte
  87. quicTransportParameters []byte
  88. encryptedClientHello []byte
  89. // [Psiphon] Seed is used to randomize the marshalled Client Hello.
  90. marshalerPRNGSeed *prng.Seed
  91. }
  92. func (m *clientHelloMsg) marshalMsg(echInner bool) ([]byte, error) {
  93. var exts cryptobyte.Builder
  94. if len(m.serverName) > 0 {
  95. // RFC 6066, Section 3
  96. exts.AddUint16(extensionServerName)
  97. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  98. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  99. exts.AddUint8(0) // name_type = host_name
  100. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  101. exts.AddBytes([]byte(m.serverName))
  102. })
  103. })
  104. })
  105. }
  106. if len(m.supportedPoints) > 0 && !echInner {
  107. // RFC 4492, Section 5.1.2
  108. exts.AddUint16(extensionSupportedPoints)
  109. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  110. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  111. exts.AddBytes(m.supportedPoints)
  112. })
  113. })
  114. }
  115. if m.ticketSupported && !echInner {
  116. // RFC 5077, Section 3.2
  117. exts.AddUint16(extensionSessionTicket)
  118. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  119. exts.AddBytes(m.sessionTicket)
  120. })
  121. }
  122. if m.secureRenegotiationSupported && !echInner {
  123. // RFC 5746, Section 3.2
  124. exts.AddUint16(extensionRenegotiationInfo)
  125. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  126. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  127. exts.AddBytes(m.secureRenegotiation)
  128. })
  129. })
  130. }
  131. if m.extendedMasterSecret && !echInner {
  132. // RFC 7627
  133. exts.AddUint16(extensionExtendedMasterSecret)
  134. exts.AddUint16(0) // empty extension_data
  135. }
  136. if m.scts {
  137. // RFC 6962, Section 3.3.1
  138. exts.AddUint16(extensionSCT)
  139. exts.AddUint16(0) // empty extension_data
  140. }
  141. if m.earlyData {
  142. // RFC 8446, Section 4.2.10
  143. exts.AddUint16(extensionEarlyData)
  144. exts.AddUint16(0) // empty extension_data
  145. }
  146. if m.quicTransportParameters != nil { // marshal zero-length parameters when present
  147. // RFC 9001, Section 8.2
  148. exts.AddUint16(extensionQUICTransportParameters)
  149. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  150. exts.AddBytes(m.quicTransportParameters)
  151. })
  152. }
  153. if len(m.encryptedClientHello) > 0 {
  154. exts.AddUint16(extensionEncryptedClientHello)
  155. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  156. exts.AddBytes(m.encryptedClientHello)
  157. })
  158. }
  159. // Note that any extension that can be compressed during ECH must be
  160. // contiguous. If any additional extensions are to be compressed they must
  161. // be added to the following block, so that they can be properly
  162. // decompressed on the other side.
  163. var echOuterExts []uint16
  164. if m.ocspStapling {
  165. // RFC 4366, Section 3.6
  166. if echInner {
  167. echOuterExts = append(echOuterExts, extensionStatusRequest)
  168. } else {
  169. exts.AddUint16(extensionStatusRequest)
  170. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  171. exts.AddUint8(1) // status_type = ocsp
  172. exts.AddUint16(0) // empty responder_id_list
  173. exts.AddUint16(0) // empty request_extensions
  174. })
  175. }
  176. }
  177. if len(m.supportedCurves) > 0 {
  178. // RFC 4492, sections 5.1.1 and RFC 8446, Section 4.2.7
  179. if echInner {
  180. echOuterExts = append(echOuterExts, extensionSupportedCurves)
  181. } else {
  182. exts.AddUint16(extensionSupportedCurves)
  183. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  184. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  185. for _, curve := range m.supportedCurves {
  186. exts.AddUint16(uint16(curve))
  187. }
  188. })
  189. })
  190. }
  191. }
  192. if len(m.supportedSignatureAlgorithms) > 0 {
  193. // RFC 5246, Section 7.4.1.4.1
  194. if echInner {
  195. echOuterExts = append(echOuterExts, extensionSignatureAlgorithms)
  196. } else {
  197. exts.AddUint16(extensionSignatureAlgorithms)
  198. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  199. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  200. for _, sigAlgo := range m.supportedSignatureAlgorithms {
  201. exts.AddUint16(uint16(sigAlgo))
  202. }
  203. })
  204. })
  205. }
  206. }
  207. if len(m.supportedSignatureAlgorithmsCert) > 0 {
  208. // RFC 8446, Section 4.2.3
  209. if echInner {
  210. echOuterExts = append(echOuterExts, extensionSignatureAlgorithmsCert)
  211. } else {
  212. exts.AddUint16(extensionSignatureAlgorithmsCert)
  213. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  214. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  215. for _, sigAlgo := range m.supportedSignatureAlgorithmsCert {
  216. exts.AddUint16(uint16(sigAlgo))
  217. }
  218. })
  219. })
  220. }
  221. }
  222. if len(m.alpnProtocols) > 0 {
  223. // RFC 7301, Section 3.1
  224. if echInner {
  225. echOuterExts = append(echOuterExts, extensionALPN)
  226. } else {
  227. exts.AddUint16(extensionALPN)
  228. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  229. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  230. for _, proto := range m.alpnProtocols {
  231. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  232. exts.AddBytes([]byte(proto))
  233. })
  234. }
  235. })
  236. })
  237. }
  238. }
  239. if len(m.supportedVersions) > 0 {
  240. // RFC 8446, Section 4.2.1
  241. if echInner {
  242. echOuterExts = append(echOuterExts, extensionSupportedVersions)
  243. } else {
  244. exts.AddUint16(extensionSupportedVersions)
  245. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  246. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  247. for _, vers := range m.supportedVersions {
  248. exts.AddUint16(vers)
  249. }
  250. })
  251. })
  252. }
  253. }
  254. if len(m.cookie) > 0 {
  255. // RFC 8446, Section 4.2.2
  256. if echInner {
  257. echOuterExts = append(echOuterExts, extensionCookie)
  258. } else {
  259. exts.AddUint16(extensionCookie)
  260. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  261. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  262. exts.AddBytes(m.cookie)
  263. })
  264. })
  265. }
  266. }
  267. if len(m.keyShares) > 0 {
  268. // RFC 8446, Section 4.2.8
  269. if echInner {
  270. echOuterExts = append(echOuterExts, extensionKeyShare)
  271. } else {
  272. exts.AddUint16(extensionKeyShare)
  273. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  274. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  275. for _, ks := range m.keyShares {
  276. exts.AddUint16(uint16(ks.group))
  277. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  278. exts.AddBytes(ks.data)
  279. })
  280. }
  281. })
  282. })
  283. }
  284. }
  285. if len(m.pskModes) > 0 {
  286. // RFC 8446, Section 4.2.9
  287. if echInner {
  288. echOuterExts = append(echOuterExts, extensionPSKModes)
  289. } else {
  290. exts.AddUint16(extensionPSKModes)
  291. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  292. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  293. exts.AddBytes(m.pskModes)
  294. })
  295. })
  296. }
  297. }
  298. if len(echOuterExts) > 0 && echInner {
  299. exts.AddUint16(extensionECHOuterExtensions)
  300. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  301. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  302. for _, e := range echOuterExts {
  303. exts.AddUint16(e)
  304. }
  305. })
  306. })
  307. }
  308. if len(m.pskIdentities) > 0 { // pre_shared_key must be the last extension
  309. // RFC 8446, Section 4.2.11
  310. exts.AddUint16(extensionPreSharedKey)
  311. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  312. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  313. for _, psk := range m.pskIdentities {
  314. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  315. exts.AddBytes(psk.label)
  316. })
  317. exts.AddUint32(psk.obfuscatedTicketAge)
  318. }
  319. })
  320. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  321. for _, binder := range m.pskBinders {
  322. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  323. exts.AddBytes(binder)
  324. })
  325. }
  326. })
  327. })
  328. }
  329. extBytes, err := exts.Bytes()
  330. if err != nil {
  331. return nil, err
  332. }
  333. var b cryptobyte.Builder
  334. b.AddUint8(typeClientHello)
  335. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  336. b.AddUint16(m.vers)
  337. addBytesWithLength(b, m.random, 32)
  338. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  339. if !echInner {
  340. b.AddBytes(m.sessionId)
  341. }
  342. })
  343. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  344. for _, suite := range m.cipherSuites {
  345. b.AddUint16(suite)
  346. }
  347. })
  348. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  349. b.AddBytes(m.compressionMethods)
  350. })
  351. if len(extBytes) > 0 {
  352. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  353. b.AddBytes(extBytes)
  354. })
  355. }
  356. })
  357. return b.Bytes()
  358. }
  359. func (m *clientHelloMsg) marshal() ([]byte, error) {
  360. // [Psiphon]
  361. // Randomize the Client Hello.
  362. if m.marshalerPRNGSeed != nil {
  363. return m.marshalRandomizedNoECH()
  364. }
  365. return m.marshalMsg(false)
  366. }
  367. // [Psiphon]
  368. //
  369. // marshalRandomizedNoECH is a randomized variant of `marshalMsg(false)`. The original Marshal
  370. // is retained as-is to ease future merging.
  371. //
  372. // marshalRandomizedNoECH is idempotent given the same `clientHelloMsg.Seed`.
  373. //
  374. // The offered cipher suites and algorithms are shuffled and truncated. Longer
  375. // lists are selected with higher probability. Extensions are shuffled.
  376. //
  377. // The quic_transport_parameters extension is marshaled in quic-go and is
  378. // randomized in TransportParameters.Marshal.
  379. func (m *clientHelloMsg) marshalRandomizedNoECH() ([]byte, error) {
  380. PRNG := prng.NewPRNGWithSeed(m.marshalerPRNGSeed)
  381. cipherSuites := make([]uint16, len(m.cipherSuites))
  382. for {
  383. perm := PRNG.Perm(len(m.cipherSuites))
  384. for i, j := range perm {
  385. cipherSuites[j] = m.cipherSuites[i]
  386. }
  387. cut := len(cipherSuites)
  388. for ; cut > 1; cut-- {
  389. if !PRNG.FlipCoin() {
  390. break
  391. }
  392. }
  393. // Must contain at least one of defaultCipherSuitesTLS13.
  394. containsDefault := false
  395. for _, suite := range cipherSuites[:cut] {
  396. for _, defaultSuite := range defaultCipherSuitesTLS13 {
  397. if suite == defaultSuite {
  398. containsDefault = true
  399. break
  400. }
  401. }
  402. if containsDefault {
  403. break
  404. }
  405. }
  406. if containsDefault {
  407. cipherSuites = cipherSuites[:cut]
  408. break
  409. }
  410. }
  411. compressionMethods := make([]uint8, len(m.compressionMethods))
  412. perm := PRNG.Perm(len(m.compressionMethods))
  413. for i, j := range perm {
  414. compressionMethods[j] = m.compressionMethods[i]
  415. }
  416. cut := len(compressionMethods)
  417. for ; cut > 1; cut-- {
  418. if !PRNG.FlipCoin() {
  419. break
  420. }
  421. }
  422. compressionMethods = compressionMethods[:cut]
  423. // supported_groups (elliptic_curves)
  424. // The supportedCurves field is shuffled and truncated up to `cut`,
  425. // which is randomly drawn from a geometric distribution, determining
  426. // the number of elements retained. However, all keyShare groups
  427. // are always retained.
  428. supportedCurves := make([]CurveID, len(m.supportedCurves))
  429. perm = PRNG.Perm(len(m.supportedCurves))
  430. for i, j := range perm {
  431. supportedCurves[j] = m.supportedCurves[i]
  432. }
  433. cut = len(supportedCurves)
  434. for ; cut > len(m.keyShares); cut-- {
  435. if !PRNG.FlipCoin() {
  436. break
  437. }
  438. }
  439. maxNumToDelete := len(supportedCurves) - cut
  440. numDeleted := 0
  441. supportedCurves = slices.DeleteFunc(supportedCurves, func(curve CurveID) bool {
  442. // Delete curves that are not in keyShares up to maxNumToDelete.
  443. if numDeleted < maxNumToDelete && !slices.ContainsFunc(m.keyShares, func(ks keyShare) bool {
  444. return ks.group == curve
  445. }) {
  446. numDeleted++
  447. return true
  448. }
  449. return false
  450. })
  451. supportedPoints := make([]uint8, len(m.supportedPoints))
  452. perm = PRNG.Perm(len(m.supportedPoints))
  453. for i, j := range perm {
  454. supportedPoints[j] = m.supportedPoints[i]
  455. }
  456. cut = len(supportedPoints)
  457. for ; cut > 1; cut-- {
  458. if !PRNG.FlipCoin() {
  459. break
  460. }
  461. }
  462. supportedPoints = supportedPoints[:cut]
  463. var b cryptobyte.Builder
  464. b.AddUint8(typeClientHello)
  465. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  466. b.AddUint16(m.vers)
  467. addBytesWithLength(b, m.random, 32)
  468. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  469. b.AddBytes(m.sessionId)
  470. })
  471. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  472. for _, suite := range cipherSuites {
  473. b.AddUint16(suite)
  474. }
  475. })
  476. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  477. b.AddBytes(compressionMethods)
  478. })
  479. // If extensions aren't present, omit them.
  480. var extensionsPresent bool
  481. bWithoutExtensions := *b
  482. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  483. extensionMarshallers := []func(){
  484. func() {
  485. if len(m.serverName) > 0 {
  486. // RFC 6066, Section 3
  487. b.AddUint16(extensionServerName)
  488. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  489. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  490. b.AddUint8(0) // name_type = host_name
  491. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  492. b.AddBytes([]byte(m.serverName))
  493. })
  494. })
  495. })
  496. }
  497. },
  498. func() {
  499. if len(supportedPoints) > 0 {
  500. // RFC 4492, Section 5.1.2
  501. b.AddUint16(extensionSupportedPoints)
  502. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  503. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  504. b.AddBytes(supportedPoints)
  505. })
  506. })
  507. }
  508. },
  509. func() {
  510. if m.ticketSupported {
  511. // RFC 5077, Section 3.2
  512. b.AddUint16(extensionSessionTicket)
  513. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  514. b.AddBytes(m.sessionTicket)
  515. })
  516. }
  517. },
  518. func() {
  519. if m.secureRenegotiationSupported {
  520. // RFC 5746, Section 3.2
  521. b.AddUint16(extensionRenegotiationInfo)
  522. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  523. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  524. b.AddBytes(m.secureRenegotiation)
  525. })
  526. })
  527. }
  528. },
  529. func() {
  530. if m.extendedMasterSecret {
  531. // RFC 7672
  532. b.AddUint16(extensionExtendedMasterSecret)
  533. b.AddUint16(0) // empty extension_data
  534. }
  535. },
  536. func() {
  537. if m.scts {
  538. // RFC 6962, Section 3.3.1
  539. b.AddUint16(extensionSCT)
  540. b.AddUint16(0) // empty extension_data
  541. }
  542. },
  543. func() {
  544. if m.earlyData {
  545. // RFC 8446, Section 4.2.10
  546. b.AddUint16(extensionEarlyData)
  547. b.AddUint16(0) // empty extension_data
  548. }
  549. },
  550. func() {
  551. if m.quicTransportParameters != nil { // marshal zero-length parameters when present
  552. // RFC 9001, Section 8.2
  553. b.AddUint16(extensionQUICTransportParameters)
  554. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  555. b.AddBytes(m.quicTransportParameters)
  556. })
  557. }
  558. },
  559. func() {
  560. if m.ocspStapling {
  561. // RFC 4366, Section 3.6
  562. b.AddUint16(extensionStatusRequest)
  563. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  564. b.AddUint8(1) // status_type = ocsp
  565. b.AddUint16(0) // empty responder_id_list
  566. b.AddUint16(0) // empty request_extensions
  567. })
  568. }
  569. },
  570. func() {
  571. if len(supportedCurves) > 0 {
  572. // RFC 4492, sections 5.1.1 and RFC 8446, Section 4.2.7
  573. b.AddUint16(extensionSupportedCurves)
  574. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  575. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  576. for _, curve := range supportedCurves {
  577. b.AddUint16(uint16(curve))
  578. }
  579. })
  580. })
  581. }
  582. },
  583. func() {
  584. if len(m.supportedSignatureAlgorithms) > 0 {
  585. // RFC 5246, Section 7.4.1.4.1
  586. b.AddUint16(extensionSignatureAlgorithms)
  587. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  588. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  589. for _, sigAlgo := range m.supportedSignatureAlgorithms {
  590. b.AddUint16(uint16(sigAlgo))
  591. }
  592. })
  593. })
  594. }
  595. },
  596. func() {
  597. if len(m.supportedSignatureAlgorithmsCert) > 0 {
  598. // RFC 8446, Section 4.2.3
  599. b.AddUint16(extensionSignatureAlgorithmsCert)
  600. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  601. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  602. for _, sigAlgo := range m.supportedSignatureAlgorithmsCert {
  603. b.AddUint16(uint16(sigAlgo))
  604. }
  605. })
  606. })
  607. }
  608. },
  609. func() {
  610. if len(m.alpnProtocols) > 0 {
  611. // RFC 7301, Section 3.1
  612. b.AddUint16(extensionALPN)
  613. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  614. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  615. for _, proto := range m.alpnProtocols {
  616. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  617. b.AddBytes([]byte(proto))
  618. })
  619. }
  620. })
  621. })
  622. }
  623. },
  624. func() {
  625. if len(m.supportedVersions) > 0 {
  626. // RFC 8446, Section 4.2.1
  627. b.AddUint16(extensionSupportedVersions)
  628. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  629. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  630. for _, vers := range m.supportedVersions {
  631. b.AddUint16(vers)
  632. }
  633. })
  634. })
  635. }
  636. },
  637. func() {
  638. if len(m.cookie) > 0 {
  639. // RFC 8446, Section 4.2.2
  640. b.AddUint16(extensionCookie)
  641. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  642. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  643. b.AddBytes(m.cookie)
  644. })
  645. })
  646. }
  647. },
  648. func() {
  649. if len(m.keyShares) > 0 {
  650. // RFC 8446, Section 4.2.8
  651. b.AddUint16(extensionKeyShare)
  652. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  653. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  654. for _, ks := range m.keyShares {
  655. b.AddUint16(uint16(ks.group))
  656. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  657. b.AddBytes(ks.data)
  658. })
  659. }
  660. })
  661. })
  662. }
  663. },
  664. func() {
  665. if len(m.pskModes) > 0 {
  666. // RFC 8446, Section 4.2.9
  667. b.AddUint16(extensionPSKModes)
  668. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  669. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  670. b.AddBytes(m.pskModes)
  671. })
  672. })
  673. }
  674. },
  675. }
  676. // randomize all extensions except pre_shared_key
  677. perm = PRNG.Perm(len(extensionMarshallers))
  678. for _, j := range perm {
  679. extensionMarshallers[j]()
  680. }
  681. if len(m.pskIdentities) > 0 { // pre_shared_key must be the last extension
  682. // RFC 8446, Section 4.2.11
  683. b.AddUint16(extensionPreSharedKey)
  684. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  685. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  686. for _, psk := range m.pskIdentities {
  687. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  688. b.AddBytes(psk.label)
  689. })
  690. b.AddUint32(psk.obfuscatedTicketAge)
  691. }
  692. })
  693. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  694. for _, binder := range m.pskBinders {
  695. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  696. b.AddBytes(binder)
  697. })
  698. }
  699. })
  700. })
  701. }
  702. extensionsPresent = len(b.BytesOrPanic()) > 2
  703. })
  704. if !extensionsPresent {
  705. *b = bWithoutExtensions
  706. }
  707. })
  708. return b.BytesOrPanic(), nil
  709. }
  710. // marshalWithoutBinders returns the ClientHello through the
  711. // PreSharedKeyExtension.identities field, according to RFC 8446, Section
  712. // 4.2.11.2. Note that m.pskBinders must be set to slices of the correct length.
  713. func (m *clientHelloMsg) marshalWithoutBinders() ([]byte, error) {
  714. bindersLen := 2 // uint16 length prefix
  715. for _, binder := range m.pskBinders {
  716. bindersLen += 1 // uint8 length prefix
  717. bindersLen += len(binder)
  718. }
  719. var fullMessage []byte
  720. if m.original != nil {
  721. fullMessage = m.original
  722. } else {
  723. var err error
  724. fullMessage, err = m.marshal()
  725. if err != nil {
  726. return nil, err
  727. }
  728. }
  729. return fullMessage[:len(fullMessage)-bindersLen], nil
  730. }
  731. // updateBinders updates the m.pskBinders field. The supplied binders must have
  732. // the same length as the current m.pskBinders.
  733. func (m *clientHelloMsg) updateBinders(pskBinders [][]byte) error {
  734. if len(pskBinders) != len(m.pskBinders) {
  735. return errors.New("tls: internal error: pskBinders length mismatch")
  736. }
  737. for i := range m.pskBinders {
  738. if len(pskBinders[i]) != len(m.pskBinders[i]) {
  739. return errors.New("tls: internal error: pskBinders length mismatch")
  740. }
  741. }
  742. m.pskBinders = pskBinders
  743. return nil
  744. }
  745. func (m *clientHelloMsg) unmarshal(data []byte) bool {
  746. *m = clientHelloMsg{original: data}
  747. s := cryptobyte.String(data)
  748. if !s.Skip(4) || // message type and uint24 length field
  749. !s.ReadUint16(&m.vers) || !s.ReadBytes(&m.random, 32) ||
  750. !readUint8LengthPrefixed(&s, &m.sessionId) {
  751. return false
  752. }
  753. var cipherSuites cryptobyte.String
  754. if !s.ReadUint16LengthPrefixed(&cipherSuites) {
  755. return false
  756. }
  757. m.cipherSuites = []uint16{}
  758. m.secureRenegotiationSupported = false
  759. for !cipherSuites.Empty() {
  760. var suite uint16
  761. if !cipherSuites.ReadUint16(&suite) {
  762. return false
  763. }
  764. if suite == scsvRenegotiation {
  765. m.secureRenegotiationSupported = true
  766. }
  767. m.cipherSuites = append(m.cipherSuites, suite)
  768. }
  769. if !readUint8LengthPrefixed(&s, &m.compressionMethods) {
  770. return false
  771. }
  772. if s.Empty() {
  773. // ClientHello is optionally followed by extension data
  774. return true
  775. }
  776. var extensions cryptobyte.String
  777. if !s.ReadUint16LengthPrefixed(&extensions) || !s.Empty() {
  778. return false
  779. }
  780. seenExts := make(map[uint16]bool)
  781. for !extensions.Empty() {
  782. var extension uint16
  783. var extData cryptobyte.String
  784. if !extensions.ReadUint16(&extension) ||
  785. !extensions.ReadUint16LengthPrefixed(&extData) {
  786. return false
  787. }
  788. if seenExts[extension] {
  789. return false
  790. }
  791. seenExts[extension] = true
  792. switch extension {
  793. case extensionServerName:
  794. // RFC 6066, Section 3
  795. var nameList cryptobyte.String
  796. if !extData.ReadUint16LengthPrefixed(&nameList) || nameList.Empty() {
  797. return false
  798. }
  799. for !nameList.Empty() {
  800. var nameType uint8
  801. var serverName cryptobyte.String
  802. if !nameList.ReadUint8(&nameType) ||
  803. !nameList.ReadUint16LengthPrefixed(&serverName) ||
  804. serverName.Empty() {
  805. return false
  806. }
  807. if nameType != 0 {
  808. continue
  809. }
  810. if len(m.serverName) != 0 {
  811. // Multiple names of the same name_type are prohibited.
  812. return false
  813. }
  814. m.serverName = string(serverName)
  815. // An SNI value may not include a trailing dot.
  816. if strings.HasSuffix(m.serverName, ".") {
  817. return false
  818. }
  819. }
  820. case extensionStatusRequest:
  821. // RFC 4366, Section 3.6
  822. var statusType uint8
  823. var ignored cryptobyte.String
  824. if !extData.ReadUint8(&statusType) ||
  825. !extData.ReadUint16LengthPrefixed(&ignored) ||
  826. !extData.ReadUint16LengthPrefixed(&ignored) {
  827. return false
  828. }
  829. m.ocspStapling = statusType == statusTypeOCSP
  830. case extensionSupportedCurves:
  831. // RFC 4492, sections 5.1.1 and RFC 8446, Section 4.2.7
  832. var curves cryptobyte.String
  833. if !extData.ReadUint16LengthPrefixed(&curves) || curves.Empty() {
  834. return false
  835. }
  836. for !curves.Empty() {
  837. var curve uint16
  838. if !curves.ReadUint16(&curve) {
  839. return false
  840. }
  841. m.supportedCurves = append(m.supportedCurves, CurveID(curve))
  842. }
  843. case extensionSupportedPoints:
  844. // RFC 4492, Section 5.1.2
  845. if !readUint8LengthPrefixed(&extData, &m.supportedPoints) ||
  846. len(m.supportedPoints) == 0 {
  847. return false
  848. }
  849. case extensionSessionTicket:
  850. // RFC 5077, Section 3.2
  851. m.ticketSupported = true
  852. extData.ReadBytes(&m.sessionTicket, len(extData))
  853. case extensionSignatureAlgorithms:
  854. // RFC 5246, Section 7.4.1.4.1
  855. var sigAndAlgs cryptobyte.String
  856. if !extData.ReadUint16LengthPrefixed(&sigAndAlgs) || sigAndAlgs.Empty() {
  857. return false
  858. }
  859. for !sigAndAlgs.Empty() {
  860. var sigAndAlg uint16
  861. if !sigAndAlgs.ReadUint16(&sigAndAlg) {
  862. return false
  863. }
  864. m.supportedSignatureAlgorithms = append(
  865. m.supportedSignatureAlgorithms, SignatureScheme(sigAndAlg))
  866. }
  867. case extensionSignatureAlgorithmsCert:
  868. // RFC 8446, Section 4.2.3
  869. var sigAndAlgs cryptobyte.String
  870. if !extData.ReadUint16LengthPrefixed(&sigAndAlgs) || sigAndAlgs.Empty() {
  871. return false
  872. }
  873. for !sigAndAlgs.Empty() {
  874. var sigAndAlg uint16
  875. if !sigAndAlgs.ReadUint16(&sigAndAlg) {
  876. return false
  877. }
  878. m.supportedSignatureAlgorithmsCert = append(
  879. m.supportedSignatureAlgorithmsCert, SignatureScheme(sigAndAlg))
  880. }
  881. case extensionRenegotiationInfo:
  882. // RFC 5746, Section 3.2
  883. if !readUint8LengthPrefixed(&extData, &m.secureRenegotiation) {
  884. return false
  885. }
  886. m.secureRenegotiationSupported = true
  887. case extensionExtendedMasterSecret:
  888. // RFC 7627
  889. m.extendedMasterSecret = true
  890. case extensionALPN:
  891. // RFC 7301, Section 3.1
  892. var protoList cryptobyte.String
  893. if !extData.ReadUint16LengthPrefixed(&protoList) || protoList.Empty() {
  894. return false
  895. }
  896. for !protoList.Empty() {
  897. var proto cryptobyte.String
  898. if !protoList.ReadUint8LengthPrefixed(&proto) || proto.Empty() {
  899. return false
  900. }
  901. m.alpnProtocols = append(m.alpnProtocols, string(proto))
  902. }
  903. case extensionSCT:
  904. // RFC 6962, Section 3.3.1
  905. m.scts = true
  906. case extensionSupportedVersions:
  907. // RFC 8446, Section 4.2.1
  908. var versList cryptobyte.String
  909. if !extData.ReadUint8LengthPrefixed(&versList) || versList.Empty() {
  910. return false
  911. }
  912. for !versList.Empty() {
  913. var vers uint16
  914. if !versList.ReadUint16(&vers) {
  915. return false
  916. }
  917. m.supportedVersions = append(m.supportedVersions, vers)
  918. }
  919. case extensionCookie:
  920. // RFC 8446, Section 4.2.2
  921. if !readUint16LengthPrefixed(&extData, &m.cookie) ||
  922. len(m.cookie) == 0 {
  923. return false
  924. }
  925. case extensionKeyShare:
  926. // RFC 8446, Section 4.2.8
  927. var clientShares cryptobyte.String
  928. if !extData.ReadUint16LengthPrefixed(&clientShares) {
  929. return false
  930. }
  931. for !clientShares.Empty() {
  932. var ks keyShare
  933. if !clientShares.ReadUint16((*uint16)(&ks.group)) ||
  934. !readUint16LengthPrefixed(&clientShares, &ks.data) ||
  935. len(ks.data) == 0 {
  936. return false
  937. }
  938. m.keyShares = append(m.keyShares, ks)
  939. }
  940. case extensionEarlyData:
  941. // RFC 8446, Section 4.2.10
  942. m.earlyData = true
  943. case extensionPSKModes:
  944. // RFC 8446, Section 4.2.9
  945. if !readUint8LengthPrefixed(&extData, &m.pskModes) {
  946. return false
  947. }
  948. case extensionQUICTransportParameters:
  949. m.quicTransportParameters = make([]byte, len(extData))
  950. if !extData.CopyBytes(m.quicTransportParameters) {
  951. return false
  952. }
  953. case extensionPreSharedKey:
  954. // RFC 8446, Section 4.2.11
  955. if !extensions.Empty() {
  956. return false // pre_shared_key must be the last extension
  957. }
  958. var identities cryptobyte.String
  959. if !extData.ReadUint16LengthPrefixed(&identities) || identities.Empty() {
  960. return false
  961. }
  962. for !identities.Empty() {
  963. var psk pskIdentity
  964. if !readUint16LengthPrefixed(&identities, &psk.label) ||
  965. !identities.ReadUint32(&psk.obfuscatedTicketAge) ||
  966. len(psk.label) == 0 {
  967. return false
  968. }
  969. m.pskIdentities = append(m.pskIdentities, psk)
  970. }
  971. var binders cryptobyte.String
  972. if !extData.ReadUint16LengthPrefixed(&binders) || binders.Empty() {
  973. return false
  974. }
  975. for !binders.Empty() {
  976. var binder []byte
  977. if !readUint8LengthPrefixed(&binders, &binder) ||
  978. len(binder) == 0 {
  979. return false
  980. }
  981. m.pskBinders = append(m.pskBinders, binder)
  982. }
  983. default:
  984. // Ignore unknown extensions.
  985. continue
  986. }
  987. if !extData.Empty() {
  988. return false
  989. }
  990. }
  991. return true
  992. }
  993. func (m *clientHelloMsg) originalBytes() []byte {
  994. return m.original
  995. }
  996. func (m *clientHelloMsg) clone() *clientHelloMsg {
  997. return &clientHelloMsg{
  998. original: slices.Clone(m.original),
  999. vers: m.vers,
  1000. random: slices.Clone(m.random),
  1001. sessionId: slices.Clone(m.sessionId),
  1002. cipherSuites: slices.Clone(m.cipherSuites),
  1003. compressionMethods: slices.Clone(m.compressionMethods),
  1004. serverName: m.serverName,
  1005. ocspStapling: m.ocspStapling,
  1006. supportedCurves: slices.Clone(m.supportedCurves),
  1007. supportedPoints: slices.Clone(m.supportedPoints),
  1008. ticketSupported: m.ticketSupported,
  1009. sessionTicket: slices.Clone(m.sessionTicket),
  1010. supportedSignatureAlgorithms: slices.Clone(m.supportedSignatureAlgorithms),
  1011. supportedSignatureAlgorithmsCert: slices.Clone(m.supportedSignatureAlgorithmsCert),
  1012. secureRenegotiationSupported: m.secureRenegotiationSupported,
  1013. secureRenegotiation: slices.Clone(m.secureRenegotiation),
  1014. extendedMasterSecret: m.extendedMasterSecret,
  1015. alpnProtocols: slices.Clone(m.alpnProtocols),
  1016. scts: m.scts,
  1017. supportedVersions: slices.Clone(m.supportedVersions),
  1018. cookie: slices.Clone(m.cookie),
  1019. keyShares: slices.Clone(m.keyShares),
  1020. earlyData: m.earlyData,
  1021. pskModes: slices.Clone(m.pskModes),
  1022. pskIdentities: slices.Clone(m.pskIdentities),
  1023. pskBinders: slices.Clone(m.pskBinders),
  1024. quicTransportParameters: slices.Clone(m.quicTransportParameters),
  1025. encryptedClientHello: slices.Clone(m.encryptedClientHello),
  1026. }
  1027. }
  1028. type serverHelloMsg struct {
  1029. original []byte
  1030. vers uint16
  1031. random []byte
  1032. sessionId []byte
  1033. cipherSuite uint16
  1034. compressionMethod uint8
  1035. ocspStapling bool
  1036. ticketSupported bool
  1037. secureRenegotiationSupported bool
  1038. secureRenegotiation []byte
  1039. extendedMasterSecret bool
  1040. alpnProtocol string
  1041. scts [][]byte
  1042. supportedVersion uint16
  1043. serverShare keyShare
  1044. selectedIdentityPresent bool
  1045. selectedIdentity uint16
  1046. supportedPoints []uint8
  1047. encryptedClientHello []byte
  1048. serverNameAck bool
  1049. // HelloRetryRequest extensions
  1050. cookie []byte
  1051. selectedGroup CurveID
  1052. }
  1053. func (m *serverHelloMsg) marshal() ([]byte, error) {
  1054. var exts cryptobyte.Builder
  1055. if m.ocspStapling {
  1056. exts.AddUint16(extensionStatusRequest)
  1057. exts.AddUint16(0) // empty extension_data
  1058. }
  1059. if m.ticketSupported {
  1060. exts.AddUint16(extensionSessionTicket)
  1061. exts.AddUint16(0) // empty extension_data
  1062. }
  1063. if m.secureRenegotiationSupported {
  1064. exts.AddUint16(extensionRenegotiationInfo)
  1065. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1066. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  1067. exts.AddBytes(m.secureRenegotiation)
  1068. })
  1069. })
  1070. }
  1071. if m.extendedMasterSecret {
  1072. exts.AddUint16(extensionExtendedMasterSecret)
  1073. exts.AddUint16(0) // empty extension_data
  1074. }
  1075. if len(m.alpnProtocol) > 0 {
  1076. exts.AddUint16(extensionALPN)
  1077. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1078. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1079. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  1080. exts.AddBytes([]byte(m.alpnProtocol))
  1081. })
  1082. })
  1083. })
  1084. }
  1085. if len(m.scts) > 0 {
  1086. exts.AddUint16(extensionSCT)
  1087. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1088. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1089. for _, sct := range m.scts {
  1090. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1091. exts.AddBytes(sct)
  1092. })
  1093. }
  1094. })
  1095. })
  1096. }
  1097. if m.supportedVersion != 0 {
  1098. exts.AddUint16(extensionSupportedVersions)
  1099. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1100. exts.AddUint16(m.supportedVersion)
  1101. })
  1102. }
  1103. if m.serverShare.group != 0 {
  1104. exts.AddUint16(extensionKeyShare)
  1105. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1106. exts.AddUint16(uint16(m.serverShare.group))
  1107. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1108. exts.AddBytes(m.serverShare.data)
  1109. })
  1110. })
  1111. }
  1112. if m.selectedIdentityPresent {
  1113. exts.AddUint16(extensionPreSharedKey)
  1114. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1115. exts.AddUint16(m.selectedIdentity)
  1116. })
  1117. }
  1118. if len(m.cookie) > 0 {
  1119. exts.AddUint16(extensionCookie)
  1120. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1121. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1122. exts.AddBytes(m.cookie)
  1123. })
  1124. })
  1125. }
  1126. if m.selectedGroup != 0 {
  1127. exts.AddUint16(extensionKeyShare)
  1128. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1129. exts.AddUint16(uint16(m.selectedGroup))
  1130. })
  1131. }
  1132. if len(m.supportedPoints) > 0 {
  1133. exts.AddUint16(extensionSupportedPoints)
  1134. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1135. exts.AddUint8LengthPrefixed(func(exts *cryptobyte.Builder) {
  1136. exts.AddBytes(m.supportedPoints)
  1137. })
  1138. })
  1139. }
  1140. if len(m.encryptedClientHello) > 0 {
  1141. exts.AddUint16(extensionEncryptedClientHello)
  1142. exts.AddUint16LengthPrefixed(func(exts *cryptobyte.Builder) {
  1143. exts.AddBytes(m.encryptedClientHello)
  1144. })
  1145. }
  1146. if m.serverNameAck {
  1147. exts.AddUint16(extensionServerName)
  1148. exts.AddUint16(0)
  1149. }
  1150. extBytes, err := exts.Bytes()
  1151. if err != nil {
  1152. return nil, err
  1153. }
  1154. var b cryptobyte.Builder
  1155. b.AddUint8(typeServerHello)
  1156. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1157. b.AddUint16(m.vers)
  1158. addBytesWithLength(b, m.random, 32)
  1159. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  1160. b.AddBytes(m.sessionId)
  1161. })
  1162. b.AddUint16(m.cipherSuite)
  1163. b.AddUint8(m.compressionMethod)
  1164. if len(extBytes) > 0 {
  1165. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1166. b.AddBytes(extBytes)
  1167. })
  1168. }
  1169. })
  1170. return b.Bytes()
  1171. }
  1172. func (m *serverHelloMsg) unmarshal(data []byte) bool {
  1173. *m = serverHelloMsg{original: data}
  1174. s := cryptobyte.String(data)
  1175. if !s.Skip(4) || // message type and uint24 length field
  1176. !s.ReadUint16(&m.vers) || !s.ReadBytes(&m.random, 32) ||
  1177. !readUint8LengthPrefixed(&s, &m.sessionId) ||
  1178. !s.ReadUint16(&m.cipherSuite) ||
  1179. !s.ReadUint8(&m.compressionMethod) {
  1180. return false
  1181. }
  1182. if s.Empty() {
  1183. // ServerHello is optionally followed by extension data
  1184. return true
  1185. }
  1186. var extensions cryptobyte.String
  1187. if !s.ReadUint16LengthPrefixed(&extensions) || !s.Empty() {
  1188. return false
  1189. }
  1190. seenExts := make(map[uint16]bool)
  1191. for !extensions.Empty() {
  1192. var extension uint16
  1193. var extData cryptobyte.String
  1194. if !extensions.ReadUint16(&extension) ||
  1195. !extensions.ReadUint16LengthPrefixed(&extData) {
  1196. return false
  1197. }
  1198. if seenExts[extension] {
  1199. return false
  1200. }
  1201. seenExts[extension] = true
  1202. switch extension {
  1203. case extensionStatusRequest:
  1204. m.ocspStapling = true
  1205. case extensionSessionTicket:
  1206. m.ticketSupported = true
  1207. case extensionRenegotiationInfo:
  1208. if !readUint8LengthPrefixed(&extData, &m.secureRenegotiation) {
  1209. return false
  1210. }
  1211. m.secureRenegotiationSupported = true
  1212. case extensionExtendedMasterSecret:
  1213. m.extendedMasterSecret = true
  1214. case extensionALPN:
  1215. var protoList cryptobyte.String
  1216. if !extData.ReadUint16LengthPrefixed(&protoList) || protoList.Empty() {
  1217. return false
  1218. }
  1219. var proto cryptobyte.String
  1220. if !protoList.ReadUint8LengthPrefixed(&proto) ||
  1221. proto.Empty() || !protoList.Empty() {
  1222. return false
  1223. }
  1224. m.alpnProtocol = string(proto)
  1225. case extensionSCT:
  1226. var sctList cryptobyte.String
  1227. if !extData.ReadUint16LengthPrefixed(&sctList) || sctList.Empty() {
  1228. return false
  1229. }
  1230. for !sctList.Empty() {
  1231. var sct []byte
  1232. if !readUint16LengthPrefixed(&sctList, &sct) ||
  1233. len(sct) == 0 {
  1234. return false
  1235. }
  1236. m.scts = append(m.scts, sct)
  1237. }
  1238. case extensionSupportedVersions:
  1239. if !extData.ReadUint16(&m.supportedVersion) {
  1240. return false
  1241. }
  1242. case extensionCookie:
  1243. if !readUint16LengthPrefixed(&extData, &m.cookie) ||
  1244. len(m.cookie) == 0 {
  1245. return false
  1246. }
  1247. case extensionKeyShare:
  1248. // This extension has different formats in SH and HRR, accept either
  1249. // and let the handshake logic decide. See RFC 8446, Section 4.2.8.
  1250. if len(extData) == 2 {
  1251. if !extData.ReadUint16((*uint16)(&m.selectedGroup)) {
  1252. return false
  1253. }
  1254. } else {
  1255. if !extData.ReadUint16((*uint16)(&m.serverShare.group)) ||
  1256. !readUint16LengthPrefixed(&extData, &m.serverShare.data) {
  1257. return false
  1258. }
  1259. }
  1260. case extensionPreSharedKey:
  1261. m.selectedIdentityPresent = true
  1262. if !extData.ReadUint16(&m.selectedIdentity) {
  1263. return false
  1264. }
  1265. case extensionSupportedPoints:
  1266. // RFC 4492, Section 5.1.2
  1267. if !readUint8LengthPrefixed(&extData, &m.supportedPoints) ||
  1268. len(m.supportedPoints) == 0 {
  1269. return false
  1270. }
  1271. case extensionEncryptedClientHello: // encrypted_client_hello
  1272. m.encryptedClientHello = make([]byte, len(extData))
  1273. if !extData.CopyBytes(m.encryptedClientHello) {
  1274. return false
  1275. }
  1276. case extensionServerName:
  1277. if len(extData) != 0 {
  1278. return false
  1279. }
  1280. m.serverNameAck = true
  1281. default:
  1282. // Ignore unknown extensions.
  1283. continue
  1284. }
  1285. if !extData.Empty() {
  1286. return false
  1287. }
  1288. }
  1289. return true
  1290. }
  1291. func (m *serverHelloMsg) originalBytes() []byte {
  1292. return m.original
  1293. }
  1294. type encryptedExtensionsMsg struct {
  1295. alpnProtocol string
  1296. quicTransportParameters []byte
  1297. earlyData bool
  1298. echRetryConfigs []byte
  1299. }
  1300. func (m *encryptedExtensionsMsg) marshal() ([]byte, error) {
  1301. var b cryptobyte.Builder
  1302. b.AddUint8(typeEncryptedExtensions)
  1303. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1304. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1305. if len(m.alpnProtocol) > 0 {
  1306. b.AddUint16(extensionALPN)
  1307. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1308. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1309. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  1310. b.AddBytes([]byte(m.alpnProtocol))
  1311. })
  1312. })
  1313. })
  1314. }
  1315. if m.quicTransportParameters != nil { // marshal zero-length parameters when present
  1316. // draft-ietf-quic-tls-32, Section 8.2
  1317. b.AddUint16(extensionQUICTransportParameters)
  1318. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1319. b.AddBytes(m.quicTransportParameters)
  1320. })
  1321. }
  1322. if m.earlyData {
  1323. // RFC 8446, Section 4.2.10
  1324. b.AddUint16(extensionEarlyData)
  1325. b.AddUint16(0) // empty extension_data
  1326. }
  1327. if len(m.echRetryConfigs) > 0 {
  1328. b.AddUint16(extensionEncryptedClientHello)
  1329. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1330. b.AddBytes(m.echRetryConfigs)
  1331. })
  1332. }
  1333. })
  1334. })
  1335. return b.Bytes()
  1336. }
  1337. func (m *encryptedExtensionsMsg) unmarshal(data []byte) bool {
  1338. *m = encryptedExtensionsMsg{}
  1339. s := cryptobyte.String(data)
  1340. var extensions cryptobyte.String
  1341. if !s.Skip(4) || // message type and uint24 length field
  1342. !s.ReadUint16LengthPrefixed(&extensions) || !s.Empty() {
  1343. return false
  1344. }
  1345. for !extensions.Empty() {
  1346. var extension uint16
  1347. var extData cryptobyte.String
  1348. if !extensions.ReadUint16(&extension) ||
  1349. !extensions.ReadUint16LengthPrefixed(&extData) {
  1350. return false
  1351. }
  1352. switch extension {
  1353. case extensionALPN:
  1354. var protoList cryptobyte.String
  1355. if !extData.ReadUint16LengthPrefixed(&protoList) || protoList.Empty() {
  1356. return false
  1357. }
  1358. var proto cryptobyte.String
  1359. if !protoList.ReadUint8LengthPrefixed(&proto) ||
  1360. proto.Empty() || !protoList.Empty() {
  1361. return false
  1362. }
  1363. m.alpnProtocol = string(proto)
  1364. case extensionQUICTransportParameters:
  1365. m.quicTransportParameters = make([]byte, len(extData))
  1366. if !extData.CopyBytes(m.quicTransportParameters) {
  1367. return false
  1368. }
  1369. case extensionEarlyData:
  1370. // RFC 8446, Section 4.2.10
  1371. m.earlyData = true
  1372. case extensionEncryptedClientHello:
  1373. m.echRetryConfigs = make([]byte, len(extData))
  1374. if !extData.CopyBytes(m.echRetryConfigs) {
  1375. return false
  1376. }
  1377. default:
  1378. // Ignore unknown extensions.
  1379. continue
  1380. }
  1381. if !extData.Empty() {
  1382. return false
  1383. }
  1384. }
  1385. return true
  1386. }
  1387. type endOfEarlyDataMsg struct{}
  1388. func (m *endOfEarlyDataMsg) marshal() ([]byte, error) {
  1389. x := make([]byte, 4)
  1390. x[0] = typeEndOfEarlyData
  1391. return x, nil
  1392. }
  1393. func (m *endOfEarlyDataMsg) unmarshal(data []byte) bool {
  1394. return len(data) == 4
  1395. }
  1396. type keyUpdateMsg struct {
  1397. updateRequested bool
  1398. }
  1399. func (m *keyUpdateMsg) marshal() ([]byte, error) {
  1400. var b cryptobyte.Builder
  1401. b.AddUint8(typeKeyUpdate)
  1402. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1403. if m.updateRequested {
  1404. b.AddUint8(1)
  1405. } else {
  1406. b.AddUint8(0)
  1407. }
  1408. })
  1409. return b.Bytes()
  1410. }
  1411. func (m *keyUpdateMsg) unmarshal(data []byte) bool {
  1412. s := cryptobyte.String(data)
  1413. var updateRequested uint8
  1414. if !s.Skip(4) || // message type and uint24 length field
  1415. !s.ReadUint8(&updateRequested) || !s.Empty() {
  1416. return false
  1417. }
  1418. switch updateRequested {
  1419. case 0:
  1420. m.updateRequested = false
  1421. case 1:
  1422. m.updateRequested = true
  1423. default:
  1424. return false
  1425. }
  1426. return true
  1427. }
  1428. type newSessionTicketMsgTLS13 struct {
  1429. lifetime uint32
  1430. ageAdd uint32
  1431. nonce []byte
  1432. label []byte
  1433. maxEarlyData uint32
  1434. }
  1435. func (m *newSessionTicketMsgTLS13) marshal() ([]byte, error) {
  1436. var b cryptobyte.Builder
  1437. b.AddUint8(typeNewSessionTicket)
  1438. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1439. b.AddUint32(m.lifetime)
  1440. b.AddUint32(m.ageAdd)
  1441. b.AddUint8LengthPrefixed(func(b *cryptobyte.Builder) {
  1442. b.AddBytes(m.nonce)
  1443. })
  1444. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1445. b.AddBytes(m.label)
  1446. })
  1447. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1448. if m.maxEarlyData > 0 {
  1449. b.AddUint16(extensionEarlyData)
  1450. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1451. b.AddUint32(m.maxEarlyData)
  1452. })
  1453. }
  1454. })
  1455. })
  1456. return b.Bytes()
  1457. }
  1458. func (m *newSessionTicketMsgTLS13) unmarshal(data []byte) bool {
  1459. *m = newSessionTicketMsgTLS13{}
  1460. s := cryptobyte.String(data)
  1461. var extensions cryptobyte.String
  1462. if !s.Skip(4) || // message type and uint24 length field
  1463. !s.ReadUint32(&m.lifetime) ||
  1464. !s.ReadUint32(&m.ageAdd) ||
  1465. !readUint8LengthPrefixed(&s, &m.nonce) ||
  1466. !readUint16LengthPrefixed(&s, &m.label) ||
  1467. !s.ReadUint16LengthPrefixed(&extensions) ||
  1468. !s.Empty() {
  1469. return false
  1470. }
  1471. for !extensions.Empty() {
  1472. var extension uint16
  1473. var extData cryptobyte.String
  1474. if !extensions.ReadUint16(&extension) ||
  1475. !extensions.ReadUint16LengthPrefixed(&extData) {
  1476. return false
  1477. }
  1478. switch extension {
  1479. case extensionEarlyData:
  1480. if !extData.ReadUint32(&m.maxEarlyData) {
  1481. return false
  1482. }
  1483. default:
  1484. // Ignore unknown extensions.
  1485. continue
  1486. }
  1487. if !extData.Empty() {
  1488. return false
  1489. }
  1490. }
  1491. return true
  1492. }
  1493. type certificateRequestMsgTLS13 struct {
  1494. ocspStapling bool
  1495. scts bool
  1496. supportedSignatureAlgorithms []SignatureScheme
  1497. supportedSignatureAlgorithmsCert []SignatureScheme
  1498. certificateAuthorities [][]byte
  1499. }
  1500. func (m *certificateRequestMsgTLS13) marshal() ([]byte, error) {
  1501. var b cryptobyte.Builder
  1502. b.AddUint8(typeCertificateRequest)
  1503. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1504. // certificate_request_context (SHALL be zero length unless used for
  1505. // post-handshake authentication)
  1506. b.AddUint8(0)
  1507. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1508. if m.ocspStapling {
  1509. b.AddUint16(extensionStatusRequest)
  1510. b.AddUint16(0) // empty extension_data
  1511. }
  1512. if m.scts {
  1513. // RFC 8446, Section 4.4.2.1 makes no mention of
  1514. // signed_certificate_timestamp in CertificateRequest, but
  1515. // "Extensions in the Certificate message from the client MUST
  1516. // correspond to extensions in the CertificateRequest message
  1517. // from the server." and it appears in the table in Section 4.2.
  1518. b.AddUint16(extensionSCT)
  1519. b.AddUint16(0) // empty extension_data
  1520. }
  1521. if len(m.supportedSignatureAlgorithms) > 0 {
  1522. b.AddUint16(extensionSignatureAlgorithms)
  1523. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1524. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1525. for _, sigAlgo := range m.supportedSignatureAlgorithms {
  1526. b.AddUint16(uint16(sigAlgo))
  1527. }
  1528. })
  1529. })
  1530. }
  1531. if len(m.supportedSignatureAlgorithmsCert) > 0 {
  1532. b.AddUint16(extensionSignatureAlgorithmsCert)
  1533. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1534. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1535. for _, sigAlgo := range m.supportedSignatureAlgorithmsCert {
  1536. b.AddUint16(uint16(sigAlgo))
  1537. }
  1538. })
  1539. })
  1540. }
  1541. if len(m.certificateAuthorities) > 0 {
  1542. b.AddUint16(extensionCertificateAuthorities)
  1543. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1544. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1545. for _, ca := range m.certificateAuthorities {
  1546. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1547. b.AddBytes(ca)
  1548. })
  1549. }
  1550. })
  1551. })
  1552. }
  1553. })
  1554. })
  1555. return b.Bytes()
  1556. }
  1557. func (m *certificateRequestMsgTLS13) unmarshal(data []byte) bool {
  1558. *m = certificateRequestMsgTLS13{}
  1559. s := cryptobyte.String(data)
  1560. var context, extensions cryptobyte.String
  1561. if !s.Skip(4) || // message type and uint24 length field
  1562. !s.ReadUint8LengthPrefixed(&context) || !context.Empty() ||
  1563. !s.ReadUint16LengthPrefixed(&extensions) ||
  1564. !s.Empty() {
  1565. return false
  1566. }
  1567. for !extensions.Empty() {
  1568. var extension uint16
  1569. var extData cryptobyte.String
  1570. if !extensions.ReadUint16(&extension) ||
  1571. !extensions.ReadUint16LengthPrefixed(&extData) {
  1572. return false
  1573. }
  1574. switch extension {
  1575. case extensionStatusRequest:
  1576. m.ocspStapling = true
  1577. case extensionSCT:
  1578. m.scts = true
  1579. case extensionSignatureAlgorithms:
  1580. var sigAndAlgs cryptobyte.String
  1581. if !extData.ReadUint16LengthPrefixed(&sigAndAlgs) || sigAndAlgs.Empty() {
  1582. return false
  1583. }
  1584. for !sigAndAlgs.Empty() {
  1585. var sigAndAlg uint16
  1586. if !sigAndAlgs.ReadUint16(&sigAndAlg) {
  1587. return false
  1588. }
  1589. m.supportedSignatureAlgorithms = append(
  1590. m.supportedSignatureAlgorithms, SignatureScheme(sigAndAlg))
  1591. }
  1592. case extensionSignatureAlgorithmsCert:
  1593. var sigAndAlgs cryptobyte.String
  1594. if !extData.ReadUint16LengthPrefixed(&sigAndAlgs) || sigAndAlgs.Empty() {
  1595. return false
  1596. }
  1597. for !sigAndAlgs.Empty() {
  1598. var sigAndAlg uint16
  1599. if !sigAndAlgs.ReadUint16(&sigAndAlg) {
  1600. return false
  1601. }
  1602. m.supportedSignatureAlgorithmsCert = append(
  1603. m.supportedSignatureAlgorithmsCert, SignatureScheme(sigAndAlg))
  1604. }
  1605. case extensionCertificateAuthorities:
  1606. var auths cryptobyte.String
  1607. if !extData.ReadUint16LengthPrefixed(&auths) || auths.Empty() {
  1608. return false
  1609. }
  1610. for !auths.Empty() {
  1611. var ca []byte
  1612. if !readUint16LengthPrefixed(&auths, &ca) || len(ca) == 0 {
  1613. return false
  1614. }
  1615. m.certificateAuthorities = append(m.certificateAuthorities, ca)
  1616. }
  1617. default:
  1618. // Ignore unknown extensions.
  1619. continue
  1620. }
  1621. if !extData.Empty() {
  1622. return false
  1623. }
  1624. }
  1625. return true
  1626. }
  1627. type certificateMsg struct {
  1628. certificates [][]byte
  1629. }
  1630. func (m *certificateMsg) marshal() ([]byte, error) {
  1631. var i int
  1632. for _, slice := range m.certificates {
  1633. i += len(slice)
  1634. }
  1635. length := 3 + 3*len(m.certificates) + i
  1636. x := make([]byte, 4+length)
  1637. x[0] = typeCertificate
  1638. x[1] = uint8(length >> 16)
  1639. x[2] = uint8(length >> 8)
  1640. x[3] = uint8(length)
  1641. certificateOctets := length - 3
  1642. x[4] = uint8(certificateOctets >> 16)
  1643. x[5] = uint8(certificateOctets >> 8)
  1644. x[6] = uint8(certificateOctets)
  1645. y := x[7:]
  1646. for _, slice := range m.certificates {
  1647. y[0] = uint8(len(slice) >> 16)
  1648. y[1] = uint8(len(slice) >> 8)
  1649. y[2] = uint8(len(slice))
  1650. copy(y[3:], slice)
  1651. y = y[3+len(slice):]
  1652. }
  1653. return x, nil
  1654. }
  1655. func (m *certificateMsg) unmarshal(data []byte) bool {
  1656. if len(data) < 7 {
  1657. return false
  1658. }
  1659. certsLen := uint32(data[4])<<16 | uint32(data[5])<<8 | uint32(data[6])
  1660. if uint32(len(data)) != certsLen+7 {
  1661. return false
  1662. }
  1663. numCerts := 0
  1664. d := data[7:]
  1665. for certsLen > 0 {
  1666. if len(d) < 4 {
  1667. return false
  1668. }
  1669. certLen := uint32(d[0])<<16 | uint32(d[1])<<8 | uint32(d[2])
  1670. if uint32(len(d)) < 3+certLen {
  1671. return false
  1672. }
  1673. d = d[3+certLen:]
  1674. certsLen -= 3 + certLen
  1675. numCerts++
  1676. }
  1677. m.certificates = make([][]byte, numCerts)
  1678. d = data[7:]
  1679. for i := 0; i < numCerts; i++ {
  1680. certLen := uint32(d[0])<<16 | uint32(d[1])<<8 | uint32(d[2])
  1681. m.certificates[i] = d[3 : 3+certLen]
  1682. d = d[3+certLen:]
  1683. }
  1684. return true
  1685. }
  1686. type certificateMsgTLS13 struct {
  1687. certificate Certificate
  1688. ocspStapling bool
  1689. scts bool
  1690. }
  1691. func (m *certificateMsgTLS13) marshal() ([]byte, error) {
  1692. var b cryptobyte.Builder
  1693. b.AddUint8(typeCertificate)
  1694. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1695. b.AddUint8(0) // certificate_request_context
  1696. certificate := m.certificate
  1697. if !m.ocspStapling {
  1698. certificate.OCSPStaple = nil
  1699. }
  1700. if !m.scts {
  1701. certificate.SignedCertificateTimestamps = nil
  1702. }
  1703. marshalCertificate(b, certificate)
  1704. })
  1705. return b.Bytes()
  1706. }
  1707. func marshalCertificate(b *cryptobyte.Builder, certificate Certificate) {
  1708. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1709. for i, cert := range certificate.Certificate {
  1710. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1711. b.AddBytes(cert)
  1712. })
  1713. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1714. if i > 0 {
  1715. // This library only supports OCSP and SCT for leaf certificates.
  1716. return
  1717. }
  1718. if certificate.OCSPStaple != nil {
  1719. b.AddUint16(extensionStatusRequest)
  1720. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1721. b.AddUint8(statusTypeOCSP)
  1722. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1723. b.AddBytes(certificate.OCSPStaple)
  1724. })
  1725. })
  1726. }
  1727. if certificate.SignedCertificateTimestamps != nil {
  1728. b.AddUint16(extensionSCT)
  1729. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1730. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1731. for _, sct := range certificate.SignedCertificateTimestamps {
  1732. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  1733. b.AddBytes(sct)
  1734. })
  1735. }
  1736. })
  1737. })
  1738. }
  1739. })
  1740. }
  1741. })
  1742. }
  1743. func (m *certificateMsgTLS13) unmarshal(data []byte) bool {
  1744. *m = certificateMsgTLS13{}
  1745. s := cryptobyte.String(data)
  1746. var context cryptobyte.String
  1747. if !s.Skip(4) || // message type and uint24 length field
  1748. !s.ReadUint8LengthPrefixed(&context) || !context.Empty() ||
  1749. !unmarshalCertificate(&s, &m.certificate) ||
  1750. !s.Empty() {
  1751. return false
  1752. }
  1753. m.scts = m.certificate.SignedCertificateTimestamps != nil
  1754. m.ocspStapling = m.certificate.OCSPStaple != nil
  1755. return true
  1756. }
  1757. func unmarshalCertificate(s *cryptobyte.String, certificate *Certificate) bool {
  1758. var certList cryptobyte.String
  1759. if !s.ReadUint24LengthPrefixed(&certList) {
  1760. return false
  1761. }
  1762. for !certList.Empty() {
  1763. var cert []byte
  1764. var extensions cryptobyte.String
  1765. if !readUint24LengthPrefixed(&certList, &cert) ||
  1766. !certList.ReadUint16LengthPrefixed(&extensions) {
  1767. return false
  1768. }
  1769. certificate.Certificate = append(certificate.Certificate, cert)
  1770. for !extensions.Empty() {
  1771. var extension uint16
  1772. var extData cryptobyte.String
  1773. if !extensions.ReadUint16(&extension) ||
  1774. !extensions.ReadUint16LengthPrefixed(&extData) {
  1775. return false
  1776. }
  1777. if len(certificate.Certificate) > 1 {
  1778. // This library only supports OCSP and SCT for leaf certificates.
  1779. continue
  1780. }
  1781. switch extension {
  1782. case extensionStatusRequest:
  1783. var statusType uint8
  1784. if !extData.ReadUint8(&statusType) || statusType != statusTypeOCSP ||
  1785. !readUint24LengthPrefixed(&extData, &certificate.OCSPStaple) ||
  1786. len(certificate.OCSPStaple) == 0 {
  1787. return false
  1788. }
  1789. case extensionSCT:
  1790. var sctList cryptobyte.String
  1791. if !extData.ReadUint16LengthPrefixed(&sctList) || sctList.Empty() {
  1792. return false
  1793. }
  1794. for !sctList.Empty() {
  1795. var sct []byte
  1796. if !readUint16LengthPrefixed(&sctList, &sct) ||
  1797. len(sct) == 0 {
  1798. return false
  1799. }
  1800. certificate.SignedCertificateTimestamps = append(
  1801. certificate.SignedCertificateTimestamps, sct)
  1802. }
  1803. default:
  1804. // Ignore unknown extensions.
  1805. continue
  1806. }
  1807. if !extData.Empty() {
  1808. return false
  1809. }
  1810. }
  1811. }
  1812. return true
  1813. }
  1814. type serverKeyExchangeMsg struct {
  1815. key []byte
  1816. }
  1817. func (m *serverKeyExchangeMsg) marshal() ([]byte, error) {
  1818. length := len(m.key)
  1819. x := make([]byte, length+4)
  1820. x[0] = typeServerKeyExchange
  1821. x[1] = uint8(length >> 16)
  1822. x[2] = uint8(length >> 8)
  1823. x[3] = uint8(length)
  1824. copy(x[4:], m.key)
  1825. return x, nil
  1826. }
  1827. func (m *serverKeyExchangeMsg) unmarshal(data []byte) bool {
  1828. if len(data) < 4 {
  1829. return false
  1830. }
  1831. m.key = data[4:]
  1832. return true
  1833. }
  1834. type certificateStatusMsg struct {
  1835. response []byte
  1836. }
  1837. func (m *certificateStatusMsg) marshal() ([]byte, error) {
  1838. var b cryptobyte.Builder
  1839. b.AddUint8(typeCertificateStatus)
  1840. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1841. b.AddUint8(statusTypeOCSP)
  1842. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1843. b.AddBytes(m.response)
  1844. })
  1845. })
  1846. return b.Bytes()
  1847. }
  1848. func (m *certificateStatusMsg) unmarshal(data []byte) bool {
  1849. s := cryptobyte.String(data)
  1850. var statusType uint8
  1851. if !s.Skip(4) || // message type and uint24 length field
  1852. !s.ReadUint8(&statusType) || statusType != statusTypeOCSP ||
  1853. !readUint24LengthPrefixed(&s, &m.response) ||
  1854. len(m.response) == 0 || !s.Empty() {
  1855. return false
  1856. }
  1857. return true
  1858. }
  1859. type serverHelloDoneMsg struct{}
  1860. func (m *serverHelloDoneMsg) marshal() ([]byte, error) {
  1861. x := make([]byte, 4)
  1862. x[0] = typeServerHelloDone
  1863. return x, nil
  1864. }
  1865. func (m *serverHelloDoneMsg) unmarshal(data []byte) bool {
  1866. return len(data) == 4
  1867. }
  1868. type clientKeyExchangeMsg struct {
  1869. ciphertext []byte
  1870. }
  1871. func (m *clientKeyExchangeMsg) marshal() ([]byte, error) {
  1872. length := len(m.ciphertext)
  1873. x := make([]byte, length+4)
  1874. x[0] = typeClientKeyExchange
  1875. x[1] = uint8(length >> 16)
  1876. x[2] = uint8(length >> 8)
  1877. x[3] = uint8(length)
  1878. copy(x[4:], m.ciphertext)
  1879. return x, nil
  1880. }
  1881. func (m *clientKeyExchangeMsg) unmarshal(data []byte) bool {
  1882. if len(data) < 4 {
  1883. return false
  1884. }
  1885. l := int(data[1])<<16 | int(data[2])<<8 | int(data[3])
  1886. if l != len(data)-4 {
  1887. return false
  1888. }
  1889. m.ciphertext = data[4:]
  1890. return true
  1891. }
  1892. type finishedMsg struct {
  1893. verifyData []byte
  1894. }
  1895. func (m *finishedMsg) marshal() ([]byte, error) {
  1896. var b cryptobyte.Builder
  1897. b.AddUint8(typeFinished)
  1898. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  1899. b.AddBytes(m.verifyData)
  1900. })
  1901. return b.Bytes()
  1902. }
  1903. func (m *finishedMsg) unmarshal(data []byte) bool {
  1904. s := cryptobyte.String(data)
  1905. return s.Skip(1) &&
  1906. readUint24LengthPrefixed(&s, &m.verifyData) &&
  1907. s.Empty()
  1908. }
  1909. type certificateRequestMsg struct {
  1910. // hasSignatureAlgorithm indicates whether this message includes a list of
  1911. // supported signature algorithms. This change was introduced with TLS 1.2.
  1912. hasSignatureAlgorithm bool
  1913. certificateTypes []byte
  1914. supportedSignatureAlgorithms []SignatureScheme
  1915. certificateAuthorities [][]byte
  1916. }
  1917. func (m *certificateRequestMsg) marshal() ([]byte, error) {
  1918. // See RFC 4346, Section 7.4.4.
  1919. length := 1 + len(m.certificateTypes) + 2
  1920. casLength := 0
  1921. for _, ca := range m.certificateAuthorities {
  1922. casLength += 2 + len(ca)
  1923. }
  1924. length += casLength
  1925. if m.hasSignatureAlgorithm {
  1926. length += 2 + 2*len(m.supportedSignatureAlgorithms)
  1927. }
  1928. x := make([]byte, 4+length)
  1929. x[0] = typeCertificateRequest
  1930. x[1] = uint8(length >> 16)
  1931. x[2] = uint8(length >> 8)
  1932. x[3] = uint8(length)
  1933. x[4] = uint8(len(m.certificateTypes))
  1934. copy(x[5:], m.certificateTypes)
  1935. y := x[5+len(m.certificateTypes):]
  1936. if m.hasSignatureAlgorithm {
  1937. n := len(m.supportedSignatureAlgorithms) * 2
  1938. y[0] = uint8(n >> 8)
  1939. y[1] = uint8(n)
  1940. y = y[2:]
  1941. for _, sigAlgo := range m.supportedSignatureAlgorithms {
  1942. y[0] = uint8(sigAlgo >> 8)
  1943. y[1] = uint8(sigAlgo)
  1944. y = y[2:]
  1945. }
  1946. }
  1947. y[0] = uint8(casLength >> 8)
  1948. y[1] = uint8(casLength)
  1949. y = y[2:]
  1950. for _, ca := range m.certificateAuthorities {
  1951. y[0] = uint8(len(ca) >> 8)
  1952. y[1] = uint8(len(ca))
  1953. y = y[2:]
  1954. copy(y, ca)
  1955. y = y[len(ca):]
  1956. }
  1957. return x, nil
  1958. }
  1959. func (m *certificateRequestMsg) unmarshal(data []byte) bool {
  1960. if len(data) < 5 {
  1961. return false
  1962. }
  1963. length := uint32(data[1])<<16 | uint32(data[2])<<8 | uint32(data[3])
  1964. if uint32(len(data))-4 != length {
  1965. return false
  1966. }
  1967. numCertTypes := int(data[4])
  1968. data = data[5:]
  1969. if numCertTypes == 0 || len(data) <= numCertTypes {
  1970. return false
  1971. }
  1972. m.certificateTypes = make([]byte, numCertTypes)
  1973. if copy(m.certificateTypes, data) != numCertTypes {
  1974. return false
  1975. }
  1976. data = data[numCertTypes:]
  1977. if m.hasSignatureAlgorithm {
  1978. if len(data) < 2 {
  1979. return false
  1980. }
  1981. sigAndHashLen := uint16(data[0])<<8 | uint16(data[1])
  1982. data = data[2:]
  1983. if sigAndHashLen&1 != 0 {
  1984. return false
  1985. }
  1986. if len(data) < int(sigAndHashLen) {
  1987. return false
  1988. }
  1989. numSigAlgos := sigAndHashLen / 2
  1990. m.supportedSignatureAlgorithms = make([]SignatureScheme, numSigAlgos)
  1991. for i := range m.supportedSignatureAlgorithms {
  1992. m.supportedSignatureAlgorithms[i] = SignatureScheme(data[0])<<8 | SignatureScheme(data[1])
  1993. data = data[2:]
  1994. }
  1995. }
  1996. if len(data) < 2 {
  1997. return false
  1998. }
  1999. casLength := uint16(data[0])<<8 | uint16(data[1])
  2000. data = data[2:]
  2001. if len(data) < int(casLength) {
  2002. return false
  2003. }
  2004. cas := make([]byte, casLength)
  2005. copy(cas, data)
  2006. data = data[casLength:]
  2007. m.certificateAuthorities = nil
  2008. for len(cas) > 0 {
  2009. if len(cas) < 2 {
  2010. return false
  2011. }
  2012. caLen := uint16(cas[0])<<8 | uint16(cas[1])
  2013. cas = cas[2:]
  2014. if len(cas) < int(caLen) {
  2015. return false
  2016. }
  2017. m.certificateAuthorities = append(m.certificateAuthorities, cas[:caLen])
  2018. cas = cas[caLen:]
  2019. }
  2020. return len(data) == 0
  2021. }
  2022. type certificateVerifyMsg struct {
  2023. hasSignatureAlgorithm bool // format change introduced in TLS 1.2
  2024. signatureAlgorithm SignatureScheme
  2025. signature []byte
  2026. }
  2027. func (m *certificateVerifyMsg) marshal() ([]byte, error) {
  2028. var b cryptobyte.Builder
  2029. b.AddUint8(typeCertificateVerify)
  2030. b.AddUint24LengthPrefixed(func(b *cryptobyte.Builder) {
  2031. if m.hasSignatureAlgorithm {
  2032. b.AddUint16(uint16(m.signatureAlgorithm))
  2033. }
  2034. b.AddUint16LengthPrefixed(func(b *cryptobyte.Builder) {
  2035. b.AddBytes(m.signature)
  2036. })
  2037. })
  2038. return b.Bytes()
  2039. }
  2040. func (m *certificateVerifyMsg) unmarshal(data []byte) bool {
  2041. s := cryptobyte.String(data)
  2042. if !s.Skip(4) { // message type and uint24 length field
  2043. return false
  2044. }
  2045. if m.hasSignatureAlgorithm {
  2046. if !s.ReadUint16((*uint16)(&m.signatureAlgorithm)) {
  2047. return false
  2048. }
  2049. }
  2050. return readUint16LengthPrefixed(&s, &m.signature) && s.Empty()
  2051. }
  2052. type newSessionTicketMsg struct {
  2053. ticket []byte
  2054. }
  2055. func (m *newSessionTicketMsg) marshal() ([]byte, error) {
  2056. // See RFC 5077, Section 3.3.
  2057. ticketLen := len(m.ticket)
  2058. length := 2 + 4 + ticketLen
  2059. x := make([]byte, 4+length)
  2060. x[0] = typeNewSessionTicket
  2061. x[1] = uint8(length >> 16)
  2062. x[2] = uint8(length >> 8)
  2063. x[3] = uint8(length)
  2064. x[8] = uint8(ticketLen >> 8)
  2065. x[9] = uint8(ticketLen)
  2066. copy(x[10:], m.ticket)
  2067. // [Psiphon]
  2068. // Set lifetime hint to a more typical value.
  2069. if obfuscateSessionTickets {
  2070. hints := []int{300, 1200, 7200, 10800, 64800, 100800, 129600}
  2071. index := prng.Intn(len(hints))
  2072. hint := hints[index]
  2073. x[4] = uint8(hint >> 24)
  2074. x[5] = uint8(hint >> 16)
  2075. x[6] = uint8(hint >> 8)
  2076. x[7] = uint8(hint)
  2077. }
  2078. return x, nil
  2079. }
  2080. func (m *newSessionTicketMsg) unmarshal(data []byte) bool {
  2081. if len(data) < 10 {
  2082. return false
  2083. }
  2084. length := uint32(data[1])<<16 | uint32(data[2])<<8 | uint32(data[3])
  2085. if uint32(len(data))-4 != length {
  2086. return false
  2087. }
  2088. ticketLen := int(data[8])<<8 + int(data[9])
  2089. if len(data)-10 != ticketLen {
  2090. return false
  2091. }
  2092. m.ticket = data[10:]
  2093. return true
  2094. }
  2095. type helloRequestMsg struct {
  2096. }
  2097. func (*helloRequestMsg) marshal() ([]byte, error) {
  2098. return []byte{typeHelloRequest, 0, 0, 0}, nil
  2099. }
  2100. func (*helloRequestMsg) unmarshal(data []byte) bool {
  2101. return len(data) == 4
  2102. }
  2103. type transcriptHash interface {
  2104. Write([]byte) (int, error)
  2105. }
  2106. // transcriptMsg is a helper used to hash messages which are not hashed when
  2107. // they are read from, or written to, the wire. This is typically the case for
  2108. // messages which are either not sent, or need to be hashed out of order from
  2109. // when they are read/written.
  2110. //
  2111. // For most messages, the message is marshalled using their marshal method,
  2112. // since their wire representation is idempotent. For clientHelloMsg and
  2113. // serverHelloMsg, we store the original wire representation of the message and
  2114. // use that for hashing, since unmarshal/marshal are not idempotent due to
  2115. // extension ordering and other malleable fields, which may cause differences
  2116. // between what was received and what we marshal.
  2117. func transcriptMsg(msg handshakeMessage, h transcriptHash) error {
  2118. if msgWithOrig, ok := msg.(handshakeMessageWithOriginalBytes); ok {
  2119. if orig := msgWithOrig.originalBytes(); orig != nil {
  2120. h.Write(msgWithOrig.originalBytes())
  2121. return nil
  2122. }
  2123. }
  2124. data, err := msg.marshal()
  2125. if err != nil {
  2126. return err
  2127. }
  2128. h.Write(data)
  2129. return nil
  2130. }