Skip to content

Conversation

benrr101
Copy link
Contributor

@benrr101 benrr101 commented Oct 8, 2025

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.

… 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.
…roviders, HasColumnEncryptionKeyStoreProviderRegistered
…ParameterEncryptionRPC, IsDescribeParameterEncryptionRPCCurrentlyInProgress
@benrr101 benrr101 added this to the 7.0.0-preview3 milestone Oct 8, 2025
@Copilot Copilot AI review requested due to automatic review settings October 8, 2025 23:14
@benrr101 benrr101 requested a review from a team as a code owner October 8, 2025 23:14
@benrr101 benrr101 added the Common Project 🚮 Things that relate to the common project project label Oct 8, 2025
Copy link
Contributor

@Copilot Copilot AI left a 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)
Copy link

Copilot AI Oct 8, 2025

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.

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

Copilot uses AI. Check for mistakes.

Comment on lines +1034 to +1037
// @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.
Copy link

Copilot AI Oct 8, 2025

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.

Copy link
Contributor

@edwardneal edwardneal left a 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!

paulmedynski
paulmedynski previously approved these changes Oct 9, 2025
paulmedynski
paulmedynski previously approved these changes Oct 10, 2025
@paulmedynski paulmedynski self-assigned this Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Common Project 🚮 Things that relate to the common project project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants