MongoDB\Driver\ClientEncryption::createDataKey

Parámetros

kmsProvider

El proveedor KMS (por ejemplo "local", "aws") que se utilizará para cifrar el nuevo documento clave.

options

Opciones de datos de clave

Opción	Tipo	Descripción
masterKey	array	El documento masterKey identifica una clave específica de KMS utilizada para cifrar el nuevo documento clave. Esta opción es requerida a menos que kmsProvider sea "local". Opciones del proveedor "aws" Opción Tipo Descripción region string Requis. key string Requis. El nombre de recurso Amazon (ARN) de la clave maestra del cliente AWS (CMK). endpoint string Opcional. Un identificador de host alternativo para enviar las solicitudes KMS. Puede incluir el número de puerto. Opciones del proveedor "azure" Opción Tipo Descripción keyVaultEndpoint string Requis. Host con puerto opcional (por ejemplo, "example.vault.azure.net"). keyName string Requis. keyVersion string Opcional. Una versión específica de la clave nombrada. Por omisión, se utiliza la versión primaria de la clave. Opciones del proveedor "gcp" Opción Tipo Descripción projectId string Requis. location string Requis. keyRing string Requis. keyName string Requis. keyVersion string Opcional. Una versión específica de la clave nombrada. Por omisión, se utiliza la versión primaria de la clave. endpoint string Opcional. Host con puerto opcional. El valor por omisión es "cloudkms.googleapis.com". Opciones del proveedor "kmip" Opción Tipo Descripción keyId string Opcional. Identificador único de un objeto gestionado de 96 bytes de datos secretos KMIP. Si no se especifica, el controlador crea un objeto gestionado aleatorio de 96 bytes de datos secretos KMIP. endpoint string Opcional. Host con puerto opcional. delegated bool Opcional. Si es verdadero, esta clave debe ser descifrada por el servidor KMIP.
keyAltNames	array	Una lista opcional de nombres alternativos de string utilizados para referenciar una clave. Si una clave se crea con nombres alternativos, entonces el cifrado puede referirse a la clave por el nombre alternativo único en lugar de por _id.
keyMaterial	MongoDB\BSON\Binary	Un valor opcional de 96 bytes a utilizar como material de clave para el documento clave en curso de creación. Si keyMaterial es dado, el material de clave personalizado se utiliza para cifrar y descifrar los datos. De lo contrario, el material de clave para el nuevo documento clave es generado a partir de un dispositivo aleatorio criptográficamente seguro.