Skip to content

Latest commit

 

History

History
140 lines (121 loc) · 4.78 KB

kms.md

File metadata and controls

140 lines (121 loc) · 4.78 KB

KMS

AWS's kms service · portable interface driver.KMS · AWS index

Operations (54)

Operation Description
CancelKeyDeletion
ConnectCustomKeyStore
CreateAlias Aliases.
CreateCustomKeyStore
CreateGrant Grants.
CreateKey Key lifecycle.
Decrypt
DeleteAlias
DeleteCustomKeyStore
DeleteImportedKeyMaterial
DeriveSharedSecret
DescribeCustomKeyStores DescribeCustomKeyStores returns every store, or only the one matching id
DescribeKey
DisableKey
DisableKeyRotation
DisconnectCustomKeyStore
EnableKey
EnableKeyRotation Rotation.
Encrypt
GenerateDataKey
GenerateDataKeyPair
GenerateDataKeyPairWithoutPlaintext
GenerateDataKeyWithoutPlaintext
GenerateMac
GenerateRandom
GenerateRandomInCustomKeyStore GenerateRandomInCustomKeyStore serves GenerateRandom with a CustomKeyStoreId.
GetKeyPolicy Key policies.
GetKeyRotationStatus
GetParametersForImport
GetPublicKey
ImportKeyMaterial
ListAliases
ListGrants
ListKeyPolicies
ListKeyRotations
ListKeys
ListResourceTags
ListRetirableGrants
PutKeyPolicy
ReEncrypt
ReplicateKey
RetireGrant
RevokeGrant
RotateKeyOnDemand
ScheduleKeyDeletion
Sign
TagResource Tags.
UntagResource
UpdateAlias
UpdateCustomKeyStore
UpdateKeyDescription
UpdatePrimaryRegion
Verify
VerifyMac

Optional capabilities

Discovered by type assertion; only some providers implement these.

Crypto

Crypto is the cryptographic surface of KMS. It is embedded in the KMS

Operation Description
Decrypt
DeriveSharedSecret
Encrypt
GenerateDataKey
GenerateDataKeyPair
GenerateDataKeyPairWithoutPlaintext
GenerateDataKeyWithoutPlaintext
GenerateMac
GenerateRandom
GetPublicKey
ReEncrypt
Sign
Verify
VerifyMac

CustomKeyStores

CustomKeyStores is the custom key store surface of KMS.

Operation Description
ConnectCustomKeyStore
CreateCustomKeyStore
DeleteCustomKeyStore
DescribeCustomKeyStores DescribeCustomKeyStores returns every store, or only the one matching id
DisconnectCustomKeyStore
GenerateRandomInCustomKeyStore GenerateRandomInCustomKeyStore serves GenerateRandom with a CustomKeyStoreId.
UpdateCustomKeyStore

KeyImport

KeyImport is the import-material and multi-region surface of KMS.

Operation Description
DeleteImportedKeyMaterial
GetParametersForImport
ImportKeyMaterial
ReplicateKey
UpdatePrimaryRegion

Management

Management is the grants/rotation/policy surface of KMS.

Operation Description
CreateGrant Grants.
DisableKeyRotation
EnableKeyRotation Rotation.
GetKeyPolicy Key policies.
GetKeyRotationStatus
ListGrants
ListKeyPolicies
ListKeyRotations
ListRetirableGrants
PutKeyPolicy
RetireGrant
RevokeGrant
RotateKeyOnDemand

Not in scope

  • Custom key stores are control-plane only. There is no CloudHSM cluster or external key store proxy to reach, so ConnectCustomKeyStore moves a store straight to CONNECTED and never reports CONNECTING, FAILED or a ConnectionErrorCode, and CreateCustomKeyStore does not contact a PUBLIC_ENDPOINT proxy. Cluster existence and activity, cluster relatedness (CloudHsmClusterNotRelatedException), the trust anchor, the kmsuser password and the proxy credentials are not checked. Keys in a store use locally generated key material, so crypto works the same as for AWS_KMS keys while the store is connected. While it is not, the keys report KeyState Unavailable (a PendingDeletion key keeps that state) and crypto fails with KMSInvalidStateException. GenerateRandom with the CustomKeyStoreId of a connected CloudHSM store returns locally generated bytes.
  • DeriveSharedSecret returns the raw ECDH secret only. The Nitro Enclave / NitroTPM Recipient attestation flow (CiphertextForRecipient), DryRun and grant tokens are not emulated.
  • SM2 (China Regions only), ECC_SECG_P256K1, ML-DSA and ECC_NIST_EDWARDS25519 key specs are not supported, so KEY_AGREEMENT keys are limited to ECC_NIST_P256, ECC_NIST_P384 and ECC_NIST_P521.