update

Update package-lock.json

.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+        {
+            "env": {
+                "node": true
+            },
+            "files": [
+                ".eslintrc.{js,cjs}"
+            ],
+            "parserOptions": {
+                "sourceType": "script"
+            }
+        }
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}

.github/workflows/canary.yml

@@ -22,13 +22,14 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95 # v1
+    - uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v1
       with:
-        allowed-endpoints: 
+        egress-policy: audit
+        allowed-endpoints:
           api.github.com:443
           github.com:443
 
-    - uses: actions/checkout@629c2de402a417ea7690ca6ce3f33229e27606a5 # v2
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v2
     - name: Update the rc tag
       uses: step-security/publish-action@b438f840875fdcb7d1de4fc3d1d30e86cf6acb5d
       with:

.github/workflows/code-review.yml

@@ -0,0 +1,23 @@
+name: Code Review
+on:
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  code-review:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
+        with:
+          disable-sudo: true
+          egress-policy: block
+          allowed-endpoints: >
+            api.github.com:443
+            int.api.stepsecurity.io:443
+
+      - name: Code Review
+        uses: step-security/ai-codewise@int

.github/workflows/codeql-analysis.yml

@@ -41,16 +41,16 @@ jobs:
 
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95
+      uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423
       with:
         egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
 
     - name: Checkout repository
-      uses: actions/checkout@d171c3b028d844f2bf14e9fdec0c58114451e4bf
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@b398f525a5587552e573b247ac661067fafa920b
+      uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -61,7 +61,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@b398f525a5587552e573b247ac661067fafa920b
+      uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -75,4 +75,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@b398f525a5587552e573b247ac661067fafa920b
+      uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a

.github/workflows/dependency-review.yml

@@ -0,0 +1,27 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required,
+# PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
+        with:
+          egress-policy: audit
+
+      - name: 'Checkout Repository'
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@6c5ccdad469c9f8a2996bfecaec55a631a347034 # v3.1.0

.github/workflows/recurring-int-tests.yml

@@ -6,14 +6,14 @@ on:
 
 permissions:
   contents: read
-      
+
 jobs:
   int-tests:
     name: int tests
     runs-on: ubuntu-latest
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95
+      uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423
       with:
         egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
 

.github/workflows/release.yml

@@ -25,13 +25,14 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95
+    - uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423
       with:
-        allowed-endpoints: 
+        egress-policy: audit
+        allowed-endpoints:
           api.github.com:443
           github.com:443
 
-    - uses: actions/checkout@d171c3b028d844f2bf14e9fdec0c58114451e4bf
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
     - name: Update the rc tag
       uses: step-security/publish-action@b438f840875fdcb7d1de4fc3d1d30e86cf6acb5d
       with:

.github/workflows/scorecards.yml

@@ -0,0 +1,67 @@
+name: Scorecards supply-chain security
+on:
+  # Only the default branch is supported.
+  branch_protection_rule:
+  schedule:
+    # Weekly on Saturdays.
+    - cron: "30 1 * * 6"
+  push:
+    branches: [main, master]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecards analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Used to receive a badge. (Upcoming feature)
+      id-token: write
+      actions: read
+      contents: read
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
+        with:
+          egress-policy: audit
+
+      - name: "Checkout code"
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # tag=v3.0.0
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # tag=v1.1.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) Read-only PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecards on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          # repo_token: ${{ secrets.SCORECARD_READ_TOKEN }}
+
+          # Publish the results for public repositories to enable scorecard badges. For more details, see
+          # https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories, `publish_results` will automatically be set to `false`, regardless
+          # of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # tag=v3.0.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@cdcdbb579706841c47f7063dda365e292e5cad7a # tag=v1.0.26
+        with:
+          sarif_file: results.sarif

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Test
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main # to update code coverage
+
+permissions: # added using https://github.com/step-security/secure-workflows
+  contents: read
+concurrency:
+  group: ${{ github.workflow }}
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
+        with:
+          disable-sudo: true
+          egress-policy: audit
+          allowed-endpoints: >
+            api.github.com:443
+            codecov.io:443
+            github.com:443
+            registry.npmjs.org:443
+            storage.googleapis.com:443
+            uploader.codecov.io:443
+
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run coverage
+        run: npm test -- --coverage
+      - uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4

.gitignore

@@ -104,4 +104,4 @@ typings/
 .tern-port
 
 # vscode files
-.vscode
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+exclude: ^dist/
+repos:
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.16.3
+  hooks:
+  - id: gitleaks
+- repo: https://github.com/pre-commit/mirrors-eslint
+  rev: v8.38.0
+  hooks:
+  - id: eslint
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace

README.md

@@ -1,123 +1,233 @@
+<p align="center">
 <picture>
   <source media="(prefers-color-scheme: light)" srcset="images/banner.png" width="400">
-  <img src="images/banner.png" width="400">
+  <img alt="Dark Banner" src="images/banner-dark.png" width="400">
 </picture>
+</p>
+
+<div align="center">
 
 [![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)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/step-security/harden-runner/badge)](https://api.securityscorecards.dev/projects/github.com/step-security/harden-runner)
 [![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)
 
----
+</div>
 
-Harden-Runner GitHub Action installs a security agent on the GitHub-hosted runner (Ubuntu VM) to
+## GitHub Actions Runtime Security
 
-1. Prevent exfiltration of credentials
-2. Detect compromised dependencies and build tools
-3. Detect tampering of source code during build
+Harden-Runner provides runtime security for GitHub-hosted and self-hosted environments.
 
-<p align="left">
-      <img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/HardenRunnerGIFV.gif" alt="Demo using GIF" >
-    </p>
+For self-hosted environments, Harden-Runner supports:
+
+1. Kubernetes runners setup using Actions Runner Controller (ARC)
+2. Virtual Machine runners (e.g. on EC2) - both ephemeral and persistent runners are supported
+
+[![Harden Runner Demo](images/RuntimeSecurityDemo.gif)](https://youtu.be/fpdwX5hYACo)
+
+## Explore open source projects using Harden-Runner
+
+| [![CISA](https://avatars.githubusercontent.com/u/18539691?s=60&v=4)](https://app.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/6199340224) | [![Microsoft](https://avatars.githubusercontent.com/u/6154722?s=60&v=4)](https://app.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/5559160177) | [![Google](https://avatars.githubusercontent.com/u/2810941?s=60&v=4)](https://app.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/5546354505) | [![DataDog](https://avatars.githubusercontent.com/u/365230?s=60&v=4)](https://app.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/5387101451) | [![Intel](https://avatars.githubusercontent.com/u/17888862?s=60&v=4)](https://app.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/5579910614) | [![Kubernetes](https://avatars.githubusercontent.com/u/36015203?s=60&v=4)](https://app.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/5581511101) | [![Node.js](https://avatars.githubusercontent.com/u/9950313?s=60&v=4)](https://app.stepsecurity.io/github/nodejs/node/actions/runs/5563468674) | [![Mastercard](https://avatars.githubusercontent.com/u/1653148?s=60&v=4)](https://app.stepsecurity.io/github/Mastercard/flow/actions/runs/5542112873) |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **CISA**<br>[Explore](https://app.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/6199340224)                                                | **Microsoft**<br>[Explore](https://app.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/5559160177)                                               | **Google**<br>[Explore](https://app.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/5546354505)                                               | **DataDog**<br>[Explore](https://app.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/5387101451)                                              | **Intel**<br>[Explore](https://app.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/5579910614)                                                | **Kubernetes**<br>[Explore](https://app.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/5581511101)                                                | **Node.js**<br>[Explore](https://app.stepsecurity.io/github/nodejs/node/actions/runs/5563468674)                                               | **Mastercard**<br>[Explore](https://app.stepsecurity.io/github/Mastercard/flow/actions/runs/5542112873)                                               |
+
+## 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.
+
+Hands-on Tutorials for GitHub Actions Runtime Security:
+
+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)
 
 ## Why
 
-Compromised dependencies and build tools typically make outbound calls to exfiltrate data or credentials, or may tamper source code, dependencies, or artifacts during the build.
+Compromised workflows, dependencies, and build tools typically make outbound calls to exfiltrate credentials, or may tamper source code, dependencies, or artifacts during the build.
 
-Harden-Runner GitHub Actions installs a daemon that monitors process, file, and network activity to:
+Harden-Runner monitors process, file, and network activity to:
 
-| |Countermeasure |Threat|
-|--|----------|----------------|
-|1.| Block 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|
-|2.| Detect 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)|
-|3.| Detect 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)
+|     | Countermeasure                                                                                                                      | Prevent Security Breach                                                                                                                                                                                                                                                                                                                             |
+| --- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 1.  | Block egress traffic at the DNS (Layer 7) and network layers (Layers 3 and 4) to prevent exfiltration of code and CI/CD credentials | To prevent [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 [SolarWinds incident](https://github.com/step-security/github-actions-goat/blob/main/docs/Vulnerabilities/TamperingDuringBuild.md) scenario                                                                                                                                                                                               |
+| 3.  | Detect poisoned workflows and compromised dependencies                                                                              | 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) |
 
 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.
 
 ## How
 
-1. Add `step-security/harden-runner` to your GitHub Actions workflow file as the first step in each job.
+### GitHub-Hosted Runners
+
+1. Add `step-security/harden-runner` GitHub Action to your GitHub Actions workflow file as the first step in each job.
 
    ```yaml
    steps:
-     - uses: step-security/harden-runner@dd2c410b088af7c0dc8046f3ac9a8f4148492a95
+     - uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
        with:
          egress-policy: audit
    ```
 
-2. In the workflow logs, you will see a link to security insights and recommendations.
+2. In the workflow logs and the job markdown summary, 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>
+    <p align="left">
+      <img src="images/buildlog1.png" alt="Link in build log" >
+    </p>
 
-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.
+3. Click on the link ([example link](https://app.stepsecurity.io/github/microsoft/msquic/actions/runs/5577342236)). You will see a process monitor view of network and file events correlated with each step of the job.
 
-<p align="left">
-  <img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/OutboundCalls2.png" alt="Insights from harden-runner" >
-</p>
+    <p align="left">
+      <img src="images/insights-5.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. When you use `egress-policy: block` mode, you can also set `disable-telemetry: true` to not send telemetry to the StepSecurity API.
+4. Under the insights section, you'll find a Recommended Policy. You can either 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.
 
-<p align="left">
-  <img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/RecomPolicy1.png" alt="Policy recommended by harden-runner" >
-</p>
+    <p align="left">
+      <img src="images/rec-policy1.png" alt="Policy recommended by harden-runner" >
+    </p>
 
-5. If outbound network call is made to an endpoint not in the allowed list or if source code is tampered, you will see an annotation in the workflow run.
+### Self-Hosted Actions Runner Controller (ARC) Runners
 
-<p align="left">
-  <img src="https://github.com/step-security/supply-chain-goat/blob/main/images/harden-runner/SourceCodeOverwrite.png" alt="Policy recommended by harden-runner" >
-</p>
+> 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).
 
-## Support for private repositories
+Actions Runner Controller (ARC) is a Kubernetes operator that orchestrates and scales self-hosted runners for GitHub Actions.
 
-Install the [Harden Runner App](https://github.com/marketplace/harden-runner-app) to use Harden-Runner GitHub Action for `Private` repositories.
+- Instead of adding the Harden-Runner GitHub Action in each workflow, you'll need to install the ARC Harden-Runner daemonset on your Kubernetes cluster.
+- Upon installation, the ARC Harden-Runner daemonset constantly monitors each workflow run; 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 for `block` mode.
+- You can access security insights and runtime detections under the `Runtime Security` tab in your dashboard.
 
+### 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 workflow, you'll need to install the Harden-Runner agent on your runner image (e.g. AMI). This is typically done using packer.
+- The Harden-Runner agent monitors each job 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 for `block` mode.
+- You can access security insights and runtime detections under the `Runtime Security` tab in your dashboard.
+
+## Support for Self-Hosted Runners and Private Repositories
+
+Runtime security for self-hosted runners and private repositories are supported with a commercial license. Check out the [documentation](https://docs.stepsecurity.io/stepsecurity-platform/billing) for more details.
+
+- Install the [StepSecurity Actions Security GitHub App](https://github.com/apps/stepsecurity-actions-security) to use Harden-Runner GitHub Action for `Private` repositories.
 - If you use Harden-Runner GitHub Action in a private repository, the generated insights URL is NOT public.
 - You need to authenticate first to access insights URL for private repository. Only those who have access to the repository can view it.
-- [Harden Runner App](https://github.com/marketplace/harden-runner-app) only needs `actions: read` permissions on your repositories.
 
-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.
+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.
+
+## Features at a glance
+
+For details, check out the documentation at https://docs.stepsecurity.io
+
+### 👀 Monitor egress traffic
+
+> 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 past job runs
+
+### 🚦 Filter egress traffic to allowed endpoints
+
+> Applies to both GitHub-hosted and self-hosted runners
+
+Once allowed endpoints are set in the policy 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)
+
+- 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`
+
+<p align="left">
+  <img src="images/blocked-outbound-call-2.png" alt="Policy recommended by harden-runner" >
+</p>
+
+### 🤖 Select GitHub Actions with Confidence
+
+> Applies to both GitHub-hosted and self-hosted runners
+
+Before integrating a GitHub Action into your workflow, evaluate its network activity.
+
+- Access network behavior data for hundreds of GitHub Actions, compiled from thousands of workflow runs that use Harden-Runner in public repositories
+- Search for a GitHub Action and view a comprehensive report of its outbound network traffic
+- Use this insight to make educated choices about incorporating GitHub Actions into your projects
+
+<p align="left">
+  <img src="images/network-behavior.png" alt="Networking behavior of an Action" >
+</p>
+
+### 📁 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.
+
+- 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
+
+<p align="left">
+  <img src="images/file-overwritten.png" alt="Policy recommended by harden-runner" >
+</p>
+
+### 🚫 Run your job without sudo access
+
+> Applies to GitHub-hosted runners
+
+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
+
+### 🔔 Get security alerts
+
+> Applies to both GitHub-hosted and self-hosted runners
+
+Install the [StepSecurity Actions Security GitHub App](https://github.com/apps/stepsecurity-actions-security) to get security alerts.
+
+- Email and Slack notifications are supported
+- Notifications are sent when 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).
-
-1. [Support for private repositories](https://github.com/step-security/harden-runner/discussions/74)
-2. [Where should allowed-endpoints be stored?](https://github.com/step-security/harden-runner/discussions/84)
-3. [Cryptographically verify tools run as part of the CI/ CD pipeline](https://github.com/step-security/harden-runner/discussions/94)
-
-## Limitations
-
-1. Harden-Runner GitHub Action only works for GitHub-hosted runners. Self-hosted runners are not supported.
-2. 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).
-3. 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`.
-
-## 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](https://stars.github.com/profiles/lirantal/), 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 tool’s improvement over time_ - [Jordan Harband](https://github.com/ljharb), 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, Staff Site Reliability Engineer, Kapiche
-
-## Workflows using harden-runner
-
-Some important workflows using harden-runner:
-| |Repository |Link to insights|
-|--|----------|----------------|
-|1.|[nvm-sh/nvm](https://github.com/nvm-sh/nvm/blob/master/.github/workflows/lint.yml)|[Link to insights](https://app.stepsecurity.io/github/nvm-sh/nvm/actions/runs/1757959262)|
-|2.|[yannickcr/eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react/blob/master/.github/workflows/release.yml)|[Link to insights](https://app.stepsecurity.io/github/yannickcr/eslint-plugin-react/actions/runs/1930818585)
-|3.|[microsoft/msquic](https://github.com/microsoft/msquic/blob/main/.github/workflows/docker-publish.yml)|[Link to insights](https://app.stepsecurity.io/github/microsoft/msquic/actions/runs/1759010243)
-|4.|[ossf/scorecard](https://github.com/ossf/scorecard/blob/main/.github/workflows/codeql-analysis.yml)|[Link to insights](https://app.stepsecurity.io/github/ossf/scorecard/actions/runs/2006162141)
-|5.|[Automattic/vip-go-mu-plugins](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)
+- 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?
 
-Harden-Runner GitHub Action downloads and installs the StepSecurity Agent.
+### 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).
+- 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)
 
-## 1-minute Demo Video
+### Self-Hosted Actions Runner Controller (ARC) Runners
 
-https://user-images.githubusercontent.com/25015917/156026587-79356450-9b35-4254-9c2e-7f2cc8d81059.mp4
+- 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.
+
+### Self-Hosted Actions Runner Controller (ARC) Runners
+
+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)
+
+1. Only Ubuntu VM is supported. Windows and MacOS jobs are not supported.

action.yml

@@ -1,5 +1,5 @@
-name: "Harden Runner"
-description: "Security agent for GitHub-hosted runner to monitor the build process"
+name: "Harden-Runner"
+description: "Harden-Runner provides runtime security for GitHub-hosted and self-hosted runners"
 inputs:
   allowed-endpoints:
     description: "Only these endpoints will be allowed if egress-policy is set to block"
@@ -16,11 +16,24 @@ inputs:
     description: "Disable sending telemetry to StepSecurity API, can be set to true or false. This can only be set to true when egress-policy is set to block"
     required: false
     default: "false"
+  disable-sudo:
+    description: "Disable sudo access for the runner account"
+    required: false
+    default: "false"
+  disable-file-monitoring:
+    description: "Disable file monitoring"
+    required: false
+    default: "false"
+  policy:
+    description: "Policy name to be used from the policy store"
+    required: false
+    default: ""
+
 branding:
   icon: "check-square"
   color: "green"
 runs:
-  using: "node16"
+  using: "node20"
   pre: "dist/pre/index.js"
   main: "dist/index.js"
   post: "dist/post/index.js"

jest.config.ts

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package.json

@@ -1,14 +1,15 @@
 {
   "name": "step-security-harden-runner",
-  "version": "1.5.0",
-  "description": "Security agent for GitHub-hosted runner to monitor the build process",
+  "version": "2.6.1",
+  "description": "Security agent for GitHub-hosted runner: block egress traffic & detect code overwrite to prevent breaches",
   "main": "index.js",
   "scripts": {
     "build": "npm run main && npm run pre && npm run post",
     "main": "ncc build src/index.ts --source-map",
     "pre": "ncc build src/setup.ts --source-map -o dist/pre",
     "post": "ncc build src/cleanup.ts --source-map -o dist/post",
-    "lint": "eslint src/**/*.ts"
+    "lint": "eslint src/**/*.ts",
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -22,28 +23,30 @@
   },
   "homepage": "https://github.com/step-security/harden-runner#readme",
   "dependencies": {
-    "@actions/cache": "^3.0.4",
+    "@actions/cache": "^3.1.4",
     "@actions/core": "^1.5.0",
     "@actions/exec": "^1.1.0",
-    "@actions/github": "^5.0.0",
-    "@actions/http-client": "^2.0.1",
-    "@actions/tool-cache": "^1.7.1",
+    "@actions/github": "^6.0.0",
+    "@actions/tool-cache": "^2.0.1",
     "ansi-regex": ">=5.0.1",
+    "axios": "^1.6.1",
     "is-docker": "^3.0.0",
     "node-fetch": ">=3.2.0",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.1",
-    "@types/node": "^16.9.0",
-    "@typescript-eslint/eslint-plugin": "^4.29.2",
-    "@typescript-eslint/parser": "^4.29.2",
-    "@vercel/ncc": "^0.30.0",
-    "eslint": "^7.32.0",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.9.0",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
+    "@vercel/ncc": "0.38.0",
+    "eslint": "^8.53.0",
     "eslint-config-google": "^0.14.0",
-    "jest": ">=27.4.7",
+    "jest": "^29.3.1",
     "jest-junit": ">=13.0.0",
-    "ts-jest": ">=27.1.3",
-    "typescript": "^4.3.5"
+    "nock": "^13.3.0",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   }
 }

src/arc-runner.test.ts

@@ -0,0 +1,20 @@
+import { isArcRunner, sendAllowedEndpoints } from "./arc-runner";
+
+
+it("should correctly recognize arc based runner", async () => {
+  process.env["GITHUB_ACTIONS_RUNNER_EXTRA_USER_AGENT"] =
+    "actions-runner-controller/2.0.1";
+
+  let isArc: boolean =  await isArcRunner();
+  expect(isArc).toBe(true);
+
+});
+
+
+it("should write endpoint files", ()=>{
+  process.env["isTest"] = "1"
+
+  let allowed_endpoints = ["github.com:443", "*.google.com:443", "youtube.com"].join(" ");
+  sendAllowedEndpoints(allowed_endpoints);
+
+})

src/arc-runner.ts

@@ -0,0 +1,62 @@
+import * as cp from "child_process";
+import * as fs from "fs";
+import { sleep } from "./setup";
+
+export function isArcRunner(): boolean {
+  const runnerUserAgent = process.env["GITHUB_ACTIONS_RUNNER_EXTRA_USER_AGENT"];
+
+  let isARC = false;
+
+  if (!runnerUserAgent) {
+    isARC = false;
+  } else {
+    isARC = runnerUserAgent.includes("actions-runner-controller/");
+  }
+
+  return isARC || isSecondaryPod();
+}
+
+function isSecondaryPod(): boolean {
+  const workDir = "/__w";
+  return fs.existsSync(workDir);
+}
+
+function getRunnerTempDir(): string {
+  const isTest = process.env["isTest"];
+
+  if (isTest === "1") {
+    return "/tmp";
+  }
+
+  return process.env["RUNNER_TEMP"] || "/tmp";
+}
+
+export function sendAllowedEndpoints(endpoints: string): void {
+  const allowedEndpoints = endpoints.split(" "); // endpoints are space separated
+
+  for (const endpoint of allowedEndpoints) {
+    if (endpoint) {
+      const encodedEndpoint = Buffer.from(endpoint).toString("base64");
+      cp.execSync(
+        `echo "${endpoint}" > "${getRunnerTempDir()}/step_policy_endpoint_${encodedEndpoint}"`
+      );
+    }
+  }
+
+  if (allowedEndpoints.length > 0) {
+    applyPolicy(allowedEndpoints.length);
+  }
+}
+
+function applyPolicy(count: number): void {
+  const fileName = `step_policy_apply_${count}`;
+  cp.execSync(`echo "${fileName}" > "${getRunnerTempDir()}/${fileName}"`);
+}
+
+export function removeStepPolicyFiles() {
+  cp.execSync(`rm ${getRunnerTempDir()}/step_policy_*`);
+}
+
+export function arcCleanUp() {
+  cp.execSync(`echo "cleanup" > "${getRunnerTempDir()}/step_policy_cleanup"`);
+}

src/cache.ts

@@ -1,98 +1,6 @@
-import * as core from "@actions/core";
-import { HttpClient } from "@actions/http-client";
-import { RequestOptions } from "@actions/http-client/lib/interfaces";
-import { BearerCredentialHandler } from "@actions/http-client/lib/auth";
-import * as crypto from "crypto";
-
-const versionSalt = "1.0";
 export const cacheKey = "harden-runner-cacheKey";
 export const cacheFile = "/home/agent/cache.txt";
 
-function getCacheApiUrl(resource: string): string {
-  const baseUrl: string = process.env["ACTIONS_CACHE_URL"] || "";
-  if (!baseUrl) {
-    throw new Error("Cache Service Url not found, unable to restore cache.");
-  }
-
-  const url = `${baseUrl}_apis/artifactcache/${resource}`;
-  core.debug(`Resource Url: ${url}`);
-  return url;
-}
-
-function createAcceptHeader(type: string, apiVersion: string): string {
-  return `${type};api-version=${apiVersion}`;
-}
-
-function getRequestOptions(): RequestOptions {
-  const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
-
-  const requestOptions: RequestOptions = {
-    headers: {
-      Accept: createAcceptHeader("application/json", "6.0-preview.1"),
-      Authorization: `Bearer ${token}`,
-    },
-  };
-
-  return requestOptions;
-}
-
-function createHttpClient(): HttpClient {
-  const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
-  const bhandler = new BearerCredentialHandler(token);
-  return new HttpClient("actions/cache", [bhandler], getRequestOptions());
-}
-
-export function getCacheVersion(
-  paths: string[],
-  compressionMethod?: CompressionMethod
-): string {
-  const components = paths.concat(
-    !compressionMethod || compressionMethod === CompressionMethod.Gzip
-      ? []
-      : [compressionMethod]
-  );
-
-  // Add salt to cache version to support breaking changes in cache entry
-  components.push(versionSalt);
-
-  return crypto.createHash("sha256").update(components.join("|")).digest("hex");
-}
-
-export async function getCacheEntry(
-  keys: string[],
-  paths: string[],
-  options?: InternalCacheOptions
-): Promise<ArtifactCacheEntry | null> {
-  const httpClient = createHttpClient();
-  const version = getCacheVersion(paths, options?.compressionMethod);
-  const resource = `cache?keys=${encodeURIComponent(
-    keys.join(",")
-  )}&version=${version}`;
-
-  const response = await httpClient.getJson<ArtifactCacheEntry>(
-    getCacheApiUrl(resource)
-  );
-  if (response.statusCode === 204) {
-    throw new Error("Request returned 204 status");
-  }
-  if (!isSuccessStatusCode(response.statusCode)) {
-    throw new Error(`Cache service responded with ${response.statusCode}`);
-  }
-
-  const cacheResult = response.result;
-  const cacheDownloadUrl = cacheResult?.archiveLocation;
-  if (!cacheDownloadUrl) {
-    throw new Error("Cache still be done, but  not found.");
-  }
-
-  return cacheResult;
-}
-
-export interface InternalCacheOptions {
-  compressionMethod?: CompressionMethod;
-  cacheSize?: number;
-}
-
 export interface ArtifactCacheEntry {
   cacheKey?: string;
   scope?: string;
@@ -100,13 +8,6 @@ export interface ArtifactCacheEntry {
   archiveLocation?: string;
 }
 
-function isSuccessStatusCode(statusCode?: number): boolean {
-  if (!statusCode) {
-    return false;
-  }
-  return statusCode >= 200 && statusCode < 300;
-}
-
 export enum CompressionMethod {
   Gzip = "gzip",
   // Long range mode was added to zstd in v1.3.2.
@@ -118,4 +19,4 @@ export enum CompressionMethod {
 const RefKey = "GITHUB_REF";
 export function isValidEvent(): boolean {
   return RefKey in process.env && Boolean(process.env[RefKey]);
-}
+}

src/checksum.ts

@@ -10,7 +10,7 @@ export function verifyChecksum(downloadPath: string) {
     .digest("hex"); // checksum of downloaded file
 
   const expectedChecksum: string =
-    "7027c15a988395f3dde5e77d9a58889669adbda52fbd527ae8216e6d81dd8b1a"; // checksum for v0.11.0
+    "ceb925c78e5c79af4f344f08f59bbdcf3376d20d15930a315f9b24b6c4d0328a"; // checksum for v0.13.5
 
   if (checksum !== expectedChecksum) {
     core.setFailed(

src/cleanup.ts

@@ -1,11 +1,8 @@
 import * as fs from "fs";
 import * as cp from "child_process";
-import * as core from "@actions/core";
 import * as common from "./common";
 import isDocker from "is-docker";
-import * as cache from "@actions/cache";
-import { cacheFile, cacheKey, isValidEvent } from "./cache";
-import path from "path";
+import { arcCleanUp, isArcRunner, removeStepPolicyFiles } from "./arc-runner";
 
 (async () => {
   if (process.platform !== "linux") {
@@ -17,13 +14,32 @@ import path from "path";
     return;
   }
 
+  if (isArcRunner()) {
+    console.log(`[!] ${common.ARC_RUNNER_MESSAGE}`);
+    arcCleanUp();
+    removeStepPolicyFiles();
+    return;
+  }
+
+  if (process.env.STATE_selfHosted === "true") {
+    return;
+  }
+
+  if (
+    String(process.env.STATE_monitorStatusCode) ===
+    common.STATUS_HARDEN_RUNNER_UNAVAILABLE
+  ) {
+    console.log(common.HARDEN_RUNNER_UNAVAILABLE_MESSAGE);
+    return;
+  }
+
   fs.writeFileSync(
     "/home/agent/post_event.json",
     JSON.stringify({ event: "post" })
   );
 
-  var doneFile = "/home/agent/done.json";
-  var counter = 0;
+  const doneFile = "/home/agent/done.json";
+  let counter = 0;
   while (true) {
     if (!fs.existsSync(doneFile)) {
       counter++;
@@ -39,7 +55,7 @@ import path from "path";
     }
   }
 
-  var log = "/home/agent/agent.log";
+  const log = "/home/agent/agent.log";
   if (fs.existsSync(log)) {
     console.log("log:");
     var content = fs.readFileSync(log, "utf-8");
@@ -53,32 +69,19 @@ import path from "path";
     console.log(content);
   }
 
-  // write annotations
-  var annotationsFile = "/home/agent/annotation.log";
-  if (fs.existsSync(annotationsFile)) {
-    var content = fs.readFileSync(annotationsFile, "utf-8");
-    content.split(/\r?\n/).forEach((line) => {
-      core.error(line);
+  var disable_sudo = process.env.STATE_disableSudo;
+  if (disable_sudo !== "true") {
+    var journalLog = cp.execSync("sudo journalctl -u agent.service", {
+      encoding: "utf8",
     });
+    console.log("Service log:");
+    console.log(journalLog);
   }
 
-  // Always log the service log
-  var journalLog = cp.execSync("sudo journalctl -u agent.service", {
-    encoding: "utf8",
-  });
-  console.log("Service log:");
-  console.log(journalLog);
-
-  if (isValidEvent()) {
-    try {
-      const cmd = "cp";
-      const args = [path.join(__dirname, "cache.txt"), cacheFile];
-      cp.execFileSync(cmd, args);
-      const cacheResult = await cache.saveCache([cacheFile], cacheKey);
-      console.log(cacheResult);
-    } catch (exception) {
-      console.log(exception);
-    }
+  try {
+    await common.addSummary();
+  } catch (exception) {
+    console.log(exception);
   }
 })();
 

src/common.test.ts

@@ -0,0 +1,28 @@
+import { processLogLine } from "./common"; // import the function
+
+describe("processLogLine function", () => {
+  it("correctly processes the log line and adds an entry to the array", () => {
+    const tableEntries: {
+      pid: string;
+      process: string;
+      domain: string;
+      ipAddress: string;
+      status: string;
+    }[] = [];
+    const logLine =
+      "Thu, 15 Jun 2023 05:35:29 GMT:endpoint called ip address:port 104.16.24.35:443, domain: registry.npmjs.org., pid: 2135, process: node.";
+
+    processLogLine(logLine, tableEntries);
+
+    // Check if a single entry is added to the array
+    expect(tableEntries.length).toBe(1);
+
+    // Check if the entry's properties are set correctly
+    const entry = tableEntries[0];
+    expect(entry.pid).toBe("2135");
+    expect(entry.process).toBe("node");
+    expect(entry.domain).toBe("registry.npmjs.org.");
+    expect(entry.ipAddress).toBe("104.16.24.35:443");
+    expect(entry.status).toBe("✅ Allowed"); // Since the IP address is not '54.185.253.63', status should be '✔️ Allowed'
+  });
+});

src/common.ts

@@ -1,3 +1,6 @@
+import * as core from "@actions/core";
+import * as fs from "fs";
+
 export function printInfo(web_url) {
   console.log(
     "\x1b[32m%s\x1b[0m",
@@ -9,8 +12,164 @@ export function printInfo(web_url) {
   );
 }
 
+export const processLogLine = (
+  line: string,
+  tableEntries: {
+    pid: string;
+    process: string;
+    domain: string;
+    ipAddress: string;
+    status: string;
+  }[]
+): void => {
+  if (
+    line.includes("pid") &&
+    line.includes("process") &&
+    line.includes("domain") &&
+    line.includes("ip address")
+  ) {
+    const matches = line.match(
+      /ip address:port ([\d.:]+), domain: ([\w.-]+), pid: (\d+), process: (\w+)/
+    );
+    if (matches) {
+      const [ipAddress, domain, pid, process] = matches.slice(1);
+
+      // Check if all values are non-empty
+      if (pid && process && domain && ipAddress) {
+        const status = ipAddress.startsWith("54.185.253.63")
+          ? "❌ Blocked"
+          : "✅ Allowed";
+
+        tableEntries.push({ pid, process, domain, ipAddress, status });
+      }
+    }
+  }
+};
+
+export async function addSummary() {
+  if (process.env.STATE_monitorStatusCode !== "200") {
+    return;
+  }
+
+  const web_url = "https://app.stepsecurity.io";
+  const insights_url = `${web_url}/github/${process.env["GITHUB_REPOSITORY"]}/actions/runs/${process.env["GITHUB_RUN_ID"]}`;
+
+  const log = "/home/agent/agent.log";
+  if (!fs.existsSync(log)) {
+    return;
+  }
+
+  let needsSubscription = false;
+  try {
+    let data = fs.readFileSync("/home/agent/annotation.log", "utf8");
+    if (data.includes("StepSecurity Harden Runner is disabled")) {
+      needsSubscription = true;
+    }
+  } catch (err) {
+    //console.error(err);
+  }
+
+  if (needsSubscription) {
+    await core.summary
+      .addSeparator()
+      .addRaw(
+        `<h2>⚠️ Your GitHub Actions Runtime Security is currently disabled!</h2>`
+      );
+
+    await core.summary
+      .addRaw(
+        `
+<p>It appears that you're using the <a href="https://github.com/step-security/harden-runner">Harden-Runner GitHub Action</a> by StepSecurity within a private repository. However, runtime security is not enabled as your organization hasn't signed up for a free trial or a paid subscription yet.</p>
+<p>To enable runtime security, start a free trial today by installing the <a href="https://github.com/apps/stepsecurity-actions-security">StepSecurity Actions Security GitHub App</a>. For more information or assistance, feel free to reach out to us through our <a href="https://www.stepsecurity.io/contact">contact form</a>.</p>
+`
+      )
+      .addSeparator()
+      .write();
+    return;
+  }
+
+  const content = fs.readFileSync(log, "utf-8");
+  const lines = content.split("\n");
+
+  let tableEntries = [];
+
+  for (const line of lines) {
+    processLogLine(line, tableEntries);
+  }
+
+  if (tableEntries.length === 0) {
+    return;
+  }
+
+  const insightsRow = `<p><b><a href="${insights_url}">📄 View Full Report</a></b></p>`;
+
+  await core.summary.addSeparator().addRaw(`<h2>🛡 StepSecurity Report</h2>`);
+
+  tableEntries.sort((a, b) => {
+    if (a.status === "❌ Blocked" && b.status !== "❌ Blocked") {
+      return -1;
+    } else if (a.status !== "❌ Blocked" && b.status === "❌ Blocked") {
+      return 1;
+    } else {
+      return 0;
+    }
+  });
+
+  tableEntries = tableEntries.slice(0, 3);
+
+  await core.summary.addRaw(`
+  <blockquote>
+  <p>Preview of the outbound network calls during this workflow run.</p></blockquote>
+  <h3>Network Calls</h3>
+  <table>
+    <thead>
+      <tr>
+        <th>Process</th>
+        <th>Destination</th>
+        <th>Status</th>
+      </tr>
+    </thead>
+    <tbody>
+      ${tableEntries
+        .map(
+          (entry) => `<tr>
+          <td><code>${entry.process}</code></td>
+          <td>${entry.domain.replace(/\.$/, "")}</td>
+          <td>${entry.status}</td>
+        </tr>`
+        )
+        .join("")}
+      <tr>
+        <td><code>...</code></td>
+        <td><code>...</code></td>
+        <td><code>...</code></td>
+      </tr>
+    </tbody>
+  </table>
+  ${insightsRow}
+`);
+
+  await core.summary
+    .addRaw(
+      `<p><i>Markdown generated by the <a href="https://github.com/step-security/harden-runner">Harden-Runner GitHub Action</a>.</i></p>`
+    )
+    .addSeparator()
+    .write();
+}
+
+export const STATUS_HARDEN_RUNNER_UNAVAILABLE = "409";
+
 export const CONTAINER_MESSAGE =
   "This job is running in a container. Harden Runner does not run in a container as it needs sudo access to run. This job will not be monitored.";
 
 export const UBUNTU_MESSAGE =
   "This job is not running in a GitHub Actions Hosted Runner Ubuntu VM. Harden Runner is only supported on Ubuntu VM. This job will not be monitored.";
+
+export const SELF_HOSTED_NO_AGENT_MESSAGE =
+  "This job is running on a self-hosted runner, but the runner does not have Harden-Runner installed. This job will not be monitored.";
+
+export const HARDEN_RUNNER_UNAVAILABLE_MESSAGE =
+  "Sorry, we are currently experiencing issues with the Harden Runner installation process. It is currently unavailable.";
+
+export const ARC_RUNNER_MESSAGE =
+  "Workflow is currently being executed in ARC based runner";

src/index.ts

@@ -12,6 +12,14 @@ import isDocker from "is-docker";
     return;
   }
 
+  if (
+    String(process.env.STATE_monitorStatusCode) ===
+    common.STATUS_HARDEN_RUNNER_UNAVAILABLE
+  ) {
+    console.log(common.HARDEN_RUNNER_UNAVAILABLE_MESSAGE);
+    return;
+  }
+
   if (
     core.getBooleanInput("disable-telemetry") &&
     core.getInput("egress-policy") === "block"

src/interfaces.ts

@@ -0,0 +1,23 @@
+export interface Configuration {
+  repo: string;
+  run_id: string;
+  correlation_id: string;
+  working_directory: string;
+  api_url: string;
+  allowed_endpoints: string;
+  egress_policy: string;
+  disable_telemetry: boolean;
+  disable_sudo: boolean;
+  disable_file_monitoring: boolean;
+  private: string;
+}
+
+export interface PolicyResponse {
+  owner?: string;
+  policyName?: string;
+  allowed_endpoints?: string[];
+  disable_sudo?: boolean;
+  disable_file_monitoring?: boolean;
+  disable_telemetry?: boolean;
+  egress_policy?: string;
+}

src/policy-utils.test.ts

@@ -0,0 +1,67 @@
+import nock from "nock";
+import { API_ENDPOINT, fetchPolicy, mergeConfigs } from "./policy-utils";
+import { Configuration, PolicyResponse } from "./interfaces";
+
+test("success: fetching policy", async () => {
+  let owner = "h0x0er";
+  let policyName = "policy1";
+  let response = {
+    owner: "h0x0er",
+    policyName: "policy1",
+    allowed_endpoints: ["github.com:443"],
+    egress_policy: "audit",
+    disable_telemetry: false,
+    disable_sudo: false,
+    disable_file_monitoring: false,
+  };
+  const policyScope = nock(`${API_ENDPOINT}`)
+    .get(`/github/${owner}/actions/policies/${policyName}`)
+    .reply(200, response);
+
+  let idToken = "xyz";
+  let policy = await fetchPolicy(owner, policyName, idToken);
+  console.log(policy);
+  expect(policy).toStrictEqual(response);
+});
+
+test("merge configs", async () => {
+  let localConfig: Configuration = {
+    repo: "test/repo",
+    run_id: "xyx",
+    correlation_id: "aaaaa",
+    working_directory: "/xyz",
+    api_url: "xyz",
+    allowed_endpoints: "",
+    egress_policy: "audit",
+    disable_telemetry: false,
+    disable_sudo: false,
+    disable_file_monitoring: false,
+    private: "true",
+  };
+  let policyResponse: PolicyResponse = {
+    owner: "h0x0er",
+    policyName: "policy1",
+    allowed_endpoints: ["github.com:443", "google.com:443"],
+    egress_policy: "audit",
+    disable_telemetry: false,
+    disable_sudo: false,
+    disable_file_monitoring: false,
+  };
+
+  let expectedConfiguration: Configuration = {
+    repo: "test/repo",
+    run_id: "xyx",
+    correlation_id: "aaaaa",
+    working_directory: "/xyz",
+    api_url: "xyz",
+    allowed_endpoints: "github.com:443 google.com:443",
+    egress_policy: "audit",
+    disable_telemetry: false,
+    disable_sudo: false,
+    disable_file_monitoring: false,
+    private: "true",
+  };
+
+  localConfig = mergeConfigs(localConfig, policyResponse);
+  expect(localConfig).toStrictEqual(expectedConfiguration);
+});

src/policy-utils.ts

@@ -0,0 +1,75 @@
+import { HttpClient } from "@actions/http-client";
+import { PolicyResponse, Configuration } from "./interfaces";
+
+export const API_ENDPOINT = "https://agent.api.stepsecurity.io/v1";
+
+export async function fetchPolicy(
+  owner: string,
+  policyName: string,
+  idToken: string
+): Promise<PolicyResponse> {
+
+  if (idToken === "") {
+    throw new Error("[PolicyFetch]: id-token in empty");
+  }
+
+  let policyEndpoint = `${API_ENDPOINT}/github/${owner}/actions/policies/${policyName}`;
+
+  let httpClient = new HttpClient();
+
+  let headers = {};
+  headers["Authorization"] = `Bearer ${idToken}`;
+  headers["Source"] = "github-actions";
+
+  let response = undefined;
+  let err = undefined;
+
+  let retry = 0;
+  while(retry < 3){
+    try{
+      console.log(`Attempt: ${retry+1}`)
+      response = await httpClient.getJson<PolicyResponse>(
+        policyEndpoint,
+        headers
+      );
+      break;
+    }catch(e){
+      err = e
+    }
+    retry += 1
+    await sleep(1000);
+  }
+
+  if(response === undefined && err !== undefined){
+    throw new Error(`[Policy Fetch] ${err}`)
+  }else{
+    return response.result;
+  }
+}
+
+export function mergeConfigs(
+  localConfig: Configuration,
+  remoteConfig: PolicyResponse
+) {
+  if (localConfig.allowed_endpoints === "") {
+    localConfig.allowed_endpoints = remoteConfig.allowed_endpoints.join(" ");
+  }
+  if (remoteConfig.disable_sudo !== undefined) {
+    localConfig.disable_sudo = remoteConfig.disable_sudo;
+  }
+
+  if (remoteConfig.disable_file_monitoring !== undefined) {
+    localConfig.disable_file_monitoring = remoteConfig.disable_file_monitoring;
+  }
+  if (remoteConfig.egress_policy !== undefined) {
+    localConfig.egress_policy = remoteConfig.egress_policy;
+  }
+
+  return localConfig;
+}
+
+function sleep(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+}

src/setup.ts

@@ -1,20 +1,28 @@
 import * as core from "@actions/core";
 import * as cp from "child_process";
 import * as fs from "fs";
-import * as httpm from "@actions/http-client";
+import axios from "axios";
 import * as path from "path";
 import { v4 as uuidv4 } from "uuid";
 import * as common from "./common";
 import * as tc from "@actions/tool-cache";
 import { verifyChecksum } from "./checksum";
 import isDocker from "is-docker";
+import { context } from "@actions/github";
+import { EOL } from "os";
 import {
-  cacheFile,
+  ArtifactCacheEntry,
   cacheKey,
+  cacheFile,
   CompressionMethod,
-  getCacheEntry,
   isValidEvent,
 } from "./cache";
+import { Configuration, PolicyResponse } from "./interfaces";
+import { fetchPolicy, mergeConfigs } from "./policy-utils";
+import * as cache from "@actions/cache";
+import { getCacheEntry } from "@actions/cache/lib/internal/cacheHttpClient";
+import * as utils from "@actions/cache/lib/internal/cacheUtils";
+import { isArcRunner, sendAllowedEndpoints } from "./arc-runner";
 
 (async () => {
   try {
@@ -32,9 +40,7 @@ import {
     var api_url = `https://${env}.api.stepsecurity.io/v1`;
     var web_url = "https://app.stepsecurity.io";
 
-    console.log(`Step Security Job Correlation ID: ${correlation_id}`);
-
-    const confg = {
+    let confg: Configuration = {
       repo: process.env["GITHUB_REPOSITORY"],
       run_id: process.env["GITHUB_RUN_ID"],
       correlation_id: correlation_id,
@@ -43,25 +49,19 @@ import {
       allowed_endpoints: core.getInput("allowed-endpoints"),
       egress_policy: core.getInput("egress-policy"),
       disable_telemetry: core.getBooleanInput("disable-telemetry"),
+      disable_sudo: core.getBooleanInput("disable-sudo"),
+      disable_file_monitoring: core.getBooleanInput("disable-file-monitoring"),
+      private: context?.payload?.repository?.private || false,
     };
 
-    if (isValidEvent()) {
-      try {
-        const cacheEntry = await getCacheEntry([cacheKey], [cacheFile], {
-          compressionMethod: CompressionMethod.ZstdWithoutLong,
-        });
-        const url = new URL(cacheEntry.archiveLocation);
-        core.info(`Adding cacheHost: ${url.hostname}:443 to allowed-endpoints`);
-        confg.allowed_endpoints += ` ${url.hostname}:443`;
-      } catch (exception) {
-        // some exception has occurred.
-        core.info("Unable to fetch cacheURL");
-        if (confg.egress_policy === "block") {
-          core.info("Switching egress-policy to audit mode");
-          confg.egress_policy = "audit";
-        }
+    fs.appendFileSync(
+      process.env.GITHUB_STATE,
+      `disableSudo=${confg.disable_sudo}${EOL}`,
+      {
+        encoding: "utf8",
       }
-    }
+    );
+    core.info(`[!] Current Configuration: \n${JSON.stringify(confg)}\n`);
 
     if (confg.egress_policy !== "audit" && confg.egress_policy !== "block") {
       core.setFailed("egress-policy must be either audit or block");
@@ -77,18 +77,107 @@ import {
       core.setFailed("disable-telemetry must be a boolean value");
     }
 
-    if (!confg.disable_telemetry) {
-      let _http = new httpm.HttpClient();
-      _http.requestOptions = { socketTimeout: 3 * 1000 };
+    if (isValidEvent() && confg.egress_policy === "block") {
       try {
-        await _http.get(
-          `${api_url}/github/${process.env["GITHUB_REPOSITORY"]}/actions/runs/${process.env["GITHUB_RUN_ID"]}/monitor`
+        const cacheResult = await cache.saveCache(
+          [path.join(__dirname, "cache.txt")],
+          cacheKey
         );
-      } catch (e) {
-        console.log(`error in connecting to ${api_url}: ${e}`);
+        console.log(cacheResult);
+      } catch (exception) {
+        console.log(exception);
+      }
+      try {
+        const compressionMethod: CompressionMethod =
+          await utils.getCompressionMethod();
+        const cacheFilePath = path.join(__dirname, "cache.txt");
+        core.info(`cacheFilePath ${cacheFilePath}`);
+        const cacheEntry: ArtifactCacheEntry = await getCacheEntry(
+          [cacheKey],
+          [cacheFilePath],
+          {
+            compressionMethod: compressionMethod,
+          }
+        );
+        const url = new URL(cacheEntry.archiveLocation);
+        core.info(`Adding cacheHost: ${url.hostname}:443 to allowed-endpoints`);
+        confg.allowed_endpoints += ` ${url.hostname}:443`;
+      } catch (exception) {
+        // some exception has occurred.
+        core.info(`Unable to fetch cacheURL`);
+        if (confg.egress_policy === "block") {
+          core.info("Switching egress-policy to audit mode");
+          confg.egress_policy = "audit";
+        }
       }
     }
 
+    if (!confg.disable_telemetry || confg.egress_policy === "audit") {
+      common.printInfo(web_url);
+    }
+
+    if (isArcRunner()) {
+      console.log(`[!] ${common.ARC_RUNNER_MESSAGE}`);
+      if (confg.egress_policy === "block") {
+        sendAllowedEndpoints(confg.allowed_endpoints);
+        await sleep(10000);
+      }
+      return;
+    }
+
+    const runnerName = process.env.RUNNER_NAME || "";
+    core.info(`RUNNER_NAME: ${runnerName}`);
+    if (!runnerName.startsWith("GitHub Actions")) {
+      fs.appendFileSync(process.env.GITHUB_STATE, `selfHosted=true${EOL}`, {
+        encoding: "utf8",
+      });
+      if (!fs.existsSync("/home/agent/agent")) {
+        core.info(common.SELF_HOSTED_NO_AGENT_MESSAGE);
+        return;
+      }
+      if (confg.egress_policy === "block") {
+        try {
+          if (process.env.USER) {
+            cp.execSync(`sudo chown -R ${process.env.USER} /home/agent`);
+          }
+          const confgStr = JSON.stringify(confg);
+          fs.writeFileSync("/home/agent/block_event.json", confgStr);
+          await sleep(5000);
+        } catch (error) {
+          core.info(`[!] Unable to write block_event.json: ${error}`);
+        }
+      }
+      return;
+    }
+    //return;
+
+    let statusCode;
+    //_http.requestOptions = { socketTimeout: 3 * 1000 };
+    try {
+      const resp = await axios.get(
+        `${api_url}/github/${process.env["GITHUB_REPOSITORY"]}/actions/runs/${process.env["GITHUB_RUN_ID"]}/monitor`,
+        { timeout: 3000 }
+      );
+
+      statusCode = resp.status; // adding error code to check whether agent is getting installed or not.
+      console.log(`statuscode: ${statusCode}`);
+      fs.appendFileSync(
+        process.env.GITHUB_STATE,
+        `monitorStatusCode=${statusCode}${EOL}`,
+        {
+          encoding: "utf8",
+        }
+      );
+    } catch (e) {
+      console.log(`error in connecting to ${api_url}: ${e}`);
+    }
+    //return;
+    console.log(`Step Security Job Correlation ID: ${correlation_id}`);
+    if (String(statusCode) === common.STATUS_HARDEN_RUNNER_UNAVAILABLE) {
+      console.log(common.HARDEN_RUNNER_UNAVAILABLE_MESSAGE);
+      return;
+    }
+    //return;
     const confgStr = JSON.stringify(confg);
     cp.execSync("sudo mkdir -p /home/agent");
     cp.execSync("sudo chown -R $USER /home/agent");
@@ -98,18 +187,14 @@ import {
     let auth = `token ${token}`;
 
     const downloadPath: string = await tc.downloadTool(
-      "https://github.com/step-security/agent/releases/download/v0.11.0/agent_0.11.0_linux_amd64.tar.gz",
+      "https://github.com/step-security/agent/releases/download/v0.13.5/agent_0.13.5_linux_amd64.tar.gz",
       undefined,
       auth
     );
 
     verifyChecksum(downloadPath); // NOTE: verifying agent's checksum, before extracting
     const extractPath = await tc.extractTar(downloadPath);
-
-    if (!confg.disable_telemetry || confg.egress_policy === "audit") {
-      common.printInfo(web_url);
-    }
-
+    //return;
     let cmd = "cp",
       args = [path.join(extractPath, "agent"), "/home/agent/agent"];
     cp.execFileSync(cmd, args);
@@ -131,6 +216,7 @@ import {
     var statusFile = "/home/agent/agent.status";
     var logFile = "/home/agent/agent.log";
     var counter = 0;
+    await sleep(5000);
     while (true) {
       if (!fs.existsSync(statusFile)) {
         counter++;
@@ -142,6 +228,7 @@ import {
           }
           break;
         }
+        console.log("sleeping");
         await sleep(300);
       } // The file *does* exist
       else {
@@ -154,9 +241,11 @@ import {
   } catch (error) {
     core.setFailed(error.message);
   }
+  console.log("method done");
+  return;
 })();
 
-function sleep(ms) {
+export function sleep(ms) {
   return new Promise((resolve) => {
     setTimeout(resolve, ms);
   });

tsconfig.json

@@ -14,4 +14,4 @@
     "exclude": [
       "src/**/*.test.ts"
     ]
-  }
+  }