data_key.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 <string>
#include <vector>
 
#include <mongocxx/client_encryption-fwd.hpp>
#include <mongocxx/options/data_key-fwd.hpp>
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
 
#include <mongocxx/stdx.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace options {
 
class data_key {
   public:
    //     keyId: Optional<String>, // keyId is the KMIP Unique Identifier to a 96 byte KMIP Secret
    //                              // Data managed object.If keyId is omitted, the driver creates a
    //                              // random 96 byte KMIP Secret Data managed object.
    //     endpoint: Optional<String> // Host with optional port.
    MONGOCXX_ABI_EXPORT_CDECL(data_key&)
    master_key(bsoncxx::v_noabi::document::view_or_value master_key);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
    master_key() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(data_key&) key_alt_names(std::vector<std::string> key_alt_names);
 
    MONGOCXX_ABI_EXPORT_CDECL(const std::vector<std::string>&) key_alt_names() const;
 
    using key_material_type = std::vector<uint8_t>;
 
    MONGOCXX_ABI_EXPORT_CDECL(data_key&) key_material(key_material_type key_material);
 
    MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<key_material_type>&) key_material();
 
   private:
    friend ::mongocxx::v_noabi::client_encryption;
 
    void* convert() const;
 
    stdx::optional<bsoncxx::v_noabi::document::view_or_value> _master_key;
    std::vector<std::string> _key_alt_names;
    stdx::optional<key_material_type> _key_material;
};
 
}  // namespace options
}  // namespace v_noabi
}  // namespace mongocxx
 
// CXX-2770: missing include of postlude header.
#if defined(MONGOCXX_TEST_MACRO_GUARDS_FIX_MISSING_POSTLUDE)
#include <mongocxx/config/postlude.hpp>
#endif