8000 Add a client parameter to specify SSL version(s). by vaintroub · Pull Request #450 · mysql-net/MySqlConnector · GitHub
[go: up one dir, main page]
Skip to content

Add a client parameter to specify SSL version(s). #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add a client parameter to specify SSL version(s). #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
033ba21
Add a client parameter to specify SSL version(s).
vaintroub Mar 13, 2018
4ba5dae
Enable TLS1.2 by default in SslProtocols, unless on Windows.
vaintroub Mar 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/MySqlConnector/Core/ConnectionSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ public ConnectionSettings(MySqlConnectionStringBuilder csb)

// SSL/TLS Options
SslMode = csb.SslMode;
SslProtocols = csb.SslProtocols;
CertificateFile = csb.CertificateFile;
CertificatePassword = csb.CertificatePassword;
CACertificateFile = csb.CACertificateFile;
Expand Down Expand Up @@ -84,6 +85,7 @@ public ConnectionSettings(MySqlConnectionStringBuilder csb)

// SSL/TLS Options
public MySqlSslMode SslMode { get; }
public System.Security.Authentication.SslProtocols SslProtocols { get; }
public string CertificateFile { get; }
public string CertificatePassword { get; }
public string CACertificateFile { get; }
Expand Down
12 changes: 4 additions & 8 deletions src/MySqlConnector/Core/ServerSession.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,11 +851,6 @@ bool ValidateRemoteCertificate(object rcbSender, X509Certificate rcbCertificate,
else
sslStream = new SslStream(m_networkStream, false, ValidateRemoteCertificate, ValidateLocalCertificate);

// SslProtocols.Tls1.2 throws an exception in Windows, see https://github.com/mysql-net/MySqlConnector/pull/101
var sslProtocols = SslProtocols.Tls | SslProtocols.Tls11;
if (!Utility.IsWindows())
sslProtocols |= SslProtocols.Tls12;

var checkCertificateRevocation = cs.SslMode == MySqlSslMode.VerifyFull;

var initSsl = HandshakeResponse41Payload.CreateWithSsl(serverCapabilities, cs, m_useCompression);
Expand All @@ -865,14 +860,14 @@ bool ValidateRemoteCertificate(object rcbSender, X509Certificate rcbCertificate,
{
if (ioBehavior == IOBehavior.Asynchronous)
{
await sslStream.AuthenticateAsClientAsync(HostName, clientCertificates, sslProtocols, checkCertificateRevocation).ConfigureAwait(false);
await sslStream.AuthenticateAsClientAsync(HostName, clientCertificates, cs.SslProtocols, checkCertificateRevocation).ConfigureAwait(false);
}
else
{
#if NETSTANDARD1_3
await sslStream.AuthenticateAsClientAsync(HostName, clientCertificates, sslProtocols, checkCertificateRevocation).ConfigureAwait(false);
await sslStream.AuthenticateAsClientAsync(HostName, clientCertificates, cs.SslProtocols, checkCertificateRevocation).ConfigureAwait(false);
#else
sslStream.AuthenticateAsClient(HostName, clientCertificates, sslProtocols, checkCertificateRevocation);
sslStream.AuthenticateAsClient(HostName, clientCertificates, cs.SslProtocols, checkCertificateRevocation);
#endif
}
var sslByteHandler = new StreamByteHandler(sslStream);
Expand Down Expand Up @@ -1071,6 +1066,7 @@ private void VerifyState(State state1, State state2, State state3)
internal bool SslIsAuthenticated => m_sslStream?.IsAuthenticated ?? false;

internal bool SslIsMutuallyAuthenticated => m_sslStream?.IsMutuallyAuthenticated ?? false;
internal SslProtocols SslProtocol => m_sslStream?.SslProtocol ?? SslProtocols.None;

private byte[] CreateConnectionAttributes()
{
Expand Down
1 change: 1 addition & 0 deletions src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,7 @@ private async ValueTask<ServerSession> CreateSessionAsync(IOBehavior? ioBehavior
internal bool SslIsAuthenticated => m_session.SslIsAuthenticated;

internal bool SslIsMutuallyAuthenticated => m_session.SslIsMutuallyAuthenticated;
internal System.Security.Authentication.SslProtocols SslProtocol => m_session.SslProtocol;

internal void SetState(ConnectionState newState)
{
Expand Down
31 changes: 31 additions & 0 deletions src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnectionStringBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
using System.Collections.Generic;
using System.Data.Common;
using System.Globalization;
using System.Security.Authentication;
using MySqlConnector.Utilities;

namespace MySql.Data.MySqlClient
Expand Down Expand Up @@ -61,6 +62,12 @@ public MySqlSslMode SslMode
set => MySqlConnectionStringOption.SslMode.SetValue(this, value);
}

public SslProtocols SslProtocols
{
get => MySqlConnectionStringOption.SslProtocols.GetValue(this);
set => MySqlConnectionStringOption.SslProtocols.SetValue(this, value);
}

public string CertificateFile
{
get => MySqlConnectionStringOption.CertificateFile.GetValue(this);
Expand Down Expand Up @@ -262,6 +269,7 @@ internal abstract class MySqlConnectionStringOption

// SSL/TLS Options
public static readonly MySqlConnectionStringOption<MySqlSslMode> SslMode;
public static readonly MySqlConnectionStringOption<SslProtocols> SslProtocols;
public static readonly MySqlConnectionStringOption<string> CertificateFile;
public static readonly MySqlConnectionStringOption<string> CertificatePassword;
public static readonly MySqlConnectionStringOption<string> CACertificateFile;
Expand Down Expand Up @@ -347,6 +355,17 @@ static MySqlConnectionStringOption()
keys: new[] { "SSL Mode", "SslMode" },
defaultValue: MySqlSslMode.Preferred));

var sslProtocolsDefault = System.Security.Authentication.SslProtocols.Tls |
System.Security.Authentication.SslProtocols.Tls11;
if (!Utility.IsWindows())
{
sslProtocolsDefault |= System.Security.Authentication.SslProtocols.Tls12;
}

AddOption(SslProtocols = new MySqlConnectionStringOption<SslProtocols>(
keys: new[] { "SSL Protocols", "SslProtocols" },
defaultValue: sslProtocolsDefault));

AddOption(CertificateFile = new MySqlConnectionStringOption<string>(
keys: new[] { "CertificateFile", "Certificate File" },
defaultValue: null));
Expand Down Expand Up @@ -503,6 +522,18 @@ private static T ChangeType(object objectValue)
throw new InvalidOperationException("Value '{0}' not supported for option '{1}'.".FormatInvariant(objectValue, typeof(T).Name));
}

if (typeof(T) == typeof(SslProtocols) && objectValue is string sslProtocolsString)
{
try
{
return (T) Enum.Parse(typeof(T), sslProtocolsString, true);
}
catch (Exception)
{
throw new InvalidOperationException("Value '{0}' not supported for option '{1}'.".FormatInvariant(objectValue, typeof(T).Name));
}
}

return (T) Convert.ChangeType(objectValue, typeof(T), CultureInfo.InvariantCulture);
}

Expand Down
3 changes: 3 additions & 0 deletions tests/MySqlConnector.Tests/MySqlConnectionStringBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System.Security.Authentication;
using MySql.Data.MySqlClient;
using Xunit;

Expand Down Expand Up @@ -82,6 +83,7 @@ public void ParseConnectionString()
"allow public key retrieval = true;" +
"server rsa public key file=rsa.pem;" +
"load balance=random;" +
"ssl protocols = Tls11,Tls12;" +
#endif
"Keep Alive=90;" +
"minpoolsize=5;" +
Expand Down Expand Up @@ -114,6 +116,7 @@ public void ParseConnectionString()
Assert.True(csb.AllowPublicKeyRetrieval);
Assert.Equal("rsa.pem", csb.ServerRsaPublicKeyFile);
Assert.Equal(MySqlLoadBalance.Random, csb.LoadBalance);
Assert.Equal(SslProtocols.Tls11 | SslProtocols.Tls12, csb.SslProtocols);
#endif
Assert.Equal(90u, csb.Keepalive);
Assert.Equal(15u, csb.MaximumPoolSize);
Expand Down
17 changes: 17 additions & 0 deletions tests/SideBySide/SslTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,23 @@ public async Task ConnectSslPreferred()
}
}

#if !BASELINE
[SkippableFact(ConfigSettings.RequiresSsl)]
public async Task ConnectTls1_0()
{
var csb = AppConfig.CreateConnectionStringBuilder();
csb.SslMode = MySqlSslMode.Preferred;
csb.SslProtocols = System.Security.Authentication.SslProtocols.Tls;
csb.CertificateFile = null;
csb.CertificatePassword = null;
using (var connection = new MySqlConnection(csb.ConnectionString))
{
await connection.OpenAsync();
Assert.True(csb.SslProtocols.HasFlag(connection.SslProtocol));
}
}
#endif

[SkippableTheory(ConfigSettings.RequiresSsl | ConfigSettings.KnownClientCertificate)]
[InlineData("ssl-client.pfx", null, null)]
[InlineData("ssl-client-pw-test.pfx", "test", null)]
Expand Down
0