update

Update package-lock.json

.github/workflows/canary.yml

@@ -22,14 +22,14 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v1
+    - uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v1
       with:
         egress-policy: audit
         allowed-endpoints:
           api.github.com:443
           github.com:443
 
-    - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v2
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v2
     - name: Update the rc tag
       uses: step-security/publish-action@b438f840875fdcb7d1de4fc3d1d30e86cf6acb5d
       with:
@@ -41,9 +41,3 @@ jobs:
       env:
         PAT: ${{ secrets.PAT }}
         canary: true
-
-    - name: Canary TLS test
-      uses: docker://ghcr.io/step-security/integration-test/int:latest
-      env:
-        PAT: ${{ secrets.PAT }}
-        canary-tls: true

.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@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde
+      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@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@2d790406f505036ef40ecba973cc774a50395aac
+      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@2d790406f505036ef40ecba973cc774a50395aac
+      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@2d790406f505036ef40ecba973cc774a50395aac
+      uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a

.github/workflows/dependency-review.yml

@@ -17,11 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
         with:
           egress-policy: audit
 
       - name: 'Checkout Repository'
-        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@0c155c5e8556a497adf53f2c18edabf945ed8e70 # v4.3.2
+        uses: actions/dependency-review-action@6c5ccdad469c9f8a2996bfecaec55a631a347034 # v3.1.0

.github/workflows/publish-immutable-actions.yml

@@ -1,28 +0,0 @@
-name: 'Publish Immutable Action Version'
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-      packages: write
-
-    steps:
-      - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
-        with:
-          egress-policy: audit
-
-      - name: Checking out
-        uses: actions/checkout@v6
-      - name: Publish
-        id: publish
-        uses: actions/publish-immutable-action@0.0.4

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

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde
+      uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423
       with:
         egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
 
@@ -22,18 +22,3 @@ jobs:
       env:
         PAT: ${{ secrets.PAT }}
         canary: true
-
-  int-tls-tests:
-    name: int tls tests
-    runs-on: ubuntu-latest
-    steps:
-    - name: Harden Runner
-      uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde
-      with:
-        egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
-
-    - name: Canary test
-      uses: docker://ghcr.io/step-security/integration-test/int:latest
-      env:
-        PAT: ${{ secrets.PAT }}
-        canary-tls: true

.github/workflows/release.yml

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

.github/workflows/runs-on.yml

@@ -1,179 +0,0 @@
-name: RunsOn Tests
-
-on: 
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  test-host-outbound:
-    runs-on:
-      - runs-on=${{ github.run_id }}
-      - runner=2cpu-linux-x64
-      - image=ubuntu24-stepsecurity-x64
-    steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@rc
-        with:
-          egress-policy: audit
-          allowed-endpoints: >
-            github.com:443
-            goreleaser.com:443
-            
-
-      - name: Checkout code
-        uses: actions/checkout@v6
-            
-      - name: Run outbound calls from host
-        run: |
-          start_time=$(date +%s)
-          end_time=$((start_time + 90))  # 5 minutes = 300 seconds
-          
-          while [ $(date +%s) -lt $end_time ]; do
-            curl -I https://www.google.com
-            curl -I https://goreleaser.com
-            sleep 10  # wait 10 seconds between calls
-          done
-  
-  test-docker-outbound:
-    runs-on:
-      - runs-on=${{ github.run_id }}
-      - runner=2cpu-linux-x64
-      - image=ubuntu24-stepsecurity-x64
-    steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@rc
-        with:
-          egress-policy: block
-          allowed-endpoints: >
-            archive.ubuntu.com:80
-            github.com:443
-            goreleaser.com:443
-            production.cloudflare.docker.com:443
-            docker-images-prod.6aa30f8b08e16409b46e0173d6de2f56.r2.cloudflarestorage.com:443
-            *.docker.io:443
-            security.ubuntu.com:80
-         
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Run outbound calls from within Docker container
-        continue-on-error: true
-        run: |
-          # Start the container
-          docker run --rm -d --name test-container ubuntu:latest sleep 90
-          
-          # Install curl in the container
-          docker exec test-container apt-get update
-          docker exec test-container apt-get install -y curl
-          
-          # Print /etc/resolv.conf from the container
-          docker exec test-container cat /etc/resolv.conf
-          
-          # Make outbound calls
-          for i in {1..9}; do
-            docker exec test-container curl -I https://www.google.com
-            docker exec test-container curl -I https://goreleaser.com
-            sleep 10  # wait 10 seconds between calls
-          done
-          
-          # Stop the container
-          docker stop test-container
-
-      
-  test-docker-build-outbound:
-    runs-on:
-      - runs-on=${{ github.run_id }}
-      - runner=2cpu-linux-x64
-      - image=ubuntu24-stepsecurity-x64
-    steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@rc
-        with:
-          egress-policy: audit
-          allowed-endpoints: >
-            archive.ubuntu.com:80
-            auth.docker.io:443
-            github.com:443
-            goreleaser.com:443
-            production.cloudflare.docker.com:443
-            docker-images-prod.6aa30f8b08e16409b46e0173d6de2f56.r2.cloudflarestorage.com:443
-            registry-1.docker.io:443
-            security.ubuntu.com:80
-            
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Build Docker image and test outbound calls during build
-        continue-on-error: true
-        run: |
-          # Create a Dockerfile that installs curl and makes outbound calls
-          cat <<EOF > Dockerfile
-          FROM ubuntu:latest
-          RUN apt-get update && apt-get install -y curl
-          RUN for i in {1..9}; do curl -I https://www.google.com && curl -I https://goreleaser.com; sleep 10; done
-          EOF
-          
-          # Build the Docker image
-          docker build -t test-image .
-          
-          # Print /etc/resolv.conf from the build container (temporary container used during build)
-          container_id=$(docker create test-image)
-          docker start $container_id
-          docker exec $container_id cat /etc/resolv.conf
-          docker stop $container_id
-          docker rm $container_id
-
-      - name: Print Docker logs with journalctl
-        run: |
-            sudo journalctl -u docker.service --no-pager 
-        shell: bash
-      
-  test-long-running-docker:
-    runs-on:
-      - runs-on=${{ github.run_id }}
-      - runner=2cpu-linux-x64
-      - image=ubuntu24-stepsecurity-x64
-    steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@rc
-        with:
-          egress-policy: block
-          allowed-endpoints: >
-            archive.ubuntu.com:80
-            auth.docker.io:443
-            github.com:443
-            goreleaser.com:443
-            production.cloudflare.docker.com:443
-            registry-1.docker.io:443
-            docker-images-prod.6aa30f8b08e16409b46e0173d6de2f56.r2.cloudflarestorage.com:443
-            security.ubuntu.com:80
-            
-
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Run long-running Docker container with outbound calls
-        continue-on-error: true
-        run: |
-          # Start the long-running container
-          docker run --rm -d --name long-running-container ubuntu:latest bash -c "
-            apt-get update && apt-get install -y curl && 
-            while true; do 
-              curl -I https://www.google.com; 
-              curl -I https://goreleaser.com; 
-              sleep 10; 
-            done
-          "
-          
-          # Print /etc/resolv.conf from the container
-          docker exec long-running-container cat /etc/resolv.conf
-          
-          # Let the container run for 5 minutes
-          sleep 90
-          
-          # Stop the container
-          docker stop long-running-container
-     
-      

.github/workflows/scorecards.yml

@@ -25,17 +25,17 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
         with:
           egress-policy: audit
 
       - name: "Checkout code"
-        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # tag=v3.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # tag=v3.0.0
         with:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # tag=v1.1.1
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # tag=v1.1.1
         with:
           results_file: results.sarif
           results_format: sarif
@@ -54,7 +54,7 @@ jobs:
       # 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@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # tag=v4.6.1
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # tag=v3.0.0
         with:
           name: SARIF file
           path: results.sarif
@@ -62,6 +62,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@2d790406f505036ef40ecba973cc774a50395aac # tag=v1.0.26
+        uses: github/codeql-action/upload-sarif@cdcdbb579706841c47f7063dda365e292e5cad7a # tag=v1.0.26
         with:
           sarif_file: results.sarif

.github/workflows/test.yml

@@ -13,13 +13,10 @@ concurrency:
   group: ${{ github.workflow }}
 jobs:
   test:
-    permissions:
-      checks: write
-      pull-requests: write
     runs-on: ubuntu-latest
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
         with:
           disable-sudo: true
           egress-policy: audit
@@ -32,44 +29,9 @@ jobs:
             uploader.codecov.io:443
 
       - name: Checkout
-        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        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
-      - name: Publish Test Results
-        uses: step-security/publish-unit-test-result-action@e88bfc6c0dffc68a1067d63526c80c81f248da11 # v2.20.0
-        if: always()
-        with:
-          files: |
-            reports/*.xml
-
-  build-check:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Harden Runner
-        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
-        with:
-          disable-sudo: true
-          egress-policy: audit
-          allowed-endpoints: >
-            github.com:443
-            registry.npmjs.org:443
-
-      - name: Checkout
-        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
-      - name: Install Dependencies
-        run: npm ci
-      - name: Run build
-        run: npm run build
-      - name: Check for changes in dist
-        run: |
-          if [[ `git status --porcelain dist` ]]; then
-            echo "Changes detected in dist directory after build:"
-            git status --porcelain dist
-            git diff dist
-            exit 1
-          else
-            echo "No changes in dist directory - build is clean"
-          fi

.gitignore

@@ -20,7 +20,6 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
-reports
 *.lcov
 
 # nyc test coverage

README.md

@@ -1,7 +1,7 @@
 <p align="center">
 <picture>
-  <source media="(prefers-color-scheme: light)" srcset="images/harden-runner-new.png" width="400">
-  <img alt="Dark Banner" src="images/harden-runner-new.png" width="400">
+  <source media="(prefers-color-scheme: light)" srcset="images/banner.png" width="400">
+  <img alt="Dark Banner" src="images/banner-dark.png" width="400">
 </picture>
 </p>
 
@@ -13,181 +13,221 @@
 
 </div>
 
-# Harden-Runner
+## GitHub Actions Runtime Security
 
-Corporate laptops and production servers typically have robust security monitoring in place to reduce risk and meet compliance requirements. However, CI/CD runners, which handle sensitive information like secrets for cloud environments and create production builds, often lack such security measures. This oversight has led to significant supply chain attacks, including the SolarWinds and Codecov breaches.
+Harden-Runner provides runtime security for GitHub-hosted and self-hosted environments.
 
-Traditional security monitoring and EDR solutions are ineffective for CI/CD runners due to their ephemeral nature. These tools also lack the necessary context to correlate events with specific workflow runs in a CI/CD environment.
+For self-hosted environments, Harden-Runner supports:
 
-StepSecurity Harden-Runner addresses this gap by providing security monitoring tailored for CI/CD runners. This approach brings CI/CD runners under the same level of security scrutiny as other critical systems, addressing a significant gap in the software supply chain.
-### Harden-Runner: Security Incidents Detected
+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 Detected the tj-actions/changed-files compromise](https://www.stepsecurity.io/blog/harden-runner-detection-tj-actions-changed-files-action-is-compromised) ([CVE-2025-30066](https://github.com/advisories/GHSA-mrrh-fwg8-r2c3))
-- [Harden-Runner Detected a CI/CD Supply Chain Attack in Google’s Open-Source Project Flank](https://www.stepsecurity.io/case-studies/flank)
-- [Harden-Runner Detected the NX Build System compromise](https://www.stepsecurity.io/blog/supply-chain-security-alert-popular-nx-build-system-package-compromised-with-data-stealing-malware)
-- [Harden-Runner Detected a 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)
-- [Harden-Runner Detected Anomalous Traffic to api.ipify.org Across Multiple Customers](https://www.stepsecurity.io/blog/harden-runner-detects-anomalous-traffic-to-api-ipify-org-across-multiple-customers)  
-- [Harden-Runner Detected an Unexpected Microsoft Defender Installation on GitHub-Hosted Ubuntu Runners](https://www.stepsecurity.io/blog/how-stepsecurity-harden-runner-detected-unexpected-microsoft-defender-installation-on-github-hosted-ubuntu-runners)
-- [Harden-Runner Flagged an Anomalous Outbound Call, Leading to a Docker Documentation Update](https://www.stepsecurity.io/blog/harden-runner-flags-anomalous-outbound-call-leading-to-docker-documentation-update)
+[![Harden Runner Demo](images/RuntimeSecurityDemo.gif)](https://youtu.be/fpdwX5hYACo)
 
-### See It in Action
-Harden-Runner secures over **8 million CI/CD workflow runs every week**, protecting thousands of pipelines, including those from popular open-source projects by **Microsoft, Google, and CISA**. See how top projects are using Harden-Runner and explore the insights:  
-➡️ [Who's using Harden-Runner?](https://docs.stepsecurity.io/whos-using-harden-runner)
+## Explore open source projects using Harden-Runner
 
-## 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)
-- [Environment Compatibility Matrix](#environment-compatibility-matrix)
-- [How It Works](docs/how-it-works.md)
-- [Known Limitations](docs/limitations.md)
-- [Join the Discussions](#discussions)
-- [Official Documentation](https://docs.stepsecurity.io/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
 
-## Introduction
+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.
 
-Learn how Harden-Runner works through the video below, which shows how it detected the tj-actions/changed-files compromise.  [View the interactive demo here](https://app.storylane.io/share/679y2zgzljov).
+Hands-on Tutorials for GitHub Actions Runtime Security:
 
-<a href="https://www.youtube.com/watch?v=oTAJ7Hy7nPU" target="_blank">
-  <img src="images/case-study.png" alt="Harden-Runner detected the tj-actions/changed-files Breach" title="This case study video shows how StepSecurity Harden-Runner detected the tj-actions/changed-files Breach">
-</a>
+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)
 
----
-## Getting Started
+## Why
 
-This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows. For more details, refer to the [official documentation](https://docs.stepsecurity.io/harden-runner).
+Compromised workflows, dependencies, and build tools typically make outbound calls to exfiltrate credentials, or may tamper source code, dependencies, or artifacts during the build.
 
-### **Step 1: Add Harden-Runner to Your Workflow**
+Harden-Runner monitors process, file, and network activity to:
 
-To integrate Harden-Runner, follow these steps:
+|     | 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
+
+### GitHub-Hosted Runners
+
+1. Add `step-security/harden-runner` GitHub Action to your GitHub Actions workflow file as the first step in each job.
 
-- Open your GitHub Actions workflow file (e.g., `.github/workflows/<workflow-name>.yml`).
-- Add the following code as the first step in each job:
    ```yaml
    steps:
-     - name: Harden Runner
-       uses: step-security/harden-runner@c6295a65d1254861815972266d5933fd6e532bdf # v2.11.1
+     - uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
        with:
          egress-policy: audit
+   ```
 
-**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secure-workflow)
-<details>
-<summary>Click to view the full Getting Started Guide</summary>
+2. In the workflow logs and the job markdown summary, you will see a link to security insights and recommendations.
 
-### **Step 2: Access Security Insights**
-
-Run your workflow. Once completed:
-- Review the **workflow logs** and the **job markdown summary**.
-- Look for a link to **security insights and recommendations**.
-  <p align="left">
-      <img src="images/buildlog1.png" alt="Link in workflow log" >
-    </p>
-- Click on the provided link (e.g., [example link](https://app.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.
-     <p align="left">
-      <img src="images/network-events.png" alt="Link in network events" >
+    <p align="left">
+      <img src="images/buildlog1.png" alt="Link in build log" >
     </p>
 
-</details>
+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.
 
----
-## Why Choose Harden-Runner?
+    <p align="left">
+      <img src="images/insights-5.png" alt="Insights from harden-runner" >
+    </p>
 
-- **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.
+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="images/rec-policy1.png" alt="Policy recommended by harden-runner" >
+    </p>
 
----
+### Self-Hosted Actions Runner Controller (ARC) Runners
 
-## Features
+> 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).
 
-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).
+Actions Runner Controller (ARC) is a Kubernetes operator that orchestrates and scales self-hosted runners for GitHub Actions.
 
-### Community (Free)
+- 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.
 
-- **CI/CD-Aware Event Correlation:** Each outbound network connection, file operation, and process execution is mapped to the exact step, job, and workflow where it occurs.
-- **Automated Baseline Creation:** Harden-Runner builds a baseline for each job based on past outbound network connections.
-- **Anomaly Detection:** Once the baseline is created, any future outbound calls not in the baseline trigger a detection.
-- **Block Network Egress Traffic with Domain Allowlist:** Optionally use the automatically created baseline to control outbound network traffic by specifying allowed domains, preventing unauthorized data exfiltration.
-- **Detect Modification of Source Code:** Monitor and alert on unauthorized changes to your source code during the CI/CD pipeline.
+### Self-Hosted VM Runners (e.g. on EC2)
 
-### Enterprise (Paid)
+> Explore demo workflows using self-hosted VM Runners and Harden-Runner [here](https://docs.stepsecurity.io/harden-runner/how-tos/enable-runtime-security-vm).
 
-Includes all features in the **Community** tier, plus:
+- 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 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.
-- **GitHub Checks Integration:** Enable GitHub Checks for Harden-Runner—if the baseline remains unchanged, the check passes; if it changes, the check fails, showing new outbound connections.
-- **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.
+## Support for Self-Hosted Runners and Private Repositories
 
-For a detailed comparison and more information, please visit our [Pricing Page](https://www.stepsecurity.io/pricing).
+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.
 
-Explore the full feature set in the [Features Documentation](https://docs.stepsecurity.io/harden-runner).
+- 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.
 
----
+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.
 
-## Trusted By and Case Studies
+## Features at a glance
 
-Harden-Runner is trusted by over 8000 leading open-source projects and enterprises, including Microsoft, Google, Kubernetes, and more.
+For details, check out the documentation at https://docs.stepsecurity.io
 
-### Trusted by
+### 👀 Monitor egress traffic
 
+> Applies to both GitHub-hosted and self-hosted runners
 
-| [![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**<br>[Explore](https://app.stepsecurity.io/github/cisagov/skeleton-generic/actions/runs/9947319332?jobid=27479776091&tab=network-events)                                                | **Microsoft**<br>[Explore](https://app.stepsecurity.io/github/microsoft/ebpf-for-windows/actions/runs/7587031851)                                               | **Google**<br>[Explore](https://app.stepsecurity.io/github/GoogleCloudPlatform/functions-framework-ruby/actions/runs/7576989995)                                               | **DataDog**<br>[Explore](https://app.stepsecurity.io/github/DataDog/stratus-red-team/actions/runs/7446169664)                                              | **Intel**<br>[Explore](https://app.stepsecurity.io/github/intel/cve-bin-tool/actions/runs/7590975903)                                                | **Kubernetes**<br>[Explore](https://app.stepsecurity.io/github/kubernetes-sigs/cluster-api-provider-azure/actions/runs/7591172950)                                                | **Node.js**<br>[Explore](https://app.stepsecurity.io/github/nodejs/node/actions/runs/7591405720)                                               | **AWS**<br>[Explore](https://app.stepsecurity.io/github/aws/aperf/actions/runs/7631366761)                                               |
+Harden-Runner monitors all outbound traffic from each job at the DNS and network layers
 
-### Enterprise Case Studies
+- 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
 
-- [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)
-- [Chainguard Secures GitHub Actions with StepSecurity](https://www.stepsecurity.io/case-studies/chainguard)
-- [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)
+### 🚦 Filter egress traffic to allowed endpoints
 
----
+> Applies to both GitHub-hosted and self-hosted runners
 
-## Environment Compatibility Matrix
+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 is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. For self-hosted runners, audit mode is deployed directly to the runner infrastructure without requiring any changes to your existing workflows. For more details, refer to the [official documentation](https://docs.stepsecurity.io/harden-runner).
+- 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`
 
-| Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode |
-|------------------|---------------|--------------------------|-------------------|
-| GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes |
-| Self-hosted VM runners | ✅ Full support | Include agent in runner image | No |
-| Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No |
-| Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No |
-| RunsOn Runners | ✅ Full support | Pre-integrated | No |
+<p align="left">
+  <img src="images/blocked-outbound-call-2.png" alt="Policy recommended by harden-runner" >
+</p>
 
-## How It Works
+### 🤖 Select GitHub Actions with Confidence
 
-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).
+> Applies to both GitHub-hosted and self-hosted runners
 
----
+Before integrating a GitHub Action into your workflow, evaluate its network activity.
 
-## Limitations
+- 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
 
-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).
+<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
 
-Join the conversation! For questions, ideas, or feedback, visit our [Discussions Page](https://github.com/step-security/harden-runner/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
 
-For enterprise support, email support@stepsecurity.io. Interested in using Harden-Runner in other CI/CD platforms? Reach out to interest@stepsecurity.io.
+## How does it work?
 
----
+### GitHub-Hosted Runners
 
-## License
+For GitHub-hosted runners, Harden-Runner GitHub Action downloads and installs the StepSecurity Agent.
 
-Harden-Runner is open source. See the [LICENSE](LICENSE) file for details.
+- 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.
+
+### 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

@@ -17,11 +17,7 @@ inputs:
     required: false
     default: "false"
   disable-sudo:
-    description: "Disable sudo access for the runner account. Note: This parameter will be deprecated in the future. Please use disable-sudo-and-containers instead."
-    required: false
-    default: "false"
-  disable-sudo-and-containers:
-    description: "Disable sudo and container access for the runner account"
+    description: "Disable sudo access for the runner account"
     required: false
     default: "false"
   disable-file-monitoring:

docs/how-it-works.md

@@ -1,21 +0,0 @@
-## 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.

docs/limitations.md

@@ -1,14 +0,0 @@
-## 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) with built-in labels such as `ubuntu-latest`, as it needs sudo access on the Ubuntu VM to run. The limitation is if the entire job is run in a container. However, such jobs can be monitored when using custom VM images with GitHub-hosted runners. This is also 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 (e.g. on EC2) and Bare-metal Runners 
-
-* Only Linux jobs are supported. Windows and MacOS jobs are not supported.

jest.config.ts

@@ -1,9 +1,5 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 export default {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  reporters: [
-    "default",
-    ["jest-junit", { outputDirectory: "reports", outputName: "report.xml" }],
-  ],
+  preset: 'ts-jest',
+  testEnvironment: 'node',
 };

osv-scanner.toml

@@ -1,11 +0,0 @@
-[[IgnoredVulns]]
-id = "GHSA-h5c3-5r3r-rr8q"
-reason = "Untrusted headers are not processed"
-
-[[IgnoredVulns]]
-id = "GHSA-rmvr-2pp2-xj38"
-reason = "Untrusted headers are not processed"
-
-[[IgnoredVulns]]
-id = "GHSA-xx4v-prfh-6cgc"
-reason = "Untrusted headers are not processed"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "step-security-harden-runner",
-  "version": "2.7.0",
+  "version": "2.6.1",
   "description": "Security agent for GitHub-hosted runner: block egress traffic & detect code overwrite to prevent breaches",
   "main": "index.js",
   "scripts": {
@@ -23,31 +23,30 @@
   },
   "homepage": "https://github.com/step-security/harden-runner#readme",
   "dependencies": {
-    "@actions/cache": "^4.0.0",
+    "@actions/cache": "^3.1.4",
     "@actions/core": "^1.5.0",
     "@actions/exec": "^1.1.0",
-    "@actions/github": "^6.0.1",
-    "@actions/http-client": "^2.0.1",
-    "@actions/tool-cache": "^1.7.1",
-    "@babel/helpers": "^7.26.10",
+    "@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.5.2",
-    "@types/node": "^16.9.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.3",
-    "eslint": "^7.32.0",
+    "@vercel/ncc": "0.38.0",
+    "eslint": "^8.53.0",
     "eslint-config-google": "^0.14.0",
     "jest": "^29.3.1",
     "jest-junit": ">=13.0.0",
     "nock": "^13.3.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
-    "typescript": "^4.3.5"
+    "typescript": "^5.2.2"
   }
 }

src/arc-runner.test.ts

@@ -1,9 +1,20 @@
-import { isARCRunner } from "./arc-runner";
+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();
+  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

@@ -1,8 +1,8 @@
 import * as cp from "child_process";
 import * as fs from "fs";
-import path from "path";
+import { sleep } from "./setup";
 
-export function isARCRunner(): boolean {
+export function isArcRunner(): boolean {
   const runnerUserAgent = process.env["GITHUB_ACTIONS_RUNNER_EXTRA_USER_AGENT"];
 
   let isARC = false;
@@ -18,40 +18,45 @@ export function isARCRunner(): boolean {
 
 function isSecondaryPod(): boolean {
   const workDir = "/__w";
-  let hasKubeEnv = process.env["KUBERNETES_PORT"] !== undefined;
-  return fs.existsSync(workDir) && hasKubeEnv;
+  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 startTime = Date.now();
   const allowedEndpoints = endpoints.split(" "); // endpoints are space separated
 
-  let sent = 0;
-  for (let endpoint of allowedEndpoints) {
-    endpoint = endpoint.trim();
-    if (endpoint.length > 0) {
-      let encodedEndpoint = Buffer.from(endpoint).toString("base64");
-      let endpointPolicyStr = `step_policy_endpoint_${encodedEndpoint}`;
-      echo(endpointPolicyStr);
-      sent++;
+  for (const endpoint of allowedEndpoints) {
+    if (endpoint) {
+      const encodedEndpoint = Buffer.from(endpoint).toString("base64");
+      cp.execSync(
+        `echo "${endpoint}" > "${getRunnerTempDir()}/step_policy_endpoint_${encodedEndpoint}"`
+      );
     }
   }
 
-  if (sent > 0) {
-    applyPolicy(sent);
+  if (allowedEndpoints.length > 0) {
+    applyPolicy(allowedEndpoints.length);
   }
-
-  const duration = Date.now() - startTime;
-  console.log(
-    `[harden-runner] sendAllowedEndpoints completed in ${duration}ms (sent ${sent} endpoints)`
-  );
 }
 
 function applyPolicy(count: number): void {
-  let applyPolicyStr = `step_policy_apply_${count}`;
-  echo(applyPolicyStr);
+  const fileName = `step_policy_apply_${count}`;
+  cp.execSync(`echo "${fileName}" > "${getRunnerTempDir()}/${fileName}"`);
 }
 
-function echo(content: string) {
-  cp.execFileSync("echo", [content]);
+export function removeStepPolicyFiles() {
+  cp.execSync(`rm ${getRunnerTempDir()}/step_policy_*`);
+}
+
+export function arcCleanUp() {
+  cp.execSync(`echo "cleanup" > "${getRunnerTempDir()}/step_policy_cleanup"`);
 }

src/checksum.ts

@@ -2,34 +2,15 @@ import * as core from "@actions/core";
 import * as crypto from "crypto";
 import * as fs from "fs";
 
-const CHECKSUMS = {
-  tls: {
-    amd64: "603d6a0dabb60a7c8f651d7f5b53258fa64162424a77da9884d9032b3e71d6b1", // v1.7.6
-    arm64: "fdc7504a3210dc67fc8393969b0f3c98df593c7884c83ed6d1c0ec84070801aa",
-  },
-  non_tls: {
-    amd64: "336093af8ebe969567b66fd035af3bd4f7e1c723ce680d6b4b5b2a1f79bc329e", // v0.14.2
-  },
-};
-
-export function verifyChecksum(
-  downloadPath: string,
-  isTLS: boolean,
-  variant: string
-) {
+export function verifyChecksum(downloadPath: string) {
   const fileBuffer: Buffer = fs.readFileSync(downloadPath);
   const checksum: string = crypto
     .createHash("sha256")
     .update(fileBuffer)
     .digest("hex"); // checksum of downloaded file
 
-  let expectedChecksum: string = "";
-
-  if (isTLS) {
-    expectedChecksum = CHECKSUMS["tls"][variant];
-  } else {
-    expectedChecksum = CHECKSUMS["non_tls"][variant];
-  }
+  const expectedChecksum: string =
+    "ceb925c78e5c79af4f344f08f59bbdcf3376d20d15930a315f9b24b6c4d0328a"; // checksum for v0.13.5
 
   if (checksum !== expectedChecksum) {
     core.setFailed(

src/cleanup.ts

@@ -2,22 +2,22 @@ import * as fs from "fs";
 import * as cp from "child_process";
 import * as common from "./common";
 import isDocker from "is-docker";
-import { isARCRunner } from "./arc-runner";
-import { isGithubHosted } from "./tls-inspect";
-(async () => {
-  console.log("[harden-runner] post-step");
+import { arcCleanUp, isArcRunner, removeStepPolicyFiles } from "./arc-runner";
 
+(async () => {
   if (process.platform !== "linux") {
     console.log(common.UBUNTU_MESSAGE);
     return;
   }
-  if (isGithubHosted() && isDocker()) {
+  if (isDocker()) {
     console.log(common.CONTAINER_MESSAGE);
     return;
   }
 
-  if (isARCRunner()) {
+  if (isArcRunner()) {
     console.log(`[!] ${common.ARC_RUNNER_MESSAGE}`);
+    arcCleanUp();
+    removeStepPolicyFiles();
     return;
   }
 
@@ -25,14 +25,6 @@ import { isGithubHosted } from "./tls-inspect";
     return;
   }
 
-  if (process.env.STATE_customVMImage === "true") {
-    return;
-  }
-
-  if (process.env.STATE_isTLS === "false" && process.arch === "arm64") {
-    return;
-  }
-
   if (
     String(process.env.STATE_monitorStatusCode) ===
     common.STATUS_HARDEN_RUNNER_UNAVAILABLE
@@ -70,13 +62,6 @@ import { isGithubHosted } from "./tls-inspect";
     console.log(content);
   }
 
-  const daemonLog = "/home/agent/daemon.log";
-  if (fs.existsSync(daemonLog)) {
-    console.log("daemonLog:");
-    var content = fs.readFileSync(daemonLog, "utf-8");
-    console.log(content);
-  }
-
   var status = "/home/agent/agent.status";
   if (fs.existsSync(status)) {
     console.log("status:");
@@ -85,22 +70,12 @@ import { isGithubHosted } from "./tls-inspect";
   }
 
   var disable_sudo = process.env.STATE_disableSudo;
-  var disable_sudo_and_containers = process.env.STATE_disableSudoAndContainers;
-
-  if (disable_sudo !== "true" && disable_sudo_and_containers !== "true") {
-    try {
-      var journalLog = cp.execSync(
-        "sudo journalctl -u agent.service --lines=1000",
-        {
-          encoding: "utf8",
-          maxBuffer: 1024 * 1024 * 10, // 10MB buffer
-        }
-      );
-      console.log("agent.service log:");
-      console.log(journalLog);
-    } catch (error) {
-      console.log("Warning: Could not fetch service logs:", error.message);
-    }
+  if (disable_sudo !== "true") {
+    var journalLog = cp.execSync("sudo journalctl -u agent.service", {
+      encoding: "utf8",
+    });
+    console.log("Service log:");
+    console.log(journalLog);
   }
 
   try {

src/common.ts

@@ -1,6 +1,5 @@
 import * as core from "@actions/core";
 import * as fs from "fs";
-import { STEPSECURITY_API_URL, STEPSECURITY_WEB_URL } from "./configs";
 
 export function printInfo(web_url) {
   console.log(
@@ -35,15 +34,8 @@ export const processLogLine = (
     if (matches) {
       const [ipAddress, domain, pid, process] = matches.slice(1);
 
-      // Check if all values are non-empty and domain does not end with specified patterns
-      if (
-        pid &&
-        process &&
-        domain &&
-        ipAddress &&
-        !domain.endsWith(".actions.githubusercontent.com.") &&
-        !domain.endsWith(".blob.core.windows.net.")
-      ) {
+      // Check if all values are non-empty
+      if (pid && process && domain && ipAddress) {
         const status = ipAddress.startsWith("54.185.253.63")
           ? "❌ Blocked"
           : "✅ Allowed";
@@ -55,16 +47,18 @@ export const processLogLine = (
 };
 
 export async function addSummary() {
-  if (process.env.STATE_addSummary !== "true") {
+  if (process.env.STATE_monitorStatusCode !== "200") {
     return;
   }
 
-  const correlation_id = process.env.STATE_correlation_id;
-  if (!correlation_id) {
+  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");
@@ -94,51 +88,88 @@ export async function addSummary() {
     return;
   }
 
-  // Extract owner and repo from GITHUB_REPOSITORY (format: owner/repo)
-  const [owner, repo] = process.env["GITHUB_REPOSITORY"]?.split("/") || [];
-  const run_id = process.env["GITHUB_RUN_ID"];
-  
-  if (!owner || !repo || !run_id || !correlation_id) {
+  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;
   }
 
-  // Fetch job summary from API
-  const apiUrl = `${STEPSECURITY_API_URL}/github/${owner}/${repo}/actions/runs/${run_id}/correlation/${correlation_id}/job-markdown-summary`;
-  
-  try {
-    const response = await fetch(apiUrl);
-    if (!response.ok) {
-      console.error(`Failed to fetch job summary: ${response.status} ${response.statusText}`);
-      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;
     }
-    
-    const markdownSummary = await response.text();
-    
-    // Render the markdown summary using core.summary.addRaw
-    await core.summary.addRaw(markdownSummary).write();
-    return;
-  } catch (error) {
-    console.error(`Error fetching job summary: ${error}`);
-    return;
-  }
+  });
+
+  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. Such jobs can be monitored by installing Harden Runner in a custom VM image for GitHub-hosted runners.";
+  "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_RUNNER_MESSAGE =
-  "This job is running on a self-hosted runner.";
+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.";
-
-export const ARM64_RUNNER_MESSAGE =
-  "ARM runners are not supported in the Harden-Runner community tier.";
+  "Workflow is currently being executed in ARC based runner";

src/configs.ts

@@ -1,5 +0,0 @@
-export const STEPSECURITY_ENV = "agent"; // agent or int
-
-export const STEPSECURITY_API_URL = `https://${STEPSECURITY_ENV}.api.stepsecurity.io/v1`;
-
-export const STEPSECURITY_WEB_URL = "https://app.stepsecurity.io";

src/index.ts

@@ -1,16 +1,13 @@
 import * as common from "./common";
 import * as core from "@actions/core";
 import isDocker from "is-docker";
-import { STEPSECURITY_WEB_URL } from "./configs";
-import { isGithubHosted } from "./tls-inspect";
-(async () => {
-  console.log("[harden-runner] main-step");
 
+(async () => {
   if (process.platform !== "linux") {
     console.log(common.UBUNTU_MESSAGE);
     return;
   }
-  if (isGithubHosted() && isDocker()) {
+  if (isDocker()) {
     console.log(common.CONTAINER_MESSAGE);
     return;
   }
@@ -23,10 +20,6 @@ import { isGithubHosted } from "./tls-inspect";
     return;
   }
 
-  if (process.env.STATE_isTLS === "false" && process.arch === "arm64") {
-    return;
-  }
-
   if (
     core.getBooleanInput("disable-telemetry") &&
     core.getInput("egress-policy") === "block"
@@ -35,7 +28,7 @@ import { isGithubHosted } from "./tls-inspect";
       "Telemetry will not be sent to StepSecurity API as disable-telemetry is set to true"
     );
   } else {
-    var web_url = STEPSECURITY_WEB_URL;
+    var web_url = "https://app.stepsecurity.io";
     common.printInfo(web_url);
   }
 })();

src/install-agent.ts

@@ -1,67 +0,0 @@
-import * as tc from "@actions/tool-cache";
-import * as core from "@actions/core";
-import * as cp from "child_process";
-import * as path from "path";
-import * as fs from "fs";
-import { verifyChecksum } from "./checksum";
-import { EOL } from "os";
-import { ARM64_RUNNER_MESSAGE } from "./common";
-
-export async function installAgent(
-  isTLS: boolean,
-  configStr: string
-): Promise<boolean> {
-  // Note: to avoid github rate limiting
-  const token = core.getInput("token", { required: true });
-  const auth = `token ${token}`;
-
-  const variant = process.arch === "x64" ? "amd64" : "arm64";
-
-  let downloadPath: string;
-
-  fs.appendFileSync(process.env.GITHUB_STATE, `isTLS=${isTLS}${EOL}`, {
-    encoding: "utf8",
-  });
-
-  if (isTLS) {
-    downloadPath = await tc.downloadTool(
-      `https://github.com/step-security/agent-ebpf/releases/download/v1.7.6/harden-runner_1.7.6_linux_${variant}.tar.gz`,
-      undefined,
-      auth
-    );
-  } else {
-    if (variant === "arm64") {
-      console.log(ARM64_RUNNER_MESSAGE);
-      return false;
-    }
-    downloadPath = await tc.downloadTool(
-      "https://github.com/step-security/agent/releases/download/v0.14.2/agent_0.14.2_linux_amd64.tar.gz",
-      undefined,
-      auth
-    );
-  }
-
-  verifyChecksum(downloadPath, isTLS, variant);
-
-  const extractPath = await tc.extractTar(downloadPath);
-
-  let cmd = "cp",
-    args = [path.join(extractPath, "agent"), "/home/agent/agent"];
-
-  cp.execFileSync(cmd, args);
-
-  cp.execSync("chmod +x /home/agent/agent");
-
-  fs.writeFileSync("/home/agent/agent.json", configStr);
-
-  cmd = "sudo";
-  args = [
-    "cp",
-    path.join(__dirname, "agent.service"),
-    "/etc/systemd/system/agent.service",
-  ];
-  cp.execFileSync(cmd, args);
-  cp.execSync("sudo systemctl daemon-reload");
-  cp.execSync("sudo service agent start", { timeout: 15000 });
-  return true;
-}

src/interfaces.ts

@@ -8,12 +8,8 @@ export interface Configuration {
   egress_policy: string;
   disable_telemetry: boolean;
   disable_sudo: boolean;
-  disable_sudo_and_containers: boolean;
   disable_file_monitoring: boolean;
-  is_github_hosted: boolean;
   private: string;
-  is_debug: boolean;
-  one_time_key: string;
 }
 
 export interface PolicyResponse {
@@ -21,7 +17,6 @@ export interface PolicyResponse {
   policyName?: string;
   allowed_endpoints?: string[];
   disable_sudo?: boolean;
-  disable_sudo_and_containers?: boolean;
   disable_file_monitoring?: boolean;
   disable_telemetry?: boolean;
   egress_policy?: string;

src/policy-utils.test.ts

@@ -1,7 +1,6 @@
 import nock from "nock";
-import { fetchPolicy, mergeConfigs } from "./policy-utils";
+import { API_ENDPOINT, fetchPolicy, mergeConfigs } from "./policy-utils";
 import { Configuration, PolicyResponse } from "./interfaces";
-import { STEPSECURITY_API_URL } from "./configs";
 
 test("success: fetching policy", async () => {
   let owner = "h0x0er";
@@ -15,7 +14,7 @@ test("success: fetching policy", async () => {
     disable_sudo: false,
     disable_file_monitoring: false,
   };
-  const policyScope = nock(`${STEPSECURITY_API_URL}`)
+  const policyScope = nock(`${API_ENDPOINT}`)
     .get(`/github/${owner}/actions/policies/${policyName}`)
     .reply(200, response);
 
@@ -36,12 +35,8 @@ test("merge configs", async () => {
     egress_policy: "audit",
     disable_telemetry: false,
     disable_sudo: false,
-    disable_sudo_and_containers: false,
     disable_file_monitoring: false,
     private: "true",
-    is_github_hosted: true,
-    is_debug: false,
-    one_time_key: "",
   };
   let policyResponse: PolicyResponse = {
     owner: "h0x0er",
@@ -63,12 +58,8 @@ test("merge configs", async () => {
     egress_policy: "audit",
     disable_telemetry: false,
     disable_sudo: false,
-    disable_sudo_and_containers: false,
     disable_file_monitoring: false,
     private: "true",
-    is_github_hosted: true,
-    is_debug: false,
-    one_time_key: "",
   };
 
   localConfig = mergeConfigs(localConfig, policyResponse);

src/policy-utils.ts

@@ -1,17 +1,19 @@
 import { HttpClient } from "@actions/http-client";
 import { PolicyResponse, Configuration } from "./interfaces";
-import { STEPSECURITY_API_URL } from "./configs";
+
+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 = `${STEPSECURITY_API_URL}/github/${owner}/actions/policies/${policyName}`;
+  let policyEndpoint = `${API_ENDPOINT}/github/${owner}/actions/policies/${policyName}`;
 
   let httpClient = new HttpClient();
 
@@ -23,29 +25,24 @@ export async function fetchPolicy(
   let err = undefined;
 
   let retry = 0;
-  while (retry < 3) {
-    try {
-      console.log(`Attempt: ${retry + 1}`);
+  while(retry < 3){
+    try{
+      console.log(`Attempt: ${retry+1}`)
       response = await httpClient.getJson<PolicyResponse>(
         policyEndpoint,
         headers
       );
       break;
-    } catch (e) {
-      err = e;
+    }catch(e){
+      err = e
     }
-    retry += 1;
+    retry += 1
     await sleep(1000);
   }
 
-  if (response === undefined && err !== undefined) {
-    // Preserve the original error's statusCode if it exists
-    const error = new Error(`[Policy Fetch] ${err}`);
-    if (err.statusCode !== undefined) {
-      (error as any).statusCode = err.statusCode;
-    }
-    throw error;
-  } else {
+  if(response === undefined && err !== undefined){
+    throw new Error(`[Policy Fetch] ${err}`)
+  }else{
     return response.result;
   }
 }
@@ -61,10 +58,6 @@ export function mergeConfigs(
     localConfig.disable_sudo = remoteConfig.disable_sudo;
   }
 
-  if (remoteConfig.disable_sudo_and_containers !== undefined) {
-    localConfig.disable_sudo_and_containers = remoteConfig.disable_sudo_and_containers;
-  }
-
   if (remoteConfig.disable_file_monitoring !== undefined) {
     localConfig.disable_file_monitoring = remoteConfig.disable_file_monitoring;
   }
@@ -75,7 +68,7 @@ export function mergeConfigs(
   return localConfig;
 }
 
-function sleep(ms: number) {
+function sleep(ms) {
   return new Promise((resolve) => {
     setTimeout(resolve, ms);
   });

src/setup.ts

@@ -1,10 +1,12 @@
 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";
@@ -19,38 +21,24 @@ 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 cacheTwirpClient from "@actions/cache/lib/internal/shared/cacheTwirpClient";
-import { GetCacheEntryDownloadURLRequest } from "@actions/cache/lib/generated/results/api/v1/cache";
-import { getCacheServiceVersion } from "@actions/cache/lib/internal/config";
-
 import * as utils from "@actions/cache/lib/internal/cacheUtils";
-import { isARCRunner, sendAllowedEndpoints } from "./arc-runner";
-import { STEPSECURITY_API_URL, STEPSECURITY_WEB_URL } from "./configs";
-import { isGithubHosted, isTLSEnabled } from "./tls-inspect";
-import { installAgent } from "./install-agent";
-
-interface MonitorResponse {
-  runner_ip_address?: string;
-  one_time_key?: string;
-  monitoring_started?: boolean;
-}
+import { isArcRunner, sendAllowedEndpoints } from "./arc-runner";
 
 (async () => {
   try {
-    console.log("[harden-runner] pre-step");
-
     if (process.platform !== "linux") {
       console.log(common.UBUNTU_MESSAGE);
       return;
     }
-    if (isGithubHosted() && isDocker()) {
+    if (isDocker()) {
       console.log(common.CONTAINER_MESSAGE);
       return;
     }
 
     var correlation_id = uuidv4();
-    var api_url = STEPSECURITY_API_URL;
-    var web_url = STEPSECURITY_WEB_URL;
+    var env = "agent";
+    var api_url = `https://${env}.api.stepsecurity.io/v1`;
+    var web_url = "https://app.stepsecurity.io";
 
     let confg: Configuration = {
       repo: process.env["GITHUB_REPOSITORY"],
@@ -62,43 +50,10 @@ interface MonitorResponse {
       egress_policy: core.getInput("egress-policy"),
       disable_telemetry: core.getBooleanInput("disable-telemetry"),
       disable_sudo: core.getBooleanInput("disable-sudo"),
-      disable_sudo_and_containers: core.getBooleanInput(
-        "disable-sudo-and-containers"
-      ),
       disable_file_monitoring: core.getBooleanInput("disable-file-monitoring"),
       private: context?.payload?.repository?.private || false,
-      is_github_hosted: isGithubHosted(),
-      is_debug: core.isDebug(),
-      one_time_key: "",
     };
 
-    let policyName = core.getInput("policy");
-    if (policyName !== "") {
-      console.log(`Fetching policy from API with name: ${policyName}`);
-      try {
-        let idToken: string = await core.getIDToken();
-        let result: PolicyResponse = await fetchPolicy(
-          context.repo.owner,
-          policyName,
-          idToken
-        );
-        confg = mergeConfigs(confg, result);
-      } catch (err) {
-        core.info(`[!] ${err}`);
-        // Only fail the job if ID token is not available
-        if (err.message && err.message.includes('Unable to get ACTIONS_ID_TOKEN_REQUEST')) {
-          core.setFailed('Policy store requires id-token write permission as it uses OIDC to fetch the policy from StepSecurity API. Please add "id-token: write" to your job permissions.');
-        } else {
-          // Handle different HTTP status codes
-          if (err.statusCode >= 400 && err.statusCode < 500) {
-            core.error('Policy not found');
-          } else {
-            core.error(`Unexpected error occurred: ${err}. Falling back to egress policy audit`);
-            confg.egress_policy = 'audit';
-          }
-        }
-      }
-    }
     fs.appendFileSync(
       process.env.GITHUB_STATE,
       `disableSudo=${confg.disable_sudo}${EOL}`,
@@ -106,13 +61,6 @@ interface MonitorResponse {
         encoding: "utf8",
       }
     );
-    fs.appendFileSync(
-      process.env.GITHUB_STATE,
-      `disableSudoAndContainers=${confg.disable_sudo_and_containers}${EOL}`,
-      {
-        encoding: "utf8",
-      }
-    );
     core.info(`[!] Current Configuration: \n${JSON.stringify(confg)}\n`);
 
     if (confg.egress_policy !== "audit" && confg.egress_policy !== "block") {
@@ -139,78 +87,28 @@ interface MonitorResponse {
       } catch (exception) {
         console.log(exception);
       }
-
-      const cacheServiceVersion: string = getCacheServiceVersion();
-
-      switch (cacheServiceVersion) {
-        case "v2":
-          core.info(`cache version: v2`);
-          try {
-            const cacheFilePath = path.join(__dirname, "cache.txt");
-            core.info(`cacheFilePath ${cacheFilePath}`);
-
-            const twirpClient = cacheTwirpClient.internalCacheTwirpClient();
-            const compressionMethod = await utils.getCompressionMethod();
-
-            const request: GetCacheEntryDownloadURLRequest = {
-              key: cacheKey,
-              restoreKeys: [],
-              version: utils.getCacheVersion(
-                [cacheFilePath],
-                compressionMethod,
-                false
-              ),
-            };
-
-            const response = await twirpClient.GetCacheEntryDownloadURL(
-              request
-            );
-
-            const url = new URL(response.signedDownloadUrl);
-            core.info(
-              `Adding cacheHost: ${url.hostname}:443 to allowed-endpoints`
-            );
-
-            confg.allowed_endpoints += ` ${url.hostname}:443`;
-          } catch (e) {
-            core.info(`Unable to fetch cacheURL ${e}`);
-            if (confg.egress_policy === "block") {
-              core.info("Switching egress-policy to audit mode");
-              confg.egress_policy = "audit";
-            }
-          }
-          break;
-
-        case "v1":
-          core.info(`cache version: v1`);
-
-          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 ${exception}`);
-            if (confg.egress_policy === "block") {
-              core.info("Switching egress-policy to audit mode");
-              confg.egress_policy = "audit";
-            }
+      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";
+        }
       }
     }
 
@@ -218,7 +116,7 @@ interface MonitorResponse {
       common.printInfo(web_url);
     }
 
-    if (isARCRunner()) {
+    if (isArcRunner()) {
       console.log(`[!] ${common.ARC_RUNNER_MESSAGE}`);
       if (confg.egress_policy === "block") {
         sendAllowedEndpoints(confg.allowed_endpoints);
@@ -229,50 +127,40 @@ interface MonitorResponse {
 
     const runnerName = process.env.RUNNER_NAME || "";
     core.info(`RUNNER_NAME: ${runnerName}`);
-    if (!isGithubHosted()) {
+    if (!runnerName.startsWith("GitHub Actions")) {
       fs.appendFileSync(process.env.GITHUB_STATE, `selfHosted=true${EOL}`, {
         encoding: "utf8",
       });
-
-      core.info(common.SELF_HOSTED_RUNNER_MESSAGE);
-
+      if (!fs.existsSync("/home/agent/agent")) {
+        core.info(common.SELF_HOSTED_NO_AGENT_MESSAGE);
+        return;
+      }
       if (confg.egress_policy === "block") {
-        sendAllowedEndpoints(confg.allowed_endpoints);
-        await sleep(5000);
+        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;
 
-    if (isGithubHosted() && process.env.STEP_SECURITY_HARDEN_RUNNER === "true") {
-      fs.appendFileSync(process.env.GITHUB_STATE, `customVMImage=true${EOL}`, {
-        encoding: "utf8",
-      });
-
-      core.info("This job is running on a custom VM image with Harden Runner installed.");
-
-      if (confg.egress_policy === "block") {
-        sendAllowedEndpoints(confg.allowed_endpoints);
-        await sleep(5000);
-      }
-      return;
-    }
-
-    let _http = new httpm.HttpClient();
-    let statusCode: number | undefined;
-    _http.requestOptions = { socketTimeout: 3 * 1000 };
-    let addSummary = "false";
+    let statusCode;
+    //_http.requestOptions = { socketTimeout: 3 * 1000 };
     try {
-      const monitorRequestData = {
-        correlation_id: correlation_id,
-        job: process.env["GITHUB_JOB"],
-      };
-      const resp = await _http.postJson<MonitorResponse>(
+      const resp = await axios.get(
         `${api_url}/github/${process.env["GITHUB_REPOSITORY"]}/actions/runs/${process.env["GITHUB_RUN_ID"]}/monitor`,
-        monitorRequestData
+        { timeout: 3000 }
       );
 
-      const responseData = resp.result;
-      statusCode = resp.statusCode; // adding error code to check whether agent is getting installed or not.
+      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}`,
@@ -280,85 +168,85 @@ interface MonitorResponse {
           encoding: "utf8",
         }
       );
-
-      if (statusCode === 200 && responseData) {
-        console.log(`Runner IP Address: ${responseData.runner_ip_address}`);
-        confg.one_time_key = responseData.one_time_key;
-        addSummary = responseData.monitoring_started ? "true" : "false";
-      }
     } catch (e) {
       console.log(`error in connecting to ${api_url}: ${e}`);
     }
-    fs.appendFileSync(
-      process.env.GITHUB_STATE,
-      `addSummary=${addSummary}${EOL}`,
-      {
-        encoding: "utf8",
-      }
-    );
-    fs.appendFileSync(
-      process.env.GITHUB_STATE,
-      `correlation_id=${correlation_id}${EOL}`,
-      {
-        encoding: "utf8",
-      }
-    );
-
+    //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");
-    chownForFolder(process.env.USER, "/home/agent");
+    cp.execSync("sudo chown -R $USER /home/agent");
 
-    let isTLS = await isTLSEnabled(context.repo.owner);
+    // Note: to avoid github rate limiting
+    let token = core.getInput("token");
+    let auth = `token ${token}`;
 
-    const agentInstalled = await installAgent(isTLS, confgStr);
+    const downloadPath: string = await tc.downloadTool(
+      "https://github.com/step-security/agent/releases/download/v0.13.5/agent_0.13.5_linux_amd64.tar.gz",
+      undefined,
+      auth
+    );
 
-    if (agentInstalled) {
-      // Check that the file exists locally
-      var statusFile = "/home/agent/agent.status";
-      var logFile = "/home/agent/agent.log";
-      var counter = 0;
-      while (true) {
-        if (!fs.existsSync(statusFile)) {
-          counter++;
-          if (counter > 30) {
-            console.log("timed out");
-            if (fs.existsSync(logFile)) {
-              var content = fs.readFileSync(logFile, "utf-8");
-              console.log(content);
-            }
-            break;
+    verifyChecksum(downloadPath); // NOTE: verifying agent's checksum, before extracting
+    const extractPath = await tc.extractTar(downloadPath);
+    //return;
+    let cmd = "cp",
+      args = [path.join(extractPath, "agent"), "/home/agent/agent"];
+    cp.execFileSync(cmd, args);
+    cp.execSync("chmod +x /home/agent/agent");
+
+    fs.writeFileSync("/home/agent/agent.json", confgStr);
+
+    cmd = "sudo";
+    args = [
+      "cp",
+      path.join(__dirname, "agent.service"),
+      "/etc/systemd/system/agent.service",
+    ];
+    cp.execFileSync(cmd, args);
+    cp.execSync("sudo systemctl daemon-reload");
+    cp.execSync("sudo service agent start", { timeout: 15000 });
+
+    // Check that the file exists locally
+    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++;
+        if (counter > 30) {
+          console.log("timed out");
+          if (fs.existsSync(logFile)) {
+            var content = fs.readFileSync(logFile, "utf-8");
+            console.log(content);
           }
-          await sleep(300);
-        } // The file *does* exist
-        else {
-          // Read the file
-          var content = fs.readFileSync(statusFile, "utf-8");
-          console.log(content);
           break;
         }
+        console.log("sleeping");
+        await sleep(300);
+      } // The file *does* exist
+      else {
+        // Read the file
+        var content = fs.readFileSync(statusFile, "utf-8");
+        console.log(content);
+        break;
       }
     }
   } catch (error) {
     core.setFailed(error.message);
   }
-  // see https://github.com/ruby/setup-ruby/issues/543
-  process.exit(0);
+  console.log("method done");
+  return;
 })();
 
-export function sleep(ms: number) {
+export function sleep(ms) {
   return new Promise((resolve) => {
     setTimeout(resolve, ms);
   });
 }
-
-function chownForFolder(newOwner: string, target: string) {
-  let cmd = "sudo";
-  let args = ["chown", "-R", newOwner, target];
-  cp.execFileSync(cmd, args);
-}

src/tls-inspect.test.ts

@@ -1,29 +0,0 @@
-import nock from "nock";
-import { STEPSECURITY_API_URL } from "./configs";
-import { isTLSEnabled } from "./tls-inspect";
-
-test("tls-inspect enabled", async () => {
-  let owner = "h0x0er";
-  let expected = true;
-
-  const resp = nock(`${STEPSECURITY_API_URL}`)
-    .get(`/github/${owner}/actions/tls-inspection-status`)
-    .reply(200, "");
-
-  let got = await isTLSEnabled(owner);
-
-  expect(got).toEqual(expected);
-});
-
-test("tls-inspect not enabled", async () => {
-  let owner = "step-security";
-  let expected = false;
-
-  const resp = nock(`${STEPSECURITY_API_URL}`)
-    .get(`/github/${owner}/actions/tls-inspection-status`)
-    .reply(401, "");
-
-  let got = await isTLSEnabled(owner);
-
-  expect(got).toEqual(expected);
-});

src/tls-inspect.ts

@@ -1,29 +0,0 @@
-import { HttpClient } from "@actions/http-client";
-import { STEPSECURITY_API_URL } from "./configs";
-import * as core from "@actions/core";
-
-export async function isTLSEnabled(owner: string): Promise<boolean> {
-  let tlsStatusEndpoint = `${STEPSECURITY_API_URL}/github/${owner}/actions/tls-inspection-status`;
-  let httpClient = new HttpClient();
-  httpClient.requestOptions = { socketTimeout: 3 * 1000 };
-  core.info(`[!] Checking TLS_STATUS: ${owner}`);
-  let isEnabled = false;
-  try {
-    let resp = await httpClient.get(tlsStatusEndpoint);
-    if (resp.message.statusCode === 200) {
-      isEnabled = true;
-      core.info(`[!] TLS_ENABLED: ${owner}`);
-    } else {
-      core.info(`[!] TLS_NOT_ENABLED: ${owner}`);
-    }
-  } catch (e) {
-    core.info(`[!] Unable to check TLS_STATUS`);
-  }
-
-  return isEnabled;
-}
-
-export function isGithubHosted() {
-  const runnerEnvironment = process.env.RUNNER_ENVIRONMENT || "";
-  return runnerEnvironment === "github-hosted";
-}