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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/auth/credentials.h>
#include <aws/auth/private/credentials_utils.h>
#include <aws/common/clock.h>
#include <aws/common/date_time.h>
#include <aws/common/string.h>
#include <aws/http/connection.h>
#include <aws/http/connection_manager.h>
#include <aws/http/request_response.h>
#include <aws/http/status_code.h>
#include <aws/io/logging.h>
#include <aws/io/socket.h>
#include <aws/io/tls_channel_handler.h>
#include <aws/io/uri.h>
#if defined(_MSC_VER)
# pragma warning(disable : 4204)
# pragma warning(disable : 4232)
#endif /* _MSC_VER */
/* ecs task role credentials body response is currently ~ 1300 characters + name length */
#define ECS_RESPONSE_SIZE_INITIAL 2048
#define ECS_RESPONSE_SIZE_LIMIT 10000
#define ECS_CONNECT_TIMEOUT_DEFAULT_IN_SECONDS 2
static void s_on_connection_manager_shutdown(void *user_data);
struct aws_credentials_provider_ecs_impl {
struct aws_http_connection_manager *connection_manager;
const struct aws_auth_http_system_vtable *function_table;
struct aws_string *host;
struct aws_string *path_and_query;
struct aws_string *auth_token;
};
/*
* Tracking structure for each outstanding async query to an ecs provider
*/
struct aws_credentials_provider_ecs_user_data {
/* immutable post-creation */
struct aws_allocator *allocator;
struct aws_credentials_provider *ecs_provider;
aws_on_get_credentials_callback_fn *original_callback;
void *original_user_data;
/* mutable */
struct aws_http_connection *connection;
struct aws_http_message *request;
struct aws_byte_buf current_result;
int status_code;
int error_code;
};
static void s_aws_credentials_provider_ecs_user_data_destroy(struct aws_credentials_provider_ecs_user_data *user_data) {
if (user_data == NULL) {
return;
}
struct aws_credentials_provider_ecs_impl *impl = user_data->ecs_provider->impl;
if (user_data->connection) {
impl->function_table->aws_http_connection_manager_release_connection(
impl->connection_manager, user_data->connection);
}
aws_byte_buf_clean_up(&user_data->current_result);
if (user_data->request) {
aws_http_message_destroy(user_data->request);
}
aws_credentials_provider_release(user_data->ecs_provider);
aws_mem_release(user_data->allocator, user_data);
}
static struct aws_credentials_provider_ecs_user_data *s_aws_credentials_provider_ecs_user_data_new(
struct aws_credentials_provider *ecs_provider,
aws_on_get_credentials_callback_fn callback,
void *user_data) {
struct aws_credentials_provider_ecs_user_data *wrapped_user_data =
aws_mem_calloc(ecs_provider->allocator, 1, sizeof(struct aws_credentials_provider_ecs_user_data));
if (wrapped_user_data == NULL) {
goto on_error;
}
wrapped_user_data->allocator = ecs_provider->allocator;
wrapped_user_data->ecs_provider = ecs_provider;
aws_credentials_provider_acquire(ecs_provider);
wrapped_user_data->original_user_data = user_data;
wrapped_user_data->original_callback = callback;
if (aws_byte_buf_init(&wrapped_user_data->current_result, ecs_provider->allocator, ECS_RESPONSE_SIZE_INITIAL)) {
goto on_error;
}
return wrapped_user_data;
on_error:
s_aws_credentials_provider_ecs_user_data_destroy(wrapped_user_data);
return NULL;
}
static void s_aws_credentials_provider_ecs_user_data_reset_response(
struct aws_credentials_provider_ecs_user_data *ecs_user_data) {
ecs_user_data->current_result.len = 0;
ecs_user_data->status_code = 0;
if (ecs_user_data->request) {
aws_http_message_destroy(ecs_user_data->request);
ecs_user_data->request = NULL;
}
}
/*
* In general, the ECS document looks something like:
{
"Code" : "Success",
"LastUpdated" : "2019-05-28T18:03:09Z",
"Type" : "AWS-HMAC",
"AccessKeyId" : "...",
"SecretAccessKey" : "...",
"Token" : "...",
"Expiration" : "2019-05-29T00:21:43Z"
}
*
* No matter the result, this always gets called assuming that esc_user_data is successfully allocated
*/
static void s_ecs_finalize_get_credentials_query(struct aws_credentials_provider_ecs_user_data *ecs_user_data) {
/* Try to build credentials from whatever, if anything, was in the result */
struct aws_credentials *credentials = NULL;
struct aws_parse_credentials_from_json_doc_options parse_options = {
.access_key_id_name = "AccessKeyId",
.secret_access_key_name = "SecretAccessKey",
.token_name = "Token",
.expiration_name = "Expiration",
.token_required = true,
.expiration_required = true,
};
if (aws_byte_buf_append_null_terminator(&ecs_user_data->current_result) == AWS_OP_SUCCESS) {
credentials = aws_parse_credentials_from_json_document(
ecs_user_data->allocator, aws_byte_cursor_from_buf(&ecs_user_data->current_result), &parse_options);
} else {
AWS_LOGF_ERROR(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider failed to add null terminating char to resulting buffer.",
(void *)ecs_user_data->ecs_provider);
}
if (credentials != NULL) {
AWS_LOGF_INFO(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider successfully queried instance role credentials",
(void *)ecs_user_data->ecs_provider);
} else {
/* no credentials, make sure we have a valid error to report */
if (ecs_user_data->error_code == AWS_ERROR_SUCCESS) {
ecs_user_data->error_code = aws_last_error();
if (ecs_user_data->error_code == AWS_ERROR_SUCCESS) {
ecs_user_data->error_code = AWS_AUTH_CREDENTIALS_PROVIDER_ECS_SOURCE_FAILURE;
}
}
AWS_LOGF_WARN(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider failed to query instance role credentials with error %d(%s)",
(void *)ecs_user_data->ecs_provider,
ecs_user_data->error_code,
aws_error_str(ecs_user_data->error_code));
}
/* pass the credentials back */
ecs_user_data->original_callback(credentials, ecs_user_data->error_code, ecs_user_data->original_user_data);
/* clean up */
s_aws_credentials_provider_ecs_user_data_destroy(ecs_user_data);
aws_credentials_release(credentials);
}
static int s_ecs_on_incoming_body_fn(
struct aws_http_stream *stream,
const struct aws_byte_cursor *data,
void *user_data) {
(void)stream;
struct aws_credentials_provider_ecs_user_data *ecs_user_data = user_data;
struct aws_credentials_provider_ecs_impl *impl = ecs_user_data->ecs_provider->impl;
AWS_LOGF_TRACE(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider received %zu response bytes",
(void *)ecs_user_data->ecs_provider,
data->len);
if (data->len + ecs_user_data->current_result.len > ECS_RESPONSE_SIZE_LIMIT) {
impl->function_table->aws_http_connection_close(ecs_user_data->connection);
AWS_LOGF_ERROR(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider query response exceeded maximum allowed length",
(void *)ecs_user_data->ecs_provider);
return aws_raise_error(AWS_ERROR_SHORT_BUFFER);
}
if (aws_byte_buf_append_dynamic(&ecs_user_data->current_result, data)) {
impl->function_table->aws_http_connection_close(ecs_user_data->connection);
AWS_LOGF_ERROR(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider query error appending response",
(void *)ecs_user_data->ecs_provider);
return AWS_OP_ERR;
}
return AWS_OP_SUCCESS;
}
static int s_ecs_on_incoming_headers_fn(
struct aws_http_stream *stream,
enum aws_http_header_block header_block,
const struct aws_http_header *header_array,
size_t num_headers,
void *user_data) {
(void)header_array;
(void)num_headers;
if (header_block != AWS_HTTP_HEADER_BLOCK_MAIN) {
return AWS_OP_SUCCESS;
}
struct aws_credentials_provider_ecs_user_data *ecs_user_data = user_data;
if (header_block == AWS_HTTP_HEADER_BLOCK_MAIN) {
if (ecs_user_data->status_code == 0) {
struct aws_credentials_provider_ecs_impl *impl = ecs_user_data->ecs_provider->impl;
if (impl->function_table->aws_http_stream_get_incoming_response_status(
stream, &ecs_user_data->status_code)) {
AWS_LOGF_ERROR(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider failed to get http status code",
(void *)ecs_user_data->ecs_provider);
return AWS_OP_ERR;
}
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) ECS credentials provider query received http status code %d",
(void *)ecs_user_data->ecs_provider,
ecs_user_data->status_code);
}
}
return AWS_OP_SUCCESS;
}
static void s_ecs_query_task_role_credentials(struct aws_credentials_provider_ecs_user_data *ecs_user_data);
static void s_ecs_on_stream_complete_fn(struct aws_http_stream *stream, int error_code, void *user_data) {
struct aws_credentials_provider_ecs_user_data *ecs_user_data = user_data;
aws_http_message_destroy(ecs_user_data->request);
ecs_user_data->request = NULL;
struct aws_credentials_provider_ecs_impl *impl = ecs_user_data->ecs_provider->impl;
impl->function_table->aws_http_stream_release(stream);
/*
* On anything other than a 200, nullify the response and pretend there was
* an error
*/
if (ecs_user_data->status_code != AWS_HTTP_STATUS_CODE_200_OK || error_code != AWS_OP_SUCCESS) {
ecs_user_data->current_result.len = 0;
if (error_code != AWS_OP_SUCCESS) {
ecs_user_data->error_code = error_code;
} else {
ecs_user_data->error_code = AWS_AUTH_CREDENTIALS_PROVIDER_HTTP_STATUS_FAILURE;
}
}
s_ecs_finalize_get_credentials_query(ecs_user_data);
}
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_accept_header, "Accept");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_accept_header_value, "application/json");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_user_agent_header, "User-Agent");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_user_agent_header_value, "aws-sdk-crt/ecs-credentials-provider");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_authorization_header, "Authorization");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_accept_encoding_header, "Accept-Encoding");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_accept_encoding_header_value, "identity");
AWS_STATIC_STRING_FROM_LITERAL(s_ecs_host_header, "Host");
static int s_make_ecs_http_query(
struct aws_credentials_provider_ecs_user_data *ecs_user_data,
struct aws_byte_cursor *uri) {
AWS_FATAL_ASSERT(ecs_user_data->connection);
struct aws_http_stream *stream = NULL;
struct aws_http_message *request = aws_http_message_new_request(ecs_user_data->allocator);
if (request == NULL) {
return AWS_OP_ERR;
}
struct aws_credentials_provider_ecs_impl *impl = ecs_user_data->ecs_provider->impl;
struct aws_http_header host_header = {
.name = aws_byte_cursor_from_string(s_ecs_host_header),
.value = aws_byte_cursor_from_string(impl->host),
};
if (aws_http_message_add_header(request, host_header)) {
goto on_error;
}
if (impl->auth_token != NULL) {
struct aws_http_header auth_header = {
.name = aws_byte_cursor_from_string(s_ecs_authorization_header),
.value = aws_byte_cursor_from_string(impl->auth_token),
};
if (aws_http_message_add_header(request, auth_header)) {
goto on_error;
}
}
struct aws_http_header accept_header = {
.name = aws_byte_cursor_from_string(s_ecs_accept_header),
.value = aws_byte_cursor_from_string(s_ecs_accept_header_value),
};
if (aws_http_message_add_header(request, accept_header)) {
goto on_error;
}
struct aws_http_header accept_encoding_header = {
.name = aws_byte_cursor_from_string(s_ecs_accept_encoding_header),
.value = aws_byte_cursor_from_string(s_ecs_accept_encoding_header_value),
};
if (aws_http_message_add_header(request, accept_encoding_header)) {
goto on_error;
}
struct aws_http_header user_agent_header = {
.name = aws_byte_cursor_from_string(s_ecs_user_agent_header),
.value = aws_byte_cursor_from_string(s_ecs_user_agent_header_value),
};
if (aws_http_message_add_header(request, user_agent_header)) {
goto on_error;
}
if (aws_http_message_set_request_path(request, *uri)) {
goto on_error;
}
if (aws_http_message_set_request_method(request, aws_byte_cursor_from_c_str("GET"))) {
goto on_error;
}
ecs_user_data->request = request;
struct aws_http_make_request_options request_options = {
.self_size = sizeof(request_options),
.on_response_headers = s_ecs_on_incoming_headers_fn,
.on_response_header_block_done = NULL,
.on_response_body = s_ecs_on_incoming_body_fn,
.on_complete = s_ecs_on_stream_complete_fn,
.user_data = ecs_user_data,
.request = request,
};
stream = impl->function_table->aws_http_connection_make_request(ecs_user_data->connection, &request_options);
if (!stream) {
goto on_error;
}
if (impl->function_table->aws_http_stream_activate(stream)) {
goto on_error;
}
return AWS_OP_SUCCESS;
on_error:
impl->function_table->aws_http_stream_release(stream);
aws_http_message_destroy(request);
ecs_user_data->request = NULL;
return AWS_OP_ERR;
}
static void s_ecs_query_task_role_credentials(struct aws_credentials_provider_ecs_user_data *ecs_user_data) {
AWS_FATAL_ASSERT(ecs_user_data->connection);
struct aws_credentials_provider_ecs_impl *impl = ecs_user_data->ecs_provider->impl;
/* "Clear" the result */
s_aws_credentials_provider_ecs_user_data_reset_response(ecs_user_data);
struct aws_byte_cursor uri_cursor = aws_byte_cursor_from_string(impl->path_and_query);
if (s_make_ecs_http_query(ecs_user_data, &uri_cursor) == AWS_OP_ERR) {
s_ecs_finalize_get_credentials_query(ecs_user_data);
}
}
static void s_ecs_on_acquire_connection(struct aws_http_connection *connection, int error_code, void *user_data) {
struct aws_credentials_provider_ecs_user_data *ecs_user_data = user_data;
if (connection == NULL) {
AWS_LOGF_WARN(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"id=%p: ECS provider failed to acquire a connection, error code %d(%s)",
(void *)ecs_user_data->ecs_provider,
error_code,
aws_error_str(error_code));
ecs_user_data->error_code = error_code;
s_ecs_finalize_get_credentials_query(ecs_user_data);
return;
}
ecs_user_data->connection = connection;
s_ecs_query_task_role_credentials(ecs_user_data);
}
static int s_credentials_provider_ecs_get_credentials_async(
struct aws_credentials_provider *provider,
aws_on_get_credentials_callback_fn callback,
void *user_data) {
struct aws_credentials_provider_ecs_impl *impl = provider->impl;
struct aws_credentials_provider_ecs_user_data *wrapped_user_data =
s_aws_credentials_provider_ecs_user_data_new(provider, callback, user_data);
if (wrapped_user_data == NULL) {
goto error;
}
impl->function_table->aws_http_connection_manager_acquire_connection(
impl->connection_manager, s_ecs_on_acquire_connection, wrapped_user_data);
return AWS_OP_SUCCESS;
error:
s_aws_credentials_provider_ecs_user_data_destroy(wrapped_user_data);
return AWS_OP_ERR;
}
static void s_credentials_provider_ecs_destroy(struct aws_credentials_provider *provider) {
struct aws_credentials_provider_ecs_impl *impl = provider->impl;
if (impl == NULL) {
return;
}
aws_string_destroy(impl->path_and_query);
aws_string_destroy(impl->auth_token);
aws_string_destroy(impl->host);
/* aws_http_connection_manager_release will eventually leads to call of s_on_connection_manager_shutdown,
* which will do memory release for provider and impl. So We should be freeing impl
* related memory first, then call aws_http_connection_manager_release.
*/
if (impl->connection_manager) {
impl->function_table->aws_http_connection_manager_release(impl->connection_manager);
} else {
/* If provider setup failed halfway through, connection_manager might not exist.
* In this case invoke shutdown completion callback directly to finish cleanup */
s_on_connection_manager_shutdown(provider);
}
/* freeing the provider takes place in the shutdown callback below */
}
static struct aws_credentials_provider_vtable s_aws_credentials_provider_ecs_vtable = {
.get_credentials = s_credentials_provider_ecs_get_credentials_async,
.destroy = s_credentials_provider_ecs_destroy,
};
static void s_on_connection_manager_shutdown(void *user_data) {
struct aws_credentials_provider *provider = user_data;
aws_credentials_provider_invoke_shutdown_callback(provider);
aws_mem_release(provider->allocator, provider);
}
struct aws_credentials_provider *aws_credentials_provider_new_ecs(
struct aws_allocator *allocator,
const struct aws_credentials_provider_ecs_options *options) {
struct aws_credentials_provider *provider = NULL;
struct aws_credentials_provider_ecs_impl *impl = NULL;
aws_mem_acquire_many(
allocator,
2,
&provider,
sizeof(struct aws_credentials_provider),
&impl,
sizeof(struct aws_credentials_provider_ecs_impl));
if (!provider) {
return NULL;
}
AWS_ZERO_STRUCT(*provider);
AWS_ZERO_STRUCT(*impl);
aws_credentials_provider_init_base(provider, allocator, &s_aws_credentials_provider_ecs_vtable, impl);
struct aws_tls_connection_options tls_connection_options;
AWS_ZERO_STRUCT(tls_connection_options);
if (options->tls_ctx) {
aws_tls_connection_options_init_from_ctx(&tls_connection_options, options->tls_ctx);
struct aws_byte_cursor host = options->host;
if (aws_tls_connection_options_set_server_name(&tls_connection_options, allocator, &host)) {
AWS_LOGF_ERROR(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p): failed to create a tls connection options with error %s",
(void *)provider,
aws_error_debug_str(aws_last_error()));
goto on_error;
}
}
struct aws_socket_options socket_options;
AWS_ZERO_STRUCT(socket_options);
socket_options.type = AWS_SOCKET_STREAM;
socket_options.domain = AWS_SOCKET_IPV4;
socket_options.connect_timeout_ms = (uint32_t)aws_timestamp_convert(
ECS_CONNECT_TIMEOUT_DEFAULT_IN_SECONDS, AWS_TIMESTAMP_SECS, AWS_TIMESTAMP_MILLIS, NULL);
struct aws_http_connection_manager_options manager_options;
AWS_ZERO_STRUCT(manager_options);
manager_options.bootstrap = options->bootstrap;
manager_options.initial_window_size = ECS_RESPONSE_SIZE_LIMIT;
manager_options.socket_options = &socket_options;
manager_options.host = options->host;
if (options->port == 0) {
manager_options.port = options->tls_ctx ? 443 : 80;
} else {
manager_options.port = options->port;
}
manager_options.max_connections = 2;
manager_options.shutdown_complete_callback = s_on_connection_manager_shutdown;
manager_options.shutdown_complete_user_data = provider;
manager_options.tls_connection_options = options->tls_ctx ? &tls_connection_options : NULL;
impl->function_table = options->function_table;
if (impl->function_table == NULL) {
impl->function_table = g_aws_credentials_provider_http_function_table;
}
impl->connection_manager = impl->function_table->aws_http_connection_manager_new(allocator, &manager_options);
if (impl->connection_manager == NULL) {
goto on_error;
}
if (options->auth_token.len != 0) {
impl->auth_token = aws_string_new_from_cursor(allocator, &options->auth_token);
if (impl->auth_token == NULL) {
goto on_error;
}
}
impl->path_and_query = aws_string_new_from_cursor(allocator, &options->path_and_query);
if (impl->path_and_query == NULL) {
goto on_error;
}
impl->host = aws_string_new_from_cursor(allocator, &options->host);
if (impl->host == NULL) {
goto on_error;
}
provider->shutdown_options = options->shutdown_options;
aws_tls_connection_options_clean_up(&tls_connection_options);
return provider;
on_error:
aws_tls_connection_options_clean_up(&tls_connection_options);
aws_credentials_provider_destroy(provider);
return NULL;
}
|