Cosmosdb/client encryption fix #33355
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amanrao23
requested review from
aditishree1,
sajeetharan and
topshot99
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR fixes client‐side encryption issues in the Cosmos DB SDK by converting key data types from Buffer to Uint8Array, renaming parameters for clarity, and updating type definitions and sample code.
- Methods in key wrapping/unwrapping now use Uint8Array for consistency.
- Parameter names have been updated (e.g. from “id” to “clientEncryptionKeyId”) and client encryption metadata and included paths are now defined as object literals.
- The API and sample documentation have been updated accordingly.
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sdk/cosmosdb/cosmos/src/encryption/EncryptionKeyStoreProvider.ts | Converts keys to/from Uint8Array and Buffer for proper wrapping/unwrapping. |
| sdk/cosmosdb/cosmos/src/encryption/EncryptionProcessor.ts | Updates wrapped key conversion to Uint8Array. |
| sdk/cosmosdb/cosmos/review/cosmos.api.md | Updates method signatures to use Uint8Array instead of Buffer. |
| sdk/cosmosdb/cosmos/src/client/Database/Database.ts | Renames parameters (id → clientEncryptionKeyId) and updates key conversion logic. |
| sdk/cosmosdb/cosmos/src/encryption/Cache/ProtectedDataEncryptionKeyCache.ts | Adjusts parameter conversion from Buffer to Uint8Array. |
| sdk/cosmosdb/cosmos/src/encryption/EncryptionKeyWrapMetadata.ts | Switches from a class to an interface definition with updated properties. |
| sdk/cosmosdb/cosmos/src/encryption/ClientEncryptionIncludedPath.ts | Changes from a class to an interface and standardizes property names. |
| sdk/cosmosdb/cosmos/src/encryption/EncryptionKeyResolver/AzureKeyVaultEncryptionKeyResolver.ts | Updates key wrapping/unwrapping methods to use Uint8Array. |
| Samples & CHANGELOG | Updates sample code and changelog snippets to use object literal style for metadata and paths. |
| sdk/cosmosdb/cosmos/src/encryption/EncryptionKeyResolver/EncryptionKeyResolver.ts | Adjusts interface definitions to use Uint8Array. |
| sdk/cosmosdb/cosmos/src/encryption/ClientEncryptionKey/ClientEncryptionKeyProperties.ts | Changes the type of wrappedDataEncryptionKey from Buffer to Uint8Array. |
| Tests | Updates test constructors to align with new object literal definitions for encryption settings. |
Comments suppressed due to low confidence (1)
sdk/cosmosdb/cosmos/samples-dev/ClientSideEncryption.ts:147
- There is a spelling error in the property name; 'algoruthm' should be 'algorithm'.
algoruthm: KeyEncryptionAlgorithm.RSA_OAEP,
| type: EncryptionKeyResolverName.AzureKeyVault, | ||
| name: "akvKey", | ||
| value: "https://<my-key-vault>.vault.azure.net/keys/<key>/<version>", | ||
| algoriithm: KeyEncryptionAlgorithm.RSA_OAEP |
There was a problem hiding this comment.
There is a spelling error in the property name; 'algoriithm' should be 'algorithm'.
Suggested change
| algoriithm: KeyEncryptionAlgorithm.RSA_OAEP | |
| algorithm: KeyEncryptionAlgorithm.RSA_OAEP |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Packages impacted by this PR
@azure/cosmos
Issues associated with this PR
Describe the problem that is addressed by this PR
This PR fixes issues related to client side encryption
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
Provide a list of related PRs (if any)
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Checklists