960 lines
43 KiB
Python
960 lines
43 KiB
Python
# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"). You
|
|
# may not use this file except in compliance with the License. A copy of
|
|
# the License is located at
|
|
#
|
|
# http://aws.amazon.com/apache2.0/
|
|
#
|
|
# or in the "license" file accompanying this file. This file 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.
|
|
from tests import unittest, mock, BaseSessionTest, create_session, ClientHTTPStubber
|
|
from nose.tools import assert_equal
|
|
|
|
import botocore.session
|
|
from botocore.config import Config
|
|
from botocore.compat import urlsplit
|
|
from botocore.exceptions import ParamValidationError, ClientError
|
|
from botocore import UNSIGNED
|
|
|
|
|
|
class TestS3BucketValidation(unittest.TestCase):
|
|
def test_invalid_bucket_name_raises_error(self):
|
|
session = botocore.session.get_session()
|
|
s3 = session.create_client('s3')
|
|
with self.assertRaises(ParamValidationError):
|
|
s3.put_object(Bucket='adfgasdfadfs/bucket/name',
|
|
Key='foo', Body=b'asdf')
|
|
|
|
|
|
class BaseS3OperationTest(BaseSessionTest):
|
|
def setUp(self):
|
|
super(BaseS3OperationTest, self).setUp()
|
|
self.region = 'us-west-2'
|
|
self.client = self.session.create_client(
|
|
's3', self.region)
|
|
self.http_stubber = ClientHTTPStubber(self.client)
|
|
|
|
|
|
class TestOnlyAsciiCharsAllowed(BaseS3OperationTest):
|
|
def test_validates_non_ascii_chars_trigger_validation_error(self):
|
|
self.http_stubber.add_response()
|
|
with self.http_stubber:
|
|
with self.assertRaises(ParamValidationError):
|
|
self.client.put_object(
|
|
Bucket='foo', Key='bar', Metadata={
|
|
'goodkey': 'good', 'non-ascii': u'\u2713'})
|
|
|
|
|
|
class TestS3GetBucketLifecycle(BaseS3OperationTest):
|
|
def test_multiple_transitions_returns_one(self):
|
|
response_body = (
|
|
'<?xml version="1.0" ?>'
|
|
'<LifecycleConfiguration xmlns="http://s3.amazonaws.'
|
|
'com/doc/2006-03-01/">'
|
|
' <Rule>'
|
|
' <ID>transitionRule</ID>'
|
|
' <Prefix>foo</Prefix>'
|
|
' <Status>Enabled</Status>'
|
|
' <Transition>'
|
|
' <Days>40</Days>'
|
|
' <StorageClass>STANDARD_IA</StorageClass>'
|
|
' </Transition>'
|
|
' <Transition>'
|
|
' <Days>70</Days>'
|
|
' <StorageClass>GLACIER</StorageClass>'
|
|
' </Transition>'
|
|
' </Rule>'
|
|
' <Rule>'
|
|
' <ID>noncurrentVersionRule</ID>'
|
|
' <Prefix>bar</Prefix>'
|
|
' <Status>Enabled</Status>'
|
|
' <NoncurrentVersionTransition>'
|
|
' <NoncurrentDays>40</NoncurrentDays>'
|
|
' <StorageClass>STANDARD_IA</StorageClass>'
|
|
' </NoncurrentVersionTransition>'
|
|
' <NoncurrentVersionTransition>'
|
|
' <NoncurrentDays>70</NoncurrentDays>'
|
|
' <StorageClass>GLACIER</StorageClass>'
|
|
' </NoncurrentVersionTransition>'
|
|
' </Rule>'
|
|
'</LifecycleConfiguration>'
|
|
).encode('utf-8')
|
|
s3 = self.session.create_client('s3')
|
|
with ClientHTTPStubber(s3) as http_stubber:
|
|
http_stubber.add_response(body=response_body)
|
|
response = s3.get_bucket_lifecycle(Bucket='mybucket')
|
|
# Each Transition member should have at least one of the
|
|
# transitions provided.
|
|
self.assertEqual(
|
|
response['Rules'][0]['Transition'],
|
|
{'Days': 40, 'StorageClass': 'STANDARD_IA'}
|
|
)
|
|
self.assertEqual(
|
|
response['Rules'][1]['NoncurrentVersionTransition'],
|
|
{'NoncurrentDays': 40, 'StorageClass': 'STANDARD_IA'}
|
|
)
|
|
|
|
|
|
class TestS3PutObject(BaseS3OperationTest):
|
|
def test_500_error_with_non_xml_body(self):
|
|
# Note: This exact test case may not be applicable from
|
|
# an integration standpoint if the issue is fixed in the future.
|
|
#
|
|
# The issue is that:
|
|
# S3 returns a 200 response but the received response from urllib3 has
|
|
# a 500 status code and the headers are in the body of the
|
|
# the response. Botocore will try to parse out the error body as xml,
|
|
# but the body is invalid xml because it is full of headers.
|
|
# So instead of blowing up on an XML parsing error, we
|
|
# should at least use the 500 status code because that can be
|
|
# retried.
|
|
#
|
|
# We are unsure of what exactly causes the response to be mangled
|
|
# but we expect it to be how 100 continues are handled.
|
|
non_xml_content = (
|
|
'x-amz-id-2: foo\r\n'
|
|
'x-amz-request-id: bar\n'
|
|
'Date: Tue, 06 Oct 2015 03:20:38 GMT\r\n'
|
|
'ETag: "a6d856bc171fc6aa1b236680856094e2"\r\n'
|
|
'Content-Length: 0\r\n'
|
|
'Server: AmazonS3\r\n'
|
|
).encode('utf-8')
|
|
s3 = self.session.create_client('s3')
|
|
with ClientHTTPStubber(s3) as http_stubber:
|
|
http_stubber.add_response(status=500, body=non_xml_content)
|
|
http_stubber.add_response()
|
|
response = s3.put_object(Bucket='mybucket', Key='mykey', Body=b'foo')
|
|
# The first response should have been retried even though the xml is
|
|
# invalid and eventually return the 200 response.
|
|
self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 200)
|
|
self.assertEqual(len(http_stubber.requests), 2)
|
|
|
|
|
|
class TestS3SigV4(BaseS3OperationTest):
|
|
def setUp(self):
|
|
super(TestS3SigV4, self).setUp()
|
|
self.client = self.session.create_client(
|
|
's3', self.region, config=Config(signature_version='s3v4'))
|
|
self.http_stubber = ClientHTTPStubber(self.client)
|
|
self.http_stubber.add_response()
|
|
|
|
def get_sent_headers(self):
|
|
return self.http_stubber.requests[0].headers
|
|
|
|
def test_content_md5_set(self):
|
|
with self.http_stubber:
|
|
self.client.put_object(Bucket='foo', Key='bar', Body='baz')
|
|
self.assertIn('content-md5', self.get_sent_headers())
|
|
|
|
def test_content_sha256_set_if_config_value_is_true(self):
|
|
config = Config(signature_version='s3v4', s3={
|
|
'payload_signing_enabled': True
|
|
})
|
|
self.client = self.session.create_client(
|
|
's3', self.region, config=config)
|
|
self.http_stubber = ClientHTTPStubber(self.client)
|
|
self.http_stubber.add_response()
|
|
with self.http_stubber:
|
|
self.client.put_object(Bucket='foo', Key='bar', Body='baz')
|
|
sent_headers = self.get_sent_headers()
|
|
sha_header = sent_headers.get('x-amz-content-sha256')
|
|
self.assertNotEqual(sha_header, b'UNSIGNED-PAYLOAD')
|
|
|
|
def test_content_sha256_not_set_if_config_value_is_false(self):
|
|
config = Config(signature_version='s3v4', s3={
|
|
'payload_signing_enabled': False
|
|
})
|
|
self.client = self.session.create_client(
|
|
's3', self.region, config=config)
|
|
self.http_stubber = ClientHTTPStubber(self.client)
|
|
self.http_stubber.add_response()
|
|
with self.http_stubber:
|
|
self.client.put_object(Bucket='foo', Key='bar', Body='baz')
|
|
sent_headers = self.get_sent_headers()
|
|
sha_header = sent_headers.get('x-amz-content-sha256')
|
|
self.assertEqual(sha_header, b'UNSIGNED-PAYLOAD')
|
|
|
|
def test_content_sha256_set_if_md5_is_unavailable(self):
|
|
with mock.patch('botocore.auth.MD5_AVAILABLE', False):
|
|
with mock.patch('botocore.handlers.MD5_AVAILABLE', False):
|
|
with self.http_stubber:
|
|
self.client.put_object(Bucket='foo', Key='bar', Body='baz')
|
|
sent_headers = self.get_sent_headers()
|
|
unsigned = 'UNSIGNED-PAYLOAD'
|
|
self.assertNotEqual(sent_headers['x-amz-content-sha256'], unsigned)
|
|
self.assertNotIn('content-md5', sent_headers)
|
|
|
|
|
|
|
|
class TestCanSendIntegerHeaders(BaseSessionTest):
|
|
|
|
def test_int_values_with_sigv4(self):
|
|
s3 = self.session.create_client(
|
|
's3', config=Config(signature_version='s3v4'))
|
|
with ClientHTTPStubber(s3) as http_stubber:
|
|
http_stubber.add_response()
|
|
s3.upload_part(Bucket='foo', Key='bar', Body=b'foo',
|
|
UploadId='bar', PartNumber=1, ContentLength=3)
|
|
headers = http_stubber.requests[0].headers
|
|
# Verify that the request integer value of 3 has been converted to
|
|
# string '3'. This also means we've made it pass the signer which
|
|
# expects string values in order to sign properly.
|
|
self.assertEqual(headers['Content-Length'], b'3')
|
|
|
|
|
|
|
|
class TestRegionRedirect(BaseS3OperationTest):
|
|
def setUp(self):
|
|
super(TestRegionRedirect, self).setUp()
|
|
self.client = self.session.create_client(
|
|
's3', 'us-west-2', config=Config(
|
|
signature_version='s3v4',
|
|
s3={'addressing_style': 'path'},
|
|
))
|
|
self.http_stubber = ClientHTTPStubber(self.client)
|
|
|
|
self.redirect_response = {
|
|
'status': 301,
|
|
'headers': {'x-amz-bucket-region': 'eu-central-1'},
|
|
'body': (
|
|
b'<?xml version="1.0" encoding="UTF-8"?>\n'
|
|
b'<Error>'
|
|
b' <Code>PermanentRedirect</Code>'
|
|
b' <Message>The bucket you are attempting to access must be'
|
|
b' addressed using the specified endpoint. Please send '
|
|
b' all future requests to this endpoint.'
|
|
b' </Message>'
|
|
b' <Bucket>foo</Bucket>'
|
|
b' <Endpoint>foo.s3.eu-central-1.amazonaws.com</Endpoint>'
|
|
b'</Error>'
|
|
)
|
|
}
|
|
self.bad_signing_region_response = {
|
|
'status': 400,
|
|
'headers': {'x-amz-bucket-region': 'eu-central-1'},
|
|
'body': (
|
|
b'<?xml version="1.0" encoding="UTF-8"?>'
|
|
b'<Error>'
|
|
b' <Code>AuthorizationHeaderMalformed</Code>'
|
|
b' <Message>the region us-west-2 is wrong; '
|
|
b'expecting eu-central-1</Message>'
|
|
b' <Region>eu-central-1</Region>'
|
|
b' <RequestId>BD9AA1730D454E39</RequestId>'
|
|
b' <HostId></HostId>'
|
|
b'</Error>'
|
|
)
|
|
}
|
|
self.success_response = {
|
|
'status': 200,
|
|
'headers': {},
|
|
'body': (
|
|
b'<?xml version="1.0" encoding="UTF-8"?>\n'
|
|
b'<ListBucketResult>'
|
|
b' <Name>foo</Name>'
|
|
b' <Prefix></Prefix>'
|
|
b' <Marker></Marker>'
|
|
b' <MaxKeys>1000</MaxKeys>'
|
|
b' <EncodingType>url</EncodingType>'
|
|
b' <IsTruncated>false</IsTruncated>'
|
|
b'</ListBucketResult>'
|
|
)
|
|
}
|
|
|
|
def test_region_redirect(self):
|
|
self.http_stubber.add_response(**self.redirect_response)
|
|
self.http_stubber.add_response(**self.success_response)
|
|
with self.http_stubber:
|
|
response = self.client.list_objects(Bucket='foo')
|
|
self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 200)
|
|
self.assertEqual(len(self.http_stubber.requests), 2)
|
|
|
|
initial_url = ('https://s3.us-west-2.amazonaws.com/foo'
|
|
'?encoding-type=url')
|
|
self.assertEqual(self.http_stubber.requests[0].url, initial_url)
|
|
|
|
fixed_url = ('https://s3.eu-central-1.amazonaws.com/foo'
|
|
'?encoding-type=url')
|
|
self.assertEqual(self.http_stubber.requests[1].url, fixed_url)
|
|
|
|
def test_region_redirect_cache(self):
|
|
self.http_stubber.add_response(**self.redirect_response)
|
|
self.http_stubber.add_response(**self.success_response)
|
|
self.http_stubber.add_response(**self.success_response)
|
|
|
|
with self.http_stubber:
|
|
first_response = self.client.list_objects(Bucket='foo')
|
|
second_response = self.client.list_objects(Bucket='foo')
|
|
|
|
self.assertEqual(
|
|
first_response['ResponseMetadata']['HTTPStatusCode'], 200)
|
|
self.assertEqual(
|
|
second_response['ResponseMetadata']['HTTPStatusCode'], 200)
|
|
|
|
self.assertEqual(len(self.http_stubber.requests), 3)
|
|
initial_url = ('https://s3.us-west-2.amazonaws.com/foo'
|
|
'?encoding-type=url')
|
|
self.assertEqual(self.http_stubber.requests[0].url, initial_url)
|
|
|
|
fixed_url = ('https://s3.eu-central-1.amazonaws.com/foo'
|
|
'?encoding-type=url')
|
|
self.assertEqual(self.http_stubber.requests[1].url, fixed_url)
|
|
self.assertEqual(self.http_stubber.requests[2].url, fixed_url)
|
|
|
|
def test_resign_request_with_region_when_needed(self):
|
|
|
|
# Create a client with no explicit configuration so we can
|
|
# verify the default behavior.
|
|
client = self.session.create_client('s3', 'us-west-2')
|
|
with ClientHTTPStubber(client) as http_stubber:
|
|
http_stubber.add_response(**self.bad_signing_region_response)
|
|
http_stubber.add_response(**self.success_response)
|
|
first_response = client.list_objects(Bucket='foo')
|
|
self.assertEqual(
|
|
first_response['ResponseMetadata']['HTTPStatusCode'], 200)
|
|
|
|
self.assertEqual(len(http_stubber.requests), 2)
|
|
initial_url = ('https://foo.s3.us-west-2.amazonaws.com/'
|
|
'?encoding-type=url')
|
|
self.assertEqual(http_stubber.requests[0].url, initial_url)
|
|
|
|
fixed_url = ('https://foo.s3.eu-central-1.amazonaws.com/'
|
|
'?encoding-type=url')
|
|
self.assertEqual(http_stubber.requests[1].url, fixed_url)
|
|
|
|
def test_resign_request_in_us_east_1(self):
|
|
region_headers = {'x-amz-bucket-region': 'eu-central-1'}
|
|
|
|
# Verify that the default behavior in us-east-1 will redirect
|
|
client = self.session.create_client('s3', 'us-east-1')
|
|
with ClientHTTPStubber(client) as http_stubber:
|
|
http_stubber.add_response(status=400)
|
|
http_stubber.add_response(status=400, headers=region_headers)
|
|
http_stubber.add_response(headers=region_headers)
|
|
http_stubber.add_response()
|
|
response = client.head_object(Bucket='foo', Key='bar')
|
|
self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 200)
|
|
|
|
self.assertEqual(len(http_stubber.requests), 4)
|
|
initial_url = ('https://foo.s3.amazonaws.com/bar')
|
|
self.assertEqual(http_stubber.requests[0].url, initial_url)
|
|
|
|
fixed_url = ('https://foo.s3.eu-central-1.amazonaws.com/bar')
|
|
self.assertEqual(http_stubber.requests[-1].url, fixed_url)
|
|
|
|
def test_resign_request_in_us_east_1_fails(self):
|
|
region_headers = {'x-amz-bucket-region': 'eu-central-1'}
|
|
|
|
# Verify that the final 400 response is propagated
|
|
# back to the user.
|
|
client = self.session.create_client('s3', 'us-east-1')
|
|
with ClientHTTPStubber(client) as http_stubber:
|
|
http_stubber.add_response(status=400)
|
|
http_stubber.add_response(status=400, headers=region_headers)
|
|
http_stubber.add_response(headers=region_headers)
|
|
# The final request still fails with a 400.
|
|
http_stubber.add_response(status=400)
|
|
with self.assertRaises(ClientError) as e:
|
|
client.head_object(Bucket='foo', Key='bar')
|
|
self.assertEqual(len(http_stubber.requests), 4)
|
|
|
|
|
|
class TestGeneratePresigned(BaseS3OperationTest):
|
|
def test_generate_unauthed_url(self):
|
|
config = Config(signature_version=botocore.UNSIGNED)
|
|
client = self.session.create_client('s3', self.region, config=config)
|
|
url = client.generate_presigned_url(
|
|
ClientMethod='get_object',
|
|
Params={
|
|
'Bucket': 'foo',
|
|
'Key': 'bar'
|
|
})
|
|
self.assertEqual(url, 'https://foo.s3.amazonaws.com/bar')
|
|
|
|
def test_generate_unauthed_post(self):
|
|
config = Config(signature_version=botocore.UNSIGNED)
|
|
client = self.session.create_client('s3', self.region, config=config)
|
|
parts = client.generate_presigned_post(Bucket='foo', Key='bar')
|
|
expected = {
|
|
'fields': {'key': 'bar'},
|
|
'url': 'https://foo.s3.amazonaws.com/'
|
|
}
|
|
self.assertEqual(parts, expected)
|
|
|
|
def test_default_presign_uses_sigv2(self):
|
|
url = self.client.generate_presigned_url(ClientMethod='list_buckets')
|
|
self.assertNotIn('Algorithm=AWS4-HMAC-SHA256', url)
|
|
|
|
def test_sigv4_presign(self):
|
|
config = Config(signature_version='s3v4')
|
|
client = self.session.create_client('s3', self.region, config=config)
|
|
url = client.generate_presigned_url(ClientMethod='list_buckets')
|
|
self.assertIn('Algorithm=AWS4-HMAC-SHA256', url)
|
|
|
|
def test_sigv2_presign(self):
|
|
config = Config(signature_version='s3')
|
|
client = self.session.create_client('s3', self.region, config=config)
|
|
url = client.generate_presigned_url(ClientMethod='list_buckets')
|
|
self.assertNotIn('Algorithm=AWS4-HMAC-SHA256', url)
|
|
|
|
def test_uses_sigv4_for_unknown_region(self):
|
|
client = self.session.create_client('s3', 'us-west-88')
|
|
url = client.generate_presigned_url(ClientMethod='list_buckets')
|
|
self.assertIn('Algorithm=AWS4-HMAC-SHA256', url)
|
|
|
|
def test_default_presign_sigv4_in_sigv4_only_region(self):
|
|
client = self.session.create_client('s3', 'us-east-2')
|
|
url = client.generate_presigned_url(ClientMethod='list_buckets')
|
|
self.assertIn('Algorithm=AWS4-HMAC-SHA256', url)
|
|
|
|
def test_presign_unsigned(self):
|
|
config = Config(signature_version=botocore.UNSIGNED)
|
|
client = self.session.create_client('s3', 'us-east-2', config=config)
|
|
url = client.generate_presigned_url(ClientMethod='list_buckets')
|
|
self.assertEqual(
|
|
'https://s3.us-east-2.amazonaws.com/', url)
|
|
|
|
def test_presign_url_with_ssec(self):
|
|
config = Config(signature_version='s3')
|
|
client = self.session.create_client('s3', 'us-east-1', config=config)
|
|
url = client.generate_presigned_url(
|
|
ClientMethod='get_object',
|
|
Params={
|
|
'Bucket': 'mybucket',
|
|
'Key': 'mykey',
|
|
'SSECustomerKey': 'a' * 32,
|
|
'SSECustomerAlgorithm': 'AES256'
|
|
}
|
|
)
|
|
# The md5 of the sse-c key will be injected when parameters are
|
|
# built so it should show up in the presigned url as well.
|
|
self.assertIn(
|
|
'x-amz-server-side-encryption-customer-key-md5=', url
|
|
)
|
|
|
|
def test_presign_s3_accelerate(self):
|
|
config = Config(signature_version=botocore.UNSIGNED,
|
|
s3={'use_accelerate_endpoint': True})
|
|
client = self.session.create_client('s3', 'us-east-1', config=config)
|
|
url = client.generate_presigned_url(
|
|
ClientMethod='get_object',
|
|
Params={'Bucket': 'mybucket', 'Key': 'mykey'}
|
|
)
|
|
# The url should be the accelerate endpoint
|
|
self.assertEqual(
|
|
'https://mybucket.s3-accelerate.amazonaws.com/mykey', url)
|
|
|
|
def test_presign_post_s3_accelerate(self):
|
|
config = Config(signature_version=botocore.UNSIGNED,
|
|
s3={'use_accelerate_endpoint': True})
|
|
client = self.session.create_client('s3', 'us-east-1', config=config)
|
|
parts = client.generate_presigned_post(
|
|
Bucket='mybucket', Key='mykey')
|
|
# The url should be the accelerate endpoint
|
|
expected = {
|
|
'fields': {'key': 'mykey'},
|
|
'url': 'https://mybucket.s3-accelerate.amazonaws.com/'
|
|
}
|
|
self.assertEqual(parts, expected)
|
|
|
|
|
|
def test_correct_url_used_for_s3():
|
|
# Test that given various sets of config options and bucket names,
|
|
# we construct the expect endpoint url.
|
|
t = S3AddressingCases(_verify_expected_endpoint_url)
|
|
|
|
# The default behavior for sigv2. DNS compatible buckets
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.us-west-2.amazonaws.com/key')
|
|
yield t.case(region='us-east-1', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-west-1', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.us-west-1.amazonaws.com/key')
|
|
yield t.case(region='us-west-1', bucket='bucket', key='key',
|
|
signature_version='s3', is_secure=False,
|
|
expected_url='http://bucket.s3.us-west-1.amazonaws.com/key')
|
|
|
|
# Virtual host addressing is independent of signature version.
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url=(
|
|
'https://bucket.s3.us-west-2.amazonaws.com/key'))
|
|
yield t.case(region='us-east-1', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-west-1', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url=(
|
|
'https://bucket.s3.us-west-1.amazonaws.com/key'))
|
|
yield t.case(region='us-west-1', bucket='bucket', key='key',
|
|
signature_version='s3v4', is_secure=False,
|
|
expected_url=(
|
|
'http://bucket.s3.us-west-1.amazonaws.com/key'))
|
|
yield t.case(
|
|
region='us-west-1', bucket='bucket-with-num-1', key='key',
|
|
signature_version='s3v4', is_secure=False,
|
|
expected_url='http://bucket-with-num-1.s3.us-west-1.amazonaws.com/key')
|
|
|
|
# Regions outside of the 'aws' partition.
|
|
# These should still default to virtual hosted addressing
|
|
# unless explicitly configured otherwise.
|
|
yield t.case(region='cn-north-1', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url=(
|
|
'https://bucket.s3.cn-north-1.amazonaws.com.cn/key'))
|
|
# This isn't actually supported because cn-north-1 is sigv4 only,
|
|
# but we'll still double check that our internal logic is correct
|
|
# when building the expected url.
|
|
yield t.case(region='cn-north-1', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url=(
|
|
'https://bucket.s3.cn-north-1.amazonaws.com.cn/key'))
|
|
# If the request is unsigned, we should have the default
|
|
# fix_s3_host behavior which is to use virtual hosting where
|
|
# possible but fall back to path style when needed.
|
|
yield t.case(region='cn-north-1', bucket='bucket', key='key',
|
|
signature_version=UNSIGNED,
|
|
expected_url=(
|
|
'https://bucket.s3.cn-north-1.amazonaws.com.cn/key'))
|
|
yield t.case(region='cn-north-1', bucket='bucket.dot', key='key',
|
|
signature_version=UNSIGNED,
|
|
expected_url=(
|
|
'https://s3.cn-north-1.amazonaws.com.cn/bucket.dot/key'))
|
|
|
|
# And of course you can explicitly specify which style to use.
|
|
virtual_hosting = {'addressing_style': 'virtual'}
|
|
yield t.case(region='cn-north-1', bucket='bucket', key='key',
|
|
signature_version=UNSIGNED,
|
|
s3_config=virtual_hosting,
|
|
expected_url=(
|
|
'https://bucket.s3.cn-north-1.amazonaws.com.cn/key'))
|
|
path_style = {'addressing_style': 'path'}
|
|
yield t.case(region='cn-north-1', bucket='bucket', key='key',
|
|
signature_version=UNSIGNED,
|
|
s3_config=path_style,
|
|
expected_url=(
|
|
'https://s3.cn-north-1.amazonaws.com.cn/bucket/key'))
|
|
|
|
# If you don't have a DNS compatible bucket, we use path style.
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket.dot', key='key',
|
|
expected_url='https://s3.us-west-2.amazonaws.com/bucket.dot/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket.dot', key='key',
|
|
expected_url='https://s3.amazonaws.com/bucket.dot/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='BucketName', key='key',
|
|
expected_url='https://s3.amazonaws.com/BucketName/key')
|
|
yield t.case(
|
|
region='us-west-1', bucket='bucket_name', key='key',
|
|
expected_url='https://s3.us-west-1.amazonaws.com/bucket_name/key')
|
|
yield t.case(
|
|
region='us-west-1', bucket='-bucket-name', key='key',
|
|
expected_url='https://s3.us-west-1.amazonaws.com/-bucket-name/key')
|
|
yield t.case(
|
|
region='us-west-1', bucket='bucket-name-', key='key',
|
|
expected_url='https://s3.us-west-1.amazonaws.com/bucket-name-/key')
|
|
yield t.case(
|
|
region='us-west-1', bucket='aa', key='key',
|
|
expected_url='https://s3.us-west-1.amazonaws.com/aa/key')
|
|
yield t.case(
|
|
region='us-west-1', bucket='a'*64, key='key',
|
|
expected_url=('https://s3.us-west-1.amazonaws.com/%s/key' % ('a' * 64))
|
|
)
|
|
|
|
# Custom endpoint url should always be used.
|
|
yield t.case(
|
|
customer_provided_endpoint='https://my-custom-s3/',
|
|
bucket='foo', key='bar',
|
|
expected_url='https://my-custom-s3/foo/bar')
|
|
yield t.case(
|
|
customer_provided_endpoint='https://my-custom-s3/',
|
|
bucket='bucket.dots', key='bar',
|
|
expected_url='https://my-custom-s3/bucket.dots/bar')
|
|
# Doesn't matter what region you specify, a custom endpoint url always
|
|
# wins.
|
|
yield t.case(
|
|
customer_provided_endpoint='https://my-custom-s3/',
|
|
region='us-west-2', bucket='foo', key='bar',
|
|
expected_url='https://my-custom-s3/foo/bar')
|
|
|
|
# Explicitly configuring "virtual" addressing_style.
|
|
virtual_hosting = {'addressing_style': 'virtual'}
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=virtual_hosting,
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
s3_config=virtual_hosting,
|
|
expected_url='https://bucket.s3.us-west-2.amazonaws.com/key')
|
|
yield t.case(
|
|
region='eu-central-1', bucket='bucket', key='key',
|
|
s3_config=virtual_hosting,
|
|
expected_url='https://bucket.s3.eu-central-1.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=virtual_hosting,
|
|
customer_provided_endpoint='https://foo.amazonaws.com',
|
|
expected_url='https://bucket.foo.amazonaws.com/key')
|
|
|
|
# Test us-gov with virtual addressing.
|
|
yield t.case(
|
|
region='us-gov-west-1', bucket='bucket', key='key',
|
|
s3_config=virtual_hosting,
|
|
expected_url='https://bucket.s3.us-gov-west-1.amazonaws.com/key')
|
|
|
|
yield t.case(
|
|
region='us-gov-west-1', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.us-gov-west-1.amazonaws.com/key')
|
|
yield t.case(
|
|
region='fips-us-gov-west-1', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3-fips-us-gov-west-1.amazonaws.com/key')
|
|
|
|
|
|
# Test path style addressing.
|
|
path_style = {'addressing_style': 'path'}
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=path_style,
|
|
expected_url='https://s3.amazonaws.com/bucket/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=path_style,
|
|
customer_provided_endpoint='https://foo.amazonaws.com/',
|
|
expected_url='https://foo.amazonaws.com/bucket/key')
|
|
|
|
# S3 accelerate
|
|
use_accelerate = {'use_accelerate_endpoint': True}
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_accelerate,
|
|
expected_url='https://bucket.s3-accelerate.amazonaws.com/key')
|
|
yield t.case(
|
|
# region is ignored with S3 accelerate.
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
s3_config=use_accelerate,
|
|
expected_url='https://bucket.s3-accelerate.amazonaws.com/key')
|
|
# Provided endpoints still get recognized as accelerate endpoints.
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
customer_provided_endpoint='https://s3-accelerate.amazonaws.com',
|
|
expected_url='https://bucket.s3-accelerate.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
customer_provided_endpoint='http://s3-accelerate.amazonaws.com',
|
|
expected_url='http://bucket.s3-accelerate.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_accelerate, is_secure=False,
|
|
# Note we're using http:// because is_secure=False.
|
|
expected_url='http://bucket.s3-accelerate.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# s3-accelerate must be the first part of the url.
|
|
customer_provided_endpoint='https://foo.s3-accelerate.amazonaws.com',
|
|
expected_url='https://foo.s3-accelerate.amazonaws.com/bucket/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# The endpoint must be an Amazon endpoint.
|
|
customer_provided_endpoint='https://s3-accelerate.notamazon.com',
|
|
expected_url='https://s3-accelerate.notamazon.com/bucket/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# Extra components must be whitelisted.
|
|
customer_provided_endpoint='https://s3-accelerate.foo.amazonaws.com',
|
|
expected_url='https://s3-accelerate.foo.amazonaws.com/bucket/key')
|
|
# Use virtual even if path is specified for s3 accelerate because
|
|
# path style will not work with S3 accelerate.
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config={'use_accelerate_endpoint': True,
|
|
'addressing_style': 'path'},
|
|
expected_url='https://bucket.s3-accelerate.amazonaws.com/key')
|
|
|
|
# S3 dual stack endpoints.
|
|
use_dualstack = {'use_dualstack_endpoint': True}
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_dualstack, signature_version='s3',
|
|
# Still default to virtual hosted when possible on sigv2.
|
|
expected_url='https://bucket.s3.dualstack.us-east-1.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
s3_config=use_dualstack, signature_version='s3',
|
|
# Still default to virtual hosted when possible on sigv2.
|
|
expected_url='https://bucket.s3.dualstack.us-west-2.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_dualstack, signature_version='s3v4',
|
|
expected_url='https://bucket.s3.dualstack.us-east-1.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
s3_config=use_dualstack, signature_version='s3v4',
|
|
expected_url='https://bucket.s3.dualstack.us-west-2.amazonaws.com/key')
|
|
# Non DNS compatible buckets use path style for dual stack.
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket.dot', key='key',
|
|
s3_config=use_dualstack,
|
|
# Still default to virtual hosted when possible.
|
|
expected_url=(
|
|
'https://s3.dualstack.us-west-2.amazonaws.com/bucket.dot/key'))
|
|
# Supports is_secure (use_ssl=False in create_client()).
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket.dot', key='key', is_secure=False,
|
|
s3_config=use_dualstack,
|
|
# Still default to virtual hosted when possible.
|
|
expected_url=(
|
|
'http://s3.dualstack.us-west-2.amazonaws.com/bucket.dot/key'))
|
|
|
|
# Is path style is requested, we should use it, even if the bucket is
|
|
# DNS compatible.
|
|
force_path_style = {
|
|
'use_dualstack_endpoint': True,
|
|
'addressing_style': 'path',
|
|
}
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
s3_config=force_path_style,
|
|
# Still default to virtual hosted when possible.
|
|
expected_url='https://s3.dualstack.us-west-2.amazonaws.com/bucket/key')
|
|
|
|
# Accelerate + dual stack
|
|
use_accelerate_dualstack = {
|
|
'use_accelerate_endpoint': True,
|
|
'use_dualstack_endpoint': True,
|
|
}
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_accelerate_dualstack,
|
|
expected_url=(
|
|
'https://bucket.s3-accelerate.dualstack.amazonaws.com/key'))
|
|
yield t.case(
|
|
# Region is ignored with S3 accelerate.
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
s3_config=use_accelerate_dualstack,
|
|
expected_url=(
|
|
'https://bucket.s3-accelerate.dualstack.amazonaws.com/key'))
|
|
# Only s3-accelerate overrides a customer endpoint.
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_dualstack,
|
|
customer_provided_endpoint='https://s3-accelerate.amazonaws.com',
|
|
expected_url=(
|
|
'https://bucket.s3-accelerate.amazonaws.com/key'))
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# Dualstack is whitelisted.
|
|
customer_provided_endpoint=(
|
|
'https://s3-accelerate.dualstack.amazonaws.com'),
|
|
expected_url=(
|
|
'https://bucket.s3-accelerate.dualstack.amazonaws.com/key'))
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# Even whitelisted parts cannot be duplicated.
|
|
customer_provided_endpoint=(
|
|
'https://s3-accelerate.dualstack.dualstack.amazonaws.com'),
|
|
expected_url=(
|
|
'https://s3-accelerate.dualstack.dualstack'
|
|
'.amazonaws.com/bucket/key'))
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# More than two extra parts is not allowed.
|
|
customer_provided_endpoint=(
|
|
'https://s3-accelerate.dualstack.dualstack.dualstack'
|
|
'.amazonaws.com'),
|
|
expected_url=(
|
|
'https://s3-accelerate.dualstack.dualstack.dualstack.amazonaws.com'
|
|
'/bucket/key'))
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
# Extra components must be whitelisted.
|
|
customer_provided_endpoint='https://s3-accelerate.foo.amazonaws.com',
|
|
expected_url='https://s3-accelerate.foo.amazonaws.com/bucket/key')
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_accelerate_dualstack, is_secure=False,
|
|
# Note we're using http:// because is_secure=False.
|
|
expected_url=(
|
|
'http://bucket.s3-accelerate.dualstack.amazonaws.com/key'))
|
|
# Use virtual even if path is specified for s3 accelerate because
|
|
# path style will not work with S3 accelerate.
|
|
use_accelerate_dualstack['addressing_style'] = 'path'
|
|
yield t.case(
|
|
region='us-east-1', bucket='bucket', key='key',
|
|
s3_config=use_accelerate_dualstack,
|
|
expected_url=(
|
|
'https://bucket.s3-accelerate.dualstack.amazonaws.com/key'))
|
|
|
|
|
|
class S3AddressingCases(object):
|
|
def __init__(self, verify_function):
|
|
self._verify = verify_function
|
|
|
|
def case(self, region=None, bucket='bucket', key='key',
|
|
s3_config=None, is_secure=True, customer_provided_endpoint=None,
|
|
expected_url=None, signature_version=None):
|
|
return (
|
|
self._verify, region, bucket, key, s3_config, is_secure,
|
|
customer_provided_endpoint, expected_url, signature_version
|
|
)
|
|
|
|
|
|
def _verify_expected_endpoint_url(region, bucket, key, s3_config,
|
|
is_secure=True,
|
|
customer_provided_endpoint=None,
|
|
expected_url=None, signature_version=None):
|
|
environ = {}
|
|
with mock.patch('os.environ', environ):
|
|
environ['AWS_ACCESS_KEY_ID'] = 'access_key'
|
|
environ['AWS_SECRET_ACCESS_KEY'] = 'secret_key'
|
|
environ['AWS_CONFIG_FILE'] = 'no-exist-foo'
|
|
environ['AWS_SHARED_CREDENTIALS_FILE'] = 'no-exist-foo'
|
|
session = create_session()
|
|
session.config_filename = 'no-exist-foo'
|
|
config = Config(
|
|
signature_version=signature_version,
|
|
s3=s3_config
|
|
)
|
|
s3 = session.create_client('s3', region_name=region, use_ssl=is_secure,
|
|
config=config,
|
|
endpoint_url=customer_provided_endpoint)
|
|
with ClientHTTPStubber(s3) as http_stubber:
|
|
http_stubber.add_response()
|
|
s3.put_object(Bucket=bucket, Key=key, Body=b'bar')
|
|
assert_equal(http_stubber.requests[0].url, expected_url)
|
|
|
|
|
|
def _create_s3_client(region, is_secure, endpoint_url, s3_config,
|
|
signature_version):
|
|
environ = {}
|
|
with mock.patch('os.environ', environ):
|
|
environ['AWS_ACCESS_KEY_ID'] = 'access_key'
|
|
environ['AWS_SECRET_ACCESS_KEY'] = 'secret_key'
|
|
environ['AWS_CONFIG_FILE'] = 'no-exist-foo'
|
|
environ['AWS_SHARED_CREDENTIALS_FILE'] = 'no-exist-foo'
|
|
session = create_session()
|
|
session.config_filename = 'no-exist-foo'
|
|
config = Config(
|
|
signature_version=signature_version,
|
|
s3=s3_config
|
|
)
|
|
s3 = session.create_client('s3', region_name=region, use_ssl=is_secure,
|
|
config=config,
|
|
endpoint_url=endpoint_url)
|
|
return s3
|
|
|
|
|
|
def test_addressing_for_presigned_urls():
|
|
# See TestGeneratePresigned for more detailed test cases
|
|
# on presigned URLs. Here's we're just focusing on the
|
|
# adddressing mode used for presigned URLs.
|
|
# We special case presigned URLs due to backwards
|
|
# compatibility.
|
|
t = S3AddressingCases(_verify_presigned_url_addressing)
|
|
|
|
# us-east-1, or the "global" endpoint. A signature version of
|
|
# None means the user doesn't have signature version configured.
|
|
yield t.case(region='us-east-1', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-east-1', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-east-1', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-east-1', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
s3_config={'addressing_style': 'path'},
|
|
expected_url='https://s3.amazonaws.com/bucket/key')
|
|
|
|
# A region that supports both 's3' and 's3v4'.
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
s3_config={'addressing_style': 'path'},
|
|
expected_url='https://s3.us-west-2.amazonaws.com/bucket/key')
|
|
|
|
# An 's3v4' only region.
|
|
yield t.case(region='us-east-2', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-east-2', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-east-2', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
yield t.case(region='us-east-2', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
s3_config={'addressing_style': 'path'},
|
|
expected_url='https://s3.us-east-2.amazonaws.com/bucket/key')
|
|
|
|
# Dualstack endpoints
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
s3_config={'use_dualstack_endpoint': True},
|
|
expected_url='https://bucket.s3.dualstack.us-west-2.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3',
|
|
s3_config={'use_dualstack_endpoint': True},
|
|
expected_url='https://bucket.s3.dualstack.us-west-2.amazonaws.com/key')
|
|
yield t.case(
|
|
region='us-west-2', bucket='bucket', key='key',
|
|
signature_version='s3v4',
|
|
s3_config={'use_dualstack_endpoint': True},
|
|
expected_url='https://bucket.s3.dualstack.us-west-2.amazonaws.com/key')
|
|
|
|
# Accelerate
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
s3_config={'use_accelerate_endpoint': True},
|
|
expected_url='https://bucket.s3-accelerate.amazonaws.com/key')
|
|
|
|
# A region that we don't know about.
|
|
yield t.case(region='us-west-50', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
expected_url='https://bucket.s3.amazonaws.com/key')
|
|
|
|
# Customer provided URL results in us leaving the host untouched.
|
|
yield t.case(region='us-west-2', bucket='bucket', key='key',
|
|
signature_version=None,
|
|
customer_provided_endpoint='https://foo.com/',
|
|
expected_url='https://foo.com/bucket/key')
|
|
|
|
|
|
def _verify_presigned_url_addressing(region, bucket, key, s3_config,
|
|
is_secure=True,
|
|
customer_provided_endpoint=None,
|
|
expected_url=None,
|
|
signature_version=None):
|
|
s3 = _create_s3_client(region=region, is_secure=is_secure,
|
|
endpoint_url=customer_provided_endpoint,
|
|
s3_config=s3_config,
|
|
signature_version=signature_version)
|
|
url = s3.generate_presigned_url(
|
|
'get_object', {'Bucket': bucket, 'Key': key})
|
|
# We're not trying to verify the params for URL presigning,
|
|
# those are tested elsewhere. We just care about the hostname/path.
|
|
parts = urlsplit(url)
|
|
actual = '%s://%s%s' % parts[:3]
|
|
assert_equal(actual, expected_url)
|