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 <mongocxx/v1/client_encryption-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/value-fwd.hpp>
#include <bsoncxx/v1/document/view-fwd.hpp>
#include <bsoncxx/v1/types/value-fwd.hpp>
 
#include <mongocxx/v1/client-fwd.hpp>
#include <mongocxx/v1/collection-fwd.hpp>
#include <mongocxx/v1/cursor-fwd.hpp>
#include <mongocxx/v1/data_key_options-fwd.hpp>
#include <mongocxx/v1/database-fwd.hpp>
#include <mongocxx/v1/delete_one_result-fwd.hpp>
#include <mongocxx/v1/encrypt_options-fwd.hpp>
#include <mongocxx/v1/rewrap_many_datakey_options-fwd.hpp>
#include <mongocxx/v1/rewrap_many_datakey_result-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <string>
#include <utility>
 
namespace mongocxx {
namespace v1 {

class client_encryption {
   private:
    void* _impl; // mongoc_client_encryption_t
 
   public:
    class options;

    MONGOCXX_ABI_EXPORT_CDECL() ~client_encryption();

    MONGOCXX_ABI_EXPORT_CDECL() client_encryption(client_encryption&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(client_encryption&) operator=(client_encryption&& other) noexcept;

    client_encryption(client_encryption const& other) = delete;

    client_encryption& operator=(client_encryption const& other) = delete;

    explicit MONGOCXX_ABI_EXPORT_CDECL() client_encryption(options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::types::value) create_data_key(
        bsoncxx::v1::stdx::string_view kms_provider,
        v1::data_key_options const& opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::types::value) create_data_key(bsoncxx::v1::stdx::string_view kms_provider);

    MONGOCXX_ABI_EXPORT_CDECL(v1::collection) create_encrypted_collection(
        v1::database& db,
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view opts,
        bsoncxx::v1::document::value& coll_opts,
        bsoncxx::v1::stdx::string_view kms_provider,
        bsoncxx::v1::document::view master_key);

    MONGOCXX_ABI_EXPORT_CDECL(v1::collection) create_encrypted_collection(
        v1::database& db,
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view opts,
        bsoncxx::v1::document::value& coll_opts,
        bsoncxx::v1::stdx::string_view kms_provider);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::types::value) encrypt(
        bsoncxx::v1::types::value value,
        v1::encrypt_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) encrypt_expression(
        bsoncxx::v1::document::view expr,
        v1::encrypt_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::types::value) decrypt(bsoncxx::v1::types::value value);

    MONGOCXX_ABI_EXPORT_CDECL(v1::rewrap_many_datakey_result) rewrap_many_datakey(
        bsoncxx::v1::document::view filter,
        v1::rewrap_many_datakey_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(v1::delete_one_result) delete_key(bsoncxx::v1::types::value id);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) get_key(bsoncxx::v1::types::value id);

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) get_keys();

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) add_key_alt_name(
        bsoncxx::v1::types::value id,
        bsoncxx::v1::stdx::string_view key_alt_name);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) remove_key_alt_name(
        bsoncxx::v1::types::value id,
        bsoncxx::v1::stdx::string_view key_alt_name);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) get_key_by_alt_name(
        bsoncxx::v1::stdx::string_view key_alt_name);
 
    class internal;
 
   private:
    /* explicit(false) */ client_encryption(void* impl);
};

class client_encryption::options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~options();

    MONGOCXX_ABI_EXPORT_CDECL() options(options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(options&) operator=(options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() options(options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(options&) operator=(options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() options();

    MONGOCXX_ABI_EXPORT_CDECL(options&) key_vault_client(v1::client* v);

    MONGOCXX_ABI_EXPORT_CDECL(v1::client*) key_vault_client() const;

    using ns_pair = std::pair<std::string, std::string>;

    MONGOCXX_ABI_EXPORT_CDECL(options&) key_vault_namespace(ns_pair v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<ns_pair>) key_vault_namespace() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) kms_providers(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) kms_providers() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) tls_opts(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) tls_opts() const;
 
    class internal;
};
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>