-
Notifications
You must be signed in to change notification settings - Fork 39
add socket tier 1 reachability analysis #550
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
57e8b93
81cfc8f
4ca3b58
1bee36c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Socket reachability scan for rs-stellar-xdr. | ||
| # For general Socket reachability documentation, see https://docs.socket.dev/docs/full-application-reachability | ||
| # Rust workspace (root + xdr-generator-rust subcrates). | ||
| # | ||
| # Schedule: Sun 01:36 UTC weekly. Use workflow_dispatch to run on demand. | ||
| # | ||
| # ============================================================================ | ||
| # Socket scan — reading the job status. (The scan step below produces this: an | ||
| # exit code + an optional ::warning:: annotation, which GitHub Actions renders | ||
| # as the job's state.) | ||
| # ============================================================================ | ||
| # GREEN (exit 0, no warning): scan completed and every analyzed vulnerability | ||
| # got full Tier 1 reachability (precise, your-code-aware). Nothing to do. | ||
| # YELLOW (exit 0 + "::warning:: Socket scan completed with Tier 2 fallbacks"): | ||
| # scan completed, but Tier 1 could NOT be computed for some/all | ||
| # vulnerabilities, which fell back to Tier 2 (precomputed) reachability. | ||
| # You still get CVE detection + Tier 2 results, just reduced precision | ||
| # for the affected CVEs. The job is NOT failing. | ||
| # RED (non-zero exit): scan did not complete. Do not assume any part | ||
| # succeeded — could be reachability hard-failing, a missing language | ||
| # toolchain, the runner out of memory, a network/API error, or even the | ||
| # underlying CVE/SBOM detection failing. Check the logs and fix before | ||
| # relying on results. | ||
| # ============================================================================ | ||
|
|
||
| name: Socket reachability scan | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: '36 1 * * 0' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| env: | ||
| # Force JS-based GitHub actions (actions/checkout, actions/setup-*, etc.) to | ||
| # use Node 24 instead of the soon-to-be-deprecated Node 20. Safe to remove | ||
| # after 2026-06-16 (when Node 24 becomes the default and this becomes a no-op). | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | ||
|
|
||
| jobs: | ||
| socket-scan: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 | ||
| - uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9 # v1 | ||
| with: | ||
| toolchain: "1.86.0" | ||
| - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | ||
| with: | ||
| node-version: "24.18.0" | ||
| - name: Enable Corepack (yarn/pnpm per repo packageManager) | ||
|
kanwalpreetd marked this conversation as resolved.
Outdated
|
||
| run: corepack enable | ||
|
|
||
| - name: Install Socket CLI | ||
| run: npm install -g socket | ||
|
Comment on lines
+46
to
+47
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Left as unpinned to include latest features/support in the CLI without needing to bump it periodically, I think pinning will add too much overhead for maintenance, probably not worth it for this kind of generic tool. (the socket API token used by the job has limited permissions to only trigger a new scan in Socket backend, so the risk of a new malicious CLI release is contained) |
||
|
|
||
| - name: Run Socket reachability scan | ||
| env: | ||
| SOCKET_SECURITY_API_TOKEN: ${{ secrets.SOCKET_SECURITY_API_TOKEN }} | ||
| run: | | ||
| # Stream the scan output through tee so the run log captures it AND | ||
| # we can grep it for Tier-2-fallback markers; capture the scan's | ||
| # exit code via ${PIPESTATUS[0]} (tee always exits 0). If the scan | ||
| # succeeded but logged a Tier 2 fallback, emit a ::warning:: | ||
| # annotation that GitHub Actions renders as a yellow run-level | ||
| # warning without failing the job. | ||
| set +e | ||
| socket scan create --reach \ | ||
|
kanwalpreetd marked this conversation as resolved.
|
||
| --org=stellar \ | ||
| --no-interactive \ | ||
| --reach-continue-on-no-source-files \ | ||
| --reach-continue-on-analysis-errors \ | ||
| --reach-continue-on-install-errors \ | ||
| --reach-continue-on-missing-lock-files \ | ||
| . 2>&1 | tee /tmp/scan.log | ||
| rc=${PIPESTATUS[0]} | ||
| if [ $rc -eq 0 ] && grep -qE "Reachability falls back to Tier 2|fallback to the results from the pre-computed|Reachability falls back to precomputed" /tmp/scan.log; then | ||
| echo "::warning::Socket scan completed with Tier 2 fallbacks - some vulnerabilities used precomputed reachability instead of full Tier 1" | ||
| fi | ||
| exit $rc | ||
Uh oh!
There was an error while loading. Please reload this page.