ClientEncryption.encrypt()

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 5.0, consulte Procedimientos de actualización de MongoDB.6.0

ClientEncryption.encrypt(encryptionKeyId, value, encryptionAlgorithm)

ClientEncryption.encrypt() cifra el value utilizando los encryptionKeyId y encryptionAlgorithm especificados. admite el cifrado explícito (manual) de valores deencrypt() campo.

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 `value`. El UUID es un `binary data` objeto BSON 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.Consulte Almacén de claves de cifrado para obtener más información sobre los almacenes de claves y las claves de cifrado de datos.
`value`	Consulte Tipos BSON no admitidos.	El valor a cifrar.
`encryptionAlgorithm`	string	El algoritmo de cifrado que se utilizará para cifrar `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 Mongo() constructor del mongo shell para establecer una conexión con las opciones de cifrado de campo requeridas del lado del cliente. El método admite los siguientes proveedores de Servicios de Gestión de Claves (KMS) para la gestión de Mongo() la Clave Maestra del Cliente (CMK):
or
Utilice las opciones de línea mongo de comandos del shell para establecer una conexión con las opciones requeridas. Estas opciones solo son compatibles con el proveedor KMS de Amazon Web Services para la gestión de CMK.

Tipos BSON no compatibles

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

minKey
maxKey
null
undefined

Si se cifra un campo utilizando,AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic encrypt() no admite los siguientes tipos BSON:

double
decimal128
bool
object
array

Ejemplo

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

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

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)
    }
  }
}

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

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

Recupere el ClientEncryption objeto y utilice el método para cifrar un valor utilizando una ClientEncryption.encrypt() clave UUID de cifrado de datos específica y un 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"
)

Siencrypt() tiene éxito, devuelve el valor cifrado:

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

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

Volver

Encriptación a nivel de campo

ClientEncryption.decrypt