implement password manager support for connection strings (#107)

MaceWindu · web-flow · commit 4ae27cd5d0a4 · 2024-03-09T15:49:45.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -249,6 +249,8 @@ dotnet_diagnostic.MA0006.severity = none
 dotnet_diagnostic.MA0007.severity = none
 # MA0009: Add regex evaluation timeout
 dotnet_diagnostic.MA0009.severity = none
+# MA0023: Add RegexOptions.ExplicitCapture
+dotnet_diagnostic.MA0023.severity = none
 # MA0026: Fix TODO comment
 dotnet_diagnostic.MA0026.severity = none
 # MA0038: Make method static (deprecated, use CA1822 instead)
diff --git a/Source/Configuration/AppConfig.cs b/Source/Configuration/AppConfig.cs
@@ -26,7 +26,7 @@ public static ILinqToDBSettings LoadJson(string configPath)
 			if (cn.Key.EndsWith("_ProviderName", StringComparison.InvariantCultureIgnoreCase))
 				continue;
 
-			connections.Add(cn.Key, new ConnectionStringSettings(cn.Key, cn.Value));
+			connections.Add(cn.Key, new ConnectionStringSettings(cn.Key, PasswordManager.ResolvePasswordManagerFields(cn.Value)));
 		}
 
 		foreach (var cn in config.ConnectionStrings)
@@ -64,7 +64,7 @@ public static ILinqToDBSettings LoadAppConfig(string configPath)
 			var providerName     = node.Attributes["providerName"    ]?.Value;
 
 			if (name != null && connectionString != null)
-				settings.Add(new ConnectionStringSettings(name, connectionString) { ProviderName = providerName });
+				settings.Add(new ConnectionStringSettings(name, PasswordManager.ResolvePasswordManagerFields(connectionString)) { ProviderName = providerName });
 		}
 
 		return new AppConfig(settings.ToArray());
@@ -82,11 +82,13 @@ private sealed class JsonConfig
 		public IDictionary<string, string>? ConnectionStrings { get; set; }
 	}
 
+	/// <param name="name">Connection name.</param>
+	/// <param name="connectionString">Must be connection string without password manager tokens.</param>
 	private sealed class ConnectionStringSettings(string name, string connectionString) : IConnectionStringSettings
 	{
 		string IConnectionStringSettings.ConnectionString => connectionString;
-		string  IConnectionStringSettings.Name             => name;
-		bool    IConnectionStringSettings.IsGlobal         => false;
+		string IConnectionStringSettings.Name             => name;
+		bool   IConnectionStringSettings.IsGlobal         => false;
 
 		public string? ProviderName { get; set; }
 	}
diff --git a/Source/Configuration/ConnectionSettings.cs b/Source/Configuration/ConnectionSettings.cs
@@ -387,6 +387,18 @@ public string? ProviderPath
 		[JsonIgnore]
 		public string? ConnectionString { get; set; }
 
+		/// <summary>
+		/// Returns <see cref="ConnectionString"/> property value with resolved LINQPad password manager tokens.
+		/// </summary>
+		/// <returns></returns>
+		public string? GetFullConnectionString         () => PasswordManager.ResolvePasswordManagerFields(ConnectionString);
+
+		/// <summary>
+		/// Returns <see cref="SecondaryConnectionString"/> property value with resolved LINQPad password manager tokens.
+		/// </summary>
+		/// <returns></returns>
+		public string? GetFullSecondaryConnectionString() => PasswordManager.ResolvePasswordManagerFields(SecondaryConnectionString);
+
 		/// <summary>
 		/// Stored in <see cref="IDatabaseInfo.Provider"/>.
 		/// </summary>
diff --git a/Source/DatabaseProviders/AccessProvider.cs b/Source/DatabaseProviders/AccessProvider.cs
@@ -40,9 +40,9 @@ public override void ClearAllPools(string providerName)
 	public override DateTime? GetLastSchemaUpdate(ConnectionSettings settings)
 	{
 		var connectionString = settings.Connection.Provider == ProviderName.Access
-			? settings.Connection.ConnectionString
+			? settings.Connection.GetFullConnectionString()
 			: settings.Connection.SecondaryProvider == ProviderName.Access
-				? settings.Connection.SecondaryConnectionString
+				? settings.Connection.GetFullSecondaryConnectionString()
 				: null;
 
 		if (connectionString == null || !RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
@@ -53,7 +53,7 @@ public override void ClearAllPools(string providerName)
 		if (settings.Connection.Provider == ProviderName.Access)
 			provider = DatabaseProviders.GetDataProvider(settings);
 		else
-			provider = DatabaseProviders.GetDataProvider(settings.Connection.SecondaryProvider, settings.Connection.SecondaryConnectionString, null);
+			provider = DatabaseProviders.GetDataProvider(settings.Connection.SecondaryProvider, connectionString, null);
 
 		using var cn = (OleDbConnection)provider.CreateConnection(connectionString);
 		cn.Open();
@@ -65,6 +65,8 @@ public override void ClearAllPools(string providerName)
 
 	public override ProviderInfo? GetProviderByConnectionString(string connectionString)
 	{
+		connectionString = PasswordManager.ResolvePasswordManagerFields(connectionString);
+
 		var isOleDb = connectionString.IndexOf("Microsoft.Jet.OLEDB", StringComparison.OrdinalIgnoreCase) != -1
 			|| connectionString.IndexOf("Microsoft.ACE.OLEDB", StringComparison.OrdinalIgnoreCase) != -1;
 
diff --git a/Source/DatabaseProviders/DatabaseProviderBase.cs b/Source/DatabaseProviders/DatabaseProviderBase.cs
@@ -30,6 +30,9 @@ public virtual void                          Unload                       (
 	public abstract DateTime?         GetLastSchemaUpdate(ConnectionSettings settings);
 	public abstract DbProviderFactory GetProviderFactory (string providerName        );
 
+	/// <param name="providerName">Provider name.</param>
+	/// <param name="connectionString">Connection string must be resolved against password manager already.</param>
+	/// <returns></returns>
 	public virtual IDataProvider GetDataProvider(string providerName, string connectionString)
 	{
 		return DataConnection.GetDataProvider(providerName, connectionString)
diff --git a/Source/DatabaseProviders/DatabaseProviders.cs b/Source/DatabaseProviders/DatabaseProviders.cs
@@ -64,12 +64,21 @@ public static void Init()
 		// trigger .cctors
 	}
 
-	public static DbConnection CreateConnection (ConnectionSettings settings) => GetDataProvider(settings).CreateConnection(settings.Connection.ConnectionString!);
+	public static DbConnection CreateConnection(ConnectionSettings settings)
+	{
+		return GetDataProvider(settings).CreateConnection(settings.Connection.GetFullConnectionString()!);
+	}
 
 	public static DbProviderFactory GetProviderFactory(ConnectionSettings settings) => GetProviderByName(settings.Connection.Provider!).GetProviderFactory(settings.Connection.Provider!);
 
-	public static IDataProvider GetDataProvider(ConnectionSettings settings) => GetDataProvider(settings.Connection.Provider, settings.Connection.ConnectionString, settings.Connection.ProviderPath);
+	public static IDataProvider GetDataProvider(ConnectionSettings settings)
+	{
+		return GetDataProvider(settings.Connection.Provider, settings.Connection.GetFullConnectionString(), settings.Connection.ProviderPath);
+	}
 
+	/// <param name="providerName">Provider name.</param>
+	/// <param name="connectionString">Connection string must be already resolved against password manager.</param>
+	/// <param name="providerPath">Optional path to provider assembly.</param>
 	public static IDataProvider GetDataProvider(string? providerName, string? connectionString, string? providerPath)
 	{
 		if (string.IsNullOrWhiteSpace(providerName))
diff --git a/Source/DatabaseProviders/IDatabaseProvider.cs b/Source/DatabaseProviders/IDatabaseProvider.cs
@@ -53,6 +53,8 @@ internal interface IDatabaseProvider
 	/// <summary>
 	/// Tries to infer provider by database connection string.
 	/// </summary>
+	/// <param name="connectionString">Connection string could contain password manager tokens.</param>
+	/// <returns></returns>
 	ProviderInfo? GetProviderByConnectionString(string connectionString);
 
 	/// <summary>
@@ -95,6 +97,8 @@ internal interface IDatabaseProvider
 	/// <summary>
 	/// Returns linq2db data provider.
 	/// </summary>
+	/// <param name="providerName">Provider name.</param>
+	/// <param name="connectionString">Connection string must be already resolved against password manager.</param>
 	IDataProvider GetDataProvider(string providerName, string connectionString);
 
 #if NETFRAMEWORK
diff --git a/Source/DatabaseProviders/SqlServerProvider.cs b/Source/DatabaseProviders/SqlServerProvider.cs
@@ -92,7 +92,6 @@ public override DbProviderFactory GetProviderFactory(string providerName)
 		return SqlClientFactory.Instance;
 	}
 
-
 	public override IDataProvider GetDataProvider(string providerName, string connectionString)
 	{
 		// provider detector fails to detect Microsoft.Data.SqlClient
diff --git a/Source/Drivers/DriverHelper.cs b/Source/Drivers/DriverHelper.cs
@@ -266,17 +266,18 @@ public static bool ShowConnectionDialog(IConnectionInfo cxInfo, ConnectionDialog
 						throw new LinqToDBLinqPadException($"Cannot access provider assembly at {model.DynamicConnection.ProviderPath}");
 				}
 
-				var provider = DatabaseProviders.GetDataProvider(model.DynamicConnection.Provider.Name, model.DynamicConnection.ConnectionString, model.DynamicConnection.ProviderPath);
-
-				using (var con = provider.CreateConnection(model.DynamicConnection.ConnectionString))
+				var connectionString = PasswordManager.ResolvePasswordManagerFields(model.DynamicConnection.ConnectionString);
+				var provider         = DatabaseProviders.GetDataProvider(model.DynamicConnection.Provider.Name, connectionString, model.DynamicConnection.ProviderPath);
+				using (var con       = provider.CreateConnection(connectionString))
 					con.Open();
 
 				if (model.DynamicConnection.Database.SupportsSecondaryConnection
 					&& model.DynamicConnection.SecondaryProvider != null
 					&& model.DynamicConnection.SecondaryConnectionString != null)
 				{
-					var secondaryProvider = DatabaseProviders.GetDataProvider(model.DynamicConnection.SecondaryProvider.Name, model.DynamicConnection.SecondaryConnectionString, null);
-					using var con = secondaryProvider.CreateConnection(model.DynamicConnection.SecondaryConnectionString);
+					var secondaryConnectionString = PasswordManager.ResolvePasswordManagerFields(model.DynamicConnection.SecondaryConnectionString);
+					var secondaryProvider         = DatabaseProviders.GetDataProvider(model.DynamicConnection.SecondaryProvider.Name, secondaryConnectionString, null);
+					using var con                 = secondaryProvider.CreateConnection(secondaryConnectionString);
 					con.Open();
 				}
 
diff --git a/Source/Drivers/DynamicLinqToDBDriver.cs b/Source/Drivers/DynamicLinqToDBDriver.cs
@@ -197,7 +197,7 @@ public override List<ExplorerItem> GetSchemaAndBuildAssembly(IConnectionInfo cxI
 			[
 				settings.Connection.Provider,
 				settings.Connection.ProviderPath,
-				settings.Connection.ConnectionString
+				settings.Connection.GetFullConnectionString()
 			];
 		}
 		catch (Exception ex)
diff --git a/Source/Drivers/DynamicSchemaGenerator.cs b/Source/Drivers/DynamicSchemaGenerator.cs
@@ -132,7 +132,7 @@ public static (List<ExplorerItem> items, string sourceCode, string providerAssem
 
 		var provider         = DatabaseProviders.GetDataProvider(settings);
 
-		using var db         = new DataConnection(provider, settings.Connection.ConnectionString!);
+		using var db         = new DataConnection(provider, settings.Connection.GetFullConnectionString()!);
 		if (settings.Connection.CommandTimeout != null)
 			db.CommandTimeout = settings.Connection.CommandTimeout.Value;
 
@@ -150,8 +150,9 @@ public static (List<ExplorerItem> items, string sourceCode, string providerAssem
 		DatabaseModel dataModel;
 		if (settings.Connection.Database == ProviderName.Access && settings.Connection.SecondaryConnectionString != null)
 		{
-			var secondaryProvider = DatabaseProviders.GetDataProvider(settings.Connection.SecondaryProvider, settings.Connection.SecondaryConnectionString, null);
-			using var sdc         = new DataConnection(secondaryProvider, settings.Connection.SecondaryConnectionString);
+			var secondaryConnectionString = settings.Connection.GetFullSecondaryConnectionString()!;
+			var secondaryProvider         = DatabaseProviders.GetDataProvider(settings.Connection.SecondaryProvider, secondaryConnectionString, null);
+			using var sdc                 = new DataConnection(secondaryProvider, secondaryConnectionString);
 
 			if (settings.Connection.CommandTimeout != null)
 				sdc.CommandTimeout = settings.Connection.CommandTimeout.Value;
diff --git a/Source/Drivers/PasswordManager.cs b/Source/Drivers/PasswordManager.cs
@@ -0,0 +1,20 @@
+﻿using System.Diagnostics.CodeAnalysis;
+using System.Text.RegularExpressions;
+using LINQPad;
+
+namespace LinqToDB.LINQPad
+{
+	internal static partial class PasswordManager
+	{
+		private static readonly Regex _tokenReplacer = new(@"\{pm:([^\}]+)\}", RegexOptions.Compiled);
+
+		[return: NotNullIfNotNull(nameof(value))]
+		public static string? ResolvePasswordManagerFields(string? value)
+		{
+			if (value == null)
+				return null;
+
+			return _tokenReplacer.Replace(value, m => Util.GetPassword(m.Groups[1].Value));
+		}
+	}
+}
diff --git a/Source/LINQPadDataConnection.cs b/Source/LINQPadDataConnection.cs
@@ -10,6 +10,9 @@ public class LINQPadDataConnection : DataConnection
 	/// <summary>
 	/// Constructor for inherited context.
 	/// </summary>
+	/// <param name="providerName">Provider name.</param>
+	/// <param name="providerPath">Optional provider assembly path.</param>
+	/// <param name="connectionString">Connection string must have password manager tokens replaced already.</param>
 	protected LINQPadDataConnection(string? providerName, string? providerPath, string? connectionString)
 		: base(
 			DatabaseProviders.GetDataProvider(providerName, connectionString, providerPath),
@@ -24,7 +27,7 @@ internal LINQPadDataConnection(ConnectionSettings settings)
 		: this(
 			settings.Connection.Provider,
 			settings.Connection.ProviderPath,
-			settings.Connection.ConnectionString)
+			settings.Connection.GetFullConnectionString())
 	{
 		if (settings.Connection.CommandTimeout != null)
 			CommandTimeout = settings.Connection.CommandTimeout.Value;
diff --git a/Source/UI/Settings/DynamicConnectionTab.xaml b/Source/UI/Settings/DynamicConnectionTab.xaml
@@ -39,7 +39,7 @@
 					<TextBox Padding="5" Text="{Binding ProviderPath}" />
 				</DockPanel>
 
-				<StackPanel Margin="0 5 0 0" ToolTip="Specify database connection string">
+				<StackPanel Margin="0 5 0 0" ToolTip="Specify database connection string. Connection string could reference values from LINPad Password Manager (see File -> Password Manager) using following format: {pm:name}, e.g. &quot;Server=.;Database=DB;User Id=user;Password={pm:my-password}&quot;">
 					<Label>Connection string</Label>
 					<TextBox Padding="5" Text="{Binding ConnectionString}" TextWrapping="Wrap" Height="60" VerticalScrollBarVisibility="Auto" />
 				</StackPanel>
diff --git a/release-notes.md b/release-notes.md
@@ -2,6 +2,7 @@
 
 Issues fixed:
 
+- [#88](https://github.com/linq2db/linq2db.LINQPad/issues/88): add support for LINQPad Password Manager in connection strings. To reference value from password manager use `{pm:password-name}` token syntax
 - [#97](https://github.com/linq2db/linq2db.LINQPad/issues/97), [#103](https://github.com/linq2db/linq2db.LINQPad/issues/103): update dependencies to get rid of vulnerable transient dependencies
 - [#101](https://github.com/linq2db/linq2db.LINQPad/issues/101): fix snippets generation from object names matching C# keywords
 - [#102](https://github.com/linq2db/linq2db.LINQPad/pull/102): support custom `IDataContext`-based contexts; don't try to load missing connection configuration files. Thanks to [@cal-tlabwest](https://github.com/cal-tlabwest) for fix

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public static ILinqToDBSettings LoadJson(string configPath)`
`26`	`26`	`if (cn.Key.EndsWith("_ProviderName", StringComparison.InvariantCultureIgnoreCase))`
`27`	`27`	`continue;`
`28`	`28`
`29`		`- connections.Add(cn.Key, new ConnectionStringSettings(cn.Key, cn.Value));`
	`29`	`+ connections.Add(cn.Key, new ConnectionStringSettings(cn.Key, PasswordManager.ResolvePasswordManagerFields(cn.Value)));`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`foreach (var cn in config.ConnectionStrings)`
`@@ -64,7 +64,7 @@ public static ILinqToDBSettings LoadAppConfig(string configPath)`
`64`	`64`	`var providerName = node.Attributes["providerName" ]?.Value;`
`65`	`65`
`66`	`66`	`if (name != null && connectionString != null)`
`67`		`- settings.Add(new ConnectionStringSettings(name, connectionString) { ProviderName = providerName });`
	`67`	`+ settings.Add(new ConnectionStringSettings(name, PasswordManager.ResolvePasswordManagerFields(connectionString)) { ProviderName = providerName });`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`return new AppConfig(settings.ToArray());`
`@@ -82,11 +82,13 @@ private sealed class JsonConfig`
`82`	`82`	`public IDictionary<string, string>? ConnectionStrings { get; set; }`
`83`	`83`	`}`
`84`	`84`
	`85`	`+ /// <param name="name">Connection name.</param>`
	`86`	`+ /// <param name="connectionString">Must be connection string without password manager tokens.</param>`
`85`	`87`	`private sealed class ConnectionStringSettings(string name, string connectionString) : IConnectionStringSettings`
`86`	`88`	`{`
`87`	`89`	`string IConnectionStringSettings.ConnectionString => connectionString;`
`88`		`- string IConnectionStringSettings.Name => name;`
`89`		`- bool IConnectionStringSettings.IsGlobal => false;`
	`90`	`+ string IConnectionStringSettings.Name => name;`
	`91`	`+ bool IConnectionStringSettings.IsGlobal => false;`
`90`	`92`
`91`	`93`	`public string? ProviderName { get; set; }`
`92`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,9 @@ public virtual void Unload (`
`30`	`30`	`public abstract DateTime? GetLastSchemaUpdate(ConnectionSettings settings);`
`31`	`31`	`public abstract DbProviderFactory GetProviderFactory (string providerName );`
`32`	`32`
	`33`	`+ /// <param name="providerName">Provider name.</param>`
	`34`	`+ /// <param name="connectionString">Connection string must be resolved against password manager already.</param>`
	`35`	`+ /// <returns></returns>`
`33`	`36`	`public virtual IDataProvider GetDataProvider(string providerName, string connectionString)`
`34`	`37`	`{`
`35`	`38`	`return DataConnection.GetDataProvider(providerName, connectionString)`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,6 @@ public override DbProviderFactory GetProviderFactory(string providerName)`
`92`	`92`	`return SqlClientFactory.Instance;`
`93`	`93`	`}`
`94`	`94`
`95`		`-`
`96`	`95`	`public override IDataProvider GetDataProvider(string providerName, string connectionString)`
`97`	`96`	`{`
`98`	`97`	`// provider detector fails to detect Microsoft.Data.SqlClient`
Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,7 @@ public override List<ExplorerItem> GetSchemaAndBuildAssembly(IConnectionInfo cxI`
`197`	`197`	`[`
`198`	`198`	`settings.Connection.Provider,`
`199`	`199`	`settings.Connection.ProviderPath,`
`200`		`- settings.Connection.ConnectionString`
	`200`	`+ settings.Connection.GetFullConnectionString()`
`201`	`201`	`];`
`202`	`202`	`}`
`203`	`203`	`catch (Exception ex)`