chore(dafny): KSA Add test coverage for creating a hv-2 branch key. #1400
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,256 @@ | ||
| // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| include "../src/Index.dfy" | ||
|
|
||
| // methods to validate a Get* Branch Key result from the Branch Key Store client | ||
| module {:options "/functionSyntax:4" } BranchKeyValidators { | ||
| import opened Wrappers | ||
| import opened StandardLibrary.UInt | ||
| import UTF8 | ||
| import UUID | ||
| import Types = AwsCryptographyKeyStoreTypes | ||
| import Structure | ||
|
|
||
| method VerifyGetKeys( | ||
| identifier : string, | ||
| keyStore : Types.IKeyStoreClient, | ||
| storage : Types.IKeyStorageInterface, | ||
| nameonly versionUtf8Bytes?: Option<seq<uint8>> := None, | ||
| nameonly encryptionContext : Types.EncryptionContext := map[], | ||
| nameonly hierarchyVersion : Types.HierarchyVersion := Types.HierarchyVersion.v1 | ||
| ) | ||
| requires | ||
| keyStore.ValidState() && storage.ValidState() | ||
| modifies | ||
| keyStore.Modifies, storage.Modifies | ||
| ensures | ||
| keyStore.ValidState() && storage.ValidState() | ||
|
|
||
| { | ||
| var _ := testBeaconKeyHappyCase( | ||
| keyStore := keyStore, | ||
| branchKeyId := identifier, | ||
| encryptionContext := encryptionContext | ||
| ); | ||
|
|
||
| var activeResult := testActiveBranchKeyHappyCase( | ||
| keyStore := keyStore, | ||
| branchKeyId := identifier, | ||
| encryptionContext := encryptionContext | ||
| ); | ||
| var versionString :- expect UTF8.Decode(activeResult.branchKeyVersion); | ||
|
|
||
| var _ := testBranchKeyVersionHappyCase( | ||
| keyStore := keyStore, | ||
| branchKeyId := identifier, | ||
| branchKeyIdActiveVersion := versionString, | ||
| branchKeyIdActiveVersionUtf8Bytes := activeResult.branchKeyVersion, | ||
| encryptionContext := encryptionContext | ||
| ); | ||
| VerifyGetKeysFromStorage(identifier, storage, hierarchyVersion:=hierarchyVersion); | ||
|
|
||
| //= aws-encryption-sdk-specification/framework/branch-key-store.md#branch-key-and-beacon-key-creation | ||
| //= type=test | ||
| //# This guid MUST be [version 4 UUID](https://www.ietf.org/rfc/rfc4122.txt) | ||
| var versionByteUUID :- expect UUID.ToByteArray(versionString); | ||
| var versionRoundTrip :- expect UUID.FromByteArray(versionByteUUID); | ||
| expect versionRoundTrip == versionString; | ||
| } | ||
|
|
||
|
|
||
| method VerifyGetKeysFromStorage( | ||
| identifier : string, | ||
| storage : Types.IKeyStorageInterface, | ||
| nameonly hierarchyVersion : Types.HierarchyVersion := Types.HierarchyVersion.v1 | ||
| ) | ||
| requires storage.ValidState() | ||
| modifies storage.Modifies | ||
| ensures storage.ValidState() | ||
| { | ||
| var active :- expect storage.GetEncryptedActiveBranchKey( | ||
| Types.GetEncryptedActiveBranchKeyInput( | ||
| Identifier := identifier | ||
| ) | ||
| ); | ||
| expect active.Item.Type.ActiveHierarchicalSymmetricVersion?; | ||
|
|
||
| var beacon :- expect storage.GetEncryptedBeaconKey( | ||
| Types.GetEncryptedBeaconKeyInput( | ||
| Identifier := identifier | ||
| ) | ||
| ); | ||
| expect beacon.Item.Type.ActiveHierarchicalSymmetricBeacon?; | ||
|
|
||
| var version :- expect storage.GetEncryptedBranchKeyVersion( | ||
| Types.GetEncryptedBranchKeyVersionInput( | ||
| Identifier := identifier, | ||
| Version := active.Item.Type.ActiveHierarchicalSymmetricVersion.Version | ||
| ) | ||
| ); | ||
| expect version.Item.Type.HierarchicalSymmetricVersion?; | ||
|
|
||
| var hvMatches? := match hierarchyVersion { | ||
| case v1 | ||
| => | ||
| && branchKeyContextSaysHV1(active.Item.EncryptionContext) | ||
| && branchKeyContextSaysHV1(beacon.Item.EncryptionContext) | ||
| && branchKeyContextSaysHV1(version.Item.EncryptionContext) | ||
| case v2 | ||
| => | ||
| && branchKeyContextSaysHV2(active.Item.EncryptionContext) | ||
| && branchKeyContextSaysHV2(beacon.Item.EncryptionContext) | ||
| && branchKeyContextSaysHV2(version.Item.EncryptionContext) | ||
| }; | ||
| if (!hvMatches?) { | ||
| print "HV did not match expectation, did bkc have hv?: ", Structure.HIERARCHY_VERSION in active.Item.EncryptionContext; | ||
| if (Structure.HIERARCHY_VERSION in active.Item.EncryptionContext) { | ||
| print " Actual HV: ", active.Item.EncryptionContext[Structure.HIERARCHY_VERSION]; | ||
| } | ||
| } | ||
| expect hvMatches?, "Hierarchy Version did not match expectation."; | ||
|
|
||
| //= aws-encryption-sdk-specification/framework/branch-key-store.md#branch-key-and-beacon-key-creation | ||
| //= type=test | ||
| //# This timestamp MUST be in ISO 8601 format in UTC, to microsecond precision (e.g. “YYYY-MM-DDTHH:mm:ss.ssssssZ“) | ||
| expect ISO8601?(active.Item.CreateTime); | ||
| expect ISO8601?(beacon.Item.CreateTime); | ||
| expect ISO8601?(version.Item.CreateTime); | ||
| } | ||
|
|
||
| predicate branchKeyContextSaysHV1(bkc: Types.EncryptionContextString) | ||
| { | ||
| Structure.HIERARCHY_VERSION in bkc && bkc[Structure.HIERARCHY_VERSION] == Structure.HIERARCHY_VERSION_VALUE_1 | ||
| } | ||
|
|
||
| predicate branchKeyContextSaysHV2(bkc: Types.EncryptionContextString) | ||
| { | ||
| Structure.HIERARCHY_VERSION in bkc && bkc[Structure.HIERARCHY_VERSION] == Structure.HIERARCHY_VERSION_VALUE_2 | ||
| } | ||
|
|
||
| method testActiveBranchKeyHappyCase( | ||
| keyStore: Types.IKeyStoreClient, | ||
| branchKeyId: string, | ||
| nameonly versionUtf8Bytes?: Option<seq<uint8>> := None, | ||
| nameonly encryptionContext : Types.EncryptionContext := map[] | ||
| ) returns (output: Types.BranchKeyMaterials) | ||
| requires keyStore.ValidState() | ||
| modifies keyStore.Modifies | ||
| ensures keyStore.ValidState() | ||
| { | ||
| var activeResult :- expect keyStore.GetActiveBranchKey( | ||
| Types.GetActiveBranchKeyInput( | ||
| branchKeyIdentifier := branchKeyId | ||
| )); | ||
| expect isValidActiveBranchKeyResult?(activeResult, branchKeyId, encryptionContext, versionUtf8Bytes?); | ||
| return activeResult.branchKeyMaterials; | ||
| } | ||
|
|
||
| method testBranchKeyVersionHappyCase( | ||
| keyStore: Types.IKeyStoreClient, | ||
| branchKeyId: string, | ||
| branchKeyIdActiveVersion: string, | ||
| branchKeyIdActiveVersionUtf8Bytes: seq<uint8>, | ||
| nameonly encryptionContext : Types.EncryptionContext := map[] | ||
| ) returns (output: Types.BranchKeyMaterials) | ||
| requires keyStore.ValidState() | ||
| modifies keyStore.Modifies | ||
| ensures keyStore.ValidState() | ||
| { | ||
| var versionResult :- expect keyStore.GetBranchKeyVersion( | ||
| Types.GetBranchKeyVersionInput( | ||
| branchKeyIdentifier := branchKeyId, | ||
| branchKeyVersion := branchKeyIdActiveVersion | ||
| )); | ||
| expect isValidBranchKeyVersionResult?(versionResult, branchKeyId, encryptionContext, branchKeyIdActiveVersionUtf8Bytes); | ||
| return versionResult.branchKeyMaterials; | ||
| } | ||
|
|
||
| method testBeaconKeyHappyCase( | ||
| keyStore: Types.IKeyStoreClient, | ||
| branchKeyId: string, | ||
| nameonly encryptionContext : Types.EncryptionContext := map[] | ||
| ) returns (output: Types.BeaconKeyMaterials) | ||
| requires keyStore.ValidState() | ||
| modifies keyStore.Modifies | ||
| ensures keyStore.ValidState() | ||
| { | ||
| var beaconKeyResult :- expect keyStore.GetBeaconKey( | ||
| Types.GetBeaconKeyInput( | ||
| branchKeyIdentifier := branchKeyId | ||
| )); | ||
| expect beaconKeyResult.beaconKeyMaterials.beaconKeyIdentifier == branchKeyId, "Wrong Branch Key ID."; | ||
| expect beaconKeyResult.beaconKeyMaterials.beaconKey.Some?, "Beacon Key Materials MUST be present."; | ||
| expect |beaconKeyResult.beaconKeyMaterials.beaconKey.value| == 32, "Lenght of Beacon Key Materials MUST be 32 bytes."; | ||
| if (beaconKeyResult.beaconKeyMaterials.encryptionContext != encryptionContext) { | ||
| print "Beacon Key's encryption context is incorrect. Expected: ", encryptionContext, " but got: ", beaconKeyResult.beaconKeyMaterials.encryptionContext; | ||
|
There was a problem hiding this comment. We can remove the print statement |
||
| expect false, "Beacon Key's encryption context is incorrect."; | ||
| } | ||
| expect isValidBeaconResult?(beaconKeyResult, branchKeyId, encryptionContext); | ||
| return beaconKeyResult.beaconKeyMaterials; | ||
| } | ||
|
|
||
| predicate isValidBeaconResult?( | ||
| beaconKeyResult: Types.GetBeaconKeyOutput, | ||
| branchKeyId: string, | ||
| encryptionContext : Types.EncryptionContext | ||
| ) { | ||
| && beaconKeyResult.beaconKeyMaterials.beaconKeyIdentifier == branchKeyId | ||
| && beaconKeyResult.beaconKeyMaterials.beaconKey.Some? | ||
| && |beaconKeyResult.beaconKeyMaterials.beaconKey.value| == 32 | ||
| && beaconKeyResult.beaconKeyMaterials.encryptionContext == encryptionContext | ||
| } | ||
|
|
||
| predicate isValidActiveBranchKeyResult?( | ||
| branchKeyResult: Types.GetActiveBranchKeyOutput, | ||
| branchKeyId: string, | ||
| encryptionContext : Types.EncryptionContext, | ||
| branchKeyIdActiveVersionUtf8Bytes: Option<seq<uint8>> | ||
| ) | ||
| { | ||
| && branchKeyResult.branchKeyMaterials.branchKeyIdentifier == branchKeyId | ||
| && (branchKeyIdActiveVersionUtf8Bytes.None? || | ||
| branchKeyResult.branchKeyMaterials.branchKeyVersion == branchKeyIdActiveVersionUtf8Bytes.value) | ||
| && |branchKeyResult.branchKeyMaterials.branchKey| == 32 | ||
| && branchKeyResult.branchKeyMaterials.encryptionContext == encryptionContext | ||
| } | ||
|
|
||
| predicate isValidBranchKeyVersionResult?( | ||
| versionResult: Types.GetBranchKeyVersionOutput, | ||
| branchKeyId: string, | ||
| encryptionContext : Types.EncryptionContext, | ||
| branchKeyIdActiveVersionUtf8Bytes: seq<uint8> | ||
| ) | ||
| { | ||
| && versionResult.branchKeyMaterials.branchKeyIdentifier == branchKeyId | ||
| && versionResult.branchKeyMaterials.branchKeyVersion == branchKeyIdActiveVersionUtf8Bytes | ||
| && |versionResult.branchKeyMaterials.branchKey| == 32 | ||
| && versionResult.branchKeyMaterials.encryptionContext == encryptionContext | ||
| } | ||
|
|
||
| //= aws-encryption-sdk-specification/framework/branch-key-store.md#branch-key-and-beacon-key-creation | ||
| //= type=test | ||
| //# This timestamp MUST be in ISO 8601 format in UTC, to microsecond precision (e.g. “YYYY-MM-DDTHH:mm:ss.ssssssZ“) | ||
| lemma ISO8601Test() | ||
| { | ||
| assert ISO8601?("2024-08-06T17:23:25.000874Z"); | ||
| } | ||
|
|
||
| //= aws-encryption-sdk-specification/framework/branch-key-store.md#branch-key-and-beacon-key-creation | ||
| //= type=test | ||
| //# This timestamp MUST be in ISO 8601 format in UTC, to microsecond precision (e.g. “YYYY-MM-DDTHH:mm:ss.ssssssZ“) | ||
| predicate ISO8601?( | ||
| CreateTime: string | ||
| ) | ||
| { | ||
| // “YYYY-MM-DDTHH:mm:ss.ssssssZ“ | ||
| && |CreateTime| == 27 | ||
| && CreateTime[4] == '-' | ||
| && CreateTime[7] == '-' | ||
| && CreateTime[10] == 'T' | ||
| && CreateTime[13] == ':' | ||
| && CreateTime[16] == ':' | ||
| && CreateTime[19] == '.' | ||
| && CreateTime[26] == 'Z' | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this print statement? Can we leave it as as commented code?