throwing new mysql exception mssg with no sensitive information. (#1823)

* throwing new mysql exception mssg with no sensitive information. * PR Fixes 1
dotnet · Feb 14, 2022 · e0f2448 · e0f2448
1 parent 4901144
commit e0f2448
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/src/Scaffolding/VS.Web.CG.EFCore/EntityFrameworkModelProcessor.cs b/src/Scaffolding/VS.Web.CG.EFCore/EntityFrameworkModelProcessor.cs
@@ -8,6 +8,7 @@
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 using Microsoft.Build.Locator;
 using Microsoft.CodeAnalysis;
@@ -18,12 +19,14 @@
 using Microsoft.DotNet.Scaffolding.Shared.ProjectModel;
 using Microsoft.VisualStudio.Web.CodeGeneration.DotNet;
 using Microsoft.DotNet.Scaffolding.Shared.Project;
+using System.Collections;
 
 namespace Microsoft.VisualStudio.Web.CodeGeneration.EntityFrameworkCore
 {
     internal class EntityFrameworkModelProcessor
     {
         private const string EFSqlServerPackageName = "Microsoft.EntityFrameworkCore.SqlServer";
+        private const string MySqlException = nameof(MySqlException);
         private const string NewDbContextFolderName = "Data";
         private bool _useSqlite;
         private string _dbContextFullTypeName;
@@ -554,6 +557,19 @@ private DbContext TryCreateContextUsingAppCode(Type dbContextType, Type startupT
             }
             catch (Exception ex)
             {
+                var exceptionType = ex.GetType();
+                // if MySQL exception with error code 1045, discard error message since it contains sensitive dev information
+                if (exceptionType.Name.Equals(MySqlException, StringComparison.OrdinalIgnoreCase) || exceptionType.FullName.Contains(MySqlException, StringComparison.OrdinalIgnoreCase))
+                {
+                    if (ex.Data.Keys.Count > 0 &&
+                        ex.Data["Server Error Code"] != null &&
+                        //based on error code 1045 from here https://dev.mysql.com/doc/
+                        ex.Data["Server Error Code"].ToString().Equals("1045", StringComparison.OrdinalIgnoreCase))
+                    {
+                        ex = new Exception($"{MessageStrings.MySQLDbContextExceptionMssg}\n");
+                        throw ex;
+                    }
+                }
                 throw ex.Unwrap(_logger);
             }
         }

diff --git a/src/Scaffolding/VS.Web.CG.EFCore/MessageStrings.Designer.cs b/src/Scaffolding/VS.Web.CG.EFCore/MessageStrings.Designer.cs
diff --git a/src/Scaffolding/VS.Web.CG.EFCore/MessageStrings.resx b/src/Scaffolding/VS.Web.CG.EFCore/MessageStrings.resx
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -168,6 +168,9 @@
   <data name="ModelTypeNotFound" xml:space="preserve">
     <value>Could not get the reflection type for Model : {0}</value>
   </data>
+  <data name="MySQLDbContextExceptionMssg" xml:space="preserve">
+    <value>Unable to get DbContext Instance. Access denied for user (MySQL db).</value>
+  </data>
   <data name="NoEntityOfTypeInDbContext" xml:space="preserve">
     <value>There is no entity type {0} on DbContext {1}</value>
   </data>