1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2019-2021 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.
module Mongo
module Crypt
module KMS
module KMIP
# KMIP KMS master key document object contains KMS master key parameters.
#
# @api private
class MasterKeyDocument
include KMS::Validations
# @return [ String | nil ] The KMIP Unique Identifier to a 96 byte
# KMIP Secret Data managed object.
attr_reader :key_id
# @return [ String | nil ] KMIP KMS endpoint with optional port.
attr_reader :endpoint
FORMAT_HINT = "KMIP KMS key document must be in the format: " +
"{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }"
# Creates a master key document object form a parameters hash.
#
# @param [ Hash ] opts A hash that contains master key options for
# KMIP KMS provider
# @option opts [ String | nil ] :key_id KMIP Unique Identifier to
# a 96 byte KMIP Secret Data managed object, optional. If key_id
# is omitted, the driver creates a random 96 byte identifier.
# @option opts [ String | nil ] :endpoint KMIP endpoint, optional.
#
# @raise [ ArgumentError ] If required options are missing or incorrectly
# formatted.
def initialize(opts = {})
@key_id = validate_param(
:key_id, opts, FORMAT_HINT, required: false
)
@endpoint = validate_param(
:endpoint, opts, FORMAT_HINT, required: false
)
end
# Convert master key document object to a BSON document in libmongocrypt format.
#
# @return [ BSON::Document ] KMIP KMS credentials in libmongocrypt format.
def to_document
BSON::Document.new({
provider: 'kmip',
}).tap do |bson|
bson.update({ endpoint: endpoint }) unless endpoint.nil?
bson.update({ keyId: key_id }) unless key_id.nil?
end
end
end
end
end
end
end
|
