using System;
using System.Collections.Generic;
using System.IO;
using Org.BouncyCastle.Tls.Crypto;
using Org.BouncyCastle.Utilities;
namespace Org.BouncyCastle.Tls
{
public class DtlsClientProtocol
: DtlsProtocol
{
public DtlsClientProtocol()
: base()
{
}
///
public virtual DtlsTransport Connect(TlsClient client, DatagramTransport transport)
{
if (client == null)
throw new ArgumentNullException("client");
if (transport == null)
throw new ArgumentNullException("transport");
TlsClientContextImpl clientContext = new TlsClientContextImpl(client.Crypto);
ClientHandshakeState state = new ClientHandshakeState();
state.client = client;
state.clientContext = clientContext;
client.Init(clientContext);
clientContext.HandshakeBeginning(client);
SecurityParameters securityParameters = clientContext.SecurityParameters;
securityParameters.m_extendedPadding = client.ShouldUseExtendedPadding();
DtlsRecordLayer recordLayer = new DtlsRecordLayer(clientContext, client, transport);
client.NotifyCloseHandle(recordLayer);
try
{
return ClientHandshake(state, recordLayer);
}
catch (TlsFatalAlert fatalAlert)
{
AbortClientHandshake(state, recordLayer, fatalAlert.AlertDescription);
throw;
}
catch (IOException)
{
AbortClientHandshake(state, recordLayer, AlertDescription.internal_error);
throw;
}
catch (Exception e)
{
AbortClientHandshake(state, recordLayer, AlertDescription.internal_error);
throw new TlsFatalAlert(AlertDescription.internal_error, e);
}
finally
{
securityParameters.Clear();
}
}
internal virtual void AbortClientHandshake(ClientHandshakeState state, DtlsRecordLayer recordLayer,
short alertDescription)
{
recordLayer.Fail(alertDescription);
InvalidateSession(state);
}
///
internal virtual DtlsTransport ClientHandshake(ClientHandshakeState state, DtlsRecordLayer recordLayer)
{
TlsClient client = state.client;
TlsClientContextImpl clientContext = state.clientContext;
SecurityParameters securityParameters = clientContext.SecurityParameters;
DtlsReliableHandshake handshake = new DtlsReliableHandshake(clientContext, recordLayer,
client.GetHandshakeTimeoutMillis(), TlsUtilities.GetHandshakeResendTimeMillis(client), null);
byte[] clientHelloBody = GenerateClientHello(state);
recordLayer.SetWriteVersion(ProtocolVersion.DTLSv10);
handshake.SendMessage(HandshakeType.client_hello, clientHelloBody);
DtlsReliableHandshake.Message serverMessage = handshake.ReceiveMessage();
// TODO Consider stricter HelloVerifyRequest protocol
//if (serverMessage.Type == HandshakeType.hello_verify_request)
while (serverMessage.Type == HandshakeType.hello_verify_request)
{
byte[] cookie = ProcessHelloVerifyRequest(state, serverMessage.Body);
byte[] patched = PatchClientHelloWithCookie(clientHelloBody, cookie);
handshake.ResetAfterHelloVerifyRequestClient();
handshake.SendMessage(HandshakeType.client_hello, patched);
serverMessage = handshake.ReceiveMessage();
}
if (serverMessage.Type == HandshakeType.server_hello)
{
ProtocolVersion recordLayerVersion = recordLayer.ReadVersion;
ReportServerVersion(state, recordLayerVersion);
recordLayer.SetWriteVersion(recordLayerVersion);
ProcessServerHello(state, serverMessage.Body);
ApplyMaxFragmentLengthExtension(recordLayer, securityParameters.MaxFragmentLength);
}
else
{
throw new TlsFatalAlert(AlertDescription.unexpected_message);
}
handshake.HandshakeHash.NotifyPrfDetermined();
if (securityParameters.IsResumedSession)
{
securityParameters.m_masterSecret = state.sessionMasterSecret;
recordLayer.InitPendingEpoch(TlsUtilities.InitCipher(clientContext));
// NOTE: Calculated exclusive of the actual Finished message from the server
securityParameters.m_peerVerifyData = TlsUtilities.CalculateVerifyData(clientContext,
handshake.HandshakeHash, true);
ProcessFinished(handshake.ReceiveMessageBody(HandshakeType.finished),
securityParameters.PeerVerifyData);
// NOTE: Calculated exclusive of the Finished message itself
securityParameters.m_localVerifyData = TlsUtilities.CalculateVerifyData(clientContext,
handshake.HandshakeHash, false);
handshake.SendMessage(HandshakeType.finished, securityParameters.LocalVerifyData);
handshake.Finish();
if (securityParameters.IsExtendedMasterSecret)
{
securityParameters.m_tlsUnique = securityParameters.PeerVerifyData;
}
securityParameters.m_localCertificate = state.sessionParameters.LocalCertificate;
securityParameters.m_peerCertificate = state.sessionParameters.PeerCertificate;
securityParameters.m_pskIdentity = state.sessionParameters.PskIdentity;
securityParameters.m_srpIdentity = state.sessionParameters.SrpIdentity;
clientContext.HandshakeComplete(client, state.tlsSession);
recordLayer.InitHeartbeat(state.heartbeat, HeartbeatMode.peer_allowed_to_send == state.heartbeatPolicy);
return new DtlsTransport(recordLayer, client.IgnoreCorruptDtlsRecords);
}
InvalidateSession(state);
state.tlsSession = TlsUtilities.ImportSession(securityParameters.SessionID, null);
serverMessage = handshake.ReceiveMessage();
if (serverMessage.Type == HandshakeType.supplemental_data)
{
ProcessServerSupplementalData(state, serverMessage.Body);
serverMessage = handshake.ReceiveMessage();
}
else
{
client.ProcessServerSupplementalData(null);
}
state.keyExchange = TlsUtilities.InitKeyExchangeClient(clientContext, client);
if (serverMessage.Type == HandshakeType.certificate)
{
ProcessServerCertificate(state, serverMessage.Body);
serverMessage = handshake.ReceiveMessage();
}
else
{
// Okay, Certificate is optional
state.authentication = null;
}
if (serverMessage.Type == HandshakeType.certificate_status)
{
if (securityParameters.StatusRequestVersion < 1)
throw new TlsFatalAlert(AlertDescription.unexpected_message);
ProcessCertificateStatus(state, serverMessage.Body);
serverMessage = handshake.ReceiveMessage();
}
else
{
// Okay, CertificateStatus is optional
}
TlsUtilities.ProcessServerCertificate(clientContext, state.certificateStatus, state.keyExchange,
state.authentication, state.clientExtensions, state.serverExtensions);
if (serverMessage.Type == HandshakeType.server_key_exchange)
{
ProcessServerKeyExchange(state, serverMessage.Body);
serverMessage = handshake.ReceiveMessage();
}
else
{
// Okay, ServerKeyExchange is optional
state.keyExchange.SkipServerKeyExchange();
}
if (serverMessage.Type == HandshakeType.certificate_request)
{
ProcessCertificateRequest(state, serverMessage.Body);
TlsUtilities.EstablishServerSigAlgs(securityParameters, state.certificateRequest);
serverMessage = handshake.ReceiveMessage();
}
else
{
// Okay, CertificateRequest is optional
}
if (serverMessage.Type == HandshakeType.server_hello_done)
{
if (serverMessage.Body.Length != 0)
{
throw new TlsFatalAlert(AlertDescription.decode_error);
}
}
else
{
throw new TlsFatalAlert(AlertDescription.unexpected_message);
}
TlsCredentials clientAuthCredentials = null;
TlsCredentialedSigner clientAuthSigner = null;
Certificate clientAuthCertificate = null;
SignatureAndHashAlgorithm clientAuthAlgorithm = null;
TlsStreamSigner clientAuthStreamSigner = null;
if (state.certificateRequest != null)
{
clientAuthCredentials = TlsUtilities.EstablishClientCredentials(state.authentication,
state.certificateRequest);
if (clientAuthCredentials != null)
{
clientAuthCertificate = clientAuthCredentials.Certificate;
if (clientAuthCredentials is TlsCredentialedSigner)
{
clientAuthSigner = (TlsCredentialedSigner)clientAuthCredentials;
clientAuthAlgorithm = TlsUtilities.GetSignatureAndHashAlgorithm(
securityParameters.NegotiatedVersion, clientAuthSigner);
clientAuthStreamSigner = clientAuthSigner.GetStreamSigner();
if (ProtocolVersion.DTLSv12.Equals(securityParameters.NegotiatedVersion))
{
TlsUtilities.VerifySupportedSignatureAlgorithm(securityParameters.ServerSigAlgs,
clientAuthAlgorithm, AlertDescription.internal_error);
if (clientAuthStreamSigner == null)
{
TlsUtilities.TrackHashAlgorithmClient(handshake.HandshakeHash, clientAuthAlgorithm);
}
}
if (clientAuthStreamSigner != null)
{
handshake.HandshakeHash.ForceBuffering();
}
}
}
}
handshake.HandshakeHash.SealHashAlgorithms();
if (clientAuthCredentials == null)
{
state.keyExchange.SkipClientCredentials();
}
else
{
state.keyExchange.ProcessClientCredentials(clientAuthCredentials);
}
var clientSupplementalData = client.GetClientSupplementalData();
if (clientSupplementalData != null)
{
byte[] supplementalDataBody = GenerateSupplementalData(clientSupplementalData);
handshake.SendMessage(HandshakeType.supplemental_data, supplementalDataBody);
}
if (null != state.certificateRequest)
{
SendCertificateMessage(clientContext, handshake, clientAuthCertificate, null);
}
byte[] clientKeyExchangeBody = GenerateClientKeyExchange(state);
handshake.SendMessage(HandshakeType.client_key_exchange, clientKeyExchangeBody);
securityParameters.m_sessionHash = TlsUtilities.GetCurrentPrfHash(handshake.HandshakeHash);
TlsProtocol.EstablishMasterSecret(clientContext, state.keyExchange);
recordLayer.InitPendingEpoch(TlsUtilities.InitCipher(clientContext));
if (clientAuthSigner != null)
{
DigitallySigned certificateVerify = TlsUtilities.GenerateCertificateVerifyClient(clientContext,
clientAuthSigner, clientAuthAlgorithm, clientAuthStreamSigner, handshake.HandshakeHash);
byte[] certificateVerifyBody = GenerateCertificateVerify(state, certificateVerify);
handshake.SendMessage(HandshakeType.certificate_verify, certificateVerifyBody);
}
handshake.PrepareToFinish();
securityParameters.m_localVerifyData = TlsUtilities.CalculateVerifyData(clientContext,
handshake.HandshakeHash, false);
handshake.SendMessage(HandshakeType.finished, securityParameters.LocalVerifyData);
if (state.expectSessionTicket)
{
serverMessage = handshake.ReceiveMessage();
if (serverMessage.Type == HandshakeType.new_session_ticket)
{
/*
* RFC 5077 3.4. If the client receives a session ticket from the server, then it
* discards any Session ID that was sent in the ServerHello.
*/
securityParameters.m_sessionID = TlsUtilities.EmptyBytes;
InvalidateSession(state);
state.tlsSession = TlsUtilities.ImportSession(securityParameters.SessionID, null);
ProcessNewSessionTicket(state, serverMessage.Body);
}
else
{
throw new TlsFatalAlert(AlertDescription.unexpected_message);
}
}
// NOTE: Calculated exclusive of the actual Finished message from the server
securityParameters.m_peerVerifyData = TlsUtilities.CalculateVerifyData(clientContext,
handshake.HandshakeHash, true);
ProcessFinished(handshake.ReceiveMessageBody(HandshakeType.finished), securityParameters.PeerVerifyData);
handshake.Finish();
state.sessionMasterSecret = securityParameters.MasterSecret;
state.sessionParameters = new SessionParameters.Builder()
.SetCipherSuite(securityParameters.CipherSuite)
.SetExtendedMasterSecret(securityParameters.IsExtendedMasterSecret)
.SetLocalCertificate(securityParameters.LocalCertificate)
.SetMasterSecret(clientContext.Crypto.AdoptSecret(state.sessionMasterSecret))
.SetNegotiatedVersion(securityParameters.NegotiatedVersion)
.SetPeerCertificate(securityParameters.PeerCertificate)
.SetPskIdentity(securityParameters.PskIdentity)
.SetSrpIdentity(securityParameters.SrpIdentity)
// TODO Consider filtering extensions that aren't relevant to resumed sessions
.SetServerExtensions(state.serverExtensions)
.Build();
state.tlsSession = TlsUtilities.ImportSession(securityParameters.SessionID, state.sessionParameters);
securityParameters.m_tlsUnique = securityParameters.LocalVerifyData;
clientContext.HandshakeComplete(client, state.tlsSession);
recordLayer.InitHeartbeat(state.heartbeat, HeartbeatMode.peer_allowed_to_send == state.heartbeatPolicy);
return new DtlsTransport(recordLayer, client.IgnoreCorruptDtlsRecords);
}
///
protected virtual byte[] GenerateCertificateVerify(ClientHandshakeState state,
DigitallySigned certificateVerify)
{
MemoryStream buf = new MemoryStream();
certificateVerify.Encode(buf);
return buf.ToArray();
}
///
protected virtual byte[] GenerateClientHello(ClientHandshakeState state)
{
TlsClient client = state.client;
TlsClientContextImpl clientContext = state.clientContext;
SecurityParameters securityParameters = clientContext.SecurityParameters;
ProtocolVersion[] supportedVersions = client.GetProtocolVersions();
ProtocolVersion earliestVersion = ProtocolVersion.GetEarliestDtls(supportedVersions);
ProtocolVersion latestVersion = ProtocolVersion.GetLatestDtls(supportedVersions);
if (!ProtocolVersion.IsSupportedDtlsVersionClient(latestVersion))
throw new TlsFatalAlert(AlertDescription.internal_error);
clientContext.SetClientVersion(latestVersion);
clientContext.SetClientSupportedVersions(supportedVersions);
bool offeringDtlsV12Minus = ProtocolVersion.DTLSv12.IsEqualOrLaterVersionOf(earliestVersion);
bool offeringDtlsV13Plus = ProtocolVersion.DTLSv13.IsEqualOrEarlierVersionOf(latestVersion);
{
bool useGmtUnixTime = !offeringDtlsV13Plus && client.ShouldUseGmtUnixTime();
securityParameters.m_clientRandom = TlsProtocol.CreateRandomBlock(useGmtUnixTime, clientContext);
}
TlsSession sessionToResume = offeringDtlsV12Minus ? client.GetSessionToResume() : null;
bool fallback = client.IsFallback();
state.offeredCipherSuites = client.GetCipherSuites();
state.clientExtensions = TlsExtensionsUtilities.EnsureExtensionsInitialised(client.GetClientExtensions());
bool shouldUseEms = client.ShouldUseExtendedMasterSecret();
EstablishSession(state, sessionToResume);
byte[] legacy_session_id = TlsUtilities.GetSessionID(state.tlsSession);
if (legacy_session_id.Length > 0)
{
if (!Arrays.Contains(state.offeredCipherSuites, state.sessionParameters.CipherSuite))
{
legacy_session_id = TlsUtilities.EmptyBytes;
}
}
ProtocolVersion sessionVersion = null;
if (legacy_session_id.Length > 0)
{
sessionVersion = state.sessionParameters.NegotiatedVersion;
if (!ProtocolVersion.Contains(supportedVersions, sessionVersion))
{
legacy_session_id = TlsUtilities.EmptyBytes;
}
}
if (legacy_session_id.Length > 0 && TlsUtilities.IsExtendedMasterSecretOptional(sessionVersion))
{
if (shouldUseEms)
{
if (!state.sessionParameters.IsExtendedMasterSecret &&
!client.AllowLegacyResumption())
{
legacy_session_id = TlsUtilities.EmptyBytes;
}
}
else
{
if (state.sessionParameters.IsExtendedMasterSecret)
{
legacy_session_id = TlsUtilities.EmptyBytes;
}
}
}
if (legacy_session_id.Length < 1)
{
CancelSession(state);
}
client.NotifySessionToResume(state.tlsSession);
ProtocolVersion legacy_version = latestVersion;
if (offeringDtlsV13Plus)
{
legacy_version = ProtocolVersion.DTLSv12;
TlsExtensionsUtilities.AddSupportedVersionsExtensionClient(state.clientExtensions, supportedVersions);
/*
* RFC 9147 5. DTLS implementations do not use the TLS 1.3 "compatibility mode" [..].
*/
}
clientContext.SetRsaPreMasterSecretVersion(legacy_version);
securityParameters.m_clientServerNames = TlsExtensionsUtilities.GetServerNameExtensionClient(
state.clientExtensions);
if (TlsUtilities.IsSignatureAlgorithmsExtensionAllowed(latestVersion))
{
TlsUtilities.EstablishClientSigAlgs(securityParameters, state.clientExtensions);
}
securityParameters.m_clientSupportedGroups = TlsExtensionsUtilities.GetSupportedGroupsExtension(
state.clientExtensions);
// TODO[dtls13]
//state.clientBinders = TlsUtilities.AddPreSharedKeyToClientHello(clientContext, client,
// state.clientExtensions, state.offeredCipherSuites);
state.clientBinders = null;
// TODO[tls13-psk] Perhaps don't add key_share if external PSK(s) offered and 'psk_dhe_ke' not offered
state.clientAgreements = TlsUtilities.AddKeyShareToClientHello(clientContext, client,
state.clientExtensions);
if (shouldUseEms && TlsUtilities.IsExtendedMasterSecretOptional(supportedVersions))
{
TlsExtensionsUtilities.AddExtendedMasterSecretExtension(state.clientExtensions);
}
else
{
state.clientExtensions.Remove(ExtensionType.extended_master_secret);
}
// Cipher Suites (and SCSV)
{
/*
* RFC 5746 3.4. The client MUST include either an empty "renegotiation_info" extension,
* or the TLS_EMPTY_RENEGOTIATION_INFO_SCSV signaling cipher suite value in the
* ClientHello. Including both is NOT RECOMMENDED.
*/
bool noRenegExt = (null == TlsUtilities.GetExtensionData(state.clientExtensions,
ExtensionType.renegotiation_info));
bool noRenegScsv = !Arrays.Contains(state.offeredCipherSuites,
CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV);
if (noRenegExt && noRenegScsv)
{
state.offeredCipherSuites = Arrays.Append(state.offeredCipherSuites,
CipherSuite.TLS_EMPTY_RENEGOTIATION_INFO_SCSV);
}
}
/* (Fallback SCSV)
* RFC 7507 4. If a client sends a ClientHello.client_version containing a lower value
* than the latest (highest-valued) version supported by the client, it SHOULD include
* the TLS_FALLBACK_SCSV cipher suite value in ClientHello.cipher_suites [..]. (The
* client SHOULD put TLS_FALLBACK_SCSV after all cipher suites that it actually intends
* to negotiate.)
*/
if (fallback && !Arrays.Contains(state.offeredCipherSuites, CipherSuite.TLS_FALLBACK_SCSV))
{
state.offeredCipherSuites = Arrays.Append(state.offeredCipherSuites, CipherSuite.TLS_FALLBACK_SCSV);
}
// Heartbeats
{
state.heartbeat = client.GetHeartbeat();
state.heartbeatPolicy = client.GetHeartbeatPolicy();
if (null != state.heartbeat || HeartbeatMode.peer_allowed_to_send == state.heartbeatPolicy)
{
TlsExtensionsUtilities.AddHeartbeatExtension(state.clientExtensions,
new HeartbeatExtension(state.heartbeatPolicy));
}
}
int bindersSize = null == state.clientBinders ? 0 : state.clientBinders.m_bindersSize;
ClientHello clientHello = new ClientHello(legacy_version, securityParameters.ClientRandom,
legacy_session_id, cookie: TlsUtilities.EmptyBytes, state.offeredCipherSuites, state.clientExtensions,
bindersSize);
/*
* TODO[dtls13] See TlsClientProtocol.SendClientHelloMessage for how to prepare/encode binders and also
* consider the impact of binders on cookie patching after HelloVerifyRequest.
*/
MemoryStream buf = new MemoryStream();
clientHello.Encode(clientContext, buf);
return buf.ToArray();
}
///
protected virtual byte[] GenerateClientKeyExchange(ClientHandshakeState state)
{
MemoryStream buf = new MemoryStream();
state.keyExchange.GenerateClientKeyExchange(buf);
return buf.ToArray();
}
protected virtual void CancelSession(ClientHandshakeState state)
{
if (state.sessionMasterSecret != null)
{
state.sessionMasterSecret.Destroy();
state.sessionMasterSecret = null;
}
if (state.sessionParameters != null)
{
state.sessionParameters.Clear();
state.sessionParameters = null;
}
state.tlsSession = null;
}
protected virtual bool EstablishSession(ClientHandshakeState state, TlsSession sessionToResume)
{
state.tlsSession = null;
state.sessionParameters = null;
state.sessionMasterSecret = null;
if (null == sessionToResume || !sessionToResume.IsResumable)
return false;
SessionParameters sessionParameters = sessionToResume.ExportSessionParameters();
if (null == sessionParameters)
return false;
ProtocolVersion sessionVersion = sessionParameters.NegotiatedVersion;
if (null == sessionVersion || !sessionVersion.IsDtls)
return false;
bool isEms = sessionParameters.IsExtendedMasterSecret;
if (!TlsUtilities.IsExtendedMasterSecretOptional(sessionVersion))
{
if (!isEms)
return false;
}
TlsCrypto crypto = state.clientContext.Crypto;
TlsSecret sessionMasterSecret = TlsUtilities.GetSessionMasterSecret(crypto, sessionParameters.MasterSecret);
if (null == sessionMasterSecret)
return false;
state.tlsSession = sessionToResume;
state.sessionParameters = sessionParameters;
state.sessionMasterSecret = sessionMasterSecret;
return true;
}
protected virtual void InvalidateSession(ClientHandshakeState state)
{
if (state.tlsSession != null)
{
state.tlsSession.Invalidate();
}
CancelSession(state);
}
///
protected virtual void ProcessCertificateRequest(ClientHandshakeState state, byte[] body)
{
if (null == state.authentication)
{
/*
* RFC 2246 7.4.4. It is a fatal handshake_failure alert for an anonymous server to
* request client identification.
*/
throw new TlsFatalAlert(AlertDescription.handshake_failure);
}
MemoryStream buf = new MemoryStream(body, false);
CertificateRequest certificateRequest = CertificateRequest.Parse(state.clientContext, buf);
TlsProtocol.AssertEmpty(buf);
state.certificateRequest = TlsUtilities.ValidateCertificateRequest(certificateRequest, state.keyExchange);
}
///
protected virtual void ProcessCertificateStatus(ClientHandshakeState state, byte[] body)
{
MemoryStream buf = new MemoryStream(body, false);
// TODO[tls13] Ensure this cannot happen for (D)TLS1.3+
state.certificateStatus = CertificateStatus.Parse(state.clientContext, buf);
TlsProtocol.AssertEmpty(buf);
}
///
protected virtual byte[] ProcessHelloVerifyRequest(ClientHandshakeState state, byte[] body)
{
MemoryStream buf = new MemoryStream(body, false);
ProtocolVersion server_version = TlsUtilities.ReadVersion(buf);
/*
* RFC 6347 This specification increases the cookie size limit to 255 bytes for greater
* future flexibility. The limit remains 32 for previous versions of DTLS.
*/
int maxCookieLength = ProtocolVersion.DTLSv12.IsEqualOrEarlierVersionOf(server_version) ? 255 : 32;
byte[] cookie = TlsUtilities.ReadOpaque8(buf, 0, maxCookieLength);
TlsProtocol.AssertEmpty(buf);
// TODO Seems this behaviour is not yet in line with OpenSSL for DTLS 1.2
//ReportServerVersion(state, server_version);
if (!server_version.IsEqualOrEarlierVersionOf(state.clientContext.ClientVersion))
throw new TlsFatalAlert(AlertDescription.illegal_parameter);
return cookie;
}
///
protected virtual void ProcessNewSessionTicket(ClientHandshakeState state, byte[] body)
{
MemoryStream buf = new MemoryStream(body, false);
NewSessionTicket newSessionTicket = NewSessionTicket.Parse(buf);
TlsProtocol.AssertEmpty(buf);
state.client.NotifyNewSessionTicket(newSessionTicket);
}
///
protected virtual void ProcessServerCertificate(ClientHandshakeState state, byte[] body)
{
state.authentication = TlsUtilities.ReceiveServerCertificate(state.clientContext, state.client,
new MemoryStream(body, false), state.serverExtensions);
}
///
protected virtual void ProcessServerHello(ClientHandshakeState state, byte[] body)
{
TlsClient client = state.client;
TlsClientContextImpl clientContext = state.clientContext;
SecurityParameters securityParameters = clientContext.SecurityParameters;
MemoryStream buf = new MemoryStream(body, false);
ServerHello serverHello = ServerHello.Parse(buf);
var serverHelloExtensions = serverHello.Extensions;
ProtocolVersion legacy_version = serverHello.Version;
ProtocolVersion supported_version = TlsExtensionsUtilities.GetSupportedVersionsExtensionServer(
serverHelloExtensions);
ProtocolVersion server_version;
if (null == supported_version)
{
server_version = legacy_version;
}
else
{
if (!ProtocolVersion.DTLSv12.Equals(legacy_version) ||
!ProtocolVersion.DTLSv13.IsEqualOrEarlierVersionOf(supported_version))
{
throw new TlsFatalAlert(AlertDescription.illegal_parameter);
}
server_version = supported_version;
}
// NOT renegotiating
{
ReportServerVersion(state, server_version);
}
// NOTE: This is integrated into ReportServerVersion call above
//TlsUtilities.NegotiatedVersionDtlsClient(clientContext, state.client);
// TODO[dtls13]
//if (ProtocolVersion.DTLSv13.IsEqualOrEarlierVersionOf(server_version))
//{
// Process13ServerHello(serverHello, false);
// return;
//}
int[] offeredCipherSuites = state.offeredCipherSuites;
// TODO[dtls13]
//state.clientHello = null;
//state.retryCookie = null;
//state.retryGroup = -1;
securityParameters.m_serverRandom = serverHello.Random;
if (!clientContext.ClientVersion.Equals(server_version))
{
TlsUtilities.CheckDowngradeMarker(server_version, securityParameters.ServerRandom);
}
{
byte[] selectedSessionID = serverHello.SessionID;
securityParameters.m_sessionID = selectedSessionID;
client.NotifySessionID(selectedSessionID);
securityParameters.m_resumedSession = selectedSessionID.Length > 0 && state.tlsSession != null
&& Arrays.AreEqual(selectedSessionID, state.tlsSession.SessionID);
if (securityParameters.IsResumedSession)
{
if (serverHello.CipherSuite != state.sessionParameters.CipherSuite ||
!securityParameters.NegotiatedVersion.Equals(state.sessionParameters.NegotiatedVersion))
{
throw new TlsFatalAlert(AlertDescription.illegal_parameter,
"ServerHello parameters do not match resumed session");
}
}
}
/*
* Find out which CipherSuite the server has chosen and check that it was one of the offered
* ones, and is a valid selection for the negotiated version.
*/
{
int cipherSuite = ValidateSelectedCipherSuite(serverHello.CipherSuite,
AlertDescription.illegal_parameter);
if (!TlsUtilities.IsValidCipherSuiteSelection(offeredCipherSuites, cipherSuite) ||
!TlsUtilities.IsValidVersionForCipherSuite(cipherSuite, securityParameters.NegotiatedVersion))
{
throw new TlsFatalAlert(AlertDescription.illegal_parameter,
"ServerHello selected invalid cipher suite");
}
TlsUtilities.NegotiatedCipherSuite(securityParameters, cipherSuite);
client.NotifySelectedCipherSuite(cipherSuite);
}
/*
*
* RFC 3546 2.2 Note that the extended server hello message is only sent in response to an
* extended client hello message. However, see RFC 5746 exception below. We always include
* the SCSV, so an Extended Server Hello is always allowed.
*/
state.serverExtensions = serverHelloExtensions;
if (serverHelloExtensions != null)
{
foreach (int extType in serverHelloExtensions.Keys)
{
/*
* RFC 5746 3.6. Note that sending a "renegotiation_info" extension in response to a
* ClientHello containing only the SCSV is an explicit exception to the prohibition
* in RFC 5246, Section 7.4.1.4, on the server sending unsolicited extensions and is
* only allowed because the client is signaling its willingness to receive the
* extension via the TLS_EMPTY_RENEGOTIATION_INFO_SCSV SCSV.
*/
if (extType == ExtensionType.renegotiation_info)
continue;
/*
* RFC 5246 7.4.1.4 An extension type MUST NOT appear in the ServerHello unless the
* same extension type appeared in the corresponding ClientHello. If a client
* receives an extension type in ServerHello that it did not request in the
* associated ClientHello, it MUST abort the handshake with an unsupported_extension
* fatal alert.
*/
if (null == TlsUtilities.GetExtensionData(state.clientExtensions, extType))
throw new TlsFatalAlert(AlertDescription.unsupported_extension);
/*
* RFC 3546 2.3. If [...] the older session is resumed, then the server MUST ignore
* extensions appearing in the client hello, and send a server hello containing no
* extensions[.]
*/
if (securityParameters.IsResumedSession)
{
// TODO[compat-gnutls] GnuTLS test server sends server extensions e.g. ec_point_formats
// TODO[compat-openssl] OpenSSL test server sends server extensions e.g. ec_point_formats
// TODO[compat-polarssl] PolarSSL test server sends server extensions e.g. ec_point_formats
//throw new TlsFatalAlert(AlertDescription.illegal_parameter);
}
}
}
byte[] renegExtData = TlsUtilities.GetExtensionData(serverHelloExtensions,
ExtensionType.renegotiation_info);
// NOT renegotiating
{
/*
* RFC 5746 3.4. Client Behavior: Initial Handshake (both full and session-resumption)
*/
/*
* When a ServerHello is received, the client MUST check if it includes the
* "renegotiation_info" extension:
*/
if (renegExtData == null)
{
/*
* If the extension is not present, the server does not support secure
* renegotiation; set secure_renegotiation flag to FALSE. In this case, some clients
* may want to terminate the handshake instead of continuing; see Section 4.1 for
* discussion.
*/
securityParameters.m_secureRenegotiation = false;
}
else
{
/*
* If the extension is present, set the secure_renegotiation flag to TRUE. The
* client MUST then verify that the length of the "renegotiated_connection"
* field is zero, and if it is not, MUST abort the handshake (by sending a fatal
* handshake_failure alert).
*/
securityParameters.m_secureRenegotiation = true;
if (!Arrays.FixedTimeEquals(renegExtData,
TlsProtocol.CreateRenegotiationInfo(TlsUtilities.EmptyBytes)))
{
throw new TlsFatalAlert(AlertDescription.handshake_failure);
}
}
}
// TODO[compat-gnutls] GnuTLS test server fails to send renegotiation_info extension when resuming
client.NotifySecureRenegotiation(securityParameters.IsSecureRenegotiation);
// extended_master_secret
{
bool negotiatedEms = false;
if (TlsExtensionsUtilities.HasExtendedMasterSecretExtension(state.clientExtensions))
{
negotiatedEms = TlsExtensionsUtilities.HasExtendedMasterSecretExtension(serverHelloExtensions);
if (TlsUtilities.IsExtendedMasterSecretOptional(server_version))
{
if (!negotiatedEms &&
client.RequiresExtendedMasterSecret())
{
throw new TlsFatalAlert(AlertDescription.handshake_failure,
"Extended Master Secret extension is required");
}
}
else
{
if (negotiatedEms)
{
throw new TlsFatalAlert(AlertDescription.illegal_parameter,
"Server sent an unexpected extended_master_secret extension negotiating " + server_version);
}
}
}
securityParameters.m_extendedMasterSecret = negotiatedEms;
}
if (securityParameters.IsResumedSession &&
securityParameters.IsExtendedMasterSecret != state.sessionParameters.IsExtendedMasterSecret)
{
throw new TlsFatalAlert(AlertDescription.handshake_failure,
"Server resumed session with mismatched extended_master_secret negotiation");
}
/*
* RFC 7301 3.1. When session resumption or session tickets [...] are used, the previous
* contents of this extension are irrelevant, and only the values in the new handshake
* messages are considered.
*/
securityParameters.m_applicationProtocol = TlsExtensionsUtilities.GetAlpnExtensionServer(
serverHelloExtensions);
securityParameters.m_applicationProtocolSet = true;
// Connection ID
if (ProtocolVersion.DTLSv12.Equals(securityParameters.NegotiatedVersion))
{
/*
* RFC 9146 3. When a DTLS session is resumed or renegotiated, the "connection_id" extension is
* negotiated afresh.
*/
var serverConnectionID = TlsExtensionsUtilities.GetConnectionIDExtension(serverHelloExtensions);
if (serverConnectionID != null)
{
var clientConnectionID = TlsExtensionsUtilities.GetConnectionIDExtension(state.clientExtensions)
?? throw new TlsFatalAlert(AlertDescription.internal_error);
securityParameters.m_connectionIDLocal = serverConnectionID;
securityParameters.m_connectionIDPeer = clientConnectionID;
}
}
// Heartbeats
{
HeartbeatExtension heartbeatExtension = TlsExtensionsUtilities.GetHeartbeatExtension(
serverHelloExtensions);
if (null == heartbeatExtension)
{
state.heartbeat = null;
state.heartbeatPolicy = HeartbeatMode.peer_not_allowed_to_send;
}
else if (HeartbeatMode.peer_allowed_to_send != heartbeatExtension.Mode)
{
state.heartbeat = null;
}
}
var sessionClientExtensions = state.clientExtensions;
var sessionServerExtensions = serverHelloExtensions;
if (securityParameters.IsResumedSession)
{
sessionClientExtensions = null;
sessionServerExtensions = state.sessionParameters.ReadServerExtensions();
}
if (sessionServerExtensions != null && sessionServerExtensions.Count > 0)
{
{
/*
* RFC 7366 3. If a server receives an encrypt-then-MAC request extension from a client
* and then selects a stream or Authenticated Encryption with Associated Data (AEAD)
* ciphersuite, it MUST NOT send an encrypt-then-MAC response extension back to the
* client.
*/
bool serverSentEncryptThenMac = TlsExtensionsUtilities.HasEncryptThenMacExtension(
sessionServerExtensions);
if (serverSentEncryptThenMac && !TlsUtilities.IsBlockCipherSuite(securityParameters.CipherSuite))
throw new TlsFatalAlert(AlertDescription.illegal_parameter);
securityParameters.m_encryptThenMac = serverSentEncryptThenMac;
}
securityParameters.m_maxFragmentLength = TlsUtilities.ProcessMaxFragmentLengthExtension(
sessionClientExtensions, sessionServerExtensions, AlertDescription.illegal_parameter);
securityParameters.m_truncatedHmac = TlsExtensionsUtilities.HasTruncatedHmacExtension(
sessionServerExtensions);
if (!securityParameters.IsResumedSession)
{
// TODO[tls13] See RFC 8446 4.4.2.1
if (TlsUtilities.HasExpectedEmptyExtensionData(sessionServerExtensions,
ExtensionType.status_request_v2, AlertDescription.illegal_parameter))
{
securityParameters.m_statusRequestVersion = 2;
}
else if (TlsUtilities.HasExpectedEmptyExtensionData(sessionServerExtensions,
ExtensionType.status_request, AlertDescription.illegal_parameter))
{
securityParameters.m_statusRequestVersion = 1;
}
securityParameters.m_clientCertificateType = TlsUtilities.ProcessClientCertificateTypeExtension(
sessionClientExtensions, sessionServerExtensions, AlertDescription.illegal_parameter);
securityParameters.m_serverCertificateType = TlsUtilities.ProcessServerCertificateTypeExtension(
sessionClientExtensions, sessionServerExtensions, AlertDescription.illegal_parameter);
state.expectSessionTicket = TlsUtilities.HasExpectedEmptyExtensionData(sessionServerExtensions,
ExtensionType.session_ticket, AlertDescription.illegal_parameter);
}
}
if (sessionClientExtensions != null)
{
client.ProcessServerExtensions(sessionServerExtensions);
}
}
///
protected virtual void ProcessServerKeyExchange(ClientHandshakeState state, byte[] body)
{
MemoryStream buf = new MemoryStream(body, false);
state.keyExchange.ProcessServerKeyExchange(buf);
TlsProtocol.AssertEmpty(buf);
}
///
protected virtual void ProcessServerSupplementalData(ClientHandshakeState state, byte[] body)
{
MemoryStream buf = new MemoryStream(body, false);
var serverSupplementalData = TlsProtocol.ReadSupplementalDataMessage(buf);
state.client.ProcessServerSupplementalData(serverSupplementalData);
}
///
protected virtual void ReportServerVersion(ClientHandshakeState state, ProtocolVersion server_version)
{
TlsClientContextImpl clientContext = state.clientContext;
SecurityParameters securityParameters = clientContext.SecurityParameters;
ProtocolVersion currentServerVersion = securityParameters.NegotiatedVersion;
if (null != currentServerVersion)
{
if (!currentServerVersion.Equals(server_version))
throw new TlsFatalAlert(AlertDescription.illegal_parameter);
return;
}
if (!ProtocolVersion.Contains(clientContext.ClientSupportedVersions, server_version))
throw new TlsFatalAlert(AlertDescription.protocol_version);
// TODO[dtls13] Read draft/RFC for guidance on the legacy_record_version field
//ProtocolVersion legacy_record_version = server_version.IsLaterVersionOf(ProtocolVersion.DTLSv12)
// ? ProtocolVersion.DTLSv12
// : server_version;
//recordLayer.SetWriteVersion(legacy_record_version);
securityParameters.m_negotiatedVersion = server_version;
TlsUtilities.NegotiatedVersionDtlsClient(clientContext, state.client);
}
///
protected static byte[] PatchClientHelloWithCookie(byte[] clientHelloBody, byte[] cookie)
{
int sessionIDPos = 34;
int sessionIDLength = TlsUtilities.ReadUint8(clientHelloBody, sessionIDPos);
int cookieLengthPos = sessionIDPos + 1 + sessionIDLength;
int cookiePos = cookieLengthPos + 1;
byte[] patched = new byte[clientHelloBody.Length + cookie.Length];
Array.Copy(clientHelloBody, 0, patched, 0, cookieLengthPos);
TlsUtilities.CheckUint8(cookie.Length);
TlsUtilities.WriteUint8(cookie.Length, patched, cookieLengthPos);
Array.Copy(cookie, 0, patched, cookiePos, cookie.Length);
Array.Copy(clientHelloBody, cookiePos, patched, cookiePos + cookie.Length,
clientHelloBody.Length - cookiePos);
return patched;
}
protected internal class ClientHandshakeState
{
internal TlsClient client = null;
internal TlsClientContextImpl clientContext = null;
internal TlsSession tlsSession = null;
internal SessionParameters sessionParameters = null;
internal TlsSecret sessionMasterSecret = null;
internal SessionParameters.Builder sessionParametersBuilder = null;
internal int[] offeredCipherSuites = null;
internal IDictionary clientExtensions = null;
internal IDictionary serverExtensions = null;
internal bool expectSessionTicket = false;
internal IDictionary clientAgreements = null;
internal OfferedPsks.BindersConfig clientBinders = null;
internal TlsKeyExchange keyExchange = null;
internal TlsAuthentication authentication = null;
internal CertificateStatus certificateStatus = null;
internal CertificateRequest certificateRequest = null;
internal TlsHeartbeat heartbeat = null;
internal short heartbeatPolicy = HeartbeatMode.peer_not_allowed_to_send;
}
}
}