← 输入框|github.com|刷新
Skip to content

docs(reach): document the network access reachability needs - #441

Open
lelia wants to merge 2 commits into
mainfrom
lelia/surf-2105-document-tier-1-reachability-network-requirements
Open

lelia wants to merge 2 commits into
mainfrom
lelia/surf-2105-document-tier-1-reachability-network-requirements

Conversation

@lelia

@lelia lelia commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Documents the network access --reach needs. None of it is in the docs today, and one failure mode is quiet: with the package registry blocked, the scan completes and reports every affected vulnerability as INSTALL ERROR.

  • docs/cli-reference.md: a "Reachability network access" section after the reachability requirements. It lists api.socket.dev, storage.googleapis.com (engine download, about 120 MB) and each ecosystem's package registry, what fails when each is blocked, that an npm mirror does not cover the engine, that preinstalled dependencies remove the registry need, and that HTTPS_PROXY is honored.
  • docs/troubleshooting.md: an entry for the two failure signatures.
  • CHANGELOG.md: a 2.11.12 docs entry, plus a note under 2.11.1 that 2.11.0 was not published.
  • Version 2.11.12, because check_version requires a bump. Documentation-only otherwise.

Verification

Every claim was checked against socketcli 2.11.11 --reach on an npm test project, with a DNS sidecar that logged and allowlisted hostnames, plus a logging proxy on a network with no other egress:

Allowed Result
everything 1 reachable, 4 unreachable; lookups: api.socket.dev, storage.googleapis.com, registry.npmjs.org
api.socket.dev, storage.googleapis.com exit 0, all 5 vulnerabilities INSTALL ERROR
storage.googleapis.com blocked exit 3, Failed to run reachability analysis: HTTPSConnectionPool(host='storage.googleapis.com', ...)
proxy only, HTTPS_PROXY set full results; CLI, engine download, engine API calls and npm installs all went through the proxy

Public Changelog

N/A


Note

Low Risk
Documentation and version metadata only; no changes to scan, reachability, or networking code paths.

Overview
Documents which hosts --reach must reach and what breaks when they are blocked, filling a gap where registry failures can finish the scan with every affected finding as INSTALL ERROR.

docs/cli-reference.md adds a Reachability network access section: a table for api.socket.dev, storage.googleapis.com (~120 MB engine download), and per-ecosystem registries; notes that npm mirrors do not cover the Socket-hosted engine, preinstalled deps skip registry use, warm cache avoids GCS, and HTTPS_PROXY applies to the CLI, download, and engine.

docs/troubleshooting.md adds matching bullets for the GCS connection error (exit 3) and blanket INSTALL ERROR results.

CHANGELOG.md records 2.11.12 (docs-only) and clarifies that 2.11.0 was never published. Version is bumped to 2.11.12 in pyproject.toml, socketsecurity/__init__.py, and uv.lock for the release/version check; no runtime behavior changes.

Reviewed by Cursor Bugbot for commit d9c5dce. Configure here.

`--reach` downloads the analysis engine from storage.googleapis.com
through a signed URL from api.socket.dev, then installs the project's
dependencies from each ecosystem's registry. None of that was
documented, and the registry case fails quietly: the scan completes but
reports every affected vulnerability as INSTALL ERROR.

Add a "Reachability network access" section to the CLI reference with
the hosts, what fails when each is blocked, and proxy behavior, plus a
troubleshooting entry for the two failure signatures. Note that 2.11.0
was never published. Bump to 2.11.12 for the version check.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is ON, but none of the reported issues met your autofix severity threshold.

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit d9c5dce. Configure here.

Comment thread CHANGELOG.md Resolved
The entry only needs the documented network requirements. The note about the 2.11.1 heading and the documentation-only remark describe the PR, not the release.
@lelia
lelia temporarily deployed to socket-firewall November 5, 2026 20:15 — with GitHub Actions Inactive
@lelia

lelia commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

bugbot run

@cursor

cursor Bot commented Nov 5, 2026

Copy link
Copy Markdown

Skipping Bugbot: your team's auto mode classified this PR to skip. Visit the Bugbot dashboard to update your settings.

This branch was previously deployed

1 inactive deployment
socket-firewall — d9f55ffc Deployed Nov 5, 2026 by lelia via python-sfw-smoke-enterprise #556
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