diff --git a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/ColumnSensitivity.xml b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/ColumnSensitivity.xml
index 8f1fcfeb99..2c43af620c 100644
--- a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/ColumnSensitivity.xml
+++ b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/ColumnSensitivity.xml
@@ -3,15 +3,14 @@
Represents the Data Classification Sensitivity Information for columns as configured in Database.
- To be added.
Initializes a new instance of the
+
Returns the list of sensitivity properties as received from Server for this 'ColumnSensitivity' information
List of sensitivity properties.
- To be added.
diff --git a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/InformationType.xml b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/InformationType.xml
index db93a31054..ff2dca0c3c 100644
--- a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/InformationType.xml
+++ b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/InformationType.xml
@@ -3,20 +3,19 @@
Represents the Data Classification Information Types as received from SQL Server for the active 'SqlDataReader'
- To be added.
Initializes a new instance of the
+
Gets the ID for this 'InformationType' object
- ID of InformationType.
- To be added.
+ ID of Information Type.
Gets the name for this 'InformationType' object
- Name of InformationType.
- To be added.
+ Name of Information Type.
diff --git a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/Label.xml b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/Label.xml
index 6ccdecde4d..7d75923abe 100644
--- a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/Label.xml
+++ b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/Label.xml
@@ -3,20 +3,19 @@
Represents the Data Classification Labels as received from SQL Server for the active 'SqlDataReader'
- To be added.
Initializes a new instance of the
+
Gets the ID for this 'Label' object
ID of label.
- To be added.
Gets the name for this 'Label' object
Name of label.
- To be added.
diff --git a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityClassification.xml b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityClassification.xml
index e9c6e90b2e..83707533b1 100644
--- a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityClassification.xml
+++ b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityClassification.xml
@@ -3,26 +3,47 @@
Provides the functionlity to retrieve Sensitivity Classification data as received from SQL Server for the active 'SqlDataReader'
- To be added.
Returns the column sensitivity for this 'SensitivityClassification' Object
List of column sensitivities.
- To be added.
Returns the information types collection for this 'SensitivityClassification' Object
List of information types.
- To be added.
Returns the labels collection for this 'SensitivityClassification' Object
List of labels.
- To be added.
+
+ Returns the relative sensitivity rank for the query associated with the active 'SqlDataReader'.
+ Relative sensitivity ranking for this query.
+
+
+
+
+
+
- Initializes a new instance of the
+ Initializes a new instance of the
+
diff --git a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityProperty.xml b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityProperty.xml
index b54c8384b9..5fb61f161c 100644
--- a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityProperty.xml
+++ b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityProperty.xml
@@ -3,20 +3,42 @@
Represents the Data Classification Sensitivity Information for columns as configured in Database.
- To be added.
Initializes a new instance of the
+
Returns the information type for this 'SensitivityProperty' Object
Information type for this SensitivityProperty.
- To be added.
Returns the label for this 'SensitivityProperty' Object
Label for this SensitivityProperty.
- To be added.
+
+ Returns the sensitivity rank for this 'SensitivityProperty' Object
+ Sensitivity rank for this SensitivityProperty.
+
+
+
+
+
+
diff --git a/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityRank.xml b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityRank.xml
new file mode 100644
index 0000000000..41e215e29e
--- /dev/null
+++ b/doc/snippets/Microsoft.Data.SqlClient.DataClassification/SensitivityRank.xml
@@ -0,0 +1,17 @@
+
+
+
+
+
+ A relative ranking of the sensitivity of a query or of a column that is part of percolumn data.
+ It is an identifier based on a predefined set of values which define sensitivity rank. Used by other services like Advanced Threat Protection to detect anomalies based on their rank.
+
+
+ No sensitivity rank defined.
+ Corresponds to rank value of 0.
+ Corresponds to rank value of 10.
+ Corresponds to rank value 20.
+ Corresponds to rank value 30.
+ Corresponds to rank value 40.
+
+
diff --git a/src/Microsoft.Data.SqlClient/netcore/ref/Microsoft.Data.SqlClient.cs b/src/Microsoft.Data.SqlClient/netcore/ref/Microsoft.Data.SqlClient.cs
index 8b53ecfdf6..514a35ad36 100644
--- a/src/Microsoft.Data.SqlClient/netcore/ref/Microsoft.Data.SqlClient.cs
+++ b/src/Microsoft.Data.SqlClient/netcore/ref/Microsoft.Data.SqlClient.cs
@@ -1895,26 +1895,46 @@ public Label(string name, string id) { }
/// labels, System.Collections.Generic.IList informationTypes, System.Collections.Generic.IList columnSensitivity) { }
+ public SensitivityClassification(System.Collections.Generic.IList labels, System.Collections.Generic.IList informationTypes, System.Collections.Generic.IList columnSensitivity, SensitivityRank sensitivityRank) { }
/// ColumnSensitivities { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
/// InformationTypes { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
/// Labels { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
+ ///
@@ -2610,7 +2609,7 @@ internal void OnFeatureExtAck(int featureId, byte[] data)
throw SQL.ParsingError(ParsingErrorState.CorruptedTdsStream);
}
byte supportedDataClassificationVersion = data[0];
- if ((0 == supportedDataClassificationVersion) || (supportedDataClassificationVersion > TdsEnums.MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION))
+ if ((0 == supportedDataClassificationVersion) || (supportedDataClassificationVersion > TdsEnums.DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED))
{
SqlClientEventSource.Log.TraceEvent(" {0}, Invalid version number for DATACLASSIFICATION", ObjectID);
throw SQL.ParsingErrorValue(ParsingErrorState.DataClassificationInvalidVersion, supportedDataClassificationVersion);
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsEnums.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsEnums.cs
index 25dbb5dd76..043a70669d 100644
--- a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsEnums.cs
+++ b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsEnums.cs
@@ -933,7 +933,8 @@ internal enum FedAuthInfoId : byte
// Data Classification constants
internal const byte DATA_CLASSIFICATION_NOT_ENABLED = 0x00;
- internal const byte MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION = 0x01;
+ internal const byte DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT = 0x01;
+ internal const byte DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED = 0x02;
// Needed for UapAot, since we cannot use Enum.GetName() on SniContext.
// Enum.GetName() uses reflection, which is blocked on UapAot for internal types
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs
index 9070b88fa6..a1d424120e 100644
--- a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs
+++ b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs
@@ -471,13 +471,13 @@ internal void Connect(
uint result = _physicalStateObj.SniGetConnectionId(ref _connHandler._clientConnectionId);
Debug.Assert(result == TdsEnums.SNI_SUCCESS, "Unexpected failure state upon calling SniGetConnectionId");
-
+
if (null == _connHandler.pendingSQLDNSObject)
{
// for DNS Caching phase 1
_physicalStateObj.AssignPendingDNSInfo(serverInfo.UserProtocol, FQDNforDNSCahce, ref _connHandler.pendingSQLDNSObject);
}
-
+
SqlClientEventSource.Log.TraceEvent(" Sending prelogin handshake", "SEC");
SendPreLoginHandshake(instanceName, encrypt);
@@ -3136,7 +3136,7 @@ private bool TryProcessFeatureExtAck(TdsParserStateObject stateObj)
ret = SQLFallbackDNSCache.Instance.DeleteDNSInfo(FQDNforDNSCahce);
}
- if ( _connHandler.IsSQLDNSCachingSupported && _connHandler.pendingSQLDNSObject != null
+ if (_connHandler.IsSQLDNSCachingSupported && _connHandler.pendingSQLDNSObject != null
&& !SQLFallbackDNSCache.Instance.IsDuplicate(_connHandler.pendingSQLDNSObject))
{
ret = SQLFallbackDNSCache.Instance.AddDNSInfo(_connHandler.pendingSQLDNSObject);
@@ -3313,7 +3313,7 @@ private bool TryReadSensitivityInformationType(TdsParserStateObject stateObj, ou
private bool TryProcessDataClassification(TdsParserStateObject stateObj, out SensitivityClassification sensitivityClassification)
{
- if (this.DataClassificationVersion == 0)
+ if (DataClassificationVersion == 0)
{
throw SQL.ParsingError(ParsingErrorState.DataClassificationNotExpected);
}
@@ -3321,17 +3321,14 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
sensitivityClassification = null;
// get the labels
- UInt16 numLabels;
- if (!stateObj.TryReadUInt16(out numLabels))
+ if (!stateObj.TryReadUInt16(out ushort numLabels))
{
return false;
}
var labels = new List(numLabels);
- for (UInt16 i = 0; i < numLabels; i++)
+ for (ushort i = 0; i < numLabels; i++)
{
- string label;
- string id;
- if (!TryReadSensitivityLabel(stateObj, out label, out id))
+ if (!TryReadSensitivityLabel(stateObj, out string label, out string id))
{
return false;
}
@@ -3339,49 +3336,53 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
}
// get the information types
- UInt16 numInformationTypes;
- if (!stateObj.TryReadUInt16(out numInformationTypes))
+ if (!stateObj.TryReadUInt16(out ushort numInformationTypes))
{
return false;
}
var informationTypes = new List(numInformationTypes);
- for (UInt16 i = 0; i < numInformationTypes; i++)
+ for (ushort i = 0; i < numInformationTypes; i++)
{
- string informationType;
- string id;
- if (!TryReadSensitivityInformationType(stateObj, out informationType, out id))
+ if (!TryReadSensitivityInformationType(stateObj, out string informationType, out string id))
{
return false;
}
informationTypes.Add(new InformationType(informationType, id));
}
+ // get sensitivity rank
+ int sensitivityRank = (int)SensitivityRank.NOT_DEFINED;
+ if (DataClassificationVersion > TdsEnums.DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT)
+ {
+ if (!stateObj.TryReadInt32(out sensitivityRank) || !Enum.IsDefined(typeof(SensitivityRank), sensitivityRank))
+ {
+ return false;
+ }
+ }
+
// get the per column classification data (corresponds to order of output columns for query)
- UInt16 numResultColumns;
- if (!stateObj.TryReadUInt16(out numResultColumns))
+ if (!stateObj.TryReadUInt16(out ushort numResultColumns))
{
return false;
}
var columnSensitivities = new List(numResultColumns);
- for (UInt16 columnNum = 0; columnNum < numResultColumns; columnNum++)
+ for (ushort columnNum = 0; columnNum < numResultColumns; columnNum++)
{
// get sensitivity properties for all the different sources which were used in generating the column output
- UInt16 numSources;
- if (!stateObj.TryReadUInt16(out numSources))
+ if (!stateObj.TryReadUInt16(out ushort numSources))
{
return false;
}
var sensitivityProperties = new List(numSources);
- for (UInt16 sourceNum = 0; sourceNum < numSources; sourceNum++)
+ for (ushort sourceNum = 0; sourceNum < numSources; sourceNum++)
{
// get the label index and then lookup label to use for source
- UInt16 labelIndex;
- if (!stateObj.TryReadUInt16(out labelIndex))
+ if (!stateObj.TryReadUInt16(out ushort labelIndex))
{
return false;
}
Label label = null;
- if (labelIndex != UInt16.MaxValue)
+ if (labelIndex != ushort.MaxValue)
{
if (labelIndex >= labels.Count)
{
@@ -3391,13 +3392,12 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
}
// get the information type index and then lookup information type to use for source
- UInt16 informationTypeIndex;
- if (!stateObj.TryReadUInt16(out informationTypeIndex))
+ if (!stateObj.TryReadUInt16(out ushort informationTypeIndex))
{
return false;
}
InformationType informationType = null;
- if (informationTypeIndex != UInt16.MaxValue)
+ if (informationTypeIndex != ushort.MaxValue)
{
if (informationTypeIndex >= informationTypes.Count)
{
@@ -3406,14 +3406,23 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
informationType = informationTypes[informationTypeIndex];
}
- // add sentivity properties for the source
- sensitivityProperties.Add(new SensitivityProperty(label, informationType));
+ // get sensitivity rank
+ int sensitivityRankProperty = (int)SensitivityRank.NOT_DEFINED;
+ if (DataClassificationVersion > TdsEnums.DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT)
+ {
+ if (!stateObj.TryReadInt32(out sensitivityRankProperty) || !Enum.IsDefined(typeof(SensitivityRank), sensitivityRankProperty))
+ {
+ return false;
+ }
+ }
+
+ // add sensitivity properties for the source
+ sensitivityProperties.Add(new SensitivityProperty(label, informationType, (SensitivityRank)sensitivityRankProperty));
}
columnSensitivities.Add(new ColumnSensitivity(sensitivityProperties));
}
- sensitivityClassification = new SensitivityClassification(labels, informationTypes, columnSensitivities);
-
+ sensitivityClassification = new SensitivityClassification(labels, informationTypes, columnSensitivities, (SensitivityRank)sensitivityRank);
return true;
}
@@ -7829,7 +7838,7 @@ internal int WriteFedAuthFeatureRequest(FederatedAuthenticationFeatureExtensionD
// Write Feature ID, length of the version# field and Sensitivity Classification Version#
_physicalStateObj.WriteByte(TdsEnums.FEATUREEXT_DATACLASSIFICATION);
WriteInt(1, _physicalStateObj);
- _physicalStateObj.WriteByte(TdsEnums.MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION);
+ _physicalStateObj.WriteByte(TdsEnums.DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED);
}
return len; // size of data written
diff --git a/src/Microsoft.Data.SqlClient/netfx/ref/Microsoft.Data.SqlClient.cs b/src/Microsoft.Data.SqlClient/netfx/ref/Microsoft.Data.SqlClient.cs
index 69dbf03312..1b044d5373 100644
--- a/src/Microsoft.Data.SqlClient/netfx/ref/Microsoft.Data.SqlClient.cs
+++ b/src/Microsoft.Data.SqlClient/netfx/ref/Microsoft.Data.SqlClient.cs
@@ -5,7 +5,7 @@
[assembly: System.Resources.NeutralResourcesLanguageAttribute("en-US")]
namespace Microsoft.Data
{
- /// sensitivityProperties) { }
- /// SensitivityProperties { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
}
- /// labels, System.Collections.Generic.IList informationTypes, System.Collections.Generic.IList columnSensitivity) { }
- /// labels, System.Collections.Generic.IList informationTypes, System.Collections.Generic.IList columnSensitivity, SensitivityRank sensitivityRank) { }
+ /// ColumnSensitivities { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
- /// InformationTypes { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
- /// Labels { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
+ ///
@@ -3063,7 +3062,7 @@ internal void OnFeatureExtAck(int featureId, byte[] data)
throw SQL.ParsingError(ParsingErrorState.CorruptedTdsStream);
}
byte supportedDataClassificationVersion = data[0];
- if ((0 == supportedDataClassificationVersion) || (supportedDataClassificationVersion > TdsEnums.MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION))
+ if ((0 == supportedDataClassificationVersion) || (supportedDataClassificationVersion > TdsEnums.DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED))
{
SqlClientEventSource.Log.TraceEvent(" {0}, Invalid version number for DATACLASSIFICATION", ObjectID);
throw SQL.ParsingErrorValue(ParsingErrorState.DataClassificationInvalidVersion, supportedDataClassificationVersion);
diff --git a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsEnums.cs b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsEnums.cs
index eaba0b9cc8..a444991ddb 100644
--- a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsEnums.cs
+++ b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsEnums.cs
@@ -938,7 +938,8 @@ internal enum FedAuthInfoId : byte
// Data Classification constants
internal const byte DATA_CLASSIFICATION_NOT_ENABLED = 0x00;
- internal const byte MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION = 0x01;
+ internal const byte DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT = 0x01;
+ internal const byte DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED = 0x02;
// TCE Related constants
internal const byte MAX_SUPPORTED_TCE_VERSION = 0x02; // max version
diff --git a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs
index 4f5fd8a2e1..795a0ff841 100644
--- a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs
+++ b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs
@@ -623,7 +623,7 @@ internal void Connect(ServerInfo serverInfo,
UInt32 result = SNINativeMethodWrapper.SniGetConnectionId(_physicalStateObj.Handle, ref _connHandler._clientConnectionId);
Debug.Assert(result == TdsEnums.SNI_SUCCESS, "Unexpected failure state upon calling SniGetConnectionId");
-
+
// for DNS Caching phase 1
AssignPendingDNSInfo(serverInfo.UserProtocol, FQDNforDNSCahce);
@@ -705,12 +705,12 @@ internal void AssignPendingDNSInfo(string userProtocol, string DNSCacheKey)
if (string.IsNullOrEmpty(userProtocol))
{
-
+
result = SNINativeMethodWrapper.SniGetProviderNumber(_physicalStateObj.Handle, ref providerNumber);
Debug.Assert(result == TdsEnums.SNI_SUCCESS, "Unexpected failure state upon calling SniGetProviderNumber");
isTcpProtocol = (providerNumber == SNINativeMethodWrapper.ProviderEnum.TCP_PROV);
}
- else if (userProtocol == TdsEnums.TCP)
+ else if (userProtocol == TdsEnums.TCP)
{
isTcpProtocol = true;
}
@@ -3558,7 +3558,7 @@ private bool TryProcessFeatureExtAck(TdsParserStateObject stateObj)
ret = SQLFallbackDNSCache.Instance.DeleteDNSInfo(FQDNforDNSCahce);
}
- if ( _connHandler.IsSQLDNSCachingSupported && _connHandler.pendingSQLDNSObject != null
+ if (_connHandler.IsSQLDNSCachingSupported && _connHandler.pendingSQLDNSObject != null
&& !SQLFallbackDNSCache.Instance.IsDuplicate(_connHandler.pendingSQLDNSObject))
{
ret = SQLFallbackDNSCache.Instance.AddDNSInfo(_connHandler.pendingSQLDNSObject);
@@ -3734,7 +3734,7 @@ private bool TryReadSensitivityInformationType(TdsParserStateObject stateObj, ou
private bool TryProcessDataClassification(TdsParserStateObject stateObj, out SensitivityClassification sensitivityClassification)
{
- if (this.DataClassificationVersion == 0)
+ if (DataClassificationVersion == 0)
{
throw SQL.ParsingError(ParsingErrorState.DataClassificationNotExpected);
}
@@ -3742,17 +3742,14 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
sensitivityClassification = null;
// get the labels
- UInt16 numLabels;
- if (!stateObj.TryReadUInt16(out numLabels))
+ if (!stateObj.TryReadUInt16(out ushort numLabels))
{
return false;
}
var labels = new List(numLabels);
- for (UInt16 i = 0; i < numLabels; i++)
+ for (ushort i = 0; i < numLabels; i++)
{
- string label;
- string id;
- if (!TryReadSensitivityLabel(stateObj, out label, out id))
+ if (!TryReadSensitivityLabel(stateObj, out string label, out string id))
{
return false;
}
@@ -3760,49 +3757,53 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
}
// get the information types
- UInt16 numInformationTypes;
- if (!stateObj.TryReadUInt16(out numInformationTypes))
+ if (!stateObj.TryReadUInt16(out ushort numInformationTypes))
{
return false;
}
var informationTypes = new List(numInformationTypes);
- for (UInt16 i = 0; i < numInformationTypes; i++)
+ for (ushort i = 0; i < numInformationTypes; i++)
{
- string informationType;
- string id;
- if (!TryReadSensitivityInformationType(stateObj, out informationType, out id))
+ if (!TryReadSensitivityInformationType(stateObj, out string informationType, out string id))
{
return false;
}
informationTypes.Add(new InformationType(informationType, id));
}
+ // get sensitivity rank
+ int sensitivityRank = (int)SensitivityRank.NOT_DEFINED;
+ if (DataClassificationVersion > TdsEnums.DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT)
+ {
+ if (!stateObj.TryReadInt32(out sensitivityRank) || !Enum.IsDefined(typeof(SensitivityRank), sensitivityRank))
+ {
+ return false;
+ }
+ }
+
// get the per column classification data (corresponds to order of output columns for query)
- UInt16 numResultColumns;
- if (!stateObj.TryReadUInt16(out numResultColumns))
+ if (!stateObj.TryReadUInt16(out ushort numResultColumns))
{
return false;
}
var columnSensitivities = new List(numResultColumns);
- for (UInt16 columnNum = 0; columnNum < numResultColumns; columnNum++)
+ for (ushort columnNum = 0; columnNum < numResultColumns; columnNum++)
{
// get sensitivity properties for all the different sources which were used in generating the column output
- UInt16 numSources;
- if (!stateObj.TryReadUInt16(out numSources))
+ if (!stateObj.TryReadUInt16(out ushort numSources))
{
return false;
}
var sensitivityProperties = new List(numSources);
- for (UInt16 sourceNum = 0; sourceNum < numSources; sourceNum++)
+ for (ushort sourceNum = 0; sourceNum < numSources; sourceNum++)
{
// get the label index and then lookup label to use for source
- UInt16 labelIndex;
- if (!stateObj.TryReadUInt16(out labelIndex))
+ if (!stateObj.TryReadUInt16(out ushort labelIndex))
{
return false;
}
Label label = null;
- if (labelIndex != UInt16.MaxValue)
+ if (labelIndex != ushort.MaxValue)
{
if (labelIndex >= labels.Count)
{
@@ -3812,13 +3813,12 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
}
// get the information type index and then lookup information type to use for source
- UInt16 informationTypeIndex;
- if (!stateObj.TryReadUInt16(out informationTypeIndex))
+ if (!stateObj.TryReadUInt16(out ushort informationTypeIndex))
{
return false;
}
InformationType informationType = null;
- if (informationTypeIndex != UInt16.MaxValue)
+ if (informationTypeIndex != ushort.MaxValue)
{
if (informationTypeIndex >= informationTypes.Count)
{
@@ -3827,14 +3827,23 @@ private bool TryProcessDataClassification(TdsParserStateObject stateObj, out Sen
informationType = informationTypes[informationTypeIndex];
}
- // add sentivity properties for the source
- sensitivityProperties.Add(new SensitivityProperty(label, informationType));
+ // get sensitivity rank
+ int sensitivityRankProperty = (int)SensitivityRank.NOT_DEFINED;
+ if (DataClassificationVersion > TdsEnums.DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT)
+ {
+ if (!stateObj.TryReadInt32(out sensitivityRankProperty) || !Enum.IsDefined(typeof(SensitivityRank), sensitivityRankProperty))
+ {
+ return false;
+ }
+ }
+
+ // add sensitivity properties for the source
+ sensitivityProperties.Add(new SensitivityProperty(label, informationType, (SensitivityRank)sensitivityRankProperty));
}
columnSensitivities.Add(new ColumnSensitivity(sensitivityProperties));
}
- sensitivityClassification = new SensitivityClassification(labels, informationTypes, columnSensitivities);
-
+ sensitivityClassification = new SensitivityClassification(labels, informationTypes, columnSensitivities, (SensitivityRank)sensitivityRank);
return true;
}
@@ -8576,7 +8585,7 @@ internal int WriteFedAuthFeatureRequest(FederatedAuthenticationFeatureExtensionD
// Write Feature ID, legth of the version# field and Sensitivity Classification Version#
_physicalStateObj.WriteByte(TdsEnums.FEATUREEXT_DATACLASSIFICATION);
WriteInt(1, _physicalStateObj);
- _physicalStateObj.WriteByte(TdsEnums.MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION);
+ _physicalStateObj.WriteByte(TdsEnums.DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED);
}
return len; // size of data written
@@ -9828,7 +9837,7 @@ internal Task TdsExecuteRPC(SqlCommand cmd, _SqlRPC[] rpcArray, int timeout, boo
// Stream out parameters
SqlParameter[] parameters = rpcext.parameters;
-
+
bool isAdvancedTraceOn = SqlClientEventSource.Log.IsAdvancedTraceOn();
for (int i = (ii == startRpc) ? startParam : 0; i < parameters.Length; i++)
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/DataClassification/SensitivityClassification.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/DataClassification/SensitivityClassification.cs
index 084083b338..27acd8508b 100644
--- a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/DataClassification/SensitivityClassification.cs
+++ b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/DataClassification/SensitivityClassification.cs
@@ -8,7 +8,7 @@
namespace Microsoft.Data.SqlClient.DataClassification
{
/// SensitivityProperties { get; private set; }
@@ -72,7 +93,7 @@ public ColumnSensitivity(IList sensitivityProperties)
}
/// Labels { get; private set; }
@@ -80,15 +101,19 @@ public class SensitivityClassification
/// InformationTypes { get; private set; }
+ /// ColumnSensitivities { get; private set; }
/// labels, IList informationTypes, IList columnSensitivity)
+ public SensitivityClassification(IList labels, IList informationTypes, IList columnSensitivity, SensitivityRank sensitivityRank = SensitivityRank.NOT_DEFINED) // Default to NOT_DEFINED for backwards compatibility
{
Labels = new ReadOnlyCollection(labels);
InformationTypes = new ReadOnlyCollection(informationTypes);
ColumnSensitivities = new ReadOnlyCollection(columnSensitivity);
+ SensitivityRank = sensitivityRank;
}
}
}
diff --git a/src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataClassificationTest/DataClassificationTest.cs b/src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataClassificationTest/DataClassificationTest.cs
index 51c8ebf5eb..51ff126410 100644
--- a/src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataClassificationTest/DataClassificationTest.cs
+++ b/src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/DataClassificationTest/DataClassificationTest.cs
@@ -14,7 +14,30 @@ public static class DataClassificationTest
{
private static string s_tableName;
- [ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureServer), nameof(DataTestUtility.IsSupportedDataClassification))]
+ [ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsSupportedDataClassification))]
+ public static void TestDataClassificationResultSetRank()
+ {
+ s_tableName = DataTestUtility.GetUniqueNameForSqlServer("DC");
+ using (SqlConnection sqlConnection = new SqlConnection(DataTestUtility.TCPConnectionString))
+ using (SqlCommand sqlCommand = sqlConnection.CreateCommand())
+ {
+ try
+ {
+ sqlConnection.Open();
+ Assert.True(DataTestUtility.IsSupportedDataClassification());
+ CreateTable(sqlCommand);
+ AddSensitivity(sqlCommand, rankEnabled: true);
+ InsertData(sqlCommand);
+ RunTestsForServer(sqlCommand, rankEnabled: true);
+ }
+ finally
+ {
+ DataTestUtility.DropTable(sqlConnection, s_tableName);
+ }
+ }
+ }
+
+ [ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsSupportedDataClassification))]
public static void TestDataClassificationResultSet()
{
s_tableName = DataTestUtility.GetUniqueNameForSqlServer("DC");
@@ -26,6 +49,8 @@ public static void TestDataClassificationResultSet()
sqlConnection.Open();
Assert.True(DataTestUtility.IsSupportedDataClassification());
CreateTable(sqlCommand);
+ AddSensitivity(sqlCommand);
+ InsertData(sqlCommand);
RunTestsForServer(sqlCommand);
}
finally
@@ -35,16 +60,16 @@ public static void TestDataClassificationResultSet()
}
}
- private static void RunTestsForServer(SqlCommand sqlCommand)
+ private static void RunTestsForServer(SqlCommand sqlCommand, bool rankEnabled = false)
{
sqlCommand.CommandText = "SELECT * FROM " + s_tableName;
using (SqlDataReader reader = sqlCommand.ExecuteReader())
{
- VerifySensitivityClassification(reader);
+ VerifySensitivityClassification(reader, rankEnabled);
}
}
- private static void VerifySensitivityClassification(SqlDataReader reader)
+ private static void VerifySensitivityClassification(SqlDataReader reader, bool rankEnabled = false)
{
if (null != reader.SensitivityClassification)
{
@@ -69,8 +94,24 @@ private static void VerifySensitivityClassification(SqlDataReader reader)
VerifyLabel(sp.Label);
VerifyInfoType(sp.InformationType, columnPos);
}
+ if (rankEnabled)
+ {
+ if (columnPos == 1 || columnPos == 2)
+ {
+ Assert.True(sp.SensitivityRank == SensitivityRank.LOW);
+ }
+ else if (columnPos == 6 || columnPos == 7)
+ {
+ Assert.True(sp.SensitivityRank == SensitivityRank.MEDIUM);
+ }
+ }
+ else
+ {
+ Assert.True(reader.SensitivityClassification.SensitivityRank == SensitivityRank.NOT_DEFINED);
+ }
}
}
+ Assert.Equal(reader.SensitivityClassification.SensitivityRank, rankEnabled ? SensitivityRank.MEDIUM : SensitivityRank.NOT_DEFINED);
}
}
@@ -100,23 +141,50 @@ private static void CreateTable(SqlCommand sqlCommand)
+ "[Phone] [nvarchar](30) MASKED WITH (FUNCTION = 'default()') NULL,"
+ "[Fax] [nvarchar](30) MASKED WITH (FUNCTION = 'default()') NULL)";
sqlCommand.ExecuteNonQuery();
+ }
- sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
- + ".CompanyName WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Company Name', INFORMATION_TYPE_ID='COMPANY')";
- sqlCommand.ExecuteNonQuery();
+ private static void AddSensitivity(SqlCommand sqlCommand, bool rankEnabled = false)
+ {
+ if (rankEnabled)
+ {
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".CompanyName WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Company Name', INFORMATION_TYPE_ID='COMPANY', RANK=LOW)";
+ sqlCommand.ExecuteNonQuery();
- sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
- + ".ContactName WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Person Name', INFORMATION_TYPE_ID='NAME')";
- sqlCommand.ExecuteNonQuery();
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".ContactName WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Person Name', INFORMATION_TYPE_ID='NAME', RANK=LOW)";
+ sqlCommand.ExecuteNonQuery();
- sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
- + ".Phone WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Contact Information', INFORMATION_TYPE_ID='CONTACT')";
- sqlCommand.ExecuteNonQuery();
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".Phone WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Contact Information', INFORMATION_TYPE_ID='CONTACT', RANK=MEDIUM)";
+ sqlCommand.ExecuteNonQuery();
- sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
- + ".Fax WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Contact Information', INFORMATION_TYPE_ID='CONTACT')";
- sqlCommand.ExecuteNonQuery();
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".Fax WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Contact Information', INFORMATION_TYPE_ID='CONTACT', RANK=MEDIUM)";
+ sqlCommand.ExecuteNonQuery();
+ }
+ else
+ {
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".CompanyName WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Company Name', INFORMATION_TYPE_ID='COMPANY')";
+ sqlCommand.ExecuteNonQuery();
+
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".ContactName WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Person Name', INFORMATION_TYPE_ID='NAME')";
+ sqlCommand.ExecuteNonQuery();
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".Phone WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Contact Information', INFORMATION_TYPE_ID='CONTACT')";
+ sqlCommand.ExecuteNonQuery();
+
+ sqlCommand.CommandText = "ADD SENSITIVITY CLASSIFICATION TO " + s_tableName
+ + ".Fax WITH (LABEL='PII', LABEL_ID='L1', INFORMATION_TYPE='Contact Information', INFORMATION_TYPE_ID='CONTACT')";
+ sqlCommand.ExecuteNonQuery();
+ }
+ }
+
+ private static void InsertData(SqlCommand sqlCommand)
+ {
// INSERT ROWS OF DATA
sqlCommand.CommandText = "INSERT INTO " + s_tableName + " VALUES (@companyName, @contactName, @contactTitle, @city, @country, @phone, @fax)";
@@ -126,7 +194,7 @@ private static void CreateTable(SqlCommand sqlCommand)
sqlCommand.Parameters.AddWithValue("city", "London");
sqlCommand.Parameters.AddWithValue("@country", "UK");
sqlCommand.Parameters.AddWithValue("@phone", "(171) 555-2222");
- sqlCommand.Parameters.AddWithValue("@fax", "");
+ sqlCommand.Parameters.AddWithValue("@fax", "(171) 554-2222");
sqlCommand.ExecuteNonQuery();
sqlCommand.Parameters.Clear();
@@ -136,7 +204,7 @@ private static void CreateTable(SqlCommand sqlCommand)
sqlCommand.Parameters.AddWithValue("city", "New Orleans");
sqlCommand.Parameters.AddWithValue("@country", "USA");
sqlCommand.Parameters.AddWithValue("@phone", "(100) 555-4822");
- sqlCommand.Parameters.AddWithValue("@fax", "");
+ sqlCommand.Parameters.AddWithValue("@fax", "(100) 223-3243");
sqlCommand.ExecuteNonQuery();
sqlCommand.Parameters.Clear();
@@ -150,7 +218,7 @@ private static void CreateTable(SqlCommand sqlCommand)
sqlCommand.ExecuteNonQuery();
}
- [ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureServer), nameof(DataTestUtility.IsSupportedDataClassification))]
+ [ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsSupportedDataClassification))]
public static void TestDataClassificationBulkCopy()
{
var data = new DataTable("Company");
@@ -177,14 +245,10 @@ public static void TestDataClassificationBulkCopy()
$" [CompanyId] [uniqueidentifier] NOT NULL," +
$" [CompanyName][nvarchar](255) NOT NULL," +
$" [Email] [nvarchar](50) NULL," +
- $" [CompanyType] [int] not null," +
- $" CONSTRAINT[PK_Company] PRIMARY KEY CLUSTERED (" +
- $" [CompanyId] ASC" +
- $" ) WITH(STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF) ON[PRIMARY]" +
- $" ) ON[PRIMARY]";
+ $" [CompanyType] [int] not null)";
sqlCommand.ExecuteNonQuery();
-
- sqlCommand.CommandText = $"ADD SENSITIVITY CLASSIFICATION TO {tableName}.Email WITH (label = 'Confidential', label_id = 'c185460f-4e20-4b89-9876-ae95f07ba087', information_type = 'Contact Info', information_type_id = '5c503e21-22c6-81fa-620b-f369b8ec38d1');";
+ sqlCommand.CommandText = $"ADD SENSITIVITY CLASSIFICATION TO {tableName}.CompanyName WITH (label = 'Confidential', label_id = 'c185460f-4e20-4b89-9876-ae95f07ba087', information_type = 'Contact Info', information_type_id = '5c503e21-22c6-81fa-620b-f369b8ec38d1');";
+ sqlCommand.CommandText = $"ADD SENSITIVITY CLASSIFICATION TO {tableName}.Email WITH (label = 'Confidential', label_id = 'c185460f-4e20-4b89-9876-ae95f07ba087', information_type = 'Contact Info', information_type_id = '5c503e21-22c6-81fa-620b-f369b8ec38d1', rank = HIGH);";
sqlCommand.ExecuteNonQuery();
}