MongoDB\Driver\ClientEncryption::createDataKey

Parâmetros

kmsProvider

O provedor KMS (por exemplo, "local", "aws") que será usado para criptografar a nova chave de dados.

options

Opções de chave de dados

Opção	Tipo	Descrição
masterKey	array	O documento masterKey identifica uma chave específica do KMS usada para criptografar a nova chave de dados. Esta opção é obrigatória, a menos que kmsProvider seja "local". Opções do provedor "aws" Opção Tipo Descrição region string Obrigatória. key string Obrigatória. O Nome de Recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da AWS. endpoint string Opcional. Um identificador de servidor alternativo para o qual enviar requisições KMS. Pode incluir o número da porta. Opções do provedor "azure" Opção Tipo Descrição keyVaultEndpoint string Obrigatória. Servidor com porta opcional (por exemplo, "example.vault.azure.net"). keyName string Obrigatória. keyVersion string Opcional. Uma versão específica da chave nomeada. O padrão é usar a versão primária da chave. Opções do provedor "gcp" Opção Tipo Descrição projectId string Obrigatória. location string Obrigatória. keyRing string Obrigatória. keyName string Obrigatória. keyVersion string Opcional. Uma versão específica da chave nomeada. O padrão é usar a versão primária da chave. endpoint string Opcional. Servidor com porta opcional. O padrão é "cloudkms.googleapis.com". Opções do provedor "kmip" Opção Tipo Descrição keyId string Opcional. Identificador único para um objeto gerenciado de dados secretos KMIP de 96 bytes. Se não especificado, o driver cria um objeto gerenciado de dados secretos KMIP aleatório de 96 bytes. endpoint string Opcional. Servidor com porta opcional. delegated bool Opcional. Se verdadeira, esta chave deve ser descriptografada pelo servidor KMIP.
keyAltNames	array	Uma lista opcional de nomes alternativos de string usados ​​para fazer referência a uma chave. Se uma chave for criada com nomes alternativos, a criptografia poderá referir-se à chave pelo nome alternativo exclusivo em vez de por _id.
keyMaterial	MongoDB\BSON\Binary	Um valor opcional de 96 bytes para usar como material de chave personalizado para a chave de dados que está sendo criada. Se keyMaterial for fornecido, o material de chave personalizado será usado para criptografar e descriptografar dados. Caso contrário, o material de chave para a nova chave de dados é gerado a partir de um dispositivo aleatório criptograficamente seguro.