Skip to content

Commit 7274587

Browse files
Merge pull request #110 from arjundashrath/main
Updated Readme
2 parents 9a99570 + c96be66 commit 7274587

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
# Security agent for Github-hosted runner
1+
# Harden-Runner: Security agent for GitHub-hosted runner
22

3-
Harden-Runner GitHub Action installs a security agent on the Github-hosted runner to prevent exfiltration of credentials, monitor the build process, and detect compromised dependencies.
3+
Harden-Runner GitHub Action installs a security agent on the GitHub-hosted runner to prevent exfiltration of credentials, monitor the build process, and detect compromised dependencies.
4+
<p align="left">
5+
<img src="https://github.com/arjundashrath/supply-chain-goat/blob/patch-2/images/harden-runner/HardenRunnerGIFV.gif" alt="Link in build log" width="1440" >
6+
</p>
47

5-
## Problem
8+
## Why use Harden-Runner?
69
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 during the build process.
710

8-
## Solution
11+
Harden-Runner is a first-of-its-kind technology that automatically correlates outbound traffic, file modifications, and process activity with each step of a workflow. You can also set a policy per job of a workflow to restrict outbound traffic.
12+
13+
## Using Harden-Runner
914
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.
1015

1116
```yaml
@@ -35,7 +40,7 @@ Hijacked dependencies and compromised build tools typically make outbound reques
3540
3641
When you use `egress-policy: block` mode, you can also set `disable-telemetry: true` to not send telemetry to the StepSecurity API.
3742

38-
## How past attacks would have been prevented
43+
## How Harden-Runner mitigates threats?
3944

4045
[Hands-on tutorials](https://github.com/step-security/supply-chain-goat) to learn how `harden-runner` would have prevented past software supply chain attacks.
4146

0 commit comments

Comments
 (0)