client_encryption.hpp

Go to the documentation of this file.

// Copyright 2009-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.
 
#pragma once
 
#include <string>
 
#include <mongocxx/client_encryption-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
 
#include <bsoncxx/types/bson_value/value.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
 
#include <mongocxx/cursor.hpp>
#include <mongocxx/options/client_encryption.hpp>
#include <mongocxx/options/data_key.hpp>
#include <mongocxx/options/encrypt.hpp>
#include <mongocxx/options/rewrap_many_datakey.hpp>
#include <mongocxx/result/delete.hpp>
#include <mongocxx/result/rewrap_many_datakey.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class client_encryption {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() client_encryption(options::client_encryption opts);
 
    MONGOCXX_ABI_EXPORT_CDECL() ~client_encryption();
 
    MONGOCXX_ABI_EXPORT_CDECL() client_encryption(client_encryption&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(client_encryption&) operator=(client_encryption&&) noexcept;
 
    client_encryption(const client_encryption&) = delete;
    client_encryption& operator=(const client_encryption&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::types::bson_value::value)
    create_data_key(std::string kms_provider, const options::data_key& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(collection)
    create_encrypted_collection(
        const database& db,
        const std::string& coll_name,
        const bsoncxx::v_noabi::document::view& options,
        bsoncxx::v_noabi::document::value& out_options,
        const std::string& kms_provider,
        const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view>& masterkey =
            bsoncxx::v_noabi::stdx::nullopt);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::types::bson_value::value)
    encrypt(bsoncxx::v_noabi::types::bson_value::view value, const options::encrypt& opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    encrypt_expression(bsoncxx::v_noabi::document::view_or_value expr,
                       const options::encrypt& opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::types::bson_value::value)
    decrypt(bsoncxx::v_noabi::types::bson_value::view value);
 
    MONGOCXX_ABI_EXPORT_CDECL(result::rewrap_many_datakey)
    rewrap_many_datakey(bsoncxx::v_noabi::document::view_or_value filter,
                        const options::rewrap_many_datakey& opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(result::delete_result)
    delete_key(bsoncxx::v_noabi::types::bson_value::view_or_value id);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::value>)
    get_key(bsoncxx::v_noabi::types::bson_value::view_or_value id);
 
    MONGOCXX_ABI_EXPORT_CDECL(mongocxx::v_noabi::cursor) get_keys();
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::value>)
    add_key_alt_name(bsoncxx::v_noabi::types::bson_value::view_or_value id,
                     bsoncxx::v_noabi::string::view_or_value key_alt_name);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::value>)
    remove_key_alt_name(bsoncxx::v_noabi::types::bson_value::view_or_value id,
                        bsoncxx::v_noabi::string::view_or_value key_alt_name);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::value>)
    get_key_by_alt_name(bsoncxx::v_noabi::string::view_or_value key_alt_name);
 
   private:
    class impl;
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>