nx1x/Egret Security Action

eBPF runtime guard for CI jobs: monitor and enforce egress, process, and file behaviour, with SARIF to Code Scanning.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
commandCommand to run under Egret (monitored, and enforced in block mode). If empty, Egret is only installed so you can call `egret run` yourself.no""
policyPath to a policy.yaml. If omitted, safe defaults (audit mode) are used.no""
modeOverride policy mode: audit | block.noaudit
versionEgret release tag to download (e.g. v0.1.0). 'latest' resolves the newest release.nolatest
sarifProduce a SARIF report of policy violations from the run.notrue
upload-sarifUpload the SARIF to GitHub Code Scanning (requires `security-events: write` permission).notrue
fail-on-violationsFail the job if Egret records any policy violation, even in audit mode.nofalse
output-dirDirectory for report.json / report.md / report.sarif (default: $RUNNER_TEMP/egret/report).no""
allow-build-from-sourceIf no verified release is available, build Egret from source (UNPINNED, unverified). Off by default.nofalse
allow-pull-request-targetPermit running under pull_request_target (Egret runs your command as ROOT - only enable if you do NOT check out the PR head).nofalse
disable-sudoBlock mode only: revoke the build user's passwordless sudo for the run (defence-in-depth on top of no_new_privs). Refused in audit mode (the command runs as root there).nofalse
ingest-urlOptional self-hosted Egret Nest dashboard ingest URL (e.g. https://nest.example.com/ingest). When set, the run's report is POSTed there. Leave empty to keep everything local (no phone-home).no""
ingest-tokenBearer token for the ingest endpoint. Pass a GitHub Actions secret (never a literal) - it is sent as a request header, never placed on a command line. Ignored unless ingest-url is set.no""
github-tokenToken for the App-only publish features below (check-run, PR comment, dashboard issue). Pass a GitHub App installation token (via actions/create-github-app-token) for org-wide policy + branded 'egret[bot]' identity, or the built-in GITHUB_TOKEN for the default scope. Sent only as an Authorization header, never on a command line. Empty = no GitHub publishing.no""
check-runPublish a branded pass/fail check run summarizing the report. Requires github-token with checks: write.nofalse
pr-commentPost/update a sticky comment with the report on the pull request (pull_request events only). Requires github-token with pull-requests: write.nofalse
dashboard-issueCreate/update the Egret Security Dashboard issue with the latest report. Requires github-token with issues: write.nofalse
namedescription
report-dirDirectory containing report.json / report.md / report.sarif.
sarif-filePath to the generated SARIF file (empty when sarif is disabled or no command ran).
violationsNumber of policy violations Egret recorded.