Symmetric data encryption

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To encrypt data:

1. In the configuration file, describe the parameters of the yandex_kms_secret_ciphertext resource and specify the KMS key in the key_id field:

   resource "yandex_kms_secret_ciphertext" "password" {
     key_id      = "<key_ID>"
     aad_context = "additional authenticated data"
     plaintext   = "strong password"
   }
   

   Where:

   • key_id: KMS key ID.
   • aad_context: (AAD context).
   • plaintext: String to be encrypted.

   Warning

   yandex_kms_secret_ciphertext enables you to hide secrets when deploying an infrastructure. However, in general, it is not safe to openly specify the plaintext and aad_context in the configuration file. Secrets can be read from configuration files or execution logs and can end up in the Terraform state.

   For more information about resource parameters in Terraform, see the provider documentation.

2. Check the configuration using this command:

   terraform validate
   

   If the configuration is correct, you will get this message:

   Success! The configuration is valid.
   

3. Run this command:

   terraform plan
   

   The terminal will display a list of resources with parameters. No changes will be made at this step. If the configuration contains any errors, Terraform will point them out.

4. Apply the configuration changes:

   terraform apply
   

5. Confirm the changes: type yes into the terminal and press Enter.

   The ciphertext can then be accessed via the ciphertext variable, and the encrypted data via the plaintext variable.

   To check, you can add the following code with the decrypted_pass output variable to the configuration file.

   Alert

   This is not safe and can only be used for testing.

   output "decrypted_pass" {
     sensitive = true
     value     = yandex_kms_secret_ciphertext.password.plaintext
   }
   

   After updating the configuration, you can check the encrypted data using the command:

   terraform output decrypted_pass
   

   Result:

   "strong password"
   

To encrypt data, use the encrypt REST API method for the SymmetricCrypto resource or the SymmetricCryptoService/Encrypt gRPC API call.

For information about how to encrypt and decrypt data using the Yandex Cloud SDK, see Encrypting data using the Yandex Cloud SDK.

For information about how to encrypt and decrypt data using the AWS Encryption SDK, see Encrypting data using the AWS Encryption SDK.

For information about how to encrypt and decrypt data using Google Tink, see Encrypting data using Google Tink.

To decrypt data, use the decrypt REST API method for the SymmetricCrypto resource or the SymmetricCryptoService/Decrypt gRPC API call.

For information about how to encrypt and decrypt data using the Yandex Cloud SDK, see Encrypting data using the Yandex Cloud SDK.

For information about how to encrypt and decrypt data using the AWS Encryption SDK, see Encrypting data using the AWS Encryption SDK.

For information about how to encrypt and decrypt data using Google Tink, see Encrypting data using Google Tink.