Merge pull request #177 from aspnetboilerplate/hide-connection-string-info

hikalkan · web-flow · commit cd603496faf9 · 2018-01-29T09:34:34.000+03:00
Fixed #175 - Hide connection string from migrator output
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Migrator/MultiTenantMigrateExecuter.cs b/aspnet-core/src/AbpCompanyName.AbpProjectName.Migrator/MultiTenantMigrateExecuter.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Data.Common;
 using Abp.Data;
 using Abp.Dependency;
 using Abp.Domain.Repositories;
@@ -15,8 +16,7 @@ namespace AbpCompanyName.AbpProjectName.Migrator
 {
     public class MultiTenantMigrateExecuter : ITransientDependency
     {
-        public Log Log { get; private set; }
-
+        private readonly Log _log;
         private readonly AbpZeroDbMigrator _migrator;
         private readonly IRepository<Tenant> _tenantRepository;
         private readonly IDbPerTenantConnectionStringResolver _connectionStringResolver;
@@ -27,7 +27,7 @@ public MultiTenantMigrateExecuter(
             Log log,
             IDbPerTenantConnectionStringResolver connectionStringResolver)
         {
-            Log = log;
+            _log = log;
 
             _migrator = migrator;
             _tenantRepository = tenantRepository;
@@ -36,52 +36,52 @@ public MultiTenantMigrateExecuter(
 
         public bool Run(bool skipConnVerification)
         {
-            var hostConnStr = _connectionStringResolver.GetNameOrConnectionString(new ConnectionStringResolveArgs(MultiTenancySides.Host));
+            var hostConnStr = CensorConnectionString(_connectionStringResolver.GetNameOrConnectionString(new ConnectionStringResolveArgs(MultiTenancySides.Host)));
             if (hostConnStr.IsNullOrWhiteSpace())
             {
-                Log.Write("Configuration file should contain a connection string named 'Default'");
+                _log.Write("Configuration file should contain a connection string named 'Default'");
                 return false;
             }
 
-            Log.Write("Host database: " + ConnectionStringHelper.GetConnectionString(hostConnStr));
+            _log.Write("Host database: " + ConnectionStringHelper.GetConnectionString(hostConnStr));
             if (!skipConnVerification)
             {
-                Log.Write("Continue to migration for this host database and all tenants..? (Y/N): ");
+                _log.Write("Continue to migration for this host database and all tenants..? (Y/N): ");
                 var command = Console.ReadLine();
                 if (!command.IsIn("Y", "y"))
                 {
-                    Log.Write("Migration canceled.");
+                    _log.Write("Migration canceled.");
                     return false;
                 }
             }
 
-            Log.Write("HOST database migration started...");
+            _log.Write("HOST database migration started...");
 
             try
             {
                 _migrator.CreateOrMigrateForHost(SeedHelper.SeedHostDb);
             }
             catch (Exception ex)
             {
-                Log.Write("An error occured during migration of host database:");
-                Log.Write(ex.ToString());
-                Log.Write("Canceled migrations.");
+                _log.Write("An error occured during migration of host database:");
+                _log.Write(ex.ToString());
+                _log.Write("Canceled migrations.");
                 return false;
             }
 
-            Log.Write("HOST database migration completed.");
-            Log.Write("--------------------------------------------------------");
+            _log.Write("HOST database migration completed.");
+            _log.Write("--------------------------------------------------------");
 
             var migratedDatabases = new HashSet<string>();
             var tenants = _tenantRepository.GetAllList(t => t.ConnectionString != null && t.ConnectionString != "");
             for (var i = 0; i < tenants.Count; i++)
             {
                 var tenant = tenants[i];
-                Log.Write(string.Format("Tenant database migration started... ({0} / {1})", (i + 1), tenants.Count));
-                Log.Write("Name              : " + tenant.Name);
-                Log.Write("TenancyName       : " + tenant.TenancyName);
-                Log.Write("Tenant Id         : " + tenant.Id);
-                Log.Write("Connection string : " + SimpleStringCipher.Instance.Decrypt(tenant.ConnectionString));
+                _log.Write(string.Format("Tenant database migration started... ({0} / {1})", (i + 1), tenants.Count));
+                _log.Write("Name              : " + tenant.Name);
+                _log.Write("TenancyName       : " + tenant.TenancyName);
+                _log.Write("Tenant Id         : " + tenant.Id);
+                _log.Write("Connection string : " + SimpleStringCipher.Instance.Decrypt(tenant.ConnectionString));
 
                 if (!migratedDatabases.Contains(tenant.ConnectionString))
                 {
@@ -91,25 +91,41 @@ public bool Run(bool skipConnVerification)
                     }
                     catch (Exception ex)
                     {
-                        Log.Write("An error occured during migration of tenant database:");
-                        Log.Write(ex.ToString());
-                        Log.Write("Skipped this tenant and will continue for others...");
+                        _log.Write("An error occured during migration of tenant database:");
+                        _log.Write(ex.ToString());
+                        _log.Write("Skipped this tenant and will continue for others...");
                     }
 
                     migratedDatabases.Add(tenant.ConnectionString);
                 }
                 else
                 {
-                    Log.Write("This database has already migrated before (you have more than one tenant in same database). Skipping it....");
+                    _log.Write("This database has already migrated before (you have more than one tenant in same database). Skipping it....");
                 }
 
-                Log.Write(string.Format("Tenant database migration completed. ({0} / {1})", (i + 1), tenants.Count));
-                Log.Write("--------------------------------------------------------");
+                _log.Write(string.Format("Tenant database migration completed. ({0} / {1})", (i + 1), tenants.Count));
+                _log.Write("--------------------------------------------------------");
             }
 
-            Log.Write("All databases have been migrated.");
+            _log.Write("All databases have been migrated.");
 
             return true;
         }
+
+        private static string CensorConnectionString(string connectionString)
+        {
+            var builder = new DbConnectionStringBuilder { ConnectionString = connectionString };
+            var keysToMask = new[] { "password", "pwd", "user id", "uid" };
+
+            foreach (var key in keysToMask)
+            {
+                if (builder.ContainsKey(key))
+                {
+                    builder[key] = "*****";
+                }
+            }
+
+            return builder.ToString();
+        }
     }
 }
diff --git a/aspnet-core/src/AbpCompanyName.AbpProjectName.Migrator/Program.cs b/aspnet-core/src/AbpCompanyName.AbpProjectName.Migrator/Program.cs
@@ -9,7 +9,7 @@ namespace AbpCompanyName.AbpProjectName.Migrator
 {
     public class Program
     {
-        private static bool _quietMode = false;
+        private static bool _quietMode;
 
         public static void Main(string[] args)
         {
@@ -27,16 +27,18 @@ public static void Main(string[] args)
                 using (var migrateExecuter = bootstrapper.IocManager.ResolveAsDisposable<MultiTenantMigrateExecuter>())
                 {
                     var migrationSucceeded = migrateExecuter.Object.Run(_quietMode);
-                    // exit clean (with exit code 0) if migration is a success, otherwise exit with code 1
-                    var exitCode = Convert.ToInt32(!migrationSucceeded);
-
-                    Environment.Exit(exitCode);
-                }
-
-                if (!_quietMode)
-                {
-                    Console.WriteLine("Press ENTER to exit...");
-                    Console.ReadLine();
+                    
+                    if (_quietMode)
+                    {
+                        // exit clean (with exit code 0) if migration is a success, otherwise exit with code 1
+                        var exitCode = Convert.ToInt32(!migrationSucceeded);
+                        Environment.Exit(exitCode);
+                    }
+                    else
+                    {
+                        Console.WriteLine("Press ENTER to exit...");
+                        Console.ReadLine();
+                    }
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using System.Data.Common;`
`3`	`4`	`using Abp.Data;`
`4`	`5`	`using Abp.Dependency;`
`5`	`6`	`using Abp.Domain.Repositories;`
`@@ -15,8 +16,7 @@ namespace AbpCompanyName.AbpProjectName.Migrator`
`15`	`16`	`{`
`16`	`17`	`public class MultiTenantMigrateExecuter : ITransientDependency`
`17`	`18`	`{`
`18`		`- public Log Log { get; private set; }`
`19`		`-`
	`19`	`+ private readonly Log _log;`
`20`	`20`	`private readonly AbpZeroDbMigrator _migrator;`
`21`	`21`	`private readonly IRepository<Tenant> _tenantRepository;`
`22`	`22`	`private readonly IDbPerTenantConnectionStringResolver _connectionStringResolver;`
`@@ -27,7 +27,7 @@ public MultiTenantMigrateExecuter(`
`27`	`27`	`Log log,`
`28`	`28`	`IDbPerTenantConnectionStringResolver connectionStringResolver)`
`29`	`29`	`{`
`30`		`- Log = log;`
	`30`	`+ _log = log;`
`31`	`31`
`32`	`32`	`_migrator = migrator;`
`33`	`33`	`_tenantRepository = tenantRepository;`
`@@ -36,52 +36,52 @@ public MultiTenantMigrateExecuter(`
`36`	`36`
`37`	`37`	`public bool Run(bool skipConnVerification)`
`38`	`38`	`{`
`39`		`- var hostConnStr = _connectionStringResolver.GetNameOrConnectionString(new ConnectionStringResolveArgs(MultiTenancySides.Host));`
	`39`	`+ var hostConnStr = CensorConnectionString(_connectionStringResolver.GetNameOrConnectionString(new ConnectionStringResolveArgs(MultiTenancySides.Host)));`
`40`	`40`	`if (hostConnStr.IsNullOrWhiteSpace())`
`41`	`41`	`{`
`42`		`- Log.Write("Configuration file should contain a connection string named 'Default'");`
	`42`	`+ _log.Write("Configuration file should contain a connection string named 'Default'");`
`43`	`43`	`return false;`
`44`	`44`	`}`
`45`	`45`
`46`		`- Log.Write("Host database: " + ConnectionStringHelper.GetConnectionString(hostConnStr));`
	`46`	`+ _log.Write("Host database: " + ConnectionStringHelper.GetConnectionString(hostConnStr));`
`47`	`47`	`if (!skipConnVerification)`
`48`	`48`	`{`
`49`		`- Log.Write("Continue to migration for this host database and all tenants..? (Y/N): ");`
	`49`	`+ _log.Write("Continue to migration for this host database and all tenants..? (Y/N): ");`
`50`	`50`	`var command = Console.ReadLine();`
`51`	`51`	`if (!command.IsIn("Y", "y"))`
`52`	`52`	`{`
`53`		`- Log.Write("Migration canceled.");`
	`53`	`+ _log.Write("Migration canceled.");`
`54`	`54`	`return false;`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
`58`		`- Log.Write("HOST database migration started...");`
	`58`	`+ _log.Write("HOST database migration started...");`
`59`	`59`
`60`	`60`	`try`
`61`	`61`	`{`
`62`	`62`	`_migrator.CreateOrMigrateForHost(SeedHelper.SeedHostDb);`
`63`	`63`	`}`
`64`	`64`	`catch (Exception ex)`
`65`	`65`	`{`
`66`		`- Log.Write("An error occured during migration of host database:");`
`67`		`- Log.Write(ex.ToString());`
`68`		`- Log.Write("Canceled migrations.");`
	`66`	`+ _log.Write("An error occured during migration of host database:");`
	`67`	`+ _log.Write(ex.ToString());`
	`68`	`+ _log.Write("Canceled migrations.");`
`69`	`69`	`return false;`
`70`	`70`	`}`
`71`	`71`
`72`		`- Log.Write("HOST database migration completed.");`
`73`		`- Log.Write("--------------------------------------------------------");`
	`72`	`+ _log.Write("HOST database migration completed.");`
	`73`	`+ _log.Write("--------------------------------------------------------");`
`74`	`74`
`75`	`75`	`var migratedDatabases = new HashSet<string>();`
`76`	`76`	`var tenants = _tenantRepository.GetAllList(t => t.ConnectionString != null && t.ConnectionString != "");`
`77`	`77`	`for (var i = 0; i < tenants.Count; i++)`
`78`	`78`	`{`
`79`	`79`	`var tenant = tenants[i];`
`80`		`- Log.Write(string.Format("Tenant database migration started... ({0} / {1})", (i + 1), tenants.Count));`
`81`		`- Log.Write("Name : " + tenant.Name);`
`82`		`- Log.Write("TenancyName : " + tenant.TenancyName);`
`83`		`- Log.Write("Tenant Id : " + tenant.Id);`
`84`		`- Log.Write("Connection string : " + SimpleStringCipher.Instance.Decrypt(tenant.ConnectionString));`
	`80`	`+ _log.Write(string.Format("Tenant database migration started... ({0} / {1})", (i + 1), tenants.Count));`
	`81`	`+ _log.Write("Name : " + tenant.Name);`
	`82`	`+ _log.Write("TenancyName : " + tenant.TenancyName);`
	`83`	`+ _log.Write("Tenant Id : " + tenant.Id);`
	`84`	`+ _log.Write("Connection string : " + SimpleStringCipher.Instance.Decrypt(tenant.ConnectionString));`
`85`	`85`
`86`	`86`	`if (!migratedDatabases.Contains(tenant.ConnectionString))`
`87`	`87`	`{`
`@@ -91,25 +91,41 @@ public bool Run(bool skipConnVerification)`
`91`	`91`	`}`
`92`	`92`	`catch (Exception ex)`
`93`	`93`	`{`
`94`		`- Log.Write("An error occured during migration of tenant database:");`
`95`		`- Log.Write(ex.ToString());`
`96`		`- Log.Write("Skipped this tenant and will continue for others...");`
	`94`	`+ _log.Write("An error occured during migration of tenant database:");`
	`95`	`+ _log.Write(ex.ToString());`
	`96`	`+ _log.Write("Skipped this tenant and will continue for others...");`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`migratedDatabases.Add(tenant.ConnectionString);`
`100`	`100`	`}`
`101`	`101`	`else`
`102`	`102`	`{`
`103`		`- Log.Write("This database has already migrated before (you have more than one tenant in same database). Skipping it....");`
	`103`	`+ _log.Write("This database has already migrated before (you have more than one tenant in same database). Skipping it....");`
`104`	`104`	`}`
`105`	`105`
`106`		`- Log.Write(string.Format("Tenant database migration completed. ({0} / {1})", (i + 1), tenants.Count));`
`107`		`- Log.Write("--------------------------------------------------------");`
	`106`	`+ _log.Write(string.Format("Tenant database migration completed. ({0} / {1})", (i + 1), tenants.Count));`
	`107`	`+ _log.Write("--------------------------------------------------------");`
`108`	`108`	`}`
`109`	`109`
`110`		`- Log.Write("All databases have been migrated.");`
	`110`	`+ _log.Write("All databases have been migrated.");`
`111`	`111`
`112`	`112`	`return true;`
`113`	`113`	`}`
	`114`	`+`
	`115`	`+ private static string CensorConnectionString(string connectionString)`
	`116`	`+ {`
	`117`	`+ var builder = new DbConnectionStringBuilder { ConnectionString = connectionString };`
	`118`	`+ var keysToMask = new[] { "password", "pwd", "user id", "uid" };`
	`119`	`+`
	`120`	`+ foreach (var key in keysToMask)`
	`121`	`+ {`
	`122`	`+ if (builder.ContainsKey(key))`
	`123`	`+ {`
	`124`	`+ builder[key] = "*****";`
	`125`	`+ }`
	`126`	`+ }`
	`127`	`+`
	`128`	`+ return builder.ToString();`
	`129`	`+ }`
`114`	`130`	`}`
`115`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace AbpCompanyName.AbpProjectName.Migrator`
`9`	`9`	`{`
`10`	`10`	`public class Program`
`11`	`11`	`{`
`12`		`- private static bool _quietMode = false;`
	`12`	`+ private static bool _quietMode;`
`13`	`13`
`14`	`14`	`public static void Main(string[] args)`
`15`	`15`	`{`
`@@ -27,16 +27,18 @@ public static void Main(string[] args)`
`27`	`27`	`using (var migrateExecuter = bootstrapper.IocManager.ResolveAsDisposable<MultiTenantMigrateExecuter>())`
`28`	`28`	`{`
`29`	`29`	`var migrationSucceeded = migrateExecuter.Object.Run(_quietMode);`
`30`		`- // exit clean (with exit code 0) if migration is a success, otherwise exit with code 1`
`31`		`- var exitCode = Convert.ToInt32(!migrationSucceeded);`
`32`		`-`
`33`		`- Environment.Exit(exitCode);`
`34`		`- }`
`35`		`-`
`36`		`- if (!_quietMode)`
`37`		`- {`
`38`		`- Console.WriteLine("Press ENTER to exit...");`
`39`		`- Console.ReadLine();`
	`30`	`+`
	`31`	`+ if (_quietMode)`
	`32`	`+ {`
	`33`	`+ // exit clean (with exit code 0) if migration is a success, otherwise exit with code 1`
	`34`	`+ var exitCode = Convert.ToInt32(!migrationSucceeded);`
	`35`	`+ Environment.Exit(exitCode);`
	`36`	`+ }`
	`37`	`+ else`
	`38`	`+ {`
	`39`	`+ Console.WriteLine("Press ENTER to exit...");`
	`40`	`+ Console.ReadLine();`
	`41`	`+ }`
`40`	`42`	`}`
`41`	`43`	`}`
`42`	`44`	`}`