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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/**
* 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kStorage
#include "mongo/platform/basic.h"
#include <memory>
#include <openssl/rand.h>
#include <set>
#include "mongo/base/data_cursor.h"
#include "mongo/base/init.h"
#include "mongo/base/status.h"
#include "mongo/crypto/symmetric_crypto.h"
#include "mongo/crypto/symmetric_key.h"
#include "mongo/platform/random.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/log.h"
#include "mongo/util/net/ssl_manager.h"
#include "mongo/util/str.h"
namespace mongo {
namespace crypto {
namespace {
template <typename Init>
void initCipherContext(
EVP_CIPHER_CTX* ctx, const SymmetricKey& key, aesMode mode, const uint8_t* iv, Init init) {
const auto keySize = key.getKeySize();
const EVP_CIPHER* cipher = nullptr;
if (keySize == sym256KeySize) {
if (mode == crypto::aesMode::cbc) {
cipher = EVP_get_cipherbyname("aes-256-cbc");
} else if (mode == crypto::aesMode::gcm) {
cipher = EVP_get_cipherbyname("aes-256-gcm");
}
}
uassert(ErrorCodes::BadValue,
str::stream() << "Unrecognized AES key size/cipher mode. Size: " << keySize << " Mode: "
<< getStringFromCipherMode(mode),
cipher);
const bool initOk = (1 == init(ctx, cipher, nullptr, key.getKey(), iv));
uassert(ErrorCodes::UnknownError,
str::stream() << SSLManagerInterface::getSSLErrorMessage(ERR_get_error()),
initOk);
}
class SymmetricEncryptorOpenSSL : public SymmetricEncryptor {
public:
SymmetricEncryptorOpenSSL(const SymmetricKey& key, aesMode mode, const uint8_t* iv)
: _ctx(EVP_CIPHER_CTX_new(), EVP_CIPHER_CTX_free), _mode(mode) {
initCipherContext(_ctx.get(), key, mode, iv, EVP_EncryptInit_ex);
}
StatusWith<size_t> update(const uint8_t* in, size_t inLen, uint8_t* out, size_t outLen) final {
int len = 0;
if (1 != EVP_EncryptUpdate(_ctx.get(), out, &len, in, inLen)) {
return Status(ErrorCodes::UnknownError,
str::stream()
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error()));
}
return static_cast<size_t>(len);
}
Status addAuthenticatedData(const uint8_t* in, size_t inLen) final {
fassert(51126, _mode == crypto::aesMode::gcm);
auto swUpdate = update(in, inLen, nullptr, 0);
if (!swUpdate.isOK()) {
return swUpdate.getStatus();
}
const auto len = swUpdate.getValue();
if (len != inLen) {
return {ErrorCodes::InternalError,
str::stream() << "Unexpected write length while appending AAD: " << len};
}
return Status::OK();
}
StatusWith<size_t> finalize(uint8_t* out, size_t outLen) final {
int len = 0;
if (1 != EVP_EncryptFinal_ex(_ctx.get(), out, &len)) {
return Status(ErrorCodes::UnknownError,
str::stream()
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error()));
}
return static_cast<size_t>(len);
}
StatusWith<size_t> finalizeTag(uint8_t* out, size_t outLen) final {
if (_mode == aesMode::gcm) {
#ifdef EVP_CTRL_GCM_GET_TAG
if (1 != EVP_CIPHER_CTX_ctrl(_ctx.get(), EVP_CTRL_GCM_GET_TAG, outLen, out)) {
return Status(ErrorCodes::UnknownError,
str::stream()
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error()));
}
return crypto::aesGCMTagSize;
#else
return Status(ErrorCodes::UnsupportedFormat, "GCM support is not available");
#endif
}
// Otherwise, not a tagged cipher mode, write nothing.
return 0;
}
private:
std::unique_ptr<EVP_CIPHER_CTX, decltype(&EVP_CIPHER_CTX_free)> _ctx;
const aesMode _mode;
};
class SymmetricDecryptorOpenSSL : public SymmetricDecryptor {
public:
SymmetricDecryptorOpenSSL(const SymmetricKey& key, aesMode mode, const uint8_t* iv)
: _ctx(EVP_CIPHER_CTX_new(), EVP_CIPHER_CTX_free), _mode(mode) {
initCipherContext(_ctx.get(), key, mode, iv, EVP_DecryptInit_ex);
}
StatusWith<size_t> update(const uint8_t* in, size_t inLen, uint8_t* out, size_t outLen) final {
int len = 0;
if (1 != EVP_DecryptUpdate(_ctx.get(), out, &len, in, inLen)) {
return Status(ErrorCodes::UnknownError,
str::stream()
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error()));
}
return static_cast<size_t>(len);
}
Status addAuthenticatedData(const uint8_t* in, size_t inLen) final {
fassert(51125, _mode == crypto::aesMode::gcm);
auto swUpdate = update(in, inLen, nullptr, 0);
if (!swUpdate.isOK()) {
return swUpdate.getStatus();
}
const auto len = swUpdate.getValue();
if (len != inLen) {
return {ErrorCodes::InternalError,
str::stream() << "Unexpected write length while appending AAD: " << len};
}
return Status::OK();
}
StatusWith<size_t> finalize(uint8_t* out, size_t outLen) final {
int len = 0;
if (1 != EVP_DecryptFinal_ex(_ctx.get(), out, &len)) {
return Status(ErrorCodes::UnknownError,
str::stream()
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error()));
}
return static_cast<size_t>(len);
}
Status updateTag(const uint8_t* tag, size_t tagLen) final {
// validateEncryptionOption asserts that platforms without GCM will never start in GCM mode
if (_mode == aesMode::gcm) {
#ifdef EVP_CTRL_GCM_GET_TAG
if (1 != EVP_CIPHER_CTX_ctrl(
_ctx.get(), EVP_CTRL_GCM_SET_TAG, tagLen, const_cast<uint8_t*>(tag))) {
return Status(ErrorCodes::UnknownError,
str::stream()
<< "Unable to set GCM tag: "
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error()));
}
#else
return {ErrorCodes::UnsupportedFormat, "GCM support is not available"};
#endif
} else if (tagLen != 0) {
return {ErrorCodes::BadValue, "Unexpected tag for non-gcm cipher"};
}
return Status::OK();
}
private:
std::unique_ptr<EVP_CIPHER_CTX, decltype(&EVP_CIPHER_CTX_free)> _ctx;
const aesMode _mode;
};
} // namespace
std::set<std::string> getSupportedSymmetricAlgorithms() {
#if defined(EVP_CTRL_GCM_GET_TAG) && !defined(__APPLE__)
return {aes256CBCName, aes256GCMName};
#else
return {aes256CBCName};
#endif
}
Status engineRandBytes(uint8_t* buffer, size_t len) {
if (RAND_bytes(reinterpret_cast<unsigned char*>(buffer), len) == 1) {
return Status::OK();
}
return {ErrorCodes::UnknownError,
str::stream() << "Unable to acquire random bytes from OpenSSL: "
<< SSLManagerInterface::getSSLErrorMessage(ERR_get_error())};
}
StatusWith<std::unique_ptr<SymmetricEncryptor>> SymmetricEncryptor::create(const SymmetricKey& key,
aesMode mode,
const uint8_t* iv,
size_t ivLen) try {
std::unique_ptr<SymmetricEncryptor> encryptor =
std::make_unique<SymmetricEncryptorOpenSSL>(key, mode, iv);
return std::move(encryptor);
} catch (const DBException& e) {
return e.toStatus();
}
StatusWith<std::unique_ptr<SymmetricDecryptor>> SymmetricDecryptor::create(const SymmetricKey& key,
aesMode mode,
const uint8_t* iv,
size_t ivLen) try {
std::unique_ptr<SymmetricDecryptor> decryptor =
std::make_unique<SymmetricDecryptorOpenSSL>(key, mode, iv);
return std::move(decryptor);
} catch (const DBException& e) {
return e.toStatus();
}
} // namespace crypto
} // namespace mongo
|
