ClientEncryption.encrypt()

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 5.0, consulta el Procedimientos de actualización de MongoDB.6.0

ClientEncryption.encrypt(encryptionKeyId, value, encryptionAlgorithm)

ClientEncryption.encrypt() cifra el value usando el encryptionKeyId y el encryptionAlgorithm especificados. encrypt() permite el cifrado explícito (manual) de los valores de los campos.

Devuelve:	A `binary data` objeto con subtipo 6.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

clientEncryption = db.getMongo().getClientEncryption()
clientEncryption.encrypt(
  encryptionKeyId,
  value,
  encryptionAlgorithm
)

Parameter	Tipo	Descripción
`encryptionKeyId`	`UUID`	La clave de cifrado de datos que se utilizará para cifrar el `value`. La UUID es un objeto BSON `binary data` con subtipo `4` que identifica una clave de cifrado de datos específica. Si la clave de cifrado de datos no existe en el almacén de claves configurado para la conexión a la base de datos, `encrypt()` devuelve un error. Consulta Encryption Key Vault para obtener más información sobre depósitos de llaves y llaves de cifrado de datos.
`value`	Ver Tipos BSON no compatibles.	El valor a cifrar.
`encryptionAlgorithm`	string	El algoritmo de cifrado que se debe utilizar para cifrar el `value`. `AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic` `AEAD_AES_256_CBC_HMAC_SHA_512-Random` Para obtener documentación completa sobre los algoritmos de cifrado compatibles, consulte Algoritmos de cifrado.

Comportamiento

Habilitar el cifrado a nivel de campo del lado del cliente en la conexión a la base de datos

Los métodos de cifrado de campo del lado del cliente requieren una conexión a la base de datos con el cifrado de campo del lado del cliente habilitado. Si la conexión actual a la base de datos no se inició con el cifrado de campo del lado del cliente habilitado, puede ocurrir lo mongo siguiente:

Utilice el constructor Mongo() desde la mongo shell para establecer una conexión con las opciones de cifrado a nivel de campo del lado del cliente requeridas. El método Mongo() admite los siguientes proveedores de Key Management Service (KMS) para la gestión de la llave maestra de cliente (llave maestra de cliente):
or
Utiliza las mongo opciones de línea de comandos del shell para establecer una conexión con las opciones requeridas. Las opciones de línea de comandos solo son compatibles con el proveedor de Amazon Web Services KMS para la gestión de llave maestra de cliente.

BSON types no admitidos

encrypt() no admite el cifrado de valores con los siguientes tipos BSON:

minKey
maxKey
null
undefined

Si se encripta un campo utilizando AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic, encrypt() no es compatible con los siguientes tipos BSON:

double
decimal128
bool
object
array

Ejemplo

El siguiente ejemplo utiliza un KMS gestionado localmente para la configuración de cifrado a nivel de campo en el lado del cliente.

Para configurar el cifrado a nivel de campo del lado del cliente para una clave administrada localmente, se requiere especificar una cadena de 96 bytes codificada en base64 sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos indicados y la carga en el shell:mongo

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

Cree el objeto de cifrado a nivel de campo lado del cliente mediante el string de clave local generado:

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.__dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0, TEST_LOCAL_KEY)
    }
  }
}

Usa el constructor Mongo() para crear una conexión a la base de datos con las opciones de cifrado de nivel de campo del lado del cliente. Sustituye el URI de mongodb://myMongo.example.net por el URI de cadena de conexión del clúster de destino.

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
  ClientSideFieldLevelEncryptionOptions
)

Recupere el objeto ClientEncryption y use el método ClientEncryption.encrypt() para cifrar un valor usando una llave de cifrado de datos UUID y el algoritmo de cifrado:

clientEncryption = encryptedClient.getClientEncryption();
clientEncryption.encrypt(
  UUID("64e2d87d-f168-493c-bbdf-a394535a2cb9"),
  "123-45-6789",
  "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
)

Si tiene éxito, encrypt() devuelve el valor cifrado:

BinData(6,"AmTi2H3xaEk8u9+jlFNaLLkC3Q/+kmwDbbWrq+h9nuv9W+u7A5a0UnpULBNZH+Q21fAztPpU09wpKPrju9dKfpN1Afpj1/ZhFcH6LYZOWSBBOAuUNjPLxMNSYOOuITuuYWo=")

Para obtener la documentación completa sobre cómo iniciar conexiones MongoDB con el cifrado a nivel de campo en el lado del cliente activado, consulte Mongo().

Volver

Encriptación a nivel de campo

ClientEncryption.decrypt