update agent

Feature/custom property skip

.github/workflows/canary.yml

@@ -29,7 +29,7 @@ jobs:
           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:

.github/workflows/codeql-analysis.yml

@@ -46,7 +46,7 @@ jobs:
         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

.github/workflows/dependency-review.yml

@@ -22,6 +22,6 @@ jobs:
           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

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

@@ -22,7 +22,7 @@ jobs:
           egress-policy: audit
 
       - name: Checking out
-        uses: actions/checkout@v6
+        uses: actions/checkout@v4
       - name: Publish
         id: publish
         uses: actions/publish-immutable-action@0.0.4

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
           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

@@ -23,7 +23,7 @@ jobs:
             
 
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v3
             
       - name: Run outbound calls from host
         run: |
@@ -56,7 +56,7 @@ jobs:
             security.ubuntu.com:80
          
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v3
 
       - name: Run outbound calls from within Docker container
         continue-on-error: true
@@ -103,7 +103,7 @@ jobs:
             security.ubuntu.com:80
             
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v3
 
       - name: Build Docker image and test outbound calls during build
         continue-on-error: true
@@ -152,7 +152,7 @@ jobs:
             
 
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v3
 
       - name: Run long-running Docker container with outbound calls
         continue-on-error: true

.github/workflows/scorecards.yml

@@ -30,7 +30,7 @@ jobs:
           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
 

.github/workflows/test.yml

@@ -32,7 +32,7 @@ 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
@@ -58,7 +58,7 @@ jobs:
             registry.npmjs.org: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 build

dist/pre/index.js

@@ -85495,8 +85495,8 @@ var external_crypto_ = __nccwpck_require__(6982);
 
 const CHECKSUMS = {
     tls: {
-        amd64: "603d6a0dabb60a7c8f651d7f5b53258fa64162424a77da9884d9032b3e71d6b1",
-        arm64: "fdc7504a3210dc67fc8393969b0f3c98df593c7884c83ed6d1c0ec84070801aa",
+        amd64: "d92e2d3ad0d451dfddc082c10690fb69472df9e45f6d9b37b0e6fe374bd6569f",
+        arm64: "84ff11038212d5143447619a3b5457b58dd196cad94f987154f11bd6cd6a5fb0",
     },
     non_tls: {
         amd64: "336093af8ebe969567b66fd035af3bd4f7e1c723ce680d6b4b5b2a1f79bc329e", // v0.14.2
@@ -85549,7 +85549,7 @@ function installAgent(isTLS, configStr) {
             encoding: "utf8",
         });
         if (isTLS) {
-            downloadPath = yield tool_cache.downloadTool(`https://github.com/step-security/agent-ebpf/releases/download/v1.7.6/harden-runner_1.7.6_linux_${variant}.tar.gz`, undefined, auth);
+            downloadPath = yield tool_cache.downloadTool(`https://github.com/step-security/agent-ebpf/releases/download/v1.7.12/harden-runner_1.7.12_linux_${variant}.tar.gz`, undefined, auth);
         }
         else {
             if (variant === "arm64") {
@@ -85609,9 +85609,14 @@ var setup_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _ar
 
 
 (() => setup_awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
+    var _a, _b, _c, _d;
     try {
         console.log("[harden-runner] pre-step");
+        const customProperties = ((_b = (_a = github.context === null || github.context === void 0 ? void 0 : github.context.payload) === null || _a === void 0 ? void 0 : _a.repository) === null || _b === void 0 ? void 0 : _b.custom_properties) || {};
+        if (customProperties["skip-harden-runner"] === "true") {
+            console.log("Skipping harden-runner: custom property 'skip-harden-runner' is set to 'true'");
+            return;
+        }
         if (process.platform !== "linux") {
             console.log(UBUNTU_MESSAGE);
             return;
@@ -85635,7 +85640,7 @@ var setup_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _ar
             disable_sudo: lib_core.getBooleanInput("disable-sudo"),
             disable_sudo_and_containers: lib_core.getBooleanInput("disable-sudo-and-containers"),
             disable_file_monitoring: lib_core.getBooleanInput("disable-file-monitoring"),
-            private: ((_b = (_a = github.context === null || github.context === void 0 ? void 0 : github.context.payload) === null || _a === void 0 ? void 0 : _a.repository) === null || _b === void 0 ? void 0 : _b.private) || false,
+            private: ((_d = (_c = github.context === null || github.context === void 0 ? void 0 : github.context.payload) === null || _c === void 0 ? void 0 : _c.repository) === null || _d === void 0 ? void 0 : _d.private) || false,
             is_github_hosted: isGithubHosted(),
             is_debug: lib_core.isDebug(),
             one_time_key: "",
@@ -85758,6 +85763,13 @@ var setup_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _ar
                 encoding: "utf8",
             });
             lib_core.info(SELF_HOSTED_RUNNER_MESSAGE);
+            // Install agent for self-hosted runner (only if not already installed)
+            if (!external_fs_.existsSync("/home/agent/agent.status")) {
+                yield installAgentForSelfHosted(github.context.repo.owner);
+            }
+            else {
+                console.log("Agent already installed for self-hosted runner, skipping installation");
+            }
             if (confg.egress_policy === "block") {
                 sendAllowedEndpoints(confg.allowed_endpoints);
                 yield setup_sleep(5000);
@@ -85775,6 +85787,10 @@ var setup_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _ar
             }
             return;
         }
+        if (isGithubHosted() && external_fs_.existsSync("/home/agent/agent.status")) {
+            console.log("Agent already installed, skipping installation");
+            return;
+        }
         let _http = new lib.HttpClient();
         let statusCode;
         _http.requestOptions = { socketTimeout: 3 * 1000 };
@@ -85858,6 +85874,59 @@ function chownForFolder(newOwner, target) {
     let args = ["chown", "-R", newOwner, target];
     external_child_process_.execFileSync(cmd, args);
 }
+function installAgentForSelfHosted(owner) {
+    return setup_awaiter(this, void 0, void 0, function* () {
+        try {
+            console.log("Installing Harden Runner agent for self-hosted runner");
+            // Determine TLS support
+            let isTLS = yield isTLSEnabled(owner);
+            if (!isTLS) {
+                console.log("TLS is not enabled for this organization. Agent installation skipped for self-hosted runner.");
+                return;
+            }
+            // Create self-hosted specific config
+            const selfHostedConfig = {
+                customer: owner,
+                working_directory: process.env.GITHUB_WORKSPACE,
+                api_key: v4()
+            };
+            const selfHostedConfigStr = JSON.stringify(selfHostedConfig);
+            // Create /home/agent directory
+            external_child_process_.execSync("sudo mkdir -p /home/agent");
+            chownForFolder(process.env.USER, "/home/agent");
+            // Install the agent
+            const agentInstalled = yield installAgent(isTLS, selfHostedConfigStr);
+            if (agentInstalled) {
+                // Wait for agent.status file
+                var statusFile = "/home/agent/agent.status";
+                var logFile = "/home/agent/agent.log";
+                var counter = 0;
+                while (true) {
+                    if (!external_fs_.existsSync(statusFile)) {
+                        counter++;
+                        if (counter > 30) {
+                            console.log("timed out");
+                            if (external_fs_.existsSync(logFile)) {
+                                var content = external_fs_.readFileSync(logFile, "utf-8");
+                                console.log(content);
+                            }
+                            break;
+                        }
+                        yield setup_sleep(300);
+                    }
+                    else {
+                        var content = external_fs_.readFileSync(statusFile, "utf-8");
+                        console.log(content);
+                        break;
+                    }
+                }
+            }
+        }
+        catch (error) {
+            console.log(`Failed to install agent for self-hosted runner: ${error.message}`);
+        }
+    });
+}
 
 })();
 

src/checksum.ts

@@ -4,8 +4,8 @@ import * as fs from "fs";
 
 const CHECKSUMS = {
   tls: {
-    amd64: "603d6a0dabb60a7c8f651d7f5b53258fa64162424a77da9884d9032b3e71d6b1", // v1.7.6
-    arm64: "fdc7504a3210dc67fc8393969b0f3c98df593c7884c83ed6d1c0ec84070801aa",
+    amd64: "d92e2d3ad0d451dfddc082c10690fb69472df9e45f6d9b37b0e6fe374bd6569f", // v1.7.12
+    arm64: "84ff11038212d5143447619a3b5457b58dd196cad94f987154f11bd6cd6a5fb0",
   },
   non_tls: {
     amd64: "336093af8ebe969567b66fd035af3bd4f7e1c723ce680d6b4b5b2a1f79bc329e", // v0.14.2

src/cleanup.ts

@@ -4,9 +4,16 @@ import * as common from "./common";
 import isDocker from "is-docker";
 import { isARCRunner } from "./arc-runner";
 import { isGithubHosted } from "./tls-inspect";
+import { context } from "@actions/github";
 (async () => {
   console.log("[harden-runner] post-step");
 
+  const customProperties = context?.payload?.repository?.custom_properties || {};
+  if (customProperties["skip-harden-runner"] === "true") {
+    console.log("Skipping harden-runner: custom property 'skip-harden-runner' is set to 'true'");
+    return;
+  }
+
   if (process.platform !== "linux") {
     console.log(common.UBUNTU_MESSAGE);
     return;
@@ -41,6 +48,11 @@ import { isGithubHosted } from "./tls-inspect";
     return;
   }
 
+  if (isGithubHosted() && fs.existsSync("/home/agent/post_event.json")) {
+    console.log("Post step already executed, skipping");
+    return;
+  }
+
   fs.writeFileSync(
     "/home/agent/post_event.json",
     JSON.stringify({ event: "post" })

src/index.ts

@@ -3,9 +3,16 @@ import * as core from "@actions/core";
 import isDocker from "is-docker";
 import { STEPSECURITY_WEB_URL } from "./configs";
 import { isGithubHosted } from "./tls-inspect";
+import { context } from "@actions/github";
 (async () => {
   console.log("[harden-runner] main-step");
 
+  const customProperties = context?.payload?.repository?.custom_properties || {};
+  if (customProperties["skip-harden-runner"] === "true") {
+    console.log("Skipping harden-runner: custom property 'skip-harden-runner' is set to 'true'");
+    return;
+  }
+
   if (process.platform !== "linux") {
     console.log(common.UBUNTU_MESSAGE);
     return;

src/install-agent.ts

@@ -25,7 +25,7 @@ export async function installAgent(
 
   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`,
+      `https://github.com/step-security/agent-ebpf/releases/download/v1.7.12/harden-runner_1.7.12_linux_${variant}.tar.gz`,
       undefined,
       auth
     );

src/setup.ts

@@ -39,6 +39,12 @@ interface MonitorResponse {
   try {
     console.log("[harden-runner] pre-step");
 
+    const customProperties = context?.payload?.repository?.custom_properties || {};
+    if (customProperties["skip-harden-runner"] === "true") {
+      console.log("Skipping harden-runner: custom property 'skip-harden-runner' is set to 'true'");
+      return;
+    }
+
     if (process.platform !== "linux") {
       console.log(common.UBUNTU_MESSAGE);
       return;
@@ -236,6 +242,13 @@ interface MonitorResponse {
 
       core.info(common.SELF_HOSTED_RUNNER_MESSAGE);
 
+      // Install agent for self-hosted runner (only if not already installed)
+      if (!fs.existsSync("/home/agent/agent.status")) {
+        await installAgentForSelfHosted(context.repo.owner);
+      } else {
+        console.log("Agent already installed for self-hosted runner, skipping installation");
+      }
+
       if (confg.egress_policy === "block") {
         sendAllowedEndpoints(confg.allowed_endpoints);
         await sleep(5000);
@@ -257,6 +270,11 @@ interface MonitorResponse {
       return;
     }
 
+    if (isGithubHosted() && fs.existsSync("/home/agent/agent.status")) {
+      console.log("Agent already installed, skipping installation");
+      return;
+    }
+
     let _http = new httpm.HttpClient();
     let statusCode: number | undefined;
     _http.requestOptions = { socketTimeout: 3 * 1000 };
@@ -362,3 +380,59 @@ function chownForFolder(newOwner: string, target: string) {
   let args = ["chown", "-R", newOwner, target];
   cp.execFileSync(cmd, args);
 }
+
+async function installAgentForSelfHosted(owner: string) {
+  try {
+    console.log("Installing Harden Runner agent for self-hosted runner");
+
+    // Determine TLS support
+    let isTLS = await isTLSEnabled(owner);
+
+    if (!isTLS) {
+      console.log("TLS is not enabled for this organization. Agent installation skipped for self-hosted runner.");
+      return;
+    }
+
+    // Create self-hosted specific config
+    const selfHostedConfig = {
+      customer: owner,
+      working_directory: process.env.GITHUB_WORKSPACE,
+      api_key: uuidv4()
+    };
+    const selfHostedConfigStr = JSON.stringify(selfHostedConfig);
+
+    // Create /home/agent directory
+    cp.execSync("sudo mkdir -p /home/agent");
+    chownForFolder(process.env.USER, "/home/agent");
+
+    // Install the agent
+    const agentInstalled = await installAgent(isTLS, selfHostedConfigStr);
+
+    if (agentInstalled) {
+      // Wait for agent.status file
+      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;
+          }
+          await sleep(300);
+        } else {
+          var content = fs.readFileSync(statusFile, "utf-8");
+          console.log(content);
+          break;
+        }
+      }
+    }
+  } catch (error) {
+    console.log(`Failed to install agent for self-hosted runner: ${error.message}`);
+  }
+}