auth.py
19.1 KB
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
# -*- coding: utf-8 -*-
import hmac
import hashlib
import time
from . import utils
from .compat import urlquote, to_bytes, is_py2
from .headers import *
import logging
from .credentials import StaticCredentialsProvider
AUTH_VERSION_1 = 'v1'
AUTH_VERSION_2 = 'v2'
logger = logging.getLogger(__name__)
def make_auth(access_key_id, access_key_secret, auth_version=AUTH_VERSION_1):
if auth_version == AUTH_VERSION_2:
logger.debug("Init Auth V2: access_key_id: {0}, access_key_secret: ******".format(access_key_id))
return AuthV2(access_key_id.strip(), access_key_secret.strip())
else:
logger.debug("Init Auth v1: access_key_id: {0}, access_key_secret: ******".format(access_key_id))
return Auth(access_key_id.strip(), access_key_secret.strip())
class AuthBase(object):
"""用于保存用户AccessKeyId、AccessKeySecret,以及计算签名的对象。"""
def __init__(self, credentials_provider):
self.credentials_provider = credentials_provider
def _sign_rtmp_url(self, url, bucket_name, channel_name, expires, params):
credentials = self.credentials_provider.get_credentials()
if credentials.get_security_token():
params['security-token'] = credentials.get_security_token()
expiration_time = int(time.time()) + expires
canonicalized_resource = "/%s/%s" % (bucket_name, channel_name)
canonicalized_params = []
if params:
items = params.items()
for k, v in items:
if k != "OSSAccessKeyId" and k != "Signature" and k != "Expires" and k != "SecurityToken":
canonicalized_params.append((k, v))
canonicalized_params.sort(key=lambda e: e[0])
canon_params_str = ''
for k, v in canonicalized_params:
canon_params_str += '%s:%s\n' % (k, v)
p = params if params else {}
string_to_sign = str(expiration_time) + "\n" + canon_params_str + canonicalized_resource
logger.debug('Sign Rtmp url: string to be signed = {0}'.format(string_to_sign))
h = hmac.new(to_bytes(credentials.get_access_key_secret()), to_bytes(string_to_sign), hashlib.sha1)
signature = utils.b64encode_as_string(h.digest())
p['OSSAccessKeyId'] = credentials.get_access_key_id()
p['Expires'] = str(expiration_time)
p['Signature'] = signature
return url + '?' + '&'.join(_param_to_quoted_query(k, v) for k, v in p.items())
class ProviderAuth(AuthBase):
"""签名版本1
默认构造函数同父类AuthBase,需要传递credentials_provider
"""
_subresource_key_set = frozenset(
['response-content-type', 'response-content-language',
'response-cache-control', 'logging', 'response-content-encoding',
'acl', 'uploadId', 'uploads', 'partNumber', 'group', 'link',
'delete', 'website', 'location', 'objectInfo', 'objectMeta',
'response-expires', 'response-content-disposition', 'cors', 'lifecycle',
'restore', 'qos', 'referer', 'stat', 'bucketInfo', 'append', 'position', 'security-token',
'live', 'comp', 'status', 'vod', 'startTime', 'endTime', 'x-oss-process',
'symlink', 'callback', 'callback-var', 'tagging', 'encryption', 'versions',
'versioning', 'versionId', 'policy', 'requestPayment', 'x-oss-traffic-limit', 'qosInfo', 'asyncFetch',
'x-oss-request-payer', 'sequential', 'inventory', 'inventoryId', 'continuation-token', 'callback',
'callback-var', 'worm', 'wormId', 'wormExtend', 'replication', 'replicationLocation',
'replicationProgress', 'transferAcceleration']
)
def _sign_request(self, req, bucket_name, key):
credentials = self.credentials_provider.get_credentials()
if credentials.get_security_token():
req.headers[OSS_SECURITY_TOKEN] = credentials.get_security_token()
req.headers['date'] = utils.http_date()
signature = self.__make_signature(req, bucket_name, key, credentials)
req.headers['authorization'] = "OSS {0}:{1}".format(credentials.get_access_key_id(), signature)
def _sign_url(self, req, bucket_name, key, expires):
credentials = self.credentials_provider.get_credentials()
if credentials.get_security_token():
req.params['security-token'] = credentials.get_security_token()
expiration_time = int(time.time()) + expires
req.headers['date'] = str(expiration_time)
signature = self.__make_signature(req, bucket_name, key, credentials)
req.params['OSSAccessKeyId'] = credentials.get_access_key_id()
req.params['Expires'] = str(expiration_time)
req.params['Signature'] = signature
return req.url + '?' + '&'.join(_param_to_quoted_query(k, v) for k, v in req.params.items())
def __make_signature(self, req, bucket_name, key, credentials):
if is_py2:
string_to_sign = self.__get_string_to_sign(req, bucket_name, key)
else:
string_to_sign = self.__get_bytes_to_sign(req, bucket_name, key)
logger.debug('Make signature: string to be signed = {0}'.format(string_to_sign))
h = hmac.new(to_bytes(credentials.get_access_key_secret()), to_bytes(string_to_sign), hashlib.sha1)
return utils.b64encode_as_string(h.digest())
def __get_string_to_sign(self, req, bucket_name, key):
resource_string = self.__get_resource_string(req, bucket_name, key)
headers_string = self.__get_headers_string(req)
content_md5 = req.headers.get('content-md5', '')
content_type = req.headers.get('content-type', '')
date = req.headers.get('date', '')
return '\n'.join([req.method,
content_md5,
content_type,
date,
headers_string + resource_string])
def __get_headers_string(self, req):
headers = req.headers
canon_headers = []
for k, v in headers.items():
lower_key = k.lower()
if lower_key.startswith('x-oss-'):
canon_headers.append((lower_key, v))
canon_headers.sort(key=lambda x: x[0])
if canon_headers:
return '\n'.join(k + ':' + v for k, v in canon_headers) + '\n'
else:
return ''
def __get_resource_string(self, req, bucket_name, key):
if not bucket_name:
return '/' + self.__get_subresource_string(req.params)
else:
return '/{0}/{1}{2}'.format(bucket_name, key, self.__get_subresource_string(req.params))
def __get_subresource_string(self, params):
if not params:
return ''
subresource_params = []
for key, value in params.items():
if key in self._subresource_key_set:
subresource_params.append((key, value))
subresource_params.sort(key=lambda e: e[0])
if subresource_params:
return '?' + '&'.join(self.__param_to_query(k, v) for k, v in subresource_params)
else:
return ''
def __param_to_query(self, k, v):
if v:
return k + '=' + v
else:
return k
def __get_bytes_to_sign(self, req, bucket_name, key):
resource_bytes = self.__get_resource_string(req, bucket_name, key).encode('utf-8')
headers_bytes = self.__get_headers_bytes(req)
content_md5 = req.headers.get('content-md5', '').encode('utf-8')
content_type = req.headers.get('content-type', '').encode('utf-8')
date = req.headers.get('date', '').encode('utf-8')
return b'\n'.join([req.method.encode('utf-8'),
content_md5,
content_type,
date,
headers_bytes + resource_bytes])
def __get_headers_bytes(self, req):
headers = req.headers
canon_headers = []
for k, v in headers.items():
lower_key = k.lower()
if lower_key.startswith('x-oss-'):
canon_headers.append((lower_key, v))
canon_headers.sort(key=lambda x: x[0])
if canon_headers:
return b'\n'.join(to_bytes(k) + b':' + to_bytes(v) for k, v in canon_headers) + b'\n'
else:
return b''
class Auth(ProviderAuth):
"""签名版本1
"""
def __init__(self, access_key_id, access_key_secret):
credentials_provider = StaticCredentialsProvider(access_key_id.strip(), access_key_secret.strip())
super(Auth, self).__init__(credentials_provider)
class AnonymousAuth(object):
"""用于匿名访问。
.. note::
匿名用户只能读取public-read的Bucket,或只能读取、写入public-read-write的Bucket。
不能进行Service、Bucket相关的操作,也不能罗列文件等。
"""
def _sign_request(self, req, bucket_name, key):
pass
def _sign_url(self, req, bucket_name, key, expires):
return req.url + '?' + '&'.join(_param_to_quoted_query(k, v) for k, v in req.params.items())
def _sign_rtmp_url(self, url, bucket_name, channel_name, expires, params):
return url + '?' + '&'.join(_param_to_quoted_query(k, v) for k, v in params.items())
class StsAuth(object):
"""用于STS临时凭证访问。可以通过官方STS客户端获得临时密钥(AccessKeyId、AccessKeySecret)以及临时安全令牌(SecurityToken)。
注意到临时凭证会在一段时间后过期,在此之前需要重新获取临时凭证,并更新 :class:`Bucket <oss2.Bucket>` 的 `auth` 成员变量为新
的 `StsAuth` 实例。
:param str access_key_id: 临时AccessKeyId
:param str access_key_secret: 临时AccessKeySecret
:param str security_token: 临时安全令牌(SecurityToken)
:param str auth_version: 需要生成auth的版本,默认为AUTH_VERSION_1(v1)
"""
def __init__(self, access_key_id, access_key_secret, security_token, auth_version=AUTH_VERSION_1):
logger.debug("Init StsAuth: access_key_id: {0}, access_key_secret: ******, security_token: ******".format(access_key_id))
credentials_provider = StaticCredentialsProvider(access_key_id, access_key_secret, security_token)
self.__auth = ProviderAuthV2(credentials_provider) if auth_version == AUTH_VERSION_2 else ProviderAuth(credentials_provider)
def _sign_request(self, req, bucket_name, key):
self.__auth._sign_request(req, bucket_name, key)
def _sign_url(self, req, bucket_name, key, expires):
return self.__auth._sign_url(req, bucket_name, key, expires)
def _sign_rtmp_url(self, url, bucket_name, channel_name, expires, params):
return self.__auth._sign_rtmp_url(url, bucket_name, channel_name, expires, params)
def _param_to_quoted_query(k, v):
if v:
return urlquote(k, '') + '=' + urlquote(v, '')
else:
return urlquote(k, '')
def v2_uri_encode(raw_text):
raw_text = to_bytes(raw_text)
res = ''
for b in raw_text:
if isinstance(b, int):
c = chr(b)
else:
c = b
if (c >= 'A' and c <= 'Z') or (c >= 'a' and c <= 'z')\
or (c >= '0' and c <= '9') or c in ['_', '-', '~', '.']:
res += c
else:
res += "%{0:02X}".format(ord(c))
return res
_DEFAULT_ADDITIONAL_HEADERS = set(['range',
'if-modified-since'])
class ProviderAuthV2(AuthBase):
"""签名版本2,默认构造函数同父类AuthBase,需要传递credentials_provider
与版本1的区别在:
1. 使用SHA256算法,具有更高的安全性
2. 参数计算包含所有的HTTP查询参数
"""
def _sign_request(self, req, bucket_name, key, in_additional_headers=None):
"""把authorization放入req的header里面
:param req: authorization信息将会加入到这个请求的header里面
:type req: oss2.http.Request
:param bucket_name: bucket名称
:param key: OSS文件名
:param in_additional_headers: 加入签名计算的额外header列表
"""
credentials = self.credentials_provider.get_credentials()
if credentials.get_security_token():
req.headers[OSS_SECURITY_TOKEN] = credentials.get_security_token()
if in_additional_headers is None:
in_additional_headers = _DEFAULT_ADDITIONAL_HEADERS
additional_headers = self.__get_additional_headers(req, in_additional_headers)
req.headers['date'] = utils.http_date()
signature = self.__make_signature(req, bucket_name, key, additional_headers, credentials)
if additional_headers:
req.headers['authorization'] = "OSS2 AccessKeyId:{0},AdditionalHeaders:{1},Signature:{2}"\
.format(credentials.get_access_key_id(), ';'.join(additional_headers), signature)
else:
req.headers['authorization'] = "OSS2 AccessKeyId:{0},Signature:{1}".format(credentials.get_access_key_id(), signature)
def _sign_url(self, req, bucket_name, key, expires, in_additional_headers=None):
"""返回一个签过名的URL
:param req: 需要签名的请求
:type req: oss2.http.Request
:param bucket_name: bucket名称
:param key: OSS文件名
:param int expires: 返回的url将在`expires`秒后过期.
:param in_additional_headers: 加入签名计算的额外header列表
:return: a signed URL
"""
credentials = self.credentials_provider.get_credentials()
if credentials.get_security_token():
req.params['security-token'] = credentials.get_security_token()
if in_additional_headers is None:
in_additional_headers = set()
additional_headers = self.__get_additional_headers(req, in_additional_headers)
expiration_time = int(time.time()) + expires
req.headers['date'] = str(expiration_time) # re-use __make_signature by setting the 'date' header
req.params['x-oss-signature-version'] = 'OSS2'
req.params['x-oss-expires'] = str(expiration_time)
req.params['x-oss-access-key-id'] = credentials.get_access_key_id()
signature = self.__make_signature(req, bucket_name, key, additional_headers, credentials)
req.params['x-oss-signature'] = signature
return req.url + '?' + '&'.join(_param_to_quoted_query(k, v) for k, v in req.params.items())
def __make_signature(self, req, bucket_name, key, additional_headers, credentials):
if is_py2:
string_to_sign = self.__get_string_to_sign(req, bucket_name, key, additional_headers)
else:
string_to_sign = self.__get_bytes_to_sign(req, bucket_name, key, additional_headers)
logger.debug('Make signature: string to be signed = {0}'.format(string_to_sign))
h = hmac.new(to_bytes(credentials.get_access_key_secret()), to_bytes(string_to_sign), hashlib.sha256)
return utils.b64encode_as_string(h.digest())
def __get_additional_headers(self, req, in_additional_headers):
# we add a header into additional_headers only if it is already in req's headers.
additional_headers = set(h.lower() for h in in_additional_headers)
keys_in_header = set(k.lower() for k in req.headers.keys())
return additional_headers & keys_in_header
def __get_string_to_sign(self, req, bucket_name, key, additional_header_list):
verb = req.method
content_md5 = req.headers.get('content-md5', '')
content_type = req.headers.get('content-type', '')
date = req.headers.get('date', '')
canonicalized_oss_headers = self.__get_canonicalized_oss_headers(req, additional_header_list)
additional_headers = ';'.join(sorted(additional_header_list))
canonicalized_resource = self.__get_resource_string(req, bucket_name, key)
return verb + '\n' +\
content_md5 + '\n' +\
content_type + '\n' +\
date + '\n' +\
canonicalized_oss_headers +\
additional_headers + '\n' +\
canonicalized_resource
def __get_resource_string(self, req, bucket_name, key):
if bucket_name:
encoded_uri = v2_uri_encode('/' + bucket_name + '/' + key)
else:
encoded_uri = v2_uri_encode('/')
logger.info('encoded_uri={0} key={1}'.format(encoded_uri, key))
return encoded_uri + self.__get_canonalized_query_string(req)
def __get_canonalized_query_string(self, req):
encoded_params = {}
for param, value in req.params.items():
encoded_params[v2_uri_encode(param)] = v2_uri_encode(value)
if not encoded_params:
return ''
sorted_params = sorted(encoded_params.items(), key=lambda e: e[0])
return '?' + '&'.join(self.__param_to_query(k, v) for k, v in sorted_params)
def __param_to_query(self, k, v):
if v:
return k + '=' + v
else:
return k
def __get_canonicalized_oss_headers(self, req, additional_headers):
"""
:param additional_headers: 小写的headers列表, 并且这些headers都不以'x-oss-'为前缀.
"""
canon_headers = []
for k, v in req.headers.items():
lower_key = k.lower()
if lower_key.startswith('x-oss-') or lower_key in additional_headers:
canon_headers.append((lower_key, v))
canon_headers.sort(key=lambda x: x[0])
return ''.join(v[0] + ':' + v[1] + '\n' for v in canon_headers)
def __get_bytes_to_sign(self, req, bucket_name, key, additional_header_list):
verb = req.method.encode('utf-8')
content_md5 = req.headers.get('content-md5', '').encode('utf-8')
content_type = req.headers.get('content-type', '').encode('utf-8')
date = req.headers.get('date', '').encode('utf-8')
canonicalized_oss_headers = self.__get_canonicalized_oss_headers_bytes(req, additional_header_list)
additional_headers = ';'.join(sorted(additional_header_list)).encode('utf-8')
canonicalized_resource = self.__get_resource_string(req, bucket_name, key).encode('utf-8')
return verb + b'\n' +\
content_md5 + b'\n' +\
content_type + b'\n' +\
date + b'\n' +\
canonicalized_oss_headers +\
additional_headers + b'\n' +\
canonicalized_resource
def __get_canonicalized_oss_headers_bytes(self, req, additional_headers):
"""
:param additional_headers: 小写的headers列表, 并且这些headers都不以'x-oss-'为前缀.
"""
canon_headers = []
for k, v in req.headers.items():
lower_key = k.lower()
if lower_key.startswith('x-oss-') or lower_key in additional_headers:
canon_headers.append((lower_key, v))
canon_headers.sort(key=lambda x: x[0])
return b''.join(to_bytes(v[0]) + b':' + to_bytes(v[1]) + b'\n' for v in canon_headers)
class AuthV2(ProviderAuthV2):
"""签名版本2,与版本1的区别在:
1. 使用SHA256算法,具有更高的安全性
2. 参数计算包含所有的HTTP查询参数
"""
def __init__(self, access_key_id, access_key_secret):
credentials_provider = StaticCredentialsProvider(access_key_id.strip(), access_key_secret.strip())
super(AuthV2, self).__init__(credentials_provider)