Skip to content

Commit 7cbd34f

Browse files
simplynaveen20simplynaveen20
authored
Remove algorithm string from encryptionKeyWrapMetadata and converting MicrosoftDataEncryptionException to CosmosException (Azure#20845)
* Adding type on encryptionMetadata and coverting MicrosoftDataEncryptionException to CosmosException * correction class name of logger * Increasing the encryption length support to 8000 from 1024 * adding test case and fixing nested pojo array issue * updating plain text test * reverting change for encryptionKeyWrapMatadata * removing pojo to test plain text * updating test flow for new emulator * disabling asyncChangeFeed_fromNow_fullFidelity_forFullRange * fixing test for new emulator
1 parent 01dd7df commit 7cbd34f

File tree

6 files changed

+94
-41
lines changed

6 files changed

+94
-41
lines changed

‎sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/CosmosEncryptionAsyncClient.java‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,28 @@
33

44
package com.azure.cosmos.encryption;
55

6+
import com.azure.cosmos.BridgeInternal;
67
import com.azure.cosmos.CosmosAsyncClient;
78
import com.azure.cosmos.CosmosAsyncClientEncryptionKey;
89
import com.azure.cosmos.CosmosAsyncContainer;
910
import com.azure.cosmos.CosmosAsyncDatabase;
11+
import com.azure.cosmos.CosmosException;
12+
import com.azure.cosmos.encryption.implementation.EncryptionProcessor;
13+
import com.azure.cosmos.implementation.HttpConstants;
14+
import com.azure.cosmos.implementation.Utils;
1015
import com.azure.cosmos.implementation.caches.AsyncCache;
1116
import com.azure.cosmos.models.ClientEncryptionPolicy;
1217
import com.azure.cosmos.models.CosmosClientEncryptionKeyProperties;
1318
import com.microsoft.data.encryption.cryptography.EncryptionKeyStoreProvider;
19+
import org.slf4j.Logger;
20+
import org.slf4j.LoggerFactory;
1421
import reactor.core.publisher.Mono;
1522

1623
/**
1724
* CosmosClient with Encryption support.
1825
*/
1926
public class CosmosEncryptionAsyncClient {
27+
private final static Logger LOGGER = LoggerFactory.getLogger(CosmosEncryptionAsyncClient.class);
2028
private final CosmosAsyncClient cosmosAsyncClient;
2129
private final AsyncCache<String, ClientEncryptionPolicy> clientEncryptionPolicyCacheByContainerId;
2230
private final AsyncCache<String, CosmosClientEncryptionKeyProperties> clientEncryptionKeyPropertiesCacheByKeyId;
@@ -95,9 +103,26 @@ Mono<CosmosClientEncryptionKeyProperties> fetchClientEncryptionKeyPropertiesAsyn
95103

96104
return clientEncryptionKey.read().map(cosmosClientEncryptionKeyResponse ->
97105
cosmosClientEncryptionKeyResponse.getProperties()
98-
).onErrorResume(throwable -> Mono.error(new IllegalStateException("Encryption Based Container without Data " +
99-
"Encryption Keys. " +
100-
"Please make sure you have created the Client Encryption Keys", throwable)));
106+
).onErrorResume(throwable -> {
107+
Throwable unwrappedException = reactor.core.Exceptions.unwrap(throwable);
108+
if (!(unwrappedException instanceof Exception)) {
109+
// fatal error
110+
LOGGER.error("Unexpected failure {}", unwrappedException.getMessage(), unwrappedException);
111+
return Mono.error(unwrappedException);
112+
}
113+
Exception exception = (Exception) unwrappedException;
114+
CosmosException dce = Utils.as(exception, CosmosException.class);
115+
if (dce != null) {
116+
if (dce.getStatusCode() == HttpConstants.StatusCodes.NOTFOUND) {
117+
String message = "Encryption Based Container without Data Encryption Keys. " +
118+
"Please make sure you have created the Client Encryption Keys";
119+
return Mono.error(BridgeInternal.createCosmosException(HttpConstants.StatusCodes.NOTFOUND, message));
120+
}
121+
return Mono.error(dce);
122+
}
123+
124+
return Mono.error(exception);
125+
});
101126
}
102127

103128
/**

‎sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/implementation/EncryptionProcessor.java‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
package com.azure.cosmos.encryption.implementation;
55

6+
import com.azure.cosmos.BridgeInternal;
67
import com.azure.cosmos.CosmosAsyncContainer;
78
import com.azure.cosmos.encryption.CosmosEncryptionAsyncClient;
89
import com.azure.cosmos.encryption.EncryptionBridgeInternal;
@@ -55,7 +56,7 @@ public class EncryptionProcessor {
5556
private EncryptionSettings encryptionSettings;
5657
private AtomicBoolean isEncryptionSettingsInitDone;
5758
private ClientEncryptionPolicy clientEncryptionPolicy;
58-
private final static int STRING_SIZE_ENCRYPTION_LIMIT = 1024;
59+
private final static int STRING_SIZE_ENCRYPTION_LIMIT = 8000;
5960

6061
public EncryptionProcessor(CosmosAsyncContainer cosmosAsyncContainer,
6162
CosmosEncryptionAsyncClient encryptionCosmosClient) {
@@ -377,7 +378,7 @@ public void decryptAndSerializeProperty(EncryptionSettings encryptionSettings, O
377378
if (propertyValueHolder.isObject()) {
378379
for (Iterator<Map.Entry<String, JsonNode>> it = propertyValueHolder.fields(); it.hasNext(); ) {
379380
Map.Entry<String, JsonNode> child = it.next();
380-
if (child.getValue().isObject()) {
381+
if (child.getValue().isObject() || child.getValue().isArray()) {
381382
decryptAndSerializeProperty(encryptionSettings, (ObjectNode) propertyValueHolder,
382383
child.getValue(), propertyName);
383384
} else if (!child.getValue().isNull()) {
@@ -467,9 +468,10 @@ public static Pair<TypeMarker, byte[]> toByteArray(JsonNode jsonNode) {
467468
SqlSerializerFactory.getOrCreate("varchar", STRING_SIZE_ENCRYPTION_LIMIT, 0, 0, StandardCharsets.UTF_8.toString()).serialize(jsonNode.asText()));
468469
}
469470
} catch (MicrosoftDataEncryptionException ex) {
470-
throw new IllegalStateException("Unable to convert JSON to byte[]", ex);
471+
throw BridgeInternal.createCosmosException("Unable to convert JSON to byte[]", ex, null, 0, null);
471472
}
472-
throw new IncompatibleClassChangeError("Invalid or Unsupported Data Type Passed " + jsonNode.getNodeType());
473+
throw BridgeInternal.createCosmosException(0,
474+
"Invalid or Unsupported Data Type Passed " + jsonNode.getNodeType());
473475
}
474476

475477
public static JsonNode toJsonNode(byte[] serializedBytes, TypeMarker typeMarker) {
@@ -487,9 +489,9 @@ public static JsonNode toJsonNode(byte[] serializedBytes, TypeMarker typeMarker)
487489
STRING_SIZE_ENCRYPTION_LIMIT, 0, 0, StandardCharsets.UTF_8.toString()).deserialize(serializedBytes));
488490
}
489491
} catch (MicrosoftDataEncryptionException ex) {
490-
throw new IllegalStateException("Unable to convert byte[] to JSON", ex);
492+
throw BridgeInternal.createCosmosException("Unable to convert byte[] to JSON", ex, null, 0, null);
491493
}
492-
throw new IncompatibleClassChangeError("Invalid or Unsupported Data Type Passed " + typeMarker);
494+
throw BridgeInternal.createCosmosException(0, "Invalid or Unsupported Data Type Passed " + typeMarker);
493495
}
494496

495497
public enum TypeMarker {

‎sdk/cosmos/azure-cosmos-encryption/src/test/java/com/azure/cosmos/encryption/CosmosEncryptionClientCachesTest.java‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ public void before_CosmosItemTest() {
5959
new EncryptionCrudTest.TestEncryptionKeyStoreProvider());
6060
cosmosEncryptionAsyncDatabase =
6161
cosmosEncryptionAsyncClient.getCosmosEncryptionAsyncDatabase(cosmosDatabaseProperties.getId());
62+
//Create ClientEncryptionKeys
63+
metadata1 = new EncryptionKeyWrapMetadata("key1", "tempmetadata1");
64+
metadata2 = new EncryptionKeyWrapMetadata("key2", "tempmetadata2");
65+
cosmosEncryptionAsyncDatabase.createClientEncryptionKey("key1",
66+
CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256, metadata1).block();
67+
cosmosEncryptionAsyncDatabase.createClientEncryptionKey("key2",
68+
CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256, metadata2).block();
6269

6370
//Create collection with clientEncryptionPolicy
6471
ClientEncryptionPolicy clientEncryptionPolicy = new ClientEncryptionPolicy(EncryptionCrudTest.getPaths());
@@ -68,14 +75,6 @@ public void before_CosmosItemTest() {
6875
cosmosEncryptionAsyncDatabase.getCosmosAsyncDatabase().createContainer(containerProperties).block();
6976
cosmosEncryptionAsyncContainer =
7077
cosmosEncryptionAsyncDatabase.getCosmosEncryptionAsyncContainer(containerProperties.getId());
71-
72-
//Create collection with ClientEncryptionKeys
73-
metadata1 = new EncryptionKeyWrapMetadata("key1", "tempmetadata1");
74-
metadata2 = new EncryptionKeyWrapMetadata("key2", "tempmetadata2");
75-
cosmosEncryptionAsyncDatabase.createClientEncryptionKey("key1",
76-
CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256, metadata1).block();
77-
cosmosEncryptionAsyncDatabase.createClientEncryptionKey("key2",
78-
CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256, metadata2).block();
7978
}
8079

8180
@Test(groups = {"encryption"}, priority = 0, timeOut = TIMEOUT)

‎sdk/cosmos/azure-cosmos-encryption/src/test/java/com/azure/cosmos/encryption/EncryptionCrudTest.java‎

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
import com.azure.cosmos.CosmosAsyncClient;
77
import com.azure.cosmos.CosmosAsyncDatabase;
88
import com.azure.cosmos.CosmosClientBuilder;
9+
import com.azure.cosmos.CosmosException;
910
import com.azure.cosmos.encryption.models.CosmosEncryptionAlgorithm;
1011
import com.azure.cosmos.encryption.models.CosmosEncryptionType;
12+
import com.azure.cosmos.encryption.models.SqlQuerySpecWithEncryption;
1113
import com.azure.cosmos.models.ClientEncryptionIncludedPath;
1214
import com.azure.cosmos.models.ClientEncryptionPolicy;
1315
import com.azure.cosmos.models.CosmosContainerProperties;
@@ -19,7 +21,6 @@
1921
import com.azure.cosmos.models.PartitionKey;
2022
import com.azure.cosmos.models.SqlParameter;
2123
import com.azure.cosmos.models.SqlQuerySpec;
22-
import com.azure.cosmos.encryption.models.SqlQuerySpecWithEncryption;
2324
import com.azure.cosmos.rx.TestSuiteBase;
2425
import com.azure.cosmos.util.CosmosPagedFlux;
2526
import com.fasterxml.jackson.annotation.JsonProperty;
@@ -31,6 +32,7 @@
3132
import org.testng.annotations.Factory;
3233
import org.testng.annotations.Test;
3334

35+
import java.io.IOException;
3436
import java.util.ArrayList;
3537
import java.util.HashMap;
3638
import java.util.List;
@@ -65,19 +67,19 @@ public void before_CosmosItemTest() {
6567
cosmosEncryptionAsyncDatabase =
6668
cosmosEncryptionAsyncClient.getCosmosEncryptionAsyncDatabase(cosmosAsyncDatabase);
6769

68-
ClientEncryptionPolicy clientEncryptionPolicy = new ClientEncryptionPolicy(getPaths());
69-
String containerId = UUID.randomUUID().toString();
70-
CosmosContainerProperties properties = new CosmosContainerProperties(containerId, "/mypk");
71-
properties.setClientEncryptionPolicy(clientEncryptionPolicy);
72-
cosmosEncryptionAsyncDatabase.getCosmosAsyncDatabase().createContainer(properties).block();
73-
cosmosEncryptionAsyncContainer = cosmosEncryptionAsyncDatabase.getCosmosEncryptionAsyncContainer(containerId);
7470
metadata1 = new EncryptionKeyWrapMetadata("key1", "tempmetadata1");
7571
metadata2 = new EncryptionKeyWrapMetadata("key2", "tempmetadata2");
7672
cosmosEncryptionAsyncDatabase.createClientEncryptionKey("key1",
7773
CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256, metadata1).block();
7874
cosmosEncryptionAsyncDatabase.createClientEncryptionKey("key2",
7975
CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256, metadata2).block();
80-
cosmosEncryptionAsyncDatabase.rewrapClientEncryptionKey("key2", metadata2).block();
76+
77+
ClientEncryptionPolicy clientEncryptionPolicy = new ClientEncryptionPolicy(getPaths());
78+
String containerId = UUID.randomUUID().toString();
79+
CosmosContainerProperties properties = new CosmosContainerProperties(containerId, "/mypk");
80+
properties.setClientEncryptionPolicy(clientEncryptionPolicy);
81+
cosmosEncryptionAsyncDatabase.getCosmosAsyncDatabase().createContainer(properties).block();
82+
cosmosEncryptionAsyncContainer = cosmosEncryptionAsyncDatabase.getCosmosEncryptionAsyncContainer(containerId);
8183
}
8284

8385
@AfterClass(groups = {"encryption"}, timeOut = SHUTDOWN_TIMEOUT, alwaysRun = true)
@@ -87,7 +89,7 @@ public void afterClass() {
8789
}
8890

8991
@Test(groups = {"encryption"}, timeOut = TIMEOUT)
90-
public void createItemEncrypt_readItemDecrypt() {
92+
public void createItemEncrypt_readItemDecrypt() throws MicrosoftDataEncryptionException, IOException {
9193
Pojo properties = getItem(UUID.randomUUID().toString());
9294
CosmosItemResponse<Pojo> itemResponse = cosmosEncryptionAsyncContainer.createItem(properties,
9395
new PartitionKey(properties.mypk), new CosmosItemRequestOptions()).block();
@@ -98,10 +100,35 @@ public void createItemEncrypt_readItemDecrypt() {
98100
Pojo readItem = cosmosEncryptionAsyncContainer.readItem(properties.id, new PartitionKey(properties.mypk),
99101
new CosmosItemRequestOptions(), Pojo.class).block().getItem();
100102
validateResponse(properties, readItem);
103+
104+
//Check for max length support of 8000
105+
properties = getItem(UUID.randomUUID().toString());
106+
String longString = "";
107+
for (int i = 0; i < 8000; i++) {
108+
longString += "a";
109+
}
110+
properties.sensitiveString = longString;
111+
itemResponse = cosmosEncryptionAsyncContainer.createItem(properties,
112+
new PartitionKey(properties.mypk), new CosmosItemRequestOptions()).block();
113+
assertThat(itemResponse.getRequestCharge()).isGreaterThan(0);
114+
responseItem = itemResponse.getItem();
115+
validateResponse(properties, responseItem);
116+
117+
//Check for exception for length greater that 8000
118+
longString += "a";
119+
properties.sensitiveString = longString;
120+
try {
121+
cosmosEncryptionAsyncContainer.createItem(properties,
122+
new PartitionKey(properties.mypk), new CosmosItemRequestOptions()).block();
123+
fail("Item create should fail as length of encryption field is greater than 8000");
124+
} catch (CosmosException ex) {
125+
assertThat(ex.getMessage()).contains("Unable to convert JSON to byte[]");
126+
assertThat(ex.getCause() instanceof MicrosoftDataEncryptionException).isTrue();
127+
}
101128
}
102129

103130
@Test(groups = {"encryption"}, timeOut = TIMEOUT)
104-
public void upsertItem_readItem() throws Exception {
131+
public void upsertItem_readItem() {
105132
Pojo properties = getItem(UUID.randomUUID().toString());
106133
CosmosItemResponse<Pojo> itemResponse = cosmosEncryptionAsyncContainer.upsertItem(properties,
107134
new PartitionKey(properties.mypk), new CosmosItemRequestOptions()).block();
@@ -299,7 +326,6 @@ private void validateResponse(Pojo originalItem, Pojo result) {
299326
assertThat(result.sensitiveChildPojo2DArray[0][0].sensitiveIntArray).isEqualTo(originalItem.sensitiveChildPojo2DArray[0][0].sensitiveIntArray);
300327
assertThat(result.sensitiveChildPojo2DArray[0][0].sensitiveStringArray).isEqualTo(originalItem.sensitiveChildPojo2DArray[0][0].sensitiveStringArray);
301328
assertThat(result.sensitiveChildPojo2DArray[0][0].sensitiveString3DArray).isEqualTo(originalItem.sensitiveChildPojo2DArray[0][0].sensitiveString3DArray);
302-
303329
}
304330

305331
public static Pojo getItem(String documentId) {
@@ -316,10 +342,14 @@ public static Pojo getItem(String documentId) {
316342

317343
Pojo nestedPojo = new Pojo();
318344
nestedPojo.id = "nestedPojo";
345+
nestedPojo.mypk = "nestedPojo";
319346
nestedPojo.sensitiveString = "nestedPojo";
320347
nestedPojo.sensitiveDouble = 10.123;
321348
nestedPojo.sensitiveInt = 123;
322349
nestedPojo.sensitiveLong = 1234;
350+
nestedPojo.sensitiveStringArray = new String[]{"str1", "str1"};
351+
nestedPojo.sensitiveString3DArray = new String[][][]{{{"str1", "str2"}, {"str3", "str4"}}, {{"str5", "str6"}, {
352+
"str7", "str8"}}};
323353
nestedPojo.sensitiveBoolean = true;
324354

325355
pojo.sensitiveNestedPojo = nestedPojo;
@@ -336,7 +366,9 @@ public static Pojo getItem(String documentId) {
336366
childPojo1.sensitiveInt = 123;
337367
childPojo1.sensitiveLong = 1234;
338368
childPojo1.sensitiveBoolean = true;
339-
369+
childPojo1.sensitiveStringArray = new String[]{"str1", "str1"};
370+
childPojo1.sensitiveString3DArray = new String[][][]{{{"str1", "str2"}, {"str3", "str4"}}, {{"str5", "str6"}, {
371+
"str7", "str8"}}};
340372
Pojo childPojo2 = new Pojo();
341373
childPojo2.id = "childPojo2";
342374
childPojo2.sensitiveString = "child2TestingString";
@@ -475,7 +507,6 @@ public static List<ClientEncryptionIncludedPath> getPaths() {
475507
includedPath8.setEncryptionType(CosmosEncryptionType.DETERMINISTIC);
476508
includedPath8.setEncryptionAlgorithm(CosmosEncryptionAlgorithm.AEAES_256_CBC_HMAC_SHA_256);
477509

478-
479510
ClientEncryptionIncludedPath includedPath9 = new ClientEncryptionIncludedPath();
480511
includedPath9.setClientEncryptionKeyId("key1");
481512
includedPath9.setPath("/sensitiveIntArray");

‎sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/EncryptionKeyWrapMetadata.java‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public EncryptionKeyWrapMetadata() {
3131
@Beta(value = Beta.SinceVersion.V4_14_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
3232
public EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source) {
3333
this.type = source.type;
34-
this.algorithm = source.algorithm;
34+
this.name = source.name;
3535
this.value = source.value;
3636
}
3737

@@ -43,26 +43,21 @@ public EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source) {
4343
*/
4444
@Beta(value = Beta.SinceVersion.V4_14_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
4545
public EncryptionKeyWrapMetadata(String name, String value) {
46-
this("custom", name, value, null);
46+
this("custom", name, value);
4747
}
4848

49-
private EncryptionKeyWrapMetadata(String type, String name, String value, String algorithm) {
49+
private EncryptionKeyWrapMetadata(String type, String name, String value) {
5050
Preconditions.checkNotNull(type, "type is null");
5151
Preconditions.checkNotNull(value, "value is null");
5252
this.type = type;
5353
this.name = name;
5454
this.value = value;
55-
this.algorithm = algorithm;
5655
}
5756

5857
@JsonProperty("type")
5958
@JsonInclude(JsonInclude.Include.NON_NULL)
6059
private String type;
6160

62-
@JsonProperty("algorithm")
63-
@JsonInclude(JsonInclude.Include.NON_NULL)
64-
private String algorithm;
65-
6661
@JsonProperty("value")
6762
@JsonInclude(JsonInclude.Include.NON_NULL)
6863
private String value;
@@ -107,13 +102,13 @@ public boolean equals(Object obj) {
107102
if (obj == null || getClass() != obj.getClass()) return false;
108103
EncryptionKeyWrapMetadata that = (EncryptionKeyWrapMetadata) obj;
109104
return Objects.equals(type, that.type) &&
110-
Objects.equals(algorithm, that.algorithm) &&
105+
Objects.equals(name, that.name) &&
111106
Objects.equals(value, that.value);
112107
}
113108

114109
@Override
115110
public int hashCode() {
116-
return Objects.hash(type, algorithm, value);
111+
return Objects.hash(type, name, value);
117112
}
118113

119114
}

‎sdk/cosmos/azure-cosmos/src/test/java/com/azure/cosmos/CosmosContainerChangeFeedTest.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,8 @@ public void asyncChangeFeed_fromNow_incremental_forFullRange() throws Exception
414414
drainAndValidateChangeFeedResults(options, null, expectedEventCountAfterUpdates);
415415
}
416416

417-
@Test(groups = { "emulator" }, timeOut = TIMEOUT)
417+
//TODO Temporarily disabling
418+
@Test(groups = { "emulator" }, timeOut = TIMEOUT, enabled = false)
418419
public void asyncChangeFeed_fromNow_fullFidelity_forFullRange() throws Exception {
419420
this.createContainer(
420421
(cp) -> cp.setChangeFeedPolicy(ChangeFeedPolicy.createFullFidelityPolicy(Duration.ofMinutes(10)))

0 commit comments

Comments
 (0)