libmongocrypt-helper 1.7.4.0.1002 → 1.8.0.0.1001

data/ext/libmongocrypt/libmongocrypt/src/mongocrypt-crypto-private.h

@@ -17,8 +17,8 @@
 #ifndef MONGOCRYPT_CRYPTO_PRIVATE_H
 #define MONGOCRYPT_CRYPTO_PRIVATE_H
 
-#include "mongocrypt.h"
 #include "mongocrypt-buffer-private.h"
+#include "mongocrypt.h"
 
 #define MONGOCRYPT_KEY_LEN 96
 #define MONGOCRYPT_IV_KEY_LEN 32
@@ -30,157 +30,85 @@
 #define MONGOCRYPT_BLOCK_SIZE 16
 #define MONGOCRYPT_HMAC_SHA256_LEN 32
 #define MONGOCRYPT_TOKEN_KEY_LEN 32
+
 typedef struct {
-   int hooks_enabled;
-   mongocrypt_crypto_fn aes_256_cbc_encrypt;
-   mongocrypt_crypto_fn aes_256_cbc_decrypt;
-   mongocrypt_crypto_fn aes_256_ctr_encrypt;
-   mongocrypt_crypto_fn aes_256_ctr_decrypt;
-   mongocrypt_crypto_fn aes_256_ecb_encrypt;
-   mongocrypt_random_fn random;
-   mongocrypt_hmac_fn hmac_sha_512;
-   mongocrypt_hmac_fn hmac_sha_256;
-   mongocrypt_hash_fn sha_256;
-   void *ctx;
+    int hooks_enabled;
+    mongocrypt_crypto_fn aes_256_cbc_encrypt;
+    mongocrypt_crypto_fn aes_256_cbc_decrypt;
+    mongocrypt_crypto_fn aes_256_ctr_encrypt;
+    mongocrypt_crypto_fn aes_256_ctr_decrypt;
+    mongocrypt_crypto_fn aes_256_ecb_encrypt;
+    mongocrypt_random_fn random;
+    mongocrypt_hmac_fn hmac_sha_512;
+    mongocrypt_hmac_fn hmac_sha_256;
+    mongocrypt_hash_fn sha_256;
+    void *ctx;
 } _mongocrypt_crypto_t;
 
-uint32_t
-_mongocrypt_calculate_ciphertext_len (uint32_t plaintext_len,
-                                      mongocrypt_status_t *status);
-
-/* _mongocrypt_fle2aead_calculate_ciphertext_len returns the required length of
- * the ciphertext for _mongocrypt_fle2aead_do_encryption. */
-uint32_t
-_mongocrypt_fle2aead_calculate_ciphertext_len (uint32_t plaintext_len,
-                                               mongocrypt_status_t *status);
-
-/* _mongocrypt_fle2_calculate_ciphertext_len returns the required length of
- * the ciphertext for _mongocrypt_fle2_do_encryption. */
-uint32_t
-_mongocrypt_fle2_calculate_ciphertext_len (uint32_t plaintext_len,
-                                           mongocrypt_status_t *status);
-
-uint32_t
-_mongocrypt_calculate_plaintext_len (uint32_t ciphertext_len,
-                                     mongocrypt_status_t *status);
-
-/* _mongocrypt_fle2aead_calculate_plaintext_len returns the required length of
- * the plaintext for _mongocrypt_fle2aead_do_decryption. */
-uint32_t
-_mongocrypt_fle2aead_calculate_plaintext_len (uint32_t ciphertext_len,
-                                              mongocrypt_status_t *status);
-
-/* _mongocrypt_fle2_calculate_plaintext_len returns the required length of
- * the plaintext for _mongocrypt_fle2_do_decryption. */
-uint32_t
-_mongocrypt_fle2_calculate_plaintext_len (uint32_t ciphertext_len,
-                                          mongocrypt_status_t *status);
-
-bool
-_mongocrypt_do_encryption (_mongocrypt_crypto_t *crypto,
-                           const _mongocrypt_buffer_t *iv,
-                           const _mongocrypt_buffer_t *associated_data,
-                           const _mongocrypt_buffer_t *key,
-                           const _mongocrypt_buffer_t *plaintext,
-                           _mongocrypt_buffer_t *ciphertext,
-                           uint32_t *bytes_written,
-                           mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
-
-bool
-_mongocrypt_do_decryption (_mongocrypt_crypto_t *crypto,
-                           const _mongocrypt_buffer_t *associated_data,
-                           const _mongocrypt_buffer_t *key,
-                           const _mongocrypt_buffer_t *ciphertext,
-                           _mongocrypt_buffer_t *plaintext,
-                           uint32_t *bytes_written,
-                           mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
-
-/* _mongocrypt_fle2aead_do_encryption does AEAD encryption.
- * It follows the construction described in the [AEAD with
- * CTR](https://docs.google.com/document/d/1eCU7R8Kjr-mdyz6eKvhNIDVmhyYQcAaLtTfHeK7a_vE/)
- *
- * Note: The 96 byte key is split differently for FLE 2.
- * - FLE 1 uses first 32 bytes as the mac key, and the second 32 bytes as the
- *   encryption key.
- * - FLE 2 uses first 32 bytes as encryption key, and the
- *   second 32 bytes as the mac key.
- * Note: Attempting to encrypt a 0 length plaintext is an error.
+typedef uint32_t (*_mongocrypt_ciphertextlen_fn)(uint32_t plaintext_len, mongocrypt_status_t *status);
+typedef uint32_t (*_mongocrypt_plaintextlen_fn)(uint32_t ciphertext_len, mongocrypt_status_t *status);
+typedef bool (*_mongocrypt_do_encryption_fn)(_mongocrypt_crypto_t *crypto,
+                                             const _mongocrypt_buffer_t *iv,
+                                             const _mongocrypt_buffer_t *associated_data,
+                                             const _mongocrypt_buffer_t *key,
+                                             const _mongocrypt_buffer_t *plaintext,
+                                             _mongocrypt_buffer_t *ciphertext,
+                                             uint32_t *bytes_written,
+                                             mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
+typedef bool (*_mongocrypt_do_decryption_fn)(_mongocrypt_crypto_t *crypto,
+                                             const _mongocrypt_buffer_t *associated_data,
+                                             const _mongocrypt_buffer_t *key,
+                                             const _mongocrypt_buffer_t *ciphertext,
+                                             _mongocrypt_buffer_t *plaintext,
+                                             uint32_t *bytes_written,
+                                             mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
+
+/**
+ * Defines the application layer protocol to use when
+ * encrypting client data values.
  */
-bool
-_mongocrypt_fle2aead_do_encryption (_mongocrypt_crypto_t *crypto,
-                                    const _mongocrypt_buffer_t *iv,
-                                    const _mongocrypt_buffer_t *associated_data,
-                                    const _mongocrypt_buffer_t *key,
-                                    const _mongocrypt_buffer_t *plaintext,
-                                    _mongocrypt_buffer_t *ciphertext,
-                                    uint32_t *bytes_written,
-                                    mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+typedef struct {
+    _mongocrypt_ciphertextlen_fn get_ciphertext_len;
+    _mongocrypt_plaintextlen_fn get_plaintext_len;
+    _mongocrypt_do_encryption_fn do_encrypt;
+    _mongocrypt_do_decryption_fn do_decrypt;
+} _mongocrypt_value_encryption_algorithm_t;
 
-bool
-_mongocrypt_fle2aead_do_decryption (_mongocrypt_crypto_t *crypto,
-                                    const _mongocrypt_buffer_t *associated_data,
-                                    const _mongocrypt_buffer_t *key,
-                                    const _mongocrypt_buffer_t *ciphertext,
-                                    _mongocrypt_buffer_t *plaintext,
-                                    uint32_t *bytes_written,
-                                    mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+// FLE1 algorithm: AES-256-CBC HMAC/SHA-512-256 (SHA-512 truncated to 256 bits)
+// Algorithm is documented in [FLE and
+// AEAD](https://docs.google.com/document/d/1D8xTXWo1B1dunO0bDZhPdolKTMbbD5fUIgsERubWRmY)
+const _mongocrypt_value_encryption_algorithm_t *_mcFLE1Algorithm();
 
-/* _mongocrypt_fle2_do_encryption does non-AEAD encryption.
- * @key is expected to be only an encryption key of size MONGOCRYPT_ENC_KEY_LEN.
- * Note: Attempting to encrypt a 0 length plaintext is an error.
- */
-bool
-_mongocrypt_fle2_do_encryption (_mongocrypt_crypto_t *crypto,
-                                const _mongocrypt_buffer_t *iv,
-                                const _mongocrypt_buffer_t *key,
-                                const _mongocrypt_buffer_t *plaintext,
-                                _mongocrypt_buffer_t *ciphertext,
-                                uint32_t *bytes_written,
-                                mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+// FLE2 general algorithm: AES-256-CTR HMAC/SHA-256
+// Algorithm is documented in [AEAD with
+// CTR](https://docs.google.com/document/d/1eCU7R8Kjr-mdyz6eKvhNIDVmhyYQcAaLtTfHeK7a_vE/).
+const _mongocrypt_value_encryption_algorithm_t *_mcFLE2AEADAlgorithm();
 
-/* _mongocrypt_fle2_do_decryption does non-AEAD decryption.
- * @key is expected to be only an encryption key of size MONGOCRYPT_ENC_KEY_LEN.
- */
-bool
-_mongocrypt_fle2_do_decryption (_mongocrypt_crypto_t *crypto,
-                                const _mongocrypt_buffer_t *key,
-                                const _mongocrypt_buffer_t *ciphertext,
-                                _mongocrypt_buffer_t *plaintext,
-                                uint32_t *bytes_written,
-                                mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+// FLE2 used with FLE2IndexedEncryptedValue: AES-256-CTR no HMAC
+const _mongocrypt_value_encryption_algorithm_t *_mcFLE2Algorithm();
+
+// FLE2AEAD general algorithm: AES-256-CBC HMAC/SHA-256
+const _mongocrypt_value_encryption_algorithm_t *_mcFLE2v2AEADAlgorithm();
 
-bool
-_mongocrypt_random (_mongocrypt_crypto_t *crypto,
-                    _mongocrypt_buffer_t *out,
-                    uint32_t count,
-                    mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _mongocrypt_random(_mongocrypt_crypto_t *crypto,
+                        _mongocrypt_buffer_t *out,
+                        uint32_t count,
+                        mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
 /* Generates a random number in the range [0, exclusive_upper_bound) in out. */
-bool
-_mongocrypt_random_uint64 (_mongocrypt_crypto_t *crypto,
-                           uint64_t exclusive_upper_bound,
-                           uint64_t *out,
-                           mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _mongocrypt_random_uint64(_mongocrypt_crypto_t *crypto,
+                               uint64_t exclusive_upper_bound,
+                               uint64_t *out,
+                               mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
 /* Generates a random number in the range [0, exclusive_upper_bound) in out. */
-bool
-_mongocrypt_random_int64 (_mongocrypt_crypto_t *crypto,
-                          int64_t exclusive_upper_bound,
-                          int64_t *out,
-                          mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _mongocrypt_random_int64(_mongocrypt_crypto_t *crypto,
+                              int64_t exclusive_upper_bound,
+                              int64_t *out,
+                              mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
 /* Returns 0 if equal, non-zero otherwise */
-int
-_mongocrypt_memequal (const void *const b1, const void *const b2, size_t len);
-
+int _mongocrypt_memequal(const void *const b1, const void *const b2, size_t len);
 
 /*
  * _mongocrypt_wrap_key encrypts a DEK with a KEK.
@@ -192,13 +120,11 @@ _mongocrypt_memequal (const void *const b1, const void *const b2, size_t len);
  * Returns true if no error occurred.
  * Returns false and sets @status if an error occurred.
  */
-bool
-_mongocrypt_wrap_key (_mongocrypt_crypto_t *crypto,
-                      _mongocrypt_buffer_t *kek,
-                      _mongocrypt_buffer_t *dek,
-                      _mongocrypt_buffer_t *encrypted_dek,
-                      mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _mongocrypt_wrap_key(_mongocrypt_crypto_t *crypto,
+                          _mongocrypt_buffer_t *kek,
+                          _mongocrypt_buffer_t *dek,
+                          _mongocrypt_buffer_t *encrypted_dek,
+                          mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
 /*
  * _mongocrypt_unwrap_key decrypts an encrypted DEK with a KEK.
@@ -210,22 +136,18 @@ _mongocrypt_wrap_key (_mongocrypt_crypto_t *crypto,
  * Returns true if no error occurred.
  * Returns false and sets @status if an error occurred.
  */
-bool
-_mongocrypt_unwrap_key (_mongocrypt_crypto_t *crypto,
-                        _mongocrypt_buffer_t *kek,
-                        _mongocrypt_buffer_t *encrypted_dek,
-                        _mongocrypt_buffer_t *dek,
-                        mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
-
-bool
-_mongocrypt_calculate_deterministic_iv (
-   _mongocrypt_crypto_t *crypto,
-   const _mongocrypt_buffer_t *key,
-   const _mongocrypt_buffer_t *plaintext,
-   const _mongocrypt_buffer_t *associated_data,
-   _mongocrypt_buffer_t *out,
-   mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _mongocrypt_unwrap_key(_mongocrypt_crypto_t *crypto,
+                            _mongocrypt_buffer_t *kek,
+                            _mongocrypt_buffer_t *encrypted_dek,
+                            _mongocrypt_buffer_t *dek,
+                            mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
+
+bool _mongocrypt_calculate_deterministic_iv(_mongocrypt_crypto_t *crypto,
+                                            const _mongocrypt_buffer_t *key,
+                                            const _mongocrypt_buffer_t *plaintext,
+                                            const _mongocrypt_buffer_t *associated_data,
+                                            _mongocrypt_buffer_t *out,
+                                            mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
 /*
  * _mongocrypt_hmac_sha_256 computes the HMAC SHA-256.
@@ -238,12 +160,11 @@ _mongocrypt_calculate_deterministic_iv (
  * Returns true if no error occurred.
  * Returns false sets @status if an error occurred.
  */
-bool
-_mongocrypt_hmac_sha_256 (_mongocrypt_crypto_t *crypto,
-                          const _mongocrypt_buffer_t *key,
-                          const _mongocrypt_buffer_t *in,
-                          _mongocrypt_buffer_t *out,
-                          mongocrypt_status_t *status);
+bool _mongocrypt_hmac_sha_256(_mongocrypt_crypto_t *crypto,
+                              const _mongocrypt_buffer_t *key,
+                              const _mongocrypt_buffer_t *in,
+                              _mongocrypt_buffer_t *out,
+                              mongocrypt_status_t *status);
 
 /* Crypto implementations must implement these functions. */
 
@@ -252,52 +173,37 @@ _mongocrypt_hmac_sha_256 (_mongocrypt_crypto_t *crypto,
    is successful. */
 extern bool _native_crypto_initialized;
 
-void
-_native_crypto_init (void);
+void _native_crypto_init(void);
 
 typedef struct {
-   const _mongocrypt_buffer_t *key;
-   const _mongocrypt_buffer_t *iv;
-   const _mongocrypt_buffer_t *in;
-   _mongocrypt_buffer_t *out;
-   uint32_t *bytes_written;
-   mongocrypt_status_t *status;
+    const _mongocrypt_buffer_t *key;
+    const _mongocrypt_buffer_t *iv;
+    const _mongocrypt_buffer_t *in;
+    _mongocrypt_buffer_t *out;
+    uint32_t *bytes_written;
+    mongocrypt_status_t *status;
 } aes_256_args_t;
 
-bool
-_native_crypto_aes_256_cbc_encrypt (aes_256_args_t args)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_aes_256_cbc_encrypt(aes_256_args_t args) MONGOCRYPT_WARN_UNUSED_RESULT;
 
-bool
-_native_crypto_aes_256_cbc_decrypt (aes_256_args_t args)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_aes_256_cbc_decrypt(aes_256_args_t args) MONGOCRYPT_WARN_UNUSED_RESULT;
 
-bool
-_native_crypto_hmac_sha_512 (const _mongocrypt_buffer_t *key,
-                             const _mongocrypt_buffer_t *in,
-                             _mongocrypt_buffer_t *out,
-                             mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_hmac_sha_512(const _mongocrypt_buffer_t *key,
+                                 const _mongocrypt_buffer_t *in,
+                                 _mongocrypt_buffer_t *out,
+                                 mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
-bool
-_native_crypto_random (_mongocrypt_buffer_t *out,
-                       uint32_t count,
-                       mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_random(_mongocrypt_buffer_t *out,
+                           uint32_t count,
+                           mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
-bool
-_native_crypto_aes_256_ctr_encrypt (aes_256_args_t args)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_aes_256_ctr_encrypt(aes_256_args_t args) MONGOCRYPT_WARN_UNUSED_RESULT;
 
-bool
-_native_crypto_aes_256_ctr_decrypt (aes_256_args_t args)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_aes_256_ctr_decrypt(aes_256_args_t args) MONGOCRYPT_WARN_UNUSED_RESULT;
 
-bool
-_native_crypto_hmac_sha_256 (const _mongocrypt_buffer_t *key,
-                             const _mongocrypt_buffer_t *in,
-                             _mongocrypt_buffer_t *out,
-                             mongocrypt_status_t *status)
-   MONGOCRYPT_WARN_UNUSED_RESULT;
+bool _native_crypto_hmac_sha_256(const _mongocrypt_buffer_t *key,
+                                 const _mongocrypt_buffer_t *in,
+                                 _mongocrypt_buffer_t *out,
+                                 mongocrypt_status_t *status) MONGOCRYPT_WARN_UNUSED_RESULT;
 
 #endif /* MONGOCRYPT_CRYPTO_PRIVATE_H */