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]: Add JsonNode Encryption processor #4780

Merged
Show file tree
Hide file tree
Changes from 66 commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
d6f89ea
Add baseline benchmarks for `Microsoft.Azure.Cosmos.Encryption.Custom`
juraj-blazek Sep 12, 2024
8928b88
Cleanup
juraj-blazek Sep 12, 2024
9dc7d54
Use set of static test data for benchmarks
juraj-blazek Sep 12, 2024
368dc25
Merge branch 'master' into users/juraj-blazek/encryption-benchmark-ba…
juraj-blazek Sep 12, 2024
38a198a
Add non-allocating APIs to encryptors
juraj-blazek Sep 16, 2024
e0bb8bf
WIP
juraj-blazek Sep 16, 2024
9c3c276
Revert solution update
juraj-blazek Sep 16, 2024
c37a092
Merge branch 'users/juraj-blazek/encryption-benchmark-baseline' of ht…
juraj-blazek Sep 16, 2024
f4db1c6
Merge branch 'master' into users/juraj-blazek/encryption-benchmark-ba…
juraj-blazek Sep 16, 2024
91714f9
Merge branch 'master' into users/juraj-blazek/encryption-benchmark-ba…
juraj-blazek Sep 17, 2024
2058f8b
Merge remote-tracking branch 'origin/master' into users/juraj-blazek/…
juraj-blazek Sep 17, 2024
f33538c
Add implementation, fix tests
juraj-blazek Sep 17, 2024
6923fd2
Switch to randomized encryption for benchmarks
juraj-blazek Sep 17, 2024
4ea8690
Merge branch 'master' into users/juraj-blazek/encryption-benchmark-ba…
kr-santosh Sep 18, 2024
03ef682
Some more array pooling
juraj-blazek Sep 17, 2024
1044a89
Streaming deserialization
juraj-blazek Sep 19, 2024
f1db54d
Merge remote-tracking branch 'origin/master' into users/juraj-blazek/…
juraj-blazek Sep 19, 2024
05bfc50
Cleanup
juraj-blazek Sep 20, 2024
5629f74
Update MDE and rerun benchmarks
juraj-blazek Sep 20, 2024
495d2c4
Add non-allocating APIs to encryptors
juraj-blazek Sep 16, 2024
b3f74b1
Merge branch 'master' into users/juraj-blazek/non-allocating-encryptor
JanHyka Sep 30, 2024
14bce37
~ drop repeated DEK calls
JanHyka Sep 30, 2024
4ff1601
! typo
JanHyka Sep 30, 2024
d8a345c
~ update benchmark
JanHyka Sep 30, 2024
03c06e0
~ fix tests
JanHyka Sep 30, 2024
a1025c4
Merge branch 'Azure:master' into users/juraj-blazek/non-allocating-en…
JanHyka Oct 1, 2024
3bf77c8
~ cleanup
JanHyka Oct 1, 2024
ceaa8b5
+ refresh benchmark
JanHyka Oct 1, 2024
611b3ac
+ unit test
JanHyka Oct 1, 2024
9ca89d4
~ merge predecessor PR
JanHyka Oct 1, 2024
8a78fe8
~ merge fixes and initial cleanup
JanHyka Oct 1, 2024
8ed2135
~ write directly to output document instead of copying
JanHyka Oct 1, 2024
bbe9845
! tests
JanHyka Oct 1, 2024
a107f62
~ retrieve DataEncryptionKey only once per document
JanHyka Oct 1, 2024
a1ad02b
! fix tests
JanHyka Oct 1, 2024
4f2f072
~ update Aes algorithm to reuse GetEncryptedByteCount
JanHyka Oct 2, 2024
cbbeee2
~ refactor EncryptionProcessor
JanHyka Oct 4, 2024
b6c851c
! names
JanHyka Oct 4, 2024
72ccae7
~ less static
JanHyka Oct 4, 2024
8ea5879
Merge branch 'master' into users/juraj-blazek/encryption-array-pooling
JanHyka Oct 6, 2024
8c60e69
Merge branch 'master' into users/juraj-blazek/encryption-array-pooling
JanHyka Oct 6, 2024
5554aa0
~ merge fixes
JanHyka Oct 6, 2024
28620ed
~ cleanup
JanHyka Oct 6, 2024
eb059c8
~ unwanted changes
JanHyka Oct 6, 2024
cc2eab5
- unused method
JanHyka Oct 6, 2024
c9ba300
~ updates (PR)
JanHyka Oct 6, 2024
9f9cbca
~ add stable vs preview release duplicity
JanHyka Oct 7, 2024
c347e71
Merge branch 'users/juraj-blazek/encryption-array-pooling' into users…
JanHyka Oct 7, 2024
64172b8
~ cleanup and parent branch merge
JanHyka Oct 7, 2024
ff583f9
Merge branch 'master' into users/jan-hyka/refactor-encryption-processor
JanHyka Oct 7, 2024
0ba8c34
Merge branch 'master' into users/jan-hyka/refactor-encryption-processor
JanHyka Oct 7, 2024
326b1be
~ master merges
JanHyka Oct 7, 2024
c520e16
- duplicate
JanHyka Oct 7, 2024
5c40821
~ cleanup
JanHyka Oct 7, 2024
99c7a75
+ Add .NET8.0 target for Cosmos.Encryption.Custom
JanHyka Oct 8, 2024
31c20e7
- remove implicit IsPreview from csproj
JanHyka Oct 8, 2024
90b2cec
+ JsonNodeSqlSerializer
JanHyka Oct 9, 2024
6f27d9d
+ initial commit
JanHyka Oct 9, 2024
d7c06d6
! EncryptioProperties System.Text.Json annotations
JanHyka Oct 9, 2024
cb9d166
+ bump benchmark
JanHyka Oct 9, 2024
9215f67
~ Merge branch 'master' into users/jan-hyka/jsonnode_serializer
JanHyka Oct 10, 2024
38cc928
- remove explicit System.Text.Json 8.0.5
JanHyka Oct 10, 2024
ba4f73b
Merge branch 'users/jan-hyka/jsonnode_serializer' into users/jan-hyka…
JanHyka Oct 10, 2024
424028c
Merge branch 'master' into users/jan-hyka/jsonnode_encryptionProcessor
JanHyka Oct 10, 2024
2af9ddb
~ propagate changes from master
JanHyka Oct 10, 2024
69c8978
Merge branch 'master' into users/jan-hyka/jsonnode_encryptionProcessor
JanHyka Oct 11, 2024
a0ccd44
Merge branch 'master' into users/jan-hyka/jsonnode_encryptionProcessor
JanHyka Oct 13, 2024
d9c315d
~ complete merge from master & update benchmark
JanHyka Oct 13, 2024
e420cc0
+ add missing JsonPropertyName attributes
JanHyka Oct 14, 2024
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 @@ -6,6 +6,25 @@ namespace Microsoft.Azure.Cosmos.Encryption.Custom
{
using System.Collections.Generic;

/// <summary>
/// API for JSON processing
/// </summary>
public enum JsonProcessor
kirankumarkolli marked this conversation as resolved.
Show resolved Hide resolved
{
/// <summary>
/// Newtonsoft.Json
/// </summary>
Newtonsoft,

#if NET8_0_OR_GREATER
/// <summary>
/// System.Text.Json
/// </summary>
/// <remarks>Available with .NET8.0 package only.</remarks>
SystemTextJson,
#endif
}

/// <summary>
/// Options for encryption of data.
/// </summary>
Expand Down Expand Up @@ -35,5 +54,11 @@ public sealed class EncryptionOptions
/// Example of a path specification: /sensitive
/// </summary>
public IEnumerable<string> PathsToEncrypt { get; set; }

/// <summary>
/// Gets or sets API used for Json processing
/// </summary>
/// <remarks>Setting only applies with Mde encryption is used.</remarks>
public JsonProcessor JsonProcessor { get; set; } = JsonProcessor.Newtonsoft;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,29 @@
namespace Microsoft.Azure.Cosmos.Encryption.Custom
{
using System.Collections.Generic;
using System.Text.Json.Serialization;
using Newtonsoft.Json;

internal class EncryptionProperties
{
[JsonProperty(PropertyName = Constants.EncryptionFormatVersion)]
[JsonPropertyName(Constants.EncryptionFormatVersion)]
public int EncryptionFormatVersion { get; }

[JsonProperty(PropertyName = Constants.EncryptionDekId)]
[JsonPropertyName(Constants.EncryptionDekId)]
public string DataEncryptionKeyId { get; }

[JsonProperty(PropertyName = Constants.EncryptionAlgorithm)]
[JsonPropertyName(Constants.EncryptionAlgorithm)]
public string EncryptionAlgorithm { get; }

[JsonProperty(PropertyName = Constants.EncryptedData)]
[JsonPropertyName(Constants.EncryptedData)]
public byte[] EncryptedData { get; }

[JsonProperty(PropertyName = Constants.EncryptedPaths)]
[JsonPropertyName(Constants.EncryptedPaths)]
public IEnumerable<string> EncryptedPaths { get; }

public EncryptionProperties(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,78 +7,33 @@
namespace Microsoft.Azure.Cosmos.Encryption.Custom.Transformation
{
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Newtonsoft.Json.Linq;

internal class MdeEncryptionProcessor
{
internal JObjectSqlSerializer Serializer { get; set; } = new JObjectSqlSerializer();
internal MdeJObjectEncryptionProcessor JObjectEncryptionProcessor { get; set; } = new MdeJObjectEncryptionProcessor();

internal MdeEncryptor Encryptor { get; set; } = new MdeEncryptor();
#if NET8_0_OR_GREATER
internal MdeJsonNodeEncryptionProcessor JsonNodeEncryptionProcessor { get; set; } = new MdeJsonNodeEncryptionProcessor();
#endif

public async Task<Stream> EncryptAsync(
Stream input,
Encryptor encryptor,
EncryptionOptions encryptionOptions,
CancellationToken token)
{
JObject itemJObj = EncryptionProcessor.BaseSerializer.FromStream<JObject>(input);
List<string> pathsEncrypted = new ();
TypeMarker typeMarker;

using ArrayPoolManager arrayPoolManager = new ();

DataEncryptionKey encryptionKey = await encryptor.GetEncryptionKeyAsync(encryptionOptions.DataEncryptionKeyId, encryptionOptions.EncryptionAlgorithm, token);

foreach (string pathToEncrypt in encryptionOptions.PathsToEncrypt)
return encryptionOptions.JsonProcessor switch
{
JsonProcessor.Newtonsoft => await this.JObjectEncryptionProcessor.EncryptAsync(input, encryptor, encryptionOptions, token),
#if NET8_0_OR_GREATER
string propertyName = pathToEncrypt[1..];
#else
string propertyName = pathToEncrypt.Substring(1);
JsonProcessor.SystemTextJson => await this.JsonNodeEncryptionProcessor.EncryptAsync(input, encryptor, encryptionOptions, token),
#endif
if (!itemJObj.TryGetValue(propertyName, out JToken propertyValue))
{
continue;
}

if (propertyValue.Type == JTokenType.Null)
{
continue;
}

byte[] plainText = null;
(typeMarker, plainText, int plainTextLength) = this.Serializer.Serialize(propertyValue, arrayPoolManager);

if (plainText == null)
{
continue;
}

byte[] encryptedBytes = this.Encryptor.Encrypt(encryptionKey, typeMarker, plainText, plainTextLength);

itemJObj[propertyName] = encryptedBytes;
pathsEncrypted.Add(pathToEncrypt);
}

EncryptionProperties encryptionProperties = new (
encryptionFormatVersion: 3,
encryptionOptions.EncryptionAlgorithm,
encryptionOptions.DataEncryptionKeyId,
encryptedData: null,
pathsEncrypted);

itemJObj.Add(Constants.EncryptedInfo, JObject.FromObject(encryptionProperties));
#if NET8_0_OR_GREATER
await input.DisposeAsync();
#else
input.Dispose();
#endif
return EncryptionProcessor.BaseSerializer.ToStream(itemJObj);
_ => throw new InvalidOperationException("Unsupported JsonProcessor")
};
}

internal async Task<DecryptionContext> DecryptObjectAsync(
Expand All @@ -88,57 +43,7 @@ internal async Task<DecryptionContext> DecryptObjectAsync(
CosmosDiagnosticsContext diagnosticsContext,
CancellationToken cancellationToken)
{
_ = diagnosticsContext;

if (encryptionProperties.EncryptionFormatVersion != 3)
{
throw new NotSupportedException($"Unknown encryption format version: {encryptionProperties.EncryptionFormatVersion}. Please upgrade your SDK to the latest version.");
}

using ArrayPoolManager arrayPoolManager = new ();
using ArrayPoolManager<char> charPoolManager = new ();

DataEncryptionKey encryptionKey = await encryptor.GetEncryptionKeyAsync(encryptionProperties.DataEncryptionKeyId, encryptionProperties.EncryptionAlgorithm, cancellationToken);

List<string> pathsDecrypted = new (encryptionProperties.EncryptedPaths.Count());
foreach (string path in encryptionProperties.EncryptedPaths)
{
#if NET8_0_OR_GREATER
string propertyName = path[1..];
#else
string propertyName = path.Substring(1);
#endif

if (!document.TryGetValue(propertyName, out JToken propertyValue))
{
// malformed document, such record shouldn't be there at all
continue;
}

byte[] cipherTextWithTypeMarker = propertyValue.ToObject<byte[]>();
if (cipherTextWithTypeMarker == null)
{
continue;
}

(byte[] plainText, int decryptedCount) = this.Encryptor.Decrypt(encryptionKey, cipherTextWithTypeMarker, arrayPoolManager);

this.Serializer.DeserializeAndAddProperty(
(TypeMarker)cipherTextWithTypeMarker[0],
plainText.AsSpan(0, decryptedCount),
document,
propertyName,
charPoolManager);

pathsDecrypted.Add(path);
}

DecryptionContext decryptionContext = EncryptionProcessor.CreateDecryptionContext(
pathsDecrypted,
encryptionProperties.DataEncryptionKeyId);

document.Remove(Constants.EncryptedInfo);
return decryptionContext;
return await this.JObjectEncryptionProcessor.DecryptObjectAsync(document, encryptor, encryptionProperties, diagnosticsContext, cancellationToken);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,29 @@ internal virtual byte[] Encrypt(DataEncryptionKey encryptionKey, TypeMarker type
return encryptedText;
}

internal virtual (byte[], int) Encrypt(DataEncryptionKey encryptionKey, TypeMarker typeMarker, byte[] plainText, int plainTextLength, ArrayPoolManager arrayPoolManager)
{
int encryptedTextLength = encryptionKey.GetEncryptByteCount(plainTextLength) + 1;

byte[] encryptedText = arrayPoolManager.Rent(encryptedTextLength);

encryptedText[0] = (byte)typeMarker;

int encryptedLength = encryptionKey.EncryptData(
plainText,
plainTextOffset: 0,
plainTextLength,
encryptedText,
outputOffset: 1);

if (encryptedLength < 0)
{
throw new InvalidOperationException($"{nameof(DataEncryptionKey)} returned null cipherText from {nameof(DataEncryptionKey.EncryptData)}.");
}

return (encryptedText, encryptedTextLength);
}

internal virtual (byte[] plainText, int plainTextLength) Decrypt(DataEncryptionKey encryptionKey, byte[] cipherText, ArrayPoolManager arrayPoolManager)
{
int plainTextLength = encryptionKey.GetDecryptByteCount(cipherText.Length - 1);
Expand Down
Loading