MongoDB C++ Driver 4.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
client_encryption.hpp
Go to the documentation of this file.
1// Copyright 2009-present MongoDB, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <string>
18
22
25
27
28namespace mongocxx {
29namespace v_noabi {
30namespace options {
31
36 public:
53
62
66 using ns_pair = std::pair<std::string, std::string>;
67
86
94 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<ns_pair> const&)
96
142 kms_providers(bsoncxx::v_noabi::document::view_or_value kms_providers);
143
150 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
152
177 tls_opts(bsoncxx::v_noabi::document::view_or_value tls_opts);
178
185 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
186 tls_opts() const;
187
188 private:
190
191 void* convert() const;
192
193 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::client*> _key_vault_client;
194 bsoncxx::v_noabi::stdx::optional<ns_pair> _key_vault_namespace;
195 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _kms_providers;
196 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _tls_opts;
197};
198
199} // namespace options
200} // namespace v_noabi
201} // namespace mongocxx
202
203#include <mongocxx/config/postlude.hpp>
204
Used by mongocxx::v_noabi::client_encryption.
Definition client_encryption.hpp:35
client_encryption & key_vault_namespace(ns_pair ns)
Sets the namespace to use to access the key vault collection, which contains all data keys used for e...
client_encryption & tls_opts(bsoncxx::v_noabi::document::view_or_value tls_opts)
Sets the TLS options to use for client side encryption with a given KMS provider.
client_encryption & kms_providers(bsoncxx::v_noabi::document::view_or_value kms_providers)
Sets the KMS providers to use for client side encryption.
std::pair< std::string, std::string > ns_pair
Represents the name of a database and a collection.
Definition client_encryption.hpp:66
client_encryption & key_vault_client(mongocxx::v_noabi::client *client)
When the key vault collection is on a separate MongoDB cluster, sets the optional client to use to ro...
Used by clients.
Definition client.hpp:37
Declares mongocxx::v_noabi::client.
Declares mongocxx::v_noabi::client_encryption.
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
The top-level namespace within which all mongocxx library entities are declared.
Declares mongocxx::v_noabi::options::client_encryption.
Provides std::optional-related polyfills for library API usage.