Связаться с намиПодключиться

Получить информацию о секрете, его содержимом и правах доступа

Статья создана
Улучшена
Обновлена 11 ноября 2024 г.

Вы можете получить подробную информацию о секрете, содержимое секрета, а также просмотреть права доступа к секрету.

Получить информацию о секрете

  1. В консоли управления выберите каталог, которому принадлежит секрет.
  2. В списке сервисов выберите Lockbox.
  3. В меню слева выберите Секреты.
  4. Нажмите на имя нужного секрета.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

  1. Посмотрите описание команды CLI для получения информации о секрете:

    yc lockbox secret get --help

  2. Получите информацию о секрете, указав его имя или идентификатор:

    yc lockbox secret get <имя_секрета>

    Результат:

    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

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

Чтобы получить информацию о секрете с помощью Terraform:

  1. Добавьте в конфигурационный файл Terraform блоки data и output:

    data "yandex_lockbox_secret" "my_secret" {
  secret_id = "<идентификатор_секрета>"
}

output "current_version" {
  value = data.yandex_lockbox_secret.my_secret.current_version
}

    Где:

    • data "yandex_lockbox_secret" — описание секрета в качестве источника данных:
      • secret_id — идентификатор секрета.
    • output "current_version" — выходная переменная, которая содержит информацию о текущей версии секрета:
      • value — возвращаемое значение.

    Вместо current_version вы можете выбрать любой другой параметр для получения информации. Более подробно о параметрах источника данных yandex_lockbox_secret см. в документации провайдера.

  2. Создайте ресурсы:

    1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

    2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.

    3. Выполните команду:

      terraform plan

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

    4. Примените изменения конфигурации:

      terraform apply

    5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

    Terraform создаст все требуемые ресурсы и отобразит значения выходных переменных в терминале. Чтобы проверить результат, выполните команду:

    terraform output

    Результат:

    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"
  },
])

Чтобы получить информацию о секрете, воспользуйтесь методом REST API get для ресурса Secret или вызовом gRPC API SecretService/Get.

Получить содержимое секрета

  1. В консоли управления выберите каталог, которому принадлежит секрет.
  2. В списке сервисов выберите Lockbox.
  3. В меню слева выберите Секреты.
  4. Нажмите на имя нужного секрета.
  5. В разделе Версии нажмите на нужную версию секрета.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

  1. Посмотрите описание команды CLI для получения содержимого секрета:

    yc lockbox payload get --help

  2. Получите содержимое секрета, указав его имя или идентификатор:

    yc lockbox payload get <имя_или_идентификатор_секрета>

    Результат:

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

    Если в качестве конфиденциального значения используется файл, то содержимое секрета возвращается в кодировке Base64. Вы можете декодировать файл с помощью утилиты base64 на Linux:

    base64 --decode <путь_к_файлу> > output.txt

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

Чтобы получить содержимое секрета с помощью Terraform:

  1. Добавьте в конфигурационный файл Terraform блоки data и output:

    data "yandex_lockbox_secret_version" "my_secret_version" {
  secret_id  = "<идентификатор_секрета>"
  version_id = "<идентификатор_версии>"
}

output "my_secret_entries" {
  value = data.yandex_lockbox_secret_version.my_secret_version.entries
}

    Где:

    • data "yandex_lockbox_secret_version" — описание секрета в качестве источника данных:
      • secret_id — идентификатор секрета.
      • version_id — идентификатор версии секрета. Необязательный параметр. По умолчанию используется текущая версия секрета.
    • output "my_secret_entries" — выходная переменная, которая хранит содержимое секрета:
      • value — возвращаемое значение.

    Более подробно о параметрах источника данных yandex_lockbox_secret_version см. в документации провайдера.

  2. Создайте ресурсы:

    1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

    2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.

    3. Выполните команду:

      terraform plan

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

    4. Примените изменения конфигурации:

      terraform apply

    5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

    Terraform создаст все требуемые ресурсы и отобразит значения выходных переменных в терминале. Чтобы проверить результат, выполните команду:

    terraform output

    Результат:

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

Чтобы получить содержимое секрета, воспользуйтесь методом REST API get для ресурса Payload или вызовом gRPC API PayloadService/Get.

Если в качестве конфиденциального значения используется файл, то содержимое секрета возвращается в кодировке Base64. Вы можете декодировать файл с помощью модуля base64 в Python или других инструментов.

Просмотреть права доступа к секрету

  1. В консоли управления выберите каталог, которому принадлежит секрет.
  2. В списке сервисов выберите Lockbox.
  3. В меню слева выберите Секреты.
  4. Нажмите на имя нужного секрета.
  5. На панели слева выберите раздел Права доступа.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

  1. Посмотрите описание команды CLI для просмотра прав доступа к секрету:

    yc lockbox secret list-access-bindings --help

  2. Просмотрите права доступа к секрету, указав его имя или идентификатор:

    yc lockbox secret list-access-bindings <имя_или_идентификатор_секрета>

    Результат:

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

Чтобы посмотреть права доступа к секрету, воспользуйтесь методом REST API ListAccessBindings для ресурса Secret или вызовом gRPC API SecretService/ListAccessBindings.

Предыдущая
Настроить права доступа к секрету
Следующая
Удалить секрет