sign - sign

Référence

Service:: Key Vault

API Version:: 7.4

Crée une signature à partir d’un digest à l’aide de la clé spécifiée.
L’opération SIGN s’applique aux clés asymétriques et symétriques stockées dans Azure Key Vault, car cette opération utilise la partie privée de la clé. Cette opération nécessite l’autorisation clés/signe.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
key-name	path	True	string	Nom de la clé.
key-version	path	True	string	Version de la clé.
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Obligatoire	Type	Description
alg	True	JsonWebKeySignatureAlgorithm	Identificateur de l’algorithme de signature/vérification. Pour plus d’informations sur les types d’algorithmes possibles, consultez JsonWebKeySignatureAlgorithm.
value	True	string

Réponses

Nom	Type	Description
200 OK	KeyOperationResult	Valeur de signature.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Sign

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/testkey/9885aa558e8d448789683188f8c194b0/sign?api-version=7.4

{
  "alg": "RS512",
  "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg"
}

Sample Response

Status code:: 200

{
  "kid": "https://myvault.vault.azure.net/keys/testkey/9885aa558e8d448789683188f8c194b0",
  "value": "aKFG8NXcfTzqyR44rW42484K_zZI_T7zZuebvWuNgAoEI1gXYmxrshp42CunSmmu4oqo4-IrCikPkNIBkHXnAW2cv03Ad0UpwXhVfepK8zzDBaJPMKVGS-ZRz8CshEyGDKaLlb3J3zEkXpM3RrSEr0mdV6hndHD_mznLB5RmFui5DsKAhez4vUqajgtkgcPfCekMqeSwp6r9ItVL-gEoAohx8XMDsPedqu-7BuZcBcdayaPuBRL4wWoTDULA11P-UN_sJ5qMj3BbiRYhIlBWGR04wIGfZ3pkJjHJUpOvgH2QajdYPzUBauOCewMYbq9XkLRSzI_A7HkkDVycugSeAA"
}

Définitions

Nom	Description
Error	Erreur du serveur du coffre de clés.
JsonWebKeySignatureAlgorithm	Identificateur de l’algorithme de signature/vérification. Pour plus d’informations sur les types d’algorithmes possibles, consultez JsonWebKeySignatureAlgorithm.
KeyOperationResult	Résultat de l’opération de clé.
KeySignParameters	Paramètres d’opérations clés.
KeyVaultError	Exception d’erreur du coffre de clés.

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

JsonWebKeySignatureAlgorithm

Identificateur de l’algorithme de signature/vérification. Pour plus d’informations sur les types d’algorithmes possibles, consultez JsonWebKeySignatureAlgorithm.

Nom	Type	Description
ES256	string	ECDSA utilisant P-256 et SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518.
ES256K	string	ECDSA utilisant P-256K et SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
ES384	string	ECDSA utilisant P-384 et SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
ES512	string	ECDSA utilisant P-521 et SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518
PS256	string	RSASSA-PSS utilisant SHA-256 et MGF1 avec SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
PS384	string	RSASSA-PSS utilisant SHA-384 et MGF1 avec SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
PS512	string	RSASSA-PSS utilisant SHA-512 et MGF1 avec SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518
RS256	string	RSASSA-PKCS1-v1_5 à l’aide de SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
RS384	string	RSASSA-PKCS1-v1_5 à l’aide de SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
RS512	string	RSASSA-PKCS1-v1_5 à l’aide de SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518
RSNULL	string	Réservé

KeyOperationResult

Résultat de l’opération de clé.

Nom	Type	Description
aad	string
iv	string
kid	string	Identificateur de clé
tag	string
value	string

KeySignParameters

Paramètres d’opérations clés.

Nom	Type	Description
alg	JsonWebKeySignatureAlgorithm	Identificateur de l’algorithme de signature/vérification. Pour plus d’informations sur les types d’algorithmes possibles, consultez JsonWebKeySignatureAlgorithm.
value	string

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.

Share via