-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathAdditionalDecryptionKeyMaterialTest.java
More file actions
923 lines (786 loc) · 40 KB
/
AdditionalDecryptionKeyMaterialTest.java
File metadata and controls
923 lines (786 loc) · 40 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package software.amazon.encryption.s3;
import org.junit.jupiter.api.BeforeAll;
import org.junitpioneer.jupiter.RetryingTest;
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.encryption.s3.materials.AesKeyring;
import software.amazon.encryption.s3.materials.MaterialsDescription;
import software.amazon.encryption.s3.materials.PartialRsaKeyPair;
import software.amazon.encryption.s3.materials.RawKeyMaterial;
import software.amazon.encryption.s3.materials.RsaKeyring;
import javax.crypto.KeyGenerator;
import javax.crypto.SecretKey;
import java.security.KeyPair;
import java.security.KeyPairGenerator;
import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Map;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static software.amazon.encryption.s3.utils.S3EncryptionClientTestResources.BUCKET;
import static software.amazon.encryption.s3.utils.S3EncryptionClientTestResources.appendTestSuffix;
import static software.amazon.encryption.s3.utils.S3EncryptionClientTestResources.deleteObject;
/**
* This class is an integration test for verifying the additionalDecryptionKeyMaterial feature
* in the S3EncryptionClient.
*/
public class AdditionalDecryptionKeyMaterialTest {
private static SecretKey AES_KEY_1;
private static SecretKey AES_KEY_2;
private static SecretKey AES_KEY_3;
private static KeyPair RSA_KEY_PAIR_1;
private static KeyPair RSA_KEY_PAIR_2;
private static KeyPair RSA_KEY_PAIR_3;
@BeforeAll
public static void setUp() throws NoSuchAlgorithmException {
// Generate AES keys
KeyGenerator keyGen = KeyGenerator.getInstance("AES");
keyGen.init(256);
AES_KEY_1 = keyGen.generateKey();
AES_KEY_2 = keyGen.generateKey();
AES_KEY_3 = keyGen.generateKey();
// Generate RSA key pairs
KeyPairGenerator keyPairGen = KeyPairGenerator.getInstance("RSA");
keyPairGen.initialize(2048);
RSA_KEY_PAIR_1 = keyPairGen.generateKeyPair();
RSA_KEY_PAIR_2 = keyPairGen.generateKeyPair();
RSA_KEY_PAIR_3 = keyPairGen.generateKeyPair();
}
/**
* Test AES keyring with null additionalDecryptionKeyMaterial map.
* This tests the default behavior when no additional key material is provided.
*/
@RetryingTest(3)
public void testAesKeyringWithNullAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("aes-null-additional-key-material");
final String input = "AES with null additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an AES keyring with the first key and materials description
AesKeyring encryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create an AES keyring with the same key but null additionalDecryptionKeyMaterial
AesKeyring decryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(null) // Explicitly set to null
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test AES keyring with empty additionalDecryptionKeyMaterial map.
* This tests the behavior when an empty map is provided.
*/
@RetryingTest(3)
public void testAesKeyringWithEmptyAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("aes-empty-additional-key-material");
final String input = "AES with empty additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an AES keyring with the first key and materials description
AesKeyring encryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create an AES keyring with the same key but empty additionalDecryptionKeyMaterial
Map<MaterialsDescription, RawKeyMaterial<SecretKey>> emptyMap = new HashMap<>();
AesKeyring decryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(emptyMap) // Empty map
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test AES keyring with a singleton additionalDecryptionKeyMaterial map.
* This tests the behavior when a single additional key material is provided.
*/
@RetryingTest(3)
public void testAesKeyringWithSingletonAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("aes-singleton-additional-key-material");
final String input = "AES with singleton additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an AES keyring with the first key and materials description
AesKeyring encryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a singleton map with the matching materials description and the same key used for encryption
Map<MaterialsDescription, RawKeyMaterial<SecretKey>> singletonMap = new HashMap<>();
singletonMap.put(materialsDescription, RawKeyMaterial.<SecretKey>builder()
.materialsDescription(materialsDescription)
.keyMaterial(AES_KEY_1) // Use the same key that was used for encryption
.build());
// Create an AES keyring with a different key but with additionalDecryptionKeyMaterial containing the original key
AesKeyring decryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_3) // Different key than what was used for encryption
.materialsDescription(MaterialsDescription.builder().put("different", "description").build())
.additionalDecryptionKeyMaterial(singletonMap) // Contains the key that matches the materials description
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test AES keyring with multiple entries in the additionalDecryptionKeyMaterial map.
* This tests the behavior when multiple additional key materials are provided.
*/
@RetryingTest(3)
public void testAesKeyringWithMultipleAdditionalKeyMaterials() {
final String objectKey = appendTestSuffix("aes-multiple-additional-key-materials");
final String input = "AES with multiple additional key materials";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an AES keyring with the first key and materials description
AesKeyring encryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a map with multiple entries
Map<MaterialsDescription, RawKeyMaterial<SecretKey>> multipleMap = new HashMap<>();
// Add an entry that doesn't match
MaterialsDescription nonMatchingDesc = MaterialsDescription.builder()
.put("purpose", "different")
.put("version", "2")
.build();
multipleMap.put(nonMatchingDesc, RawKeyMaterial.<SecretKey>builder()
.materialsDescription(nonMatchingDesc)
.keyMaterial(AES_KEY_2)
.build());
// Add the matching entry
multipleMap.put(materialsDescription, RawKeyMaterial.<SecretKey>builder()
.materialsDescription(materialsDescription)
.keyMaterial(AES_KEY_1)
.build());
// Create an AES keyring with a different key but with additionalDecryptionKeyMaterial containing the original key
AesKeyring decryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_3) // Different key than what was used for encryption
.materialsDescription(MaterialsDescription.builder().put("different", "description").build())
.additionalDecryptionKeyMaterial(multipleMap) // Contains the key that matches the materials description
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test AES keyring with additionalDecryptionKeyMaterial that doesn't match.
* This tests the behavior when no matching key material is found and it should fall back to the default key.
*/
@RetryingTest(3)
public void testAesKeyringWithNonMatchingAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("aes-non-matching-additional-key-material");
final String input = "AES with non-matching additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an AES keyring with the first key and materials description
AesKeyring encryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a map with a non-matching entry
Map<MaterialsDescription, RawKeyMaterial<SecretKey>> nonMatchingMap = new HashMap<>();
MaterialsDescription nonMatchingDesc = MaterialsDescription.builder()
.put("purpose", "different")
.put("version", "2")
.build();
nonMatchingMap.put(nonMatchingDesc, RawKeyMaterial.<SecretKey>builder()
.materialsDescription(nonMatchingDesc)
.keyMaterial(AES_KEY_2)
.build());
// Create an AES keyring with the correct key as the default but with non-matching additionalDecryptionKeyMaterial
AesKeyring decryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1) // Same key as used for encryption
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(nonMatchingMap) // Contains a key that doesn't match
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test AES keyring with additionalDecryptionKeyMaterial that doesn't match and a wrong default key.
* This tests the behavior when no matching key material is found and the default key is also wrong.
*/
@RetryingTest(3)
public void testAesKeyringWithNonMatchingAdditionalKeyMaterialAndWrongDefaultKey() {
final String objectKey = appendTestSuffix("aes-non-matching-additional-key-material-wrong-default");
final String input = "AES with non-matching additional key material and wrong default key";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an AES keyring with the first key and materials description
AesKeyring encryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_1)
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a map with a non-matching entry
Map<MaterialsDescription, RawKeyMaterial<SecretKey>> nonMatchingMap = new HashMap<>();
MaterialsDescription nonMatchingDesc = MaterialsDescription.builder()
.put("purpose", "different")
.put("version", "2")
.build();
nonMatchingMap.put(nonMatchingDesc, RawKeyMaterial.<SecretKey>builder()
.materialsDescription(nonMatchingDesc)
.keyMaterial(AES_KEY_2)
.build());
// Create an AES keyring with a wrong default key and non-matching additionalDecryptionKeyMaterial
AesKeyring decryptionKeyring = AesKeyring.builder()
.wrappingKey(AES_KEY_3) // Different key than what was used for encryption
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(nonMatchingMap) // Contains a key that doesn't match
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Attempt to decrypt the object, which should fail
assertThrows(S3EncryptionClientException.class, () -> decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build()));
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test RSA keyring with null additionalDecryptionKeyMaterial map.
* This tests the default behavior when no additional key material is provided.
*/
@RetryingTest(3)
public void testRsaKeyringWithNullAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("rsa-null-additional-key-material");
final String input = "RSA with null additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an RSA keyring with the first key pair and materials description
RsaKeyring encryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create an RSA keyring with the same key pair but null additionalDecryptionKeyMaterial
RsaKeyring decryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(null) // Explicitly set to null
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test RSA keyring with empty additionalDecryptionKeyMaterial map.
* This tests the behavior when an empty map is provided.
*/
@RetryingTest(3)
public void testRsaKeyringWithEmptyAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("rsa-empty-additional-key-material");
final String input = "RSA with empty additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an RSA keyring with the first key pair and materials description
RsaKeyring encryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create an RSA keyring with the same key pair but empty additionalDecryptionKeyMaterial
Map<MaterialsDescription, RawKeyMaterial<PartialRsaKeyPair>> emptyMap = new HashMap<>();
RsaKeyring decryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(emptyMap) // Empty map
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test RSA keyring with a singleton additionalDecryptionKeyMaterial map.
* This tests the behavior when a single additional key material is provided.
*/
@RetryingTest(3)
public void testRsaKeyringWithSingletonAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("rsa-singleton-additional-key-material");
final String input = "RSA with singleton additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an RSA keyring with the first key pair and materials description
RsaKeyring encryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a singleton map with the matching materials description and the same key pair used for encryption
Map<MaterialsDescription, RawKeyMaterial<PartialRsaKeyPair>> singletonMap = new HashMap<>();
singletonMap.put(materialsDescription, RawKeyMaterial.<PartialRsaKeyPair>builder()
.materialsDescription(materialsDescription)
.keyMaterial(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.build());
// Create an RSA keyring with a different key pair but with additionalDecryptionKeyMaterial containing the original key pair
RsaKeyring decryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_3.getPublic())
.privateKey(RSA_KEY_PAIR_3.getPrivate())
.build())
.materialsDescription(MaterialsDescription.builder().put("different", "description").build())
.additionalDecryptionKeyMaterial(singletonMap) // Contains the key pair that matches the materials description
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test RSA keyring with multiple entries in the additionalDecryptionKeyMaterial map.
* This tests the behavior when multiple additional key materials are provided.
*/
@RetryingTest(3)
public void testRsaKeyringWithMultipleAdditionalKeyMaterials() {
final String objectKey = appendTestSuffix("rsa-multiple-additional-key-materials");
final String input = "RSA with multiple additional key materials";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an RSA keyring with the first key pair and materials description
RsaKeyring encryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a map with multiple entries
Map<MaterialsDescription, RawKeyMaterial<PartialRsaKeyPair>> multipleMap = new HashMap<>();
// Add an entry that doesn't match
MaterialsDescription nonMatchingDesc = MaterialsDescription.builder()
.put("purpose", "different")
.put("version", "2")
.build();
multipleMap.put(nonMatchingDesc, RawKeyMaterial.<PartialRsaKeyPair>builder()
.materialsDescription(nonMatchingDesc)
.keyMaterial(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_2.getPublic())
.privateKey(RSA_KEY_PAIR_2.getPrivate())
.build())
.build());
// Add the matching entry
multipleMap.put(materialsDescription, RawKeyMaterial.<PartialRsaKeyPair>builder()
.materialsDescription(materialsDescription)
.keyMaterial(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.build());
// Create an RSA keyring with a different key pair but with additionalDecryptionKeyMaterial containing the original key pair
RsaKeyring decryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_3.getPublic())
.privateKey(RSA_KEY_PAIR_3.getPrivate())
.build())
.materialsDescription(MaterialsDescription.builder().put("different", "description").build())
.additionalDecryptionKeyMaterial(multipleMap) // Contains the key pair that matches the materials description
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test RSA keyring with additionalDecryptionKeyMaterial that doesn't match.
* This tests the behavior when no matching key material is found and it should fall back to the default key.
*/
@RetryingTest(3)
public void testRsaKeyringWithNonMatchingAdditionalKeyMaterial() {
final String objectKey = appendTestSuffix("rsa-non-matching-additional-key-material");
final String input = "RSA with non-matching additional key material";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an RSA keyring with the first key pair and materials description
RsaKeyring encryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a map with a non-matching entry
Map<MaterialsDescription, RawKeyMaterial<PartialRsaKeyPair>> nonMatchingMap = new HashMap<>();
MaterialsDescription nonMatchingDesc = MaterialsDescription.builder()
.put("purpose", "different")
.put("version", "2")
.build();
nonMatchingMap.put(nonMatchingDesc, RawKeyMaterial.<PartialRsaKeyPair>builder()
.materialsDescription(nonMatchingDesc)
.keyMaterial(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_2.getPublic())
.privateKey(RSA_KEY_PAIR_2.getPrivate())
.build())
.build());
// Create an RSA keyring with the correct key pair as the default but with non-matching additionalDecryptionKeyMaterial
RsaKeyring decryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(nonMatchingMap) // Contains a key pair that doesn't match
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Decrypt the object
ResponseBytes<GetObjectResponse> objectResponse = decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build());
// Verify the decrypted content
String output = objectResponse.asUtf8String();
assertEquals(input, output);
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
/**
* Test RSA keyring with additionalDecryptionKeyMaterial that doesn't match and a wrong default key.
* This tests the behavior when no matching key material is found and the default key is also wrong.
*/
@RetryingTest(3)
public void testRsaKeyringWithNonMatchingAdditionalKeyMaterialAndWrongDefaultKey() {
final String objectKey = appendTestSuffix("rsa-non-matching-additional-key-material-wrong-default");
final String input = "RSA with non-matching additional key material and wrong default key";
// Create a materials description for the encryption
MaterialsDescription materialsDescription = MaterialsDescription.builder()
.put("purpose", "test")
.put("version", "1")
.build();
// Create an RSA keyring with the first key pair and materials description
RsaKeyring encryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_1.getPublic())
.privateKey(RSA_KEY_PAIR_1.getPrivate())
.build())
.materialsDescription(materialsDescription)
.build();
// Create an S3 encryption client for encryption
S3Client encryptionClient = S3EncryptionClient.builder()
.keyring(encryptionKeyring)
.build();
// Encrypt and upload the object
encryptionClient.putObject(PutObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build(), RequestBody.fromString(input));
// Create a map with a non-matching entry
Map<MaterialsDescription, RawKeyMaterial<PartialRsaKeyPair>> nonMatchingMap = new HashMap<>();
MaterialsDescription nonMatchingDesc = MaterialsDescription.builder()
.put("purpose", "different")
.put("version", "2")
.build();
nonMatchingMap.put(nonMatchingDesc, RawKeyMaterial.<PartialRsaKeyPair>builder()
.materialsDescription(nonMatchingDesc)
.keyMaterial(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_2.getPublic())
.privateKey(RSA_KEY_PAIR_2.getPrivate())
.build())
.build());
// Create an RSA keyring with a wrong default key pair and non-matching additionalDecryptionKeyMaterial
RsaKeyring decryptionKeyring = RsaKeyring.builder()
.wrappingKeyPair(PartialRsaKeyPair.builder()
.publicKey(RSA_KEY_PAIR_3.getPublic())
.privateKey(RSA_KEY_PAIR_3.getPrivate())
.build())
.materialsDescription(materialsDescription)
.additionalDecryptionKeyMaterial(nonMatchingMap) // Contains a key pair that doesn't match
.build();
// Create an S3 encryption client for decryption
S3Client decryptionClient = S3EncryptionClient.builder()
.keyring(decryptionKeyring)
.build();
// Attempt to decrypt the object, which should fail
assertThrows(S3EncryptionClientException.class, () -> decryptionClient.getObjectAsBytes(GetObjectRequest.builder()
.bucket(BUCKET)
.key(objectKey)
.build()));
// Cleanup
deleteObject(BUCKET, objectKey, decryptionClient);
encryptionClient.close();
decryptionClient.close();
}
}