你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

sign - sign

使用指定的键从摘要创建签名。
SIGN 操作适用于存储在 Azure 密钥保管库 中的非对称密钥,因为此操作使用密钥的专用部分。 此操作需要密钥/符号权限。

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/sign?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

JsonWebKeySignatureAlgorithm

签名/验证算法标识符。 有关可能的算法类型的详细信息,请参阅 JsonWebKeySignatureAlgorithm。

value True

string

响应

名称 类型 说明
200 OK

KeyOperationResult

签名值。

Other Status Codes

KeyVaultError

密钥保管库描述操作失败原因的错误响应。

示例

Sign

Sample Request

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

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

Sample Response

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

定义

名称 说明
Error

密钥保管库服务器错误。

JsonWebKeySignatureAlgorithm

签名/验证算法标识符。 有关可能的算法类型的详细信息,请参阅 JsonWebKeySignatureAlgorithm。

KeyOperationResult

键操作结果。

KeySignParameters

关键操作参数。

KeyVaultError

密钥保管库错误异常。

Error

密钥保管库服务器错误。

名称 类型 说明
code

string

错误代码。

innererror

Error

密钥保管库服务器错误。

message

string

错误消息。

JsonWebKeySignatureAlgorithm

签名/验证算法标识符。 有关可能的算法类型的详细信息,请参阅 JsonWebKeySignatureAlgorithm。

名称 类型 说明
ES256

string

使用 P-256 和 SHA-256 的 ECDSA,如 中所述 https://tools.ietf.org/html/rfc7518

ES256K

string

使用 P-256K 和 SHA-256 的 ECDSA,如 中所述 https://tools.ietf.org/html/rfc7518

ES384

string

使用 P-384 和 SHA-384 的 ECDSA,如 https://tools.ietf.org/html/rfc7518

ES512

string

使用 P-521 和 SHA-512 的 ECDSA,如 https://tools.ietf.org/html/rfc7518

PS256

string

将 SHA-256 和 MGF1 与 SHA-256 配合使用的 RSASSA-PSS,如 https://tools.ietf.org/html/rfc7518

PS384

string

将 SHA-384 和 MGF1 与 SHA-384 配合使用的 RSASSA-PSS,如 中所述 https://tools.ietf.org/html/rfc7518

PS512

string

将 SHA-512 和 MGF1 与 SHA-512 配合使用的 RSASSA-PSS,如 中所述 https://tools.ietf.org/html/rfc7518

RS256

string

RSASSA-PKCS1-v1_5 使用 SHA-256,如中所述 https://tools.ietf.org/html/rfc7518

RS384

string

RSASSA-PKCS1-v1_5 使用 SHA-384,如中所述 https://tools.ietf.org/html/rfc7518

RS512

string

RSASSA-PKCS1-v1_5 使用 SHA-512,如中所述 https://tools.ietf.org/html/rfc7518

RSNULL

string

预留

KeyOperationResult

键操作结果。

名称 类型 说明
aad

string

iv

string

kid

string

密钥标识符

tag

string

value

string

KeySignParameters

关键操作参数。

名称 类型 说明
alg

JsonWebKeySignatureAlgorithm

签名/验证算法标识符。 有关可能的算法类型的详细信息,请参阅 JsonWebKeySignatureAlgorithm。

value

string

KeyVaultError

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。