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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
# Copyright (C) 2019-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/db/matcher/matcher_type_set.h"
- "mongo/db/matcher/schema/encrypt_schema_types.h"
imports:
- "mongo/idl/basic_types.idl"
types:
encryptSchemaAnyType:
bson_serialization_type: any
description: "Holds a to-be-encrypted BSONElement of any type."
cpp_type: "mongo::EncryptSchemaAnyType"
serializer: mongo::EncryptSchemaAnyType::serializeToBSON
deserializer: mongo::EncryptSchemaAnyType::parseFromBSON
encryptSchemaKeyId:
bson_serialization_type: any
description: "A string pointing to the key id or an array UUIDs identifying a set of keys."
cpp_type: "mongo::EncryptSchemaKeyId"
serializer: mongo::EncryptSchemaKeyId::serializeToBSON
deserializer: mongo::EncryptSchemaKeyId::parseFromBSON
bsonTypeSet:
bson_serialization_type: any
description: "A string or array of strings representing BSONType names."
cpp_type: "mongo::BSONTypeSet"
serializer: mongo::BSONTypeSet::serializeToBSON
deserializer: mongo::BSONTypeSet::parseFromBSON
enums:
FleAlgorithm:
description: "The algorithm used to encrypt fields for field level encryption."
type: string
values:
kDeterministic: "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
kRandom: "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
FleAlgorithmInt:
description: "The algorithm used to encrypt fields for field level encryption represented
as an unsigned integer."
type: int
values:
kDeterministic: 1
kRandom: 2
structs:
# Maps to the encrypt keyword in JSON Schema.
EncryptionInfo:
description: "Represents the fields that users can specify within the encryptMetadata
subobject in a JSON Schema."
strict: true
fields:
bsonType:
description: "Specifies the type of the to-be-encrypted value."
type: bsonTypeSet
optional: true
algorithm:
description: "The encryption algorithm to be used."
type: FleAlgorithm
optional: true
keyId:
description: "A JSONPointer to a key or an array of UUIDs identifying a set of keys."
type: encryptSchemaKeyId
optional: true
# Maps to "encryptMetadata" in JSON Schema.
EncryptionMetadata:
description: "The fields that can be applied to children in the schema
with the encrypt keyword."
strict: true
generate_comparison_operators: true
fields:
algorithm:
description: "The encryption algorithm to be used."
type: FleAlgorithm
optional: true
keyId:
description: "A JSONPointer to a key or an array of UUIDs identifying a set of keys."
type: encryptSchemaKeyId
optional: true
EncryptionPlaceholder:
description: "Implements Encryption BinData (subtype 6) sub-subtype 0, the intent-to-encrypt
mapping. Contains a value to encrypt and a description of how it should be encrypted."
strict: true
fields:
a:
description: "The encryption algorithm to be used."
type: FleAlgorithmInt
cpp_name: algorithm
ki:
description: "Used to query the key vault by _id. If omitted, ka must be specified."
type: uuid
cpp_name: keyId
optional: true
ka:
description: "Used to query the key vault by keyAltName. If omitted,
ki must be specified."
type: string
cpp_name: keyAltName
optional: true
v:
description: "value to encrypt"
type: encryptSchemaAnyType
cpp_name: value
|
