Enable column encryption setting (#908)

* Enable the Column Encryption advanced security connection setting and add supporting tests.
microsoft · Jan 23, 2020 · 7b102df · 7b102df
1 parent 1577a0b
commit 7b102df
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 5 deletions.
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs b/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs
@@ -1142,6 +1142,20 @@ public static SqlConnectionStringBuilder CreateConnectionStringBuilder(Connectio
                         throw new ArgumentException(SR.ConnectionServiceConnStringInvalidAuthType(connectionDetails.AuthenticationType));
                 }
             }
+            if (!string.IsNullOrEmpty(connectionDetails.ColumnEncryptionSetting))
+            {
+                switch (connectionDetails.ColumnEncryptionSetting.ToUpper())
+                {
+                    case "ENABLED":
+                        connectionBuilder.ColumnEncryptionSetting = SqlConnectionColumnEncryptionSetting.Enabled;
+                        break;
+                    case "DISABLED":
+                        connectionBuilder.ColumnEncryptionSetting = SqlConnectionColumnEncryptionSetting.Disabled;
+                        break;
+                    default:
+                        throw new ArgumentException(SR.ConnectionServiceConnStringInvalidColumnEncryptionSetting(connectionDetails.ColumnEncryptionSetting));
+                }
+            }
             if (connectionDetails.Encrypt.HasValue)
             {
                 connectionBuilder.Encrypt = connectionDetails.Encrypt.Value;
@@ -1313,6 +1327,7 @@ public ConnectionDetails ParseConnectionString(string connectionString)
                 ConnectTimeout = builder.ConnectTimeout,
                 CurrentLanguage = builder.CurrentLanguage,
                 DatabaseName = builder.InitialCatalog,
+                ColumnEncryptionSetting = builder.ColumnEncryptionSetting.ToString(),
                 Encrypt = builder.Encrypt,
                 FailoverPartner = builder.FailoverPartner,
                 LoadBalanceTimeout = builder.LoadBalanceTimeout,

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs b/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetails.cs
@@ -99,6 +99,22 @@ public string AuthenticationType
             }
         }
 
+        /// <summary>
+        /// Gets or sets a value that specifies that Always Encrypted functionality is enabled in a connection.
+        /// </summary>
+        public string ColumnEncryptionSetting
+        {
+            get
+            {
+                return GetOptionValue<string>("columnEncryptionSetting");
+            }
+
+            set
+            {
+                SetOptionValue("columnEncryptionSetting", value);
+            }
+        }
+
         /// <summary>
         /// Gets or sets a Boolean value that indicates whether SQL Server uses SSL encryption for all data sent between the client and server if the server has a certificate installed.
         /// </summary>

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetailsExtensions.cs b/src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionDetailsExtensions.cs
@@ -22,6 +22,7 @@ public static ConnectionDetails Clone(this ConnectionDetails details)
                 UserName = details.UserName,
                 Password = details.Password,
                 AuthenticationType = details.AuthenticationType,
+                ColumnEncryptionSetting = details.ColumnEncryptionSetting,
                 Encrypt = details.Encrypt,
                 TrustServerCertificate = details.TrustServerCertificate,
                 PersistSecurityInfo = details.PersistSecurityInfo,

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs
@@ -2987,6 +2987,11 @@ public static string ConnectionServiceConnStringInvalidAuthType(string authType)
             return Keys.GetString(Keys.ConnectionServiceConnStringInvalidAuthType, authType);
         }
 
+        public static string ConnectionServiceConnStringInvalidColumnEncryptionSetting(string columnEncryptionSetting)
+        {
+            return Keys.GetString(Keys.ConnectionServiceConnStringInvalidColumnEncryptionSetting, columnEncryptionSetting);
+        }
+
         public static string ConnectionServiceConnStringInvalidIntent(string intent)
         {
             return Keys.GetString(Keys.ConnectionServiceConnStringInvalidIntent, intent);
@@ -3160,6 +3165,9 @@ public class Keys
             public const string ConnectionServiceConnStringInvalidAuthType = "ConnectionServiceConnStringInvalidAuthType";
 
 
+            public const string ConnectionServiceConnStringInvalidColumnEncryptionSetting = "ConnectionServiceConnStringInvalidColumnEncryptionSetting";
+
+
             public const string ConnectionServiceConnStringInvalidIntent = "ConnectionServiceConnStringInvalidIntent";
 
 

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx
@@ -139,7 +139,12 @@
     <value>Invalid value &apos;{0}&apos; for AuthenticationType.  Valid values are &apos;Integrated&apos; and &apos;SqlLogin&apos;.</value>
     <comment>.
  Parameters: 0 - authType (string) </comment>
-  </data>
+  </data>
+  <data name="ConnectionServiceConnStringInvalidColumnEncryptionSetting" xml:space="preserve">
+    <value>Invalid value &apos;{0}&apos; for ComlumEncryption. Valid values are &apos;Enabled&apos; and &apos;Disabled&apos;.</value>
+    <comment>.
+ Parameters: 0 - columnEncryptionSetting (string) </comment>
+  </data>
   <data name="ConnectionServiceConnStringInvalidIntent" xml:space="preserve">
     <value>Invalid value &apos;{0}&apos; for ApplicationIntent. Valid values are &apos;ReadWrite&apos; and &apos;ReadOnly&apos;.</value>
     <comment>.

diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings
@@ -33,6 +33,8 @@ ConnectionServiceDbErrorDefaultNotConnected(string uri) = Specified URI '{0}' do
 
 ConnectionServiceConnStringInvalidAuthType(string authType) = Invalid value '{0}' for AuthenticationType.  Valid values are 'Integrated' and 'SqlLogin'.
 
+ConnectionServiceConnStringInvalidColumnEncryptionSetting(string columnEncryptionSetting) = Invalid value '{0}' for ComlumEncryption. Valid values are 'Enabled' and 'Disabled'.
+
 ConnectionServiceConnStringInvalidIntent(string intent) = Invalid value '{0}' for ApplicationIntent. Valid values are 'ReadWrite' and 'ReadOnly'.
 
 ConnectionServiceConnectionCanceled = Connection canceled

diff --git a/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Connection/ConnectionDetailsTests.cs b/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Connection/ConnectionDetailsTests.cs
@@ -44,6 +44,7 @@ public void ConnectionDetailsWithoutAnyOptionShouldReturnNullOrDefaultForOptions
             Assert.Equal(details.MaxPoolSize, expectedForInt);
             Assert.Equal(details.MinPoolSize, expectedForInt);
             Assert.Equal(details.PacketSize, expectedForInt);
+            Assert.Equal(details.ColumnEncryptionSetting, expectedForStrings);
             Assert.Equal(details.Encrypt, expectedForBoolean);
             Assert.Equal(details.MultipleActiveResultSets, expectedForBoolean);
             Assert.Equal(details.MultiSubnetFailover, expectedForBoolean);
@@ -81,6 +82,7 @@ public void ConnectionDetailsPropertySettersShouldSetOptionValuesCorrectly()
             details.MaxPoolSize = expectedForInt + index++;
             details.MinPoolSize = expectedForInt + index++;
             details.PacketSize = expectedForInt + index++;
+            details.ColumnEncryptionSetting = expectedForStrings + index++;
             details.Encrypt = (index++ % 2 == 0);
             details.MultipleActiveResultSets = (index++ % 2 == 0);
             details.MultiSubnetFailover = (index++ % 2 == 0);
@@ -110,6 +112,7 @@ public void ConnectionDetailsPropertySettersShouldSetOptionValuesCorrectly()
             Assert.Equal(details.MaxPoolSize, expectedForInt + index++);
             Assert.Equal(details.MinPoolSize, expectedForInt + index++);
             Assert.Equal(details.PacketSize, expectedForInt + index++);
+            Assert.Equal(details.ColumnEncryptionSetting, expectedForStrings + index++);
             Assert.Equal(details.Encrypt, (index++ % 2 == 0));
             Assert.Equal(details.MultipleActiveResultSets, (index++ % 2 == 0));
             Assert.Equal(details.MultiSubnetFailover, (index++ % 2 == 0));
@@ -148,6 +151,7 @@ public void ConnectionDetailsOptionsShouldBeDefinedInConnectionProviderOptions()
             details.MaxPoolSize = expectedForInt + index++;
             details.MinPoolSize = expectedForInt + index++;
             details.PacketSize = expectedForInt + index++;
+            details.ColumnEncryptionSetting = expectedForStrings + index++;
             details.Encrypt = (index++ % 2 == 0);
             details.MultipleActiveResultSets = (index++ % 2 == 0);
             details.MultiSubnetFailover = (index++ % 2 == 0);

diff --git a/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Connection/ConnectionServiceTests.cs b/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Connection/ConnectionServiceTests.cs
@@ -501,6 +501,14 @@ public async Task ConnectingWithNullParametersObjectYieldsErrorMessage()
         [InlineData("AuthenticationType", "SqlLogin", "")]
         [InlineData("Encrypt", true, "Encrypt")]
         [InlineData("Encrypt", false, "Encrypt")]
+        [InlineData("ColumnEncryptionSetting", "Enabled", "Column Encryption Setting=Enabled")]
+        [InlineData("ColumnEncryptionSetting", "Disabled", "Column Encryption Setting=Disabled")]
+        [InlineData("ColumnEncryptionSetting", "enabled", "Column Encryption Setting=Enabled")]
+        [InlineData("ColumnEncryptionSetting", "disabled", "Column Encryption Setting=Disabled")]
+        [InlineData("ColumnEncryptionSetting", "ENABLED", "Column Encryption Setting=Enabled")]
+        [InlineData("ColumnEncryptionSetting", "DISABLED", "Column Encryption Setting=Disabled")]
+        [InlineData("ColumnEncryptionSetting", "eNaBlEd", "Column Encryption Setting=Enabled")]
+        [InlineData("ColumnEncryptionSetting", "DiSaBlEd", "Column Encryption Setting=Disabled")]
         [InlineData("TrustServerCertificate", true, "TrustServerCertificate")]
         [InlineData("TrustServerCertificate", false, "TrustServerCertificate")]
         [InlineData("PersistSecurityInfo", true, "Persist Security Info")]
@@ -545,13 +553,16 @@ public void ConnectingWithOptionalParametersBuildsConnectionString(string proper
         }
 
         /// <summary>
-        /// Build connection string with an invalid auth type
+        /// Build connection string with an invalid property type
         /// </summary>
-        [Fact]
-        public void BuildConnectionStringWithInvalidAuthType()
+        [Theory]
+        [InlineData("AuthenticationType", "NotAValidAuthType")]
+        [InlineData("ColumnEncryptionSetting", "NotAValidColumnEncryptionSetting")]
+        public void BuildConnectionStringWithInvalidOptions(string propertyName, object propertyValue)
         {
             ConnectionDetails details = TestObjects.GetTestConnectionDetails();
-            details.AuthenticationType = "NotAValidAuthType";
+            PropertyInfo info = details.GetType().GetProperty(propertyName);
+            info.SetValue(details, propertyValue);
             Assert.Throws<ArgumentException>(() => ConnectionService.BuildConnectionString(details));
         }