s3broker 0.4.2 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,9 +5,18 @@
|
|
|
5
5
|
|
|
6
6
|
A Cloudflare Workers library for building S3 proxies with guardrails.
|
|
7
7
|
|
|
8
|
+
This is a work in progress. More guardrails and features would be added soon.
|
|
9
|
+
|
|
8
10
|
## Overview
|
|
9
11
|
|
|
10
|
-
S3Broker is a TypeScript library for building proxies and guardrails for S3-compatible storage.
|
|
12
|
+
S3Broker is a TypeScript library for building proxies and guardrails for S3-compatible storage. The library is intended to be used on Cloudflare Workers.
|
|
13
|
+
|
|
14
|
+
When you have an S3 secret key with read/write access, any client using that key can perform destructive operations. Your data is vulnerable to:
|
|
15
|
+
|
|
16
|
+
- **Accidental deletion** by users or misconfigured tools
|
|
17
|
+
- **Ransomware attacks** that encrypt or delete your files
|
|
18
|
+
|
|
19
|
+
S3Broker acts as a protective layer between your clients and the upstream S3 endpoint. Instead of giving clients direct access to your upstream key (Key B), you give them a different key (Key A). S3Broker validates every request against configurable guardrails and blocks dangerous operations before they reach your storage.
|
|
11
20
|
|
|
12
21
|
```
|
|
13
22
|
========== ============ ============
|
|
@@ -15,13 +24,6 @@ S3Broker is a TypeScript library for building proxies and guardrails for S3-comp
|
|
|
15
24
|
========== ============ ============
|
|
16
25
|
```
|
|
17
26
|
|
|
18
|
-
**Key Features:**
|
|
19
|
-
|
|
20
|
-
- **Two-Key Authentication**: Clients authenticate with Key A; S3Broker re-signs requests with Key B for the upstream
|
|
21
|
-
- **Guardrails Framework**: Configurable policies to protect your data (e.g., prevent deletion of recently created objects)
|
|
22
|
-
- **Full S3 Compatibility**: Works with any S3 client (AWS SDK, s3cmd, rclone, etc.)
|
|
23
|
-
- **Cloudflare Workers**: Built for Cloudflare Workers runtime
|
|
24
|
-
|
|
25
27
|
## Installation
|
|
26
28
|
|
|
27
29
|
```bash
|