Getting information about a secret, its contents, and access rights

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to get information about a secret:

   yc lockbox secret get --help
   

2. Get information about a secret by specifying its name or ID:

   yc lockbox secret get <secret_name>
   

   Result:

   id: e6qi98vtdva1********
   folder_id: b1go79qlt1tp********
   created_at: "2023-11-03T15:28:18.909Z"
   name: test-secret
   kms_key_id: abj765aos682********
   status: ACTIVE
   current_version:
     id: e6q7nvojsgmk********
     secret_id: e6qi98vtdva1********
     created_at: "2023-11-03T15:28:18.909Z"
     status: ACTIVE
     payload_entry_keys:
       - example-key
   

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 don't have Terraform, install it and configure the Yandex Cloud provider.

To get information about a secret using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_lockbox_secret" "my_secret" {
     secret_id = "<secret_ID>"
   }
   
   output "current_version" {
     value = data.yandex_lockbox_secret.my_secret.current_version
   }
   

   Where:

   • data "yandex_lockbox_secret": Description of the secret as a data source:
     • secret_id: Secret ID.
   • output "current_version": Output variable that contains information about the current secret version:
     • value: Returned value.

   You can replace current_version with any other parameter to get the information you need. For more information about the yandex_lockbox_secret data source parameters, see the relevant provider documentation.

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

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

   4. Apply the configuration changes:

      terraform apply
      

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

   Terraform will create the required resources and display the output variable values in the terminal. To check the results, run:

   terraform output
   

   Result:

   current_version = tolist([
     {
       "created_at" = "2024-03-27T02:45:05Z"
       "description" = ""
       "destroy_at" = ""
       "id" = "e6qo5a6imnm0********"
       "payload_entry_keys" = tolist([
         "key",
       ])
       "secret_id" = "e6qnva6ntl66********"
       "status" = "ACTIVE"
     },
   ])
   

To get information about a secret, use the get REST API method for the Secret resource or the SecretService/Get gRPC API call.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. See the description of the CLI command to get the contents of a secret:

   yc lockbox payload get --help
   

2. Get the contents of a secret by specifying its name or ID:

   yc lockbox payload get <secret_name_or_ID>
   

   Result:

   version_id: e6q7nvojsgmk********
   entries:
     - key: example-key
       text_value: example-value
   

   If a file is used as the confidential value, the returned secret content will be Base64 encoded. To decode the file, use the Linux base64 utility:

   base64 --decode <path_to_file> > output.txt
   

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 don't have Terraform, install it and configure the Yandex Cloud provider.

To get the contents of the secret using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_lockbox_secret_version" "my_secret_version" {
     secret_id  = "<secret_ID>"
     version_id = "<version_ID>"
   }
   
   output "my_secret_entries" {
     value = data.yandex_lockbox_secret_version.my_secret_version.entries
   }
   

   Where:

   • data "yandex_lockbox_secret_version": Description of the secret as a data source:
     • secret_id: Secret ID.
     • version_id: Secret version ID. This is an optional parameter. Defaults to the current secret version.
   • output "my_secret_entries": Output variable which stores the contents of the secret:
     • value: Returned value.

   For more information about the yandex_lockbox_secret_version data source parameters, see the provider documentation.

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

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

   4. Apply the configuration changes:

      terraform apply
      

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

   Terraform will create the required resources and display the output variable values in the terminal. To check the results, run:

   terraform output
   

   Result:

   my_secret_entries = [
     {
       key        = "example-key"
       text_value = "example-value"
     },
     {
       key        = "example-key"
       text_value = "example-value"
     },
   ]
   

To get the secret contents, use the get REST API method for the Payload resource or the PayloadService/Get gRPC API call.

If a file is used as the confidential value, the returned secret content will be Base64 encoded. To decode the file, use the base64 Python module or other suitable tools.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. See the description of the CLI command to view access permissions to a secret:

   yc lockbox secret list-access-bindings --help
   

2. View access permissions to a secret by specifying its name or ID:

   yc lockbox secret list-access-bindings <secret_name_or_ID>
   

   Result:

   +---------+---------------+----------------------+
   | ROLE ID | SUBJECT TYPE  |      SUBJECT ID      | 
   +---------+---------------+----------------------+
   | viewer  | federatedUser | ajej2i98kcjd******** | 
   +---------+---------------+----------------------+
   

To view access permissions to a secret, use the ListAccessBindings REST API method for the Secret resource or the SecretService/ListAccessBindings gRPC API call.