MongoDB C++ Driver mongocxx-3.6.7
data_key.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#include <vector>
19
20#include <bsoncxx/document/view_or_value.hpp>
21#include <bsoncxx/stdx/optional.hpp>
22#include <mongocxx/stdx.hpp>
23
24#include <mongocxx/config/prelude.hpp>
25
26namespace mongocxx {
27MONGOCXX_INLINE_NAMESPACE_BEGIN
28
29class client_encryption;
30
31namespace options {
32
36class MONGOCXX_API data_key {
37 public:
59
66 const stdx::optional<bsoncxx::document::view_or_value>& master_key() const;
67
81 data_key& key_alt_names(std::vector<std::string> key_alt_names);
82
89 const std::vector<std::string>& key_alt_names() const;
90
91 private:
92 friend class mongocxx::client_encryption;
93 MONGOCXX_PRIVATE void* convert() const;
94
95 stdx::optional<bsoncxx::document::view_or_value> _master_key;
96 std::vector<std::string> _key_alt_names;
97};
98
99} // namespace options
100
101MONGOCXX_INLINE_NAMESPACE_END
102} // namespace mongocxx
Definition: client_encryption.hpp:28
Class representing options for data key generation for encryption.
Definition: data_key.hpp:36
data_key & master_key(bsoncxx::document::view_or_value master_key)
Sets a KMS-specific key used to encrypt the new data key.
const stdx::optional< bsoncxx::document::view_or_value > & master_key() const
Gets the master key.
data_key & key_alt_names(std::vector< std::string > key_alt_names)
Sets an optional list of string alternate names used to reference the key.
const std::vector< std::string > & key_alt_names() const
Gets the alternate names for the data key.
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24