MongoDB C++ Driver  mongocxx-3.6.0
client_encryption.hpp
1 // Copyright 2020 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 <bsoncxx/document/view_or_value.hpp>
18 #include <bsoncxx/stdx/optional.hpp>
19 #include <mongocxx/stdx.hpp>
20 
21 #include <mongocxx/config/prelude.hpp>
22 
23 namespace mongocxx {
24 MONGOCXX_INLINE_NAMESPACE_BEGIN
25 
26 class client;
27 class client_encryption;
28 
29 namespace options {
30 
34 class MONGOCXX_API client_encryption {
35  public:
49  client_encryption& key_vault_client(mongocxx::client* client);
50 
57  const stdx::optional<client*>& key_vault_client() const;
58 
75  using ns_pair = std::pair<std::string, std::string>;
76  client_encryption& key_vault_namespace(ns_pair ns);
77 
85  const stdx::optional<ns_pair>& key_vault_namespace() const;
86 
111  client_encryption& kms_providers(bsoncxx::document::view_or_value kms_providers);
112 
119  const stdx::optional<bsoncxx::document::view_or_value>& kms_providers() const;
120 
121  private:
122  friend class mongocxx::client_encryption;
123 
124  MONGOCXX_PRIVATE void* convert() const;
125 
126  stdx::optional<mongocxx::client*> _key_vault_client;
127  stdx::optional<ns_pair> _key_vault_namespace;
128  stdx::optional<bsoncxx::document::view_or_value> _kms_providers;
129 };
130 
131 } // namespace options
132 MONGOCXX_INLINE_NAMESPACE_END
133 } // namespace mongocxx
134 
135 #include <mongocxx/config/postlude.hpp>
mongocxx::options::client
Class representing the optional arguments to a MongoDB driver client object.
Definition: client.hpp:35
mongocxx::options::client_encryption
Class representing options for the object managing explicit client-side encryption.
Definition: client_encryption.hpp:34
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:30
mongocxx::client
Class representing a client connection to MongoDB.
Definition: client.hpp:58
mongocxx::options::client_encryption::ns_pair
std::pair< std::string, std::string > ns_pair
Sets the namespace to use to access the key vault collection, which contains all data keys used for e...
Definition: client_encryption.hpp:75
mongocxx::client_encryption
Definition: client_encryption.hpp:28