Skip to content

🧹 chore: post-v1.0.0 cleanup — README trim, version refs, Snyk exclude#67

Merged
s-b-e-n-s-o-n merged 4 commits into
mainfrom
chore/post-v1.0-cleanup
May 21, 2026
Merged

🧹 chore: post-v1.0.0 cleanup — README trim, version refs, Snyk exclude#67
s-b-e-n-s-o-n merged 4 commits into
mainfrom
chore/post-v1.0-cleanup

Conversation

@s-b-e-n-s-o-n
Copy link
Copy Markdown
Contributor

Summary

Housekeeping now that v1.0.0 is tagged and published.

README cleanup

  • Drop deferential "wollomatic" framing in the comparison section.
  • Trim the Configuration section: the 274-line exhaustive inline YAML dump is replaced with a short overview that links to the configuration reference on the docs site.

Stale version references → v1.0.0

  • SECURITY.md — supported-versions table tracks the 1.0.x line; prose drops the "until v1.0 is tagged" qualifier.
  • docs/content/docs/verification.mdx — cosign verify-blob example uses v1.0.0 tarball asset names.
  • website/src/components/cli-demo.tsxversion / --version demo output shows v1.0.0 at the release commit.

Snyk Code false positives

  • Exclude app/internal/ownership/middleware.go from Snyk Code. Its upstreamInspector methods build a request URL from a client-supplied identifier and pass it to NewRequestWithContext — flagged as SSRF (CWE-918). False positive: the URL host is the hardcoded literal "http://docker", only the path is dynamic, and u.client's transport is pinned to the Docker unix socket via a custom DialContext. CodeQL and Gosec still scan the file.

Verification

  • snyk code test --severity-threshold=high0 issues (was 2 HIGH).
  • Biome check on the modified cli-demo.tsx → clean.
  • No Go code changed — govulncheck / grype are unchanged from main (already verified clean).

The comparison prose led with "We give wollomatic its due — it is the
strongest of the prior generation" and re-listed wollomatic's feature
set that the comparison table directly above already covers. Cut the
redundant sentence — the table carries the comparison.
The Configuration section had grown into a ~300-line reference manual
duplicating docs/content/docs/{configuration,admin,observability,
security}.mdx — configuration.mdx alone is more thorough at 1049 lines.

Replace the kitchen-sink YAML and per-knob prose (mTLS selectors, ACLs,
profiles, rate limits, rollout modes, hot-reload, admin API, signed
bundles, ownership, insecure opt-ins, redaction) with a minimal example
plus links to the canonical docs pages. Keeps the env-var quick
reference and the preset / compose-stack lists.
v1.0.0 was tagged and published on 2026-05-20; update the references that
still pointed at the rc.2 pre-release:

- SECURITY.md — supported-versions table now tracks the 1.0.x line, and
  the prose drops the "until v1.0 is tagged" qualifier.
- docs verification.mdx — cosign verify-blob example uses the v1.0.0
  tarball asset names.
- website cli-demo.tsx — `version` / `--version` demo output shows
  v1.0.0 at the release commit.
Snyk Code's taint analysis flags upstreamInspector.inspectResource /
inspectExec with two HIGH SSRF findings (CWE-918): a client-supplied
resource identifier flows into the URL passed to NewRequestWithContext.

Both are false positives. The URL host is the hardcoded literal
"http://docker" — only the request path is dynamic, so the host can
never be attacker-redirected — and u.client's transport is pinned to the
Docker unix socket via a custom DialContext that ignores the host
entirely. No outbound request can reach anything but the configured
Docker socket.

Snyk Code findings cannot be ignored per-finding via the SCA-only
`ignore:` section, so this uses the existing `exclude: code:` mechanism.
CodeQL and Gosec still scan the file.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sockguard-website Ready Ready Preview, Comment May 21, 2026 3:36pm

Copy link
Copy Markdown
Member

@biggest-littlest biggest-littlest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Post-v1.0.0 housekeeping — README trim, stale rc.2 refs bumped, Snyk Code SSRF false positives excluded with justification. CI green, security/snyk green.

@s-b-e-n-s-o-n s-b-e-n-s-o-n merged commit 8ee701a into main May 21, 2026
36 checks passed
@s-b-e-n-s-o-n s-b-e-n-s-o-n deleted the chore/post-v1.0-cleanup branch May 21, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants