Skip to content

πŸ“– docs: proxy override reflects the tunnel destination guard behaviour - #17034

Merged
hivecommons-hive[bot] merged 1 commit into
v5from
docs/proxy-override-drift
Nov 7, 2026
Merged

hivecommons-hive[bot] merged 1 commit into
v5from
docs/proxy-override-drift

Conversation

@clubanderson

Copy link
Copy Markdown
Member

Summary

Docs drift after #16785 and #16895 (merged into v5 on 2026-11-07). #16785 routed the two uninspected tunnel legs (tunnelDirect CONNECT passthrough and dialTunnelUpstream transparent-TLS passthrough) through the same guarded dialer as the plain-HTTP forward path, so HIVE_PROXY_ALLOW_PRIVATE_FORWARD now lifts the destination guard for all three legs. Two docs still described the guard and its override as plain-HTTP-only. #16895 (canary body read fails closed) touched the same proxy package and was checked for doc impact; it needed none.

No code changes. Every claim traces to the #16785 diff or current src/crux/proxy/plain_forward_guard.go / github_proxy_connect.go.

Corrected statements

  • src/docs/env-vars.md (HIVE_PROXY_ALLOW_PRIVATE_FORWARD row): was "Lifts the plain-HTTP forward destination guard ... a non-CONNECT request through the proxy is dialled only when ...". Now says the guard covers plain-HTTP forwards, uninspected CONNECT tunnels and transparent-TLS passthrough, that the override lifts it for all three legs at once, and that the proxy logs a boot-time warning when it is set. Links πŸ› fix(crux/proxy): apply destination policy to uninspected tunnelsΒ #16785 beside Review backlog (security): Plain-HTTP forward path has no host allowlist or caller identity check (pre-existing)Β #14082.
  • src/docs/env-vars.md (same row): "deployments that genuinely egress to a private network over plain HTTP" -> "through the proxy", since the override is no longer plain-HTTP-only.
  • src/docs/security-model.md Β§5 "Plain-HTTP forwards": retitled "Plain-HTTP forwards and uninspected tunnels"; adds that a CONNECT to a non-inspected host and the transparent-TLS passthrough use the same guarded dialer, so CONNECT 169.254.169.254:80 or an SNI naming a cluster address is refused rather than tunnelled from the proxy's uid.
  • src/docs/security-model.md Β§5: "Set HIVE_PROXY_ALLOW_PRIVATE_FORWARD=true only where a private-network plain-HTTP destination is intended" -> "private-network destination", plus the all-three-legs and boot-time-warning notes.

Changelog

changelog.d/changed-16785-proxy-override-docs.md (src/scripts/check-changelog-fragment.sh with BASE_REF=v5 passes).

Checklist

  • Commits are signed off (git commit -s)
  • Changelog fragment added

Since #16785 the proxy's destination guard covers plain-HTTP forwards,
uninspected CONNECT tunnels and transparent-TLS passthrough, and
HIVE_PROXY_ALLOW_PRIVATE_FORWARD=true lifts it for all three legs.
env-vars.md and security-model.md still described the guard and its
override as plain-HTTP-only; bring both in line with the code.

Signed-off-by: Andrew Anderson <andy@clubanderson.com>
@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Nov 7, 2026
@kubestellar-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign danathar for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubestellar-prow kubestellar-prow Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 7, 2026
@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Open PR overlap check

Base branch: v5

Conflicts are checked with every PR merged onto the current tip of v5, so a PR that only needs a rebase is not reported as conflicting with its siblings.

No conflicting open PRs or same-file overlaps were found.

@hivecommons-hive

hivecommons-hive Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Hive status β€” updated in place; edits do not notify. Full history is in the Activity Monitor.

@clubanderson this PR is held at stage/071-needs-author and the hive will not merge it yet.

Failing checks:

  • PR Issue

Next: the hive does not push to your branch. Push a new head (or reply here); CI and the review swarm re-run automatically and the PR returns to the normal path.

Evidence bundle `#170343c64922` sha256:9d4fe42df3d36a3dd0b4c36167b1ea672eb166be455964090261f45b7cf04064 β€” download from the dashboard or `hivectl review evidence #17034`.

@hivecommons-hive
hivecommons-hive Bot merged commit 92cd2af into v5 Nov 7, 2026
83 of 86 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the docs/proxy-override-drift branch November 7, 2026 18:23
@hivecommons-hive

Copy link
Copy Markdown
Contributor

merged by Hive trusted-author auto-merge: author @clubanderson holds role owner and GitHub permission admin on repo; CI green at 3c64922.

@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution! Your PR has been merged.

We'd love to hear how your experience was: share feedback

@clubanderson clubanderson changed the title πŸ“– docs: proxy override reflects #16785/#16895 behaviour πŸ“– docs: proxy override reflects the tunnel destination guard behaviour Nov 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant