Global Modules

Devuelve

Retorna una string JSON Web Token codificada para el payload proporcionado.

Considere el siguiente objeto de claims JWT:

{
  "sub": "1234567890",
  "name": "Joe Example",
  "iat": 1565721223187
}

Podemos codificar el objeto de reclamaciones como una cadena JWT llamando a utils.jwt.encode(). La siguiente función codifica el JWT utilizando el método de firma HS512 y el secreto "SuperSecret":

exports = function() {
  const signingMethod = "HS512";
  const payload = {
    "sub": "1234567890",
    "name": "Joe Example",
    "iat": 1565721223187
  };
  const secret = "SuperSecret";
  return utils.jwt.encode(signingMethod, payload, secret);
}

"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvZSBTY2htb2UiLCJpYXQiOjE1NjU3MjEyMjMxODd9.-QL15ldu2BYuJokNWT6YRiwZQIiIpvq6Kyv-C6qslNdNiUVxo8zqLJZ1iEkNf2yZKMIrQuMCtIC1tzd2H31AxA"

Devuelve

Si returnHeader es false, devuelve la carga de EJSON decodificada.

Si returnHeader es true, devuelve un objeto que contiene la cabecera JOSE en el campo header y la carga útil decodificada en formato EJSON en el campo payload.

{
  "header": {
    "<JOSE Header Field>": <JOSE Header Value>,
    ...
  },
  "payload": {
    "<JWT Claim Field>": <JWT Claim Value>,
    ...
  }
}

Considera la siguiente JWT firmada string:

"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvZSBTY2htb2UiLCJpYXQiOjE1NjU3MjEyMjMxODd9.-QL15ldu2BYuJokNWT6YRiwZQIiIpvq6Kyv-C6qslNdNiUVxo8zqLJZ1iEkNf2yZKMIrQuMCtIC1tzd2H31AxA"

El JWT se firmó utilizando el método de firma HS512 con el valor secreto "SuperSecret". Podemos decodificar el objeto de claims utils.jwt.decode() del JWT. La siguiente función decodifica la JWT string en un objeto EJSON:

exports = function(jwtString) {
  const key = "SuperSecret";
  return utils.jwt.decode(jwtString, key, false, ["HS512"]);
}

{
  "sub": "1234567890",
  "name": "Joe Example",
  "iat": { "$numberDouble": 1565721223187 }
}

Devuelve

Un BSON Binario objeto que contiene la string cifrada con el tipo de cifrado especificado y la clave.

Assume that we have defined a value named aesEncryptionKey that contains the following 32-byte AES encryption key:

"603082712271C525E087BD999A4E0738"

Con esta clave AES, podemos cifrar un mensaje en una string base64 utilizando la siguiente función:

exports = function() {
  const message = "MongoDB is great!"
  const key = context.values.get("aesEncryptionKey");
  const encryptedMessage = utils.crypto.encrypt("aes", message, key);
  return encryptedMessage.toBase64();
}

"WPBuIvJ6Bity43Uh822dW8QlVYVJaFUiDeUjlTiJXzptUuTYIKPlXekBQAJb"

Devuelve

Un objeto BSON Binario que contiene el mensaje descifrado.

Si el mensaje cifrado proporcionado se cifró con el método y clave especificados, entonces el mensaje descifrado es idéntico al mensaje original.

Supongamos que hemos definido un Value llamado aesEncryptionKey que contiene la siguiente llave de cifrado AES de 32bytes:

"603082712271C525E087BD999A4E0738"

Podemos usar esta clave AES para descifrar cualquier cadena base64 que haya sido cifrada con la misma clave utilizando la siguiente función:

exports = function(encryptedMessage) {
  // The encrypted message must be a BSON.Binary
  if(typeof encryptedMessage === "string") {
    encryptedMessage = BSON.Binary.fromBase64(encryptedMessage)
  }
  const key = context.values.get("aesEncryptionKey");
  const decryptedMessage = utils.crypto.decrypt("aes", encryptedMessage, key);
  return decryptedMessage.text();
}

"MongoDB is great!"

Devuelve

Un BSON.Binary firma criptográfica para el mensaje firmado usando la llave privada especificada.

Supongamos que hemos definido un valor llamado rsaPrivateKey que contiene la siguiente llave privada RSA:

-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQDVsEjse2qO4v3p8RM/q8Rqzloc1lee34yoYuKZ2cemuUu8Jpc7
KFO1+aJpXdbSPZNhGLdANn8f2oMIZ1R9hgEJRn/Qm/YyC4RPTGg55nzHqSlziNZJ
JAyEUyU7kx5+Kb6ktgojhk8ocZRkorM8FEylkrKzgSrfay0PcWHPsKlmeQIDAQAB
AoGAHlVK1L7kLmpMbuP4voYMeLjYE9XdVEEZf2GiFwLSE3mkJY44033y/Bb2lgxr
DScOf675fFUAEK59ATlhxfu6s6rgx+g9qQQ+mL74YZWPqiZHBPjyMRaBalDVC4QF
YJ+DopFcB8hY2ElXnbK70ALmVYNjw3RdmC97h0YfOsQcWW0CQQD18aeuPNicVnse
Ku22vvhvQYlabaQh4xdkEIxz1TthZj48f61wZwEMipYqOAc5XEtDlNnxgeipv0yF
RHstUjwXAkEA3m0Br/U/vC9evuXppWbONana08KLgfELyd3Uw9jG7VKJZTBH5mS8
7CB68aEF8egrJpo8Ss8BkWrvCxYDb4Y77wJAUlbOMZozVtvpKidrIFR9Lho91uWA
Hsw9h4W20AzibXBig7SnJ0uE4WMAdS/+0yhgFkceVCmO8E2YW8Gaj4jJjwJASxtg
AHy+ItuUEL4uIW4Pn8tVW0BMP3qX0niXyfI/ag/+2S5uePv3V3y4RzNqgH83Yved
+FziWKpVQdcTHeuj/QJBAJl1G3WFruk0llIoKKbKljaEiCm1WCTcuEPbdOtkJYvO
9ZYQg/fji70FERkq2KHtY7aLhCHzy0d4n9xgE/pjV+I=
-----END RSA PRIVATE KEY-----

Con esta clave RSA, podemos firmar un mensaje usando la siguiente función:

exports = function() {
  const message = "MongoDB is great!"
  const rsaPrivateKey = context.values.get("rsaPrivateKey");
  const signature = utils.crypto.sign("rsa", message, rsaPrivateKey, "pss");
  return signature.toBase64();
}

"SpfXcJwPbypArt+XuYQyuZqU52YCAY/sZj2kiuin2b6/RzyM4Ek3n3spOtqZJqxn1tfQavxIX4V+prbs74/pOaQkCLekl9Hoa1xOzSKcGoRd8U+n1+UBY3d3cyODGMpyr8Tim2HZAeLPE/D3Q36/K+jpgjvrJFXsJoAy5/PV7iEGV1fkzogmZtXWDcUUBBTTNPY4qZTzjNhL4RAFOc7Mfci+ojE/lLsNaumUVU1/Eky4vasmyjqunm+ULCcRmgWtGDMGHaQV4OXC2LMUe9GOqd3Q9ghCe0Vlhn25oTh8cXoGpd1Fr8wolNa//9dUqSM+QYDpZJXGLShX/Oa8mPwJZKDKHtqrS+2vE6S4dDWR7zKDza+DeovOeCih71QyuSYMXSz+WWGgfLzv/syhmUXP/mjqgLmJU6Kwg5htajDoylpzLC0BLGT4zDZEwBrq/AjwRs/EPjYdFgGCt1WCbbVlDyXvvH1ekDrzACzumhiMSZNNa+ZH3JmMJxTCQWDfiTeAfkauaaZHKIj2q2/QE7vuAhNcVPJ2YgpXnvnQHJpEZBc/Y3Q6JLxom6+cGC4P//9d++r2cwzXIkqD+wSGZVSVtpm5CLtWMRSK5FX2dv16bM+LE8ozoRvtMUDTrQ8SSSDGxyuYbvN9b2fYYPcWpCMchqOBXV6eZGoMldaHX3Qy5h8="

Devuelve

Un booleano que, si true, indica si la firma es válida o no para el mensaje y llave pública proporcionados.

Hemos recibido un mensaje con una firma en formato BSON.Binary y queremos verificar que el mensaje fue firmado con la clave privada que corresponde a la clave pública RSA del remitente:

-----BEGIN RSA PUBLIC KEY-----
MIGJAoGBANWwSOx7ao7i/enxEz+rxGrOWhzWV57fjKhi4pnZx6a5S7wmlzsoU7X5
omld1tI9k2EYt0A2fx/agwhnVH2GAQlGf9Cb9jILhE9MaDnmfMepKXOI1kkxDIRT
JTuTHn4pvqS2CiOGTyhxlGSiszwUTKWSsrOBKt9rLQ9xYc+wqWZ5AgMBAAE=
-----END RSA PUBLIC KEY-----

Con esta clave RSA, podemos verificar un mensaje firmado con la llave privada correspondiente usando la siguiente función:

exports = function() {
  const rsaPublicKey = context.values.get("rsaPublicKey");
  const message = "MongoDB is great!"
  const signature = BSON.Binary.fromBase64("SpfXcJwPbypArt+XuYQyuZqU52YCAY/sZj2kiuin2b6/RzyM4Ek3n3spOtqZJqxn1tfQavxIX4V+prbs74/pOaQkCLekl9Hoa1xOzSKcGoRd8U+n1+UBY3d3cyODGMpyr8Tim2HZAeLPE/D3Q36/K+jpgjvrJFXsJoAy5/PV7iEGV1fkzogmZtXWDcUUBBTTNPY4qZTzjNhL4RAFOc7Mfci+ojE/lLsNaumUVU1/Eky4vasmyjqunm+ULCcRmgWtGDMGHaQV4OXC2LMUe9GOqd3Q9ghCe0Vlhn25oTh8cXoGpd1Fr8wolNa//9dUqSM+QYDpZJXGLShX/Oa8mPwJZKDKHtqrS+2vE6S4dDWR7zKDza+DeovOeCih71QyuSYMXSz+WWGgfLzv/syhmUXP/mjqgLmJU6Kwg5htajDoylpzLC0BLGT4zDZEwBrq/AjwRs/EPjYdFgGCt1WCbbVlDyXvvH1ekDrzACzumhiMSZNNa+ZH3JmMJxTCQWDfiTeAfkauaaZHKIj2q2/QE7vuAhNcVPJ2YgpXnvnQHJpEZBc/Y3Q6JLxom6+cGC4P//9d++r2cwzXIkqD+wSGZVSVtpm5CLtWMRSK5FX2dv16bM+LE8ozoRvtMUDTrQ8SSSDGxyuYbvN9b2fYYPcWpCMchqOBXV6eZGoMldaHX3Qy5h8=")
  const isValid = utils.crypto.verify("rsa", message, rsaPublicKey, signature, "pss");
  return isValid; // true if the signature matches, else false
}

true

Devuelve

La firma de la entrada, en el formato especificado por output_format.

La siguiente función genera una firma sha256 como una cadena base 64:

exports = function() {
  const signature = utils.crypto.hmac(
    "hello!",
    "super-secret",
    "sha256",
    "base64"
  )
  return signature
}

"SUXd6PRMaTXXgBGaGsIHzaDWgTSa6C3D44lRGrvRak0="

Devuelve

Un objeto BSON.Binary que codifica el valor hash de la entrada proporcionada generada por la función hash especificada.

La siguiente función convierte una cadena de entrada en hash sha256:

exports = function() {
  return utils.crypto.hash(
    "sha256",
    "hello!"
  )
}

"zgYJL7lI2f+sfRo3bkBLJrdXW8wR7gWkYV/vT+w6MIs="

Devuelve

Un objeto estándar de JavaScript generado a partir del string JSON suministrado.

La siguiente función convierte una cadena JSON serializada a un objeto JavaScript equivalente:

exports = function() {
  const jsonString = `{
    "answer": 42,
    "submittedAt": "2020-03-02T16:50:24.475Z"
  }`;
  return JSON.parse(jsonString);
}

{
  "answer": 42,
  "submittedAt": "2020-03-02T16:50:24.475Z"
}

Devuelve

Una representación de cadena del objeto JavaScript proporcionado.

La siguiente función serializa un objeto JavaScript en una cadena JSON equivalente:

exports = function() {
  const jsonObject = {
    answer: 42,
    submittedAt: new Date("2020-03-02T16:46:47.977Z")
  };
  return JSON.stringify(jsonObject);
}

"{\"answer\":42,\"submittedAt\":\"2020-03-02T16:46:47.977Z\"}"

Devuelve

Una representación de objeto JavaScript de la string EJSON proporcionada.

La siguiente función convierte una string EJSON serializada en un objeto JavaScript equivalente:

exports = function() {
  const ejsonString = `{
    "answer": {
      "$numberLong": "42"
    },
    "submittedAt": {
      "$date": {
        "$numberLong": "1583167607977"
      }
    }
  }`;
  return EJSON.parse(ejsonString);
}

{
  "answer": {
    "$numberLong": "42"
  },
  "submittedAt": {
    "$date": {
      "$numberLong": "1583167607977"
    }
  }
}

Devuelve

Una representación de cadena del objeto EJSON proporcionado.

La siguiente función serializa un objeto JavaScript en una string EJSON equivalente:

exports = function() {
  const jsonObject = {
    answer: 42,
    submittedAt: new Date("2020-03-02T16:46:47.977Z")
  };
  return EJSON.stringify(jsonObject);
}

"{\"answer\":{\"$numberLong\":\"42\"},\"submittedAt\":{\"$date\":{\"$numberLong\":\"1583167607977\"}}}"

Devuelve

Un BSON.ObjectId objeto que codifica la cadena ObjectId especificada o una ObjectId cadena generada si no se especificó ninguna.

const objectId = new BSON.ObjectId("5e58667d902d38559c802b13");
const generatedObjectId = new BSON.ObjectId();

Devuelve

Un BSON.BSONRegExp objeto que codifica el patrón y las banderas de la expresión regular proporcionada.

const regex = BSON.BSONRegExp("the great", "ig");

BSON.Binario.deHex()

Construye un objeto BSON.Binary a partir de datos representados como una cadena hexadecimal.

BSON.Binary.fromHex(
  hexString: string,
  subType?: number
): BSON.Binary

Devuelve

Un objeto BSON.Binary que codifica la cadena hexadecimal proporcionada.

const binary = BSON.Binary.fromHex("54657374206d65737361676520706c656173652069676e6f7265=");

BSON.Binary.prototype.toHex()

Convierte el objeto BSON.Binary en una cadena hexadecimal.

BSON.Binary.prototype.toHex(): string

Devuelve

Una representación de cadena hexadecimal del objeto BSON.Binary proporcionado.

export = function() {
  const binary = BSON.Binary.fromHex(
      "54657374206d65737361676520706c656173652069676e6f7265="
    );
  const hexString = binary.toHex();
  return hexString
}

"54657374206d65737361676520706c656173652069676e6f7265="

BSON.Binary.fromBase64()

Construye un objeto BSON.Binary a partir de datos representados como una cadena base64.

BSON.Binary.fromBase64(
  base64String: string,
  subType?: number
): BSON.Binary

Devuelve

Un objeto BSON.Binary que codifica la string base64 proporcionada.

const binary = BSON.Binary.fromBase64("VGVzdCBtZXNzYWdlIHBsZWFzZSBpZ25vcmU=");

BSON.Binary.prototype.toBase64()

Convierte un objeto BSON.Binary en una cadena base64.

BSON.Binary.prototype.toBase64(): string

Devuelve

Una representación de cadena base64 del objeto BSON.Binary.

const binary = BSON.Binary.fromBase64("VGVzdCBtZXNzYWdlIHBsZWFzZSBpZ25vcmU=");
const base64String = binary.toBase64();

BSON.Binary.prototype.text()

Converts the BSON.Binary object into a UTF-8 string.

BSON.Binary.prototype.text(): string

Devuelve

Una representación de cadena UTF-8 del objeto BSON.Binary proporcionado.

const binary = BSON.Binary.fromBase64("VGVzdCBtZXNzYWdlIHBsZWFzZSBpZ25vcmU=");
const decodedString = binary.text();

Devuelve

Un objeto BSON.Int32 que codifica el entero especificado. Devuelve 0 si no se suministran argumentos.

const int32 = BSON.Int32(42);

BSON.Long(bajo32, alto32)

BSON.Long(low32: number, high32: number): BSON.Long

Constructs a BSON.Long object from two 32-bit integers that represent the low 32 bits and the high 32 bits in the 64-bit Long integer.

Devuelve

Un objeto BSON.Long que codifica el entero especificado. Devuelve 0 si no se suministran argumentos.

BSON.Long codifica usando la siguiente fórmula:

(high32 * (2**32)) + low32

Devuelve

Un objeto BSON.Double que codifica el double especificado. Devuelve 0 si no se suministra ningún argumento.

const double = BSON.Double(1234.5678);

Devuelve

Un BSON.Decimal128 que codifica el valor decimal proporcionado.

const double = BSON.Decimal128.fromString("1234.5678910123456");