mirror of
https://github.com/step-security/harden-runner.git
synced 2026-06-07 07:47:06 +00:00
67 lines
4.8 KiB
Markdown
67 lines
4.8 KiB
Markdown
<p align="left">
|
|
<img src="https://step-security-images.s3.us-west-2.amazonaws.com/Final-Logo-06.png" alt="Step Security Logo" width="340">
|
|
</p>
|
|
|
|
# Security monitoring for the GitHub-hosted runner
|
|
|
|
If you have a self-hosted build server (e.g. Cloud VM), you may have security monitoring implemented on it. When you use GitHub Actions hosted-runner, you can use `harden-runner` to add security controls and monitoring to the build server (Ubuntu VM) on which GitHub Actions runs your workflows. Unlike traditional monitoring for Cloud VMs, `harden-runner` insights and policy are granular per job of a workflow.
|
|
|
|
## 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 `step-security/harden-runner` to your GitHub Actions workflow file as the first step. Use [StepSecurity's online tool](http://app.stepsecurity.io/) to quickly add this and fix additional security issues.
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: step-security/harden-runner@14dc64f30986eaa2ad2dddcec073f5aab18e5a24 # v1
|
|
with:
|
|
egress-policy: audit
|
|
```
|
|
|
|
2. In the workflow logs, you will see a link to security insights and recommendations.
|
|
|
|
<p align="left">
|
|
<img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/ActionLog.png" alt="Link in build log" >
|
|
</p>
|
|
|
|
3. Click on the link ([example link](https://app.stepsecurity.io/github/jauderho/dockerfiles/actions/runs/1736506434)). You will see outbound traffic made by each step.
|
|
|
|
<p align="left">
|
|
<img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/OutboundCall.png" alt="Insights from harden-runner" >
|
|
</p>
|
|
|
|
4. Below the insights, you will see the recommended policy. Add the recommended outbound endpoints to your workflow file, and only traffic to these endpoints will be allowed.
|
|
|
|
<p align="left">
|
|
<img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/RecomPolicy.png" alt="Policy recommended by harden-runner" >
|
|
</p>
|
|
|
|
## Try it out
|
|
|
|
[Hands-on tutorials](https://github.com/step-security/supply-chain-goat) to learn how `harden-runner` would have prevented past software supply chain attacks, such as the Codecov breach.
|
|
|
|
## Support for private repositories
|
|
Support for private repositories is now in `Preview`. Install the [Harden Runner App](https://github.com/apps/harden-runner-app) if you want to use `harden-runner` for `Private` repositories or if you want the insights to show up instantly after the workflow run completes for `Public` repositories. This App only needs `actions: read` permissions on your repositories. You can install it on selected repositories, or all repositories in your organization.
|
|
|
|
## Discussions
|
|
|
|
If you have questions or ideas, please use [discussions](https://github.com/step-security/harden-runner/discussions).
|
|
1. [Support for private repositories](https://github.com/step-security/harden-runner/discussions/74)
|
|
2. [Generation of accurate SBOM (software bill of materials)](https://github.com/step-security/harden-runner/discussions/75)
|
|
3. [SLSA Level 1](https://github.com/step-security/harden-runner/discussions/93)
|
|
4. [Cryptographically verify tools run as part of the CI/ CD pipeline](https://github.com/step-security/harden-runner/discussions/94)
|
|
|
|
## FAQ
|
|
|
|
### Why do I see calls to `api.snapcraft.io`?
|
|
|
|
During workflow runs, it was observed that unnecessary outbound calls were being made to some domains. All of the outbound calls were due to unnecessary services running on the GitHub Actions hosted-runner VM. These services have been stopped, except for `snapd`, which makes calls to `api.snapcraft.io`. You can read more about this issue [here](https://github.com/actions/virtual-environments/issues/4867). `api.snapcraft.io` is not needed for your workflow, and does not need to be added to the `allowed-endpoints` list.
|
|
|
|
## Workflows using harden-runner
|
|
|
|
Workflows using harden-runner:
|
|
1. https://github.com/nvm-sh/nvm/tree/master/.github/workflows ([link to insights](https://app.stepsecurity.io/github/nvm-sh/nvm/actions/runs/1757959262))
|
|
2. https://github.com/microsoft/msquic/tree/main/.github/workflows ([link to insights](https://app.stepsecurity.io/github/microsoft/msquic/actions/runs/1759010243))
|
|
3. https://github.com/Automattic/vip-go-mu-plugins/blob/master/.github/workflows/e2e.yml ([link to insights](https://app.stepsecurity.io/github/Automattic/vip-go-mu-plugins/actions/runs/1758760957))
|
|
4. https://github.com/MTRNord/matrix-art/tree/main/.github/workflows ([link to insights](https://app.stepsecurity.io/github/MTRNord/matrix-art/actions/runs/1758933417))
|
|
5. https://github.com/jauderho/dockerfiles/blob/main/.github/workflows/age.yml ([link to insights](https://app.stepsecurity.io/github/jauderho/dockerfiles/actions/runs/1758047950))
|