Skip to content

Commit

Permalink
fix: Names and clarification (#283)
Browse files Browse the repository at this point in the history
The encyrption context on hierarchical materials
is all the encryption context,
not only any custom values set by the customer
on branch key creation.
  • Loading branch information
seebees authored Sep 11, 2024
1 parent 47d2977 commit c594df9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
11 changes: 8 additions & 3 deletions framework/key-store/key-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,16 @@ This structure MUST include all of the following fields:

A union that MUST hold the following three options

- ActiveHierarchicalSymmetricVersion [HierarchicalSymmetricVersion](#hierarchicalsymmetricversion)
- HierarchicalSymmetricVersion [HierarchicalSymmetricVersion](#hierarchicalsymmetricversion)
- ActiveHierarchicalSymmetricVersion [ActiveHierarchicalSymmetric](#activehierarchicalsymmetric)
- HierarchicalSymmetricVersion [HierarchicalSymmetric](#hierarchicalsymmetric)
- ActiveHierarchicalSymmetricBeacon

### HierarchicalSymmetricVersion
### ActiveHierarchicalSymmetric

A structure that MUST have one member,
the UTF8 Encoded value of the version of the branch key.

### HierarchicalSymmetric

A structure that MUST have one member,
the UTF8 Encoded value of the version of the branch key.
Expand Down
2 changes: 1 addition & 1 deletion framework/structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ This value MUST be a version 4 [UUID](https://www.ietf.org/rfc/rfc4122.txt).

##### Encryption Context

The [custom encryption context](#encryption-context) associated with this branch key.
The [encryption context](#encryption-context) associated with this branch key.

This comment has been minimized.

Copy link
@texastony

texastony Oct 16, 2024

Contributor

This change to the Branch Key's Encryption Context highlights some confusion in the specification and in the Dafny MPL library that implements it about what a Branch Key's Encryption Context is.

We should address this.


## Beacon Key Materials

Expand Down

0 comments on commit c594df9

Please sign in to comment.