Container for the parameters to the Encrypt operation.
Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or
asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.
You can use this operation to encrypt small amounts of arbitrary data, such as a personal
identifier or database password, or other sensitive information. You don't need to
use the Encrypt operation to encrypt a data key. The GenerateDataKey
and GenerateDataKeyPair operations return a plaintext data key and an encrypted
copy of that data key.
If you use a symmetric encryption KMS key, you can use an encryption context to add
additional security to your encryption operation. If you specify an EncryptionContext
when encrypting data, you must specify the same encryption context (a case-sensitive
exact match) when decrypting the data. Otherwise, the request to decrypt fails with
an InvalidCiphertextException. For more information, see Encryption
Context in the Key Management Service Developer Guide.
If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The algorithm must be compatible with the KMS key spec.
When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The maximum size of the data that you can encrypt varies with the type of KMS key and the encryption algorithm that you choose.
Symmetric encryption KMS keys
SYMMETRIC_DEFAULT: 4096 bytes
RSA_2048RSAES_OAEP_SHA_1: 214 bytesRSAES_OAEP_SHA_256: 190 bytes
RSA_3072RSAES_OAEP_SHA_1: 342 bytesRSAES_OAEP_SHA_256: 318 bytes
RSA_4096RSAES_OAEP_SHA_1: 470 bytesRSAES_OAEP_SHA_256: 446 bytes
SM2PKE: 1024 bytes (China Regions only)
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN in the value of the
KeyId parameter.
Required permissions: kms:Encrypt (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.EncryptRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class EncryptRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The EncryptRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
EncryptRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DryRun | System.Boolean |
Gets and sets the property DryRun.
Checks if your request will succeed. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide. |
|
|
EncryptionAlgorithm | Amazon.KeyManagementService.EncryptionAlgorithmSpec |
Gets and sets the property EncryptionAlgorithm. Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value, The SM2PKE algorithm is only available in China Regions. |
|
|
EncryptionContext | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property EncryptionContext. Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended. For more information, see Encryption context in the Key Management Service Developer Guide. |
|
|
GrantTokens | System.Collections.Generic.List<System.String> |
Gets and sets the property GrantTokens. A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide. |
|
|
KeyId | System.String |
Gets and sets the property KeyId.
Identifies the KMS key to use in the encryption operation. The KMS key must have a
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using
an alias name, prefix it with For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. |
|
|
Plaintext | System.IO.MemoryStream |
Gets and sets the property Plaintext. Data to be encrypted. |
Examples
The following example encrypts data with the specified symmetric encryption KMS key.
To encrypt data with a symmetric encryption KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.Encrypt(new EncryptRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
Plaintext = new MemoryStream(<binary data>) // The data to encrypt.
});
MemoryStream ciphertextBlob = response.CiphertextBlob; // The encrypted data (ciphertext).
string encryptionAlgorithm = response.EncryptionAlgorithm; // The encryption algorithm that was used in the operation. For symmetric encryption keys, the encryption algorithm is always SYMMETRIC_DEFAULT.
string keyId = response.KeyId; // The ARN of the KMS key that was used to encrypt the data.
The following example encrypts data with the specified RSA asymmetric KMS key. When you encrypt with an asymmetric key, you must specify the encryption algorithm.
To encrypt data with an asymmetric encryption KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.Encrypt(new EncryptRequest
{
EncryptionAlgorithm = "RSAES_OAEP_SHA_256", // The encryption algorithm to use in the operation.
KeyId = "0987dcba-09fe-87dc-65ba-ab0987654321", // The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
Plaintext = new MemoryStream(<binary data>) // The data to encrypt.
});
MemoryStream ciphertextBlob = response.CiphertextBlob; // The encrypted data (ciphertext).
string encryptionAlgorithm = response.EncryptionAlgorithm; // The encryption algorithm that was used in the operation.
string keyId = response.KeyId; // The ARN of the KMS key that was used to encrypt the data.
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5