-
Notifications
You must be signed in to change notification settings - Fork 317
Merge | SqlCommand Encryption Methods #3676
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…ncryptionParameterResults
…ncryptionParameterResults
… the server returns the right number of rows for the sp_describe_parameter_encryption, but since it's just a debug build check, it has no bearing on prod builds.
…sEnclaveComputations
…roviders, HasColumnEncryptionKeyStoreProviderRegistered
…ParameterEncryptionRPC, IsDescribeParameterEncryptionRPCCurrentlyInProgress
…DescribeParameterEncryption
…yptionKeyStoreProvider
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR merges SqlCommand encryption-related methods from platform-specific files into a shared partial class file for better code organization and maintainability. The changes consolidate encryption functionality that was previously duplicated across .NET Framework and .NET Core implementations.
- Moves encryption-related methods from platform-specific SqlCommand files to a new shared SqlCommand.Encryption.cs file
- Consolidates fields, properties, and methods related to column encryption and enclave operations
- Removes code duplication between netfx and netcore implementations
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
File | Description |
---|---|
SqlCommand.Encryption.cs | New shared partial class containing all encryption-related methods and fields |
SqlCommand.cs | Added encryption-related fields and properties to shared base class |
SqlParameter.cs | Added TODO comment about parameter name prefixing logic |
SqlSecurityUtility.cs | Added debug assertion for connection null check |
EnclaveDelegate.cs | Added TODO comment about class naming |
SqlCommand.netfx.cs | Removed encryption methods now in shared file |
SqlCommand.netcore.cs | Removed encryption methods now in shared file |
Project files | Added reference to new SqlCommand.Encryption.cs file |
// @TODO: 3) This doesn't check for null _customColumnEncryptionKeyStoreProviders | ||
internal List<string> GetColumnEncryptionCustomKeyStoreProvidersNames() | ||
{ | ||
if (_customColumnEncryptionKeyStoreProviders.Count > 0) |
Copilot
AI
Oct 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Potential null reference exception. The method doesn't check if _customColumnEncryptionKeyStoreProviders
is null before accessing its Count property, but line 28 in the TODO comment indicates this should be checked.
if (_customColumnEncryptionKeyStoreProviders.Count > 0) | |
if (_customColumnEncryptionKeyStoreProviders != null && _customColumnEncryptionKeyStoreProviders.Count > 0) |
Copilot uses AI. Check for mistakes.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Show resolved
Hide resolved
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Show resolved
Hide resolved
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Show resolved
Hide resolved
// @TODO: 1) storing this as Command state seems fishy | ||
// @TODO: 2) despite being concurrent, the usage of ContainsKey -> TryAdd is a race condition | ||
// @TODO: 3) we have SqlTceCipherInfoTable, we should use it - or make it usable. | ||
// @TODO: 4) even if we're supposed to store it as state, is the intention to obliterate the list each time? If so, we should probably store it locally and replace the state obj at the end. |
Copilot
AI
Oct 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Race condition in concurrent dictionary usage. The pattern of checking ContainsKey followed by TryAdd on lines 1043-1045 creates a race condition where multiple threads could pass the ContainsKey check simultaneously.
Copilot uses AI. Check for mistakes.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good - we're almost there!
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Show resolved
Hide resolved
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlCommand.netcore.cs
Outdated
Show resolved
Hide resolved
…up on the code within.
Description
This is the second to last PR I have planned for merging SqlCommand. In this installment, the methods related to parameter encryption are merged, as well as some other blocks that don't have well defined organization. I'm not certain that these should have their own partial, but to avoid the base partial being too large to navigate, I made the executive decision to make a partial. Each commit is bite-sized and focuses on a single or a couple related methods at a time.
The following methods were merged in this PR:
BuildStoredProcedureStatementForColumnEncryption
ClearDescribeParameterEncryptionRequests
_currentlyExecutingDescribeParameterEncryptionRPC
_customColumnEncryptionKeyStoreProviders
customData
customDataLength
enclaveAttestationParameters
GetColumnEncryptionCustomKeyProvidersNames
GetEnclaveSessionParameters
GetParameterEncryptionDataReader
- code from netcore taken since it is more conciseGetParameterEncryptionDataReaderAsync
- code from netcore taken since it is more conciseHasColumnEncryptionKeyStoreProviderRegistered
InvalidateEnclaveSession
IsDescribeParameterEncryptionRPCCurrentlyInProgress
keysToBeSentToEnclave
PrepareDescribeParameterEncryptionRequest
PrepareTransparentEncryptionFinallyBlock
ReadDescribeEncryptionParameterResults
sp_describe_parameter_encryption
rowsAffected
member as it was only being used to check if the server returned the right number of rows fromsp_describe_parameter_encryption
in debug mode.requiresEnclaveComputations
ResetEncryptionState
RowsAffectedByDescribeParameterEncryption
_rowsAffectedBySpDescribeParameterEncryption
_rpcForEncryption
SetColumnEncryptionSetting
ShouldCacheEncryptionMetadata
ShouldUseEnclaveBasedWorkflow
_sqlRPCParameterEncryptionRegArray
_forceInternalEndQuery
_forceRetryableEnclaveQueryExecutionExceptionDuringGenerateEnclavePackage
_sleepAfterReadDescribeEncryptionParameterResults
_sleepDuringRunExecuteReaderTdsForSpDescribeParameterEncryption
_sleepDuringTryFetchInputParameterEncryptionInfo
TryFetchInputParameterEncryptionInfo
TryGetColumnEncryptionKeyStoreProvider
ValidateCustomProviders
_wasBatchModeColumnEncryptionSettingsSetOnce
Issues
Continuation of work in #1261
Testing
Build passes, SqlCommandTests pass locally. CI should validate the rest of it.