Skip to content

docs(proxies): stop promising UDP through SOCKS5 proxies the tunnel never lets out - #634

Closed
GeiserX wants to merge 4 commits into
mainfrom
docs/proxy-udp-tcp-only
Closed

GeiserX wants to merge 4 commits into
mainfrom
docs/proxy-udp-tcp-only

Conversation

@GeiserX

@GeiserX GeiserX commented Nov 7, 2026

Copy link
Copy Markdown
Owner

Problem

The proxies page says a SOCKS5 proxy "carries UDP only if the provider supports SOCKS5 UDP ASSOCIATE", and that UDP services work through SOCKS5 when the provider supports it. The tunnel does not allow that: for a socks5 or http proxy, tunnel/cp-tunnel lets traffic out only over TCP to the proxy's address and port (EGRESS_RULE="... ip daddr $PROXY_IP tcp dport $PROXY_PORT accept"). A UDP ASSOCIATE relay sends UDP to the proxy, so the firewall drops it. The comparison page already says "TCP only", so the two pages disagree.

Fix

  • The SOCKS5 row says TCP only, and why.
  • The Tailscale row says UDP is included (tailscale0 traffic is accepted whatever the protocol).
  • "What cannot run through a proxy" says UDP services need a Tailscale exit node.

We are keeping the tunnel as it is. Opening UDP to the proxy would mean letting the earner reach any UDP port on the proxy host.

Check

tests/test_docs_proxy_udp.py reads the socks5 | http egress rule from cp-tunnel and checks the page. It fails on main's page (test_the_page_does_not_promise_udp_through_socks5). It also fails if the rule is changed to let UDP out, so the test cannot pass on a stale premise.

docs/proxies.md said a SOCKS5 proxy carries UDP when the provider supports
UDP ASSOCIATE. cp-tunnel lets a socks5 or http tunnel out only over TCP to
the proxy's port, so UDP relays are dropped. The page now says SOCKS5 and
HTTP CONNECT carry TCP only and a Tailscale exit node carries UDP, matching
the comparison page. A test reads the tunnel's egress rule and fails if the
page promises UDP through SOCKS5 again.
@coderabbitai

coderabbitai Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 33 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

Commits

Reviewing files that changed from the base of the PR and between d709e47 and 61d57ea.

Files selected for processing: 2

  • docs/proxies.md
  • tests/test_docs_proxy_udp.py
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@codecov

codecov Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.97%. Comparing base (d709e47) to head (61d57ea).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #634   +/-   ##
=======================================
  Coverage   93.97%   93.97%           
=======================================
  Files          74       74           
  Lines       15678    15678           
=======================================
  Hits        14733    14733           
  Misses        945      945           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GeiserX

GeiserX commented Nov 7, 2026

Copy link
Copy Markdown
Owner Author

CodeRabbit hit its review limit here, so it reviewed the same head on the mirror geiresx#29. One nitpick: the matcher missed a plain 'SOCKS5 carries UDP'. Fixed in 'test(proxies): also catch a plain SOCKS5 carries UDP claim'.

@GeiserX

GeiserX commented Nov 7, 2026

Copy link
Copy Markdown
Owner Author

Landed in #653 (f681889), which combined this fix with the others into one release.

@GeiserX GeiserX closed this Nov 7, 2026
@GeiserX
GeiserX deleted the docs/proxy-udp-tcp-only branch November 7, 2026 21:41
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.

1 participant