Spec-Zone.ru › AWS CLI v2

[ aws . payment-cryptography ]

start-key-usage

Описание

Включает ключ шифрования платежей Amazon Web Services, делая его активным для криптографических операций в рамках шифрования платежей Amazon Web Services.

Использование в разных учетных записях: Данная операция не может быть использована в разных учетных записях Amazon Web Services.

Связанные операции:

  • StopKeyUsage

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

Синтаксис

  start-key-usage
--key-identifier <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]

Параметры

--key-identifier (строка)

Идентификатор ключа.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

Если не указано иное, все примеры имеют правила цитирования, характерные для Unix. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для включения ключа

Следующий пример включения ключа для использования.

aws payment-cryptography start-key-usage \
    --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h

Вывод:

{
    "Key": {
        "CreateTimestamp": "1686800690",
        "Enabled": true,
        "Exportable": true,
        "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/alsuwfxug3pgy6xh",
        "KeyAttributes": {
            "KeyAlgorithm": "TDES_3KEY",
            "KeyClass": "SYMMETRIC_KEY",
            "KeyModesOfUse": {
                "Decrypt": true,
                "DeriveKey": false,
                "Encrypt": true,
                "Generate": false,
                "NoRestrictions": false,
                "Sign": false,
                "Unwrap": true,
                "Verify": false,
                "Wrap": true
            },
            "KeyUsage": "TR31_P1_PIN_GENERATION_KEY"
        },
        "KeyCheckValue": "369D",
        "KeyCheckValueAlgorithm": "ANSI_X9_24",
        "KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY",
        "KeyState": "CREATE_COMPLETE",
        "UsageStartTimestamp": "1686800690"
    }
}

Дополнительную информацию см. в разделе Включение и выключение ключей в руководстве пользователя AWS Payment Cryptography.

Вывод

Ключ -> (структура)

Идентификатор ключа шифрования платежей Amazon Web Services, активированного для использования.

KeyArn -> (строка)

Amazon Resource Name (ARN) ключа.

KeyAttributes -> (структура)

Роль ключа, поддерживаемый им алгоритм и разрешенные криптографические операции с ключом. Эти данные неизменны после создания ключа.

KeyUsage -> (строка)

Криптографическое использование ключа шифрования платежей Amazon Web Services, как определено в разделе A.5.2 спецификации TR-31.

KeyClass -> (строка)

Тип ключа шифрования платежей Amazon Web Services для создания, который определяет классификацию криптографического метода и содержит ли ключ шифрования платежей Amazon Web Services симметричный ключ или пару асимметричных ключей.

KeyAlgorithm -> (строка)

Алгоритм ключа, используемый при создании ключа шифрования платежей Amazon Web Services.

Для симметричных ключей Amazon Web Services Payment Cryptography поддерживает алгоритмы AES и TDES. Для асимметричных ключей Amazon Web Services Payment Cryptography поддерживает алгоритмы RSA и ECC_NIST.

KeyModesOfUse -> (структура)

Список криптографических операций, которые можно выполнить с помощью ключа.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для шифрования данных.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для расшифровки данных.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для обертывания других ключей.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для распаковки других ключей.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для генерации и проверки других ключей верификации карты и ПИН-кода.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для подписи.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для проверки подписей.

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

Указывает, можно ли использовать ключ шифрования платежей Amazon Web Services для вывода новых ключей.

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

Указывает, что у ключа шифрования платежей Amazon Web Services нет специальных ограничений, кроме ограничений, подразумеваемых KeyUsage.

KeyCheckValue -> (строка)

Значение проверки ключа (KCV) используется для проверки того, что все стороны, владеющие заданным ключом, имеют один и тот же ключ или для выявления изменения ключа.

KeyCheckValueAlgorithm -> (строка)

Алгоритм, используемый Amazon Web Services Payment Cryptography для вычисления значения проверки ключа (KCV). Он используется для проверки целостности ключа.

Для ключей TDES KCV вычисляется путем шифрования 8 байтов, каждое с нулевым значением, с проверяемым ключом и сохранения 3 старших байтов зашифрованного результата. Для ключей AES KCV вычисляется с помощью алгоритма CMAC, где входные данные составляют 16 нулевых байтов, а сохраняются 3 старших байта зашифрованного результата.

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

Указывает, включен ли ключ.

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

Указывает, экспортируемый ли ключ. Эти данные неизменны после создания ключа.

KeyState -> (строка)

Состояние ключа, который создается или удаляется.

KeyOrigin -> (строка)

Источник материала ключа. Для ключей, созданных в рамках Amazon Web Services Payment Cryptography, значение равно AWS_PAYMENT_CRYPTOGRAPHY. Для ключей, импортированных в Amazon Web Services Payment Cryptography, значение равно EXTERNAL.

CreateTimestamp -> (временная метка)

Дата и время создания ключа.

UsageStartTimestamp -> (временная метка)

Дата и время, после которых Amazon Web Services Payment Cryptography начнет использовать материал ключа для криптографических операций.

UsageStopTimestamp -> (временная метка)

Дата и время, после которых Amazon Web Services Payment Cryptography перестанет использовать материал ключа для криптографических операций.

DeletePendingTimestamp -> (временная метка)

Дата и время, после которых Amazon Web Services Payment Cryptography удалит ключ. Это значение присутствует только тогда, когда KeyState равен DELETE_PENDING и ключ запланирован на удаление.

DeleteTimestamp -> (временная метка)

Дата и время, после которых Amazon Web Services Payment Cryptography удалит ключ. Это значение присутствует только тогда, когда значение KeyState равно DELETE_COMPLETE, и ключ шифрования платежей Amazon Web Services удален.

DeriveKeyUsage -> (строка)

Криптографическое использование ключа, полученного с помощью ECDH, как определено в разделе A.5.2 спецификации TR-31.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API