Skip to content

Commit 4126efa

Browse files
rishav-karanjitrishav-karanjit
authored
chore: Rename Directkmsmaterialsprovider to Directkmsmaterialprovider (#2150)
1 parent afa621c commit 4126efa

10 files changed

Lines changed: 52 additions & 78 deletions

File tree

DynamoDbEncryption/runtimes/java/src/main/sdkv2/com/amazonaws/services/dynamodbv2/datamodeling/sdkv2/encryption/providers/DirectKmsMaterialsProvider.java renamed to DynamoDbEncryption/runtimes/java/src/main/sdkv2/com/amazonaws/services/dynamodbv2/datamodeling/sdkv2/encryption/providers/DirectKmsMaterialProvider.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
*
5050
* @see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html">KMS Encryption Context</a>
5151
*/
52-
public class DirectKmsMaterialsProvider implements EncryptionMaterialsProvider {
52+
public class DirectKmsMaterialProvider implements EncryptionMaterialsProvider {
5353

5454
private static final String COVERED_ATTR_CTX_KEY = "aws-kms-ec-attr";
5555
private static final String SIGNING_KEY_ALGORITHM = "amzn-ddb-sig-alg";
@@ -72,11 +72,11 @@ public class DirectKmsMaterialsProvider implements EncryptionMaterialsProvider {
7272
private final int sigKeyLength;
7373
private final String sigKeyDesc;
7474

75-
public DirectKmsMaterialsProvider(KmsClient kms) {
75+
public DirectKmsMaterialProvider(KmsClient kms) {
7676
this(kms, null);
7777
}
7878

79-
public DirectKmsMaterialsProvider(
79+
public DirectKmsMaterialProvider(
8080
KmsClient kms,
8181
String encryptionKeyId,
8282
Map<String, String> materialDescription
@@ -106,7 +106,7 @@ public DirectKmsMaterialsProvider(
106106
this.sigKeyLength = parts.length == 2 ? Integer.parseInt(parts[1]) : 256;
107107
}
108108

109-
public DirectKmsMaterialsProvider(KmsClient kms, String encryptionKeyId) {
109+
public DirectKmsMaterialProvider(KmsClient kms, String encryptionKeyId) {
110110
this(kms, encryptionKeyId, Collections.emptyMap());
111111
}
112112

@@ -249,7 +249,7 @@ protected String getEncryptionKeyId() {
249249

250250
/**
251251
* Select encryption key id to be used to generate data key. The default implementation of this method returns
252-
* {@link DirectKmsMaterialsProvider#encryptionKeyId}.
252+
* {@link DirectKmsMaterialProvider#encryptionKeyId}.
253253
*
254254
* @param context encryption context.
255255
* @return the encryptionKeyId.
@@ -344,7 +344,7 @@ private static void populateKmsEcFromEc(
344344
);
345345
} else {
346346
throw new UnsupportedOperationException(
347-
"DirectKmsMaterialsProvider only supports String, Number, and Binary HashKeys"
347+
"DirectKmsMaterialProvider only supports String, Number, and Binary HashKeys"
348348
);
349349
}
350350
}
@@ -369,7 +369,7 @@ private static void populateKmsEcFromEc(
369369
);
370370
} else {
371371
throw new UnsupportedOperationException(
372-
"DirectKmsMaterialsProvider only supports String, Number, and Binary RangeKeys"
372+
"DirectKmsMaterialProvider only supports String, Number, and Binary RangeKeys"
373373
);
374374
}
375375
}

‎DynamoDbEncryption/runtimes/java/src/test/sdkv2/com/amazonaws/services/dynamodbv2/datamodeling/sdkv2/HolisticIT.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionFlags;
1111
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.AsymmetricStaticProvider;
1212
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.CachingMostRecentProvider;
13-
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialsProvider;
13+
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialProvider;
1414
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.EncryptionMaterialsProvider;
1515
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.SymmetricStaticProvider;
1616
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.WrappedMaterialsProvider;
@@ -872,13 +872,13 @@ private EncryptionMaterialsProvider createProvider(
872872
}
873873
case ScenarioManifest.AWS_KMS_PROVIDER_NAME:
874874
if (materialDescription != null && !materialDescription.isEmpty()) {
875-
return new DirectKmsMaterialsProvider(
875+
return new DirectKmsMaterialProvider(
876876
kmsClient,
877877
keyDataMap.get(keys.decryptName).keyId,
878878
materialDescription
879879
);
880880
}
881-
return new DirectKmsMaterialsProvider(
881+
return new DirectKmsMaterialProvider(
882882
kmsClient,
883883
keyDataMap.get(keys.decryptName).keyId
884884
);

‎DynamoDbEncryption/runtimes/java/src/test/sdkv2/com/amazonaws/services/dynamodbv2/datamodeling/sdkv2/HolisticITHelper.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.DynamoDBEncryptor;
88
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionContext;
99
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionFlags;
10-
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialsProvider;
10+
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialProvider;
1111
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.testing.DdbRecordMatcher;
1212
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.testing.ScenarioManifest;
1313
import com.fasterxml.jackson.core.type.TypeReference;
@@ -114,7 +114,7 @@ public static void decryptNonBmpHashKeyVectorAndWithNullKeyId(
114114
loadKeyData(scenarioManifest.keyDataPath);
115115

116116
DynamoDBEncryptor encryptor = DynamoDBEncryptor.getInstance(
117-
new DirectKmsMaterialsProvider(kmsClient)
117+
new DirectKmsMaterialProvider(kmsClient)
118118
);
119119
EncryptionContext ctx = EncryptionContext
120120
.builder()

DynamoDbEncryption/runtimes/java/src/test/sdkv2/com/amazonaws/services/dynamodbv2/datamodeling/sdkv2/encryption/providers/DirectKmsMaterialsProviderTest.java renamed to DynamoDbEncryption/runtimes/java/src/test/sdkv2/com/amazonaws/services/dynamodbv2/datamodeling/sdkv2/encryption/providers/DirectKmsMaterialProviderTest.java

Lines changed: 18 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
import software.amazon.awssdk.services.kms.model.GenerateDataKeyRequest;
4646
import software.amazon.awssdk.services.kms.model.GenerateDataKeyResponse;
4747

48-
public class DirectKmsMaterialsProviderTest {
48+
public class DirectKmsMaterialProviderTest {
4949

5050
private FakeKMS kms;
5151
private String keyId;
@@ -64,10 +64,7 @@ public void setUp() {
6464

6565
@Test
6666
public void simple() {
67-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
68-
kms,
69-
keyId
70-
);
67+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
7168

7269
EncryptionMaterials eMat = prov.getEncryptionMaterials(ctx);
7370
SecretKey encryptionKey = eMat.getEncryptionKey();
@@ -96,10 +93,7 @@ public void simple() {
9693

9794
@Test
9895
public void simpleWithKmsEc() {
99-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
100-
kms,
101-
keyId
102-
);
96+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
10397

10498
Map<String, AttributeValue> attrVals = new HashMap<>();
10599
attrVals.put("hk", AttributeValue.builder().s("HashKeyValue").build());
@@ -136,10 +130,7 @@ public void simpleWithKmsEc() {
136130

137131
@Test
138132
public void simpleWithKmsEc2() throws GeneralSecurityException {
139-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
140-
kms,
141-
keyId
142-
);
133+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
143134

144135
Map<String, AttributeValue> attrVals = new HashMap<>();
145136
attrVals.put("hk", AttributeValue.builder().n("10").build());
@@ -176,10 +167,7 @@ public void simpleWithKmsEc2() throws GeneralSecurityException {
176167

177168
@Test
178169
public void simpleWithKmsEc3() throws GeneralSecurityException {
179-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
180-
kms,
181-
keyId
182-
);
170+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
183171

184172
Map<String, AttributeValue> attrVals = new HashMap<>();
185173
attrVals.put(
@@ -243,10 +231,7 @@ public void simpleWithKmsEc3() throws GeneralSecurityException {
243231

244232
@Test
245233
public void randomEnvelopeKeys() throws GeneralSecurityException {
246-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
247-
kms,
248-
keyId
249-
);
234+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
250235

251236
EncryptionMaterials eMat = prov.getEncryptionMaterials(ctx);
252237
SecretKey encryptionKey = eMat.getEncryptionKey();
@@ -264,10 +249,7 @@ public void randomEnvelopeKeys() throws GeneralSecurityException {
264249
@Test
265250
public void testRefresh() {
266251
// This does nothing, make sure we don't throw and exception.
267-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
268-
kms,
269-
keyId
270-
);
252+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
271253
prov.refresh();
272254
}
273255

@@ -276,7 +258,7 @@ public void explicitContentKeyAlgorithm() throws GeneralSecurityException {
276258
Map<String, String> desc = new HashMap<>();
277259
desc.put(WrappedRawMaterials.CONTENT_KEY_ALGORITHM, "AES");
278260

279-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
261+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(
280262
kms,
281263
keyId,
282264
desc
@@ -301,7 +283,7 @@ public void explicitContentKeyLength128() throws GeneralSecurityException {
301283
Map<String, String> desc = new HashMap<>();
302284
desc.put(WrappedRawMaterials.CONTENT_KEY_ALGORITHM, "AES/128");
303285

304-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
286+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(
305287
kms,
306288
keyId,
307289
desc
@@ -328,7 +310,7 @@ public void explicitContentKeyLength256() throws GeneralSecurityException {
328310
Map<String, String> desc = new HashMap<>();
329311
desc.put(WrappedRawMaterials.CONTENT_KEY_ALGORITHM, "AES/256");
330312

331-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
313+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(
332314
kms,
333315
keyId,
334316
desc
@@ -398,7 +380,7 @@ public void extendedWithDerivedEncryptionKeyId() {
398380

399381
@Test(expectedExceptions = SdkException.class)
400382
public void encryptionKeyIdMismatch() throws SdkException {
401-
DirectKmsMaterialsProvider directProvider = new DirectKmsMaterialsProvider(
383+
DirectKmsMaterialProvider directProvider = new DirectKmsMaterialProvider(
402384
kms,
403385
keyId
404386
);
@@ -469,12 +451,12 @@ public GenerateDataKeyResponse generateDataKey(GenerateDataKeyRequest r) {
469451
}
470452
};
471453
assertFalse(gdkCalled.get());
472-
new DirectKmsMaterialsProvider(kmsSpy, keyId).getEncryptionMaterials(ctx);
454+
new DirectKmsMaterialProvider(kmsSpy, keyId).getEncryptionMaterials(ctx);
473455
assertTrue(gdkCalled.get());
474456
}
475457

476458
private static class ExtendedKmsMaterialsProvider
477-
extends DirectKmsMaterialsProvider {
459+
extends DirectKmsMaterialProvider {
478460

479461
private final String encryptionKeyIdAttributeName;
480462

@@ -553,15 +535,12 @@ private static EncryptionContext ctx(EncryptionMaterials mat) {
553535

554536
@Test(expectedExceptions = NullPointerException.class)
555537
public void constructorNullKmsClient() {
556-
new DirectKmsMaterialsProvider(null, keyId);
538+
new DirectKmsMaterialProvider(null, keyId);
557539
}
558540

559541
@Test(expectedExceptions = UnsupportedOperationException.class)
560542
public void unsupportedHashKeyType() {
561-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
562-
kms,
563-
keyId
564-
);
543+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
565544
Map<String, AttributeValue> attrVals = new HashMap<>();
566545
attrVals.put("hk", AttributeValue.builder().bool(true).build());
567546
EncryptionContext boolCtx = new EncryptionContext.Builder()
@@ -573,10 +552,7 @@ public void unsupportedHashKeyType() {
573552

574553
@Test(expectedExceptions = UnsupportedOperationException.class)
575554
public void unsupportedRangeKeyType() {
576-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
577-
kms,
578-
keyId
579-
);
555+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
580556
Map<String, AttributeValue> attrVals = new HashMap<>();
581557
attrVals.put("hk", AttributeValue.builder().s("HashKeyValue").build());
582558
attrVals.put("rk", AttributeValue.builder().bool(true).build());
@@ -590,10 +566,7 @@ public void unsupportedRangeKeyType() {
590566

591567
@Test(expectedExceptions = NullPointerException.class)
592568
public void hashKeyMissingFromAttributeValues() {
593-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
594-
kms,
595-
keyId
596-
);
569+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
597570
EncryptionContext missingCtx = new EncryptionContext.Builder()
598571
.hashKeyName("hk")
599572
.attributeValues(Collections.emptyMap())
@@ -603,10 +576,7 @@ public void hashKeyMissingFromAttributeValues() {
603576

604577
@Test(expectedExceptions = NullPointerException.class)
605578
public void rangeKeyMissingFromAttributeValues() {
606-
DirectKmsMaterialsProvider prov = new DirectKmsMaterialsProvider(
607-
kms,
608-
keyId
609-
);
579+
DirectKmsMaterialProvider prov = new DirectKmsMaterialProvider(kms, keyId);
610580
Map<String, AttributeValue> attrVals = new HashMap<>();
611581
attrVals.put("hk", AttributeValue.builder().s("HashKeyValue").build());
612582
EncryptionContext missingCtx = new EncryptionContext.Builder()

‎Examples/runtimes/java/DDBECwithSDKV2/src/main/java/AwsKmsEncryptedItem.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.DynamoDBEncryptor;
55
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionContext;
66
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionFlags;
7-
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialsProvider;
7+
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialProvider;
88
import java.security.GeneralSecurityException;
99
import java.util.EnumSet;
1010
import java.util.HashMap;
@@ -54,8 +54,8 @@ public static void encryptRecord(
5454
);
5555
record.put(IGNORED_FIELD_NAME, AttributeValue.builder().s("alone").build());
5656

57-
// Create DirectKmsMaterialsProvider
58-
final DirectKmsMaterialsProvider cmp = new DirectKmsMaterialsProvider(
57+
// Create DirectKmsMaterialProvider
58+
final DirectKmsMaterialProvider cmp = new DirectKmsMaterialProvider(
5959
kmsClient,
6060
cmkArn
6161
);

‎Examples/runtimes/java/DDBECwithSDKV2/src/main/java/AwsKmsMultiRegionKey.java‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.DynamoDBEncryptor;
55
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionContext;
66
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionFlags;
7-
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialsProvider;
7+
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialProvider;
88
import java.security.GeneralSecurityException;
99
import java.util.EnumSet;
1010
import java.util.HashMap;
@@ -104,8 +104,10 @@ public static void encryptRecord(
104104
record.put(IGNORED_FIELD_NAME, AttributeValue.builder().s("alone").build());
105105

106106
// Set up encryptor with first region's KMS key
107-
final DirectKmsMaterialsProvider cmpEncrypt =
108-
new DirectKmsMaterialsProvider(kmsEncrypt, cmkArnEncrypt);
107+
final DirectKmsMaterialProvider cmpEncrypt = new DirectKmsMaterialProvider(
108+
kmsEncrypt,
109+
cmkArnEncrypt
110+
);
109111
final DynamoDBEncryptor encryptor = DynamoDBEncryptor.getInstance(
110112
cmpEncrypt
111113
);
@@ -149,8 +151,10 @@ public static void encryptRecord(
149151
);
150152

151153
// Set up decryptor using the replica key from second region
152-
final DirectKmsMaterialsProvider cmpDecrypt =
153-
new DirectKmsMaterialsProvider(kmsDecrypt, cmkArnDecrypt);
154+
final DirectKmsMaterialProvider cmpDecrypt = new DirectKmsMaterialProvider(
155+
kmsDecrypt,
156+
cmkArnDecrypt
157+
);
154158
final DynamoDBEncryptor decryptor = DynamoDBEncryptor.getInstance(
155159
cmpDecrypt
156160
);

‎Examples/runtimes/java/DDBECwithSDKV2/src/main/java/MostRecentEncryptedItem.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionContext;
66
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.EncryptionFlags;
77
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.CachingMostRecentProvider;
8-
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialsProvider;
8+
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialProvider;
99
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.store.MetaStore;
1010
import java.security.GeneralSecurityException;
1111
import java.util.EnumSet;
@@ -22,7 +22,7 @@
2222

2323
/**
2424
* This demonstrates how to use the CachingMostRecentProvider backed by a MetaStore
25-
* and the DirectKmsMaterialsProvider to encrypt your data.
25+
* and the DirectKmsMaterialProvider to encrypt your data.
2626
*/
2727
public class MostRecentEncryptedItem {
2828

@@ -62,7 +62,7 @@ public static void encryptRecord(
6262
record.put(IGNORED_FIELD_NAME, AttributeValue.builder().s("alone").build());
6363

6464
// Provider Configuration to protect the data keys
65-
final DirectKmsMaterialsProvider kmsProv = new DirectKmsMaterialsProvider(
65+
final DirectKmsMaterialProvider kmsProv = new DirectKmsMaterialProvider(
6666
kmsClient,
6767
cmkArn
6868
);

‎Examples/runtimes/java/Migration/DDBECv2ToAWSDBE/src/main/java/software/amazon/cryptography/examples/migration/awsdbe/MigrationExampleStep1.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package software.amazon.cryptography.examples.migration.awsdbe;
22

33
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.DynamoDBEncryptor;
4-
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialsProvider;
4+
import com.amazonaws.services.dynamodbv2.datamodeling.sdkv2.encryption.providers.DirectKmsMaterialProvider;
55
import java.util.Arrays;
66
import java.util.HashMap;
77
import java.util.List;
@@ -100,7 +100,7 @@ public static void MigrationStep1(
100100

101101
// 5. Configure the same DynamoDBEncryptor that we did in Step 0.
102102
final KmsClient kmsClient = KmsClient.create();
103-
final DirectKmsMaterialsProvider cmp = new DirectKmsMaterialsProvider(
103+
final DirectKmsMaterialProvider cmp = new DirectKmsMaterialProvider(
104104
kmsClient,
105105
kmsKeyId
106106
);

0 commit comments

Comments
 (0)