swift 2.23.3__py3-none-any.whl → 2.35.0__py3-none-any.whl

swift/common/middleware/s3api/controllers/obj.py

@@ -13,15 +13,24 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from io import BytesIO
+import json
+
+from swift.common import constraints
 from swift.common.http import HTTP_OK, HTTP_PARTIAL_CONTENT, HTTP_NO_CONTENT
 from swift.common.request_helpers import update_etag_is_at_header
-from swift.common.swob import Range, content_range_header_value
+from swift.common.swob import Range, content_range_header_value, \
+    normalize_etag
 from swift.common.utils import public, list_from_csv
+from swift.common.registry import get_swift_info
 
+from swift.common.middleware.versioned_writes.object_versioning import \
+    DELETE_MARKER_CONTENT_TYPE
 from swift.common.middleware.s3api.utils import S3Timestamp, sysmeta_header
 from swift.common.middleware.s3api.controllers.base import Controller
 from swift.common.middleware.s3api.s3response import S3NotImplemented, \
-    InvalidRange, NoSuchKey, InvalidArgument, HTTPNoContent
+    InvalidRange, NoSuchKey, NoSuchVersion, InvalidArgument, HTTPNoContent, \
+    PreconditionFailed, KeyTooLongError
 
 
 class ObjectController(Controller):
@@ -68,8 +77,7 @@ class ObjectController(Controller):
                 continue
             had_match = True
             for value in list_from_csv(req.headers[match_header]):
-                if value.startswith('"') and value.endswith('"'):
-                    value = value[1:-1]
+                value = normalize_etag(value)
                 if value.endswith('-N'):
                     # Deal with fake S3-like etags for SLOs uploaded via Swift
                     req.headers[match_header] += ', ' + value[:-2]
@@ -78,11 +86,47 @@ class ObjectController(Controller):
             # Update where to look
             update_etag_is_at_header(req, sysmeta_header('object', 'etag'))
 
-        resp = req.get_response(self.app)
+        object_name = req.object_name
+        version_id = req.params.get('versionId')
+        if version_id not in ('null', None) and \
+                'object_versioning' not in get_swift_info():
+            raise S3NotImplemented()
+        part_number = req.validate_part_number(check_max=False)
+
+        query = {}
+        if version_id is not None:
+            query['version-id'] = version_id
+        if part_number is not None:
+            query['part-number'] = part_number
+
+        if version_id not in ('null', None):
+            container_info = req.get_container_info(self.app)
+            if not container_info.get(
+                    'sysmeta', {}).get('versions-container', ''):
+                # Versioning has never been enabled
+                raise NoSuchVersion(object_name, version_id)
+
+        resp = req.get_response(self.app, query=query)
+
+        if not resp.is_slo:
+            # SLO ignores part_number for non-slo objects, but s3api only
+            # allows the query param for non-MPU if it's exactly 1.
+            part_number = req.validate_part_number(parts_count=1)
+            if part_number == 1:
+                # When the query param *is* exactly 1 the response status code
+                # and headers are updated.
+                resp.status = HTTP_PARTIAL_CONTENT
+                resp.headers['Content-Range'] = \
+                    'bytes 0-%d/%s' % (int(resp.headers['Content-Length']) - 1,
+                                       resp.headers['Content-Length'])
+            # else: part_number is None
 
         if req.method == 'HEAD':
             resp.app_iter = None
 
+        if 'x-amz-meta-deleted' in resp.headers:
+            raise NoSuchKey(object_name)
+
         for key in ('content-type', 'content-language', 'expires',
                     'cache-control', 'content-disposition',
                     'content-encoding'):
@@ -116,6 +160,8 @@ class ObjectController(Controller):
         """
         Handle PUT Object and PUT Object (Copy) request
         """
+        if len(req.object_name) > constraints.MAX_OBJECT_NAME_LENGTH:
+            raise KeyTooLongError()
         # set X-Timestamp by s3api to use at copy resp body
         req_timestamp = S3Timestamp.now()
         req.headers['X-Timestamp'] = req_timestamp.internal
@@ -125,12 +171,14 @@ class ObjectController(Controller):
                                   req.headers['X-Amz-Copy-Source-Range'],
                                   'Illegal copy header')
         req.check_copy_source(self.app)
+        if not req.headers.get('Content-Type'):
+            # can't setdefault because it can be None for some reason
+            req.headers['Content-Type'] = 'binary/octet-stream'
         resp = req.get_response(self.app)
 
         if 'X-Amz-Copy-Source' in req.headers:
             resp.append_copy_resp_body(req.controller_name,
                                        req_timestamp.s3xmlformat)
-
             # delete object metadata from response
             for key in list(resp.headers.keys()):
                 if key.lower().startswith('x-amz-meta-'):
@@ -143,20 +191,76 @@ class ObjectController(Controller):
     def POST(self, req):
         raise S3NotImplemented()
 
+    def _restore_on_delete(self, req):
+        resp = req.get_response(self.app, 'GET', req.container_name, '',
+                                query={'prefix': req.object_name,
+                                       'versions': True})
+        if resp.status_int != HTTP_OK:
+            return resp
+        old_versions = json.loads(resp.body)
+        resp = None
+        for item in old_versions:
+            if item['content_type'] == DELETE_MARKER_CONTENT_TYPE:
+                resp = None
+                break
+            try:
+                resp = req.get_response(self.app, 'PUT', query={
+                    'version-id': item['version_id']})
+            except PreconditionFailed:
+                self.logger.debug('skipping failed PUT?version-id=%s' %
+                                  item['version_id'])
+                continue
+            # if that worked, we'll go ahead and fix up the status code
+            resp.status_int = HTTP_NO_CONTENT
+            break
+        return resp
+
     @public
     def DELETE(self, req):
         """
         Handle DELETE Object request
         """
+        if 'versionId' in req.params and \
+                req.params['versionId'] != 'null' and \
+                'object_versioning' not in get_swift_info():
+            raise S3NotImplemented()
+
+        version_id = req.params.get('versionId')
+        if version_id not in ('null', None):
+            container_info = req.get_container_info(self.app)
+            if not container_info.get(
+                    'sysmeta', {}).get('versions-container', ''):
+                # Versioning has never been enabled
+                return HTTPNoContent(headers={'x-amz-version-id': version_id})
+
         try:
-            query = req.gen_multipart_manifest_delete_query(self.app)
+            try:
+                query = req.gen_multipart_manifest_delete_query(
+                    self.app, version=version_id)
+            except NoSuchKey:
+                query = {}
+
             req.headers['Content-Type'] = None  # Ignore client content-type
+
+            if version_id is not None:
+                query['version-id'] = version_id
+                query['symlink'] = 'get'
+
             resp = req.get_response(self.app, query=query)
-            if query and resp.status_int == HTTP_OK:
+            # If we're going to continue using this request, we need to
+            # replace the now-spent body
+            req.environ['wsgi.input'] = BytesIO(b'')
+            req.headers['content-length'] = '0'
+            req.headers.pop('transfer-encoding', None)
+            if query.get('multipart-manifest') and resp.status_int == HTTP_OK:
                 for chunk in resp.app_iter:
                     pass  # drain the bulk-deleter response
                 resp.status = HTTP_NO_CONTENT
                 resp.body = b''
+            if resp.sw_headers.get('X-Object-Current-Version-Id') == 'null':
+                new_resp = self._restore_on_delete(req)
+                if new_resp:
+                    resp = new_resp
         except NoSuchKey:
             # expect to raise NoSuchBucket when the bucket doesn't exist
             req.get_container_info(self.app)

swift/common/middleware/s3api/controllers/object_lock.py

@@ -0,0 +1,44 @@
+# Copyright (c) 2010-2023 OpenStack Foundation
+#
+# Licensed 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.
+
+from swift.common.utils import public
+
+from swift.common.middleware.s3api.controllers.base import Controller, \
+    bucket_operation, S3NotImplemented
+from swift.common.middleware.s3api.s3response import \
+    ObjectLockConfigurationNotFoundError
+
+
+class ObjectLockController(Controller):
+    """
+    Handles GET object-lock request, which always returns
+    <ObjectLockEnabled>Disabled</ObjectLockEnabled>
+    """
+    @public
+    @bucket_operation
+    def GET(self, req):
+        """
+        Handles GET object-lock param calls.
+        """
+        raise ObjectLockConfigurationNotFoundError(req.container_name)
+
+    @public
+    @bucket_operation
+    def PUT(self, req):
+        """
+        Handles PUT object-lock param calls.
+        """
+        # Basically we don't support it, so return a 501
+        raise S3NotImplemented('The requested resource is not implemented')

swift/common/middleware/s3api/controllers/s3_acl.py

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from six.moves.urllib.parse import quote
+from urllib.parse import quote
 from swift.common.utils import public
 
 from swift.common.middleware.s3api.controllers.base import Controller
@@ -37,7 +37,7 @@ class S3AclController(Controller):
         """
         Handles GET Bucket acl and GET Object acl.
         """
-        resp = req.get_response(self.app)
+        resp = req.get_response(self.app, method='HEAD')
 
         acl = resp.object_acl if req.is_object_request else resp.bucket_acl
 

swift/common/middleware/s3api/controllers/tagging.py

@@ -0,0 +1,57 @@
+# Copyright (c) 2014 OpenStack Foundation.
+#
+# Licensed 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.
+
+from swift.common.utils import public
+
+from swift.common.middleware.s3api.controllers.base import Controller, \
+    S3NotImplemented
+from swift.common.middleware.s3api.s3response import HTTPOk
+from swift.common.middleware.s3api.etree import Element, tostring, \
+    SubElement
+
+
+class TaggingController(Controller):
+    """
+    Handles the following APIs:
+
+    * GET Bucket and Object tagging
+    * PUT Bucket and Object tagging
+    * DELETE Bucket and Object tagging
+
+    """
+    @public
+    def GET(self, req):
+        """
+        Handles GET Bucket and Object tagging.
+        """
+        elem = Element('Tagging')
+        SubElement(elem, 'TagSet')
+        body = tostring(elem)
+
+        return HTTPOk(body=body, content_type=None)
+
+    @public
+    def PUT(self, req):
+        """
+        Handles PUT Bucket and Object tagging.
+        """
+        raise S3NotImplemented('The requested resource is not implemented')
+
+    @public
+    def DELETE(self, req):
+        """
+        Handles DELETE Bucket and Object tagging.
+        """
+        raise S3NotImplemented('The requested resource is not implemented')

swift/common/middleware/s3api/controllers/versioning.py

@@ -13,12 +13,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from swift.common.utils import public
+from swift.common.utils import public, config_true_value
+from swift.common.registry import get_swift_info
 
 from swift.common.middleware.s3api.controllers.base import Controller, \
     bucket_operation
-from swift.common.middleware.s3api.etree import Element, tostring
-from swift.common.middleware.s3api.s3response import HTTPOk, S3NotImplemented
+from swift.common.middleware.s3api.etree import Element, tostring, \
+    fromstring, XMLSyntaxError, DocumentInvalid, SubElement
+from swift.common.middleware.s3api.s3response import HTTPOk, \
+    S3NotImplemented, MalformedXML
+
+MAX_PUT_VERSIONING_BODY_SIZE = 10240
 
 
 class VersioningController(Controller):
@@ -36,13 +41,16 @@ class VersioningController(Controller):
         """
         Handles GET Bucket versioning.
         """
-        req.get_response(self.app, method='HEAD')
+        sysmeta = req.get_container_info(self.app).get('sysmeta', {})
 
-        # Just report there is no versioning configured here.
         elem = Element('VersioningConfiguration')
+        if sysmeta.get('versions-enabled'):
+            SubElement(elem, 'Status').text = (
+                'Enabled' if config_true_value(sysmeta['versions-enabled'])
+                else 'Suspended')
         body = tostring(elem)
 
-        return HTTPOk(body=body, content_type="text/plain")
+        return HTTPOk(body=body, content_type=None)
 
     @public
     @bucket_operation
@@ -50,4 +58,25 @@ class VersioningController(Controller):
         """
         Handles PUT Bucket versioning.
         """
-        raise S3NotImplemented()
+        if 'object_versioning' not in get_swift_info():
+            raise S3NotImplemented()
+
+        xml = req.xml(MAX_PUT_VERSIONING_BODY_SIZE)
+        try:
+            elem = fromstring(xml, 'VersioningConfiguration')
+            status = elem.find('./Status').text
+        except (XMLSyntaxError, DocumentInvalid):
+            raise MalformedXML()
+        except Exception as e:
+            self.logger.error(e)
+            raise
+
+        if status not in ['Enabled', 'Suspended']:
+            raise MalformedXML()
+
+        # Set up versioning
+        # NB: object_versioning responsible for ensuring its container exists
+        req.headers['X-Versions-Enabled'] = str(status == 'Enabled').lower()
+        req.get_response(self.app, 'POST')
+
+        return HTTPOk()

swift/common/middleware/s3api/etree.py

@@ -15,13 +15,22 @@
 
 import lxml.etree
 from copy import deepcopy
-from pkg_resources import resource_stream  # pylint: disable-msg=E0611
-import six
+try:
+    # importlib.resources was introduced in py37, but couldn't handle
+    # resources in subdirectories (which we use); files() added support
+    from importlib.resources import files
+    del files
+except ImportError:
+    # python < 3.9
+    from pkg_resources import resource_stream  # pylint: disable-msg=E0611
+else:
+    import importlib.resources
+    resource_stream = None
 
 from swift.common.utils import get_logger
 from swift.common.middleware.s3api.exception import S3Exception
 from swift.common.middleware.s3api.utils import camel_to_snake, \
-    utf8encode, utf8decode
+    utf8decode
 
 XMLNS_S3 = 'http://s3.amazonaws.com/doc/2006-03-01/'
 XMLNS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
@@ -41,7 +50,7 @@ def cleanup_namespaces(elem):
             tag = tag[len('{%s}' % ns):]
         return tag
 
-    if not isinstance(elem.tag, six.string_types):
+    if not isinstance(elem.tag, str):
         # elem is a comment element.
         return
 
@@ -70,7 +79,13 @@ def fromstring(text, root_tag=None, logger=None):
         # validate XML
         try:
             path = 'schema/%s.rng' % camel_to_snake(root_tag)
-            with resource_stream(__name__, path) as rng:
+            if resource_stream:
+                # python < 3.9
+                stream = resource_stream(__name__, path)
+            else:
+                stream = importlib.resources.files(
+                    __name__.rsplit('.', 1)[0]).joinpath(path).open('rb')
+            with stream as rng:
                 lxml.etree.RelaxNG(file=rng).assertValid(elem)
         except IOError as e:
             # Probably, the schema file doesn't exist.
@@ -92,7 +107,7 @@ def tostring(tree, use_s3ns=True, xml_declaration=True):
 
         root = Element(tree.tag, attrib=tree.attrib, nsmap=nsmap)
         root.text = tree.text
-        root.extend(deepcopy(tree.getchildren()))
+        root.extend(deepcopy(list(tree)))
         tree = root
 
     return lxml.etree.tostring(tree, xml_declaration=xml_declaration,
@@ -120,8 +135,6 @@ class _Element(lxml.etree.ElementBase):
         """
         utf-8 wrapper property of lxml.etree.Element.text
         """
-        if six.PY2:
-            return utf8encode(lxml.etree.ElementBase.text.__get__(self))
         return lxml.etree.ElementBase.text.__get__(self)
 
     @text.setter
@@ -130,7 +143,7 @@ class _Element(lxml.etree.ElementBase):
 
 
 parser_lookup = lxml.etree.ElementDefaultClassLookup(element=_Element)
-parser = lxml.etree.XMLParser()
+parser = lxml.etree.XMLParser(resolve_entities=False, no_network=True)
 parser.set_element_class_lookup(parser_lookup)
 
 Element = parser.makeelement

swift/common/middleware/s3api/exception.py

@@ -22,10 +22,6 @@ class NotS3Request(S3Exception):
     pass
 
 
-class BadSwiftRequest(S3Exception):
-    pass
-
-
 class ACLError(S3Exception):
     pass