toolframe-object-store-s3 0.1.0__py3-none-any.whl

toolframe_object_store_s3/plugin.py

@@ -0,0 +1,186 @@
+"""Private S3 objects partitioned by application and owning plugin."""
+
+from __future__ import annotations
+
+import re
+from urllib.parse import urlsplit
+
+import boto3
+from botocore.config import Config
+from botocore.exceptions import BotoCoreError, ClientError
+from toolframe_sdk import AuthorizationSpec, PluginDefinition, PluginError
+from toolframe_sdk.object_store import (
+    MAX_OBJECT_BYTES,
+    OBJECT_STORE_SERVICE,
+    object_store_service,
+)
+from toolframe_sdk.object_store_provider import ObjectStoreProvider, check_key
+
+
+class S3ObjectStore(ObjectStoreProvider):
+    def open_backend(self):
+        config = self.context.config
+        endpoint = config.get("endpoint_url")
+        if endpoint:
+            parsed = urlsplit(endpoint)
+            if (
+                parsed.scheme not in {"https", "http"}
+                or not parsed.hostname
+                or parsed.username
+                or parsed.password
+                or parsed.query
+                or parsed.fragment
+                or parsed.path not in {"", "/"}
+            ):
+                raise PluginError(
+                    "invalid_endpoint",
+                    "S3 endpoint must be an HTTP(S) origin without credentials",
+                )
+        self.prefix = config.get("prefix", "toolframe").strip("/")
+        check_key(self.prefix)
+        self.bucket = config["bucket"]
+        # Credentials come from the AWS chain, never serializable plugin config.
+        self.client = boto3.client(
+            "s3",
+            endpoint_url=endpoint,
+            region_name=config.get("region", "us-east-1"),
+            config=Config(
+                signature_version="s3v4",
+                connect_timeout=5,
+                read_timeout=15,
+                retries={"max_attempts": 2, "mode": "standard"},
+                s3={"addressing_style": config.get("addressing_style", "path")},
+                request_checksum_calculation="when_required",
+                response_checksum_validation="when_required",
+            ),
+        )
+        try:
+            self.client.head_bucket(Bucket=self.bucket)
+        except BotoCoreError, ClientError:
+            self.client.close()
+            raise PluginError(
+                "object_store_unavailable", "Cannot access the configured S3 bucket"
+            ) from None
+
+    def close_backend(self):
+        if hasattr(self, "client"):
+            self.client.close()
+
+    def key(self, namespace, key=""):
+        return f"{self.prefix}/{namespace}/{key}"
+
+    def request(self, method, **params):
+        try:
+            return getattr(self.client, method)(Bucket=self.bucket, **params)
+        except ClientError as error:
+            code = error.response.get("Error", {}).get("Code")
+            if code in {"NoSuchKey", "NotFound", "404"}:
+                raise PluginError("object_missing", "Object does not exist") from None
+            if code in {"PreconditionFailed", "412"}:
+                raise PluginError(
+                    "object_changed", "Object changed; read its metadata again"
+                ) from None
+            raise PluginError("object_store_unavailable", "S3 request failed") from None
+
+    def put(self, namespace, metadata, stream):
+        self.request(
+            "put_object",
+            Key=self.key(namespace, metadata["key"]),
+            Body=stream,
+            ContentLength=metadata["size"],
+            ContentType=metadata["content_type"],
+            Metadata={
+                "sha256": metadata["etag"],
+                "modified-at": str(metadata["modified_at"]),
+            },
+        )
+
+    def metadata(self, key, response):
+        etag = response.get("Metadata", {}).get("sha256", "")
+        if not re.fullmatch(r"[a-f0-9]{64}", etag):
+            raise PluginError(
+                "object_corrupt", "Object is missing Toolframe checksum metadata"
+            )
+        return {
+            "key": key,
+            "size": response["ContentLength"],
+            "content_type": response.get("ContentType", "application/octet-stream"),
+            "etag": etag,
+            "modified_at": float(response["Metadata"]["modified-at"]),
+        }
+
+    def head(self, namespace, key):
+        return self.metadata(
+            key, self.request("head_object", Key=self.key(namespace, key))
+        )
+
+    def read(self, namespace, key, offset, length, etag):
+        response = self.request("head_object", Key=self.key(namespace, key))
+        metadata = self.metadata(key, response)
+        if metadata["etag"] != etag:
+            raise PluginError(
+                "object_changed", "Object changed; read its metadata again"
+            )
+        if offset > metadata["size"]:
+            raise PluginError("invalid_range", "Offset exceeds the object size")
+        if offset == metadata["size"]:
+            return b""
+        result = self.request(
+            "get_object",
+            Key=self.key(namespace, key),
+            IfMatch=response["ETag"],
+            Range=f"bytes={offset}-{min(offset + length, metadata['size']) - 1}",
+        )
+        try:
+            return result["Body"].read(length)
+        finally:
+            result["Body"].close()
+
+    def list(self, namespace, prefix, after, limit):
+        base = self.key(namespace)
+        result = self.request(
+            "list_objects_v2",
+            Prefix=base + prefix,
+            StartAfter=base + after,
+            MaxKeys=limit + 1,
+        )
+        entries = result.get("Contents", [])
+        items = [
+            self.head(namespace, item["Key"][len(base) :]) for item in entries[:limit]
+        ]
+        more = len(entries) > limit or result.get("IsTruncated", False)
+        return {
+            "objects": items,
+            "next_after": items[-1]["key"] if more and items else None,
+        }
+
+    def delete(self, namespace, key):
+        self.request("delete_object", Key=self.key(namespace, key))
+
+
+plugin = PluginDefinition(
+    id="object-store-s3",
+    kind="provider",
+    provider_kind="object-store",
+    factory="toolframe_object_store_s3.plugin:S3ObjectStore",
+    authorization=AuthorizationSpec(),
+    runtime_validation="separate_application",
+    config_schema={
+        "type": "object",
+        "additionalProperties": False,
+        "required": ["bucket"],
+        "properties": {
+            "bucket": {"type": "string", "minLength": 3, "maxLength": 63},
+            "endpoint_url": {"type": "string", "maxLength": 2048},
+            "region": {"type": "string", "minLength": 1, "maxLength": 64},
+            "prefix": {"type": "string", "minLength": 1, "maxLength": 128},
+            "addressing_style": {"enum": ["path", "virtual", "auto"]},
+            "max_object_bytes": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": MAX_OBJECT_BYTES,
+            },
+        },
+    },
+    services={OBJECT_STORE_SERVICE: object_store_service()},
+)

toolframe_object_store_s3-0.1.0.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.5
+Name: toolframe-object-store-s3
+Version: 0.1.0
+Summary: S3-compatible object storage for Toolframe plugins
+Project-URL: Homepage, https://github.com/toolframe/toolframe-object-store-s3
+Project-URL: Repository, https://github.com/toolframe/toolframe-object-store-s3
+Project-URL: Documentation, https://github.com/toolframe/toolframe-object-store-s3#readme
+Project-URL: Issues, https://github.com/toolframe/toolframe-object-store-s3/issues
+Author-email: byfb <62798989+byfb@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.14
+Requires-Dist: boto3<2,>=1.42
+Requires-Dist: toolframe-sdk==0.3.0
+Description-Content-Type: text/markdown
+
+# Toolframe S3 object storage
+
+`object-store-s3` keeps private Toolframe files in an existing S3-compatible bucket.
+It implements `toolframe.object_store` v1, matching the local provider's SDK client
+and Dashboard image workflow. RustFS is the local integration target.
+
+## Quick start
+
+Use Toolframe Core 0.6.2 and SDK 0.3.0 with object-storage support.
+Create a private bucket first. Supply credentials through the standard AWS chain
+in the environment that starts Core (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`,
+optional `AWS_SESSION_TOKEN`, or a supported AWS profile/role).
+
+With the plugin installed but disabled, set its configuration in `toolframe.toml`:
+
+```toml
+[plugins.object-store-s3]
+source = "pypi:toolframe-object-store-s3==0.1.0"
+enabled = false
+
+[plugins.object-store-s3.config]
+bucket = "toolframe-images"
+endpoint_url = "http://127.0.0.1:9000"
+region = "us-east-1"
+prefix = "toolframe"
+addressing_style = "path"
+max_object_bytes = 67108864
+```
+
+Core downloads the pinned package from PyPI when applying this configuration.
+Omit `endpoint_url` for AWS S3. TLS verification stays enabled for HTTPS endpoints.
+Use `addressing_style = "virtual"` when required by your service. Do not put access
+keys, secrets or URL credentials in plugin configuration.
+
+```sh
+toolframe-core --home APP plugin enable object-store-s3
+```
+
+Disable the local object-store provider before enabling S3; each application
+selects one provider. Existing local files do not migrate automatically.
+Business code continues to use `self.context.object_store()` unchanged.
+
+## Storage and permissions
+
+Objects live under `<prefix>/<sha256(application-id)>/<plugin-id>/<key>`. The
+provider only accesses the existing bucket; it never creates buckets, changes
+ACLs or enables public access. Grant ListBucket on the configured prefix and
+GetObject, PutObject and DeleteObject for its objects. Keep application IDs and
+prefixes stable across restarts. Use bucket backup/versioning policies for recovery.
+
+Core inherits the AWS environment into trusted workers. Use an application-scoped
+credential/profile; this is not a credential sandbox between untrusted plugins.
+`head_bucket` checks access during activation. Service errors do not return SDK
+exception text, credentials or endpoints to callers.
+
+Uploads stage in bounded local temporary files before one atomic `PutObject`.
+Content type and SHA-256 metadata are retained. Range reads use S3 conditional
+requests to reject concurrent replacement. The common limit is 64 MiB per object,
+256 KiB per wire chunk, 32 unfinished uploads and 256 MiB staging per worker;
+`max_object_bytes` may lower the object limit. Sessions expire after ten minutes.
+Completed data survives plugin removal; unfinished uploads do not survive restart.
+There is no cross-resource transaction, durable upload resumption, presigned URL,
+public download endpoint or automatic migration in this version.
+
+## Test with RustFS
+
+Follow the official [RustFS container instructions](https://docs.rustfs.com/en/installation/container).
+Use a dedicated test bucket and credentials. Example local-only container:
+
+```sh
+# rustfs.env contains private RUSTFS_ACCESS_KEY and RUSTFS_SECRET_KEY values.
+docker run -d --name toolframe-rustfs --env-file ./rustfs.env \
+  -p 127.0.0.1:9000:9000 -p 127.0.0.1:9001:9001 \
+  -v toolframe-rustfs-data:/data -v toolframe-rustfs-logs:/logs \
+  rustfs/rustfs:latest
+```
+
+For sibling development checkouts with the matching SDK:
+
+```sh
+uv sync --group dev
+uv run pytest -q                     # stub tests; live test explicitly skips
+export TOOLFRAME_TEST_S3_ENDPOINT=http://127.0.0.1:9000
+export TOOLFRAME_TEST_S3_BUCKET=toolframe-test
+# Set AWS credentials separately, then create this dedicated bucket once.
+uv run pytest -q                     # includes the live integration test
+uv run ruff check src tests
+uv build --no-sources
+```
+
+The integration test uses a unique prefix and removes only the objects it created.
+It checks a >1 MiB upload, exact download, empty files, restart, application
+isolation, replacement detection, pagination and deletion. Record the container
+image digest with acceptance evidence. Runtime validation requires a separate
+application because a scratch home does not isolate the remote bucket.
+AWS S3 and other compatible services require their own acceptance run; RustFS
+coverage does not establish compatibility with every S3 extension.
+
+Licensed under Apache-2.0; see [LICENSE](LICENSE).
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).

toolframe_object_store_s3-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+toolframe_object_store_s3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+toolframe_object_store_s3/plugin.py,sha256=5aLn9e3J5HREOM91sqr3DyFz0x-S4YHRwIc69SJO8_E,6898
+toolframe_object_store_s3-0.1.0.dist-info/METADATA,sha256=7YAF434T5GMkiTiTZuwEApU9Aeq4vup3bUhoXyPw9bk,5278
+toolframe_object_store_s3-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+toolframe_object_store_s3-0.1.0.dist-info/entry_points.txt,sha256=BIiWFZoPbD9I7ManLSzsAfeeVymQ_HzrFWuhVEZk4r0,78
+toolframe_object_store_s3-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+toolframe_object_store_s3-0.1.0.dist-info/licenses/NOTICE,sha256=ul1rv24we4KKVQWRRg9fjEFtmvZ8k0zk7ACr380mPXo,48
+toolframe_object_store_s3-0.1.0.dist-info/RECORD,,

toolframe_object_store_s3-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

toolframe_object_store_s3-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[toolframe.plugins]
+object-store-s3 = toolframe_object_store_s3.plugin:plugin

toolframe_object_store_s3-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

toolframe_object_store_s3-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,2 @@
+Toolframe
+Copyright 2026 Toolframe contributors