MongoDB C++ Driver mongocxx-3.10.1
Loading...
Searching...
No Matches
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 <string>
18
19#include <mongocxx/client-fwd.hpp>
20#include <mongocxx/client_encryption-fwd.hpp>
21#include <mongocxx/options/client_encryption-fwd.hpp>
22
23#include <bsoncxx/document/view_or_value.hpp>
24#include <bsoncxx/stdx/optional.hpp>
25#include <mongocxx/stdx.hpp>
26
27#include <mongocxx/config/prelude.hpp>
28
29namespace mongocxx {
30namespace v_noabi {
31namespace options {
32
37 public:
52
59 const stdx::optional<mongocxx::v_noabi::client*>& key_vault_client() const;
60
77 using ns_pair = std::pair<std::string, std::string>;
79
87 const stdx::optional<ns_pair>& key_vault_namespace() const;
88
133
140 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& kms_providers() const;
141
165
172 const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& tls_opts() const;
173
174 private:
175 friend ::mongocxx::v_noabi::client_encryption;
176
177 MONGOCXX_PRIVATE void* convert() const;
178
179 stdx::optional<mongocxx::v_noabi::client*> _key_vault_client;
180 stdx::optional<ns_pair> _key_vault_namespace;
181 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _kms_providers;
182 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _tls_opts;
183};
184
185} // namespace options
186} // namespace v_noabi
187} // namespace mongocxx
188
189#include <mongocxx/config/postlude.hpp>
Class representing a client connection to MongoDB.
Definition client.hpp:61
Class representing options for the object managing explicit client-side encryption.
Definition client_encryption.hpp:36
const stdx::optional< ns_pair > & key_vault_namespace() const
Gets the key vault namespace.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & kms_providers() const
Gets the KMS providers.
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.
const stdx::optional< mongocxx::v_noabi::client * > & key_vault_client() const
Gets the key vault client.
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:77
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & tls_opts() const
Gets the TLS options.
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...
Class representing the optional arguments to a MongoDB driver client object.
Definition client.hpp:38
The top-level namespace for mongocxx library entities.
Definition bulk_write-fwd.hpp:19