aws-elixir v0.1.0 AWS.KMS
AWS Key Management Service
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
- [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) - This topic provides general information about the types of credentials used for accessing AWS.
- [Temporary Security Credentials](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) - This section of the *IAM User Guide* describes how to create and use temporary security credentials.
- [Signature Version 4 Signing Process](http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
- `Encrypt`
- `Decrypt`
- `GenerateDataKey`
- `GenerateDataKeyWithoutPlaintext`
Summary
Functions
Cancels the deletion of a customer master key (CMK). When this operation is
successful, the CMK is set to the Disabled
state. To enable a CMK, use
EnableKey
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word “alias” followed by a forward slash (alias/). An alias that begins with “aws” after the forward slash (alias/aws…) is reserved by Amazon Web Services (AWS)
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies
Creates a customer master key (CMK)
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions
Deletes the specified alias. To map an alias to a different key, call
UpdateAlias
Provides detailed information about the specified customer master key
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide
Disables rotation of the specified key
Marks a key as enabled, thereby permitting its use
Enables rotation of the specified customer master key
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases
Generates a data key that you can use in your application to locally
encrypt data. This call returns a plaintext version of the key in the
Plaintext
field of the response object and an encrypted copy of the key
in the CiphertextBlob
field. The key is encrypted by using the master key
specified by the KeyId
field. To decrypt the encrypted key, pass it to
the Decrypt
API
Returns a data key encrypted by a customer master key without the plaintext
copy of that key. Otherwise, this API functions exactly like
GenerateDataKey
. You can use this API to, for example, satisfy an audit
requirement that an encrypted key be made available without exposing the
plaintext copy of that key
Generates an unpredictable byte string
Retrieves a policy attached to the specified key
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key
Lists all of the key aliases in the account
List the grants for a specified key
Retrieves a list of policies attached to a key
Lists the customer master keys
Returns a list of all grants for which the grant’s RetiringPrincipal
matches the one specified
Attaches a key policy to the specified customer master key (CMK)
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext
Retires a grant. You can retire a grant when you’re done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API
Revokes a grant. You can revoke a grant to actively deny operations that depend on it
Schedules the deletion of a customer master key (CMK). You may provide a
waiting period, specified in days, before deletion occurs. If you do not
provide a waiting period, the default period of 30 days is used. When this
operation is successful, the state of the CMK changes to PendingDeletion
.
Before the waiting period ends, you can use CancelKeyDeletion
to cancel
the deletion of the CMK. After the waiting period ends, AWS KMS deletes the
CMK and all AWS KMS data associated with it, including all aliases that
point to it
Updates an alias to map it to a different key
Updates the description of a key
Functions
Cancels the deletion of a customer master key (CMK). When this operation is
successful, the CMK is set to the Disabled
state. To enable a CMK, use
EnableKey
.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word “alias” followed by a forward slash (alias/). An alias that begins with “aws” after the forward slash (alias/aws…) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias
.
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
- The `GenerateDataKey` operation
- [AWS Key Management Service Concepts](http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) in the *AWS Key Management Service Developer Guide*
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
- `GenerateDataKey`
- `GenerateDataKeyWithoutPlaintext`
- `Encrypt`
Deletes the specified alias. To map an alias to a different key, call
UpdateAlias
.
Provides detailed information about the specified customer master key.
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Enables rotation of the specified customer master key.
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases:
- You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
- If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Generates a data key that you can use in your application to locally
encrypt data. This call returns a plaintext version of the key in the
Plaintext
field of the response object and an encrypted copy of the key
in the CiphertextBlob
field. The key is encrypted by using the master key
specified by the KeyId
field. To decrypt the encrypted key, pass it to
the Decrypt
API.
We recommend that you use the following pattern to locally encrypt data:
call the GenerateDataKey
API, use the key returned in the Plaintext
response field to locally encrypt data, and then erase the plaintext data
key from memory. Store the encrypted data key (contained in the
CiphertextBlob
field) alongside of the locally encrypted data.
you must also store the context in full or at least store enough
information along with the encrypted data to be able to reconstruct the
context when submitting the ciphertext to the Decrypt
API. It is a good
practice to choose a context that you can reconstruct on the fly to better
secure the ciphertext. For more information about how this parameter is
used, see Encryption
Context.
To decrypt data, pass the encrypted data key to the Decrypt
API.
Decrypt
uses the associated master key to decrypt the encrypted data key
and returns it as plaintext. Use the plaintext data key to locally decrypt
your data and then erase the key from memory. You must specify the
encryption context, if any, that you specified when you generated the key.
The encryption context is logged by CloudTrail, and you can use this log to
help track the use of particular data.
Returns a data key encrypted by a customer master key without the plaintext
copy of that key. Otherwise, this API functions exactly like
GenerateDataKey
. You can use this API to, for example, satisfy an audit
requirement that an encrypted key be made available without exposing the
plaintext copy of that key.
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
Returns a list of all grants for which the grant’s RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire
a grant, use RetireGrant
.
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt
is authorized twice - once as
ReEncryptFrom
on the source key and once as ReEncryptTo
on the
destination key. We therefore recommend that you include the
"action":"kms:ReEncrypt*"
statement in your key policies to permit
re-encryption from or to the key. The statement is included automatically
when you authorize use of the key through the console but must be included
manually when you set a policy by using the PutKeyPolicy
function.
Retires a grant. You can retire a grant when you’re done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
- The account that created the grant
- The `RetiringPrincipal`, if present
- The `GranteePrincipal`, if `RetireGrant` is a grantee operation
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
Schedules the deletion of a customer master key (CMK). You may provide a
waiting period, specified in days, before deletion occurs. If you do not
provide a waiting period, the default period of 30 days is used. When this
operation is successful, the state of the CMK changes to PendingDeletion
.
Before the waiting period ends, you can use CancelKeyDeletion
to cancel
the deletion of the CMK. After the waiting period ends, AWS KMS deletes the
CMK and all AWS KMS data associated with it, including all aliases that
point to it.
Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word “alias” followed by a forward slash (alias/). An alias that begins with “aws” after the forward slash (alias/aws…) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.