-
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
Open
kanwalpreetd
wants to merge
4
commits into
stellar:main
Choose a base branch
from
kanwalpreetd:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+72
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
57e8b93
add socket tier 1 reachability analysis
kanwalpreetd 81cfc8f
Merge branch 'main' into main
kanwalpreetd 4ca3b58
socket-scan: address review comments
kanwalpreetd 1bee36c
socket-scan: drop the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 env var
kanwalpreetd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # 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 | ||
|
|
||
| jobs: | ||
| socket-scan: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 | ||
| - run: rustup update | ||
| - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | ||
| with: | ||
| node-version: "24.18.0" | ||
|
|
||
| - name: Install Socket CLI | ||
| run: npm install -g socket | ||
|
|
||
| - 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 | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The 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)