MONGOC_CLIENT_...YPTION_ENCRYPT(3)

💖 mongoc_client_encryption_encrypt 💖

okay bestie, welcome to the libmongoc manual, specifically the page for mongoc_client_encryption_encrypt — yes the header got chopped in the terminal like a bad screenshot, but that's the one. she does explicit encryption, and honestly? iconic behavior. let's get into it 🫶

---

✨ SYNOPSIS ✨

bool
mongoc_client_encryption_encrypt (
   mongoc_client_encryption_t *client_encryption,
   const bson_value_t *value,
   mongoc_client_encryption_encrypt_opts_t *opts,
   bson_value_t *ciphertext,
   bson_error_t *error);

---

🌸 DESCRIPTION 🌸

so what does she actually do? she performs explicit encryption. that's the whole vibe. 💅

ciphertext is always initialized — even on failure, no cap, she never leaves you hanging with garbage memory. but bestie listen: the caller must call bson_value_destroy() to free it. literally your job, not hers. don't ghost your cleanup 🫶

now, the important part 👑 — to insert or query with an "Indexed" or "Range" encrypted payload, you use a mongoc_client_t that's configured with mongoc_auto_encryption_opts_t.

that mongoc_auto_encryption_opts_t may be configured to bypass query analysis with mongoc_auto_encryption_opts_set_bypass_query_analysis().

but it must not be configured to bypass automatic encryption with mongoc_auto_encryption_opts_set_bypass_auto_encryption(). 🚫 like, absolutely not, that's the one thing you can't do here.

⚠️ read that again bestie — "may bypass query analysis" = fine, "must not bypass automatic encryption" = do not. they are NOT the same thing and mixing them up is a whole mess. 😭

to insert with a Range payload, mongoc_client_encryption_encrypt_range_opts_t must be set in opts. no shortcuts ✨

and to query with a Range payload? that's a whole different function — use mongoc_client_encryption_encrypt_expression(). different girl, different job 💅

---

🎀 PARAMETERS 🎀

• client_encryption — a mongoc_client_encryption_t. the main character of this function ✨
• value — the value to encrypt. the secret. the tea. 🍓
• opts — a mongoc_client_encryption_encrypt_opts_t. this is where you set your Range opts if you're doing the Range thing.
• ciphertext — a bson_value_t that holds the resulting ciphertext — which is a BSON binary with subtype 6, iykyk 🦋
• error — a bson_error_t that gets set on failure. she'll tell you what went wrong 💀

---

⭐ RETURNS ⭐

returns true if it worked — slay, we love a success 💖

returns false and sets error otherwise. so like, always check. always. 🙈

👀 SEE ALSO 👀

• mongoc_client_encryption_encrypt_opts_t
• mongoc_client_enable_auto_encryption()
• mongoc_client_decryption_decrypt()
• mongoc_client_encryption_encrypt_expression()

go read those next, they're lowkey required reading for the full lore 📚

---

💜 AUTHOR 💜

MongoDB, Inc — the icon, the legend, the whole team 🫶

🌈 COPYRIGHT 🌈

2009-present, MongoDB, Inc. — periods and all, we respect the paperwork 👑

---

and that's a wrap, bestie!! this page is from libmongoc version 2.5.6, date stamped Oct 09, 202 (yes the terminal ate the rest of the year, she's mysterious like that 💀✨). go forth, encrypt explicitly, and please call bson_value_destroy(). mwah 🎀💖