Docs: socks5 autodiscovery, exit security, rust socks5 page - #6928
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughChangesThe PR adds documentation for the Rust SDK SOCKS5 module, updates related navigation and references, expands Exit Gateway security guidance to cover IPR and NR, and revises service consumer listings. Rust SDK SOCKS5 module
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant RustApplication
participant Socks5MixnetClient
participant Mixnet
participant NetworkRequester
participant Destination
RustApplication->>Socks5MixnetClient: Connect through socks5h://
Socks5MixnetClient->>Mixnet: Segment TCP stream into mixnet traffic
Mixnet->>NetworkRequester: Deliver SOCKS request
NetworkRequester->>Destination: Request public destination
Destination-->>NetworkRequester: Return response
NetworkRequester-->>Socks5MixnetClient: Reassemble response stream
Socks5MixnetClient-->>RustApplication: Return response
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install timed out. The project may have too many dependencies for the sandbox. 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. Comment |
merve64
approved these changes
Jun 30, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@documentation/docs/pages/developers/concepts/exit-security.mdx`:
- Around line 70-71: The SOCKS5 documentation bullet uses stale API names, so
update the referenced callsites in this section to match the current symbols.
Replace the outdated `Socks5MixnetClient::connect_new(...)` and
`discover().countries([...])` wording with the correct
`Socks5MixnetClient::connect_with(...)` and
`NetworkRequester::in_countries([...])` references so the docs align with the
actual API.
In `@documentation/docs/pages/developers/rust.mdx`:
- Line 54: The SOCKS proxy description in the Rust developer docs overstates
supported protocols and should be narrowed to match the actual
`Socks5MixnetClient` contract. Update the `SOCKS5 module` blurb in the Rust docs
to describe only SOCKS5 support unless there is explicit implementation evidence
elsewhere, and keep the wording aligned with the `./rust/socks5` module name and
related docs.
In `@documentation/docs/pages/developers/rust/socks5.mdx`:
- Line 129: The SOCKS5 example link currently points to the mutable develop
branch, which can drift from the documented Rust API. Update the link in the
socks5.mdx page to use a version-stable target, such as a tagged permalink or
another immutable reference, so the example stays aligned with the docs. Use the
existing “Example: SOCKS5 proxy” link text as the anchor and replace only the
branch-based GitHub target.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: bff02bde-c53b-46c3-ae18-26034e4d8633
📒 Files selected for processing (8)
documentation/docs/pages/developers/_meta.jsondocumentation/docs/pages/developers/clients/socks5.mdxdocumentation/docs/pages/developers/concepts/exit-security.mdxdocumentation/docs/pages/developers/index.mdxdocumentation/docs/pages/developers/rust.mdxdocumentation/docs/pages/developers/rust/_meta.jsondocumentation/docs/pages/developers/rust/socks5.mdxdocumentation/docs/pages/network/infrastructure/exit-services.mdx
mfahampshire
force-pushed
the
max/socks5-autodiscovery-docs
branch
from
July 23, 2026 14:05
650798f to
d3ea0f4
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@documentation/docs/pages/developers/concepts/exit-security.mdx`:
- Line 21: Update the proxy-mode explanation in
documentation/docs/pages/developers/concepts/exit-security.mdx at lines 21-21
and 48-48: describe the Network Requester as seeing the SOCKS destination, and
qualify hostname visibility as applying only to socks5h requests while
IP-address requests expose only the address. Preserve the existing distinction
at line 65.
- Around line 89-96: Update the “Exit node sees traffic?” row in the Nym column
to scope its visibility claim to proxy mode, using wording such as “Proxy mode:
Yes.” Keep the existing Tor and VPN entries unchanged and ensure the table no
longer implies that end-to-end Nym traffic has an Exit Gateway.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: bfb5a060-dbac-4686-bc05-02adddc02615
📒 Files selected for processing (8)
documentation/docs/pages/developers/clients/socks5.mdxdocumentation/docs/pages/developers/concepts/exit-security.mdxdocumentation/docs/pages/developers/index.mdxdocumentation/docs/pages/developers/rust.mdxdocumentation/docs/pages/developers/rust/_meta.jsondocumentation/docs/pages/developers/rust/mixnet.mdxdocumentation/docs/pages/developers/rust/socks5.mdxdocumentation/docs/pages/network/infrastructure/exit-services.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- documentation/docs/pages/developers/index.mdx
- documentation/docs/pages/developers/rust/_meta.json
- documentation/docs/pages/network/infrastructure/exit-services.mdx
- documentation/docs/pages/developers/rust/socks5.mdx
mfahampshire
force-pushed
the
max/socks5-autodiscovery-docs
branch
from
July 27, 2026 11:41
d3ea0f4 to
c9170e8
Compare
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (2)
documentation/docs/pages/developers/concepts/exit-security.mdx (2)
21-21: 🔒 Security & Privacy | 🟡 Minor | ⚡ Quick winQualify Network Requester hostname visibility by SOCKS address type.
These lines still state that the NR sees a hostname unconditionally. For
socks5requests, the client may send an IP address; hostname visibility applies tosocks5h. This repeats the previously reported issue and remains present in the supplied final file.Proposed wording
- via either the IP Packet Router (raw IP packets) or the SOCKS-based Network Requester (which sees the destination hostname), and continues + via either the IP Packet Router (raw IP packets) or the SOCKS-based Network Requester (which sees the SOCKS destination, including a hostname only for `socks5h` requests), and continues ... -| Exit Gateway (IPR or NR) | Sphinx removed; raw IP packet (IPR) or SOCKS request (NR) exposed | The IPR sees the destination IP and port; the NR sees the destination hostname. Either way the payload depends on your application layer (see below). | +| Exit Gateway (IPR or NR) | Sphinx removed; raw IP packet (IPR) or SOCKS request (NR) exposed | The IPR sees the destination IP and port; the NR sees the SOCKS destination: a hostname for `socks5h`, or an IP address when resolved locally. Either way the payload depends on your application layer (see below). |Also applies to: 48-48
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@documentation/docs/pages/developers/concepts/exit-security.mdx` at line 21, Update the proxy-mode explanation near the Network Requester reference to qualify hostname visibility by SOCKS address type: state that the NR sees the destination hostname for socks5h requests, while socks5 requests may provide an IP address. Apply the same clarification to the corresponding repeated statement later on the page.
91-91: 🔒 Security & Privacy | 🟡 Minor | ⚡ Quick winScope the Nym exit-visibility row to proxy mode.
End-to-end Nym traffic has no Exit Gateway, but this comparison row currently says the exit sees traffic without qualification. Use wording such as
Proxy mode: Yes (encrypt it)so the table does not contradict the end-to-end model described above.Proposed fix
-| **Exit node sees traffic?** | Yes (encrypt it) | Yes (encrypt it) | Yes (encrypt it) | +| **Exit node sees traffic?** | Proxy mode: Yes (encrypt it) | Yes (encrypt it) | Yes (encrypt it) |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@documentation/docs/pages/developers/concepts/exit-security.mdx` at line 91, Update the “Exit node sees traffic?” comparison row to qualify the Nym entry as applying only to proxy mode, using wording such as “Proxy mode: Yes (encrypt it)”; leave the other columns unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@documentation/docs/pages/developers/concepts/exit-security.mdx`:
- Line 21: Update the proxy-mode explanation near the Network Requester
reference to qualify hostname visibility by SOCKS address type: state that the
NR sees the destination hostname for socks5h requests, while socks5 requests may
provide an IP address. Apply the same clarification to the corresponding
repeated statement later on the page.
- Line 91: Update the “Exit node sees traffic?” comparison row to qualify the
Nym entry as applying only to proxy mode, using wording such as “Proxy mode: Yes
(encrypt it)”; leave the other columns unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: ae40c463-cd76-4f9b-bbd2-48572e946545
📒 Files selected for processing (8)
documentation/docs/pages/developers/clients/socks5.mdxdocumentation/docs/pages/developers/concepts/exit-security.mdxdocumentation/docs/pages/developers/index.mdxdocumentation/docs/pages/developers/rust.mdxdocumentation/docs/pages/developers/rust/_meta.jsondocumentation/docs/pages/developers/rust/mixnet.mdxdocumentation/docs/pages/developers/rust/socks5.mdxdocumentation/docs/pages/network/infrastructure/exit-services.mdx
🚧 Files skipped from review as they are similar to previous changes (5)
- documentation/docs/pages/developers/rust/mixnet.mdx
- documentation/docs/pages/developers/rust/_meta.json
- documentation/docs/pages/developers/rust.mdx
- documentation/docs/pages/developers/rust/socks5.mdx
- documentation/docs/pages/network/infrastructure/exit-services.mdx
mfahampshire
enabled auto-merge (squash)
July 27, 2026 13:29
mfahampshire
disabled auto-merge
July 27, 2026 13:57
mfahampshire
enabled auto-merge (squash)
July 27, 2026 13:57
2 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Split out from max/socks5-to-socks-plus-autodiscovery so docs can be reviewed and merged (autodeploys) independently of the nym-sdk code, which still needs QA.
This change is
Summary by CodeRabbit
New Features
Documentation