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
|
# Copyright 2016 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.
import datetime
from botocore.compat import urlsplit
from awscli.clidriver import AWSCLIEntryPoint
from awscli.testutils import (
BaseAWSCommandParamsTest,
create_clidriver,
mock,
temporary_file,
)
# Values used to fix time.time() and datetime.datetime.utcnow()
# so we know the exact values of the signatures generated.
FROZEN_TIMESTAMP = 1471305652
DEFAULT_EXPIRES = 3600
FROZEN_TIME = mock.Mock(return_value=FROZEN_TIMESTAMP)
FROZEN_DATETIME = mock.Mock(
return_value=datetime.datetime(2016, 8, 18, 14, 33, 3, 0)
)
class TestPresignCommand(BaseAWSCommandParamsTest):
prefix = 's3 presign '
def enable_addressing_mode_in_config(self, fileobj, mode):
fileobj.write(
"[default]\n" "s3 =\n" " addressing_style = %s\n" % mode
)
fileobj.flush()
self.environ['AWS_CONFIG_FILE'] = fileobj.name
self.driver = create_clidriver()
self.entry_point = AWSCLIEntryPoint(self.driver)
def enable_sigv4_from_config_file(self, fileobj):
fileobj.write("[default]\n" "s3 =\n" " signature_version = s3v4\n")
fileobj.flush()
self.environ['AWS_CONFIG_FILE'] = fileobj.name
self.driver = create_clidriver()
self.entry_point = AWSCLIEntryPoint(self.driver)
def assert_presigned_url_matches(self, actual_url, expected_match):
"""Verify generated presigned URL matches expected dict.
This method compares an actual URL against a dict of expected
values. The reason that the "expected_match" is a dict instead
of the expected presigned URL is because the query params
are unordered so we can't guarantee an expected query param
ordering.
"""
parts = urlsplit(actual_url)
self.assertEqual(parts.netloc, expected_match['hostname'])
self.assertEqual(parts.path, expected_match['path'])
query_params = self.parse_query_string(parts.query)
self.assertEqual(query_params, expected_match['query_params'])
def parse_query_string(self, query_string):
pairs = []
for part in query_string.split('&'):
pairs.append(part.split('=', 1))
return dict(pairs)
def get_presigned_url_for_cmd(self, cmdline):
with mock.patch('time.time', FROZEN_TIME):
with mock.patch('datetime.datetime') as d:
d.utcnow = FROZEN_DATETIME
stdout = self.assert_params_for_cmd(cmdline, None)[0].strip()
return stdout
def test_generates_a_url(self):
stdout = self.get_presigned_url_for_cmd(
self.prefix + 's3://bucket/key'
)
self.assert_presigned_url_matches(
stdout,
{
'hostname': 'bucket.s3.us-east-1.amazonaws.com',
'path': '/key',
'query_params': {
'X-Amz-Algorithm': 'AWS4-HMAC-SHA256',
'X-Amz-Credential': (
'access_key%2F20160818%2Fus-east-1'
'%2Fs3%2Faws4_request'
),
'X-Amz-Date': '20160818T143303Z',
'X-Amz-Expires': '3600',
'X-Amz-Signature': (
'1297528058f2c8b89cfa52c6a47d6c54890700a1da2470'
'2b06d53e774c0acc95'
),
'X-Amz-SignedHeaders': 'host',
},
},
)
def test_handles_non_dns_compatible_buckets(self):
stdout = self.get_presigned_url_for_cmd(
self.prefix + 's3://bucket.dots/key'
)
self.assert_presigned_url_matches(
stdout,
{
'hostname': 's3.us-east-1.amazonaws.com',
'path': '/bucket.dots/key',
'query_params': {
'X-Amz-Algorithm': 'AWS4-HMAC-SHA256',
'X-Amz-Credential': (
'access_key%2F20160818%2Fus-east-1'
'%2Fs3%2Faws4_request'
),
'X-Amz-Date': '20160818T143303Z',
'X-Amz-Expires': '3600',
'X-Amz-Signature': (
'5a032639cabfe3db0b4b87ba3b12c29f5e42fe74cbba8'
'a0eb69bfb30c6e2d277'
),
'X-Amz-SignedHeaders': 'host',
},
},
)
def test_handles_expires_in(self):
expires_in = 1000
stdout = self.get_presigned_url_for_cmd(
self.prefix + 's3://bucket/key --expires-in %s' % expires_in
)
self.assert_presigned_url_matches(
stdout,
{
'hostname': 'bucket.s3.us-east-1.amazonaws.com',
'path': '/key',
'query_params': {
'X-Amz-Algorithm': 'AWS4-HMAC-SHA256',
'X-Amz-Credential': (
'access_key%2F20160818%2Fus-east-1'
'%2Fs3%2Faws4_request'
),
'X-Amz-Date': '20160818T143303Z',
'X-Amz-Expires': f'{expires_in}',
'X-Amz-Signature': (
'865fb61b021c3bf406c40d41353f584835fff1f158cf1b'
'3e6ec06260ecbb8937'
),
'X-Amz-SignedHeaders': 'host',
},
},
)
def test_handles_sigv4(self):
with temporary_file('w') as f:
self.enable_sigv4_from_config_file(f)
stdout = self.get_presigned_url_for_cmd(
self.prefix + 's3://bucket/key'
)
expected = {
'hostname': 'bucket.s3.us-east-1.amazonaws.com',
'path': '/key',
'query_params': {
'X-Amz-Algorithm': 'AWS4-HMAC-SHA256',
'X-Amz-Credential': (
'access_key%2F20160818%2Fus-east-1' '%2Fs3%2Faws4_request'
),
'X-Amz-Date': '20160818T143303Z',
'X-Amz-Expires': '3600',
'X-Amz-Signature': (
'1297528058f2c8b89cfa52c6a47d6c548907'
'00a1da24702b06d53e774c0acc95'
),
'X-Amz-SignedHeaders': 'host',
},
}
self.assert_presigned_url_matches(stdout, expected)
def test_s3_prefix_not_needed(self):
# Consistent with the 'ls' command.
stdout = self.get_presigned_url_for_cmd(self.prefix + 'bucket/key')
self.assert_presigned_url_matches(
stdout,
{
'hostname': 'bucket.s3.us-east-1.amazonaws.com',
'path': '/key',
'query_params': {
'X-Amz-Algorithm': 'AWS4-HMAC-SHA256',
'X-Amz-Credential': (
'access_key%2F20160818%2Fus-east-1'
'%2Fs3%2Faws4_request'
),
'X-Amz-Date': '20160818T143303Z',
'X-Amz-Expires': '3600',
'X-Amz-Signature': (
'1297528058f2c8b89cfa52c6a47d6c54890700a1da2470'
'2b06d53e774c0acc95'
),
'X-Amz-SignedHeaders': 'host',
},
},
)
def test_can_support_addressing_mode_config(self):
with temporary_file('w') as f:
self.enable_addressing_mode_in_config(f, 'path')
stdout = self.get_presigned_url_for_cmd(
self.prefix + 's3://bucket/key'
)
self.assert_presigned_url_matches(
stdout,
{
'hostname': 's3.us-east-1.amazonaws.com',
'path': '/bucket/key',
'query_params': {
'X-Amz-Algorithm': 'AWS4-HMAC-SHA256',
'X-Amz-Credential': (
'access_key%2F20160818%2Fus-east-1'
'%2Fs3%2Faws4_request'
),
'X-Amz-Date': '20160818T143303Z',
'X-Amz-Expires': '3600',
'X-Amz-Signature': (
'c6dab3560db76aded03e6268338ddb0a6dec00ebc82d6e'
'7abdc305529fcaba74'
),
'X-Amz-SignedHeaders': 'host',
},
},
)
|
