DtlsServerProtocol.cs 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  1. #if !BESTHTTP_DISABLE_ALTERNATE_SSL && (!UNITY_WEBGL || UNITY_EDITOR)
  2. #pragma warning disable
  3. using System;
  4. using System.Collections.Generic;
  5. using System.IO;
  6. using BestHTTP.SecureProtocol.Org.BouncyCastle.Tls.Crypto;
  7. using BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities;
  8. using BestHTTP.SecureProtocol.Org.BouncyCastle.Utilities.IO;
  9. namespace BestHTTP.SecureProtocol.Org.BouncyCastle.Tls
  10. {
  11. public class DtlsServerProtocol
  12. : DtlsProtocol
  13. {
  14. protected bool m_verifyRequests = true;
  15. public DtlsServerProtocol()
  16. : base()
  17. {
  18. }
  19. public virtual bool VerifyRequests
  20. {
  21. get { return m_verifyRequests; }
  22. set { this.m_verifyRequests = value; }
  23. }
  24. /// <exception cref="IOException"/>
  25. public virtual DtlsTransport Accept(TlsServer server, DatagramTransport transport)
  26. {
  27. return Accept(server, transport, null);
  28. }
  29. /// <exception cref="IOException"/>
  30. public virtual DtlsTransport Accept(TlsServer server, DatagramTransport transport, DtlsRequest request)
  31. {
  32. if (server == null)
  33. throw new ArgumentNullException("server");
  34. if (transport == null)
  35. throw new ArgumentNullException("transport");
  36. ServerHandshakeState state = new ServerHandshakeState();
  37. state.server = server;
  38. state.serverContext = new TlsServerContextImpl(server.Crypto);
  39. server.Init(state.serverContext);
  40. state.serverContext.HandshakeBeginning(server);
  41. SecurityParameters securityParameters = state.serverContext.SecurityParameters;
  42. securityParameters.m_extendedPadding = server.ShouldUseExtendedPadding();
  43. DtlsRecordLayer recordLayer = new DtlsRecordLayer(state.serverContext, state.server, transport);
  44. server.NotifyCloseHandle(recordLayer);
  45. try
  46. {
  47. return ServerHandshake(state, recordLayer, request);
  48. }
  49. catch (TlsFatalAlert fatalAlert)
  50. {
  51. AbortServerHandshake(state, recordLayer, fatalAlert.AlertDescription);
  52. throw fatalAlert;
  53. }
  54. catch (IOException e)
  55. {
  56. AbortServerHandshake(state, recordLayer, AlertDescription.internal_error);
  57. throw e;
  58. }
  59. catch (Exception e)
  60. {
  61. AbortServerHandshake(state, recordLayer, AlertDescription.internal_error);
  62. throw new TlsFatalAlert(AlertDescription.internal_error, e);
  63. }
  64. finally
  65. {
  66. securityParameters.Clear();
  67. }
  68. }
  69. internal virtual void AbortServerHandshake(ServerHandshakeState state, DtlsRecordLayer recordLayer,
  70. short alertDescription)
  71. {
  72. recordLayer.Fail(alertDescription);
  73. InvalidateSession(state);
  74. }
  75. /// <exception cref="IOException"/>
  76. internal virtual DtlsTransport ServerHandshake(ServerHandshakeState state, DtlsRecordLayer recordLayer,
  77. DtlsRequest request)
  78. {
  79. SecurityParameters securityParameters = state.serverContext.SecurityParameters;
  80. DtlsReliableHandshake handshake = new DtlsReliableHandshake(state.serverContext, recordLayer,
  81. state.server.GetHandshakeTimeoutMillis(), request);
  82. DtlsReliableHandshake.Message clientMessage = null;
  83. if (null == request)
  84. {
  85. clientMessage = handshake.ReceiveMessage();
  86. // NOTE: DtlsRecordLayer requires any DTLS version, we don't otherwise constrain this
  87. //ProtocolVersion recordLayerVersion = recordLayer.ReadVersion;
  88. if (clientMessage.Type == HandshakeType.client_hello)
  89. {
  90. ProcessClientHello(state, clientMessage.Body);
  91. }
  92. else
  93. {
  94. throw new TlsFatalAlert(AlertDescription.unexpected_message);
  95. }
  96. }
  97. else
  98. {
  99. ProcessClientHello(state, request.ClientHello);
  100. }
  101. /*
  102. * NOTE: Currently no server support for session resumption
  103. *
  104. * If adding support, ensure securityParameters.tlsUnique is set to the localVerifyData, but
  105. * ONLY when extended_master_secret has been negotiated (otherwise NULL).
  106. */
  107. {
  108. // TODO[resumption]
  109. state.tlsSession = TlsUtilities.ImportSession(TlsUtilities.EmptyBytes, null);
  110. state.sessionParameters = null;
  111. state.sessionMasterSecret = null;
  112. }
  113. securityParameters.m_sessionID = state.tlsSession.SessionID;
  114. state.server.NotifySession(state.tlsSession);
  115. {
  116. byte[] serverHelloBody = GenerateServerHello(state, recordLayer);
  117. // TODO[dtls13] Ideally, move this into GenerateServerHello once legacy_record_version clarified
  118. {
  119. ProtocolVersion recordLayerVersion = state.serverContext.ServerVersion;
  120. recordLayer.ReadVersion = recordLayerVersion;
  121. recordLayer.SetWriteVersion(recordLayerVersion);
  122. }
  123. handshake.SendMessage(HandshakeType.server_hello, serverHelloBody);
  124. }
  125. handshake.HandshakeHash.NotifyPrfDetermined();
  126. var serverSupplementalData = state.server.GetServerSupplementalData();
  127. if (serverSupplementalData != null)
  128. {
  129. byte[] supplementalDataBody = GenerateSupplementalData(serverSupplementalData);
  130. handshake.SendMessage(HandshakeType.supplemental_data, supplementalDataBody);
  131. }
  132. state.keyExchange = TlsUtilities.InitKeyExchangeServer(state.serverContext, state.server);
  133. state.serverCredentials = null;
  134. if (!KeyExchangeAlgorithm.IsAnonymous(securityParameters.KeyExchangeAlgorithm))
  135. {
  136. state.serverCredentials = TlsUtilities.EstablishServerCredentials(state.server);
  137. }
  138. // Server certificate
  139. {
  140. Certificate serverCertificate = null;
  141. MemoryStream endPointHash = new MemoryStream();
  142. if (state.serverCredentials == null)
  143. {
  144. state.keyExchange.SkipServerCredentials();
  145. }
  146. else
  147. {
  148. state.keyExchange.ProcessServerCredentials(state.serverCredentials);
  149. serverCertificate = state.serverCredentials.Certificate;
  150. SendCertificateMessage(state.serverContext, handshake, serverCertificate, endPointHash);
  151. }
  152. securityParameters.m_tlsServerEndPoint = endPointHash.ToArray();
  153. // TODO[RFC 3546] Check whether empty certificates is possible, allowed, or excludes CertificateStatus
  154. if (serverCertificate == null || serverCertificate.IsEmpty)
  155. {
  156. securityParameters.m_statusRequestVersion = 0;
  157. }
  158. }
  159. if (securityParameters.StatusRequestVersion > 0)
  160. {
  161. CertificateStatus certificateStatus = state.server.GetCertificateStatus();
  162. if (certificateStatus != null)
  163. {
  164. byte[] certificateStatusBody = GenerateCertificateStatus(state, certificateStatus);
  165. handshake.SendMessage(HandshakeType.certificate_status, certificateStatusBody);
  166. }
  167. }
  168. byte[] serverKeyExchange = state.keyExchange.GenerateServerKeyExchange();
  169. if (serverKeyExchange != null)
  170. {
  171. handshake.SendMessage(HandshakeType.server_key_exchange, serverKeyExchange);
  172. }
  173. if (state.serverCredentials != null)
  174. {
  175. state.certificateRequest = state.server.GetCertificateRequest();
  176. if (null == state.certificateRequest)
  177. {
  178. /*
  179. * For static agreement key exchanges, CertificateRequest is required since
  180. * the client Certificate message is mandatory but can only be sent if the
  181. * server requests it.
  182. */
  183. if (!state.keyExchange.RequiresCertificateVerify)
  184. throw new TlsFatalAlert(AlertDescription.internal_error);
  185. }
  186. else
  187. {
  188. if (TlsUtilities.IsTlsV12(state.serverContext)
  189. != (state.certificateRequest.SupportedSignatureAlgorithms != null))
  190. {
  191. throw new TlsFatalAlert(AlertDescription.internal_error);
  192. }
  193. state.certificateRequest = TlsUtilities.ValidateCertificateRequest(state.certificateRequest, state.keyExchange);
  194. TlsUtilities.EstablishServerSigAlgs(securityParameters, state.certificateRequest);
  195. if (ProtocolVersion.DTLSv12.Equals(securityParameters.NegotiatedVersion))
  196. {
  197. TlsUtilities.TrackHashAlgorithms(handshake.HandshakeHash, securityParameters.ServerSigAlgs);
  198. if (state.serverContext.Crypto.HasAnyStreamVerifiers(securityParameters.ServerSigAlgs))
  199. {
  200. handshake.HandshakeHash.ForceBuffering();
  201. }
  202. }
  203. else
  204. {
  205. if (state.serverContext.Crypto.HasAnyStreamVerifiersLegacy(state.certificateRequest.CertificateTypes))
  206. {
  207. handshake.HandshakeHash.ForceBuffering();
  208. }
  209. }
  210. }
  211. }
  212. handshake.HandshakeHash.SealHashAlgorithms();
  213. if (null != state.certificateRequest)
  214. {
  215. byte[] certificateRequestBody = GenerateCertificateRequest(state, state.certificateRequest);
  216. handshake.SendMessage(HandshakeType.certificate_request, certificateRequestBody);
  217. }
  218. handshake.SendMessage(HandshakeType.server_hello_done, TlsUtilities.EmptyBytes);
  219. clientMessage = handshake.ReceiveMessage();
  220. if (clientMessage.Type == HandshakeType.supplemental_data)
  221. {
  222. ProcessClientSupplementalData(state, clientMessage.Body);
  223. clientMessage = handshake.ReceiveMessage();
  224. }
  225. else
  226. {
  227. state.server.ProcessClientSupplementalData(null);
  228. }
  229. if (state.certificateRequest == null)
  230. {
  231. state.keyExchange.SkipClientCredentials();
  232. }
  233. else
  234. {
  235. if (clientMessage.Type == HandshakeType.certificate)
  236. {
  237. ProcessClientCertificate(state, clientMessage.Body);
  238. clientMessage = handshake.ReceiveMessage();
  239. }
  240. else
  241. {
  242. if (TlsUtilities.IsTlsV12(state.serverContext))
  243. {
  244. /*
  245. * RFC 5246 If no suitable certificate is available, the client MUST send a
  246. * certificate message containing no certificates.
  247. *
  248. * NOTE: In previous RFCs, this was SHOULD instead of MUST.
  249. */
  250. throw new TlsFatalAlert(AlertDescription.unexpected_message);
  251. }
  252. NotifyClientCertificate(state, Certificate.EmptyChain);
  253. }
  254. }
  255. if (clientMessage.Type == HandshakeType.client_key_exchange)
  256. {
  257. ProcessClientKeyExchange(state, clientMessage.Body);
  258. }
  259. else
  260. {
  261. throw new TlsFatalAlert(AlertDescription.unexpected_message);
  262. }
  263. securityParameters.m_sessionHash = TlsUtilities.GetCurrentPrfHash(handshake.HandshakeHash);
  264. TlsProtocol.EstablishMasterSecret(state.serverContext, state.keyExchange);
  265. recordLayer.InitPendingEpoch(TlsUtilities.InitCipher(state.serverContext));
  266. /*
  267. * RFC 5246 7.4.8 This message is only sent following a client certificate that has signing
  268. * capability (i.e., all certificates except those containing fixed Diffie-Hellman
  269. * parameters).
  270. */
  271. {
  272. if (ExpectCertificateVerifyMessage(state))
  273. {
  274. clientMessage = handshake.ReceiveMessageDelayedDigest(HandshakeType.certificate_verify);
  275. byte[] certificateVerifyBody = clientMessage.Body;
  276. ProcessCertificateVerify(state, certificateVerifyBody, handshake.HandshakeHash);
  277. handshake.PrepareToFinish();
  278. handshake.UpdateHandshakeMessagesDigest(clientMessage);
  279. }
  280. else
  281. {
  282. handshake.PrepareToFinish();
  283. }
  284. }
  285. // NOTE: Calculated exclusive of the actual Finished message from the client
  286. securityParameters.m_peerVerifyData = TlsUtilities.CalculateVerifyData(state.serverContext,
  287. handshake.HandshakeHash, false);
  288. ProcessFinished(handshake.ReceiveMessageBody(HandshakeType.finished), securityParameters.PeerVerifyData);
  289. if (state.expectSessionTicket)
  290. {
  291. /*
  292. * TODO[new_session_ticket] Check the server-side rules regarding the session ID, since the client
  293. * is going to ignore any session ID it received once it sees the new_session_ticket message.
  294. */
  295. NewSessionTicket newSessionTicket = state.server.GetNewSessionTicket();
  296. byte[] newSessionTicketBody = GenerateNewSessionTicket(state, newSessionTicket);
  297. handshake.SendMessage(HandshakeType.new_session_ticket, newSessionTicketBody);
  298. }
  299. // NOTE: Calculated exclusive of the Finished message itself
  300. securityParameters.m_localVerifyData = TlsUtilities.CalculateVerifyData(state.serverContext,
  301. handshake.HandshakeHash, true);
  302. handshake.SendMessage(HandshakeType.finished, securityParameters.LocalVerifyData);
  303. handshake.Finish();
  304. state.sessionMasterSecret = securityParameters.MasterSecret;
  305. state.sessionParameters = new SessionParameters.Builder()
  306. .SetCipherSuite(securityParameters.CipherSuite)
  307. .SetExtendedMasterSecret(securityParameters.IsExtendedMasterSecret)
  308. .SetLocalCertificate(securityParameters.LocalCertificate)
  309. .SetMasterSecret(state.serverContext.Crypto.AdoptSecret(state.sessionMasterSecret))
  310. .SetNegotiatedVersion(securityParameters.NegotiatedVersion)
  311. .SetPeerCertificate(securityParameters.PeerCertificate)
  312. .SetPskIdentity(securityParameters.PskIdentity)
  313. .SetSrpIdentity(securityParameters.SrpIdentity)
  314. // TODO Consider filtering extensions that aren't relevant to resumed sessions
  315. .SetServerExtensions(state.serverExtensions)
  316. .Build();
  317. state.tlsSession = TlsUtilities.ImportSession(state.tlsSession.SessionID, state.sessionParameters);
  318. securityParameters.m_tlsUnique = securityParameters.PeerVerifyData;
  319. state.serverContext.HandshakeComplete(state.server, state.tlsSession);
  320. recordLayer.InitHeartbeat(state.heartbeat, HeartbeatMode.peer_allowed_to_send == state.heartbeatPolicy);
  321. return new DtlsTransport(recordLayer, state.server.IgnoreCorruptDtlsRecords);
  322. }
  323. /// <exception cref="IOException"/>
  324. protected virtual byte[] GenerateCertificateRequest(ServerHandshakeState state,
  325. CertificateRequest certificateRequest)
  326. {
  327. MemoryStream buf = new MemoryStream();
  328. certificateRequest.Encode(state.serverContext, buf);
  329. return buf.ToArray();
  330. }
  331. /// <exception cref="IOException"/>
  332. protected virtual byte[] GenerateCertificateStatus(ServerHandshakeState state,
  333. CertificateStatus certificateStatus)
  334. {
  335. MemoryStream buf = new MemoryStream();
  336. // TODO[tls13] Ensure this cannot happen for (D)TLS1.3+
  337. certificateStatus.Encode(buf);
  338. return buf.ToArray();
  339. }
  340. /// <exception cref="IOException"/>
  341. protected virtual byte[] GenerateNewSessionTicket(ServerHandshakeState state,
  342. NewSessionTicket newSessionTicket)
  343. {
  344. MemoryStream buf = new MemoryStream();
  345. newSessionTicket.Encode(buf);
  346. return buf.ToArray();
  347. }
  348. /// <exception cref="IOException"/>
  349. internal virtual byte[] GenerateServerHello(ServerHandshakeState state, DtlsRecordLayer recordLayer)
  350. {
  351. TlsServerContextImpl context = state.serverContext;
  352. SecurityParameters securityParameters = context.SecurityParameters;
  353. ProtocolVersion server_version = state.server.GetServerVersion();
  354. {
  355. if (!ProtocolVersion.Contains(context.ClientSupportedVersions, server_version))
  356. throw new TlsFatalAlert(AlertDescription.internal_error);
  357. // TODO[dtls13] Read draft/RFC for guidance on the legacy_record_version field
  358. //ProtocolVersion legacy_record_version = server_version.IsLaterVersionOf(ProtocolVersion.DTLSv12)
  359. // ? ProtocolVersion.DTLSv12
  360. // : server_version;
  361. //recordLayer.SetWriteVersion(legacy_record_version);
  362. securityParameters.m_negotiatedVersion = server_version;
  363. TlsUtilities.NegotiatedVersionDtlsServer(context);
  364. }
  365. {
  366. bool useGmtUnixTime = ProtocolVersion.DTLSv12.IsEqualOrLaterVersionOf(server_version)
  367. && state.server.ShouldUseGmtUnixTime();
  368. securityParameters.m_serverRandom = TlsProtocol.CreateRandomBlock(useGmtUnixTime, context);
  369. if (!server_version.Equals(ProtocolVersion.GetLatestDtls(state.server.GetProtocolVersions())))
  370. {
  371. TlsUtilities.WriteDowngradeMarker(server_version, securityParameters.ServerRandom);
  372. }
  373. }
  374. {
  375. int cipherSuite = ValidateSelectedCipherSuite(state.server.GetSelectedCipherSuite(),
  376. AlertDescription.internal_error);
  377. if (!TlsUtilities.IsValidCipherSuiteSelection(state.offeredCipherSuites, cipherSuite) ||
  378. !TlsUtilities.IsValidVersionForCipherSuite(cipherSuite, securityParameters.NegotiatedVersion))
  379. {
  380. throw new TlsFatalAlert(AlertDescription.internal_error);
  381. }
  382. TlsUtilities.NegotiatedCipherSuite(securityParameters, cipherSuite);
  383. }
  384. state.serverExtensions = TlsExtensionsUtilities.EnsureExtensionsInitialised(
  385. state.server.GetServerExtensions());
  386. state.server.GetServerExtensionsForConnection(state.serverExtensions);
  387. ProtocolVersion legacy_version = server_version;
  388. if (server_version.IsLaterVersionOf(ProtocolVersion.DTLSv12))
  389. {
  390. legacy_version = ProtocolVersion.DTLSv12;
  391. TlsExtensionsUtilities.AddSupportedVersionsExtensionServer(state.serverExtensions, server_version);
  392. }
  393. /*
  394. * RFC 5746 3.6. Server Behavior: Initial Handshake
  395. */
  396. if (securityParameters.IsSecureRenegotiation)
  397. {
  398. byte[] renegExtData = TlsUtilities.GetExtensionData(state.serverExtensions,
  399. ExtensionType.renegotiation_info);
  400. bool noRenegExt = (null == renegExtData);
  401. if (noRenegExt)
  402. {
  403. /*
  404. * Note that sending a "renegotiation_info" extension in response to a ClientHello
  405. * containing only the SCSV is an explicit exception to the prohibition in RFC 5246,
  406. * Section 7.4.1.4, on the server sending unsolicited extensions and is only allowed
  407. * because the client is signaling its willingness to receive the extension via the
  408. * TLS_EMPTY_RENEGOTIATION_INFO_SCSV SCSV.
  409. */
  410. /*
  411. * If the secure_renegotiation flag is set to TRUE, the server MUST include an empty
  412. * "renegotiation_info" extension in the ServerHello message.
  413. */
  414. state.serverExtensions[ExtensionType.renegotiation_info] = TlsProtocol.CreateRenegotiationInfo(
  415. TlsUtilities.EmptyBytes);
  416. }
  417. }
  418. /*
  419. * RFC 7627 4. Clients and servers SHOULD NOT accept handshakes that do not use the extended
  420. * master secret [..]. (and see 5.2, 5.3)
  421. *
  422. * RFC 8446 Appendix D. Because TLS 1.3 always hashes in the transcript up to the server
  423. * Finished, implementations which support both TLS 1.3 and earlier versions SHOULD indicate
  424. * the use of the Extended Master Secret extension in their APIs whenever TLS 1.3 is used.
  425. */
  426. if (TlsUtilities.IsTlsV13(server_version))
  427. {
  428. securityParameters.m_extendedMasterSecret = true;
  429. }
  430. else
  431. {
  432. securityParameters.m_extendedMasterSecret = state.offeredExtendedMasterSecret
  433. && state.server.ShouldUseExtendedMasterSecret();
  434. if (securityParameters.IsExtendedMasterSecret)
  435. {
  436. TlsExtensionsUtilities.AddExtendedMasterSecretExtension(state.serverExtensions);
  437. }
  438. else if (state.server.RequiresExtendedMasterSecret())
  439. {
  440. throw new TlsFatalAlert(AlertDescription.handshake_failure);
  441. }
  442. else if (state.resumedSession && !state.server.AllowLegacyResumption())
  443. {
  444. throw new TlsFatalAlert(AlertDescription.internal_error);
  445. }
  446. }
  447. // Heartbeats
  448. if (null != state.heartbeat || HeartbeatMode.peer_allowed_to_send == state.heartbeatPolicy)
  449. {
  450. TlsExtensionsUtilities.AddHeartbeatExtension(state.serverExtensions,
  451. new HeartbeatExtension(state.heartbeatPolicy));
  452. }
  453. /*
  454. * RFC 7301 3.1. When session resumption or session tickets [...] are used, the previous
  455. * contents of this extension are irrelevant, and only the values in the new handshake
  456. * messages are considered.
  457. */
  458. securityParameters.m_applicationProtocol = TlsExtensionsUtilities.GetAlpnExtensionServer(
  459. state.serverExtensions);
  460. securityParameters.m_applicationProtocolSet = true;
  461. /*
  462. * TODO RFC 3546 2.3 If [...] the older session is resumed, then the server MUST ignore
  463. * extensions appearing in the client hello, and send a server hello containing no
  464. * extensions.
  465. */
  466. if (state.serverExtensions.Count > 0)
  467. {
  468. securityParameters.m_encryptThenMac = TlsExtensionsUtilities.HasEncryptThenMacExtension(
  469. state.serverExtensions);
  470. securityParameters.m_maxFragmentLength = EvaluateMaxFragmentLengthExtension(state.resumedSession,
  471. state.clientExtensions, state.serverExtensions, AlertDescription.internal_error);
  472. securityParameters.m_truncatedHmac = TlsExtensionsUtilities.HasTruncatedHmacExtension(state.serverExtensions);
  473. /*
  474. * TODO It's surprising that there's no provision to allow a 'fresh' CertificateStatus to be sent in
  475. * a session resumption handshake.
  476. */
  477. if (!state.resumedSession)
  478. {
  479. // TODO[tls13] See RFC 8446 4.4.2.1
  480. if (TlsUtilities.HasExpectedEmptyExtensionData(state.serverExtensions,
  481. ExtensionType.status_request_v2, AlertDescription.internal_error))
  482. {
  483. securityParameters.m_statusRequestVersion = 2;
  484. }
  485. else if (TlsUtilities.HasExpectedEmptyExtensionData(state.serverExtensions,
  486. ExtensionType.status_request, AlertDescription.internal_error))
  487. {
  488. securityParameters.m_statusRequestVersion = 1;
  489. }
  490. }
  491. state.expectSessionTicket = !state.resumedSession
  492. && TlsUtilities.HasExpectedEmptyExtensionData(state.serverExtensions, ExtensionType.session_ticket,
  493. AlertDescription.internal_error);
  494. }
  495. ApplyMaxFragmentLengthExtension(recordLayer, securityParameters.MaxFragmentLength);
  496. ServerHello serverHello = new ServerHello(legacy_version, securityParameters.ServerRandom,
  497. state.tlsSession.SessionID, securityParameters.CipherSuite, state.serverExtensions);
  498. MemoryStream buf = new MemoryStream();
  499. serverHello.Encode(state.serverContext, buf);
  500. return buf.ToArray();
  501. }
  502. protected virtual void InvalidateSession(ServerHandshakeState state)
  503. {
  504. if (state.sessionMasterSecret != null)
  505. {
  506. state.sessionMasterSecret.Destroy();
  507. state.sessionMasterSecret = null;
  508. }
  509. if (state.sessionParameters != null)
  510. {
  511. state.sessionParameters.Clear();
  512. state.sessionParameters = null;
  513. }
  514. if (state.tlsSession != null)
  515. {
  516. state.tlsSession.Invalidate();
  517. state.tlsSession = null;
  518. }
  519. }
  520. /// <exception cref="IOException"/>
  521. protected virtual void NotifyClientCertificate(ServerHandshakeState state, Certificate clientCertificate)
  522. {
  523. if (null == state.certificateRequest)
  524. throw new TlsFatalAlert(AlertDescription.internal_error);
  525. TlsUtilities.ProcessClientCertificate(state.serverContext, clientCertificate, state.keyExchange,
  526. state.server);
  527. }
  528. /// <exception cref="IOException"/>
  529. protected virtual void ProcessClientCertificate(ServerHandshakeState state, byte[] body)
  530. {
  531. MemoryStream buf = new MemoryStream(body, false);
  532. Certificate.ParseOptions options = new Certificate.ParseOptions()
  533. {
  534. CertificateType = TlsExtensionsUtilities.GetClientCertificateTypeExtensionServer(
  535. state.clientExtensions, CertificateType.X509),
  536. MaxChainLength = state.server.GetMaxCertificateChainLength(),
  537. };
  538. Certificate clientCertificate = Certificate.Parse(options, state.serverContext, buf, null);
  539. TlsProtocol.AssertEmpty(buf);
  540. NotifyClientCertificate(state, clientCertificate);
  541. }
  542. /// <exception cref="IOException"/>
  543. protected virtual void ProcessCertificateVerify(ServerHandshakeState state, byte[] body,
  544. TlsHandshakeHash handshakeHash)
  545. {
  546. if (state.certificateRequest == null)
  547. throw new InvalidOperationException();
  548. MemoryStream buf = new MemoryStream(body, false);
  549. TlsServerContextImpl context = state.serverContext;
  550. DigitallySigned certificateVerify = DigitallySigned.Parse(context, buf);
  551. TlsProtocol.AssertEmpty(buf);
  552. TlsUtilities.VerifyCertificateVerifyClient(context, state.certificateRequest, certificateVerify, handshakeHash);
  553. }
  554. /// <exception cref="IOException"/>
  555. protected virtual void ProcessClientHello(ServerHandshakeState state, byte[] body)
  556. {
  557. MemoryStream buf = new MemoryStream(body, false);
  558. ClientHello clientHello = ClientHello.Parse(buf, Stream.Null);
  559. ProcessClientHello(state, clientHello);
  560. }
  561. /// <exception cref="IOException"/>
  562. protected virtual void ProcessClientHello(ServerHandshakeState state, ClientHello clientHello)
  563. {
  564. // TODO Read RFCs for guidance on the expected record layer version number
  565. ProtocolVersion legacy_version = clientHello.Version;
  566. state.offeredCipherSuites = clientHello.CipherSuites;
  567. /*
  568. * TODO RFC 3546 2.3 If [...] the older session is resumed, then the server MUST ignore
  569. * extensions appearing in the client hello, and send a server hello containing no
  570. * extensions.
  571. */
  572. state.clientExtensions = clientHello.Extensions;
  573. TlsServerContextImpl context = state.serverContext;
  574. SecurityParameters securityParameters = context.SecurityParameters;
  575. if (!legacy_version.IsDtls)
  576. throw new TlsFatalAlert(AlertDescription.illegal_parameter);
  577. context.SetRsaPreMasterSecretVersion(legacy_version);
  578. context.SetClientSupportedVersions(
  579. TlsExtensionsUtilities.GetSupportedVersionsExtensionClient(state.clientExtensions));
  580. ProtocolVersion client_version = legacy_version;
  581. if (null == context.ClientSupportedVersions)
  582. {
  583. if (client_version.IsLaterVersionOf(ProtocolVersion.DTLSv12))
  584. {
  585. client_version = ProtocolVersion.DTLSv12;
  586. }
  587. context.SetClientSupportedVersions(client_version.DownTo(ProtocolVersion.DTLSv10));
  588. }
  589. else
  590. {
  591. client_version = ProtocolVersion.GetLatestDtls(context.ClientSupportedVersions);
  592. }
  593. if (!ProtocolVersion.SERVER_EARLIEST_SUPPORTED_DTLS.IsEqualOrEarlierVersionOf(client_version))
  594. throw new TlsFatalAlert(AlertDescription.protocol_version);
  595. context.SetClientVersion(client_version);
  596. state.server.NotifyClientVersion(context.ClientVersion);
  597. securityParameters.m_clientRandom = clientHello.Random;
  598. state.server.NotifyFallback(Arrays.Contains(state.offeredCipherSuites, CipherSuite.TLS_FALLBACK_SCSV));
  599. state.server.NotifyOfferedCipherSuites(state.offeredCipherSuites);
  600. /*
  601. * TODO[resumption] Check RFC 7627 5.4. for required behaviour
  602. */
  603. /*
  604. * RFC 5746 3.6. Server Behavior: Initial Handshake
  605. */
  606. {
  607. /*
  608. * RFC 5746 3.4. The client MUST include either an empty "renegotiation_info" extension,
  609. * or the TLS_EMPTY_RENEGOTIATION_INFO_SCSV signaling cipher suite value in the
  610. * ClientHello. Including both is NOT RECOMMENDED.
  611. */
  612. /*
  613. * When a ClientHello is received, the server MUST check if it includes the
  614. * TLS_EMPTY_RENEGOTIATION_INFO_SCSV SCSV. If it does, set the secure_renegotiation flag
  615. * to TRUE.
  616. */
  617. if (Arrays.Contains(state.offeredCipherSuites, CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV))
  618. {
  619. securityParameters.m_secureRenegotiation = true;
  620. }
  621. /*
  622. * The server MUST check if the "renegotiation_info" extension is included in the
  623. * ClientHello.
  624. */
  625. byte[] renegExtData = TlsUtilities.GetExtensionData(state.clientExtensions,
  626. ExtensionType.renegotiation_info);
  627. if (renegExtData != null)
  628. {
  629. /*
  630. * If the extension is present, set secure_renegotiation flag to TRUE. The
  631. * server MUST then verify that the length of the "renegotiated_connection"
  632. * field is zero, and if it is not, MUST abort the handshake.
  633. */
  634. securityParameters.m_secureRenegotiation = true;
  635. if (!Arrays.ConstantTimeAreEqual(renegExtData,
  636. TlsProtocol.CreateRenegotiationInfo(TlsUtilities.EmptyBytes)))
  637. {
  638. throw new TlsFatalAlert(AlertDescription.handshake_failure);
  639. }
  640. }
  641. }
  642. state.server.NotifySecureRenegotiation(securityParameters.IsSecureRenegotiation);
  643. state.offeredExtendedMasterSecret = TlsExtensionsUtilities.HasExtendedMasterSecretExtension(
  644. state.clientExtensions);
  645. if (state.clientExtensions != null)
  646. {
  647. // NOTE: Validates the padding extension data, if present
  648. TlsExtensionsUtilities.GetPaddingExtension(state.clientExtensions);
  649. securityParameters.m_clientServerNames = TlsExtensionsUtilities.GetServerNameExtensionClient(
  650. state.clientExtensions);
  651. /*
  652. * RFC 5246 7.4.1.4.1. Note: this extension is not meaningful for TLS versions prior
  653. * to 1.2. Clients MUST NOT offer it if they are offering prior versions.
  654. */
  655. if (TlsUtilities.IsSignatureAlgorithmsExtensionAllowed(client_version))
  656. {
  657. TlsUtilities.EstablishClientSigAlgs(securityParameters, state.clientExtensions);
  658. }
  659. securityParameters.m_clientSupportedGroups = TlsExtensionsUtilities.GetSupportedGroupsExtension(
  660. state.clientExtensions);
  661. // Heartbeats
  662. {
  663. HeartbeatExtension heartbeatExtension = TlsExtensionsUtilities.GetHeartbeatExtension(
  664. state.clientExtensions);
  665. if (null != heartbeatExtension)
  666. {
  667. if (HeartbeatMode.peer_allowed_to_send == heartbeatExtension.Mode)
  668. {
  669. state.heartbeat = state.server.GetHeartbeat();
  670. }
  671. state.heartbeatPolicy = state.server.GetHeartbeatPolicy();
  672. }
  673. }
  674. state.server.ProcessClientExtensions(state.clientExtensions);
  675. }
  676. }
  677. /// <exception cref="IOException"/>
  678. protected virtual void ProcessClientKeyExchange(ServerHandshakeState state, byte[] body)
  679. {
  680. MemoryStream buf = new MemoryStream(body, false);
  681. state.keyExchange.ProcessClientKeyExchange(buf);
  682. TlsProtocol.AssertEmpty(buf);
  683. }
  684. /// <exception cref="IOException"/>
  685. protected virtual void ProcessClientSupplementalData(ServerHandshakeState state, byte[] body)
  686. {
  687. MemoryStream buf = new MemoryStream(body, false);
  688. var clientSupplementalData = TlsProtocol.ReadSupplementalDataMessage(buf);
  689. state.server.ProcessClientSupplementalData(clientSupplementalData);
  690. }
  691. protected virtual bool ExpectCertificateVerifyMessage(ServerHandshakeState state)
  692. {
  693. if (null == state.certificateRequest)
  694. return false;
  695. Certificate clientCertificate = state.serverContext.SecurityParameters.PeerCertificate;
  696. return null != clientCertificate && !clientCertificate.IsEmpty
  697. && (null == state.keyExchange || state.keyExchange.RequiresCertificateVerify);
  698. }
  699. protected internal class ServerHandshakeState
  700. {
  701. internal TlsServer server = null;
  702. internal TlsServerContextImpl serverContext = null;
  703. internal TlsSession tlsSession = null;
  704. internal SessionParameters sessionParameters = null;
  705. internal TlsSecret sessionMasterSecret = null;
  706. internal SessionParameters.Builder sessionParametersBuilder = null;
  707. internal int[] offeredCipherSuites = null;
  708. internal IDictionary<int, byte[]> clientExtensions = null;
  709. internal IDictionary<int, byte[]> serverExtensions = null;
  710. internal bool offeredExtendedMasterSecret = false;
  711. internal bool resumedSession = false;
  712. internal bool expectSessionTicket = false;
  713. internal TlsKeyExchange keyExchange = null;
  714. internal TlsCredentials serverCredentials = null;
  715. internal CertificateRequest certificateRequest = null;
  716. internal TlsHeartbeat heartbeat = null;
  717. internal short heartbeatPolicy = HeartbeatMode.peer_not_allowed_to_send;
  718. }
  719. }
  720. }
  721. #pragma warning restore
  722. #endif