Skip to content
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

Jump to bottom

Added support for supplying a custom CertificateValidationCallback #16

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added support for supplying a custom CertificateValidationCallback #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions src/Tests/ApprovalFiles/NoPublicApiChanges.Run.DotNet.verified.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Bui
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(DbUp.Engine.Transactions.IConnectionManager connectionManager, string schema) { }
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Builder.SupportedDatabases supported, string connectionString, string schema) { }
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Builder.SupportedDatabases supported, string connectionString, string schema, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Builder.SupportedDatabases supported, string connectionString, string schema, DbUp.Postgresql.PostgresqlConnectionOptions connectionOptions) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString, DbUp.Postgresql.PostgresqlConnectionOptions connectionOptions) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString, DbUp.Engine.Output.IUpgradeLog logger) { }
}
namespace DbUp.Postgresql
Expand All @@ -21,8 +23,15 @@ public class PostgresqlConnectionManager : DbUp.Engine.Transactions.DatabaseConn
{
public PostgresqlConnectionManager(string connectionString) { }
public PostgresqlConnectionManager(string connectionString, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public PostgresqlConnectionManager(string connectionString, DbUp.Postgresql.PostgresqlConnectionOptions connectionOptions) { }
public override System.Collections.Generic.IEnumerable<string> SplitScriptIntoCommands(string scriptContents) { }
}
public class PostgresqlConnectionOptions
{
public PostgresqlConnectionOptions() { }
public System.Security.Cryptography.X509Certificates.X509Certificate2 ClientCertificate { get; set; }
public System.Net.Security.RemoteCertificateValidationCallback UserCertificateValidationCallback { get; set; }
}
public class PostgresqlObjectParser : DbUp.Support.SqlObjectParser, DbUp.Engine.ISqlObjectParser
{
public PostgresqlObjectParser() { }
Expand Down
9 changes: 9 additions & 0 deletions src/Tests/ApprovalFiles/NoPublicApiChanges.Run.Net.verified.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Bui
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(DbUp.Engine.Transactions.IConnectionManager connectionManager, string schema) { }
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Builder.SupportedDatabases supported, string connectionString, string schema) { }
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Builder.SupportedDatabases supported, string connectionString, string schema, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public static DbUp.Builder.UpgradeEngineBuilder PostgresqlDatabase(this DbUp.Builder.SupportedDatabases supported, string connectionString, string schema, DbUp.Postgresql.PostgresqlConnectionOptions connectionOptions) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString, DbUp.Postgresql.PostgresqlConnectionOptions connectionOptions) { }
public static void PostgresqlDatabase(this DbUp.SupportedDatabasesForEnsureDatabase supported, string connectionString, DbUp.Engine.Output.IUpgradeLog logger) { }
}
namespace DbUp.Postgresql
Expand All @@ -21,8 +23,15 @@ public class PostgresqlConnectionManager : DbUp.Engine.Transactions.DatabaseConn
{
public PostgresqlConnectionManager(string connectionString) { }
public PostgresqlConnectionManager(string connectionString, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) { }
public PostgresqlConnectionManager(string connectionString, DbUp.Postgresql.PostgresqlConnectionOptions connectionOptions) { }
public override System.Collections.Generic.IEnumerable<string> SplitScriptIntoCommands(string scriptContents) { }
}
public class PostgresqlConnectionOptions
{
public PostgresqlConnectionOptions() { }
public System.Security.Cryptography.X509Certificates.X509Certificate2 ClientCertificate { get; set; }
public System.Net.Security.RemoteCertificateValidationCallback UserCertificateValidationCallback { get; set; }
}
public class PostgresqlObjectParser : DbUp.Support.SqlObjectParser, DbUp.Engine.ISqlObjectParser
{
public PostgresqlObjectParser() { }
Expand Down
16 changes: 14 additions & 2 deletions src/dbup-postgresql/PostgresqlConnectionManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,23 @@ public PostgresqlConnectionManager(string connectionString)
/// <param name="connectionString">The PostgreSQL connection string.</param>
/// <param name="certificate">Certificate for securing connection.</param>
public PostgresqlConnectionManager(string connectionString, X509Certificate2 certificate)
: this(connectionString, new PostgresqlConnectionOptions
{
ClientCertificate = certificate
})
{
}

/// <summary>
/// Create a new PostgreSQL database connection
/// </summary>
/// <param name="connectionString">The PostgreSQL connection string.</param>
/// <param name="connectionOptions">Custom options to apply on the created connection</param>
public PostgresqlConnectionManager(string connectionString, PostgresqlConnectionOptions connectionOptions)
: base(new DelegateConnectionFactory(l =>
{
NpgsqlConnection databaseConnection = new NpgsqlConnection(connectionString);
databaseConnection.ProvideClientCertificatesCallback +=
certs => certs.Add(certificate);
databaseConnection.ApplyConnectionOptions(connectionOptions);

return databaseConnection;
}
Expand Down
22 changes: 22 additions & 0 deletions src/dbup-postgresql/PostgresqlConnectionOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;

namespace DbUp.Postgresql
{
/// <summary>
/// Options that will be applied on the created connection
/// </summary>
public class PostgresqlConnectionOptions
{
/// <summary>
/// Certificate for securing connection.
/// </summary>
public X509Certificate2 ClientCertificate { get; set; }

/// <summary>
// Custom handler to verify the remote SSL certificate.
// Ignored if Npgsql.NpgsqlConnectionStringBuilder.TrustServerCertificate is set.
/// </summary>
public RemoteCertificateValidationCallback UserCertificateValidationCallback { get; set; }
}
}
59 changes: 51 additions & 8 deletions src/dbup-postgresql/PostgresqlExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,19 @@ public static UpgradeEngineBuilder PostgresqlDatabase(this SupportedDatabases su
public static UpgradeEngineBuilder PostgresqlDatabase(this SupportedDatabases supported, string connectionString, string schema, X509Certificate2 certificate)
=> PostgresqlDatabase(new PostgresqlConnectionManager(connectionString, certificate), schema);

/// <summary>
/// Creates an upgrader for PostgreSQL databases that use SSL.
/// </summary>
/// <param name="supported">Fluent helper type.</param>
/// <param name="connectionString">PostgreSQL database connection string.</param>
/// <param name="schema">The schema in which to check for changes</param>
/// <param name="connectionOptions">Connection options to set SSL parameters</param>
/// <returns>
/// A builder for a database upgrader designed for PostgreSQL databases.
/// </returns>
public static UpgradeEngineBuilder PostgresqlDatabase(this SupportedDatabases supported, string connectionString, string schema, PostgresqlConnectionOptions connectionOptions)
=> PostgresqlDatabase(new PostgresqlConnectionManager(connectionString, connectionOptions), schema);

/// <summary>
/// Creates an upgrader for PostgreSQL databases.
/// </summary>
Expand Down Expand Up @@ -113,6 +126,18 @@ public static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase s
PostgresqlDatabase(supported, connectionString, new ConsoleUpgradeLog(), certificate);
}

/// <summary>
/// Ensures that the database specified in the connection string exists using SSL for the connection.
/// </summary>
/// <param name="supported">Fluent helper type.</param>
/// <param name="connectionString">The connection string.</param>
/// <param name="connectionOptions">Connection SSL to customize SSL behaviour</param>
/// <returns></returns>
public static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase supported, string connectionString, PostgresqlConnectionOptions connectionOptions)
{
PostgresqlDatabase(supported, connectionString, new ConsoleUpgradeLog(), connectionOptions);
}

/// <summary>
/// Ensures that the database specified in the connection string exists.
/// </summary>
Expand All @@ -122,10 +147,19 @@ public static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase s
/// <returns></returns>
public static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase supported, string connectionString, IUpgradeLog logger)
{
PostgresqlDatabase(supported, connectionString, logger, null);
PostgresqlDatabase(supported, connectionString, logger, (PostgresqlConnectionOptions)null);
}

private static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase supported, string connectionString, IUpgradeLog logger, X509Certificate2 certificate)
{
var options = new PostgresqlConnectionOptions
{
ClientCertificate = certificate
};
PostgresqlDatabase(supported, connectionString, logger, options);
}

private static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase supported, string connectionString, IUpgradeLog logger, PostgresqlConnectionOptions connectionOptions)
{
if (supported == null) throw new ArgumentNullException("supported");

Expand All @@ -137,7 +171,7 @@ private static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase
if (logger == null) throw new ArgumentNullException("logger");

var masterConnectionStringBuilder = new NpgsqlConnectionStringBuilder(connectionString);

var databaseName = masterConnectionStringBuilder.Database;

if (string.IsNullOrEmpty(databaseName) || databaseName.Trim() == string.Empty)
Expand All @@ -157,11 +191,7 @@ private static void PostgresqlDatabase(this SupportedDatabasesForEnsureDatabase

using (var connection = new NpgsqlConnection(masterConnectionStringBuilder.ConnectionString))
{
if (certificate != null)
{
connection.ProvideClientCertificatesCallback +=
certs => certs.Add(certificate);
}
connection.ApplyConnectionOptions(connectionOptions);
connection.Open();

var sqlCommandText = string.Format
Expand Down Expand Up @@ -216,4 +246,17 @@ public static UpgradeEngineBuilder JournalToPostgresqlTable(this UpgradeEngineBu
builder.Configure(c => c.Journal = new PostgresqlTableJournal(() => c.ConnectionManager, () => c.Log, schema, table));
return builder;
}

internal static void ApplyConnectionOptions(this NpgsqlConnection connection, PostgresqlConnectionOptions connectionOptions)
{
if (connectionOptions?.ClientCertificate != null)
{
connection.ProvideClientCertificatesCallback +=
certs => certs.Add(connectionOptions.ClientCertificate);
}
if (connectionOptions?.UserCertificateValidationCallback != null)
{
connection.UserCertificateValidationCallback = connectionOptions.UserCertificateValidationCallback;
}
}
}