mc-fle2-insert-update-payload-private-v2.h

/*
 * Copyright 2022-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_V2_H
#define MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_V2_H
 
#include <bson/bson.h>
 
#include "mc-array-private.h"
#include "mc-optional-private.h"
#include "mongocrypt-buffer-private.h"
#include "mongocrypt-private.h"
#include "mongocrypt.h"
 
/*
 * The *TokenSet types corresponds to the following BSON document:
 * d: <binary> // EDC derived from data & contention factor token
 * s: <binary> // ESC derived from data & contention factor token
 * l: <binary> // server derived from data token
 * p: <binary> // encrypted token for compaction
 */
#define DEF_TEXT_SEARCH_TOKEN_SET(Type)                                                                                \
    typedef struct {                                                                                                   \
        _mongocrypt_buffer_t edcDerivedToken;            /* d */                                                       \
        _mongocrypt_buffer_t escDerivedToken;            /* s */                                                       \
        _mongocrypt_buffer_t serverDerivedFromDataToken; /* l */                                                       \
        _mongocrypt_buffer_t encryptedTokens;            /* p */                                                       \
    } mc_Text##Type##TokenSet_t;                                                                                       \
    void mc_Text##Type##TokenSet_init(mc_Text##Type##TokenSet_t *);                                                    \
    void mc_Text##Type##TokenSet_cleanup(mc_Text##Type##TokenSet_t *);                                                 \
    void mc_Text##Type##TokenSet_shallow_copy(const mc_Text##Type##TokenSet_t *src, mc_Text##Type##TokenSet_t *dest)
 
DEF_TEXT_SEARCH_TOKEN_SET(Exact);
DEF_TEXT_SEARCH_TOKEN_SET(Substring);
DEF_TEXT_SEARCH_TOKEN_SET(Suffix);
DEF_TEXT_SEARCH_TOKEN_SET(Prefix);

typedef struct {
    mc_TextExactTokenSet_t exact; // e
    mc_array_t substringArray;    // s
    mc_array_t suffixArray;       // u
    mc_array_t prefixArray;       // p
} mc_TextSearchTokenSets_t;
 
void mc_TextSearchTokenSets_init(mc_TextSearchTokenSets_t *);
void mc_TextSearchTokenSets_cleanup(mc_TextSearchTokenSets_t *);

 
typedef struct {
    _mongocrypt_buffer_t edcDerivedToken;            // d
    _mongocrypt_buffer_t escDerivedToken;            // s
    _mongocrypt_buffer_t encryptedTokens;            // p
    _mongocrypt_buffer_t indexKeyId;                 // u
    bson_type_t valueType;                           // t
    _mongocrypt_buffer_t value;                      // v
    _mongocrypt_buffer_t serverEncryptionToken;      // e
    _mongocrypt_buffer_t serverDerivedFromDataToken; // l
    int64_t contentionFactor;                        // k
    mc_array_t edgeTokenSetArray;                    // g
    mc_optional_int64_t sparsity;                    // sp
    mc_optional_int32_t precision;                   // pn
    mc_optional_int32_t trimFactor;                  // tf
    bson_value_t indexMin;                           // mn
    bson_value_t indexMax;                           // mx
 
    struct {
        mc_TextSearchTokenSets_t tsts;
        bool set;
    } textSearchTokenSets; // b
 
    _mongocrypt_buffer_t plaintext;
    _mongocrypt_buffer_t userKeyId;
} mc_FLE2InsertUpdatePayloadV2_t;
 
// `mc_FLE2InsertUpdatePayloadV2_t` inherits extended alignment from libbson. To dynamically allocate, use
// aligned allocation (e.g. BSON_ALIGNED_ALLOC)
BSON_STATIC_ASSERT2(alignof_mc_FLE2InsertUpdatePayloadV2_t,
                    BSON_ALIGNOF(mc_FLE2InsertUpdatePayloadV2_t) >= BSON_ALIGNOF(bson_value_t));

typedef struct {
    _mongocrypt_buffer_t edcDerivedToken;            // d
    _mongocrypt_buffer_t escDerivedToken;            // s
    _mongocrypt_buffer_t serverDerivedFromDataToken; // l
    _mongocrypt_buffer_t encryptedTokens;            // p
} mc_EdgeTokenSetV2_t;
 
void mc_FLE2InsertUpdatePayloadV2_init(mc_FLE2InsertUpdatePayloadV2_t *payload);
 
bool mc_FLE2InsertUpdatePayloadV2_parse(mc_FLE2InsertUpdatePayloadV2_t *out,
                                        const _mongocrypt_buffer_t *in,
                                        mongocrypt_status_t *status);
 
/* mc_FLE2InsertUpdatePayloadV2_decrypt decrypts ciphertext.
 * Returns NULL and sets @status on error. It is an error to call before
 * mc_FLE2InsertUpdatePayloadV2_parse. */
const _mongocrypt_buffer_t *mc_FLE2InsertUpdatePayloadV2_decrypt(_mongocrypt_crypto_t *crypto,
                                                                 mc_FLE2InsertUpdatePayloadV2_t *iup,
                                                                 const _mongocrypt_buffer_t *user_key,
                                                                 mongocrypt_status_t *status);
 
bool mc_FLE2InsertUpdatePayloadV2_serialize(const mc_FLE2InsertUpdatePayloadV2_t *payload, bson_t *out);
 
bool mc_FLE2InsertUpdatePayloadV2_serializeForRange(const mc_FLE2InsertUpdatePayloadV2_t *payload, bson_t *out);
 
bool mc_FLE2InsertUpdatePayloadV2_serializeForTextSearch(const mc_FLE2InsertUpdatePayloadV2_t *payload, bson_t *out);
 
void mc_FLE2InsertUpdatePayloadV2_cleanup(mc_FLE2InsertUpdatePayloadV2_t *payload);
 
#endif /* MC_FLE2_INSERT_UPDATE_PAYLOAD_PRIVATE_V2_H */