Add activation key encryption - #61
Open
bpescato-amazon wants to merge 3 commits into
Open
Conversation
…ted union
- Add GET /providers/{provider}/environments/{environment}/activationKeyParameters
- Replace flat ActivationKey with oneOf discriminator (ActivationKeyV1, ActivationKeyV2)
- Add ActivationKeyEncryptedPayload schema for decrypted v2 inner contents
- Add GetActivationKeyParametersResponse with supportedVersions and encryption
- Add EncryptionParameters schema (publicKey, algorithm, keyFormat)
- Read-only endpoint only (no POST/DELETE/PATCH)
bpescato-amazon
force-pushed
the
add-activation-key-encryption
branch
from
August 11, 2026 01:03
73d0574 to
0971219
Compare
dkarwowski
reviewed
Aug 27, 2026
| All versions share a common envelope containing `version` and | ||
| `destinationEnvironmentUri`. The remaining fields differ by version. | ||
| type: object | ||
| required: |
Collaborator
There was a problem hiding this comment.
For cleanliness, I'd suggest you just put the properties for version / destinationEnvironmentUri here instead of each oneof reference
properties:
version: ...
destinationEnvironmentUri: ...
oneOf:
- $ref: "$/V1"
- $ref: "$/V2"should work correctly because oneOf refs get merged in at the same depth as where the 'oneOf' is.
| description: |- | ||
| The PEM-encoded public key for encrypting activation key contents | ||
| destined for this environment. Rotated weekly; the environment accepts | ||
| keys encrypted with any of the 4 most recent public keys. |
Collaborator
There was a problem hiding this comment.
Maybe rotation frequency should actually be included as a parameter? Helps inform the caller how often they should be pulling a new key, assuming some providers want more frequent rotations.
| publicKey: | ||
| description: |- | ||
| The PEM-encoded public key for encrypting activation key contents | ||
| destined for this environment. Rotated weekly; the environment accepts |
Collaborator
There was a problem hiding this comment.
"Should" be rotated weekly?
Presumably a pair of providers can agree on their frequency based on security needs (either more or less). As part of the spec we recommend at least weekly and matches what we prefer.
| $ref: paths/environments.yaml#/OneEnvironment | ||
| /providers/{provider}/environments/{environment}/ConfirmActivationKey: | ||
| $ref: paths/environments.yaml#/ConfirmActivationKey | ||
| /providers/{provider}/environments/{environment}/activationKeyParameters: |
Collaborator
There was a problem hiding this comment.
Any reason to prefer a custom method instead of adding the parameters as attributes on the environment itself?
…ationKey base Address review feedback: declare the shared envelope properties on the ActivationKey base alongside oneOf, instead of repeating destinationEnvironmentUri in each variant. oneOf branches merge at the same depth, so V1/V2 still contribute their variant-specific fields. version retains its per-variant enum constraint in each branch for discrimination. Backward compatible with v1 keys.
…ording - Add optional nextRotationAt (UTC date-time) so callers know when to refetch the public key, instead of exposing a rotation-frequency parameter. - Soften publicKey rotation guidance: recommend at least weekly, but cadence is agreed between the two partners per their security needs.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds in a new API to fetch encryption/activation key parameters.
Designs a scheme for encrypted activation key processes.