✨ Adds key identifier field to KAO #21
Merged
Conversation
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
- This will simplify key rotation on the KAS, while maintaining support for 'legacy' or 'past' keys.
- Adds v2 format, with `kid` in response` - Allows returning the value in JWK format
pflynn-virtru
previously approved these changes
Aug 21, 2023
|
Converting to draft while I implement a proof of concept in opentdf/backend and opentdf/client-web |
|
Backend Proof of concept: https://github.com/opentdf/backend/pull/521 |
biscoe916
reviewed
Oct 12, 2023
schema/tdf/KeyAccessObject.md
Outdated
| @@ -25,6 +26,7 @@ A Key Access Object stores not only a wrapped (encrypted) key used to encrypt th | |||
| |`keyAccess`|Object|KeyAccess object stores all information about how an object key OR key split is stored, and if / how it has been encrypted (e.g., with KEK or pub wrapping key).|Yes| | |||
| |`type`|String|Specifies how the key is stored.<p>Possible Values: <dl><dt>remote</dt><dd>The wrapped key (see below) is stored using Virtru infrastructure and is thus not part of the final TDF manifest.</dd><dt>wrapped</dt><dd>Default for TDF 3.x and newer, the wrapped key is stored as part of the manifest.</dd><dt>remoteWrapped</dt><dd>Allows management of customer hosted keys, such as with a *Customer Key Server*. This feature is available as an upgrade path.</dd></dl>|Yes| | |||
| |`url`|String|A url pointing to the desired KAS deployment|Yes| | |||
| |`kid`|String|Identifier for the KAS public key.|Recommended| | |||
There was a problem hiding this comment.
Can we be more descriptive about how the KID is generated?
There was a problem hiding this comment.
I've added some detail here about what we currently use in our reference implementation and other alternatives, and also added a note in the swagger for the relevant endpoint
pflynn-virtru
approved these changes
Nov 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed Changes
MINOR enhancement
kid, which identifies which KAS key was used to wrap the data encryption key.kas_public_keyendpoint to allow return thekid. Unfortunately this is a major update for that field, so to maintain backward compatibility I'm adding it as an additional request parameter to the endpointIntended use:
Checklist
draft-<change>git tag -s 4.1.0 -m "Spec version 4.1.0 - did a thing")