-
Notifications
You must be signed in to change notification settings - Fork 44
app/(docs)/dcs/api/s3/s3-compatibility: add storj-vs-self-managed-encryption-s3-compatibility-differences #617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
435fd1a
app/(docs)/dcs/api/s3/s3-compatibility: add storj-vs-self-managed-enc…
amwolff 67d3cbe
write the page
amwolff b6e5b37
Update page.md
amwolff da855ae
use "s3 compatibility" as a noun properly
amwolff 7c09110
clarify how bucket paths are encrypted
amwolff 5b11df4
swap paths for objects keys and add at-a-glance table
amwolff File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
31 changes: 31 additions & 0 deletions
31
...atibility/storj-vs-self-managed-encryption-s3-compatibility-differences/page.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: Storj Managed vs. Self-Managed Encryption S3 Compatibility Differences | ||
| docId: oozaauQueuq9hgeac4Ze | ||
| weight: 1 | ||
| --- | ||
|
|
||
| ## Listing Endpoints Behavior | ||
|
|
||
| The behavior of listing endpoints depends on the encryption model configured for your project. | ||
|
|
||
| | Encryption Type | S3 Compatibility | | ||
| | :--- | :--- | | ||
| | **Self-Managed Encryption** | **Limited** (Restricted sorting/filtering) | | ||
| | **Storj Managed Encryption** | **Full** (Fully S3-compatible) | | ||
|
|
||
| ### Self-Managed Encryption | ||
| When using **Self-Managed Encryption**, object keys are end-to-end encrypted. This prevents the listing endpoint from deciphering the keys, which affects sorting and filtering. | ||
|
|
||
| * **Standard Listing:** For requests using a forward-slash (`/`) as a prefix terminator or delimiter, results are returned in the lexicographical order of the *encrypted* object keys. This often differs from the expected alphabetical order of the decrypted keys. Clients should not rely on ordering in these cases. | ||
| * **Exhaustive Listing:** For requests using non-standard prefixes or delimiters (not ending in `/`), the endpoint performs an "exhaustive listing." This filters object keys server-side to return results in the correct (decrypted) lexicographical order. | ||
|
|
||
| **Limitations:** | ||
| 1. **New Projects:** Projects created after **November 30, 2025**, cannot use exhaustive listing. Requests triggering this behavior will fail with a `501 Not Implemented` error. | ||
| 2. **Large Buckets:** Exhaustive listing does not work for buckets containing hundreds of thousands of objects. | ||
|
|
||
| Users requiring these features should use Storj Managed Encryption. | ||
|
|
||
| ### Storj Managed Encryption | ||
| If your project uses **Storj Managed Encryption**, object keys are **encrypted using server-managed keys**. This allows the system to process object keys directly, ensuring that Storj's S3 listing endpoints are **fully S3-compatible**. | ||
|
|
||
| Requests can use arbitrary prefixes and/or delimiters. These requests utilize an optimized execution path, offering superior performance compared to Self-Managed Encryption. Storj recommends Storj Managed Encryption for all new projects requiring high performance and strict S3 compatibility. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.