Skip to content
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

Client Encryption : Adds integration with latest Cryptography package and removes caching of AeadAes256CbcHmac256EncryptionAlgorithm object #2345

Merged
merged 18 commits into from
Apr 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public sealed class CosmosDataEncryptionKeyProvider : DataEncryptionKeyProvider

internal DekCache DekCache { get; }

/* MDE's Protected Data Encryption key Cache TTL*/
// MDE's Protected Data Encryption key Cache TTL.
internal TimeSpan? PdekCacheTimeToLive { get; }

internal Container Container
Expand Down Expand Up @@ -75,40 +75,58 @@ public CosmosDataEncryptionKeyProvider(
/// Initializes a new instance of the <see cref="CosmosDataEncryptionKeyProvider"/> class.
/// </summary>
/// <param name="encryptionKeyStoreProvider"> MDE EncryptionKeyStoreProvider for Wrapping/UnWrapping services. </param>
/// <param name="cacheTimeToLive">Time to live for EncryptionKeyStoreProvider's ProtectedDataEncryptionKey before having to refresh. 0 results in no Caching.</param>
/// <param name="dekPropertiesTimeToLive">Time to live for DEK properties before having to refresh.</param>
public CosmosDataEncryptionKeyProvider(
EncryptionKeyStoreProvider encryptionKeyStoreProvider,
TimeSpan? cacheTimeToLive = null,
TimeSpan? dekPropertiesTimeToLive = null)
{
this.EncryptionKeyStoreProvider = encryptionKeyStoreProvider ?? throw new ArgumentNullException(nameof(encryptionKeyStoreProvider));
this.MdeKeyWrapProvider = new MdeKeyWrapProvider(encryptionKeyStoreProvider);
this.dataEncryptionKeyContainerCore = new DataEncryptionKeyContainerCore(this);
this.DekCache = new DekCache(dekPropertiesTimeToLive);
this.PdekCacheTimeToLive = cacheTimeToLive;
this.PdekCacheTimeToLive = this.EncryptionKeyStoreProvider.DataEncryptionKeyCacheTimeToLive;
if (this.PdekCacheTimeToLive.HasValue)
{
// set the TTL for Protected Data Encryption.
ProtectedDataEncryptionKey.TimeToLive = this.PdekCacheTimeToLive.Value;
}
else
{
// If null is passed to DataEncryptionKeyCacheTimeToLive it results in forever caching hence setting
// arbitrarily large caching period. ProtectedDataEncryptionKey does not seem to handle TimeSpan.MaxValue.
ProtectedDataEncryptionKey.TimeToLive = TimeSpan.FromDays(36500);
kr-santosh marked this conversation as resolved.
Show resolved Hide resolved
}
}

/// <summary>
/// Initializes a new instance of the <see cref="CosmosDataEncryptionKeyProvider"/> class.
/// </summary>
/// <param name="encryptionKeyWrapProvider">A provider that will be used to wrap (encrypt) and unwrap (decrypt) data encryption keys for envelope based encryption</param>
/// <param name="encryptionKeyStoreProvider"> MDE EncryptionKeyStoreProvider for Wrapping/UnWrapping services. </param>
/// <param name="cacheTimeToLive">Time to live for EncryptionKeyStoreProvider ProtectedDataEncryptionKey before having to refresh. 0 results in no Caching.</param>
/// <param name="dekPropertiesTimeToLive">Time to live for DEK properties before having to refresh.</param>
[Obsolete("Please use the constructor with EncryptionKeyStoreProvider only.")]
public CosmosDataEncryptionKeyProvider(
EncryptionKeyWrapProvider encryptionKeyWrapProvider,
EncryptionKeyStoreProvider encryptionKeyStoreProvider,
TimeSpan? cacheTimeToLive = null,
TimeSpan? dekPropertiesTimeToLive = null)
{
this.EncryptionKeyWrapProvider = encryptionKeyWrapProvider ?? throw new ArgumentNullException(nameof(encryptionKeyWrapProvider));
this.EncryptionKeyStoreProvider = encryptionKeyStoreProvider ?? throw new ArgumentNullException(nameof(encryptionKeyStoreProvider));
this.MdeKeyWrapProvider = new MdeKeyWrapProvider(encryptionKeyStoreProvider);
this.dataEncryptionKeyContainerCore = new DataEncryptionKeyContainerCore(this);
this.DekCache = new DekCache(dekPropertiesTimeToLive);
this.PdekCacheTimeToLive = cacheTimeToLive;
this.PdekCacheTimeToLive = this.EncryptionKeyStoreProvider.DataEncryptionKeyCacheTimeToLive;
if (this.PdekCacheTimeToLive.HasValue)
{
// set the TTL for Protected Data Encryption.
ProtectedDataEncryptionKey.TimeToLive = this.PdekCacheTimeToLive.Value;
}
else
{
// If null is passed to DataEncryptionKeyCacheTimeToLive it results in forever caching hence setting
// arbitrarily large caching period. ProtectedDataEncryptionKey does not seem to handle TimeSpan.MaxValue.
ProtectedDataEncryptionKey.TimeToLive = TimeSpan.FromDays(36500);
}
}

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,6 @@ public MdeEncryptionAlgorithm(
dekProperties.Id,
keyEncryptionKey,
dekProperties.WrappedDataEncryptionKey);

protectedDataEncryptionKey.TimeToLive = cacheTimeToLive.Value;
}
}
else
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ public static CosmosClient WithEncryption(
throw new ArgumentNullException(nameof(cosmosClient));
}

// set the TTL for ProtectedDataEncryption at the Encryption CosmosClient Init so that we have a uniform expiry of the KeyStoreProvider and ProtectedDataEncryption cache items.
if (encryptionKeyStoreProvider.DataEncryptionKeyCacheTimeToLive.HasValue)
{
ProtectedDataEncryptionKey.TimeToLive = encryptionKeyStoreProvider.DataEncryptionKeyCacheTimeToLive.Value;
}
else
{
// If null is passed to DataEncryptionKeyCacheTimeToLive it results in forever caching hence setting
// arbitrarily large caching period. ProtectedDataEncryptionKey does not seem to handle TimeSpan.MaxValue.
ProtectedDataEncryptionKey.TimeToLive = TimeSpan.FromDays(36500);
}

return new EncryptionCosmosClient(cosmosClient, encryptionKeyStoreProvider);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ public static async Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyA

byte[] wrappedDataEncryptionKey = protectedDataEncryptionKey.EncryptedValue;

// cache it.
ProtectedDataEncryptionKey.GetOrCreate(
clientEncryptionKeyId,
keyEncryptionKey,
wrappedDataEncryptionKey);

ClientEncryptionKeyProperties clientEncryptionKeyProperties = new ClientEncryptionKeyProperties(
clientEncryptionKeyId,
encryptionAlgorithm,
Expand Down
Loading