DtlsReliableHandshake.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. #if !BESTHTTP_DISABLE_ALTERNATE_SSL && (!UNITY_WEBGL || UNITY_EDITOR)
  2. #pragma warning disable
  3. using System;
  4. using System.Collections;
  5. using System.IO;
  6. using BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities;
  7. namespace BestHTTP.SecureProtocol.Org.BouncyCastle.Crypto.Tls
  8. {
  9. internal class DtlsReliableHandshake
  10. {
  11. private const int MaxReceiveAhead = 16;
  12. private const int MessageHeaderLength = 12;
  13. private readonly DtlsRecordLayer mRecordLayer;
  14. private TlsHandshakeHash mHandshakeHash;
  15. private IDictionary mCurrentInboundFlight = BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities.Platform.CreateHashtable();
  16. private IDictionary mPreviousInboundFlight = null;
  17. private IList mOutboundFlight = BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities.Platform.CreateArrayList();
  18. private bool mSending = true;
  19. private int mMessageSeq = 0, mNextReceiveSeq = 0;
  20. internal DtlsReliableHandshake(TlsContext context, DtlsRecordLayer transport)
  21. {
  22. this.mRecordLayer = transport;
  23. this.mHandshakeHash = new DeferredHash();
  24. this.mHandshakeHash.Init(context);
  25. }
  26. internal void NotifyHelloComplete()
  27. {
  28. this.mHandshakeHash = mHandshakeHash.NotifyPrfDetermined();
  29. }
  30. internal TlsHandshakeHash HandshakeHash
  31. {
  32. get { return mHandshakeHash; }
  33. }
  34. internal TlsHandshakeHash PrepareToFinish()
  35. {
  36. TlsHandshakeHash result = mHandshakeHash;
  37. this.mHandshakeHash = mHandshakeHash.StopTracking();
  38. return result;
  39. }
  40. internal void SendMessage(byte msg_type, byte[] body)
  41. {
  42. TlsUtilities.CheckUint24(body.Length);
  43. if (!mSending)
  44. {
  45. CheckInboundFlight();
  46. mSending = true;
  47. mOutboundFlight.Clear();
  48. }
  49. Message message = new Message(mMessageSeq++, msg_type, body);
  50. mOutboundFlight.Add(message);
  51. WriteMessage(message);
  52. UpdateHandshakeMessagesDigest(message);
  53. }
  54. internal byte[] ReceiveMessageBody(byte msg_type)
  55. {
  56. Message message = ReceiveMessage();
  57. if (message.Type != msg_type)
  58. throw new TlsFatalAlert(AlertDescription.unexpected_message);
  59. return message.Body;
  60. }
  61. internal Message ReceiveMessage()
  62. {
  63. if (mSending)
  64. {
  65. mSending = false;
  66. PrepareInboundFlight(BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities.Platform.CreateHashtable());
  67. }
  68. byte[] buf = null;
  69. // TODO Check the conditions under which we should reset this
  70. int readTimeoutMillis = 1000;
  71. for (;;)
  72. {
  73. try
  74. {
  75. for (;;)
  76. {
  77. Message pending = GetPendingMessage();
  78. if (pending != null)
  79. return pending;
  80. int receiveLimit = mRecordLayer.GetReceiveLimit();
  81. if (buf == null || buf.Length < receiveLimit)
  82. {
  83. buf = new byte[receiveLimit];
  84. }
  85. int received = mRecordLayer.Receive(buf, 0, receiveLimit, readTimeoutMillis);
  86. if (received < 0)
  87. break;
  88. bool resentOutbound = ProcessRecord(MaxReceiveAhead, mRecordLayer.ReadEpoch, buf, 0, received);
  89. if (resentOutbound)
  90. {
  91. readTimeoutMillis = BackOff(readTimeoutMillis);
  92. }
  93. }
  94. }
  95. catch (IOException e)
  96. {
  97. // NOTE: Assume this is a timeout for the moment
  98. }
  99. ResendOutboundFlight();
  100. readTimeoutMillis = BackOff(readTimeoutMillis);
  101. }
  102. }
  103. internal void Finish()
  104. {
  105. DtlsHandshakeRetransmit retransmit = null;
  106. if (!mSending)
  107. {
  108. CheckInboundFlight();
  109. }
  110. else
  111. {
  112. PrepareInboundFlight(null);
  113. if (mPreviousInboundFlight != null)
  114. {
  115. /*
  116. * RFC 6347 4.2.4. In addition, for at least twice the default MSL defined for [TCP],
  117. * when in the FINISHED state, the node that transmits the last flight (the server in an
  118. * ordinary handshake or the client in a resumed handshake) MUST respond to a retransmit
  119. * of the peer's last flight with a retransmit of the last flight.
  120. */
  121. retransmit = new Retransmit(this);
  122. }
  123. }
  124. mRecordLayer.HandshakeSuccessful(retransmit);
  125. }
  126. internal void ResetHandshakeMessagesDigest()
  127. {
  128. mHandshakeHash.Reset();
  129. }
  130. private int BackOff(int timeoutMillis)
  131. {
  132. /*
  133. * TODO[DTLS] implementations SHOULD back off handshake packet size during the
  134. * retransmit backoff.
  135. */
  136. return System.Math.Min(timeoutMillis * 2, 60000);
  137. }
  138. /**
  139. * Check that there are no "extra" messages left in the current inbound flight
  140. */
  141. private void CheckInboundFlight()
  142. {
  143. foreach (int key in mCurrentInboundFlight.Keys)
  144. {
  145. if (key >= mNextReceiveSeq)
  146. {
  147. // TODO Should this be considered an error?
  148. }
  149. }
  150. }
  151. private Message GetPendingMessage()
  152. {
  153. DtlsReassembler next = (DtlsReassembler)mCurrentInboundFlight[mNextReceiveSeq];
  154. if (next != null)
  155. {
  156. byte[] body = next.GetBodyIfComplete();
  157. if (body != null)
  158. {
  159. mPreviousInboundFlight = null;
  160. return UpdateHandshakeMessagesDigest(new Message(mNextReceiveSeq++, next.MsgType, body));
  161. }
  162. }
  163. return null;
  164. }
  165. private void PrepareInboundFlight(IDictionary nextFlight)
  166. {
  167. ResetAll(mCurrentInboundFlight);
  168. mPreviousInboundFlight = mCurrentInboundFlight;
  169. mCurrentInboundFlight = nextFlight;
  170. }
  171. private bool ProcessRecord(int windowSize, int epoch, byte[] buf, int off, int len)
  172. {
  173. bool checkPreviousFlight = false;
  174. while (len >= MessageHeaderLength)
  175. {
  176. int fragment_length = TlsUtilities.ReadUint24(buf, off + 9);
  177. int message_length = fragment_length + MessageHeaderLength;
  178. if (len < message_length)
  179. {
  180. // NOTE: Truncated message - ignore it
  181. break;
  182. }
  183. int length = TlsUtilities.ReadUint24(buf, off + 1);
  184. int fragment_offset = TlsUtilities.ReadUint24(buf, off + 6);
  185. if (fragment_offset + fragment_length > length)
  186. {
  187. // NOTE: Malformed fragment - ignore it and the rest of the record
  188. break;
  189. }
  190. /*
  191. * NOTE: This very simple epoch check will only work until we want to support
  192. * renegotiation (and we're not likely to do that anyway).
  193. */
  194. byte msg_type = TlsUtilities.ReadUint8(buf, off + 0);
  195. int expectedEpoch = msg_type == HandshakeType.finished ? 1 : 0;
  196. if (epoch != expectedEpoch)
  197. {
  198. break;
  199. }
  200. int message_seq = TlsUtilities.ReadUint16(buf, off + 4);
  201. if (message_seq >= (mNextReceiveSeq + windowSize))
  202. {
  203. // NOTE: Too far ahead - ignore
  204. }
  205. else if (message_seq >= mNextReceiveSeq)
  206. {
  207. DtlsReassembler reassembler = (DtlsReassembler)mCurrentInboundFlight[message_seq];
  208. if (reassembler == null)
  209. {
  210. reassembler = new DtlsReassembler(msg_type, length);
  211. mCurrentInboundFlight[message_seq] = reassembler;
  212. }
  213. reassembler.ContributeFragment(msg_type, length, buf, off + MessageHeaderLength, fragment_offset,
  214. fragment_length);
  215. }
  216. else if (mPreviousInboundFlight != null)
  217. {
  218. /*
  219. * NOTE: If we receive the previous flight of incoming messages in full again,
  220. * retransmit our last flight
  221. */
  222. DtlsReassembler reassembler = (DtlsReassembler)mPreviousInboundFlight[message_seq];
  223. if (reassembler != null)
  224. {
  225. reassembler.ContributeFragment(msg_type, length, buf, off + MessageHeaderLength, fragment_offset,
  226. fragment_length);
  227. checkPreviousFlight = true;
  228. }
  229. }
  230. off += message_length;
  231. len -= message_length;
  232. }
  233. bool result = checkPreviousFlight && CheckAll(mPreviousInboundFlight);
  234. if (result)
  235. {
  236. ResendOutboundFlight();
  237. ResetAll(mPreviousInboundFlight);
  238. }
  239. return result;
  240. }
  241. private void ResendOutboundFlight()
  242. {
  243. mRecordLayer.ResetWriteEpoch();
  244. for (int i = 0; i < mOutboundFlight.Count; ++i)
  245. {
  246. WriteMessage((Message)mOutboundFlight[i]);
  247. }
  248. }
  249. private Message UpdateHandshakeMessagesDigest(Message message)
  250. {
  251. if (message.Type != HandshakeType.hello_request)
  252. {
  253. byte[] body = message.Body;
  254. byte[] buf = new byte[MessageHeaderLength];
  255. TlsUtilities.WriteUint8(message.Type, buf, 0);
  256. TlsUtilities.WriteUint24(body.Length, buf, 1);
  257. TlsUtilities.WriteUint16(message.Seq, buf, 4);
  258. TlsUtilities.WriteUint24(0, buf, 6);
  259. TlsUtilities.WriteUint24(body.Length, buf, 9);
  260. mHandshakeHash.BlockUpdate(buf, 0, buf.Length);
  261. mHandshakeHash.BlockUpdate(body, 0, body.Length);
  262. }
  263. return message;
  264. }
  265. private void WriteMessage(Message message)
  266. {
  267. int sendLimit = mRecordLayer.GetSendLimit();
  268. int fragmentLimit = sendLimit - MessageHeaderLength;
  269. // TODO Support a higher minimum fragment size?
  270. if (fragmentLimit < 1)
  271. {
  272. // TODO Should we be throwing an exception here?
  273. throw new TlsFatalAlert(AlertDescription.internal_error);
  274. }
  275. int length = message.Body.Length;
  276. // NOTE: Must still send a fragment if body is empty
  277. int fragment_offset = 0;
  278. do
  279. {
  280. int fragment_length = System.Math.Min(length - fragment_offset, fragmentLimit);
  281. WriteHandshakeFragment(message, fragment_offset, fragment_length);
  282. fragment_offset += fragment_length;
  283. }
  284. while (fragment_offset < length);
  285. }
  286. private void WriteHandshakeFragment(Message message, int fragment_offset, int fragment_length)
  287. {
  288. RecordLayerBuffer fragment = new RecordLayerBuffer(MessageHeaderLength + fragment_length);
  289. TlsUtilities.WriteUint8(message.Type, fragment);
  290. TlsUtilities.WriteUint24(message.Body.Length, fragment);
  291. TlsUtilities.WriteUint16(message.Seq, fragment);
  292. TlsUtilities.WriteUint24(fragment_offset, fragment);
  293. TlsUtilities.WriteUint24(fragment_length, fragment);
  294. fragment.Write(message.Body, fragment_offset, fragment_length);
  295. fragment.SendToRecordLayer(mRecordLayer);
  296. }
  297. private static bool CheckAll(IDictionary inboundFlight)
  298. {
  299. foreach (DtlsReassembler r in inboundFlight.Values)
  300. {
  301. if (r.GetBodyIfComplete() == null)
  302. {
  303. return false;
  304. }
  305. }
  306. return true;
  307. }
  308. private static void ResetAll(IDictionary inboundFlight)
  309. {
  310. foreach (DtlsReassembler r in inboundFlight.Values)
  311. {
  312. r.Reset();
  313. }
  314. }
  315. internal class Message
  316. {
  317. private readonly int mMessageSeq;
  318. private readonly byte mMsgType;
  319. private readonly byte[] mBody;
  320. internal Message(int message_seq, byte msg_type, byte[] body)
  321. {
  322. this.mMessageSeq = message_seq;
  323. this.mMsgType = msg_type;
  324. this.mBody = body;
  325. }
  326. public int Seq
  327. {
  328. get { return mMessageSeq; }
  329. }
  330. public byte Type
  331. {
  332. get { return mMsgType; }
  333. }
  334. public byte[] Body
  335. {
  336. get { return mBody; }
  337. }
  338. }
  339. internal class RecordLayerBuffer
  340. : MemoryStream
  341. {
  342. internal RecordLayerBuffer(int size)
  343. : base(size)
  344. {
  345. }
  346. internal void SendToRecordLayer(DtlsRecordLayer recordLayer)
  347. {
  348. #if PORTABLE || NETFX_CORE
  349. byte[] buf = ToArray();
  350. int bufLen = buf.Length;
  351. #else
  352. byte[] buf = GetBuffer();
  353. int bufLen = (int)Length;
  354. #endif
  355. recordLayer.Send(buf, 0, bufLen);
  356. BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities.Platform.Dispose(this);
  357. }
  358. }
  359. internal class Retransmit
  360. : DtlsHandshakeRetransmit
  361. {
  362. private readonly DtlsReliableHandshake mOuter;
  363. internal Retransmit(DtlsReliableHandshake outer)
  364. {
  365. this.mOuter = outer;
  366. }
  367. public void ReceivedHandshakeRecord(int epoch, byte[] buf, int off, int len)
  368. {
  369. mOuter.ProcessRecord(0, epoch, buf, off, len);
  370. }
  371. }
  372. }
  373. }
  374. #pragma warning restore
  375. #endif