Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
35e768c
Add sync initialization to CosmosDataEncryptionKeyProvider
MartinSarkany Sep 24, 2025
2f879bc
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Oct 13, 2025
9bcb702
Fix contract test
MartinSarkany Oct 13, 2025
4932b33
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Oct 21, 2025
22c344b
Fix contracts
MartinSarkany Oct 21, 2025
13ec854
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Oct 30, 2025
3e9b5df
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Nov 5, 2025
1fcb13b
Merge branch 'feature/cosmosdataencryptionkeyprovider-sync-init' of h…
MartinSarkany Nov 5, 2025
170576e
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Nov 13, 2025
78a9470
Prevent race condition, extend documentation
MartinSarkany Nov 13, 2025
54f4609
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Nov 17, 2025
daf40d8
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
MartinSarkany Mar 12, 2026
7898518
Minor fix
MartinSarkany Mar 17, 2026
e5bef98
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
kirankumarkolli Apr 13, 2026
ff0693f
Code review improvements
MartinSarkany Apr 21, 2026
867f8b4
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
kirankumarkolli Apr 22, 2026
3adb7d4
Merge branch 'master' into feature/cosmosdataencryptionkeyprovider-sy…
kirankumarkolli Apr 28, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,7 @@ public async Task InitializeAsync(
string containerId,
CancellationToken cancellationToken = default)
{
if (this.container != null)
{
throw new InvalidOperationException($"{nameof(CosmosDataEncryptionKeyProvider)} has already been initialized.");
}
this.ThrowIfAlreadyInitialized();

#if NET8_0_OR_GREATER
ArgumentNullException.ThrowIfNull(database);
Expand All @@ -173,6 +170,25 @@ public async Task InitializeAsync(
this.container = containerResponse.Container;
}

/// <summary>
/// Initialize using an existing Cosmos DB container for storing wrapped DEKs.
Comment thread
kirankumarkolli marked this conversation as resolved.
Outdated
/// </summary>
/// <param name="container">Existing Cosmos DB container.</param>
public void Initialize(Container container)
Comment thread
kirankumarkolli marked this conversation as resolved.
Comment thread
kirankumarkolli marked this conversation as resolved.
{
this.ThrowIfAlreadyInitialized();

this.container = container ?? throw new ArgumentNullException(nameof(container));
Comment thread
kirankumarkolli marked this conversation as resolved.
Outdated
}

private void ThrowIfAlreadyInitialized()
{
if (this.container != null)
{
throw new InvalidOperationException($"{nameof(CosmosDataEncryptionKeyProvider)} has already been initialized.");
}
}

/// <inheritdoc/>
public override async Task<DataEncryptionKey> FetchDataEncryptionKeyWithoutRawKeyAsync(
string id,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
//------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
//------------------------------------------------------------

namespace Microsoft.Azure.Cosmos.Encryption.Tests
{
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Encryption.Custom;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Microsoft.Data.Encryption.Cryptography;

[TestClass]
public class CosmosDataEncryptionKeyProviderTests
{
private const string ContainerId = "dekContainer";

[TestMethod]
public async Task InitializeAsync_WithValidContainer_CreatesAndSetsContainer()
{
Mock<Container> mockContainer = new(MockBehavior.Strict);
Mock<ContainerResponse> mockContainerResponse = new(MockBehavior.Strict);
mockContainerResponse.Setup(r => r.Container).Returns(mockContainer.Object);
mockContainerResponse.Setup(r => r.Resource).Returns(new ContainerProperties(ContainerId, partitionKeyPath: "/id"));

Mock<Database> mockDatabase = new(MockBehavior.Strict);
mockDatabase
.Setup(db => db.CreateContainerIfNotExistsAsync(
It.Is<string>(s => s == ContainerId),
It.Is<string>(pk => pk == "/id"),
It.IsAny<int?>(),
It.IsAny<RequestOptions>(),
It.IsAny<CancellationToken>()))
.ReturnsAsync(mockContainerResponse.Object);

CosmosDataEncryptionKeyProvider provider = CreateProvider();

await provider.InitializeAsync(mockDatabase.Object, ContainerId);

Assert.AreSame(mockContainer.Object, provider.Container);

mockDatabase.VerifyAll();
mockContainerResponse.VerifyAll();
}

[TestMethod]
public async Task InitializeAsync_WithWrongPartitionKey_Throws()
{
Mock<Container> mockContainer = new(MockBehavior.Strict);
Mock<ContainerResponse> mockContainerResponse = new(MockBehavior.Strict);
mockContainerResponse.Setup(r => r.Container).Returns(mockContainer.Object);
mockContainerResponse.Setup(r => r.Resource).Returns(new ContainerProperties("dekBad", partitionKeyPath: "/different-id"));

Mock<Database> mockDatabase = new(MockBehavior.Strict);
mockDatabase
.Setup(db => db.CreateContainerIfNotExistsAsync(
It.Is<string>(s => s == "dekBad"),
It.Is<string>(pk => pk == "/id"),
It.IsAny<int?>(),
It.IsAny<RequestOptions>(),
It.IsAny<CancellationToken>()))
.ReturnsAsync(mockContainerResponse.Object);

CosmosDataEncryptionKeyProvider provider = CreateProvider();

ArgumentException ex = await Assert.ThrowsExceptionAsync<ArgumentException>(() => provider.InitializeAsync(mockDatabase.Object, "dekBad"));

StringAssert.Contains(ex.Message, "partition key definition");
Assert.AreEqual("containerId", ex.ParamName);

mockDatabase.VerifyAll();
}

[TestMethod]
public void Initialize_WithContainer_Succeeds()
{
Mock<Container> mockContainer = new(MockBehavior.Strict);

CosmosDataEncryptionKeyProvider provider = CreateProvider();
provider.Initialize(mockContainer.Object);

Assert.AreSame(mockContainer.Object, provider.Container);
}

[TestMethod]
public void Initialize_WithNullContainer_Throws()
{
CosmosDataEncryptionKeyProvider provider = CreateProvider();

ArgumentNullException ex = Assert.ThrowsException<ArgumentNullException>(() => provider.Initialize(null));

Assert.AreEqual("container", ex.ParamName);
}

[TestMethod]
public void Initialize_Twice_Throws()
{
Mock<Container> mockContainer = new(MockBehavior.Strict);
CosmosDataEncryptionKeyProvider provider = CreateProvider();
provider.Initialize(mockContainer.Object);

InvalidOperationException ex = Assert.ThrowsException<InvalidOperationException>(() => provider.Initialize(mockContainer.Object));

StringAssert.Contains(ex.Message, nameof(CosmosDataEncryptionKeyProvider));
}

[TestMethod]
public async Task InitializeAsync_AfterInitializeContainer_Throws()
{
Mock<Container> mockContainer = new(MockBehavior.Strict);
Mock<Database> mockDatabase = new(MockBehavior.Strict);
CosmosDataEncryptionKeyProvider provider = CreateProvider();

provider.Initialize(mockContainer.Object);

await Assert.ThrowsExceptionAsync<InvalidOperationException>(() => provider.InitializeAsync(mockDatabase.Object, "ignored"));
}

[TestMethod]
public void AccessContainer_BeforeInitialization_Throws()
{
CosmosDataEncryptionKeyProvider provider = CreateProvider();

InvalidOperationException ex = Assert.ThrowsException<InvalidOperationException>(() => _ = provider.Container);

StringAssert.Contains(ex.Message, nameof(CosmosDataEncryptionKeyProvider));
}

[TestMethod]
public void Constructor_EncryptionKeyWrapProvider_SetsProperties()
{
#pragma warning disable CS0618
Mock<EncryptionKeyWrapProvider> wrapProviderMock = new(MockBehavior.Strict);

CosmosDataEncryptionKeyProvider provider = new(wrapProviderMock.Object);

Assert.AreSame(wrapProviderMock.Object, provider.EncryptionKeyWrapProvider);
Assert.IsNotNull(provider.DataEncryptionKeyContainer);
Assert.IsNotNull(provider.DekCache);
#pragma warning restore CS0618
}

[TestMethod]
public void Constructor_EncryptionKeyStoreProvider_SetsMdePropertiesAndTtl_DefaultInfinite()
{
TestEncryptionKeyStoreProvider keyStoreProvider = new();

CosmosDataEncryptionKeyProvider provider = new(keyStoreProvider);

Assert.AreSame(keyStoreProvider, provider.EncryptionKeyStoreProvider);
Assert.IsNotNull(provider.DekCache);
Assert.IsNotNull(provider.DataEncryptionKeyContainer);
Assert.IsTrue(provider.PdekCacheTimeToLive.HasValue);
Assert.IsTrue(provider.PdekCacheTimeToLive.Value > TimeSpan.Zero);
}

[TestMethod]
public void Constructor_KeyStoreProvider_SetsMdePropertiesAndTtl_Custom()
{
TimeSpan ttl = TimeSpan.FromMinutes(15);
TestEncryptionKeyStoreProvider keyStoreProvider = new()
{
DataEncryptionKeyCacheTimeToLive = ttl
};

CosmosDataEncryptionKeyProvider provider = new(keyStoreProvider);

Assert.AreSame(keyStoreProvider, provider.EncryptionKeyStoreProvider);
Assert.AreEqual(ttl, provider.PdekCacheTimeToLive);
}

private static CosmosDataEncryptionKeyProvider CreateProvider()
{
return new CosmosDataEncryptionKeyProvider(new TestEncryptionKeyStoreProvider());
}
}
}