Merge | SqlCommand Encryption Methods

[benrr101]

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 concise
• GetParameterEncryptionDataReaderAsync - code from netcore taken since it is more concise
• HasColumnEncryptionKeyStoreProviderRegistered
• InvalidateEnclaveSession
• IsDescribeParameterEncryptionRPCCurrentlyInProgress
• keysToBeSentToEnclave
• PrepareDescribeParameterEncryptionRequest
• PrepareTransparentEncryptionFinallyBlock
• ReadDescribeEncryptionParameterResults
  • Factored this massive method into three additional methods (1-3) that read a specific result set from sp_describe_parameter_encryption
  • Removed debug-only rowsAffected member as it was only being used to check if the server returned the right number of rows from sp_describe_parameter_encryption in debug mode.
• requiresEnclaveComputations
• ResetEncryptionState
• RowsAffectedByDescribeParameterEncryption
• _rowsAffectedBySpDescribeParameterEncryption
• _rpcForEncryption
• SetColumnEncryptionSetting
• ShouldCacheEncryptionMetadata
• ShouldUseEnclaveBasedWorkflow
• _sqlRPCParameterEncryptionRegArray
• Test behavior overrides
  • _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.

[Copilot]

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

[Copilot]

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.

Suggested change

	if (_customColumnEncryptionKeyStoreProviders.Count > 0)
	if (_customColumnEncryptionKeyStoreProviders != null && _customColumnEncryptionKeyStoreProviders.Count > 0)

[Copilot]

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.

[edwardneal]

Looking good - we're almost there!

[mdaigle]

Looks like there are some genuine test failures in here:

[codecov]

Codecov Report

❌ Patch coverage is 83.00283% with 120 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.75%. Comparing base (37a9c99) to head (3028240).
⚠️ Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
.../Microsoft/Data/SqlClient/SqlCommand.Encryption.cs	83.02%	109 Missing ⚠️
...src/Microsoft/Data/SqlClient/SqlCommand.netcore.cs	80.39%	10 Missing ⚠️
...lClient/src/Microsoft/Data/SqlClient/SqlCommand.cs	92.30%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3676      +/-   ##
==========================================
- Coverage   77.35%   76.75%   -0.61%     
==========================================
  Files         271      273       +2     
  Lines       45123    44914     -209     
==========================================
- Hits        34907    34474     -433     
- Misses      10216    10440     +224     

Flag	Coverage Δ
addons	90.82% <ø> (ø)
netcore	76.64% <83.00%> (-0.70%)	⬇️
netfx	76.30% <83.20%> (-0.13%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[benrr101]

Found all the bugs! Requesting new reviews from @mdaigle @paulmedynski :)