O Alibaba Cloud SDK oferece suporte a operações de gerenciamento (criação de instâncias e chaves) e operações de negócios (criptografia, descriptografia e recuperação de segredos) para o KMS. As operações de gerenciamento usam apenas o gateway compartilhado, enquanto as operações de negócios aceitam gateways compartilhados e dedicados.
Visão geral de acesso
As operações de gerenciamento estão acessíveis apenas pelo gateway compartilhado. Já as operações de negócios podem ser acessadas tanto pelo gateway compartilhado quanto pelo dedicado.
Gateway compartilhado vs. dedicado
A tabela a seguir compara os gateways compartilhado e dedicado para as operações de negócios do KMS.
Item | Gateway compartilhado | Gateway dedicado | |
Rede | Rede pública ou rede VPC. | Rede privada do KMS. | |
Desempenho | As solicitações de API estão sujeitas a cotas por segundo. Exemplo: o QPS de criptografia e descriptografia é fixo em 1.000. | Não há cota por solicitação. As solicitações são processadas no modo de melhor esforço, utilizando todos os recursos de computação e armazenamento disponíveis. Selecione a capacidade de QPS ao comprar uma instância do KMS. | |
APIs suportadas | Todas as operações criptográficas e APIs de recuperação de segredos. | Todas as operações criptográficas e APIs de recuperação de segredos, exceto ReEncrypt. | |
Controle de acesso à rede | Aceita VPC ID (chave de condição: acs:SourceVpc) e endereços IP de VPC (chave de condição: acs:VpcSourceIp) para controle de acesso à rede. | Não aceita VPC ID (chave de condição: acs:SourceVpc) nem endereços IP de origem em uma VPC (chave de condição: acs:VpcSourceIp) para controle de acesso à rede. Entre em contato com o gerente da sua conta caso precise dessa funcionalidade. | |
Autorização | Com a autenticação STS, a autorização se aplica apenas a GetSecretValue, e não a Decrypt. Outros métodos de autenticação autorizam ambas as operações. | Tanto GetSecretValue quanto Decrypt são autorizados durante a recuperação de segredos. | |
Auditoria de logs | ActionTrail | Simple Log Service (SLS) | |
Configurações do SDK | Endpoint | Durante a inicialização do cliente, configure o shared gateway endpoint em um dos seguintes formatos:
| Durante a inicialização do cliente, configure o dedicated gateway endpoint no formato: |
Certificado de CA | Não é necessário. |
| |
APIs suportadas
As operações de gerenciamento usam apenas o gateway compartilhado. As operações de negócios aceitam gateways compartilhados e dedicados.
Operações de gerenciamento
Gerenciamento de service
|
API |
Título |
Descrição |
|
DescribeAccountKmsStatus |
Consulta o status do Key Management Service (KMS) na sua conta Alibaba Cloud. |
|
|
OpenKmsService |
Ativa o Key Management Service (KMS) para a sua conta Alibaba Cloud. |
Gerenciamento de instâncias
|
API |
Título |
Descrição |
|
DescribeAccountKmsStatus |
Consulta o status do Key Management Service (KMS) na sua conta Alibaba Cloud. |
|
|
OpenKmsService |
Ativa o Key Management Service (KMS) para a sua conta Alibaba Cloud. |
Gerenciamento de chaves
|
API |
Título |
Descrição |
|
CreateKey |
Cria uma chave mestra do cliente (CMK) para criptografia de envelope, assinaturas digitais ou outras operações criptográficas. |
|
|
ListKeys |
Consulta os IDs e ARNs de todas as CMKs na região atual. |
|
|
DescribeKey |
Consulta os metadados de uma CMK, como o estado da chave, o uso e a configuração de rotação. |
|
|
UpdateKeyDescription |
Atualiza a descrição de uma CMK. |
|
|
EnableKey |
Ativa uma chave para criptografar e descriptografar dados. |
|
|
DisableKey |
Desativa uma chave. |
|
|
CreateAlias |
Cria um alias para uma chave. |
|
|
ListAliases |
Consulta todos os alias na região atual para a conta atual. |
|
|
ListAliasesByKeyId |
Consulta todos os alias vinculados a uma chave. |
|
|
DeleteAlias |
Exclui um alias. |
|
|
UpdateAlias |
Vincula um alias existente a um ID de chave mestra do cliente (CMK) diferente. |
|
|
GetParametersForImport |
Consulta os parâmetros usados para importar material de chave para uma chave mestra do cliente (CMK). |
|
|
ImportKeyMaterial |
Importa material de chave gerado externamente para uma CMK cuja source é EXTERNAL. |
|
|
DeleteKeyMaterial |
Exclui o material de chave importado de uma CMK. Após a exclusão, a CMK entra no estado PendingImport até que você reimporte o material da chave. |
|
|
ScheduleKeyDeletion |
Exclui uma chave mestra do cliente (CMK) especificada. |
|
|
CancelKeyDeletion |
Cancela a tarefa de exclusão de uma CMK. |
|
|
SetDeletionProtection |
Ativa ou desativa a proteção contra exclusão para uma chave mestra do cliente (CMK). |
|
|
UpdateRotationPolicy |
Atualiza a política de rotação automática de uma CMK. |
|
|
DescribeKeyVersion |
Consulta os metadados de uma versão específica da CMK. |
|
|
CreateKeyVersion |
Cria uma versão para uma chave mestra do cliente (CMK). |
|
|
ListKeyVersions |
Consulta todas as versões de uma CMK especificada. |
|
|
SetKeyPolicy |
Define a política de chave para uma CMK em uma instância do KMS. |
|
|
GetKeyPolicy |
Consulta a política de chave de uma CMK em uma instância do KMS. |
Gerenciamento de segredos
|
API |
Título |
Descrição |
|
ListSecrets |
Consulta todos os segredos na região atual. |
|
|
DeleteSecret |
Exclui um segredo. |
|
|
CreateSecret |
Cria um segredo e armazena sua versão inicial. |
|
|
UpdateSecret |
Atualiza os metadados de um segredo. |
|
|
UpdateSecretVersionStage |
Move um rótulo de estágio de versão para uma versão diferente de um segredo. |
|
|
UpdateSecretRotationPolicy |
Atualiza a política de rotação de um segredo. |
|
|
DescribeSecret |
Consulta os metadados de um segredo. |
|
|
ListSecretVersionIds |
Consulta todos os IDs de versão e rótulos de estágio de um segredo especificado. |
|
|
GetRandomPassword |
Gera uma string de senha aleatória. |
|
|
PutSecretValue |
Armazena uma nova versão de um valor de segredo para um segredo genérico. |
|
|
RestoreSecret |
Restaura um segredo excluído. |
|
|
RotateSecret |
Rotaciona um segredo imediatamente. |
|
|
SetSecretPolicy |
Define a política de acesso para um segredo em uma instância do KMS. |
|
|
GetSecretPolicy |
Consulta a política de acesso de um segredo especificado em uma instância do KMS. |
Gerenciamento de tags
|
API |
Título |
Descrição |
|
UntagResources |
Remove tags de chaves ou segredos. |
|
|
TagResources |
Adiciona tags a uma ou mais chaves ou segredos. |
|
|
ListTagResources |
Lista as tags vinculadas a uma chave ou segredo. |
|
|
GetKmsInstanceQuotaInfos |
Consulta o uso de cota e os limites de uma instância do KMS. |
|
|
ListResourceTags |
Consulta as tags de uma chave mestra do cliente (CMK). |
|
|
TagResource |
Adiciona tags a uma CMK, segredo ou certificado. |
|
|
UntagResource |
Remove tags de uma CMK, segredo ou certificado. |
Gerenciamento de aplicativos
|
API |
Título |
Descrição |
|
CreateNetworkRule |
Cria uma regra de acesso à rede para configurar os endereços IP privados ou blocos CIDR privados com permissão para acessar uma instância do Key Management Service (KMS). |
|
|
ListNetworkRules |
Consulta todas as regras de acesso à rede na região atual. |
|
|
DescribeNetworkRule |
Obtém os detalhes de uma regra de acesso à rede. |
|
|
UpdateNetworkRule |
Atualiza uma regra de acesso à rede. |
|
|
DeleteNetworkRule |
Exclui uma regra de acesso à rede. |
|
|
CreatePolicy |
Cria uma política de permissão para configurar as chaves e os segredos com permissão de acesso. |
|
|
ListPolicies |
Consulta todas as políticas de permissão na região atual. |
|
|
DescribePolicy |
Obtém os detalhes de uma política de permissão. |
|
|
UpdatePolicy |
Atualiza uma política de permissão. |
|
|
DeletePolicy |
Exclui uma política de permissão. |
|
|
CreateApplicationAccessPoint |
Cria um ponto de acesso de aplicativo (AAP). |
|
|
ListApplicationAccessPoints |
Consulta todos os pontos de acesso de aplicativo (AAPs) na região atual. |
|
|
DescribeApplicationAccessPoint |
Obtém os detalhes de um ponto de acesso de aplicativo (AAP). |
|
|
UpdateApplicationAccessPoint |
Atualiza as informações de um ponto de acesso de aplicativo (AAP). |
|
|
DeleteApplicationAccessPoint |
Exclui um ponto de acesso de aplicativo (AAP). |
|
|
CreateClientKey |
Cria uma chave de cliente. |
|
|
ListClientKeys |
Consulta todas as chaves de cliente em um AAP. |
|
|
GetClientKey |
Obtém informações sobre uma chave de cliente. |
|
|
DeleteClientKey |
Exclui uma chave de cliente. |
Operações de negócios-Operações criptográficas
Para executar operações criptográficas pelo gateway compartilhado, você deve primeiro ative o acesso público.
|
API |
Descrição |
Gateway compartilhado |
Gateway dedicado |
|
Gera uma chave de dados aleatória para criptografia de envelope. A chave de dados é retornada nos formatos de texto simples e texto cifrado. |
|
|
|
|
Gera uma chave de dados aleatória, criptografa-a usando uma CMK e uma chave pública (especifique a chave desejada) e retorna ambos os textos cifrados. |
|
|
|
|
Criptografa texto simples usando uma CMK simétrica. |
|
|
|
|
Descriptografa texto cifrado que foi criptografado usando uma CMK. |
|
|
|
|
Criptografa novamente o texto cifrado sob uma CMK diferente sem expor o texto simples. |
|
|
|
|
Exporta uma chave de dados criptografada por uma CMK. A chave de dados é criptografada novamente por uma chave pública especificada por você para transmissão segura. |
|
|
|
|
Gera uma chave de dados aleatória apenas no formato de texto cifrado, sem a cópia em texto simples. |
|
|
|
|
Gera uma assinatura digital usando uma CMK assimétrica. |
|
|
|
|
Verifique uma assinatura digital usando a chave pública de uma CMK assimétrica. |
|
|
|
|
Criptografa dados usando a chave pública de uma CMK assimétrica. |
|
|
|
|
Descriptografa dados usando a chave privada de uma CMK assimétrica. |
|
|
|
|
Obtém a chave pública de uma chave assimétrica. Você pode usar a chave pública para criptografar dados ou verificar uma assinatura no seu dispositivo. |
|
|
Operações de negócios-Recuperação de valores de segredos
|
API |
Descrição |
Gateway compartilhado |
Gateway dedicado |
|
Recupera um valor de segredo. |
|
|
Linguagens de programação suportadas
A tabela a seguir lista os links para que você baixe o SDK e a documentação de cada linguagem suportada.