Skip to content

Commit 59a8c10

Browse files
authored
CXX-3198 Miscellaneous improvements to address feedback in #1306 (#1310)
* Remove unnecessary strlen+min on call to bson_strncpy * Use pre-generated key material for examples instead of rand()
1 parent dcc49bb commit 59a8c10

File tree

5 files changed

+41
-21
lines changed

5 files changed

+41
-21
lines changed

examples/mongocxx/automatic_client_side_field_level_encryption.cpp

+10-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
#include <cstdint>
1717
#include <fstream>
1818
#include <iostream>
19-
#include <random>
2019

2120
#include <bsoncxx/builder/basic/document.hpp>
2221
#include <bsoncxx/builder/basic/kvp.hpp>
@@ -100,10 +99,16 @@ bsoncxx::document::value doc_from_file(std::string path) {
10099
int EXAMPLES_CDECL main() {
101100
instance inst{};
102101

103-
// This must be the same master key that was used to create
104-
// the encryption key; here, we use a random key as a placeholder.
105-
std::uint8_t key_storage[kKeyLength];
106-
std::generate_n(key_storage, kKeyLength, []() { return static_cast<std::uint8_t>(std::rand() % UINT8_MAX); });
102+
// This must be the same master key that was used to create the encryption key.
103+
// An arbitrary key is used as a placeholder for this example.
104+
std::uint8_t const key_storage[kKeyLength]{
105+
0x45, 0xA3, 0x5B, 0xC8, 0x91, 0x76, 0x2E, 0x0F, 0x34, 0x6A, 0xD1, 0xB8, 0x55, 0x9C, 0xEA, 0x1F,
106+
0x88, 0x12, 0x6D, 0x3B, 0x75, 0x2A, 0xF0, 0x97, 0x41, 0xE3, 0x5C, 0xB9, 0x66, 0x0D, 0xAF, 0x52,
107+
0x23, 0xC4, 0x8E, 0x19, 0x74, 0xAB, 0x2F, 0xD0, 0x39, 0x6B, 0x84, 0xFC, 0x14, 0x7E, 0x93, 0x27,
108+
0x5D, 0x86, 0x1C, 0xA8, 0x72, 0x30, 0xB7, 0x4F, 0x09, 0xE1, 0xCA, 0x53, 0x2D, 0x94, 0xBA, 0x68,
109+
0x0E, 0xF5, 0x48, 0x16, 0x7F, 0xAE, 0x21, 0x6C, 0x9D, 0x82, 0x0B, 0xF2, 0x5A, 0x37, 0xCC, 0x18,
110+
0x4A, 0x6E, 0x95, 0xBD, 0x33, 0x57, 0xA1, 0x08, 0xDF, 0x20, 0x69, 0xE7, 0x12, 0x8B, 0xF4, 0x3D,
111+
};
107112
bsoncxx::types::b_binary local_master_key{bsoncxx::binary_sub_type::k_binary, kKeyLength, key_storage};
108113

109114
auto kms_providers = document{} << "local" << open_document << "key" << local_master_key << close_document

examples/mongocxx/explicit_encryption.cpp

+10-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
#include <algorithm>
1616
#include <cstdint>
1717
#include <iostream>
18-
#include <random>
1918

2019
#include <bsoncxx/builder/basic/document.hpp>
2120
#include <bsoncxx/builder/basic/kvp.hpp>
@@ -51,10 +50,16 @@ int const kKeyLength = 96;
5150
int EXAMPLES_CDECL main() {
5251
instance inst{};
5352

54-
// This must be the same master key that was used to create
55-
// the encryption key; here, we use a random key as a placeholder.
56-
std::uint8_t key_storage[kKeyLength];
57-
std::generate_n(key_storage, kKeyLength, []() { return static_cast<std::uint8_t>(std::rand() % UINT8_MAX); });
53+
// This must be the same master key that was used to create the encryption key.
54+
// An arbitrary key is used as a placeholder for this example.
55+
std::uint8_t const key_storage[kKeyLength]{
56+
0x45, 0xA3, 0x5B, 0xC8, 0x91, 0x76, 0x2E, 0x0F, 0x34, 0x6A, 0xD1, 0xB8, 0x55, 0x9C, 0xEA, 0x1F,
57+
0x88, 0x12, 0x6D, 0x3B, 0x75, 0x2A, 0xF0, 0x97, 0x41, 0xE3, 0x5C, 0xB9, 0x66, 0x0D, 0xAF, 0x52,
58+
0x23, 0xC4, 0x8E, 0x19, 0x74, 0xAB, 0x2F, 0xD0, 0x39, 0x6B, 0x84, 0xFC, 0x14, 0x7E, 0x93, 0x27,
59+
0x5D, 0x86, 0x1C, 0xA8, 0x72, 0x30, 0xB7, 0x4F, 0x09, 0xE1, 0xCA, 0x53, 0x2D, 0x94, 0xBA, 0x68,
60+
0x0E, 0xF5, 0x48, 0x16, 0x7F, 0xAE, 0x21, 0x6C, 0x9D, 0x82, 0x0B, 0xF2, 0x5A, 0x37, 0xCC, 0x18,
61+
0x4A, 0x6E, 0x95, 0xBD, 0x33, 0x57, 0xA1, 0x08, 0xDF, 0x20, 0x69, 0xE7, 0x12, 0x8B, 0xF4, 0x3D,
62+
};
5863
bsoncxx::types::b_binary local_master_key{bsoncxx::binary_sub_type::k_binary, kKeyLength, key_storage};
5964

6065
auto kms_providers = document{} << "local" << open_document << "key" << local_master_key << close_document

examples/mongocxx/explicit_encryption_auto_decryption.cpp

+10-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
#include <algorithm>
1616
#include <cstdint>
1717
#include <iostream>
18-
#include <random>
1918

2019
#include <bsoncxx/builder/basic/document.hpp>
2120
#include <bsoncxx/builder/basic/kvp.hpp>
@@ -51,10 +50,16 @@ int const kKeyLength = 96;
5150
int EXAMPLES_CDECL main() {
5251
instance inst{};
5352

54-
// This must be the same master key that was used to create
55-
// the encryption key; here, we use a random key as a placeholder.
56-
std::uint8_t key_storage[kKeyLength];
57-
std::generate_n(key_storage, kKeyLength, []() { return static_cast<std::uint8_t>(std::rand() % UINT8_MAX); });
53+
// This must be the same master key that was used to create the encryption key.
54+
// An arbitrary key is used as a placeholder for this example.
55+
std::uint8_t const key_storage[kKeyLength]{
56+
0x45, 0xA3, 0x5B, 0xC8, 0x91, 0x76, 0x2E, 0x0F, 0x34, 0x6A, 0xD1, 0xB8, 0x55, 0x9C, 0xEA, 0x1F,
57+
0x88, 0x12, 0x6D, 0x3B, 0x75, 0x2A, 0xF0, 0x97, 0x41, 0xE3, 0x5C, 0xB9, 0x66, 0x0D, 0xAF, 0x52,
58+
0x23, 0xC4, 0x8E, 0x19, 0x74, 0xAB, 0x2F, 0xD0, 0x39, 0x6B, 0x84, 0xFC, 0x14, 0x7E, 0x93, 0x27,
59+
0x5D, 0x86, 0x1C, 0xA8, 0x72, 0x30, 0xB7, 0x4F, 0x09, 0xE1, 0xCA, 0x53, 0x2D, 0x94, 0xBA, 0x68,
60+
0x0E, 0xF5, 0x48, 0x16, 0x7F, 0xAE, 0x21, 0x6C, 0x9D, 0x82, 0x0B, 0xF2, 0x5A, 0x37, 0xCC, 0x18,
61+
0x4A, 0x6E, 0x95, 0xBD, 0x33, 0x57, 0xA1, 0x08, 0xDF, 0x20, 0x69, 0xE7, 0x12, 0x8B, 0xF4, 0x3D,
62+
};
5863
bsoncxx::types::b_binary local_master_key{bsoncxx::binary_sub_type::k_binary, kKeyLength, key_storage};
5964

6065
auto kms_providers = document{} << "local" << open_document << "key" << local_master_key << close_document

examples/mongocxx/server_side_field_level_encryption_enforcement.cpp

+10-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
#include <algorithm>
1616
#include <cstdint>
1717
#include <iostream>
18-
#include <random>
1918

2019
#include <bsoncxx/builder/basic/document.hpp>
2120
#include <bsoncxx/builder/basic/kvp.hpp>
@@ -53,10 +52,16 @@ int const kKeyLength = 96;
5352
int EXAMPLES_CDECL main() {
5453
instance inst{};
5554

56-
// This must be the same master key that was used to create
57-
// the encryption key; here, we use a random key as a placeholder.
58-
std::uint8_t key_storage[kKeyLength];
59-
std::generate_n(key_storage, kKeyLength, []() { return static_cast<std::uint8_t>(std::rand() % UINT8_MAX); });
55+
// This must be the same master key that was used to create the encryption key.
56+
// An arbitrary key is used as a placeholder for this example.
57+
std::uint8_t const key_storage[kKeyLength]{
58+
0x45, 0xA3, 0x5B, 0xC8, 0x91, 0x76, 0x2E, 0x0F, 0x34, 0x6A, 0xD1, 0xB8, 0x55, 0x9C, 0xEA, 0x1F,
59+
0x88, 0x12, 0x6D, 0x3B, 0x75, 0x2A, 0xF0, 0x97, 0x41, 0xE3, 0x5C, 0xB9, 0x66, 0x0D, 0xAF, 0x52,
60+
0x23, 0xC4, 0x8E, 0x19, 0x74, 0xAB, 0x2F, 0xD0, 0x39, 0x6B, 0x84, 0xFC, 0x14, 0x7E, 0x93, 0x27,
61+
0x5D, 0x86, 0x1C, 0xA8, 0x72, 0x30, 0xB7, 0x4F, 0x09, 0xE1, 0xCA, 0x53, 0x2D, 0x94, 0xBA, 0x68,
62+
0x0E, 0xF5, 0x48, 0x16, 0x7F, 0xAE, 0x21, 0x6C, 0x9D, 0x82, 0x0B, 0xF2, 0x5A, 0x37, 0xCC, 0x18,
63+
0x4A, 0x6E, 0x95, 0xBD, 0x33, 0x57, 0xA1, 0x08, 0xDF, 0x20, 0x69, 0xE7, 0x12, 0x8B, 0xF4, 0x3D,
64+
};
6065
bsoncxx::types::b_binary local_master_key{bsoncxx::binary_sub_type::k_binary, kKeyLength, key_storage};
6166

6267
auto kms_providers = document{} << "local" << open_document << "key" << local_master_key << close_document

src/mongocxx/lib/mongocxx/v_noabi/mongocxx/exception/private/mongoc_error.hh

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ inline std::error_code make_error_code(::bson_error_t const& error) {
3535
}
3636

3737
inline void set_bson_error_message(bson_error_t* error, char const* msg) {
38-
bson_strncpy(error->message, msg, std::min(strlen(msg) + 1, static_cast<size_t>(BSON_ERROR_BUFFER_SIZE)));
38+
bson_strncpy(error->message, msg, BSON_ERROR_BUFFER_SIZE);
3939
}
4040

4141
inline void make_bson_error(bson_error_t* error, operation_exception const& e) {

0 commit comments

Comments
 (0)