Documentación offline PHP master
/

MongoDB\Driver\ClientEncryption::__construct

master Ver versión oficial en línea Licencia CC-BY-3.0Descargado el 2026-08-02

En esta página

MongoDB\Driver\ClientEncryption::__construct

Crea un nuevo objeto ClientEncryption

Descripción#

php final public MongoDB\Driver\ClientEncryption::__construct(array $options)php

Construye un nuevo objeto MongoDB\Driver\ClientEncryption con las opciones especificadas.

Parámetros#

options

options
Opción Tipo Descripción
keyVaultClient MongoDB\Driver\Manager El gestor utilizado para enrutar las consultas de claves de datos. Esta opción es obligatoria (a diferencia de MongoDB\Driver\Manager::createClientEncryption).
keyVaultNamespace string Un nombre de espacio completamente calificado (por ejemplo "databaseName.collectionName") denotando la colección que contiene todas las claves de datos utilizadas para el cifrado y descifrado. Esta opción es requerida.
kmsProviders array

Un documento que contiene la configuración de uno o más proveedores KMS, que se utilizan para cifrar claves de datos. Los proveedores admitidos incluyen "aws", "azure", "gcp", "kmip" y "local", y se debe especificar al menos uno.

Si se especifica un documento vacío para "aws", "azure" o "gcp", el controlador intentará configurar el proveedor utilizando Automatic Credentials.

El formato para "aws" es el siguiente:

aws: {
    accessKeyId: <string>,
    secretAccessKey: <string>,
    sessionToken: <optional string>
}

El formato para "azure" es el siguiente:

azure: {
    tenantId: <string>,
    clientId: <string>,
    clientSecret: <string>,
    identityPlatformEndpoint: <optional string> // Defaults to "login.microsoftonline.com"
}

El formato para "gcp" es el siguiente:

gcp: {
    email: <string>,
    privateKey: <base64 string>|<MongoDB\BSON\Binary>,
    endpoint: <optional string> // Defaults to "oauth2.googleapis.com"
}

El formato para "kmip" es el siguiente:

kmip: {
    endpoint: <string>
}

El formato para "local" es el siguiente:

local: {
    // 96-byte master key used to encrypt/decrypt data keys
    key: <base64 string>|<MongoDB\BSON\Binary>
}
tlsOptions array

Un documento que contiene la configuración TLS de uno o varios proveedores KMS. Los proveedores soportados son "aws", "azure", "gcp" y "kmip". Todos los proveedores soportan las siguientes opciones:

<provider>: {
    tlsCaFile: <optional string>,
    tlsCertificateKeyFile: <optional string>,
    tlsCertificateKeyFilePassword: <optional string>,
    tlsDisableOCSPEndpointCheck: <optional bool>
}

Errores/Excepciones#

Lanza una excepción

MongoDB\Driver\Exception\InvalidArgumentException

en caso de error durante el análisis de un argumento.

Lanza

MongoDB\Driver\Exception\RuntimeException

si la extensión fue compilada sin soporte para libmongocrypt

Historial de cambios#

Versión Descripción
PECL mongodb 1.16.0

El proveedor de KMS de AWS para la cifrado lado-cliente ahora acepta una opción "sessionToken", que puede usarse para autenticarse con credenciales temporales de AWS.

Se añadió "tlsDisableOCSPEndpointCheck" a la opción "tlsOptions".

Si se especifica un documento vacío para el proveedor de KMS de "azure" o "gcp", el controlador intentará configurar el proveedor usando Credenciales Automáticas.
PECL mongodb 1.15.0

Si se especifica un documento vacío para el proveedor de KMS de "aws", el controlador intentará configurar el proveedor usando Credenciales Automáticas.

Véase también#

MongoDB\Driver\Manager::createClientEncryption

Cifrado Explícito (Manual) de Nivel de Campo del Lado del Cliente

en el manual de MongoDB