Pull-mirror of github.com/step-security/harden-runner
Find a file
2022-03-18 14:59:57 -07:00
.github Update canary.yml 2022-02-13 07:03:52 -08:00
dist Update agent and deps 2022-03-18 14:18:07 -07:00
src Update agent and deps 2022-03-18 14:18:07 -07:00
.gitignore added code for checksum verification 2022-01-18 15:34:13 +05:30
action.yml Update description 2022-02-13 08:30:23 -08:00
LICENSE Initial commit 2021-10-28 09:58:47 -07:00
package-lock.json Update agent and deps 2022-03-18 14:18:07 -07:00
package.json Update agent and deps 2022-03-18 14:18:07 -07:00
README.md Update README.md 2022-03-18 14:46:34 -07:00
SECURITY.md Create SECURITY.md 2021-11-19 13:19:40 -08:00
tsconfig.json Add code for GH action 2021-10-28 10:16:48 -07:00

Security agent for GitHub-hosted runner

Harden-Runner GitHub Action installs a security agent on the GitHub-hosted runner (Ubuntu VM) to

  1. Monitor the build process,
  2. Prevent exfiltration of credentials, and
  3. Detect compromised dependencies or build tools

Demo using GIF

Why

Hijacked dependencies and compromised build tools typically make outbound requests during the build process to exfiltrate data or credentials. There is also a risk that a compromised dependency or build tool may modify source code, dependencies, or artifacts.

Harden-Runner automatically correlates outbound traffic, file modifications, and process activity with each step of a workflow. You can also set a policy to restrict outbound traffic.

Check out the hands-on tutorials to learn how harden-runner would have prevented past software supply chain attacks.

How

  1. Add step-security/harden-runner to your GitHub Actions workflow file as the first step in each job. In the pre step, the GitHub Actions installs a daemon that monitors process, file, and network activity.

    steps:
      - uses: step-security/harden-runner@bdb12b622a910dfdc99a31fdfe6f45a16bc287a4 # v1
        with:
          egress-policy: audit
    
  2. In the workflow logs, you will see a link to security insights and recommendations.

Link in build log

  1. Click on the link (example link). You will see a process monitor view of what activities happened as part of each step. This currently includes the programs that made outbound calls and did file writes to source code or dependencies.

Insights from harden-runner

  1. 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.

Policy recommended by harden-runner

When you use egress-policy: block mode, you can also set disable-telemetry: true to not send telemetry to the StepSecurity API.

Support for private repositories

Install the Harden Runner App if you want to use harden-runner for Private 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.

  1. Support for private repositories
  2. Generation of accurate SBOM (software bill of materials)
  3. SLSA Level 1
  4. Cryptographically verify tools run as part of the CI/ CD pipeline
  5. Automatic signing

Testimonials

I think this is a great idea and for the threat model of build-time, an immediate network egress request monitoring makes a lot of sense - Liran Tal, GitHub Star, and Author of Essential Node.js Security

Harden-Runner strikes an elegant balance between ease-of-use, maintainability, and mitigation that I intend to apply to all of my 300+ npm packages. I look forward to the tools improvement over time - Jordan Harband, Open Source Maintainer

Harden runner from Step security is such a nice solution, it is another piece of the puzzle in helping treat the CI environment like production and solving supply chain security. I look forward to seeing it evolve. - Cam Parry, Senior Site Reliability Engineer, Kapiche

Workflows using harden-runner

Some important workflows using harden-runner:

Repository Link to insights
1. nvm-sh/nvm Link to insights
2. yannickcr/eslint-plugin-react Link to insights
3. microsoft/msquic Link to insights
4. ossf/scorecard Link to insights
5. Automattic/vip-go-mu-plugins Link to insights

1-minute Demo Video

https://user-images.githubusercontent.com/25015917/156026587-79356450-9b35-4254-9c2e-7f2cc8d81059.mp4