Global Modules

Devoluções

Retorna uma string de JSON web token codificada para o payload fornecido.

Considere o seguinte objeto de declaração JSON web token:

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

Podemos codificar o objeto de declarações como uma string JSON web token ligando para utils.jwt.encode(). A função a seguir codifica o JSON web token usando o método de assinatura HS512 e o segredo "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"

Devoluções

Se returnHeader for false, retorna a carga útil EJSON decodificada.

Se returnHeader for true, retorna um objeto que contém o cabeçalho JOSE no header campo e a carga útil EJSON decodificada no payload campo .

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

Considere a seguinte string JSON web token assinada:

"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvZSBTY2htb2UiLCJpYXQiOjE1NjU3MjEyMjMxODd9.-QL15ldu2BYuJokNWT6YRiwZQIiIpvq6Kyv-C6qslNdNiUVxo8zqLJZ1iEkNf2yZKMIrQuMCtIC1tzd2H31AxA"

O JSON web token foi assinado usando o método de assinatura HS512 com o valor secreto "SuperSecret". Podemos decodificar o objeto de declarações do JWT utils.jwt.decode(). A função a seguir decodifica a string JSON web token em um objeto EJSON:

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

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

Devoluções

Um objeto Binary BSON que contém a string de texto criptografada com o tipo de criptografia e chave especificados.

Suponha que definimos um valor chamado aesEncryptionKey que contém a seguinte chave de criptografia AES de 32 bytes:

"603082712271C525E087BD999A4E0738"

Com esta chave AES, podemos criptografar uma mensagem em uma string base64 usando a seguinte função:

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"

Devoluções

Um objeto Binary BSON que contém a mensagem descriptografada.

Se a mensagem criptografada fornecida foi criptografada com o método e a chave especificados, a mensagem descriptografada será idêntica à mensagem original.

Suponha que definimos um valor denominado aesEncryptionKey que contém a seguinte chave de criptografia AES 32bytes :

"603082712271C525E087BD999A4E0738"

Podemos usar essa chave AES para descriptografar qualquer string base64 que foi criptografada com a mesma chave usando a seguinte função:

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!"

Devoluções

Uma assinatura criptográfica BSON.Binary para a mensagem assinada usando a chave privada especificada.

Vamos supor que definimos um valor denominado rsaPrivateKey que contém a seguinte chave 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-----

Com esta chave RSA, podemos assinar uma mensagem usando a seguinte função:

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="

Devoluções

Um booleano que, se true, indica se a assinatura é válida ou não para a mensagem fornecida e a chave pública.

Recebemos uma mensagem com uma assinatura no formato BSON.Binary e queremos verificar se a mensagem foi assinada com a chave privada que corresponde à chave pública RSA do emissor:

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

Com esta chave RSA, podemos verificar uma mensagem assinada com a chave privada correspondente usando a seguinte função:

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

Devoluções

A assinatura da entrada, no formato especificado por output_format.

A seguinte função gera uma assinatura sha256 como uma string em base64:

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

"SUXd6PRMaTXXgBGaGsIHzaDWgTSa6C3D44lRGrvRak0="

Devoluções

Um objeto BSON.Binary que codifica o valor de hash para a entrada fornecida gerada pela função de hash especificada.

A função a seguir faz hash de uma string de entrada com sha256:

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

"zgYJL7lI2f+sfRo3bkBLJrdXW8wR7gWkYV/vT+w6MIs="

Devoluções

Um objeto JavaScript padrão gerado a partir da string JSON fornecida.

A seguinte função converte uma string JSON serializada em um 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"
}

Devoluções

Uma representação de string do objeto JavaScript fornecido.

A função a seguir serializa um objeto JavaScript em uma string 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\"}"

Devoluções

Uma representação de objeto JavaScript da string EJSON fornecida.

A função a seguir converte uma string EJSON serializada em um 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"
    }
  }
}

Devoluções

Uma representação de string do objeto EJSON fornecido.

A função a seguir serializa um objeto JavaScript em uma 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\"}}}"

Devoluções

Um objeto BSON.ObjectId que codifica a string ObjectId especificada ou uma string ObjectId gerada se nenhuma tiver sido especificada.

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

Devoluções

Um objeto BSON.BSONRegExp que codifica o padrão e os sinalizadores de expressão regular fornecidos.

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

BSON.Binary.fromHex()

Constrói um objeto BSON.Binary a partir de dados representados como uma cadeia hexadecimal.

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

Devoluções

Um objeto BSON.Binary que codifica a string hexadecimal fornecida.

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

BSON.Binary.prototype.toHex()

Converte o objeto BSON.Binary em uma string hexadecimal.

BSON.Binary.prototype.toHex(): string

Devoluções

Uma representação de string hexadecimal do objeto BSON.Binary fornecido.

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

"54657374206d65737361676520706c656173652069676e6f7265="

BSON.Binary.fromBase64()

Constrói um objeto BSON.Binary a partir de dados representados como uma string base64.

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

Devoluções

Um objeto BSON.Binary que codifica a string base64 fornecida.

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

BSON.Binary.prototype.toBase64()

Converte um objeto BSON.Binary em uma string base64.

BSON.Binary.prototype.toBase64(): string

Devoluções

Uma representação de cadeia de caracteres base64 do objeto BSON.Binary .

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

BSON.Binary.prototype.text()

Converte o objeto BSON.Binary em uma string UTF-8.

BSON.Binary.prototype.text(): string

Devoluções

Uma representação de string UTF-8 do objeto BSON.Binary fornecido.

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

Devoluções

Um objeto BSON.Int32 que codifica o número inteiro especificado. Retorna 0 se nenhum argumento for fornecido.

const int32 = BSON.Int32(42);

BSON.Long(baixo32, alto32)

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

Constrói um objeto BSON.Long a partir de dois números inteiros de 32 bits que representam os 32 bits inferiores e os 32 bits superiores no número inteiro Long de 64 bits.

Devoluções

Um objeto BSON.Long que codifica o número inteiro especificado. Retorna 0 se nenhum argumento for fornecido.

BSON.Long codifica usando a seguinte fórmula:

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

Devoluções

Um objeto BSON.Double que codifica o duplo especificado. Retorna 0 se nenhum argumento for fornecido.

const double = BSON.Double(1234.5678);

Devoluções

Um BSON.Decimal128 que codifica o valor decimal fornecido.

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