Mensagem de assinatura
Função
Essa API permite que você crie uma assinatura digital para uma mensagem ou resumo de mensagem usando a chave privada em uma CMK assimétrica.
Restrições
- Suporta apenas chaves assimétricas com key_usage de SIGN_VERIFY para operação de assinatura.
URI
POST /v1.0/{project_id}/kms/sign
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta). |
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
key_id |
Sim |
String |
ID da chave. Deve ter 36 bytes e corresponder à expressão regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Exemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f |
message |
Sim |
String |
Especifica a mensagem ou o resumo da mensagem a assinar. As mensagens podem ser 0-4096 bytes. Para assinar uma mensagem maior, forneça o resumo da mensagem, usando o objeto de dados binários codificado em Base64. |
signing_algorithm |
Sim |
String |
Especifica o algoritmo de assinatura a ser usado ao assinar a mensagem. Escolha um algoritmo que seja compatível com o tipo da CMK assimétrica especificada.Pode ser:
|
message_type |
Não |
String |
Tipo de mensagem. O valor padrão é "DIGEST". Pode ser:
|
sequence |
Não |
String |
Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
key_id |
String |
ID de CMK. |
signature |
String |
A assinatura criptográfica que foi gerada para a mensagem. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Object |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Informação de erro. |
Código de status: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Object |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Informação de erro. |
Código de status: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Object |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Informação de erro. |
Exemplo de solicitações
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "signing_algorithm" : "RSASSA_PKCS1_V1_5_SHA_256", "message" : "MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw==" }
Exemplo de respostas
Código de status: 200
Processamento da solicitação bem-sucedido.
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "signature" : "jFUqQESGBc0j6k9BozzrP9YL4qk8/W9DZRvK6XXX..." }
Código de status: 400
Parâmetros de solicitação inválidos.
{ "error" : { "error_code" : "KMS.XXX", "error_msg" : "XXX" } }
Código de status: 403
Autenticação falhou.
{ "error" : { "error_code" : "KMS.XXX", "error_msg" : "XXX" } }
Código de status: 404
O recurso solicitado não existe ou não foi encontrado.
{ "error" : { "error_code" : "KMS.XXX", "error_msg" : "XXX" } }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Processamento da solicitação bem-sucedido. |
400 |
Parâmetros de solicitação inválidos. |
403 |
Autenticação falhou. |
404 |
O recurso solicitado não existe ou não foi encontrado. |
Códigos de erro
Consulte Códigos de erro.