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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
|
/*
* Copyright 2018-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.
*/
#include "mongocrypt-buffer-private.h"
#include "mongocrypt-endian-private.h"
#include "mongocrypt-util-private.h"
#include <bson/bson.h>
// Require libbson 1.16.0 or newer. Fix for CDRIVER-3360 is needed.
#if !BSON_CHECK_VERSION(1, 16, 0)
#error "libbson 1.16.0 or newer is required."
#endif
#define INT32_LEN 4
#define TYPE_LEN 1
#define NULL_BYTE_LEN 1
#define NULL_BYTE_VAL 0x00
/* if a buffer is not owned, copy the data and make it owned. */
static void _make_owned(_mongocrypt_buffer_t *buf) {
uint8_t *tmp;
BSON_ASSERT_PARAM(buf);
if (buf->owned) {
return;
}
tmp = buf->data;
if (buf->len > 0) {
buf->data = bson_malloc(buf->len);
BSON_ASSERT(buf->data);
memcpy(buf->data, tmp, buf->len);
} else {
buf->data = NULL;
}
buf->owned = true;
}
/* TODO CDRIVER-2990 have buffer operations require initialized buffer to
* prevent leaky code. */
void _mongocrypt_buffer_init(_mongocrypt_buffer_t *buf) {
BSON_ASSERT_PARAM(buf);
memset(buf, 0, sizeof(*buf));
}
void _mongocrypt_buffer_resize(_mongocrypt_buffer_t *buf, uint32_t len) {
BSON_ASSERT_PARAM(buf);
/* Currently this just wipes whatever was in data before,
but a fancier implementation could copy over up to 'len'
bytes from the old buffer to the new one. */
if (buf->owned) {
buf->data = bson_realloc(buf->data, len);
buf->len = len;
return;
}
buf->data = bson_malloc(len);
BSON_ASSERT(buf->data);
buf->len = len;
buf->owned = true;
}
void _mongocrypt_buffer_init_size(_mongocrypt_buffer_t *buf, uint32_t len) {
BSON_ASSERT_PARAM(buf);
_mongocrypt_buffer_init(buf);
_mongocrypt_buffer_resize(buf, len);
}
void _mongocrypt_buffer_steal(_mongocrypt_buffer_t *buf, _mongocrypt_buffer_t *src) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(src);
if (!src->owned) {
_mongocrypt_buffer_copy_to(src, buf);
_mongocrypt_buffer_init(src);
return;
}
buf->data = src->data;
buf->len = src->len;
buf->owned = true;
_mongocrypt_buffer_init(src);
}
bool _mongocrypt_buffer_from_binary_iter(_mongocrypt_buffer_t *buf, bson_iter_t *iter) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(iter);
if (!BSON_ITER_HOLDS_BINARY(iter)) {
return false;
}
_mongocrypt_buffer_init(buf);
bson_iter_binary(iter, &buf->subtype, &buf->len, (const uint8_t **)&buf->data);
buf->owned = false;
return true;
}
bool _mongocrypt_buffer_copy_from_binary_iter(_mongocrypt_buffer_t *buf, bson_iter_t *iter) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(iter);
if (!_mongocrypt_buffer_from_binary_iter(buf, iter)) {
return false;
}
_make_owned(buf);
return true;
}
bool _mongocrypt_buffer_from_document_iter(_mongocrypt_buffer_t *buf, bson_iter_t *iter) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(iter);
if (!BSON_ITER_HOLDS_DOCUMENT(iter)) {
return false;
}
_mongocrypt_buffer_init(buf);
bson_iter_document(iter, &buf->len, (const uint8_t **)&buf->data);
buf->owned = false;
return true;
}
bool _mongocrypt_buffer_copy_from_document_iter(_mongocrypt_buffer_t *buf, bson_iter_t *iter) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(iter);
if (!_mongocrypt_buffer_from_document_iter(buf, iter)) {
return false;
}
_make_owned(buf);
return true;
}
void _mongocrypt_buffer_steal_from_bson(_mongocrypt_buffer_t *buf, bson_t *bson) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(bson);
_mongocrypt_buffer_init(buf);
buf->data = bson_destroy_with_steal(bson, true, &buf->len);
buf->owned = true;
}
void _mongocrypt_buffer_from_bson(_mongocrypt_buffer_t *buf, const bson_t *bson) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(bson);
_mongocrypt_buffer_init(buf);
buf->data = (uint8_t *)bson_get_data(bson);
buf->len = bson->len;
buf->owned = false;
}
bool _mongocrypt_buffer_to_bson(const _mongocrypt_buffer_t *buf, bson_t *bson) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(bson);
return bson_init_static(bson, buf->data, buf->len);
}
bool _mongocrypt_buffer_append(const _mongocrypt_buffer_t *buf, bson_t *bson, const char *key, int key_len) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(bson);
BSON_ASSERT_PARAM(key);
return bson_append_binary(bson, key, key_len, buf->subtype, buf->data, buf->len);
}
void _mongocrypt_buffer_from_binary(_mongocrypt_buffer_t *buf, const mongocrypt_binary_t *binary) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(binary);
_mongocrypt_buffer_init(buf);
buf->data = binary->data;
buf->len = binary->len;
buf->owned = false;
}
void _mongocrypt_buffer_copy_from_binary(_mongocrypt_buffer_t *buf, const struct _mongocrypt_binary_t *binary) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(binary);
_mongocrypt_buffer_from_binary(buf, binary);
_make_owned(buf);
}
void _mongocrypt_buffer_to_binary(const _mongocrypt_buffer_t *buf, mongocrypt_binary_t *binary) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(binary);
binary->data = buf->data;
binary->len = buf->len;
}
void _mongocrypt_buffer_copy_to(const _mongocrypt_buffer_t *src, _mongocrypt_buffer_t *dst) {
if (src == dst) {
return;
}
BSON_ASSERT_PARAM(src);
BSON_ASSERT_PARAM(dst);
_mongocrypt_buffer_cleanup(dst);
if (src->len == 0) {
return;
}
dst->data = bson_malloc((size_t)src->len);
BSON_ASSERT(dst->data);
memcpy(dst->data, src->data, src->len);
dst->len = src->len;
dst->subtype = src->subtype;
dst->owned = true;
}
void _mongocrypt_buffer_set_to(const _mongocrypt_buffer_t *src, _mongocrypt_buffer_t *dst) {
if (src == dst) {
return;
}
BSON_ASSERT_PARAM(src);
BSON_ASSERT_PARAM(dst);
dst->data = src->data;
dst->len = src->len;
dst->subtype = src->subtype;
dst->owned = false;
}
int _mongocrypt_buffer_cmp(const _mongocrypt_buffer_t *a, const _mongocrypt_buffer_t *b) {
BSON_ASSERT_PARAM(a);
BSON_ASSERT_PARAM(b);
if (a->len != b->len) {
return a->len > b->len ? 1 : -1;
}
if (0 == a->len) {
return 0;
}
return memcmp(a->data, b->data, a->len);
}
void _mongocrypt_buffer_cleanup(_mongocrypt_buffer_t *buf) {
if (buf && buf->owned) {
bson_free(buf->data);
}
}
bool _mongocrypt_buffer_empty(const _mongocrypt_buffer_t *buf) {
BSON_ASSERT_PARAM(buf);
return buf->data == NULL;
}
bool _mongocrypt_buffer_to_bson_value(_mongocrypt_buffer_t *plaintext, uint8_t type, bson_value_t *out) {
bool ret = false;
bson_iter_t iter;
bson_t wrapper;
uint32_t data_len;
uint32_t le_data_len;
uint8_t *data;
uint8_t data_prefix;
BSON_ASSERT_PARAM(plaintext);
BSON_ASSERT_PARAM(out);
data_prefix = INT32_LEN /* adds document size */
+ TYPE_LEN /* element type */
+ NULL_BYTE_LEN; /* and doc's null byte terminator */
BSON_ASSERT(plaintext->len <= UINT32_MAX - data_prefix - NULL_BYTE_LEN);
data_len = (plaintext->len + data_prefix + NULL_BYTE_LEN);
le_data_len = BSON_UINT32_TO_LE(data_len);
data = bson_malloc0(data_len);
BSON_ASSERT(data);
memcpy(data + data_prefix, plaintext->data, plaintext->len);
memcpy(data, &le_data_len, INT32_LEN);
memcpy(data + INT32_LEN, &type, TYPE_LEN);
data[data_len - 1] = NULL_BYTE_VAL;
if (!bson_init_static(&wrapper, data, data_len)) {
goto fail;
}
if (!bson_validate(&wrapper, BSON_VALIDATE_NONE, NULL)) {
goto fail;
}
if (!bson_iter_init_find(&iter, &wrapper, "")) {
goto fail;
}
bson_value_copy(bson_iter_value(&iter), out);
ret = true;
fail:
bson_free(data);
return ret;
}
static void _mongocrypt_buffer_copy_as_bson_value(_mongocrypt_buffer_t *plaintext,
bool (*append_func)(bson_t *bson, const void *data, int len),
const void *data,
int len) {
bson_t wrapper = BSON_INITIALIZER;
int32_t offset = INT32_LEN /* skips document size */
+ TYPE_LEN /* element type */
+ NULL_BYTE_LEN; /* and the key's null byte terminator */
uint8_t *wrapper_data;
BSON_ASSERT_PARAM(plaintext);
BSON_ASSERT_PARAM(append_func);
/* It is not straightforward to transform a bson_value_t to a string of
* bytes. As a workaround, we wrap the value in a bson document with an empty
* key, then use the raw buffer from inside the new bson_t, skipping the
* length and type header information and the key name. */
append_func(&wrapper, data, len);
wrapper_data = ((uint8_t *)bson_get_data(&wrapper));
BSON_ASSERT(wrapper.len >= (uint32_t)offset + NULL_BYTE_LEN);
plaintext->len = wrapper.len - (uint32_t)offset - NULL_BYTE_LEN; /* the final null byte */
plaintext->data = bson_malloc(plaintext->len);
BSON_ASSERT(plaintext->data);
plaintext->owned = true;
memcpy(plaintext->data, wrapper_data + offset, plaintext->len);
bson_destroy(&wrapper);
}
static bool _append_iter(bson_t *bson, const void *iter, int len) {
return bson_append_iter(bson, "", 0, (const bson_iter_t *)iter);
}
static bool _append_utf8(bson_t *bson, const void *str, int len) {
return bson_append_utf8(bson, "", 0, (const char *)str, len);
}
void _mongocrypt_buffer_copy_from_string_as_bson_value(_mongocrypt_buffer_t *plaintext, const char *str, int len) {
BSON_ASSERT_PARAM(str);
BSON_ASSERT(len >= 0);
_mongocrypt_buffer_copy_as_bson_value(plaintext, _append_utf8, str, len);
}
void _mongocrypt_buffer_from_iter(_mongocrypt_buffer_t *plaintext, bson_iter_t *iter) {
BSON_ASSERT_PARAM(iter);
_mongocrypt_buffer_copy_as_bson_value(plaintext, _append_iter, iter, 0);
}
bool _mongocrypt_buffer_from_uuid_iter(_mongocrypt_buffer_t *buf, bson_iter_t *iter) {
const uint8_t *data;
bson_subtype_t subtype;
uint32_t len;
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(iter);
if (!BSON_ITER_HOLDS_BINARY(iter)) {
return false;
}
bson_iter_binary(iter, &subtype, &len, &data);
if (subtype != BSON_SUBTYPE_UUID) {
return false;
}
if (len != UUID_LEN) {
return false;
}
_mongocrypt_buffer_init(buf);
buf->data = (uint8_t *)data;
buf->len = len;
buf->subtype = subtype;
buf->owned = false;
return true;
}
bool _mongocrypt_buffer_copy_from_uuid_iter(_mongocrypt_buffer_t *buf, bson_iter_t *iter) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(iter);
if (!_mongocrypt_buffer_from_uuid_iter(buf, iter)) {
return false;
}
_make_owned(buf);
return true;
}
bool _mongocrypt_buffer_is_uuid(_mongocrypt_buffer_t *buf) {
BSON_ASSERT_PARAM(buf);
return buf->len == UUID_LEN && buf->subtype == BSON_SUBTYPE_UUID;
}
void _mongocrypt_buffer_copy_from_hex(_mongocrypt_buffer_t *buf, const char *hex) {
uint32_t i;
size_t hex_len;
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(hex);
hex_len = strlen(hex);
if (hex_len == 0) {
_mongocrypt_buffer_init(buf);
return;
}
BSON_ASSERT(hex_len / 2u <= UINT32_MAX);
buf->len = (uint32_t)(hex_len / 2u);
buf->data = bson_malloc(buf->len);
BSON_ASSERT(buf->data);
buf->owned = true;
for (i = 0; i < buf->len; i++) {
uint32_t tmp;
BSON_ASSERT(i <= UINT32_MAX / 2);
BSON_ASSERT(sscanf(hex + (2 * i), "%02x", &tmp));
*(buf->data + i) = (uint8_t)tmp;
}
}
int _mongocrypt_buffer_cmp_hex(_mongocrypt_buffer_t *buf, const char *hex) {
_mongocrypt_buffer_t tmp;
int res;
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(hex);
_mongocrypt_buffer_copy_from_hex(&tmp, hex);
res = _mongocrypt_buffer_cmp(buf, &tmp);
_mongocrypt_buffer_cleanup(&tmp);
return res;
}
char *_mongocrypt_buffer_to_hex(_mongocrypt_buffer_t *buf) {
BSON_ASSERT_PARAM(buf);
/* since buf->len is a uint32_t, even doubling it won't bring it anywhere
* near to SIZE_MAX */
char *hex = bson_malloc0(buf->len * 2 + 1);
BSON_ASSERT(hex);
char *out = hex;
for (uint32_t i = 0; i < buf->len; i++, out += 2) {
sprintf(out, "%02X", buf->data[i]);
}
return hex;
}
bool _mongocrypt_buffer_concat(_mongocrypt_buffer_t *dst, const _mongocrypt_buffer_t *srcs, uint32_t num_srcs) {
uint32_t total = 0;
uint32_t offset;
uint32_t i;
BSON_ASSERT_PARAM(dst);
BSON_ASSERT_PARAM(srcs);
for (i = 0; i < num_srcs; i++) {
uint32_t old_total = total;
total += srcs[i].len;
/* If the previous operation overflowed, then total will have a smaller
* value than previously. */
if (total < old_total) {
return false;
}
}
_mongocrypt_buffer_init(dst);
_mongocrypt_buffer_resize(dst, total);
offset = 0;
for (i = 0; i < num_srcs; i++) {
if (srcs[i].len) {
memcpy(dst->data + offset, srcs[i].data, srcs[i].len);
}
offset += srcs[i].len;
}
return true;
}
struct _mongocrypt_binary_t *_mongocrypt_buffer_as_binary(_mongocrypt_buffer_t *buf) {
BSON_ASSERT_PARAM(buf);
buf->bin.data = buf->data;
buf->bin.len = buf->len;
return &buf->bin;
}
bool _mongocrypt_buffer_copy_from_data_and_size(_mongocrypt_buffer_t *buf, const uint8_t *data, size_t len) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(data);
_mongocrypt_buffer_init(buf);
if (!size_to_uint32(len, &buf->len)) {
return false;
}
if ((buf->data = bson_malloc(len))) {
memcpy(buf->data, data, len);
buf->owned = true;
}
return true;
}
bool _mongocrypt_buffer_steal_from_data_and_size(_mongocrypt_buffer_t *buf, uint8_t *data, size_t len) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(data);
_mongocrypt_buffer_init(buf);
if (!size_to_uint32(len, &buf->len)) {
return false;
}
buf->data = data;
buf->owned = true;
return true;
}
bool _mongocrypt_buffer_steal_from_string(_mongocrypt_buffer_t *buf, char *str) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(str);
_mongocrypt_buffer_init(buf);
if (!size_to_uint32(strlen(str), &buf->len)) {
return false;
}
buf->data = (uint8_t *)str;
buf->owned = true;
return true;
}
bool _mongocrypt_buffer_from_string(_mongocrypt_buffer_t *buf, const char *str) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(str);
_mongocrypt_buffer_init(buf);
if (!size_to_uint32(strlen(str), &buf->len)) {
return false;
}
buf->data = (uint8_t *)str;
buf->owned = false;
return true;
}
void _mongocrypt_buffer_from_data(_mongocrypt_buffer_t *buf, const uint8_t *data, uint32_t len) {
BSON_ASSERT_PARAM(buf);
BSON_ASSERT_PARAM(data);
_mongocrypt_buffer_init(buf);
buf->data = (uint8_t *)data;
buf->len = len;
buf->owned = false;
}
void _mongocrypt_buffer_copy_from_uint64_le(_mongocrypt_buffer_t *buf, uint64_t value) {
uint64_t value_le = MONGOCRYPT_UINT64_TO_LE(value);
BSON_ASSERT_PARAM(buf);
_mongocrypt_buffer_init(buf);
_mongocrypt_buffer_resize(buf, sizeof(value));
memcpy(buf->data, &value_le, buf->len);
}
bool _mongocrypt_buffer_from_subrange(_mongocrypt_buffer_t *out,
const _mongocrypt_buffer_t *in,
uint32_t offset,
uint32_t len) {
BSON_ASSERT_PARAM(out);
BSON_ASSERT_PARAM(in);
_mongocrypt_buffer_init(out);
BSON_ASSERT(offset <= UINT32_MAX - len);
if (offset + len > in->len) {
return false;
}
out->data = in->data + offset;
out->len = len;
return true;
}
|