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
|
#include "aws/s3/private/s3_checksums.h"
#include "aws/s3/private/s3_util.h"
#include <aws/cal/hash.h>
#include <aws/checksums/crc.h>
#include <aws/http/request_response.h>
#define AWS_CRC32_LEN sizeof(uint32_t)
#define AWS_CRC32C_LEN sizeof(uint32_t)
#define AWS_CRC64_LEN sizeof(uint64_t)
static const struct aws_byte_cursor s_crc64nvme_algorithm_value = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("CRC64NVME");
static const struct aws_byte_cursor s_crc32c_algorithm_value = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("CRC32C");
static const struct aws_byte_cursor s_crc32_algorithm_value = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("CRC32");
static const struct aws_byte_cursor s_sha1_algorithm_value = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("SHA1");
static const struct aws_byte_cursor s_sha256_algorithm_value = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("SHA256");
static const struct aws_byte_cursor s_crc64nvme_header_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("x-amz-checksum-crc64nvme");
static const struct aws_byte_cursor s_crc32c_header_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("x-amz-checksum-crc32c");
static const struct aws_byte_cursor s_crc32_header_name = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("x-amz-checksum-crc32");
static const struct aws_byte_cursor s_sha1_header_name = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("x-amz-checksum-sha1");
static const struct aws_byte_cursor s_sha256_header_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("x-amz-checksum-sha256");
static const struct aws_byte_cursor s_crc64nvme_completed_part_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("ChecksumCRC64NVME");
static const struct aws_byte_cursor s_crc32c_completed_part_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("ChecksumCRC32C");
static const struct aws_byte_cursor s_crc32_completed_part_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("ChecksumCRC32");
static const struct aws_byte_cursor s_sha1_completed_part_name = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("ChecksumSHA1");
static const struct aws_byte_cursor s_sha256_completed_part_name =
AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("ChecksumSHA256");
static const struct aws_byte_cursor s_empty_cursor = {
.len = 0,
.ptr = NULL,
};
size_t aws_get_digest_size_from_checksum_algorithm(enum aws_s3_checksum_algorithm algorithm) {
switch (algorithm) {
case AWS_SCA_CRC64NVME:
return AWS_CRC64_LEN;
case AWS_SCA_CRC32C:
return AWS_CRC32C_LEN;
case AWS_SCA_CRC32:
return AWS_CRC32_LEN;
case AWS_SCA_SHA1:
return AWS_SHA1_LEN;
case AWS_SCA_SHA256:
return AWS_SHA256_LEN;
default:
return 0;
}
}
struct aws_byte_cursor aws_get_http_header_name_from_checksum_algorithm(enum aws_s3_checksum_algorithm algorithm) {
switch (algorithm) {
case AWS_SCA_CRC64NVME:
return s_crc64nvme_header_name;
case AWS_SCA_CRC32C:
return s_crc32c_header_name;
case AWS_SCA_CRC32:
return s_crc32_header_name;
case AWS_SCA_SHA1:
return s_sha1_header_name;
case AWS_SCA_SHA256:
return s_sha256_header_name;
default:
return s_empty_cursor;
}
}
struct aws_byte_cursor aws_get_checksum_algorithm_name(enum aws_s3_checksum_algorithm algorithm) {
switch (algorithm) {
case AWS_SCA_CRC64NVME:
return s_crc64nvme_algorithm_value;
case AWS_SCA_CRC32C:
return s_crc32c_algorithm_value;
case AWS_SCA_CRC32:
return s_crc32_algorithm_value;
case AWS_SCA_SHA1:
return s_sha1_algorithm_value;
case AWS_SCA_SHA256:
return s_sha256_algorithm_value;
default:
return s_empty_cursor;
}
}
struct aws_byte_cursor aws_get_completed_part_name_from_checksum_algorithm(enum aws_s3_checksum_algorithm algorithm) {
switch (algorithm) {
case AWS_SCA_CRC64NVME:
return s_crc64nvme_completed_part_name;
case AWS_SCA_CRC32C:
return s_crc32c_completed_part_name;
case AWS_SCA_CRC32:
return s_crc32_completed_part_name;
case AWS_SCA_SHA1:
return s_sha1_completed_part_name;
case AWS_SCA_SHA256:
return s_sha256_completed_part_name;
default:
return s_empty_cursor;
}
}
void s3_hash_destroy(struct aws_s3_checksum *checksum) {
struct aws_hash *hash = checksum->impl.hash;
aws_hash_destroy(hash);
aws_mem_release(checksum->allocator, checksum);
}
int s3_hash_update(struct aws_s3_checksum *checksum, const struct aws_byte_cursor *to_checksum) {
return aws_hash_update(checksum->impl.hash, to_checksum);
}
int s3_hash_finalize(struct aws_s3_checksum *checksum, struct aws_byte_buf *output) {
checksum->good = false;
return aws_hash_finalize(checksum->impl.hash, output, 0);
}
static int s_crc_finalize_helper(struct aws_s3_checksum *checksum, struct aws_byte_buf *out) {
AWS_PRECONDITION(aws_byte_buf_is_valid(out));
if (!checksum->good) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
checksum->good = false;
size_t len = checksum->digest_size;
if (out->capacity - out->len < len) {
return aws_raise_error(AWS_ERROR_SHORT_BUFFER);
}
if (checksum->digest_size == AWS_CRC32_LEN) {
if (aws_byte_buf_write_be32(out, checksum->impl.crc_val_32bit)) {
return AWS_OP_SUCCESS;
}
} else {
if (aws_byte_buf_write_be64(out, checksum->impl.crc_val_64bit)) {
return AWS_OP_SUCCESS;
}
}
return aws_raise_error(AWS_ERROR_INVALID_BUFFER_SIZE);
}
static int s_crc32_finalize(struct aws_s3_checksum *checksum, struct aws_byte_buf *out) {
return s_crc_finalize_helper(checksum, out);
}
static int s_crc64_finalize(struct aws_s3_checksum *checksum, struct aws_byte_buf *out) {
return s_crc_finalize_helper(checksum, out);
}
static int s_crc32_checksum_update(struct aws_s3_checksum *checksum, const struct aws_byte_cursor *buf) {
if (!checksum->good) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
checksum->impl.crc_val_32bit = aws_checksums_crc32_ex(buf->ptr, buf->len, checksum->impl.crc_val_32bit);
return AWS_OP_SUCCESS;
}
static int s_crc32c_checksum_update(struct aws_s3_checksum *checksum, const struct aws_byte_cursor *buf) {
if (!checksum->good) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
checksum->impl.crc_val_32bit = aws_checksums_crc32c_ex(buf->ptr, buf->len, checksum->impl.crc_val_32bit);
return AWS_OP_SUCCESS;
}
static int s_crc64nvme_checksum_update(struct aws_s3_checksum *checksum, const struct aws_byte_cursor *buf) {
if (!checksum->good) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
checksum->impl.crc_val_64bit = aws_checksums_crc64nvme_ex(buf->ptr, buf->len, checksum->impl.crc_val_64bit);
return AWS_OP_SUCCESS;
}
static void s_crc_destroy(struct aws_s3_checksum *checksum) {
aws_mem_release(checksum->allocator, checksum);
}
static struct aws_checksum_vtable hash_vtable = {
.update = s3_hash_update,
.finalize = s3_hash_finalize,
.destroy = s3_hash_destroy,
};
static struct aws_checksum_vtable crc32_vtable = {
.update = s_crc32_checksum_update,
.finalize = s_crc32_finalize,
.destroy = s_crc_destroy,
};
static struct aws_checksum_vtable crc32c_vtable = {
.update = s_crc32c_checksum_update,
.finalize = s_crc32_finalize,
.destroy = s_crc_destroy,
};
static struct aws_checksum_vtable crc64nvme_vtable = {
.update = s_crc64nvme_checksum_update,
.finalize = s_crc64_finalize,
.destroy = s_crc_destroy,
};
struct aws_s3_checksum *aws_hash_new(struct aws_allocator *allocator, aws_hash_new_fn hash_fn) {
struct aws_s3_checksum *checksum = aws_mem_calloc(allocator, 1, sizeof(struct aws_s3_checksum));
struct aws_hash *hash = hash_fn(allocator);
if (!hash) {
aws_mem_release(allocator, checksum);
aws_raise_error(aws_last_error_or_unknown());
return NULL;
}
checksum->impl.hash = hash;
checksum->allocator = allocator;
checksum->vtable = &hash_vtable;
checksum->good = true;
checksum->digest_size = hash->digest_size;
return checksum;
}
static struct aws_s3_checksum *s_crc32_checksum_new(struct aws_allocator *allocator) {
struct aws_s3_checksum *checksum = aws_mem_calloc(allocator, 1, sizeof(struct aws_s3_checksum));
checksum->vtable = &crc32_vtable;
checksum->allocator = allocator;
checksum->impl.crc_val_32bit = 0;
checksum->good = true;
checksum->digest_size = AWS_CRC32_LEN;
return checksum;
}
static struct aws_s3_checksum *s_crc32c_checksum_new(struct aws_allocator *allocator) {
struct aws_s3_checksum *checksum = aws_mem_calloc(allocator, 1, sizeof(struct aws_s3_checksum));
checksum->vtable = &crc32c_vtable;
checksum->allocator = allocator;
checksum->impl.crc_val_32bit = 0;
checksum->good = true;
checksum->digest_size = AWS_CRC32C_LEN;
return checksum;
}
static struct aws_s3_checksum *s_crc64nvme_checksum_new(struct aws_allocator *allocator) {
struct aws_s3_checksum *checksum = aws_mem_calloc(allocator, 1, sizeof(struct aws_s3_checksum));
checksum->vtable = &crc64nvme_vtable;
checksum->allocator = allocator;
checksum->impl.crc_val_64bit = 0;
checksum->good = true;
checksum->digest_size = AWS_CRC64_LEN;
return checksum;
}
struct aws_s3_checksum *aws_checksum_new(struct aws_allocator *allocator, enum aws_s3_checksum_algorithm algorithm) {
struct aws_s3_checksum *checksum = NULL;
switch (algorithm) {
case AWS_SCA_CRC64NVME:
checksum = s_crc64nvme_checksum_new(allocator);
break;
case AWS_SCA_CRC32C:
checksum = s_crc32c_checksum_new(allocator);
break;
case AWS_SCA_CRC32:
checksum = s_crc32_checksum_new(allocator);
break;
case AWS_SCA_SHA1:
checksum = aws_hash_new(allocator, aws_sha1_new);
break;
case AWS_SCA_SHA256:
checksum = aws_hash_new(allocator, aws_sha256_new);
break;
default:
return NULL;
}
if (checksum != NULL) {
checksum->algorithm = algorithm;
}
return checksum;
}
void aws_checksum_destroy(struct aws_s3_checksum *checksum) {
if (checksum != NULL) {
checksum->vtable->destroy(checksum);
}
}
int aws_checksum_update(struct aws_s3_checksum *checksum, const struct aws_byte_cursor *to_checksum) {
AWS_PRECONDITION(checksum);
return checksum->vtable->update(checksum, to_checksum);
}
int aws_checksum_finalize(struct aws_s3_checksum *checksum, struct aws_byte_buf *output) {
AWS_PRECONDITION(checksum);
return checksum->vtable->finalize(checksum, output);
}
static int s_checksum_compute_fn(
struct aws_allocator *allocator,
const struct aws_byte_cursor *input,
struct aws_byte_buf *output,
struct aws_s3_checksum *(*s_crc_new)(struct aws_allocator *)) {
struct aws_s3_checksum *checksum = s_crc_new(allocator);
if (aws_checksum_update(checksum, input)) {
aws_checksum_destroy(checksum);
return AWS_OP_ERR;
}
if (aws_checksum_finalize(checksum, output)) {
aws_checksum_destroy(checksum);
return AWS_OP_ERR;
}
aws_checksum_destroy(checksum);
return AWS_OP_SUCCESS;
}
int aws_checksum_compute(
struct aws_allocator *allocator,
enum aws_s3_checksum_algorithm algorithm,
const struct aws_byte_cursor *input,
struct aws_byte_buf *output) {
switch (algorithm) {
case AWS_SCA_SHA1:
return aws_sha1_compute(allocator, input, output, 0);
case AWS_SCA_SHA256:
return aws_sha256_compute(allocator, input, output, 0);
case AWS_SCA_CRC64NVME:
return s_checksum_compute_fn(allocator, input, output, s_crc64nvme_checksum_new);
case AWS_SCA_CRC32:
return s_checksum_compute_fn(allocator, input, output, s_crc32_checksum_new);
case AWS_SCA_CRC32C:
return s_checksum_compute_fn(allocator, input, output, s_crc32c_checksum_new);
default:
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
}
static int s_init_and_verify_checksum_config_from_headers(
struct checksum_config_storage *checksum_config,
const struct aws_http_message *message,
const void *log_id) {
/* Check if the checksum header was set from the message */
struct aws_http_headers *headers = aws_http_message_get_headers(message);
enum aws_s3_checksum_algorithm header_algo = AWS_SCA_NONE;
struct aws_byte_cursor header_value;
AWS_ZERO_STRUCT(header_value);
for (size_t i = 0; i < AWS_ARRAY_SIZE(s_checksum_algo_priority_list); i++) {
enum aws_s3_checksum_algorithm algorithm = s_checksum_algo_priority_list[i];
const struct aws_byte_cursor algorithm_header_name =
aws_get_http_header_name_from_checksum_algorithm(algorithm);
if (aws_http_headers_get(headers, algorithm_header_name, &header_value) == AWS_OP_SUCCESS) {
if (header_algo == AWS_SCA_NONE) {
header_algo = algorithm;
} else {
/* If there are multiple checksum headers set, it's malformed request */
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not create auto-ranged-put meta request; multiple checksum headers has been set",
log_id);
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
}
}
if (header_algo == AWS_SCA_NONE) {
/* No checksum header found, done */
return AWS_OP_SUCCESS;
}
if (checksum_config->has_full_object_checksum) {
/* If the full object checksum has been set, it's malformed request */
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not create auto-ranged-put meta request; full object checksum is set from multiple ways.",
log_id);
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p Setting the full-object checksum from header; algorithm: " PRInSTR ", value: " PRInSTR ".",
log_id,
AWS_BYTE_CURSOR_PRI(aws_get_checksum_algorithm_name(header_algo)),
AWS_BYTE_CURSOR_PRI(header_value));
/* Set algo */
checksum_config->checksum_algorithm = header_algo;
/**
* Set the location to NONE to avoid adding extra checksums from client.
*
* Notes: The multipart upload will set the location to trailer to add parts level checksums.
**/
checksum_config->location = AWS_SCL_NONE;
/* Set full object checksum from the header value. */
aws_byte_buf_init_copy_from_cursor(
&checksum_config->full_object_checksum, checksum_config->allocator, header_value);
checksum_config->has_full_object_checksum = true;
return AWS_OP_SUCCESS;
}
int aws_checksum_config_storage_init(
struct aws_allocator *allocator,
struct checksum_config_storage *internal_config,
const struct aws_s3_checksum_config *config,
const struct aws_http_message *message,
const void *log_id) {
AWS_ZERO_STRUCT(*internal_config);
/* Zero out the struct and set the allocator regardless. */
internal_config->allocator = allocator;
if (!config) {
return AWS_OP_SUCCESS;
}
struct aws_http_headers *headers = aws_http_message_get_headers(message);
if (config->location == AWS_SCL_TRAILER) {
struct aws_byte_cursor existing_encoding;
AWS_ZERO_STRUCT(existing_encoding);
if (aws_http_headers_get(headers, g_content_encoding_header_name, &existing_encoding) == AWS_OP_SUCCESS) {
if (aws_byte_cursor_find_exact(&existing_encoding, &g_content_encoding_header_aws_chunked, NULL) ==
AWS_OP_SUCCESS) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Cannot create meta s3 request; for trailer checksum, the original request cannot be "
"aws-chunked encoding. The client will encode the request instead.",
(void *)log_id);
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
return AWS_OP_ERR;
}
}
}
if (config->location != AWS_SCL_NONE && config->checksum_algorithm == AWS_SCA_NONE) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Cannot create meta s3 request; checksum location is set, but no checksum algorithm selected.",
(void *)log_id);
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
return AWS_OP_ERR;
}
internal_config->checksum_algorithm = config->checksum_algorithm;
internal_config->location = config->location;
internal_config->validate_response_checksum = config->validate_response_checksum;
internal_config->full_object_checksum_callback = config->full_object_checksum_callback;
internal_config->user_data = config->user_data;
if (internal_config->full_object_checksum_callback) {
/* allocate the full object checksum when the callback was set. */
internal_config->has_full_object_checksum = true;
}
if (config->validate_checksum_algorithms) {
const size_t count = aws_array_list_length(config->validate_checksum_algorithms);
for (size_t i = 0; i < count; ++i) {
enum aws_s3_checksum_algorithm algorithm;
aws_array_list_get_at(config->validate_checksum_algorithms, &algorithm, i);
switch (algorithm) {
case AWS_SCA_CRC64NVME:
internal_config->response_checksum_algorithms.crc64nvme = true;
break;
case AWS_SCA_CRC32C:
internal_config->response_checksum_algorithms.crc32c = true;
break;
case AWS_SCA_CRC32:
internal_config->response_checksum_algorithms.crc32 = true;
break;
case AWS_SCA_SHA1:
internal_config->response_checksum_algorithms.sha1 = true;
break;
case AWS_SCA_SHA256:
internal_config->response_checksum_algorithms.sha256 = true;
break;
default:
break;
}
}
} else if (config->validate_response_checksum) {
internal_config->response_checksum_algorithms.crc64nvme = true;
internal_config->response_checksum_algorithms.crc32 = true;
internal_config->response_checksum_algorithms.crc32c = true;
internal_config->response_checksum_algorithms.sha1 = true;
internal_config->response_checksum_algorithms.sha256 = true;
}
/* After applying settings from config, check the message header to override the corresponding settings. */
if (s_init_and_verify_checksum_config_from_headers(internal_config, message, log_id)) {
return AWS_OP_ERR;
}
/* Anything fail afterward will need to cleanup the storage. */
return AWS_OP_SUCCESS;
}
void aws_checksum_config_storage_cleanup(struct checksum_config_storage *internal_config) {
if (internal_config->has_full_object_checksum) {
aws_byte_buf_clean_up(&internal_config->full_object_checksum);
}
}
|