-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathJsonConfig.dfy
1431 lines (1335 loc) · 57.9 KB
/
JsonConfig.dfy
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
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
include "JsonItem.dfy"
include "CreateInterceptedDDBClient.dfy"
include "CreateWrappedItemEncryptor.dfy"
include "../../../../DynamoDbEncryption/dafny/DynamoDbItemEncryptor/src/Index.dfy"
module {:options "-functionSyntax:4"} JsonConfig {
import opened Wrappers
import opened StandardLibrary
import opened StandardLibrary.UInt
import opened StandardLibrary.String
import JSON.API
import opened JSON.Values
import JSON.Errors
import opened DynamoDbEncryptionUtil
import opened DdbItemJson
import Types = AwsCryptographyDbEncryptionSdkDynamoDbTypes
import SE = AwsCryptographyDbEncryptionSdkStructuredEncryptionTypes
import SI = SearchableEncryptionInfo
import CMP = AwsCryptographyMaterialProvidersTypes
import SKS = CreateStaticKeyStores
import MPT = AwsCryptographyMaterialProvidersTypes
import ENC = AwsCryptographyDbEncryptionSdkDynamoDbItemEncryptorTypes
import MaterialProviders
import KeyVectors
import KeyVectorsTypes = AwsCryptographyMaterialProvidersTestVectorKeysTypes
import KeyMaterial
import UTF8
import Primitives = AtomicPrimitives
import ParseJsonManifests
import CreateInterceptedDDBClient
import DynamoDbItemEncryptor
import CreateWrappedItemEncryptor
import Operations = AwsCryptographyDbEncryptionSdkDynamoDbItemEncryptorOperations
const abc : UTF8.ValidUTF8Bytes :=
var s := [0x61, 0x62, 0x63];
assert s == UTF8.EncodeAscii("abc");
s
predicate IsValidInt32(x: int) { -0x8000_0000 <= x < 0x8000_0000}
type ConfigName = string
datatype Record = Record (
number : nat,
item : DDB.AttributeMap
)
datatype TableConfig = TableConfig (
name : ConfigName,
config : Types.DynamoDbTableEncryptionConfig,
vanilla : bool
)
datatype SimpleQuery = SimpleQuery (
index : Option<DDB.IndexName>,
keyExpr : Option<string>,
filterExpr : Option<string>,
failConfigs : seq<ConfigName>
)
datatype ComplexQuery = ComplexQuery (
query : SimpleQuery,
pass : seq<string>,
fail : seq<string>
)
datatype ComplexTest = ComplexTest (
config : ConfigName,
queries : seq<ComplexQuery>,
failures : seq<SimpleQuery>
)
datatype RoundTripTest = RoundTripTest (
configs : map<string, TableConfig>,
records : seq<Record>
)
datatype WriteTest = WriteTest (
config : TableConfig,
records : seq<Record>,
fileName : string
)
datatype DecryptTest = DecryptTest (
config : TableConfig,
encryptedRecords : seq<Record>,
plaintextRecords : seq<Record>
)
datatype IoTest = IoTest (
name : string,
writeConfig : TableConfig,
readConfig : TableConfig,
records : seq<Record>,
names : DDB.ExpressionAttributeNameMap,
values : DDB.ExpressionAttributeValueMap,
queries : seq<SimpleQuery>
)
const TableName : DDB.TableName := "GazelleVectorTable"
const HashName := "RecNum"
type ConfigPair = (ConfigName, ConfigName)
type PairList = seq<ConfigPair>
method newGazelle(config: TableConfig)
returns (output: Result<DDB.IDynamoDBClient, string>)
ensures output.Success? ==>
&& fresh(output.value)
&& fresh(output.value.Modifies)
&& fresh(output.value.History)
&& output.value.ValidState()
{
if config.vanilla {
var res := CreateInterceptedDDBClient.CreateVanillaDDBClient();
if res.Success? {
return Success(res.value);
} else {
print res.error, "\n";
return Failure("Failed to create vanilla client.");
}
} else {
var configs := Types.DynamoDbTablesEncryptionConfig (
tableEncryptionConfigs := map[TableName := config.config]
);
var res := CreateInterceptedDDBClient.CreateInterceptedDDBClient(configs);
if res.Success? {
return Success(res.value);
} else {
print res.error, "\n";
return Failure("Failed to create DbEsdk client.");
}
}
}
method GetRoundTripTests(data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<seq<RoundTripTest>, string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Object?, "RoundTripTest Test must be an object.");
var configs : map<string, TableConfig> := map[];
var records : seq<Record> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "Configs" => var src :- GetTableConfigs(obj.1, keys); configs := src;
case "Records" => var src :- GetRecords(obj.1); records := src;
case _ => return Failure("Unexpected part of a write test : '" + obj.0 + "'");
}
}
return Success([RoundTripTest(configs, records)]);
}
method GetWriteTests(data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<seq<WriteTest> , string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Array?, "Write Test list must be an array.");
var results : seq<WriteTest> := [];
for i := 0 to |data.arr| {
var obj := data.arr[i];
var item :- GetOneWriteTest(obj, keys);
results := results + [item];
}
return Success(results);
}
method GetOneWriteTest(data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<WriteTest, string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Object?, "A Write Test must be an object.");
var config : Option<TableConfig> := None;
var fileName : string := "";
var records : seq<Record> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "Config" => var src :- GetOneTableConfig("foo", obj.1, keys); config := Some(src);
case "FileName" =>
:- Need(obj.1.String?, "Write Test file name must be a string.");
fileName := obj.1.str;
case "Records" => records :- GetRecords(obj.1);
case _ => return Failure("Unexpected part of a write test : '" + obj.0 + "'");
}
}
:- Need(config.Some?, "Every Write Test needs a config.");
:- Need(0 < |fileName|, "Every Write Test needs a file name.");
return Success(WriteTest(config.value, records, fileName));
}
method GetDecryptTests(data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<seq<DecryptTest> , string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Array?, "Decrypt Test list must be an array.");
var results : seq<DecryptTest> := [];
for i := 0 to |data.arr| {
var obj := data.arr[i];
var item :- GetOneDecryptTest(obj, keys);
results := results + [item];
}
return Success(results);
}
method GetOneDecryptTest(data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<DecryptTest, string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Object?, "A Decrypt Test must be an object.");
var config : Option<TableConfig> := None;
var encRecords : seq<Record> := [];
var plainRecords : seq<Record> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "Config" => var src :- GetOneTableConfig("foo", obj.1, keys); config := Some(src);
case "EncryptedRecords" => encRecords :- GetRecords(obj.1);
case "PlainTextRecords" => plainRecords :- GetRecords(obj.1);
case _ => return Failure("Unexpected part of a encrypt test : '" + obj.0 + "'");
}
}
:- Need(config.Some?, "Every Decrypt Test needs a config.");
:- Need(|encRecords| == |plainRecords|, "A Decrypt Test needs the same number of EncryptedRecords and PlainTextRecords.");
:- Need(0 < |encRecords|, "Every Decrypt Test needs at least on record.");
return Success(DecryptTest(config.value, encRecords, plainRecords));
}
method GetTableConfigs(data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<map<string, TableConfig> , string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Object?, "Search Config list must be an object.");
var results : map<string, TableConfig> := map[];
for i := 0 to |data.obj| {
var obj := data.obj[i];
var item :- GetOneTableConfig(obj.0, obj.1, keys);
results := results[obj.0 := item];
}
return Success(results);
}
method GetItemEncryptor(name : string, data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (encryptor : Result<ENC.IDynamoDbItemEncryptorClient, string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
ensures encryptor.Success? ==>
&& encryptor.value.ValidState()
&& fresh(encryptor.value)
&& fresh(encryptor.value.Modifies)
{
:- Need(data.Object?, "A Table Config must be an object.");
var logicalTableName := TableName;
var partitionKeyName : DDB.KeySchemaAttributeName := HashName;
var sortKeyName : Option<DDB.KeySchemaAttributeName> := None;
var algorithmSuiteId : Option<CMP.DBEAlgorithmSuiteId> := None;
var encrypt : seq<string> := [];
var attributeActionsOnEncrypt : Types.AttributeActions := map[];
var allowed : seq<DDB.AttributeName> := [];
var prefix : string := "";
var key : seq<uint8> := [];
var stdBeacons : seq<Types.StandardBeacon> := [];
var compoundBeacons : seq<Types.CompoundBeacon> := [];
var virtualFields : seq<Types.VirtualField> := [];
var keySource : Option<Types.BeaconKeySource> := None;
var legacyOverride: Option<Types.LegacyOverride> := None;
var plaintextOverride: Option<Types.PlaintextOverride> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "logicalTableName" =>
:- Need(obj.1.String?, "logicalTableName must be of type String.");
logicalTableName := obj.1.str;
case "partitionKeyName" =>
:- Need(obj.1.String?, "partitionKeyName must be of type String.");
:- Need(DDB.IsValid_KeySchemaAttributeName(obj.1.str), "partitionKeyName '" + obj.1.str + "' is not a valid KeySchemaAttributeName.");
partitionKeyName := obj.1.str;
case "sortKeyName" =>
:- Need(obj.1.String?, "sortKeyName must be of type String.");
:- Need(DDB.IsValid_KeySchemaAttributeName(obj.1.str), "sortKeyName '" + obj.1.str + "' is not a valid KeySchemaAttributeName.");
sortKeyName := Some(obj.1.str);
case "key" =>
key :- API.Serialize(obj.1).MapFailure((e: Errors.SerializationError) => e.ToString());
case "algorithmSuiteId" =>
:- Need(obj.1.String?, "algorithmSuiteId must be of type String.");
if obj.1.str == "ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384" {
algorithmSuiteId := Some(CMP.ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384);
} else if obj.1.str == "ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_ECDSA_P384_SYMSIG_HMAC_SHA384" {
algorithmSuiteId := Some(CMP.ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_ECDSA_P384_SYMSIG_HMAC_SHA384);
} else {
return Failure("algorithmSuiteId '" + obj.1.str + "' must be either ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384 or ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_ECDSA_P384_SYMSIG_HMAC_SHA384");
}
case "plaintextOverride" =>
:- Need(obj.1.String?, "plaintextOverride must be of type String.");
if obj.1.str == "FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ" {
plaintextOverride := Some(Types.FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ);
} else if obj.1.str == "FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ" {
plaintextOverride := Some(Types.FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ);
} else if obj.1.str == "FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ" {
plaintextOverride := Some(Types.FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ);
} else {
return Failure("plaintextOverride '" + obj.1.str + "' must be one of FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ, FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ or FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ");
}
case "attributeActionsOnEncrypt" => attributeActionsOnEncrypt :- GetAttributeActions(obj.1);
case "allowedUnsignedAttributePrefix" =>
:- Need(obj.1.String?, "allowedUnsignedAttributePrefix must be of type String.");
prefix := obj.1.str;
case "allowedUnsignedAttributes" => allowed :- GetAttrNames(obj.1);
case _ => return Failure("Unexpected part of a table config : '" + obj.0 + "'");
}
}
var keyDescription :-
if |key| == 0 then
Success(KeyVectorsTypes.Hierarchy(KeyVectorsTypes.HierarchyKeyring(
keyId := "static-branch-key-1"
)))
else
var keyOut :- keys.GetKeyDescription(KeyVectorsTypes.GetKeyDescriptionInput(json := key))
.MapFailure(ParseJsonManifests.ErrorToString);
Success(keyOut.keyDescription);
var keyring :- expect keys.CreateWrappedTestVectorKeyring(KeyVectorsTypes.TestVectorKeyringInput(keyDescription := keyDescription));
var encryptorConfig :=
ENC.DynamoDbItemEncryptorConfig(
logicalTableName := logicalTableName,
partitionKeyName := partitionKeyName,
sortKeyName := sortKeyName,
attributeActionsOnEncrypt := attributeActionsOnEncrypt,
allowedUnsignedAttributes := OptSeq(allowed),
allowedUnsignedAttributePrefix := OptSeq(prefix),
algorithmSuiteId := algorithmSuiteId,
keyring := Some(keyring),
cmm := None,
legacyOverride := legacyOverride,
plaintextOverride := plaintextOverride
);
var enc : ENC.IDynamoDbItemEncryptorClient :- expect CreateWrappedItemEncryptor.CreateWrappedItemEncryptor(encryptorConfig);
return Success(enc);
// assert enc is DynamoDbItemEncryptor.DynamoDbItemEncryptorClient;
// var encr := enc as DynamoDbItemEncryptor.DynamoDbItemEncryptorClient;
// return Success(encr);
}
method GetOneTableConfig(name : string, data : JSON, keys: KeyVectors.KeyVectorsClient)
returns (output : Result<TableConfig, string>)
requires keys.ValidState()
modifies keys.Modifies
ensures keys.ValidState()
{
:- Need(data.Object?, "A Table Config must be an object.");
var logicalTableName := TableName;
var partitionKeyName : DDB.KeySchemaAttributeName := HashName;
var sortKeyName : Option<DDB.KeySchemaAttributeName> := None;
var algorithmSuiteId : Option<CMP.DBEAlgorithmSuiteId> := None;
var encrypt : seq<string> := [];
var attributeActionsOnEncrypt : Types.AttributeActions := map[];
var allowed : seq<DDB.AttributeName> := [];
var prefix : string := "";
var key : seq<uint8> := [];
var stdBeacons : seq<Types.StandardBeacon> := [];
var compoundBeacons : seq<Types.CompoundBeacon> := [];
var virtualFields : seq<Types.VirtualField> := [];
var keySource : Option<Types.BeaconKeySource> := None;
var search : Option<Types.SearchConfig> := None;
var legacyOverride: Option<Types.LegacyOverride> := None;
var plaintextOverride: Option<Types.PlaintextOverride> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "logicalTableName" =>
:- Need(obj.1.String?, "logicalTableName must be of type String.");
logicalTableName := obj.1.str;
case "partitionKeyName" =>
:- Need(obj.1.String?, "partitionKeyName must be of type String.");
:- Need(DDB.IsValid_KeySchemaAttributeName(obj.1.str), "partitionKeyName '" + obj.1.str + "' is not a valid KeySchemaAttributeName.");
partitionKeyName := obj.1.str;
case "sortKeyName" =>
:- Need(obj.1.String?, "sortKeyName must be of type String.");
:- Need(DDB.IsValid_KeySchemaAttributeName(obj.1.str), "sortKeyName '" + obj.1.str + "' is not a valid KeySchemaAttributeName.");
sortKeyName := Some(obj.1.str);
case "key" =>
key :- API.Serialize(obj.1).MapFailure((e: Errors.SerializationError) => e.ToString());
case "algorithmSuiteId" =>
:- Need(obj.1.String?, "algorithmSuiteId must be of type String.");
if obj.1.str == "ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384" {
algorithmSuiteId := Some(CMP.ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384);
} else if obj.1.str == "ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_ECDSA_P384_SYMSIG_HMAC_SHA384" {
algorithmSuiteId := Some(CMP.ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_ECDSA_P384_SYMSIG_HMAC_SHA384);
} else {
return Failure("algorithmSuiteId '" + obj.1.str + "' must be either ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_SYMSIG_HMAC_SHA384 or ALG_AES_256_GCM_HKDF_SHA512_COMMIT_KEY_ECDSA_P384_SYMSIG_HMAC_SHA384");
}
case "plaintextOverride" =>
:- Need(obj.1.String?, "plaintextOverride must be of type String.");
if obj.1.str == "FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ" {
plaintextOverride := Some(Types.FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ);
} else if obj.1.str == "FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ" {
plaintextOverride := Some(Types.FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ);
} else if obj.1.str == "FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ" {
plaintextOverride := Some(Types.FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ);
} else {
return Failure("plaintextOverride '" + obj.1.str + "' must be one of FORCE_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ, FORBID_PLAINTEXT_WRITE_ALLOW_PLAINTEXT_READ or FORBID_PLAINTEXT_WRITE_FORBID_PLAINTEXT_READ");
}
case "attributeActionsOnEncrypt" => attributeActionsOnEncrypt :- GetAttributeActions(obj.1);
case "allowedUnsignedAttributePrefix" =>
:- Need(obj.1.String?, "allowedUnsignedAttributePrefix must be of type String.");
prefix := obj.1.str;
case "allowedUnsignedAttributes" => allowed :- GetAttrNames(obj.1);
case "search" => var src :- GetOneSearchConfig(obj.1); search := Some(src);
case _ => return Failure("Unexpected part of a table config : '" + obj.0 + "'");
}
}
var keyDescription :-
if |key| == 0 then
Success(KeyVectorsTypes.Hierarchy(KeyVectorsTypes.HierarchyKeyring(
keyId := "static-branch-key-1"
)))
else
var keyOut :- keys.GetKeyDescription(KeyVectorsTypes.GetKeyDescriptionInput(json := key))
.MapFailure(ParseJsonManifests.ErrorToString);
Success(keyOut.keyDescription);
var keyring :- expect keys.CreateWrappedTestVectorKeyring(KeyVectorsTypes.TestVectorKeyringInput(keyDescription := keyDescription));
var config :=
Types.DynamoDbTableEncryptionConfig(
logicalTableName := logicalTableName,
partitionKeyName := partitionKeyName,
sortKeyName := sortKeyName,
search := search,
attributeActionsOnEncrypt := attributeActionsOnEncrypt,
allowedUnsignedAttributes := OptSeq(allowed),
allowedUnsignedAttributePrefix := OptSeq(prefix),
algorithmSuiteId := algorithmSuiteId,
keyring := Some(keyring),
cmm := None,
legacyOverride := legacyOverride,
plaintextOverride := plaintextOverride
);
return Success(TableConfig(name, config, |data.obj| == 0));
}
method GetOneSearchConfig(data : JSON) returns (output : Result<Types.SearchConfig, string>)
{
:- Need(data.Object?, "A Search Config must be an object.");
var writeVersion : nat := 1;
var versions : seq<Types.BeaconVersion> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "versions" =>
:- Need(obj.1.Array?, "versions must be an Array.");
for j := 0 to |obj.1.arr| {
var v :- GetOneBeaconVersion(obj.1.arr[j]);
versions := versions + [v];
}
case "writeVersion" =>
:- Need(obj.1.Number?, "writeVersion must be a number");
writeVersion :- DecimalToNat(obj.1.num);
case _ => return Failure("Unexpected part of a search config : '" + obj.0 + "'");
}
}
:- Need(Types.IsValid_BeaconVersionList(versions), "versions needs at least one version");
return Success(Types.SearchConfig (
versions := versions,
writeVersion := 1
));
}
method GetOneBeaconVersion(data : JSON) returns (output : Result<Types.BeaconVersion, string>)
{
:- Need(data.Object?, "A Beacon Version must be an object.");
var standardBeacons : seq<Types.StandardBeacon> := [];
var compoundBeacons : seq<Types.CompoundBeacon> := [];
var virtualFields : seq<Types.VirtualField> := [];
var keySource : Option<Types.BeaconKeySource> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "keySource" => var src :- GetKeySource(obj.1); keySource := Some(src);
case "standardBeacons" => standardBeacons :- GetStandardBeacons(obj.1);
case "compoundBeacons" => compoundBeacons :- GetCompoundBeacons(obj.1);
case "virtualFields" => virtualFields :- GetVirtualFields(obj.1);
case _ => return Failure("Unexpected part of a beacon version : '" + obj.0 + "'");
}
}
:- Need(|standardBeacons| > 0, "A Search Config needs at least one standard beacon.");
var keyMaterial : KeyMaterial.KeyMaterial :=
KeyMaterial.StaticKeyStoreInformation("abc", abc, [1,2,3,4,5], [1,2,3,4,5]);
var store := SKS.CreateStaticKeyStore(keyMaterial);
var source : Types.BeaconKeySource :=
if keySource.Some? then
keySource.value
else
Types.single(Types.SingleKeyStore(keyId := "foo", cacheTTL := 42));
return Success(Types.BeaconVersion(
version := 1,
keyStore := store,
keySource := source,
standardBeacons := standardBeacons,
compoundBeacons := OptSeq(compoundBeacons),
virtualFields := OptSeq(virtualFields),
encryptedParts := None,
signedParts := None
)
);
}
method GetFakeBeaconVersion() returns (output : Result<SI.BeaconVersion, string>)
ensures output.Success? ==> output.value.ValidState() && fresh(output.value.Modifies())
{
var keyMaterial : KeyMaterial.KeyMaterial :=
KeyMaterial.StaticKeyStoreInformation("abc", abc, [1,2,3,4,5], [1,2,3,4,5]);
var store := SKS.CreateStaticKeyStore(keyMaterial);
var source : Types.BeaconKeySource := Types.single(Types.SingleKeyStore(keyId := "foo", cacheTTL := 42));
var sb := Types.StandardBeacon(name := "name", length := 5 as Types.BeaconBitLength, loc := None, style := None);
var mpl :- expect MaterialProviders.MaterialProviders();
var cacheType : MPT.CacheType := MPT.Default(Default := MPT.DefaultCache(entryCapacity := 1));
var input := MPT.CreateCryptographicMaterialsCacheInput(
cache := cacheType
);
var cache :- expect mpl.CreateCryptographicMaterialsCache(input);
var client :- expect Primitives.AtomicPrimitives();
// Create a test partitionIdBytes
var partitionIdBytes : seq<uint8> :- expect SI.GenerateUuidBytes();
// Create a random logicalKeyStoreNameBytes
// Ideally, this should be taken from the KeyStore store,
// but logicalKeyStoreName variable doesn't exist in the
// trait AwsCryptographyKeyStoreTypes.IKeyStoreClient
// Therefore, the only way to get logicalKeyStoreName is
// to call GetKeyStoreInfo, which we don't need to do here
// since this method does NOT test the shared cache
// which is the only place logicalKeyStoreName is used
// (in the cache identifier)
var logicalKeyStoreNameBytes : seq<uint8> :- expect SI.GenerateUuidBytes();
var src := SI.KeySource(client, store, SI.SingleLoc("foo"), cache, 100 as uint32, partitionIdBytes, logicalKeyStoreNameBytes);
var bv :- expect SI.MakeBeaconVersion(1, src, map[], map[], map[]);
return Success(bv);
}
method GetAttributeActions(data : JSON) returns (output : Result<Types.AttributeActions, string>)
{
:- Need(data.Object?, "attributeActionsOnEncrypt must be an object");
var result : Types.AttributeActions := map[];
for i := 0 to |data.obj| {
var obj := data.obj[i];
:- Need(DDB.IsValid_AttributeName(obj.0), obj.0 + " is not a valid attribute name.");
var action :- GetAttributeAction(obj.1);
result := result[obj.0 := action];
}
return Success(result);
}
method GetAttributeAction(data : JSON) returns (output : Result<SE.CryptoAction, string>)
{
:- Need(data.String?, "Attribute Action must be a string");
match data.str {
case "ENCRYPT_AND_SIGN" => return Success(SE.ENCRYPT_AND_SIGN);
case "SIGN_ONLY" => return Success(SE.SIGN_ONLY);
case "CONTEXT_AND_SIGN" => return Success(SE.SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT);
case "SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT" => return Success(SE.SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT);
case "DO_NOTHING" => return Success(SE.DO_NOTHING);
case _ => return Failure(data.str + " is not a valid CryptoAction.");
}
}
method GetStrings(data : JSON) returns (output : Result<seq<string>, string>)
{
:- Need(data.Array?, "List of strings must be an array");
var results : seq<string> := [];
for i := 0 to |data.arr| {
:- Need(data.arr[i].String?, "Each item in a string list must be a string");
results := results + [data.arr[i].str];
}
return Success(results);
}
method GetAttrNames(data : JSON) returns (output : Result<seq<DDB.AttributeName>, string>)
{
:- Need(data.Array?, "List of Attribute Names must be an array");
var results : seq<DDB.AttributeName> := [];
for i := 0 to |data.arr| {
:- Need(data.arr[i].String?, "Each item in a string list must be a string");
:- Need(DDB.IsValid_AttributeName(data.arr[i].str), data.arr[i].str + " is not a valid attribute name.");
results := results + [data.arr[i].str];
}
return Success(results);
}
method GetAttributesFromGSI(prev : seq<DDB.AttributeDefinition>, gsi : seq<DDB.GlobalSecondaryIndex>) returns (output : seq<DDB.AttributeDefinition>)
{
var results := prev;
for i := 0 to |gsi| {
for j := 0 to |gsi[i].KeySchema| {
if forall k <- prev :: k.AttributeName != gsi[i].KeySchema[j].AttributeName {
results := results + [DDB.AttributeDefinition(AttributeName := gsi[i].KeySchema[j].AttributeName, AttributeType := DDB.ScalarAttributeType.S)];
}
}
}
return results;
}
method MergeGSI(prev : DDB.CreateTableInput, gsi : seq<DDB.GlobalSecondaryIndex>) returns (output : Result<DDB.CreateTableInput, string>)
{
if |gsi| == 0 {
return Success(prev);
}
var newAttr := GetAttributesFromGSI(prev.AttributeDefinitions, gsi);
if prev.GlobalSecondaryIndexes.None? {
return Success(prev.(AttributeDefinitions := newAttr, GlobalSecondaryIndexes := Some(gsi)));
} else {
return Success(prev.(AttributeDefinitions := newAttr, GlobalSecondaryIndexes := Some(prev.GlobalSecondaryIndexes.value + gsi)));
}
}
method GetVirtualFields(data : JSON) returns (output : Result<seq<Types.VirtualField> , string>)
{
:- Need(data.Array?, "Virtual Field list must be an array.");
var results : seq<Types.VirtualField> := [];
for i := 0 to |data.arr| {
var item :- GetOneVirtualField(data.arr[i]);
results := results + [item];
}
return Success(results);
}
method GetKeySource(data : JSON) returns (output : Result<Types.BeaconKeySource, string>)
{
:- Need(data.Object?, "keySource must be an object.");
var keyFieldName : string := "";
var keyId : string := "";
var cacheTTL : nat := 42;
var maxCacheSize : nat := 1;
var parts : seq<Types.VirtualPart> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "keyFieldName" =>
:- Need(obj.1.String?, "keyFieldName must be a string.");
keyFieldName := obj.1.str;
case "keyId" =>
:- Need(obj.1.String?, "keyId must be a string.");
keyId := obj.1.str;
case "cacheTTL" =>
:- Need(obj.1.Number?, "cacheTTL must be a number.");
cacheTTL :- DecimalToNat(obj.1.num);
case "maxCacheSize" =>
:- Need(obj.1.Number?, "maxCacheSize must be a number.");
maxCacheSize :- DecimalToNat(obj.1.num);
case _ => return Failure("Unexpected part of a key source : '" + data.obj[i].0 + "'");
}
}
:- Need(cacheTTL < INT32_MAX_LIMIT, "cacheTTL must fit in an int32");
:- Need(maxCacheSize < INT32_MAX_LIMIT, "maxCacheSize must fit in an int32");
:- Need(|keyFieldName| > 0 || |keyId| > 0, "Each key source needs a either a keyFieldName or a keyId.");
:- Need(|keyFieldName| == 0 || |keyId| == 0, "Each key source cannot have both a keyFieldName and a keyId.");
if |keyId| > 0 {
return Success(Types.single(Types.SingleKeyStore(keyId := keyId, cacheTTL := cacheTTL as int32)));
} else {
assert |keyFieldName| > 0;
return Success(Types.multi(Types.MultiKeyStore(keyFieldName := keyFieldName, cacheTTL := cacheTTL as int32, cache := None)));
}
}
method GetOneVirtualField(data : JSON) returns (output : Result<Types.VirtualField, string>)
{
:- Need(data.Object?, "Virtual Field must be an object.");
var name : string := "";
var parts : seq<Types.VirtualPart> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "name" =>
:- Need(obj.1.String?, "Virtual Field Name must be a string.");
name := obj.1.str;
case "parts" => parts :- GetVirtualParts(obj.1);
case _ => return Failure("Unexpected part of a virtual field : '" + data.obj[i].0 + "'");
}
}
:- Need(0 < |name|, "Each Virtual Field needs a name.");
:- Need(0 < |parts|, "Each Virtual Field needs at least 1 part.");
return Success(Types.VirtualField(name := name, parts := parts));
}
method GetVirtualParts(data : JSON) returns (output : Result<seq<Types.VirtualPart> , string>)
{
:- Need(data.Array?, "Virtual Field Parts list must be an array.");
var results : seq<Types.VirtualPart> := [];
for i := 0 to |data.arr| {
var item :- GetOneVirtualPart(data.arr[i]);
results := results + [item];
}
return Success(results);
}
method GetOneVirtualPart(data : JSON) returns (output : Result<Types.VirtualPart, string>)
{
:- Need(data.Object?, "Virtual Part must be an object.");
var loc : string := "";
var trans : seq<Types.VirtualTransform> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "loc" =>
:- Need(obj.1.String?, "Virtual Part Location must be a string.");
loc := obj.1.str;
case "trans" => trans :- GetVirtualTransforms(obj.1);
case _ => return Failure("Unexpected part of a virtual part : '" + data.obj[i].0 + "'");
}
}
:- Need(0 < |loc|, "Each Virtual Part needs a loc.");
:- Need(0 < |trans|, "Each Virtual Part needs at least 1 transform.");
return Success(Types.VirtualPart(loc := loc, trans := OptSeq(trans)));
}
method GetVirtualTransforms(data : JSON) returns (output : Result<seq<Types.VirtualTransform> , string>)
{
:- Need(data.Array?, "Virtual Field Parts list must be an array.");
var results : seq<Types.VirtualTransform> := [];
for i := 0 to |data.arr| {
var item :- GetOneVirtualTransform(data.arr[i]);
results := results + [item];
}
return Success(results);
}
method GetOneVirtualTransform(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
{
:- Need(data.Object?, "Virtual Transform must be an object.");
:- Need(|data.obj| == 1, "Virtual Transform object must be length 1.");
var obj := data.obj[0];
match obj.0 {
case "upper" =>
:- Need(obj.1.Null?, "Value of upper transform must be null");
return Success(Types.upper(Types.Upper));
case "lower" =>
:- Need(obj.1.Null?, "Value of lower transform must be null");
return Success(Types.lower(Types.Lower));
case "insert" => output := GetInsert(obj.1);
case "prefix" => output := GetPrefix(obj.1);
case "suffix" => output := GetSuffix(obj.1);
case "substring" => output := GetSubstring(obj.1);
case "segment" => output := GetSegment(obj.1);
case "segments" => output := GetSegments(obj.1);
case _ => return Failure("Unexpected Virtual Transform : '" + obj.0 + "'");
}
}
method GetInsert(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
ensures output.Success? ==> output.value.insert?
{
:- Need(data.Object?, "GetInsert Value must be an object.");
var literal : Option<string> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "literal" =>
:- Need(obj.1.String?, "GetInsert literal must be a string");
literal := Some(obj.1.str);
case _ => return Failure("Unexpected part of a GetInsert : '" + obj.0 + "'");
}
}
:- Need(literal.Some?, "Each GetInsert needs a literal.");
return Success(Types.insert(Types.Insert(literal := literal.value)));
}
method GetPrefix(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
ensures output.Success? ==> output.value.prefix?
{
:- Need(data.Object?, "GetPrefix Value must be an object.");
var length : Option<int32> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "length" =>
:- Need(obj.1.Number?, "GetPrefix length must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetPrefix length must be an int32.");
length := Some(len as int32);
case _ => return Failure("Unexpected part of a GetPrefix : '" + obj.0 + "'");
}
}
:- Need(length.Some?, "Each GetPrefix needs a length.");
return Success(Types.prefix(Types.GetPrefix(length := length.value)));
}
method GetSuffix(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
ensures output.Success? ==> output.value.suffix?
{
:- Need(data.Object?, "GetSuffix Value must be an object.");
var length : Option<int32> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "length" =>
:- Need(obj.1.Number?, "GetSuffix length must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetSuffix length must be an int32.");
length := Some(len as int32);
case _ => return Failure("Unexpected part of a GetSuffix : '" + obj.0 + "'");
}
}
:- Need(length.Some?, "Each GetSuffix needs a length.");
return Success(Types.suffix(Types.GetSuffix(length := length.value)));
}
method GetSubstring(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
ensures output.Success? ==> output.value.substring?
{
:- Need(data.Object?, "GetSubstring Value must be an object.");
var low : Option<int32> := None;
var high : Option<int32> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "low" =>
:- Need(obj.1.Number?, "GetSubstring low must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetSubstring low must be an int32.");
low := Some(len as int32);
case "high" =>
:- Need(obj.1.Number?, "GetSubstring high must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetSubstring high must be an int32.");
high := Some(len as int32);
case _ => return Failure("Unexpected part of a GetSubstring : '" + obj.0 + "'");
}
}
:- Need(low.Some?, "Each GetSubstring needs a low.");
:- Need(high.Some?, "Each GetSubstring needs a high.");
return Success(Types.substring(Types.GetSubstring(low := low.value, high := high.value)));
}
method GetSegments(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
ensures output.Success? ==> output.value.segments?
{
:- Need(data.Object?, "GetSegments Value must be an object.");
var low : Option<int32> := None;
var high : Option<int32> := None;
var split : Option<string> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "low" =>
:- Need(obj.1.Number?, "GetSegments low must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetSegments low must be an int32.");
low := Some(len as int32);
case "high" =>
:- Need(obj.1.Number?, "GetSegments high must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetSegments high must be an int32.");
high := Some(len as int32);
case "split" =>
:- Need(obj.1.String?, "GetSegments split must be a string");
split := Some(obj.1.str);
case _ => return Failure("Unexpected part of a GetSegments : '" + obj.0 + "'");
}
}
:- Need(low.Some?, "Each GetSegments needs a low.");
:- Need(high.Some?, "Each GetSegments needs a high.");
:- Need(split.Some?, "Each GetSegments needs a split.");
:- Need(|split.value| == 1, "GetSegments split must be length 1.");
return Success(Types.segments(Types.GetSegments(low := low.value, high := high.value, split := split.value)));
}
method GetSegment(data : JSON) returns (output : Result<Types.VirtualTransform, string>)
ensures output.Success? ==> output.value.segment?
{
:- Need(data.Object?, "GetSegment Value must be an object.");
var index : Option<int32> := None;
var split : Option<string> := None;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "index" =>
:- Need(obj.1.Number?, "GetSegment index must be a number");
var len :- DecimalToInt(obj.1.num);
:- Need(IsValidInt32(len), "GetSegments low must be an int32.");
index := Some(len as int32);
case "split" =>
:- Need(obj.1.String?, "GetSegments split must be a string");
split := Some(obj.1.str);
case _ => return Failure("Unexpected part of a GetSegment : '" + obj.0 + "'");
}
}
:- Need(index.Some?, "Each GetSegments needs a low.");
:- Need(split.Some?, "Each GetSegments needs a split.");
:- Need(|split.value| == 1, "GetSegments split must be length 1.");
return Success(Types.segment(Types.GetSegment(index := index.value, split := split.value)));
}
method GetCompoundBeacons(data : JSON) returns (output : Result<seq<Types.CompoundBeacon> , string>)
{
:- Need(data.Array?, "Compound Beacon list must be an array.");
var results : seq<Types.CompoundBeacon> := [];
for i := 0 to |data.arr| {
var item :- GetOneCompoundBeacon(data.arr[i]);
results := results + [item];
}
return Success(results);
}
function OptSeq<X>(s : seq<X>) : Option<seq<X>>
{
if |s| == 0 then
None
else
Some(s)
}
method GetOneCompoundBeacon(data : JSON) returns (output : Result<Types.CompoundBeacon, string>)
{
:- Need(data.Object?, "Compound Beacon must be an object.");
var name : string := "";
var split : string := ".";
var Encrypted : seq<Types.EncryptedPart> := [];
var Signed : seq<Types.SignedPart> := [];
var constructors : seq<Types.Constructor> := [];
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "Name" =>
:- Need(obj.1.String?, "Compound Beacon Name must be a string.");
name := obj.1.str;
case "Split" =>
:- Need(obj.1.String?, "Compound Beacon Split must be a string.");
:- Need(|obj.1.str| == 1, "Compound Beacon Split must be a string of length 1.");
split := obj.1.str;
case "Signed" => Signed :- GetSignedParts(obj.1);
case "Encrypted" => Encrypted :- GetEncryptedParts(obj.1);
case "Constructors" => constructors :- GetConstructors(obj.1);
case _ => return Failure("Unexpected part of a standard beacon : '" + data.obj[i].0 + "'");
}
}
:- Need(0 < |name|, "Each Compound Beacon needs a name.");
:- Need(|split| == 1, "Split for Compound Beacon must be length 1.");
return Success(Types.CompoundBeacon(name := name, split := split, encrypted := OptSeq(Encrypted), signed := OptSeq(Signed), constructors := OptSeq(constructors)));
}
method GetConstructors(data : JSON) returns (output : Result<seq<Types.Constructor> , string>)
{
:- Need(data.Array?, "Constructor list must be an array.");
var results : seq<Types.Constructor> := [];
for i := 0 to |data.arr| {
:- Need(data.arr[i].Array?, "Constructors must be an arrays.");
var result : seq<Types.ConstructorPart> := [];
for j := 0 to |data.arr[i].arr| {
var item :- GetOneConstructorPart(data.arr[i].arr[j]);
result := result + [item];
}
:- Need(0 < |result|, "Constructor Part List must have at least one item.");
results := results + [Types.Constructor(parts := result)];
}
return Success(results);
}
method GetOneConstructorPart(data : JSON) returns (output : Result<Types.ConstructorPart, string>)
{
:- Need(data.Object?, "Constructor Part must be an object.");
var name : string := "";
var req : bool := true;
for i := 0 to |data.obj| {
var obj := data.obj[i];
match obj.0 {
case "Name" =>
:- Need(obj.1.String?, "Constructor Part Name must be a string");
name := obj.1.str;