-
Notifications
You must be signed in to change notification settings - Fork 926
/
s3.py
1527 lines (1204 loc) · 49.1 KB
/
s3.py
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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.
import os
import hmac
import time
import base64
from typing import Dict, Optional
from hashlib import sha1
from datetime import datetime
import libcloud.utils.py3
from libcloud.utils.py3 import b, httplib, tostring, urlquote, urlencode
from libcloud.utils.xml import findtext, fixxpath
from libcloud.common.aws import (
AWSDriver,
AWSBaseResponse,
AWSTokenConnection,
SignedAWSConnection,
UnsignedPayloadSentinel,
)
from libcloud.common.base import RawResponse, ConnectionUserAndKey
from libcloud.utils.files import read_in_chunks
from libcloud.common.types import LibcloudError, InvalidCredsError
from libcloud.storage.base import Object, Container, StorageDriver
from libcloud.storage.types import (
ContainerError,
ObjectDoesNotExistError,
ObjectHashMismatchError,
ContainerIsNotEmptyError,
InvalidContainerNameError,
ContainerDoesNotExistError,
ContainerAlreadyExistsError,
)
try:
if libcloud.utils.py3.DEFAULT_LXML:
from lxml.etree import Element, SubElement
else:
from xml.etree.ElementTree import Element, SubElement
except ImportError:
from xml.etree.ElementTree import Element, SubElement
# How long before the token expires
EXPIRATION_SECONDS = 15 * 60
S3_US_STANDARD_HOST = "s3.amazonaws.com"
S3_US_EAST2_HOST = "s3-us-east-2.amazonaws.com"
S3_US_WEST_HOST = "s3-us-west-1.amazonaws.com"
S3_US_WEST_OREGON_HOST = "s3-us-west-2.amazonaws.com"
S3_US_GOV_EAST_HOST = "s3-us-gov-east-1.amazonaws.com"
S3_US_GOV_WEST_HOST = "s3-us-gov-west-1.amazonaws.com"
S3_CN_NORTH_HOST = "s3.cn-north-1.amazonaws.com.cn"
S3_CN_NORTHWEST_HOST = "s3.cn-northwest-1.amazonaws.com.cn"
S3_EU_WEST_HOST = "s3-eu-west-1.amazonaws.com"
S3_EU_WEST2_HOST = "s3-eu-west-2.amazonaws.com"
S3_EU_CENTRAL_HOST = "s3-eu-central-1.amazonaws.com"
S3_EU_NORTH1_HOST = "s3-eu-north-1.amazonaws.com"
S3_AP_SOUTH_HOST = "s3-ap-south-1.amazonaws.com"
S3_AP_SOUTHEAST_HOST = "s3-ap-southeast-1.amazonaws.com"
S3_AP_SOUTHEAST2_HOST = "s3-ap-southeast-2.amazonaws.com"
S3_AP_NORTHEAST1_HOST = "s3-ap-northeast-1.amazonaws.com"
S3_AP_NORTHEAST2_HOST = "s3-ap-northeast-2.amazonaws.com"
S3_AP_NORTHEAST_HOST = S3_AP_NORTHEAST1_HOST
S3_SA_EAST_HOST = "s3-sa-east-1.amazonaws.com"
S3_SA_SOUTHEAST2_HOST = "s3-sa-east-2.amazonaws.com"
S3_CA_CENTRAL_HOST = "s3-ca-central-1.amazonaws.com"
# Maps AWS region name to connection hostname
REGION_TO_HOST_MAP = {
"us-east-1": S3_US_STANDARD_HOST,
"us-east-2": S3_US_EAST2_HOST,
"us-west-1": S3_US_WEST_HOST,
"us-west-2": S3_US_WEST_OREGON_HOST,
"us-gov-east-1": S3_US_GOV_EAST_HOST,
"us-gov-west-1": S3_US_GOV_WEST_HOST,
"cn-north-1": S3_CN_NORTH_HOST,
"cn-northwest-1": S3_CN_NORTHWEST_HOST,
"eu-west-1": S3_EU_WEST_HOST,
"eu-west-2": S3_EU_WEST2_HOST,
"eu-west-3": "s3.eu-west-3.amazonaws.com",
"eu-north-1": "s3.eu-north-1.amazonaws.com",
"eu-central-1": S3_EU_CENTRAL_HOST,
"ap-south-1": S3_AP_SOUTH_HOST,
"ap-southeast-1": S3_AP_SOUTHEAST_HOST,
"ap-southeast-2": S3_AP_SOUTHEAST2_HOST,
"ap-northeast-1": S3_AP_NORTHEAST1_HOST,
"ap-northeast-2": S3_AP_NORTHEAST2_HOST,
"ap-northeast-3": "s3.ap-northeast-3.amazonaws.com",
"sa-east-1": S3_SA_EAST_HOST,
"sa-east-2": S3_SA_SOUTHEAST2_HOST,
"ca-central-1": S3_CA_CENTRAL_HOST,
"me-south-1": "s3.me-south-1.amazonaws.com",
}
API_VERSION = "2006-03-01"
NAMESPACE = "http://s3.amazonaws.com/doc/%s/" % (API_VERSION)
# AWS multi-part chunks must be minimum 5MB
CHUNK_SIZE = 5 * 1024 * 1024
# Desired number of items in each response inside a paginated request in
# ex_iterate_multipart_uploads.
RESPONSES_PER_REQUEST = 100
S3_CDN_URL_DATETIME_FORMAT = "%Y%m%dT%H%M%SZ"
S3_CDN_URL_DATE_FORMAT = "%Y%m%d"
S3_CDN_URL_EXPIRY_HOURS = float(os.getenv("LIBCLOUD_S3_CDN_URL_EXPIRY_HOURS", "24"))
class S3Response(AWSBaseResponse):
namespace = None
valid_response_codes = [
httplib.NOT_FOUND,
httplib.CONFLICT,
httplib.BAD_REQUEST,
httplib.PARTIAL_CONTENT,
]
def success(self):
i = int(self.status)
return 200 <= i <= 299 or i in self.valid_response_codes
def parse_error(self):
if self.status in [httplib.UNAUTHORIZED, httplib.FORBIDDEN]:
raise InvalidCredsError(self.body)
elif self.status == httplib.MOVED_PERMANENTLY:
bucket_region = self.headers.get("x-amz-bucket-region", None)
used_region = self.connection.driver.region
raise LibcloudError(
"This bucket is located in a different "
"region. Please use the correct driver. "
'Bucket region "%s", used region "%s".' % (bucket_region, used_region),
driver=S3StorageDriver,
)
raise LibcloudError(
"Unknown error. Status code: %d" % (self.status), driver=S3StorageDriver
)
class S3RawResponse(S3Response, RawResponse):
pass
class BaseS3Connection(ConnectionUserAndKey):
"""
Represents a single connection to the S3 Endpoint
"""
host = "s3.amazonaws.com"
responseCls = S3Response
rawResponseCls = S3RawResponse
@staticmethod
def get_auth_signature(method, headers, params, expires, secret_key, path, vendor_prefix):
"""
Signature = URL-Encode( Base64( HMAC-SHA1( YourSecretAccessKeyID,
UTF-8-Encoding-Of( StringToSign ) ) ) );
StringToSign = HTTP-VERB + "\n" +
Content-MD5 + "\n" +
Content-Type + "\n" +
Expires + "\n" +
CanonicalizedVendorHeaders +
CanonicalizedResource;
"""
special_headers = {"content-md5": "", "content-type": "", "date": ""}
vendor_headers = {}
for key, value in list(headers.items()):
key_lower = key.lower()
if key_lower in special_headers:
special_headers[key_lower] = value.strip()
elif key_lower.startswith(vendor_prefix):
vendor_headers[key_lower] = value.strip()
if expires:
special_headers["date"] = str(expires)
buf = [method]
for _, value in sorted(special_headers.items()):
buf.append(value)
string_to_sign = "\n".join(buf)
buf = []
for key, value in sorted(vendor_headers.items()):
buf.append("{}:{}".format(key, value))
header_string = "\n".join(buf)
values_to_sign = []
for value in [string_to_sign, header_string, path]:
if value:
values_to_sign.append(value)
string_to_sign = "\n".join(values_to_sign)
b64_hmac = base64.b64encode(
hmac.new(b(secret_key), b(string_to_sign), digestmod=sha1).digest()
)
return b64_hmac.decode("utf-8")
def add_default_params(self, params):
expires = str(int(time.time()) + EXPIRATION_SECONDS)
params["AWSAccessKeyId"] = self.user_id
params["Expires"] = expires
return params
def pre_connect_hook(self, params, headers):
# pylint: disable=no-member
params["Signature"] = self.get_auth_signature(
method=self.method,
headers=headers,
params=params,
expires=params["Expires"],
secret_key=self.key,
path=self.action,
vendor_prefix=self.driver.http_vendor_prefix,
)
return params, headers
class S3Connection(AWSTokenConnection, BaseS3Connection):
"""
Represents a single connection to the S3 endpoint, with AWS-specific
features.
"""
pass
class S3SignatureV4Connection(SignedAWSConnection, BaseS3Connection):
service_name = "s3"
version = API_VERSION
def __init__(
self,
user_id,
key,
secure=True,
host=None,
port=None,
url=None,
timeout=None,
proxy_url=None,
token=None,
retry_delay=None,
backoff=None,
):
super().__init__(
user_id,
key,
secure,
host,
port,
url,
timeout,
proxy_url,
token,
retry_delay,
backoff,
4,
) # force version 4
class S3MultipartUpload:
"""
Class representing an amazon s3 multipart upload
"""
def __init__(self, key, id, created_at, initiator, owner):
"""
Class representing an amazon s3 multipart upload
:param key: The object/key that was being uploaded
:type key: ``str``
:param id: The upload id assigned by amazon
:type id: ``str``
:param created_at: The date/time at which the upload was started
:type created_at: ``str``
:param initiator: The AWS owner/IAM user who initiated this
:type initiator: ``str``
:param owner: The AWS owner/IAM who will own this object
:type owner: ``str``
"""
self.key = key
self.id = id
self.created_at = created_at
self.initiator = initiator
self.owner = owner
def __repr__(self):
return "<S3MultipartUpload: key=%s>" % (self.key)
class BaseS3StorageDriver(StorageDriver):
name = "Amazon S3 (standard)"
website = "http://aws.amazon.com/s3/"
connectionCls = BaseS3Connection
hash_type = "md5"
supports_chunked_encoding = False
supports_s3_multipart_upload = True
ex_location_name = ""
namespace = NAMESPACE
http_vendor_prefix = "x-amz"
def iterate_containers(self):
response = self.connection.request("/")
if response.status == httplib.OK:
containers = self._to_containers(obj=response.object, xpath="Buckets/Bucket")
return containers
raise LibcloudError("Unexpected status code: %s" % (response.status), driver=self)
def iterate_container_objects(self, container, prefix=None, ex_prefix=None):
"""
Return a generator of objects for the given container.
:param container: Container instance
:type container: :class:`Container`
:param prefix: Only return objects starting with prefix
:type prefix: ``str``
:param ex_prefix: Only return objects starting with ex_prefix
:type ex_prefix: ``str``
:return: A generator of Object instances.
:rtype: ``generator`` of :class:`Object`
"""
prefix = self._normalize_prefix_argument(prefix, ex_prefix)
params = {}
if prefix:
params["prefix"] = prefix
last_key = None
exhausted = False
container_path = self._get_container_path(container)
while not exhausted:
if last_key:
params["marker"] = last_key
response = self.connection.request(container_path, params=params)
if response.status != httplib.OK:
raise LibcloudError("Unexpected status code: %s" % (response.status), driver=self)
objects = self._to_objs(obj=response.object, xpath="Contents", container=container)
is_truncated = response.object.findtext(
fixxpath(xpath="IsTruncated", namespace=self.namespace)
).lower()
exhausted = is_truncated == "false"
last_key = None
for obj in objects:
last_key = obj.name
yield obj
def get_container(self, container_name):
try:
response = self.connection.request("/%s" % container_name, method="HEAD")
if response.status == httplib.NOT_FOUND:
raise ContainerDoesNotExistError(
value=None, driver=self, container_name=container_name
)
except InvalidCredsError:
# This just means the user doesn't have IAM permissions to do a
# HEAD request but other requests might work.
pass
return Container(name=container_name, extra=None, driver=self)
def get_object(self, container_name, object_name):
container = self.get_container(container_name=container_name)
object_path = self._get_object_path(container, object_name)
response = self.connection.request(object_path, method="HEAD")
if response.status == httplib.OK:
obj = self._headers_to_object(
object_name=object_name, container=container, headers=response.headers
)
return obj
raise ObjectDoesNotExistError(value=None, driver=self, object_name=object_name)
def _get_container_path(self, container):
"""
Return a container path
:param container: Container instance
:type container: :class:`Container`
:return: A path for this container.
:rtype: ``str``
"""
return "/%s" % (container.name)
def _get_object_path(self, container, object_name):
"""
Return an object's CDN path.
:param container: Container instance
:type container: :class:`Container`
:param object_name: Object name
:type object_name: :class:`str`
:return: A path for this object.
:rtype: ``str``
"""
container_url = self._get_container_path(container)
object_name_cleaned = self._clean_object_name(object_name)
object_path = "{}/{}".format(container_url, object_name_cleaned)
return object_path
def create_container(self, container_name):
if self.ex_location_name:
root = Element("CreateBucketConfiguration")
child = SubElement(root, "LocationConstraint")
child.text = self.ex_location_name
data = tostring(root)
else:
data = ""
response = self.connection.request("/%s" % (container_name), data=data, method="PUT")
if response.status == httplib.OK:
container = Container(name=container_name, extra=None, driver=self)
return container
elif response.status == httplib.CONFLICT:
if "BucketAlreadyOwnedByYou" in response.body:
raise ContainerAlreadyExistsError(
value="Container with this name already exists. The name "
"be unique among all the containers in the system.",
container_name=container_name,
driver=self,
)
raise InvalidContainerNameError(
value="Container with this name already exists. The name must "
"be unique among all the containers in the system.",
container_name=container_name,
driver=self,
)
elif response.status == httplib.BAD_REQUEST:
raise ContainerError(
value="Bad request when creating container: %s" % response.body,
container_name=container_name,
driver=self,
)
raise LibcloudError("Unexpected status code: %s" % (response.status), driver=self)
def delete_container(self, container):
# Note: All the objects in the container must be deleted first
response = self.connection.request("/%s" % (container.name), method="DELETE")
if response.status == httplib.NO_CONTENT:
return True
elif response.status == httplib.CONFLICT:
raise ContainerIsNotEmptyError(
value="Container must be empty before it can be deleted.",
container_name=container.name,
driver=self,
)
elif response.status == httplib.NOT_FOUND:
raise ContainerDoesNotExistError(value=None, driver=self, container_name=container.name)
return False
def download_object(
self, obj, destination_path, overwrite_existing=False, delete_on_failure=True
):
obj_path = self._get_object_path(obj.container, obj.name)
response = self.connection.request(obj_path, method="GET", raw=True)
return self._get_object(
obj=obj,
callback=self._save_object,
response=response,
callback_kwargs={
"obj": obj,
"response": response.response,
"destination_path": destination_path,
"overwrite_existing": overwrite_existing,
"delete_on_failure": delete_on_failure,
},
success_status_code=httplib.OK,
)
def download_object_as_stream(self, obj, chunk_size=None):
obj_path = self._get_object_path(obj.container, obj.name)
response = self.connection.request(obj_path, method="GET", stream=True, raw=True)
return self._get_object(
obj=obj,
callback=read_in_chunks,
response=response,
callback_kwargs={
"iterator": response.iter_content(CHUNK_SIZE),
"chunk_size": chunk_size,
},
success_status_code=httplib.OK,
)
def download_object_range(
self,
obj,
destination_path,
start_bytes,
end_bytes=None,
overwrite_existing=False,
delete_on_failure=True,
):
self._validate_start_and_end_bytes(start_bytes=start_bytes, end_bytes=end_bytes)
obj_path = self._get_object_path(obj.container, obj.name)
headers = {"Range": self._get_standard_range_str(start_bytes, end_bytes)}
response = self.connection.request(obj_path, method="GET", headers=headers, raw=True)
return self._get_object(
obj=obj,
callback=self._save_object,
response=response,
callback_kwargs={
"obj": obj,
"response": response.response,
"destination_path": destination_path,
"overwrite_existing": overwrite_existing,
"delete_on_failure": delete_on_failure,
"partial_download": True,
},
success_status_code=httplib.PARTIAL_CONTENT,
)
def download_object_range_as_stream(self, obj, start_bytes, end_bytes=None, chunk_size=None):
self._validate_start_and_end_bytes(start_bytes=start_bytes, end_bytes=end_bytes)
obj_path = self._get_object_path(obj.container, obj.name)
headers = {"Range": self._get_standard_range_str(start_bytes, end_bytes)}
response = self.connection.request(
obj_path, method="GET", headers=headers, stream=True, raw=True
)
return self._get_object(
obj=obj,
callback=read_in_chunks,
response=response,
callback_kwargs={
"iterator": response.iter_content(CHUNK_SIZE),
"chunk_size": chunk_size,
},
success_status_code=httplib.PARTIAL_CONTENT,
)
def upload_object(
self,
file_path,
container,
object_name,
extra=None,
verify_hash=True,
headers=None,
ex_storage_class=None,
):
"""
@inherits: :class:`StorageDriver.upload_object`
:param ex_storage_class: Storage class
:type ex_storage_class: ``str``
"""
return self._put_object(
container=container,
object_name=object_name,
extra=extra,
file_path=file_path,
verify_hash=verify_hash,
headers=headers,
storage_class=ex_storage_class,
)
def _initiate_multipart(self, container, object_name, headers=None):
"""
Initiates a multipart upload to S3
:param container: The destination container
:type container: :class:`Container`
:param object_name: The name of the object which we are uploading
:type object_name: ``str``
:keyword headers: Additional headers to send with the request
:type headers: ``dict``
:return: The id of the newly created multipart upload
:rtype: ``str``
"""
headers = headers or {}
request_path = self._get_object_path(container, object_name)
params = {"uploads": ""}
response = self.connection.request(
request_path, method="POST", headers=headers, params=params
)
if response.status != httplib.OK:
raise LibcloudError("Error initiating multipart upload", driver=self)
return findtext(element=response.object, xpath="UploadId", namespace=self.namespace)
def _upload_multipart_chunks(
self, container, object_name, upload_id, stream, calculate_hash=True
):
"""
Uploads data from an iterator in fixed sized chunks to S3
:param container: The destination container
:type container: :class:`Container`
:param object_name: The name of the object which we are uploading
:type object_name: ``str``
:param upload_id: The upload id allocated for this multipart upload
:type upload_id: ``str``
:param stream: The generator for fetching the upload data
:type stream: ``generator``
:keyword calculate_hash: Indicates if we must calculate the data hash
:type calculate_hash: ``bool``
:return: A tuple of (chunk info, checksum, bytes transferred)
:rtype: ``tuple``
"""
data_hash = None
if calculate_hash:
data_hash = self._get_hash_function()
bytes_transferred = 0
count = 1
chunks = []
params = {"uploadId": upload_id}
request_path = self._get_object_path(container, object_name)
# Read the input data in chunk sizes suitable for AWS
for data in read_in_chunks(stream, chunk_size=CHUNK_SIZE, fill_size=True, yield_empty=True):
bytes_transferred += len(data)
if calculate_hash:
data_hash.update(data)
chunk_hash = self._get_hash_function()
chunk_hash.update(data)
chunk_hash = base64.b64encode(chunk_hash.digest()).decode("utf-8")
# The Content-MD5 header provides an extra level of data check and
# is recommended by amazon
headers = {
"Content-Length": len(data),
"Content-MD5": chunk_hash,
}
params["partNumber"] = count
resp = self.connection.request(
request_path, method="PUT", data=data, headers=headers, params=params
)
if resp.status != httplib.OK:
raise LibcloudError("Error uploading chunk", driver=self)
server_hash = resp.headers["etag"].replace('"', "")
# Keep this data for a later commit
chunks.append((count, server_hash))
count += 1
if calculate_hash:
data_hash = data_hash.hexdigest()
return (chunks, data_hash, bytes_transferred)
def _commit_multipart(self, container, object_name, upload_id, chunks):
"""
Makes a final commit of the data.
:param container: The destination container
:type container: :class:`Container`
:param object_name: The name of the object which we are uploading
:type object_name: ``str``
:param upload_id: The upload id allocated for this multipart upload
:type upload_id: ``str``
:param chunks: A list of (chunk_number, chunk_hash) tuples.
:type chunks: ``list``
:return: The server side hash of the uploaded data
:rtype: ``str``
"""
root = Element("CompleteMultipartUpload")
for (count, etag) in chunks:
part = SubElement(root, "Part")
part_no = SubElement(part, "PartNumber")
part_no.text = str(count)
etag_id = SubElement(part, "ETag")
etag_id.text = str(etag)
data = tostring(root)
headers = {"Content-Length": len(data)}
params = {"uploadId": upload_id}
request_path = self._get_object_path(container, object_name)
response = self.connection.request(
request_path, headers=headers, params=params, data=data, method="POST"
)
if response.status != httplib.OK:
element = response.object
# pylint: disable=maybe-no-member
code, message = response._parse_error_details(element=element)
msg = "Error in multipart commit: {} ({})".format(message, code)
raise LibcloudError(msg, driver=self)
# Get the server's etag to be passed back to the caller
body = response.parse_body()
server_hash = body.find(fixxpath(xpath="ETag", namespace=self.namespace)).text
return server_hash
def _abort_multipart(self, container, object_name, upload_id):
"""
Aborts an already initiated multipart upload
:param container: The destination container
:type container: :class:`Container`
:param object_name: The name of the object which we are uploading
:type object_name: ``str``
:param upload_id: The upload id allocated for this multipart upload
:type upload_id: ``str``
"""
params = {"uploadId": upload_id}
request_path = self._get_object_path(container, object_name)
resp = self.connection.request(request_path, method="DELETE", params=params)
if resp.status != httplib.NO_CONTENT:
raise LibcloudError(
"Error in multipart abort. status_code=%d" % (resp.status), driver=self
)
def upload_object_via_stream(
self,
iterator,
container,
object_name,
extra=None,
headers=None,
ex_storage_class=None,
):
"""
@inherits: :class:`StorageDriver.upload_object_via_stream`
:param ex_storage_class: Storage class
:type ex_storage_class: ``str``
"""
method = "PUT"
params = None
# This driver is used by other S3 API compatible drivers also.
# Amazon provides a different (complex?) mechanism to do multipart
# uploads
if self.supports_s3_multipart_upload:
return self._put_object_multipart(
container=container,
object_name=object_name,
extra=extra,
stream=iterator,
verify_hash=False,
headers=headers,
storage_class=ex_storage_class,
)
return self._put_object(
container=container,
object_name=object_name,
extra=extra,
method=method,
query_args=params,
stream=iterator,
verify_hash=False,
headers=headers,
storage_class=ex_storage_class,
)
def delete_object(self, obj):
object_path = self._get_object_path(obj.container, obj.name)
response = self.connection.request(object_path, method="DELETE")
if response.status == httplib.NO_CONTENT:
return True
elif response.status == httplib.NOT_FOUND:
raise ObjectDoesNotExistError(value=None, driver=self, object_name=obj.name)
return False
def ex_iterate_multipart_uploads(self, container, prefix=None, delimiter=None):
"""
Extension method for listing all in-progress S3 multipart uploads.
Each multipart upload which has not been committed or aborted is
considered in-progress.
:param container: The container holding the uploads
:type container: :class:`Container`
:keyword prefix: Print only uploads of objects with this prefix
:type prefix: ``str``
:keyword delimiter: The object/key names are grouped based on
being split by this delimiter
:type delimiter: ``str``
:return: A generator of S3MultipartUpload instances.
:rtype: ``generator`` of :class:`S3MultipartUpload`
"""
if not self.supports_s3_multipart_upload:
raise LibcloudError("Feature not supported", driver=self)
# Get the data for a specific container
request_path = self._get_container_path(container)
params = {"max-uploads": RESPONSES_PER_REQUEST, "uploads": ""}
if prefix:
params["prefix"] = prefix
if delimiter:
params["delimiter"] = delimiter
def finder(node, text):
return node.findtext(fixxpath(xpath=text, namespace=self.namespace))
while True:
response = self.connection.request(request_path, params=params)
if response.status != httplib.OK:
raise LibcloudError(
"Error fetching multipart uploads. " "Got code: %s" % response.status,
driver=self,
)
body = response.parse_body()
# pylint: disable=maybe-no-member
for node in body.findall(fixxpath(xpath="Upload", namespace=self.namespace)):
initiator = node.find(fixxpath(xpath="Initiator", namespace=self.namespace))
owner = node.find(fixxpath(xpath="Owner", namespace=self.namespace))
key = finder(node, "Key")
upload_id = finder(node, "UploadId")
created_at = finder(node, "Initiated")
initiator = finder(initiator, "DisplayName")
owner = finder(owner, "DisplayName")
yield S3MultipartUpload(key, upload_id, created_at, initiator, owner)
# Check if this is the last entry in the listing
# pylint: disable=maybe-no-member
is_truncated = body.findtext(fixxpath(xpath="IsTruncated", namespace=self.namespace))
if is_truncated.lower() == "false":
break
# Provide params for the next request
upload_marker = body.findtext(
fixxpath(xpath="NextUploadIdMarker", namespace=self.namespace)
)
key_marker = body.findtext(fixxpath(xpath="NextKeyMarker", namespace=self.namespace))
params["key-marker"] = key_marker
params["upload-id-marker"] = upload_marker
def ex_cleanup_all_multipart_uploads(self, container, prefix=None):
"""
Extension method for removing all partially completed S3 multipart
uploads.
:param container: The container holding the uploads
:type container: :class:`Container`
:keyword prefix: Delete only uploads of objects with this prefix
:type prefix: ``str``
"""
# Iterate through the container and delete the upload ids
for upload in self.ex_iterate_multipart_uploads(container, prefix, delimiter=None):
self._abort_multipart(container, upload.key, upload.id)
def _clean_object_name(self, name):
name = urlquote(name, safe="/~")
return name
def _put_object(
self,
container,
object_name,
method="PUT",
query_args=None,
extra=None,
file_path=None,
stream=None,
verify_hash=True,
storage_class=None,
headers=None,
):
headers = headers or {}
extra = extra or {}
headers.update(self._to_storage_class_headers(storage_class))
content_type = extra.get("content_type", None)
meta_data = extra.get("meta_data", None)
acl = extra.get("acl", None)
if meta_data:
for key, value in list(meta_data.items()):
key = self.http_vendor_prefix + "-meta-%s" % (key)
headers[key] = value
if acl:
headers[self.http_vendor_prefix + "-acl"] = acl
request_path = self._get_object_path(container, object_name)
if query_args:
request_path = "?".join((request_path, query_args))
result_dict = self._upload_object(
object_name=object_name,
content_type=content_type,
request_path=request_path,
request_method=method,
headers=headers,
file_path=file_path,
stream=stream,
)
response = result_dict["response"]
bytes_transferred = result_dict["bytes_transferred"]
headers = response.headers
response = response
server_hash = headers.get("etag", "").replace('"', "")
server_side_encryption = headers.get("x-amz-server-side-encryption", None)
aws_kms_encryption = server_side_encryption == "aws:kms"
hash_matches = result_dict["data_hash"] == server_hash
# NOTE: If AWS KMS server side encryption is enabled, ETag won't
# contain object MD5 digest so we skip the checksum check
# See https://docs.aws.amazon.com/AmazonS3/latest/API
# /RESTCommonResponseHeaders.html
# and https:/apache/libcloud/issues/1401
# for details
if verify_hash and not aws_kms_encryption and not hash_matches:
raise ObjectHashMismatchError(
value="MD5 hash {} checksum does not match {}".format(
server_hash, result_dict["data_hash"]
),
object_name=object_name,
driver=self,
)
elif response.status == httplib.OK:
obj = Object(
name=object_name,
size=bytes_transferred,