ClientEncryption.createEncryptedCollection() (método mongosh)

Nuevo en la versión 7.0.

ClientEncryption.createEncryptedCollection(dbName, collName, clientEncOpts): ClientEncryption.createEncryptedCollection crea una colección cifrada especificada por collName en la base de datos especificada por dbName.

Tip

En mongosh, puede utilizar la función auxiliar db.createEncryptedCollection(), que se ejecuta en el contexto de la base de datos actual y genera automáticamente claves de datos cuando no se especifican valores keyId.

Compatibilidad

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

MongoDB Atlas: El servicio totalmente administrado 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.createEncryptedCollection tiene la siguiente sintaxis:

clientEncryption = db.getMongo().getClientEncryption()
clientEncryption.createEncryptedCollection(
  dbName,
  collName,
  {
    provider: kmsProviderName,
    createCollectionOptions: encryptedFieldsMap,
    masterKey: customerMasterKeyCredentials
  }
)

Campos de comandos

createEncryptedCollection toma estos campos:

Campo	Tipo	Necesidad	Descripción
`dbName`	string	Requerido	Nombre de la base de datos que se desea cifrar.
`collName`	string	Requerido	Nombre de la colección a cifrar.
`clientEncOpts`	Documento	Requerido	Opciones para configurar la colección cifrada.
`clientEncOpts.provider`	string	Requerido	El KMS que usa para almacenar su clave maestra de cliente.
`clientEncOpts.createCollectionOptions`	Documento	Requerido	Campos a encriptar. Consulta Pasos para obtener detalles sobre cómo configurar el objeto `encryptedFieldsMap`.
`clientEncOpts.masterKey`	Documento	Opcional	Especifica las credenciales y los campos de identificación de clave necesarios para acceder a la clave principal cuando el proveedor KMS es AWS, GCP o Azure. Opcional cuando el proveedor de KMS sea `local`.

Comportamiento

Los métodos de cifrado a nivel de campo y consultables del lado del cliente mongosh requieren una conexión a la base de datos configurada para el cifrado del lado del cliente. Si la conexión actual a la base de datos no se inició con el cifrado a nivel de campo del lado del cliente habilitado, se producirá uno de los siguientes errores:

Utiliza el Mongo() constructor de la mongosh para establecer una conexión con las opciones necesarias de cifrado a nivel de campo en el lado del cliente. El método Mongo() admite los siguientes proveedores de Key Management Service (KMS) para la gestión de llaves maestras de cliente (llaves maestras de cliente):

Utilice las opciones de línea de comandos mongosh 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.

Ejemplo

El siguiente ejemplo utiliza un KMS gestionado de forma local para la configuración de Queryable Encryption.

Crea Tu Conexión Encriptada

Inicia mongosh
Ejecuta:
mongosh --nodb
--nodb significa no conectarse a una base de datos.
Generar un String
Genera una cadena base de 64 96bytes:
const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")
Crear un objeto de opciones de cifrado
Para crear un objeto de opciones de cifrado de nivel de campo del lado del cliente, utilice la string TEST_LOCAL_KEY del paso anterior:
var autoEncryptionOpts = { "keyVaultNamespace" : "encryption.__dataKeys", "kmsProviders" : { "local" : { "key" : BinData(0, TEST_LOCAL_KEY) } } }
Cree un objeto cliente cifrado
Para crear un objeto cliente cifrado, utiliza el constructor Mongo(). Reemplace el URI mongodb://myMongo.example.net por el URI de la cadena de conexión para el clúster de destino. Por ejemplo:
encryptedClient = Mongo( "mongodb://myMongo.example.net:27017/?replSetName=myMongo", autoEncryptionOpts )

Especificar qué campos encriptar

Crea un encryptedFieldsMaps para especificar qué campos quieres cifrar:

const encryptedFieldsMap = {
  encryptedFields: {
    fields: [
      {
        path: "secretField",
        bsonType: "string",
        queries: { queryType: "equality" },
      },
    ],
  },
};

Cree su colección cifrada

Crea una colección enc.users cifrada:

clientEncryption = encryptedClient.getClientEncryption();
let result = clientEncryption.createEncryptedCollection(
  "enc",
  "users",
  {
    provider: "local",
    createCollectionOptions: encryptedFieldsMap,
    masterKey: {} // masterKey is optional when provider is local
  }
)

Verifique su objeto resultado

createEncryptedCollection devuelve un objeto de resultado grande con muchos campos. Verifica el valor de result.collection para confirmar que la colección se haya creado en la ubicación deseada.

enc> result.collection
enc.users

Obtén más información

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().
Para un ejemplo completo de cómo crear y consultar una colección cifrada, consulta Queryable Encryption Quick Start.

Volver

SessionOptions

ClientEncryption.encrypt