[MONGOCRYPT-439] Replace references of CSFLE and "FLE 2" in public header Created: 03/Jun/22  Updated: 07/Jun/22  Resolved: 07/Jun/22

Status: Closed
Project: Libmongocrypt
Component/s: None
Affects Version/s: 1.5.0-rc1
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Kevin Albertson Assignee: Colby Pike
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Binding Changes: Not Needed

 Description   
  • Replace remaining references of "CSFLE" with "mongo_crypt" in mongocrypt.h.in
  • Replace remaining references of "FLE 2" with "Queryable Encryption" in mongocrypt.h.in

git grep -iE 'csfle|FLE 2' -- src/mongocrypt.h.in
s$rc/mongocrypt.h.in:152:   MONGOCRYPT_STATUS_ERROR_CSFLE = 3,
src/mongocrypt.h.in:432: * the CSFLE dynamic library.
src/mongocrypt.h.in:441: * system's library resolution mechanism to find the CSFLE library.
src/mongocrypt.h.in:443: * @note If no CSFLE dynamic library is found in any of the directories
src/mongocrypt.h.in:445: * succeed and continue to operate without CSFLE.
src/mongocrypt.h.in:465: * @brief Set a single override path for loading the CSFLE dynamic library.
src/mongocrypt.h.in:468: * @param[in] path A null-terminated sequence of bytes for a path to the CSFLE
src/mongocrypt.h.in:478: * @note If a CSFLE library path override is specified here, then no paths given
src/mongocrypt.h.in:480: * consulted when opening the CSFLE library.
src/mongocrypt.h.in:483: * initialize a valid CSFLE library instance for the path specified, then
src/mongocrypt.h.in:553: * Obtain a nul-terminated version string of the loaded csfle dynamic library,
src/mongocrypt.h.in:556: * If no csfle was successfully loaded, this function returns NULL.
src/mongocrypt.h.in:561: * returned string is written. If provided and no csfle library was loaded, zero
src/mongocrypt.h.in:564: * @return A nul-terminated string of the dynamically loaded csfle library.
src/mongocrypt.h.in:576: * @brief Obtain a 64-bit constant encoding the version of the loaded csfle
src/mongocrypt.h.in:583: * sixteen-bit integers, or zero if no csfle library was loaded.
src/mongocrypt.h.in:903: * Associated options for FLE 2:
src/mongocrypt.h.in:910: * An error is returned if FLE 1 and FLE 2 incompatible options are set.
src/mongocrypt.h.in:1443: * - The csfle shared library will not attempt to be loaded.
src/mongocrypt.h.in:1459: * The index type is only used for FLE 2 encryption.
src/mongocrypt.h.in:1474: * The contention factor is only used for indexed FLE 2 encryption.
src/mongocrypt.h.in:1488: * Set the index key id to use for FLE 2 explicit encryption.
src/mongocrypt.h.in:1510: * Set the query type to use for FLE 2 explicit encryption.
src/mongocrypt.h.in:1511: * The query type is only used for indexed FLE 2 encryption.



 Comments   
Comment by Githook User [ 07/Jun/22 ]

Author:

{'name': 'vector-of-bool', 'email': 'vectorofbool@gmail.com', 'username': 'vector-of-bool'}

Message: MONGOCRYPT-439: Remove comment references to FLE2 and CSFLE (#363)
Branch: master
https://github.com/mongodb/libmongocrypt/commit/3d3766889de56e6926732326fc7322caebc92812

Generated at Thu Feb 08 09:08:40 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.