* Fix race condition in AWS request signers Signed-off-by: Logan Attwood <[email protected]> * Conditionally expose get_frozen_credentials on mock_session Signed-off-by: Logan Attwood <[email protected]> * Use inheritance to make tests cleaner Signed-off-by: Logan Attwood <[email protected]> --------- Signed-off-by: Logan Attwood <[email protected]>
73 lines
2.6 KiB
Python
73 lines
2.6 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# The OpenSearch Contributors require contributions made to
|
|
# this file be licensed under the Apache-2.0 license or a
|
|
# compatible open source license.
|
|
#
|
|
# Modifications Copyright OpenSearch Contributors. See
|
|
# GitHub history for details.
|
|
|
|
import sys
|
|
|
|
PY3 = sys.version_info[0] == 3
|
|
|
|
|
|
class AWSV4SignerAsyncAuth:
|
|
"""
|
|
AWS V4 Request Signer for Async Requests.
|
|
"""
|
|
|
|
def __init__(self, credentials, region, service="es"): # type: ignore
|
|
if not credentials:
|
|
raise ValueError("Credentials cannot be empty")
|
|
self.credentials = credentials
|
|
|
|
if not region:
|
|
raise ValueError("Region cannot be empty")
|
|
self.region = region
|
|
|
|
if not service:
|
|
raise ValueError("Service name cannot be empty")
|
|
self.service = service
|
|
|
|
def __call__(self, method, url, query_string, body): # type: ignore
|
|
return self._sign_request(method, url, query_string, body) # type: ignore
|
|
|
|
def _sign_request(self, method, url, query_string, body):
|
|
"""
|
|
This method helps in signing the request by injecting the required headers.
|
|
:param prepared_request: unsigned headers
|
|
:return: signed headers
|
|
"""
|
|
|
|
from botocore.auth import SigV4Auth
|
|
from botocore.awsrequest import AWSRequest
|
|
|
|
# create an AWS request object and sign it using SigV4Auth
|
|
aws_request = AWSRequest(
|
|
method=method,
|
|
url=url,
|
|
data=body,
|
|
)
|
|
|
|
# credentials objects expose access_key, secret_key and token attributes
|
|
# via @property annotations that call _refresh() on every access,
|
|
# creating a race condition if the credentials expire before secret_key
|
|
# is called but after access_key- the end result is the access_key doesn't
|
|
# correspond to the secret_key used to sign the request. To avoid this,
|
|
# get_frozen_credentials() which returns non-refreshing credentials is
|
|
# called if it exists.
|
|
credentials = (
|
|
self.credentials.get_frozen_credentials()
|
|
if hasattr(self.credentials, "get_frozen_credentials")
|
|
and callable(self.credentials.get_frozen_credentials)
|
|
else self.credentials
|
|
)
|
|
|
|
sig_v4_auth = SigV4Auth(credentials, self.service, self.region)
|
|
sig_v4_auth.add_auth(aws_request)
|
|
aws_request.headers["X-Amz-Content-SHA256"] = sig_v4_auth.payload(aws_request)
|
|
|
|
# copy the headers from AWS request object into the prepared_request
|
|
return dict(aws_request.headers.items())
|