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
|
import hmac
import hashlib
import datetime
try:
# python 2
from urllib import quote
from urlparse import urlparse
except ImportError:
# python 3
from urllib.parse import quote, urlparse
import requests
def sign(key, msg):
"""
Copied from https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
"""
return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()
def getSignatureKey(key, dateStamp, regionName, serviceName):
"""
Copied from https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
"""
kDate = sign(('AWS4' + key).encode('utf-8'), dateStamp)
kRegion = sign(kDate, regionName)
kService = sign(kRegion, serviceName)
kSigning = sign(kService, 'aws4_request')
return kSigning
class AWSRequestsAuth(requests.auth.AuthBase):
"""
Auth class that allows us to connect to AWS services
via Amazon's signature version 4 signing process
Adapted from https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
"""
def __init__(self,
aws_access_key,
aws_secret_access_key,
aws_host,
aws_region,
aws_service,
aws_token=None):
"""
Example usage for talking to an AWS Elasticsearch Service:
AWSRequestsAuth(aws_access_key='YOURKEY',
aws_secret_access_key='YOURSECRET',
aws_host='search-service-foobar.us-east-1.es.amazonaws.com',
aws_region='us-east-1',
aws_service='es',
aws_token='...')
The aws_token is optional and is used only if you are using STS
temporary credentials.
"""
self.aws_access_key = aws_access_key
self.aws_secret_access_key = aws_secret_access_key
self.aws_host = aws_host
self.aws_region = aws_region
self.service = aws_service
self.aws_token = aws_token
def __call__(self, r):
"""
Adds the authorization headers required by Amazon's signature
version 4 signing process to the request.
Adapted from https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html
"""
aws_headers = self.get_aws_request_headers_handler(r)
r.headers.update(aws_headers)
return r
def get_aws_request_headers_handler(self, r):
"""
Override get_aws_request_headers_handler() if you have a
subclass that needs to call get_aws_request_headers() with
an arbitrary set of AWS credentials. The default implementation
calls get_aws_request_headers() with self.aws_access_key,
self.aws_secret_access_key, and self.aws_token
"""
return self.get_aws_request_headers(r=r,
aws_access_key=self.aws_access_key,
aws_secret_access_key=self.aws_secret_access_key,
aws_token=self.aws_token)
def get_aws_request_headers(self, r, aws_access_key, aws_secret_access_key, aws_token):
"""
Returns a dictionary containing the necessary headers for Amazon's
signature version 4 signing process. An example return value might
look like
{
'Authorization': 'AWS4-HMAC-SHA256 Credential=YOURKEY/20160618/us-east-1/es/aws4_request, '
'SignedHeaders=host;x-amz-date, '
'Signature=ca0a856286efce2a4bd96a978ca6c8966057e53184776c0685169d08abd74739',
'x-amz-date': '20160618T220405Z',
}
"""
# Create a date for headers and the credential string
t = datetime.datetime.utcnow()
amzdate = t.strftime('%Y%m%dT%H%M%SZ')
datestamp = t.strftime('%Y%m%d') # Date w/o time for credential_scope
canonical_uri = AWSRequestsAuth.get_canonical_path(r)
canonical_querystring = AWSRequestsAuth.get_canonical_querystring(r)
# Create the canonical headers and signed headers. Header names
# and value must be trimmed and lowercase, and sorted in ASCII order.
# Note that there is a trailing \n.
canonical_headers = ('host:' + self.aws_host + '\n' +
'x-amz-date:' + amzdate + '\n')
if aws_token:
canonical_headers += 'x-amz-security-token:' + aws_token + '\n'
# Create the list of signed headers. This lists the headers
# in the canonical_headers list, delimited with ";" and in alpha order.
# Note: The request can include any headers; canonical_headers and
# signed_headers lists those that you want to be included in the
# hash of the request. "Host" and "x-amz-date" are always required.
signed_headers = 'host;x-amz-date'
if aws_token:
signed_headers += ';x-amz-security-token'
# Create payload hash (hash of the request body content). For GET
# requests, the payload is an empty string ('').
body = r.body if r.body else bytes()
try:
body = body.encode('utf-8')
except (AttributeError, UnicodeDecodeError):
# On py2, if unicode characters in present in `body`,
# encode() throws UnicodeDecodeError, but we can safely
# pass unencoded `body` to execute hexdigest().
#
# For py3, encode() will execute successfully regardless
# of the presence of unicode data
body = body
payload_hash = hashlib.sha256(body).hexdigest()
# Combine elements to create create canonical request
canonical_request = (r.method + '\n' + canonical_uri + '\n' +
canonical_querystring + '\n' + canonical_headers +
'\n' + signed_headers + '\n' + payload_hash)
# Match the algorithm to the hashing algorithm you use, either SHA-1 or
# SHA-256 (recommended)
algorithm = 'AWS4-HMAC-SHA256'
credential_scope = (datestamp + '/' + self.aws_region + '/' +
self.service + '/' + 'aws4_request')
string_to_sign = (algorithm + '\n' + amzdate + '\n' + credential_scope +
'\n' + hashlib.sha256(canonical_request.encode('utf-8')).hexdigest())
# Create the signing key using the function defined above.
signing_key = getSignatureKey(aws_secret_access_key,
datestamp,
self.aws_region,
self.service)
# Sign the string_to_sign using the signing_key
string_to_sign_utf8 = string_to_sign.encode('utf-8')
signature = hmac.new(signing_key,
string_to_sign_utf8,
hashlib.sha256).hexdigest()
# The signing information can be either in a query string value or in
# a header named Authorization. This code shows how to use a header.
# Create authorization header and add to request headers
authorization_header = (algorithm + ' ' + 'Credential=' + aws_access_key +
'/' + credential_scope + ', ' + 'SignedHeaders=' +
signed_headers + ', ' + 'Signature=' + signature)
headers = {
'Authorization': authorization_header,
'x-amz-date': amzdate,
'x-amz-content-sha256': payload_hash
}
if aws_token:
headers['X-Amz-Security-Token'] = aws_token
return headers
@classmethod
def get_canonical_path(cls, r):
"""
Create canonical URI--the part of the URI from domain to query
string (use '/' if no path)
"""
parsedurl = urlparse(r.url)
# safe chars adapted from boto's use of urllib.parse.quote
# https://github.com/boto/boto/blob/d9e5cfe900e1a58717e393c76a6e3580305f217a/boto/auth.py#L393
return quote(parsedurl.path if parsedurl.path else '/', safe='/-_.~')
@classmethod
def get_canonical_querystring(cls, r):
"""
Create the canonical query string. According to AWS, by the
end of this function our query string values must
be URL-encoded (space=%20) and the parameters must be sorted
by name.
This method assumes that the query params in `r` are *already*
url encoded. If they are not url encoded by the time they make
it to this function, AWS may complain that the signature for your
request is incorrect.
It appears elasticsearc-py url encodes query paramaters on its own:
https://github.com/elastic/elasticsearch-py/blob/5dfd6985e5d32ea353d2b37d01c2521b2089ac2b/elasticsearch/connection/http_requests.py#L64
If you are using a different client than elasticsearch-py, it
will be your responsibility to urleconde your query params before
this method is called.
"""
canonical_querystring = ''
parsedurl = urlparse(r.url)
querystring_sorted = '&'.join(sorted(parsedurl.query.split('&')))
for query_param in querystring_sorted.split('&'):
key_val_split = query_param.split('=', 1)
key = key_val_split[0]
if len(key_val_split) > 1:
val = key_val_split[1]
else:
val = ''
if key:
if canonical_querystring:
canonical_querystring += "&"
canonical_querystring += u'='.join([key, val])
return canonical_querystring
|