encrypt - encrypt

Ссылка

Service:: Key Vault

API Version:: 7.4

Шифрует произвольную последовательность байтов с помощью ключа шифрования, хранящегося в хранилище ключей.
Операция ENCRYPT шифрует произвольную последовательность байтов с использованием ключа шифрования, находящегося в службе хранилища ключей Azure. Следует отметить, что операция ENCRYPT поддерживает только один блок данных, размер которого зависит от целевого ключа и используемого алгоритма шифрования. Операция ENCRYPT строго необходима только для симметричных ключей, находящихся в хранилище ключей Azure, так как шифрование с асимметричным ключом может быть выполнено с использованием открытой части ключа. Эта операция поддерживается для асимметричных ключей для удобства вызывающих объектов, имеющих ключ-ссылку, но не имеющих доступа к открытому материалу ключа. Для этой операции требуется разрешение "ключи/шифрование".

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/encrypt?api-version=7.4

Параметры URI

Имя	В	Обязательно	Тип	Описание
key-name	path	True	string	Имя ключа.
key-version	path	True	string	Версия ключа.
vaultBaseUrl	path	True	string	Имя хранилища, например https://myvault.vault.azure.net.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Обязательно	Тип	Описание
alg	True	JsonWebKeyEncryptionAlgorithm	идентификатор алгоритма
value	True	string
aad		string	Дополнительные данные для проверки подлинности, но не для шифрования и расшифровки при использовании алгоритмов шифрования, прошедших проверку подлинности.
iv		string	Криптографически случайный, неповторяющийся вектор инициализации для симметричного алгоритма.
tag		string	Тег для проверки подлинности при выполнении расшифровки с помощью алгоритма, прошедшего проверку подлинности.

Ответы

Имя	Тип	Описание
200 OK	KeyOperationResult	Результат шифрования.
Other Status Codes	KeyVaultError	Key Vault ответ об ошибке, описывающий причину сбоя операции.

Примеры

Encrypt example

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535/encrypt?api-version=7.4

{
  "alg": "RSA1_5",
  "value": "5ka5IVsnGrzufA"
}

Sample Response

Status code:: 200

{
  "kid": "https://myvault.vault.azure.net/keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535",
  "value": "CR0Hk0z72oOit5TxObqRpo-WFGZkb5BeN1C0xJFKHxzdDCESYPCNB-OkiWVAnMcSyu6g2aC8riVRRxY5MC2CWKj-CJ_SMke5X2kTi5yi4hJ5vuOLzmg_M6Bmqib7LsI-TeJHr9rs3-tZaSCdZ2zICeFWYduWV5rPjTnAD98epTorT8AA1zMaYHMIhKpmttcj18-dHr0E0T55dgRtsjK04uC3FlRd3odl4RhO1UHAmYpDd5FUqN-20R0dK0Zk8F8sOtThLhEmuLvqPHOCUBiGUhHA4nRDq1La4SUbThu2KMQJL6BbxxEymuliaYcNNtW7MxgVOf6V3mFxVNRY622i9g"
}

Определения

Имя	Описание
Error	Ошибка сервера хранилища ключей.
JsonWebKeyEncryptionAlgorithm	идентификатор алгоритма
KeyOperationResult	Результат операции с ключом.
KeyOperationsParameters	Параметры ключевых операций.
KeyVaultError	Исключение ошибки хранилища ключей.

Error

Ошибка сервера хранилища ключей.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	Error	Ошибка сервера хранилища ключей.
message	string	Сообщение об ошибке.

JsonWebKeyEncryptionAlgorithm

идентификатор алгоритма

Имя	Тип	Описание
A128CBC	string
A128CBCPAD	string
A128GCM	string
A128KW	string
A192CBC	string
A192CBCPAD	string
A192GCM	string
A192KW	string
A256CBC	string
A256CBCPAD	string
A256GCM	string
A256KW	string
RSA-OAEP	string
RSA-OAEP-256	string
RSA1_5	string

KeyOperationResult

Результат операции с ключом.

Имя	Тип	Описание
aad	string
iv	string
kid	string	Идентификатор ключа
tag	string
value	string

KeyOperationsParameters

Параметры ключевых операций.

Имя	Тип	Описание
aad	string	Дополнительные данные для проверки подлинности, но не для шифрования и расшифровки при использовании алгоритмов шифрования, прошедших проверку подлинности.
alg	JsonWebKeyEncryptionAlgorithm	идентификатор алгоритма
iv	string	Криптографически случайный, неповторяющийся вектор инициализации для симметричного алгоритма.
tag	string	Тег для проверки подлинности при выполнении расшифровки с помощью алгоритма, прошедшего проверку подлинности.
value	string

KeyVaultError

Исключение ошибки хранилища ключей.

Имя	Тип	Описание
error	Error	Ошибка сервера хранилища ключей.