Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions aliyun-python-sdk-core/aliyunsdkcore/auth/algorithm/hmac_sha256.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

# coding=utf-8


import hashlib
import hmac

from aliyunsdkcore.compat import ensure_string
from aliyunsdkcore.compat import ensure_bytes
from aliyunsdkcore.compat import b64_encode_bytes


def get_sign_string(source, secret):
source = ensure_bytes(source)
secret = ensure_bytes(secret)
h = hmac.new(secret, source, hashlib.sha256)
signature = ensure_string(b64_encode_bytes(h.digest()).strip())
return signature


def get_signer_name():
return "HMAC-SHA256"


def get_signer_version():
return "1.0"


def get_signer_type():
return ""
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# coding=utf-8
from aliyunsdkcore.vendored.six import iteritems
from aliyunsdkcore.vendored.six.moves.urllib.parse import urlencode
from aliyunsdkcore.auth.algorithm import sha_hmac1 as mac1
from aliyunsdkcore.auth.algorithm import hmac_sha256 as default_signer
from aliyunsdkcore.utils import parameter_helper as helper
from aliyunsdkcore.http import format_type as FormatType

Expand All @@ -37,7 +37,7 @@
# accessKeyId: this is aliyun_access_key_id
# format: XML or JSON
# input parameters is headers
def refresh_sign_parameters(parameters, format=FormatType.RAW, signer=mac1):
def refresh_sign_parameters(parameters, format=FormatType.RAW, signer=default_signer):
if parameters is None or not isinstance(parameters, dict):
parameters = dict()
parameters["Date"] = helper.get_rfc_2616_date()
Expand All @@ -53,7 +53,7 @@ def compose_string_to_sign(
uri_pattern=None,
headers={},
paths=None,
signer=mac1):
signer=default_signer):
sign_to_string = ""
sign_to_string += method
sign_to_string += HEADER_SEPARATOR
Expand Down Expand Up @@ -128,10 +128,11 @@ def get_signature(
uri_pattern,
paths,
method,
signer=mac1):
signer=default_signer):
headers = refresh_sign_parameters(
parameters=headers,
format=format)
format=format,
signer=signer)
sign_to_string = compose_string_to_sign(
method=method,
queries=queries,
Expand All @@ -151,7 +152,7 @@ def get_signature_headers(
uri_pattern,
paths,
method,
signer=mac1):
signer=default_signer):
signature, sign_to_string = get_signature(
queries,
access_key,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from aliyunsdkcore.vendored.six.moves.urllib.parse import urlencode
from aliyunsdkcore.vendored.six.moves.urllib.request import pathname2url

from aliyunsdkcore.auth.algorithm import sha_hmac1 as mac1
from aliyunsdkcore.auth.algorithm import hmac_sha256 as default_signer
from aliyunsdkcore.utils import parameter_helper as helper


Expand All @@ -33,7 +33,7 @@ def __refresh_sign_parameters(
parameters,
access_key_id,
accept_format="JSON",
signer=mac1):
signer=default_signer):
if parameters is None or not isinstance(parameters, dict):
parameters = dict()
if 'Signature' in parameters:
Expand Down Expand Up @@ -64,11 +64,11 @@ def __compose_string_to_sign(method, queries):
return string_to_sign


def __get_signature(string_to_sign, secret, signer=mac1):
def __get_signature(string_to_sign, secret, signer=default_signer):
return signer.get_sign_string(string_to_sign, secret + '&')


def get_signed_url(params, ak, secret, accept_format, method, body_params, signer=mac1):
def get_signed_url(params, ak, secret, accept_format, method, body_params, signer=default_signer):
url_params = __refresh_sign_parameters(params, ak, accept_format, signer)
sign_params = dict(url_params)
sign_params.update(body_params)
Expand Down
6 changes: 3 additions & 3 deletions aliyun-python-sdk-core/aliyunsdkcore/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
from aliyunsdkcore.auth.composer import rpc_signature_composer as rpc_signer
from aliyunsdkcore.auth.composer import roa_signature_composer as roa_signer
from aliyunsdkcore.utils.parameter_helper import md5_sum
from aliyunsdkcore.auth.algorithm import sha_hmac1
from aliyunsdkcore.auth.algorithm import hmac_sha256
from aliyunsdkcore.acs_exception import exceptions
from aliyunsdkcore.acs_exception import error_code
from aliyunsdkcore.compat import ensure_string
Expand Down Expand Up @@ -290,7 +290,7 @@ def __init__(
location_endpoint_type='openAPI',
format=None,
protocol=None,
signer=sha_hmac1):
signer=hmac_sha256):
AcsRequest.__init__(
self,
product,
Expand Down Expand Up @@ -470,7 +470,7 @@ def __init__(self, domain=None, version=None, action_name=None, uri_pattern=None
self._uri_pattern = uri_pattern
self._product = product
self._location_endpoint_type = location_endpoint_type
self._signer = sha_hmac1
self._signer = hmac_sha256
self.add_header('x-sdk-invoke-type', 'common')
self._path_params = None
self._method = "GET"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ def test_refresh_sign_parameters(self, mock_get_rfc_2616_date):
mock_get_rfc_2616_date.assert_called_once_with()
self.assertEqual(parameters.get('Date'), '2018-12-04T03:25:29Z')
self.assertEqual(parameters.get('Accept'), 'application/octet-stream')
self.assertEqual(parameters.get('x-acs-signature-method'), 'HMAC-SHA1')
self.assertEqual(parameters.get('x-acs-signature-method'), 'HMAC-SHA256')
self.assertEqual(parameters.get('x-acs-signature-version'), '1.0')
# with none
parameters = refresh_sign_parameters(None)
mock_get_rfc_2616_date.assert_called_with()
self.assertEqual(parameters.get('Date'), '2018-12-04T03:25:29Z')
self.assertEqual(parameters.get('Accept'), 'application/octet-stream')
self.assertEqual(parameters.get('x-acs-signature-method'), 'HMAC-SHA1')
self.assertEqual(parameters.get('x-acs-signature-method'), 'HMAC-SHA256')
self.assertEqual(parameters.get('x-acs-signature-version'), '1.0')

@patch("aliyunsdkcore.utils.parameter_helper.get_rfc_2616_date")
Expand All @@ -82,7 +82,7 @@ def test_get_signature(self, mock_get_rfc_2616_date):
sign, _ = get_signature({}, 'access_key_id',
'access_key_secret', 'json', {}, '/', {}, 'GET')
mock_get_rfc_2616_date.assert_called_once_with()
self.assertEqual(sign, 'HKCpm41tJg6b3EYdtGMbNuwALZU=')
self.assertEqual(sign, 'dH1gZsa/Z+mTd+VJmr+W9OCofWTRhmrPWFIprWVPR6o=')

@patch("aliyunsdkcore.utils.parameter_helper.get_rfc_2616_date")
def test_get_signature_headers(self, mock_get_rfc_2616_date):
Expand All @@ -91,4 +91,4 @@ def test_get_signature_headers(self, mock_get_rfc_2616_date):
{}, 'access_key_id', 'access_key_secret', 'json', {}, '/', {}, 'GET')
mock_get_rfc_2616_date.assert_called_once_with()
self.assertEqual(headers.get('Authorization'),
'acs access_key_id:HKCpm41tJg6b3EYdtGMbNuwALZU=')
'acs access_key_id:dH1gZsa/Z+mTd+VJmr+W9OCofWTRhmrPWFIprWVPR6o=')
20 changes: 10 additions & 10 deletions aliyun-python-sdk-core/tests/test_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,10 @@ def test_get_signed_header(self, mock_get_rfc_2616_date):
mock_get_rfc_2616_date.assert_called_once_with()
self.assertDictEqual(headers, {
'Accept': 'application/octet-stream',
'Authorization': 'acs accesskeyid:Lq1u0OzLW/uqLQswxwhne97Umlw=',
'Authorization': 'acs accesskeyid:MF0ngFVlg34K5SuJeGYQiBb5UA/eXQr/UBOEJmRZhD4=',
'Date': '2018-12-04T03:25:29Z',
'x-acs-region-id': 'regionid',
'x-acs-signature-method': 'HMAC-SHA1',
'x-acs-signature-method': 'HMAC-SHA256',
'x-acs-signature-version': '1.0',
'x-acs-version': 'version'
})
Expand All @@ -303,10 +303,10 @@ def test_get_signed_header(self, mock_get_rfc_2616_date):
headers = r.get_signed_header("regionid", "accesskeyid", "secret")
self.assertDictEqual(headers, {
'Accept': 'application/octet-stream',
'Authorization': 'acs accesskeyid:Lq1u0OzLW/uqLQswxwhne97Umlw=',
'Authorization': 'acs accesskeyid:MF0ngFVlg34K5SuJeGYQiBb5UA/eXQr/UBOEJmRZhD4=',
'Date': '2018-12-04T03:25:29Z',
'x-acs-region-id': 'regionid',
'x-acs-signature-method': 'HMAC-SHA1',
'x-acs-signature-method': 'HMAC-SHA256',
'x-acs-signature-version': '1.0',
'x-acs-version': 'version'
})
Expand All @@ -315,10 +315,10 @@ def test_get_signed_header(self, mock_get_rfc_2616_date):
headers = r.get_signed_header("regionid", "accesskeyid", "secret")
self.assertDictEqual(headers, {
'Accept': 'application/octet-stream',
'Authorization': 'acs accesskeyid:Lq1u0OzLW/uqLQswxwhne97Umlw=',
'Authorization': 'acs accesskeyid:MF0ngFVlg34K5SuJeGYQiBb5UA/eXQr/UBOEJmRZhD4=',
'Date': '2018-12-04T03:25:29Z',
'x-acs-region-id': 'regionid',
'x-acs-signature-method': 'HMAC-SHA1',
'x-acs-signature-method': 'HMAC-SHA256',
'x-acs-signature-version': '1.0',
'x-acs-version': 'version'
})
Expand All @@ -327,11 +327,11 @@ def test_get_signed_header(self, mock_get_rfc_2616_date):
headers = r.get_signed_header("regionid", "accesskeyid", "secret")
self.assertDictEqual(headers, {
'Accept': 'application/octet-stream',
'Authorization': 'acs accesskeyid:u2RdkokGTtn2BhUmzUNJjVUh448=',
'Authorization': 'acs accesskeyid:bUYa87QP/Ts93gc78qtkVxG/QCyYd9khVzMWCHKyt70=',
'Content-MD5': 'mgNkuembtIDdJeHwKEyFVQ==',
'Date': '2018-12-04T03:25:29Z',
'x-acs-region-id': 'regionid',
'x-acs-signature-method': 'HMAC-SHA1',
'x-acs-signature-method': 'HMAC-SHA256',
'x-acs-signature-version': '1.0',
'x-acs-version': 'version'
})
Expand Down Expand Up @@ -503,11 +503,11 @@ def test_common_request_get_signed_header(self, mock_get_rfc_2616_date):
mock_get_rfc_2616_date.assert_called_once_with()
self.assertDictEqual(headers, {
'Accept': 'application/octet-stream',
'Authorization': 'acs accesskeyid:j73ZHar0vd0+MGaKFlGK9JyBnEo=',
'Authorization': 'acs accesskeyid:b6aEEEYifojv60v06CVkcnWKOR7pmJ92t8w3BQB0Dgc=',
'Date': '2018-12-04T03:25:29Z',
'x-acs-action': 'action_name',
'x-acs-region-id': 'regionid',
'x-acs-signature-method': 'HMAC-SHA1',
'x-acs-signature-method': 'HMAC-SHA256',
'x-acs-signature-version': '1.0',
'x-acs-version': 'version',
'x-sdk-invoke-type': 'common'
Expand Down
143 changes: 143 additions & 0 deletions aliyun-python-sdk-core/tests/test_signature_v2.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
# coding=utf-8
import base64
import hashlib
import hmac
import itertools
import json
import os
from urllib.parse import parse_qsl, quote, urlsplit

from mock import patch
from tests import unittest

from aliyunsdkcore.auth.algorithm import hmac_sha256, sha_hmac1
from aliyunsdkcore.auth.credentials import AccessKeyCredential, RamRoleArnCredential, StsTokenCredential
from aliyunsdkcore.auth.signers.rsa_key_pair_signer import GetSessionAkRequest
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.request import CommonRequest, RoaRequest, RpcRequest


class TestSignatureV2(unittest.TestCase):
def setUp(self):
environment = patch.dict(os.environ, {}, clear=True)
environment.start()
self.addCleanup(environment.stop)

@staticmethod
def request(style, method, parameters=True):
if style.startswith('common'):
request = CommonRequest(product='Ecs', version='2014-05-26', action_name='DescribeRegions')
if style == 'common_roa':
request.set_uri_pattern('/regions/[region_id]/clusters')
request.add_path_param('region_id', 'cn-hangzhou')
elif style == 'rpc':
request = RpcRequest('Ecs', '2014-05-26', 'DescribeRegions')
else:
request = RoaRequest('CS', '2015-12-15', 'DescribeClustersForRegion',
uri_pattern='/regions/[region_id]/clusters',
path_params={'region_id': 'cn-hangzhou'})
request.set_accept_format('JSON')
request.set_method(method)
if parameters:
request.add_query_param('Value', 'Unicode-中文 +/~*')
if parameters and method == 'POST':
request.add_body_params('BodyValue', 'body +/~*')
return request

@staticmethod
def rpc_string(message):
parameters = dict(parse_qsl(urlsplit(message.get_url()).query, keep_blank_values=True))
parameters.pop('Signature')
parameters.update(parse_qsl(message.get_content() or '', keep_blank_values=True))
canonical = '&'.join(quote(key, safe='~') + '=' + quote(value, safe='~')
for key, value in sorted(parameters.items()))
return message.get_method() + '&%2F&' + quote(canonical, safe='~')

def assert_signature(self, message, style, method, secret, token=None):
algorithm = hashlib.sha1 if method == 'HMAC-SHA1' else hashlib.sha256
if style.endswith('rpc'):
parameters = dict(parse_qsl(urlsplit(message.get_url()).query, keep_blank_values=True))
self.assertEqual(method, parameters['SignatureMethod'])
self.assertEqual('1.0', parameters['SignatureVersion'])
self.assertEqual(token, parameters.get('SecurityToken'))
signature = parameters['Signature']
canonical = self.rpc_string(message)
secret += '&'
else:
headers = message.get_headers()
self.assertEqual(method, headers['x-acs-signature-method'])
self.assertEqual('1.0', headers['x-acs-signature-version'])
self.assertEqual(token, headers.get('x-acs-security-token'))
signature = headers['Authorization'].split(':', 1)[1]
canonical = message.get_method() + '\n'
for name in ('Accept', 'Content-MD5', 'Content-Type', 'Date'):
canonical += headers.get(name, '') + '\n'
canonical += ''.join(name.lower() + ':' + value + '\n'
for name, value in sorted(headers.items(), key=lambda item: item[0].lower())
if name.lower().startswith('x-acs-'))
uri = urlsplit(message.get_url())
canonical += uri.path
parameters = sorted(parse_qsl(uri.query, keep_blank_values=True))
if parameters:
canonical += '?' + '&'.join(key + '=' + value for key, value in parameters)
expected = base64.b64encode(hmac.new(secret.encode('utf-8'), canonical.encode('utf-8'),
algorithm).digest()).decode('ascii')
self.assertEqual(expected, signature)

def test_client_defaults_to_sha256(self):
cases = itertools.product(('rpc', 'roa', 'common_rpc', 'common_roa'),
('GET', 'POST'), (False, True), (False, True))
for style, http_method, sts, parameters in cases:
with self.subTest(style=style, http_method=http_method, sts=sts, parameters=parameters):
credential = (StsTokenCredential('key', 'secret', 'token+/=')
if sts else AccessKeyCredential('key', 'secret'))
client = AcsClient(credential=credential)
request = self.request(style, http_method, parameters)
message = client._make_http_response('example.test', request, 10, 10)
self.assert_signature(message, style, 'HMAC-SHA256', 'secret', 'token+/=' if sts else None)
client.session.close()

def test_explicit_request_signer_overrides_client_default(self):
client = AcsClient('key', 'secret')
request = RpcRequest('Ecs', '2014-05-26', 'DescribeRegions', signer=sha_hmac1)
message = client._make_http_response('example.test', request, 10, 10)
self.assert_signature(message, 'rpc', 'HMAC-SHA1', 'secret')
client.session.close()

def test_assume_role_defaults_to_sha256(self):
credential = RamRoleArnCredential('source-key', 'source-secret', 'role-arn', 'session')
client = AcsClient(credential=credential)
exchange = []

def assume_role(request, signer):
exchange.append(client._make_http_response('example.test', request, 10, 10, signer))
return 200, {}, json.dumps({'Credentials': {
'AccessKeyId': 'temporary-key', 'AccessKeySecret': 'temporary-secret',
'SecurityToken': 'temporary-token'
}}).encode('utf-8'), None

client._signer._doAction = assume_role
message = client._make_http_response('example.test', self.request('rpc', 'GET'), 10, 10)
self.assertEqual(1, len(exchange))
self.assert_signature(exchange[0], 'rpc', 'HMAC-SHA256', 'source-secret')
self.assert_signature(message, 'rpc', 'HMAC-SHA256', 'temporary-secret', 'temporary-token')
client.session.close()

@patch('aliyunsdkcore.auth.algorithm.sha_hmac256.get_sign_string', return_value='rsa-signature')
def test_rsa_exchange_keeps_explicit_algorithm(self, sign):
client = AcsClient('public-key-id', 'private-key')
message = client._make_http_response('example.test', GetSessionAkRequest(), 10, 10)
parameters = dict(parse_qsl(urlsplit(message.get_url()).query))
self.assertEqual('SHA256withRSA', parameters['SignatureMethod'])
self.assertEqual('PRIVATEKEY', parameters['SignatureType'])
self.assertEqual('rsa-signature', parameters['Signature'])
sign.assert_called_once()
client.session.close()

def test_hmac_sha256_vectors(self):
self.assertEqual('HMAC-SHA256', hmac_sha256.get_signer_name())
self.assertEqual('1.0', hmac_sha256.get_signer_version())
self.assertEqual('', hmac_sha256.get_signer_type())
for source in ('source', '中文unicode'):
expected = base64.b64encode(hmac.new(b'secret', source.encode('utf-8'), hashlib.sha256).digest())
self.assertEqual(expected.decode('ascii'), hmac_sha256.get_sign_string(source, 'secret'))
Loading