MongoDB\Driver\ClientEncryption::createDataKey

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::createDataKeyCrear un documento clave

Descripción

final public MongoDB\Driver\ClientEncryption::createDataKey(string $kmsProvider, ?array $options = null): MongoDB\BSON\Binary

Crear un nuevo documento clave e insertarlo en la colección de claves.

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".

"aws" provider options
Option Type Description
region string Required.
key string Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK).
endpoint string Optional. An alternate host identifier to send KMS requests to. May include port number.

"azure" provider options
Option Type Description
keyVaultEndpoint string Required. Host with optional port (e.g. "example.vault.azure.net").
keyName string Required.
keyVersion string Optional. A specific version of the named key. Defaults to using the key's primary version.

"gcp" provider options
Option Type Description
projectId string Required.
location string Required.
keyRing string Required.
keyName string Required.
keyVersion string Optional. A specific version of the named key. Defaults to using the key's primary version.
endpoint string Optional. Host with optional port. Defaults to "cloudkms.googleapis.com".

"kmip" provider options
Option Type Description
keyId string Optional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object.
endpoint string Optional. Host with optional port.
delegated bool Optional. If true, this key should be decrypted by the KMIP server.

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.

Valores devueltos

Devuelve un identificador del nuevo documento clave como un objeto MongoDB\BSON\Binary con el subtipo 4 (UUID).

Errores/Excepciones

Historial de cambios

Versión Descripción
PECL mongodb 1.20.0 Adición de "delegated" a las opciones masterKey del proveedor KMIP.
PECL mongodb 1.15.0 Adición de la opción "keyMaterial".
PECL mongodb 1.10.0 Azure y GCP son ahora soportados como proveedores KMS para el cifrado lado-cliente.

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top