S3 bundle provider (own project; read-only first)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reading the provider design and dependency-policy discussion in #139, then the filesystem provider and conformance tests in #140. Compare the AWS SDK and BCL HttpClient/SigV4 options and record the project-scoped dependency decision in CLAUDE.md. Implement and test the read-only S3 provider, including the malicious-key battery; done means conformance tests pass against an S3-compatible store and the local command reports 0 skipped.
Written by the indexing model from the issue text.
Description
Area
New project (one project per backend, see #139): a bundle provider backed by Amazon S3 / S3-compatible object storage. Name to settle, e.g. OKF4net.Providers.S3.
Why it matters
First genuinely remote backend: lets agents and the MCP host read a bundle that lives in object storage (shared across hosts, managed outside the repo) — the stated goal of the provider work (read first).
Scope
- Read: bundle = bucket + key prefix; list/read/stat mapped onto
ListObjectsV2/GetObject/HeadObject. - Read-only first. Whether and how it declares
CanWriteis deferred to the atomicity/concurrency discussion on #139 (S3 conditional writes —If-Match/If-None-Match— are the obvious building block, but the semantics must be agreed first). - Dependency policy. This is the first backend needing a third-party package (AWS SDK, or a minimal BCL
HttpClient+ SigV4 implementation — to compare). Either way it is an explicit, project-scoped exception to the zero-dependency rule, likeCatalog.Hosting: nothing in the core may reference it. Record the decision inCLAUDE.md. - Credentials are the host's: the provider takes a configured client or credential source, never reads secrets itself.
- Security (to be framed on #139 first): key normalisation and traversal (
..,//, encoded separators, case), what "outside the bundle" means for a prefix, endpoint configuration for S3-compatible stores (no redirect to arbitrary hosts), bounded sizes for listings and objects. - Caching/freshness: depends on the open freshness discussion (ETag-based revalidation is the natural fit).
Acceptance
- Same conformance tests as the filesystem provider (#140), run against an S3-compatible store (e.g. MinIO in a container), excluded from default CI like
ContainerIntegrationif it needs a running service — with the local command documented and a "0 skipped" check. - Every write path fails with the read-only exception while the provider is read-only.
- Malicious-key battery (traversal, encoded separators, oversized listing) executed, not just reviewed.
Depends on
#139, #140 — and the security framing on #139.
Effort
L
🤖 Generated with Claude Code
- Dominant language
- C#
- Stars
- 4
- Forks
- 1
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 32
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jchable/okf4net
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
.NET bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
test
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/backend type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
umbraco/Umbraco-CMS#24668 · 1 comment ·
Maintainers usually reply within 1 day
-
Pri3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MicrosoftDocs/windows-dev-docs#6205 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
area-ai untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/extensions#7956 ·
Maintainers usually reply within 1 day