diff --git a/README.md b/README.md index e7c5243..c1c2e93 100644 --- a/README.md +++ b/README.md @@ -13,360 +13,150 @@ -## Table of Contents - -- [Introduction](#introduction) -- [4,000+ open source projects use Harden-Runner](#4000-open-source-projects-use-harden-runner) - - [Trusted By](#trusted-by) - - [Case Studies](#case-studies) -- [Why use Harden-Runner](#why-use-harden-runner) -- [Getting Started](#getting-started) - - [Hardening GitHub-Hosted Runners](#hardening-github-hosted-runners) - - [Hands-On Tutorials](#hands-on-tutorials) - - [Support for Private Repositories](#support-for-private-repositories) - - [Hardening Self-Hosted Runners](#hardening-self-hosted-runners) - - [Self-Hosted Actions Runner Controller (ARC) Runners](#self-hosted-actions-runner-controller-arc-runners) - - [Self-Hosted VM Runners (e.g. on EC2)](#self-hosted-vm-runners-eg-on-ec2) -- [Features at a glance](#features-at-a-glance) - - [View outbound network traffic at the job level](#view-outbound-network-traffic-at-the-job-level) - - [View outbound network traffic at the organization level](#view-outbound-network-traffic-at-the-organization-level) - - [View outbound HTTPS traffic at the job level](#view-outbound-https-traffic-at-the-job-level) - - [Detect anomalous outbound network traffic](#detect-anomalous-outbound-network-traffic) - - [Filter outbound network traffic to allowed endpoints](#filter-outbound-network-traffic-to-allowed-endpoints) - - [Determine minimum GITHUB_TOKEN permissions using Harden-Runner](#determine-minimum-github_token-permissions-using-harden-runner) - - [View the name and path of every file written during the build process](#view-the-name-and-path-of-every-file-written-during-the-build-process) - - [View process names and arguments](#view-process-names-and-arguments) - - [Detect tampering of source code during build](#detect-tampering-of-source-code-during-build) - - [Run your job without sudo access](#run-your-job-without-sudo-access) - - [Get real-time security alerts](#get-real-time-security-alerts) -- [Discussions](#discussions) -- [How does it work?](#how-does-it-work) - - [GitHub-Hosted Runners](#github-hosted-runners-1) - - [Self-Hosted Actions Runner Controller (ARC) Runners](#self-hosted-actions-runner-controller-arc-runners-1) - - [Self-Hosted VM Runners (e.g. on EC2)](#self-hosted-vm-runners-eg-on-ec2-1) -- [Limitations](#limitations) - - [GitHub-Hosted Runners](#github-hosted-runners-2) - - [Self-Hosted Actions Runner Controller (ARC) Runners](#self-hosted-actions-runner-controller-arc-runners-2) - - [Self-Hosted VM Runners (e.g. on EC2)](#self-hosted-vm-runners-eg-on-ec2-2) +# Harden-Runner +Harden-Runner secures CI/CD workflows by controlling network access and monitoring activities on GitHub-hosted and self-hosted runners. It blocks unauthorized network traffic and detects unusual activity to protect against potential threats. The name "Harden-Runner" comes from its purpose: strengthening the security of the runners used in GitHub Actions workflows. -## Introduction - -Harden-Runner provides network egress filtering and runtime security for GitHub-hosted and self-hosted runners. It is called Harden-Runner because it `hardens` the `runner` on which GitHub Actions workflows run. - -Learn how Harden-Runner works through the video below, which shows how it detected a supply chain attack on a Google open-source project. - -Harden-Runner detected supply chain attack in a Google open-source project - -## 4,000+ open source projects use Harden-Runner - -Harden-Runner is trusted by leading open source projects and enterprises to secure their CI/CD pipelines. - -### Trusted by - - -| [![CISA](https://avatars.githubusercontent.com/u/18539691?s=60&v=4)](https://app.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/9947319332?jobid=27479776091&tab=network-events) | [![Microsoft](https://avatars.githubusercontent.com/u/6154722?s=60&v=4)](https://app.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/7587031851) | [![Google](https://avatars.githubusercontent.com/u/2810941?s=60&v=4)](https://app.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/7576989995) | [![DataDog](https://avatars.githubusercontent.com/u/365230?s=60&v=4)](https://app.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/7446169664) | [![Intel](https://avatars.githubusercontent.com/u/17888862?s=60&v=4)](https://app.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/7590975903) | [![Kubernetes](https://avatars.githubusercontent.com/u/36015203?s=60&v=4)](https://app.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/7591172950) | [![Node.js](https://avatars.githubusercontent.com/u/9950313?s=60&v=4)](https://app.stepsecurity.io/github/nodejs/node/actions/runs/7591405720) | [![AWS](https://avatars.githubusercontent.com/u/2232217?s=60&v=4)](https://app.stepsecurity.io/github/aws/aperf/actions/runs/7631366761) | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| **CISA**
[Explore](https://app.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/9947319332?jobid=27479776091&tab=network-events) | **Microsoft**
[Explore](https://app.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/7587031851) | **Google**
[Explore](https://app.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/7576989995) | **DataDog**
[Explore](https://app.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/7446169664) | **Intel**
[Explore](https://app.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/7590975903) | **Kubernetes**
[Explore](https://app.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/7591172950) | **Node.js**
[Explore](https://app.stepsecurity.io/github/nodejs/node/actions/runs/7591405720) | **AWS**
[Explore](https://app.stepsecurity.io/github/aws/aperf/actions/runs/7631366761) | - -### Case Studies - -- [Harden-Runner Detects CI/CD Supply Chain Attack in Google’s Open-Source Project Flank](https://www.stepsecurity.io/case-studies/flank) -- [Kapiche secures their GitHub Actions software supply chain with Harden-Runner](https://www.stepsecurity.io/case-studies/kapiche) -- [Arcjet Enhances CI/CD Security with Harden-Runner](https://www.stepsecurity.io/case-studies/arcjet) +## Quick Links +- [Getting Started Guide](#getting-started) +- [Why Choose Harden-Runner](#why-choose-harden-runner) +- [Features and Capabilities](#features) +- [Case Studies and Trusted Projects](#trusted-by-and-case-studies) +- [How It Works](docs/how-it-works.md) +- [Known Limitations](docs/limitations.md) +- [Join the Discussions](#discussions) +--- -## Why use Harden-Runner - -There are two main threats from compromised workflows, dependencies, and build tools in a CI/CD environment: - -1. Exfiltration of CI/CD credentials and source code -2. Tampering of source code, dependencies, or artifacts during the build to inject a backdoor +## Introduction -Harden-Runner monitors process, file, and network activity to: +Learn how Harden-Runner works through the video below, which shows how it detected a supply chain attack on a **Google** open-source project. -| | Countermeasure | Prevent Security Breach | -| --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1. | Monitor and block outbound network traffic at the DNS, HTTPS (Layer 7), and network layers (Layers 3 and 4) to prevent exfiltration of code and CI/CD credentials | To prevent the [Codecov breach](https://github.com/step-security/github-actions-goat/blob/main/docs/Vulnerabilities/ExfiltratingCICDSecrets.md) scenario | -| 2. | Detect if source code is being tampered during the build process to inject a backdoor | To detect the [XZ Utils](https://www.stepsecurity.io/blog/analysis-of-backdoored-xz-utils-build-process-with-harden-runner) and [SolarWinds incident](https://github.com/step-security/github-actions-goat/blob/main/docs/Vulnerabilities/TamperingDuringBuild.md) scenarios | -| 3. | Detect poisoned workflows and compromised dependencies that exhibit suspicious behavior | To detect [Dependency confusion](https://github.com/step-security/github-actions-goat/blob/main/docs/Vulnerabilities/ExfiltratingCICDSecrets.md#dependency-confusion-attacks) and [Malicious dependencies](https://github.com/step-security/github-actions-goat/blob/main/docs/Vulnerabilities/ExfiltratingCICDSecrets.md#compromised-dependencies) scenarios | -| 4. | Determine minimum GITHUB_TOKEN permissions by monitoring HTTPS calls to GitHub APIs | To set [minimum GITHUB_TOKEN permissions](https://www.stepsecurity.io/blog/determine-minimum-github-token-permissions-using-ebpf-with-stepsecurity-harden-runner) to reduce the impact of exfiltration | + + Harden-Runner detected supply chain attack in a Google open-source project + +--- ## Getting Started -### Hardening GitHub-Hosted Runners +This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows. -1. Add the `step-security/harden-runner` GitHub Action to your GitHub Actions workflow file as the first step in each job. You can automate adding Harden-Runner Action to your workflow file by pasting your workflow in the [StepSecurity online tool](https://app.stepsecurity.io/secureworkflow). +### **Step 1: Add Harden-Runner to Your Workflow** +To integrate Harden-Runner, follow these steps: + +- Open your GitHub Actions workflow file (e.g., `.github/workflows/.yml`). +- Add the following code as the first step in each job: ```yaml steps: - - uses: step-security/harden-runner@446798f8213ac2e75931c1b0769676d927801858 # v2.10.0 + - uses: step-security/harden-runner@446798f8213ac2e75931c1b0769676d927801858 # v2.10.3 with: egress-policy: audit - ``` - -2. In the workflow logs and the job markdown summary, you will see a link to security insights and recommendations. -

- Link in build log -

+**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secureworkflow) +
+Click to view the full Getting Started Guide -3. Click on the link ([example link](https://app.stepsecurity.io/github/step-security/github-actions-goat/actions/runs/7704454287)). You will see a process monitor view of network and file events correlated with each step of the job. +### **Step 2: Access Security Insights** -

- Insights from harden-runner +Run your workflow. Once completed: +- Review the **workflow logs** and the **job markdown summary**. +- Look for a link to **security insights and recommendations**. +

+ Link in workflow log

- -4. In the `Recommended Policy` tab, you'll find a recommended block policy based on outbound calls aggregated from the current and past runs of the job. You can update your workflow file with this policy, or alternatively, use the [Policy Store](https://docs.stepsecurity.io/harden-runner/how-tos/block-egress-traffic#2-add-the-policy-using-the-policy-store) to apply the policy without modifying the workflow file. From now on, any outbound calls not in the allowed list will be blocked. - -

- Policy recommended by harden-runner +- Click on the provided link (e.g., [example link](https://appv2.stepsecurity.io/github/step-security/github-actions-goat/actions/runs/7704454287?jobid=20996777560&tab=network-events)) to access the **Process Monitor View**, which displays: + - **Network events**: Outbound network calls correlated with each step. + - **File events**: File writes tracked during the job. +

+ Link in network events

-#### Hands-On Tutorials +
-You can use [GitHub Actions Goat](https://github.com/step-security/github-actions-goat) to try Harden-Runner. You only need a GitHub Account and a web browser. +--- +## Why Choose Harden-Runner? -Hands-on Tutorials for GitHub Actions Runtime Security: +- **Prevent Exfiltration:** Prevent the exfiltration of CI/CD secrets and source code. +- **Detect Tampering:** Identify source code modifications during builds. +- **Anomaly Detection:** Spot unusual dependencies and workflow behaviors. +- **Simplify Permissions:** Determine the minimum required `GITHUB_TOKEN` permissions. -1. [Filter Egress Network Traffic](https://github.com/step-security/github-actions-goat/blob/main/docs/Solutions/RestrictOutboundTraffic.md) -2. [Detect File Tampering](https://github.com/step-security/github-actions-goat/blob/main/docs/Solutions/MonitorSourceCode.md) -### Support for Private Repositories +--- -Hardening of runners used in private repositories is supported with a commercial license. Check out the [documentation](https://docs.stepsecurity.io/stepsecurity-platform/billing) for more details. +## Features -- To use Harden-Runner in a `Private` repository, you must install the [StepSecurity GitHub App](https://github.com/apps/stepsecurity-actions-security). -- This is needed to access the GitHub Actions API and to authenticate users to access the dashboard for private repositories. -- If you use Harden-Runner GitHub Action in a private repository, the generated insights URL is NOT public. Only those who have access to the repository can view it. +Harden-Runner offers a comprehensive suite of features to enhance the security of your CI/CD workflows, available in two tiers: **Community** (Free) and **Enterprise** (Paid). -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 private repositories. +### Community (Free) -### Hardening Self-Hosted Runners +- **Block Network Egress Traffic with Domain Allowlist:** Control outbound network traffic by specifying allowed domains, preventing unauthorized data exfiltration. +- **Detect Compromised Packages, Dependencies & Build Tools:** Identify and mitigate risks from malicious or vulnerable components in your build process. +- **Detect Modification of Source Code:** Monitor and alert on unauthorized changes to your source code during the CI/CD pipeline. +- **Disable Sudo Access:** Restrict the use of superuser privileges in your workflows to minimize security risks. +- **Insights Page for CI/CD Runs:** Access detailed reports and analytics for each CI/CD run to monitor security events and compliance. -Hardening of self-hosted runners is supported with a commercial license. Check out the [documentation](https://docs.stepsecurity.io/stepsecurity-platform/billing) for more details. For hardening of self-hosted runners you must install the [StepSecurity GitHub App](https://github.com/apps/stepsecurity-actions-security). +### Enterprise (Paid) -#### Self-Hosted Actions Runner Controller (ARC) Runners +Includes all features in the **Community** tier, plus: -> Explore demo workflows using self-hosted ARC Runner and ARC Harden-Runner [here](https://docs.stepsecurity.io/harden-runner/how-tos/enable-runtime-security-arc). - -Actions Runner Controller (ARC) is a Kubernetes operator that orchestrates self-hosted runners for GitHub Actions. - -- Instead of adding the Harden-Runner GitHub Action in each job, you'll need to install the ARC Harden-Runner daemonset on your Kubernetes cluster. -- Upon installation, the ARC Harden-Runner daemonset monitors all jobs run on the cluster; you do NOT need to add the Harden-Runner GitHub Action to each job for `audit` mode. You do need to add the Harden-Runner GitHub Action to jobs where you want to enable `block` mode. -- The instructions for installing the ARC-Harden-Runner daemonset are shown in the dashboard. To enable access to these instructions, please email support@stepsecurity.io. - -#### Self-Hosted VM Runners (e.g. on EC2) - -> Explore demo workflows using self-hosted VM Runners and Harden-Runner [here](https://docs.stepsecurity.io/harden-runner/how-tos/enable-runtime-security-vm). - -- Instead of adding the Harden-Runner GitHub Action in each job, you'll need to install the Harden-Runner agent on your runner image (e.g. AMI). This is typically done using packer or as a post-install step when using the https://github.com/philips-labs/terraform-aws-github-runner project to setup runners. -- The Harden-Runner agent monitors all jobs run on the VM, both ephemeral and persistent runners are supported; you do NOT need to add the Harden-Runner GitHub Action to each job for `audit` mode. You do need to add the Harden-Runner GitHub Action to jobs where you want to enable `block` mode. -- The instructions for installing the Harden-Runner agent on your self-hosted VM runners are shown in the dashboard. To enable access to these instructions, please email support@stepsecurity.io. This agent is different than the one used for GitHub-hosted runners. - -## Features at a glance - -For details, check out the documentation at https://docs.stepsecurity.io - -### View outbound network traffic at the job level - -> Applies to both GitHub-hosted and self-hosted runners - -Harden-Runner monitors all outbound traffic from each job at the DNS and network layers - -- After the workflow completes, each outbound call is correlated with each step of the job, and shown in the insights page -- For self-hosted runners, no changes are needed to workflow files to monitor egress traffic -- A filtering (block) egress policy is suggested in the insights page based on the current and past job runs - -

- Insights from harden-runner -

- -### View outbound network traffic at the organization level - -> Applies to both GitHub-hosted and self-hosted runners - -You can view all unique network destinations from all workflow runs in your organization on the `Runtime Security` tab. - -- The `All Observed Endpoints` menu provides a detailed list of all network destinations contacted by your Actions runners. -- For each listed endpoint, the `View Sample Workflow Runs` option enables you to examine individual GitHub Actions workflow runs that interacted with the endpoint. - -For more details refer [Unified Network Egress View: Centralize GitHub Actions Network Destinations for Your Enterprise](https://www.stepsecurity.io/blog/unified-network-egress-view-centralize-github-actions-network-destinations-for-your-enterprise) - -

- View outbound network traffic at the organization level -

- -### View outbound HTTPS traffic at the job level - -> Applies to GitHub-hosted and self-hosted VM runners - -Harden-Runner can monitor outbound HTTPS requests. This feature is supported with a commercial license. - -- HTTPS events are monitored using eBPF (no MITM proxy is used) -- If a HTTP PUT/ POST/ PATCH call is made to GitHub APIs to a HTTP Path with a different organization than where the workflow is running, the call is marked as anomalous -- As of now, only HTTPS calls to `github.com`, `api.github.com`, `*.pkg.github.com`, and `ghcr.io` hosts are monitoried. - -

- View outbound HTTPS traffic at the job level -

+- **Support for Private Repositories:** Extend Harden-Runner's security capabilities to your private GitHub repositories. +- **Support for Self-Hosted Runners:** Apply security controls and monitoring to self-hosted GitHub Actions runners. +- **View Outbound GitHub API calls at the Job Level:** Monitor HTTPS requests to GitHub APIs +- **Determine Minimum GITHUB_TOKEN Permissions:** Monitor outbound HTTPS requests to GitHub APIs to recommend the least-privilege permissions needed for your workflows, enhancing security by reducing unnecessary access. +- **View the Name and Path of Every File Written During the Build Process:** Gain visibility into every file written to the build environment, including the ability to correlate file writes with processes, ensuring complete transparency. +- **View Process Names and Arguments:** Monitor every process executed during the build process, along with its arguments, and navigate the process tree to detect suspicious activities. +- **Github Checks:** Display Harden Runner insights in the GitHub Checks UI, giving quick feedback on unusual network activity in pull requests. -### Detect anomalous outbound network traffic +For a detailed comparison and more information, please visit our [Pricing Page](https://www.stepsecurity.io/pricing). -> Applies to both GitHub-hosted and self-hosted runners +Explore the full feature set in the [Features Documentation](https://docs.stepsecurity.io/harden-runner/how-tos/enable-runtime-security/). -You can detect suspicious/ anomalous traffic using this feature even in `egress-policy:audit` mode. +--- -- Anomaly detection feature creates a machine learning model of outbound network calls by analyzing the historical data of the same workflow in previous runs -- After the baseline is created, any anomalous outbound destinations are marked as anomalous in the insights page, and real-time alerts are triggered -- You can view the list of all anomalous outbound network traffic in the `Runtime detections` page on the dashboard +## Trusted By and Case Studies -For more details, refer to [Anomalous Outbound Call Detection Using Machine Learning](https://www.stepsecurity.io/blog/announcing-anomalous-outbound-call-detection-using-machine-learning) +Harden-Runner is trusted by over 5000 leading open-source projects and enterprises, including Microsoft, Google, Kubernetes, and more. -### Filter outbound network traffic to allowed endpoints - -> Applies to both GitHub-hosted and self-hosted runners - -You can see recommended egress block policy in the `Recommendations` tab for each job. This is based on observed traffic across multiple runs of the job. - -

- Policy recommended by harden-runner -

- -Once you set these allowed endpoints in the workflow file, or in the [Policy Store](https://docs.stepsecurity.io/harden-runner/how-tos/block-egress-traffic#2-add-the-policy-using-the-policy-store) and switch to using `egress-policy:block` - -- Harden-Runner blocks egress traffic at the DNS (Layer 7) and network layers (Layers 3 and 4) -- It blocks DNS exfiltration, where attacker tries to send data out using DNS resolution -- Wildcard domains are supported, e.g. you can add `*.data.mcr.microsoft.com:443` to the allowed list, and egress traffic will be allowed to `eastus.data.mcr.microsoft.com:443` and `westus.data.mcr.microsoft.com:443` - -

- Policy recommended by harden-runner -

- -### Determine minimum GITHUB_TOKEN permissions using Harden-Runner - -> Applies to GitHub-hosted runners - -Harden-Runner monitors outbound HTTPS requests using eBPF and uses the PATHs and VERBs of these HTTPS calls to recommend the minimum GITHUB_TOKEN permissions for each job in your workflow. This feature is supported with a commercial license. - -- GITHUB_TOKEN is an automatically generated secret used to authenticate to GitHub APIs from GitHub Actions workflows. -- Harden-Runner can monitor the VERBs (e.g., `GET`, `POST`) and PATHs (e.g., `/repos/owner/repo/issues`) for calls made to the GitHub APIs from the runner. -- Each GitHub Actions API call requires a corresponding GITHUB_TOKEN permission. For instance, a GET request to the `/repos/org/repo/info/refs?service=git-upload-pack` endpoint requires the `contents: read` permission. -- The recommendation for the minimum GITHUB_TOKEN permissions are show in the `Recommendations` tab. - -For more details, refer to [Determine Minimum GITHUB_TOKEN Permissions Using eBPF with Harden-Runner. -](https://www.stepsecurity.io/blog/determine-minimum-github-token-permissions-using-ebpf-with-stepsecurity-harden-runner) - -

- View recommendation for minimum GITHUB_TOKEN permissions -

- -### View the name and path of every file written during the build process - -> Applies to both GitHub-hosted and self-hosted runners - -View the name and path of every file that was written during the build process. This feature is supported with a commercial license. - -- Harden-Runner tracks every file written to the GitHub Actions working directory during the build process. -- In the insights page in the `File Write Events` tab you can see a file explorer view of each file that was written to. -- Clicking on any file reveals a list of processes that wrote to it, providing complete transparency. - -

- View the name and path of every file written during the build process -

- -### View process names and arguments - -> Applies to both GitHub-hosted and self-hosted runners - -View process names, PIDs, and process arguments. This feature is supported with a commercial license. - -- Harden-Runner tracks every process that is run during the build process. -- Clicking on any process ID (PID) in the network events, file events, or HTTPS events shows the process that caused the event, along with the process arguments. -- You can walk up the process tree by clicking `View Parent Process` to understand the build process and detect suspicious activity. - -

- View process names and arguments -

- -### Detect tampering of source code during build - -> Applies to both GitHub-hosted and self-hosted runners - -Harden-Runner monitors file writes and can detect if a file is overwritten. +### Trusted by -- Source code overwrite is not expected in a release build -- All source code files are monitored, which means even changes to IaC files (Kubernetes manifest, Terraform) are detected -- You can enable notifications to get one-time alert when source code is overwritten -- For self-hosted runners, no changes are needed to workflow files for file monitoring -

- Policy recommended by harden-runner -

+| [![CISA](https://avatars.githubusercontent.com/u/18539691?s=60&v=4)](https://appv2.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/9947319332?jobid=27479776091&tab=network-events) | [![Microsoft](https://avatars.githubusercontent.com/u/6154722?s=60&v=4)](https://appv2.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/7587031851) | [![Google](https://avatars.githubusercontent.com/u/2810941?s=60&v=4)](https://appv2.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/7576989995) | [![DataDog](https://avatars.githubusercontent.com/u/365230?s=60&v=4)](https://appv2.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/7446169664) | [![Intel](https://avatars.githubusercontent.com/u/17888862?s=60&v=4)](https://appv2.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/7590975903) | [![Kubernetes](https://avatars.githubusercontent.com/u/36015203?s=60&v=4)](https://appv2.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/7591172950) | [![Node.js](https://avatars.githubusercontent.com/u/9950313?s=60&v=4)](https://appv2.stepsecurity.io/github/nodejs/node/actions/runs/7591405720) | [![AWS](https://avatars.githubusercontent.com/u/2232217?s=60&v=4)](https://appv2.stepsecurity.io/github/aws/aperf/actions/runs/7631366761) | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| **CISA**
[Explore](https://appv2.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/9947319332?jobid=27479776091&tab=network-events) | **Microsoft**
[Explore](https://appv2.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/7587031851) | **Google**
[Explore](https://appv2.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/7576989995) | **DataDog**
[Explore](https://appv2.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/7446169664) | **Intel**
[Explore](https://appv2.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/7590975903) | **Kubernetes**
[Explore](https://appv2.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/7591172950) | **Node.js**
[Explore](https://appv2.stepsecurity.io/github/nodejs/node/actions/runs/7591405720) | **AWS**
[Explore](https://appv2.stepsecurity.io/github/aws/aperf/actions/runs/7631366761) | -### Run your job without sudo access +### Case Studies -> Applies to GitHub-hosted runners +- [Harden-Runner Detects CI/CD Supply Chain Attack in Google’s Open-Source Project Flank](https://www.stepsecurity.io/case-studies/flank) +- [StepSecurity Detects CI/CD Supply Chain Attack in Microsoft’s Open-Source Project Azure Karpenter Provider in Real-Time](https://www.stepsecurity.io/case-studies/azure-karpenter-provider) +- [How Coveo Strengthened GitHub Actions Security with StepSecurity](https://www.stepsecurity.io/case-studies/coveo) +- [Hashgraph Achieves Comprehensive CI/CD Security Without Compromising Development Speed](https://www.stepsecurity.io/case-studies/hashgraph) +- [Kapiche secures their GitHub Actions software supply chain with Harden-Runner](https://www.stepsecurity.io/case-studies/kapiche) +- [Arcjet Enhances CI/CD Security with Harden-Runner](https://www.stepsecurity.io/case-studies/arcjet) -GitHub-hosted runner uses passwordless sudo for running jobs. +--- -- This means compromised build tools or dependencies can install attack tools -- If your job does not need sudo access, you see a policy - recommendation to disable sudo in the insights page -- When you set `disable-sudo` to `true`, the job steps run without sudo access to the GitHub-hosted Ubuntu VM +## How It Works -

- Policy recommended by harden-runner -

+Want to know the technical details? Dive into the architecture of Harden-Runner and its integrations for GitHub-hosted and self-hosted runners in our [How Harden-Runner Works Documentation](docs/how-it-works.md). -### Get real-time security alerts +--- -> Applies to both GitHub-hosted and self-hosted runners +## Limitations -Install the [StepSecurity GitHub App](https://github.com/apps/stepsecurity-actions-security) to get security alerts/ notifications. +While Harden-Runner offers powerful features, there are certain limitations based on the environment, such as OS support. See the complete list in [Known Limitations](docs/limitations.md). -- Email, Slack, and Teams notifications are supported -- Notifications are sent when anomalous outbound network/ HTTPS traffic is detected, outbound traffic is blocked, or source code is overwritten -- Notifications are not repeated for the same alert for a given workflow +--- ## Discussions -- If you have questions or ideas, please use [discussions](https://github.com/step-security/harden-runner/discussions). -- For support for self-hosted runners and private repositories, email support@stepsecurity.io. -- If you use a different CI/CD Provider (e.g. Jenkins, Gitlab CI, etc), and would like to use Harden Runner in your environment, please email interest@stepsecurity.io - -## How does it work? - -### GitHub-Hosted Runners - -For GitHub-hosted runners, Harden-Runner GitHub Action downloads and installs the StepSecurity Agent. - -- The code to monitor file, process, and network activity is in the Agent. -- The agent is written in Go and is open source at https://github.com/step-security/agent -- 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) - -### Self-Hosted Actions Runner Controller (ARC) Runners - -- ARC Harden Runner daemonset uses eBPF -- You can find more details in this blog post: https://www.stepsecurity.io/blog/introducing-harden-runner-for-kubernetes-based-self-hosted-actions-runners -- ARC Harden Runner is NOT open source. - -### Self-Hosted VM Runners (e.g. on EC2) - -- For self-hosted VMs, you add the Harden-Runner agent into your runner image (e.g. AMI). -- Agent for self-hosted VMs is NOT open source. - -## Limitations - -### GitHub-Hosted Runners - -1. Only Ubuntu VM is supported. Windows and MacOS GitHub-hosted runners are not supported. There is a discussion about that [here](https://github.com/step-security/harden-runner/discussions/121). -2. Harden-Runner is not supported when [job is run in a container](https://docs.github.com/en/actions/using-jobs/running-jobs-in-a-container) as it needs sudo access on the Ubuntu VM to run. It can be used to monitor jobs that use containers to run steps. The limitation is if the entire job is run in a container. That is not common for GitHub Actions workflows, as most of them run directly on `ubuntu-latest`. Note: This is not a limitation for Self-Hosted runners. +Join the conversation! For questions, ideas, or feedback, visit our [Discussions Page](https://github.com/step-security/harden-runner/discussions). -### Self-Hosted Actions Runner Controller (ARC) Runners +For enterprise support, email support@stepsecurity.io. Interested in using Harden-Runner in other CI/CD platforms? Reach out to interest@stepsecurity.io. -1. Since ARC Harden Runner uses eBPF, only Linux jobs are supported. Windows and MacOS jobs are not supported. +--- -### Self-Hosted VM Runners (e.g. on EC2) +## License -1. Only Ubuntu VM is supported. Windows and MacOS jobs are not supported. +Harden-Runner is open source. See the [LICENSE](LICENSE) file for details. diff --git a/docs/how-it-works.md b/docs/how-it-works.md new file mode 100644 index 0000000..ab112f1 --- /dev/null +++ b/docs/how-it-works.md @@ -0,0 +1,21 @@ +## How Harden-Runner Works? + +### GitHub-Hosted Runners + +For GitHub-hosted runners, Harden-Runner GitHub Action downloads and installs the StepSecurity Agent. + +- The code to monitor file, process, and network activity is in the Agent. +- The community tier agent is open-source and can be found [here](https://github.com/step-security/agent). The enterprise tier agent is closed-source. Both agents are written in Go. +- 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) + +### Self-Hosted Actions Runner Controller (ARC) Runners + +- ARC Harden Runner daemonset uses eBPF +- You can find more details in this [blog post](https://www.stepsecurity.io/blog/introducing-harden-runner-for-kubernetes-based-self-hosted-actions-runners) +- ARC Harden Runner is NOT open source. + +### Self-Hosted VM Runners (e.g. on EC2) + +- For self-hosted VMs, you add the Harden-Runner agent into your runner image (e.g. AMI). +- You can find more details in this [blog post](https://www.stepsecurity.io/blog/ci-cd-security-for-self-hosted-vm-runners) +- Agent for self-hosted VMs is NOT open source. \ No newline at end of file diff --git a/docs/limitations.md b/docs/limitations.md new file mode 100644 index 0000000..244361a --- /dev/null +++ b/docs/limitations.md @@ -0,0 +1,14 @@ +## Limitations + +### GitHub-Hosted Runners + +* Only Ubuntu VM is supported. Windows and MacOS GitHub-hosted runners are not supported. There is a discussion about that [here](https://github.com/step-security/harden-runner/discussions/121). +* Harden-Runner is not supported when [job is run in a container](https://docs.github.com/en/actions/using-jobs/running-jobs-in-a-container) as it needs sudo access on the Ubuntu VM to run. It can be used to monitor jobs that use containers to run steps. The limitation is if the entire job is run in a container. That is not common for GitHub Actions workflows, as most of them run directly on `ubuntu-latest`. Note: This is not a limitation for Self-Hosted runners. + +### Self-Hosted Actions Runner Controller (ARC) Runners + +* Since ARC Harden Runner uses eBPF, only Linux jobs are supported. Windows and MacOS jobs are not supported. + +### Self-Hosted VM Runners (e.g. on EC2) + +* Only Ubuntu VM is supported. Windows and MacOS jobs are not supported. \ No newline at end of file diff --git a/images/network-events.png b/images/network-events.png new file mode 100644 index 0000000..b7d568e Binary files /dev/null and b/images/network-events.png differ diff --git a/images/network-events1.png b/images/network-events1.png deleted file mode 100644 index 275ec49..0000000 Binary files a/images/network-events1.png and /dev/null differ diff --git a/images/recommended-policy1.png b/images/recommended-policy1.png deleted file mode 100644 index df6af98..0000000 Binary files a/images/recommended-policy1.png and /dev/null differ