Skip to content

Commit a0d6cb3

Browse files
committed
Update README.md
1 parent 2106324 commit a0d6cb3

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
[![harden-runner](images/banner.png)](#)
1+
<picture>
2+
<source media="(prefers-color-scheme: light)" srcset="images/banner.png" width="400">
3+
<img src="images/banner.png" width="400">
4+
</picture>
5+
26
[![Maintained by stepsecurity.io](https://img.shields.io/badge/maintained%20by-stepsecurity.io-blueviolet)](https://stepsecurity.io/?utm_source=github&utm_medium=organic_oss&utm_campaign=harden-runner)
3-
[![License: Apache 2](https://img.shields.io/badge/License-Apache%202-blue.svg)](https://raw.githubusercontent.com/step-security/harden-runner/main/LICENSE)
7+
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/step-security/harden-runner/main/LICENSE)
48

59
---
610

@@ -18,19 +22,19 @@ Harden-Runner GitHub Action installs a security agent on the GitHub-hosted runne
1822

1923
Compromised dependencies and build tools typically make outbound calls to exfiltrate data or credentials, or may modify source code, dependencies, or artifacts during the build.
2024

21-
Harden-Runner GitHub Actions installs a daemon that monitors process, file, and network activity.
25+
Harden-Runner GitHub Actions installs a daemon that monitors process, file, and network activity.
2226

2327
1. Blocks outbound calls that are not in the allowed list to prevent exfiltration of credentials (to prevent [Codecov breach](https://github.com/step-security/supply-chain-goat/blob/main/RestrictOutboundTraffic.md) scenario)
2428

2529
2. Detects if source code is being overwritten during the build process to inject a backdoor (to detect [SolarWinds incident scenario](https://github.com/step-security/supply-chain-goat/blob/main/MonitorSourceCode.md))
2630

2731
3. Detects compromised dependencies that make unexpected outbound network calls (to detect [Dependency confusion](https://github.com/step-security/supply-chain-goat/blob/main/DNSExfiltration.md) and [Malicious dependencies](https://github.com/step-security/supply-chain-goat/blob/main/CompromisedDependency.md))
2832

29-
Read this [case study](https://infosecwriteups.com/detecting-malware-packages-in-github-actions-7b93a9985635) on how Harden-Runner detected malicious packages in the NPM registry.
33+
Read this [case study](https://infosecwriteups.com/detecting-malware-packages-in-github-actions-7b93a9985635) on how Harden-Runner detected malicious packages in the NPM registry.
3034

3135
## How
3236

33-
1. Add `step-security/harden-runner` to your GitHub Actions workflow file as the first step in each job.
37+
1. Add `step-security/harden-runner` to your GitHub Actions workflow file as the first step in each job.
3438

3539
```yaml
3640
steps:
@@ -45,7 +49,7 @@ Read this [case study](https://infosecwriteups.com/detecting-malware-packages-in
4549
<img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/ActionLog.png" alt="Link in build log" >
4650
</p>
4751
48-
3. Click on the link ([example link](https://app.stepsecurity.io/github/ossf/scorecard/actions/runs/2265028928)). You will see a process monitor view of what activities happened as part of each step.
52+
3. Click on the link ([example link](https://app.stepsecurity.io/github/ossf/scorecard/actions/runs/2265028928)). You will see a process monitor view of what activities happened as part of each step.
4953
5054
<p align="left">
5155
<img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/OutboundCalls2.png" alt="Insights from harden-runner" >
@@ -67,14 +71,12 @@ Read this [case study](https://infosecwriteups.com/detecting-malware-packages-in
6771

6872
Install the [Harden Runner App](https://github.com/marketplace/harden-runner-app) to use Harden-Runner GitHub Action for `Private` repositories.
6973

70-
- If you use Harden-Runner GitHub Action in a private repository, the generated insights URL is NOT public.
74+
- If you use Harden-Runner GitHub Action in a private repository, the generated insights URL is NOT public.
7175
- You need to authenticate first to access insights URL for private repository. Only those who have access to the repository can view it.
72-
- [Harden Runner App](https://github.com/marketplace/harden-runner-app) only needs `actions: read` permissions on your repositories.
76+
- [Harden Runner App](https://github.com/marketplace/harden-runner-app) only needs `actions: read` permissions on your repositories.
7377

7478
Read this [case study on how Kapiche uses Harden Runner](https://www.stepsecurity.io/case-studies/kapiche/) to improve software supply chain security in their open source and private repositories.
7579

76-
77-
7880
## Discussions
7981

8082
If you have questions or ideas, please use [discussions](https://github.com/step-security/harden-runner/discussions).
@@ -110,10 +112,11 @@ Some important workflows using harden-runner:
110112

111113
## How does it work?
112114

113-
Harden-Runner GitHub Action downloads and installs the StepSecurity Agent.
114-
- The code to monitor file, process, and network activity is in the Agent.
115+
Harden-Runner GitHub Action downloads and installs the StepSecurity Agent.
116+
117+
- The code to monitor file, process, and network activity is in the Agent.
115118
- The agent is written in Go and is open source at https://github.com/step-security/agent
116-
- The agent's build is reproducible. You can view the steps to reproduce the build [here](http://app.stepsecurity.io/github/step-security/agent/releases/latest).
119+
- The agent's build is reproducible. You can view the steps to reproduce the build [here](http://app.stepsecurity.io/github/step-security/agent/releases/latest).
117120

118121
## 1-minute Demo Video
119122

0 commit comments

Comments
 (0)