diff --git a/README.md b/README.md index 2066fbe..3fb621e 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,22 @@ Step Security Logo

-# Policy-based Runtime Security for GitHub Actions +# Runtime Security for GitHub Actions +Harden the Ubuntu VM on which GitHub Actions runs your workflows. + +## Prevent DNS exfiltration and exfiltration of credentials First-of-its-kind patent-pending technology that automatically correlates outbound traffic with each step of a workflow. -1. Add this code to your GitHub Actions workflow file as the first step. +1. Add `step-security/harden-runner@v1` to your GitHub Actions workflow file as the first step. -``` -steps: - - uses: step-security/harden-runner@v1 - with: - egress-policy: audit - - uses: actions/checkout@v2 -``` + ``` + steps: + - uses: step-security/harden-runner@v1 + with: + egress-policy: audit + - uses: actions/checkout@v2 + ``` 2. In the workflow logs, you will see a link to security insights and recommendations. @@ -22,19 +25,19 @@ steps: Link in build log

-3. Click on the link ([example link](https://app.stepsecurity.io/github/nvm-sh/nvm/actions/runs/1547131792)). +3. Click on the link ([example link](https://app.stepsecurity.io/github/nvm-sh/nvm/actions/runs/1547131792)). You will see outbound traffic made by each step.

- Step Security Logo + Insights from harden-runner

- Step Security Logo + Policy recommended by harden-runner

4. Add the recommended outbound endpoints to your workflow file, and only traffic to these endpoints will be allowed. -``` -steps: + ``` + steps: - uses: step-security/harden-runner@v1 with: allowed-endpoints: @@ -42,4 +45,13 @@ steps: nodejs.org:443 registry.npmjs.org:443 - uses: actions/checkout@v2 -``` \ No newline at end of file + ``` + +## Workflows using harden-runner + +1. https://github.com/nvm-sh/nvm/tree/master/.github/workflows +2. https://github.com/shivammathur/setup-php/blob/master/.github/workflows/node-release.yml + +## Try it out + +[Hands-on tutorials](https://github.com/step-security/supply-chain-goat) to learn how `harden-runner` prevents software supply chain attacks.