AsymmetricEncrypt - Key Management Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Precauções

Para obter detalhes sobre a política de acesso que deve ser concedida a um usuário do Resource Access Management (RAM) ou a uma função do RAM para invocar esta operação de API, consulte Controle de acesso.
Você pode invocar esta operação de API usando um gateway compartilhado ou um gateway dedicado. Para obter detalhes, consulte Alibaba Cloud SDK.
- Gateway compartilhado: Acesse o KMS por meio de acesso à rede pública ou um nome de domínio de VPC. Para usar este método, você deve ativar a opção de acesso à rede pública. Para operações específicas, consulte Acessar chaves em uma instância do KMS por meio de acesso à rede pública.
- Gateway dedicado: Acesse o KMS usando o endpoint privado do KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

Limites de QPS

Gateway compartilhado: O limite de QPS por usuário para esta operação de API é 200. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Faça chamadas de API em uma taxa razoável.
Gateway dedicado: O limite de QPS por usuário para esta operação de API depende das especificações de desempenho de computação da sua instância do KMS. Para mais informações, consulte Dados de desempenho.

Descrição da operação

Somente chaves assimétricas cujo Uso está definido como ENCRYPT/DECRYPT são suportadas. A tabela a seguir descreve os algoritmos de criptografia suportados.

KeySpec	Algoritmo	Descrição	Número máximo de bytes que podem ser criptografados
RSA_2048	RSAES_OAEP_SHA_256	RSAES-OAEP usando SHA-256 e MGF1 com SHA-256	190
RSA_2048	RSAES_OAEP_SHA_1	RSAES-OAEP usando SHA1 e MGF1 com SHA1	214
RSA_3072	RSAES_OAEP_SHA_256	RSAES-OAEP usando SHA-256 e MGF1 com SHA-256	318
RSA_3072	RSAES_OAEP_SHA_1	RSAES-OAEP usando SHA1 e MGF1 com SHA1	342
EC_SM2	SM2PKE	Algoritmo de criptografia de chave pública de curva elíptica SM2	6047

O exemplo a seguir mostra como usar o algoritmo de criptografia RSAES_OAEP_SHA_1 para criptografar o texto simples SGVsbG8gd29ybGQ= usando uma chave assimétrica cujo ID da chave é key-hzz630494463ejqjx**** e o ID da versão da chave é 2ab1a983-7072-4bbc-a582-584b5bd8****.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

kms:AsymmetricEncrypt

get

*Chave.

acs:kms:{#regionId}:{#accountId}:key/{#KeyId}

kms:tag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Plaintext	string	Sim	O texto simples a ser criptografado. O texto simples deve ser codificado em Base64.	SGVsbG8gd29ybGQ=
KeyId	string	Sim	O ID da chave. Você também pode especificar o alias ou o Nome do Recurso do Alibaba Cloud (ARN) da chave. Para mais informações sobre aliases, consulte Gerenciar aliases de chave. Nota Para acessar uma chave que pertence a outra conta do Alibaba Cloud, você deve inserir o ARN da chave. O ARN de uma chave está no formato `acs:kms:${region}:${account}:key/${keyid}`.	key-hzz630494463ejqjx****
KeyVersionId	string	Sim	O ID da versão da chave. O identificador globalmente exclusivo da versão da chave. Nota Você pode chamar a operação ListKeyVersions para obter o ID da versão da chave.	2ab1a983-7072-4bbc-a582-584b5bd8****
Algorithm	string	Sim	O algoritmo de criptografia.	RSAES_OAEP_SHA_1
DryRun	string	Não	Especifica se o modo dry run deve ser ativado. Valores válidos: true: ativa o modo dry run. false: desativa o modo dry run. Este é o valor padrão. O modo dry run é usado para testar chamadas de API e verificar se você tem as permissões necessárias nos recursos e se os parâmetros da solicitação estão configurados corretamente. Quando o modo dry run está ativado, o KMS sempre retorna uma falha e fornece a causa da falha. As causas incluem: DryRunOperationError: A solicitação seria bem-sucedida se o parâmetro DryRun não estivesse configurado. ValidationError: Um parâmetro especificado na solicitação é inválido. AccessDeniedError: Você não tem permissões para realizar a operação no recurso do KMS.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
KeyVersionId	string	O número da versão da chave mestra usada para criptografar o texto simples.	2ab1a983-7072-4bbc-a582-584b5bd8****
KeyId	string	O ID da chave. Se o parâmetro KeyId na solicitação estiver definido como o alias ou o ARN da chave, o ID da chave também será retornado na resposta.	key-hzz630494463ejqjx****
CiphertextBlob	string	O texto criptografado gerado após a criptografia. O texto criptografado é codificado em Base64.	BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==
RequestId	string	O ID da solicitação. O ID é um identificador exclusivo gerado pelo Alibaba Cloud para a solicitação e pode ser usado para solucionar problemas.	475f1620-b9d3-4d35-b5c6-3fbdd941423d

Exemplos

Resposta de sucesso

JSON formato

{
  "KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Rejected.UnsupportedOperation	Unsupported operation.
404	Forbidden.AliasNotFound	The specified Alias is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.