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
|
/**
* 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/mutex.h>
#include <aws/common/time.h>
#include <inttypes.h>
/*
ToDo: credentials expiration environment overrides
AWS_STATIC_STRING_FROM_LITERAL(s_credential_expiration_env_var, "AWS_CREDENTIAL_EXPIRATION");
*/
#define REFRESH_CREDENTIALS_EARLY_DURATION_SECONDS 10
struct aws_credentials_provider_cached {
struct aws_credentials_provider *source;
struct aws_credentials *cached_credentials;
struct aws_mutex lock;
uint64_t refresh_interval_in_ns;
uint64_t next_refresh_time;
aws_io_clock_fn *high_res_clock_fn;
aws_io_clock_fn *system_clock_fn;
struct aws_linked_list pending_queries;
};
static void s_aws_credentials_query_list_notify_and_clean_up(
struct aws_linked_list *query_list,
struct aws_allocator *allocator,
struct aws_credentials *credentials,
int error_code) {
while (!aws_linked_list_empty(query_list)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(query_list);
struct aws_credentials_query *query = AWS_CONTAINER_OF(node, struct aws_credentials_query, node);
query->callback(credentials, error_code, query->user_data);
aws_credentials_query_clean_up(query);
aws_mem_release(allocator, query);
}
}
static void s_swap_cached_credentials(
struct aws_credentials_provider *provider,
struct aws_credentials *new_credentials) {
struct aws_credentials_provider_cached *cached_provider = provider->impl;
aws_credentials_release(cached_provider->cached_credentials);
cached_provider->cached_credentials = new_credentials;
if (cached_provider->cached_credentials != NULL) {
aws_credentials_acquire(cached_provider->cached_credentials);
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider succesfully sourced credentials on refresh",
(void *)provider);
} else {
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider was unable to source credentials on refresh",
(void *)provider);
}
}
static void s_cached_credentials_provider_get_credentials_async_callback(
struct aws_credentials *credentials,
int error_code,
void *user_data) {
struct aws_credentials_provider *provider = user_data;
struct aws_credentials_provider_cached *impl = provider->impl;
aws_mutex_lock(&impl->lock);
/*
* Move pending queries so that we can do notifications outside the lock
*/
struct aws_linked_list pending_queries;
aws_linked_list_init(&pending_queries);
aws_linked_list_swap_contents(&pending_queries, &impl->pending_queries);
uint64_t next_refresh_time_in_ns = UINT64_MAX;
uint64_t high_res_now = 0;
if (!impl->high_res_clock_fn(&high_res_now)) {
if (impl->refresh_interval_in_ns > 0) {
next_refresh_time_in_ns = high_res_now + impl->refresh_interval_in_ns;
}
uint64_t credentials_expiration_timepoint_seconds = UINT64_MAX;
if (credentials != NULL) {
credentials_expiration_timepoint_seconds = aws_credentials_get_expiration_timepoint_seconds(credentials);
}
/*
* If the sourced credentials have an explicit expiration time, we should always use that time
* rather than the much cruder, mechanical refresh setting on the caching wrapper.
*/
if (credentials_expiration_timepoint_seconds < UINT64_MAX) {
uint64_t system_now = 0;
if (!impl->system_clock_fn(&system_now)) {
uint64_t system_now_seconds =
aws_timestamp_convert(system_now, AWS_TIMESTAMP_NANOS, AWS_TIMESTAMP_SECS, NULL);
if (credentials_expiration_timepoint_seconds >=
system_now_seconds + REFRESH_CREDENTIALS_EARLY_DURATION_SECONDS) {
next_refresh_time_in_ns = high_res_now;
next_refresh_time_in_ns += aws_timestamp_convert(
credentials_expiration_timepoint_seconds - system_now_seconds -
REFRESH_CREDENTIALS_EARLY_DURATION_SECONDS,
AWS_TIMESTAMP_SECS,
AWS_TIMESTAMP_NANOS,
NULL);
}
}
}
}
impl->next_refresh_time = next_refresh_time_in_ns;
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider next refresh time set to %" PRIu64,
(void *)provider,
impl->next_refresh_time);
s_swap_cached_credentials(provider, credentials);
aws_mutex_unlock(&impl->lock);
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider notifying pending queries of new credentials",
(void *)provider);
s_aws_credentials_query_list_notify_and_clean_up(&pending_queries, provider->allocator, credentials, error_code);
}
static int s_cached_credentials_provider_get_credentials_async(
struct aws_credentials_provider *provider,
aws_on_get_credentials_callback_fn callback,
void *user_data) {
struct aws_credentials_provider_cached *impl = provider->impl;
uint64_t current_time = 0;
impl->high_res_clock_fn(¤t_time);
bool should_submit_query = false;
bool perform_callback = false;
struct aws_credentials *credentials = NULL;
aws_mutex_lock(&impl->lock);
if (impl->cached_credentials != NULL && current_time < impl->next_refresh_time) {
perform_callback = true;
credentials = impl->cached_credentials;
aws_credentials_acquire(credentials);
} else {
struct aws_credentials_query *query =
aws_mem_acquire(provider->allocator, sizeof(struct aws_credentials_query));
if (query != NULL) {
aws_credentials_query_init(query, provider, callback, user_data);
should_submit_query = aws_linked_list_empty(&impl->pending_queries);
aws_linked_list_push_back(&impl->pending_queries, &query->node);
} else {
perform_callback = true;
}
}
aws_mutex_unlock(&impl->lock);
if (should_submit_query) {
AWS_LOGF_INFO(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider has expired credentials. Requerying.",
(void *)provider);
aws_credentials_provider_get_credentials(
impl->source, s_cached_credentials_provider_get_credentials_async_callback, provider);
} else if (!perform_callback) {
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider has expired credentials. Waiting on existing query.",
(void *)provider);
}
if (perform_callback) {
if (credentials != NULL) {
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider successfully sourced from cache",
(void *)provider);
} else {
AWS_LOGF_DEBUG(
AWS_LS_AUTH_CREDENTIALS_PROVIDER,
"(id=%p) Cached credentials provider failed to source credentials while skipping requery",
(void *)provider);
}
callback(credentials, (credentials != NULL) ? AWS_ERROR_SUCCESS : aws_last_error(), user_data);
aws_credentials_release(credentials);
}
return AWS_OP_SUCCESS;
}
static void s_cached_credentials_provider_destroy(struct aws_credentials_provider *provider) {
struct aws_credentials_provider_cached *impl = provider->impl;
if (impl == NULL) {
return;
}
aws_credentials_provider_release(impl->source);
/* Invoke our own shutdown callback */
aws_credentials_provider_invoke_shutdown_callback(provider);
if (impl->cached_credentials != NULL) {
aws_credentials_release(impl->cached_credentials);
}
aws_mutex_clean_up(&impl->lock);
aws_mem_release(provider->allocator, provider);
}
static struct aws_credentials_provider_vtable s_aws_credentials_provider_cached_vtable = {
.get_credentials = s_cached_credentials_provider_get_credentials_async,
.destroy = s_cached_credentials_provider_destroy,
};
struct aws_credentials_provider *aws_credentials_provider_new_cached(
struct aws_allocator *allocator,
const struct aws_credentials_provider_cached_options *options) {
AWS_ASSERT(options->source != NULL);
struct aws_credentials_provider *provider = NULL;
struct aws_credentials_provider_cached *impl = NULL;
aws_mem_acquire_many(
allocator,
2,
&provider,
sizeof(struct aws_credentials_provider),
&impl,
sizeof(struct aws_credentials_provider_cached));
if (!provider) {
return NULL;
}
AWS_ZERO_STRUCT(*provider);
AWS_ZERO_STRUCT(*impl);
aws_credentials_provider_init_base(provider, allocator, &s_aws_credentials_provider_cached_vtable, impl);
if (aws_mutex_init(&impl->lock)) {
goto on_error;
}
aws_linked_list_init(&impl->pending_queries);
impl->source = options->source;
aws_credentials_provider_acquire(impl->source);
if (options->refresh_time_in_milliseconds > 0) {
impl->refresh_interval_in_ns = aws_timestamp_convert(
options->refresh_time_in_milliseconds, AWS_TIMESTAMP_MILLIS, AWS_TIMESTAMP_NANOS, NULL);
} else {
/*
* TODO: query AWS_CREDENTIAL_EXPIRATION for a refresh override
*
* This must be an ISO 8601 time interval which we don't have a parser for yet (one could be cobbled
* together from the existing timestamp parser). Does not seem important enough to get bogged down in atm.
* Punting for now.
*/
impl->refresh_interval_in_ns = 0;
}
if (options->high_res_clock_fn != NULL) {
impl->high_res_clock_fn = options->high_res_clock_fn;
} else {
impl->high_res_clock_fn = &aws_high_res_clock_get_ticks;
}
if (options->system_clock_fn != NULL) {
impl->system_clock_fn = options->system_clock_fn;
} else {
impl->system_clock_fn = &aws_sys_clock_get_ticks;
}
provider->shutdown_options = options->shutdown_options;
return provider;
on_error:
aws_credentials_provider_destroy(provider);
return NULL;
}
|