generate-random

Описание

Возвращает строку случайных байтов, криптографически безопасную.

Вы должны использовать параметр NumberOfBytes, чтобы указать длину строки случайных байтов. Значение длины строки по умолчанию отсутствует.

По умолчанию, строка случайных байтов генерируется в KMS. Для генерации строки байтов в кластере CloudHSM, связанном с хранилищем ключей CloudHSM, используйте параметр CustomKeyStoreId.

Дополнительную информацию об энтропии и генерации случайных чисел см. в разделе Справочник по криптографии Key Management Service.

См. также: Документацию API AWS

Синтаксис

  generate-random
[--number-of-bytes <value>]
[--custom-key-store-id <value>]
[--recipient <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--number-of-bytes (целое число)

--custom-key-store-id (строка)

--recipient (структура)

Сокращённый синтаксис:

KeyEncryptionAlgorithm=string,AttestationDocument=blob

Синтаксис JSON:

{
  "KeyEncryptionAlgorithm": "RSAES_OAEP_SHA_256",
  "AttestationDocument": blob
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON строки. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-предоставленного значения, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или значение input, выводит пример JSON ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, оно выведет пример YAML ввода, который может быть использован с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON скелет не стабилен между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS сервисами. Для каждого SSL соединения AWS CLI будет проверять SSL сертификаты. Этот параметр переопределяет поведение проверки SSL сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить вывод цвета.

• on
• off
• auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для использования при проверке SSL сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb:// всегда будет рассматриваться как двоичное и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить страницу cli для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Пример 1: Генерация 256-битной случайной строки байтов (Linux или macOS)

В следующем generate-random примере генерируется 256-битная (32-байтовая), закодированная в base64 случайная строка байтов. Пример декодирует строку байтов и сохраняет её в файле random.

При выполнении этой команды необходимо использовать параметр number-of-bytes для указания длины случайного значения в байтах.

При выполнении этой команды не указывается ключ KMS. Случайная строка байтов не связана ни с каким ключом KMS.

По умолчанию AWS KMS генерирует случайное число. Однако, если вы укажете `настраиваемый хранилище ключей<https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html>`__, случайная строка байтов будет сгенерирована в кластере AWS CloudHSM, связанном с настраиваемым хранилищем ключей.

В этом примере используются следующие параметры и значения:

• Он использует обязательный параметр --number-of-bytes со значением 32 для запроса строки длиной 32 байта (256 бит).

• Он использует параметр --output со значением text для перенаправления AWS CLI на возврат выходных данных в виде текста, а не JSON.

• Он использует --query parameter для извлечения значения свойства Plaintext из ответа.

• Он перенаправляет ( | ) выходные данные команды на утилиту base64, которая декодирует извлечённые выходные данные.

• Он использует оператор перенаправления ( > ) для сохранения декодированной строки байтов в файл ExampleRandom.

• Он использует оператор перенаправления ( > ) для сохранения двоичного зашифрованного текста в файл.

  aws kms generate-random \
      --number-of-bytes 32 \
      --output text \
      --query Plaintext | base64 --decode > ExampleRandom
  

Эта команда не производит никакого вывода.

Дополнительную информацию см. в GenerateRandom в AWS Key Management Service API Reference.

Пример 2: Генерация 256-битного случайного числа (командная строка Windows)

В следующем примере используется команда generate-random для генерации 256-битной (32-байтовой), закодированной в base64 случайной строки байтов. Пример декодирует строку байтов и сохраняет её в файле random. Этот пример такой же, как предыдущий, за исключением использования утилиты certutil в Windows для base64-декодирования случайной строки байтов перед сохранением её в файл.

Сначала сгенерируйте закодированную в base64 случайную строку байтов и сохраните её во временном файле, ExampleRandom.base64.

aws kms generate-random \
    --number-of-bytes 32 \
    --output text \
    --query Plaintext > ExampleRandom.base64

Поскольку выходные данные команды generate-random сохраняются в файле, в этом примере не выводится никакого результата.

Теперь используйте команду certutil -decode для декодирования закодированной в base64 строки байтов в файле ExampleRandom.base64. Затем она сохранит декодированную строку байтов в файл ExampleRandom.

certutil -decode ExampleRandom.base64 ExampleRandom

Вывод:

Input Length = 18
Output Length = 12
CertUtil: -decode command completed successfully.

Дополнительную информацию см. в GenerateRandom в AWS Key Management Service API Reference.

Вывод

Открытый текст -> (блок)

CiphertextForRecipient -> (блок)