GitHub Sensor User Guide

Instructions for deploying the GitHub Sensor to scan for cryptographic assets and deliver findings to the AgileSec Platform for processing and analysis.

Overview

The GitHub Sensor integrates GitHub (GitHub Cloud or GitHub Enterprise) with Keyfactor's AgileSec Platform. This Sensor allows you to discover, inventory, and analyze cryptographic assets across multiple repositories within a GitHub organization.

What Gets Scanned

The GitHub Sensor downloads target repositories from GitHub and scans for use of cryptography algorithms and libraries in source code. The following cryptographic assets can be discovered:

• X.509 Certificates: SSL/TLS certificates, code signing certificates, client authentication certificates

• Keys: RSA, DSA, EC asymmetric public keys in PEM, DER, and PKCS8 formats as well as unencrypted private keys

• Java Keystores: JKS, JCEKS, PKCS12 keystores

• Tokens: JWT and JWE tokens

• Cryptographic Libraries: OpenSSL, BouncyCastle, cryptography.io, and other crypto implementations

• Code Artifacts: Embedded certificates in compiled code (JAR, WAR, EAR files)

Prerequisites

Ensure you meet the following requirements to enable scanning.

Network Access

Ensure HTTPS network connectivity from AgileSec platform or remote execution machine to the GitHub server.

GitHub REST API must be accessible.

Supported Authentication Methods

The GitHub Sensor supports token-based authentication.

  # set your token
  export GITHUB_TOKEN="your-token-here"
  export GITHUB_URL="https://api.github.com"  # or your enterprise URL

  git clone https://oauth2:<token>@github.com/org/repo.git

GitHub Required Access Rights

The GitHub access token must have the following permissions to successfully authenticate:

Remote Execution Requirements

If running the Sensor remotely using CLI, the remote execution machine must meet these requirements:

Running the Sensor

AgileSec GitHub scans can be executed using the following methods:

1. Platform Scan Execution: Configure and execute scans directly through the Keyfactor AgileSec web UI with on-demand or scheduled execution options.

2. API Scan Execution: Programmatically trigger scans through REST API calls, enabling integration with CI/CD pipelines and automation workflows.

3. Remote Scan Execution: Deploy and run the sensor via CLI on customer-managed infrastructure for scenarios such as:

   1. Scanning air-gapped or internal instances the platform cannot directly reach

   2. Customers wanting to manage their own scheduling and execution environment.

Configuration Fields

The following parameters are used to configure AgileSec GitHub scans.

Platform Scan Execution

Running scans through the user interface is the simplest and fastest way to get started. The platform enables running on-demand or scheduled scans in a dedicated environment.

Platform Scan Configuration

1. Open your browser and navigate to the Keyfactor AgileSec Platform Web URL

2. Log in with your credentials

3. Click on "Sensors" in the left navigation menu under Scan

   

4. Click "+ New Sensor".

   

5. Click on the correct card to open the configuration interface.

Configure Parameters and Start Scan

6. Fill in the required configuration parameters.

7. Click Save.

8. Click Action then Scan to begin a scan.
   Note: Click Edit to reconfigure parameters.

   

API Scan Execution

Scans may be programmatically triggered through REST API calls, enabling seamless integration with CI/CD pipelines, automation workflows, and custom applications. API execution provides flexibility for developers to incorporate cryptographic scanning into their existing development and deployment processes.

Generate AgileSec API Access Token

1. Open your browser and navigate to AgileSec Platform UI

2. Log in with your Keyfactor credentials

3. Click "Access Tokens" in the main navigation menu

4. Click "Generate Token" button

5. Set Token Type to API Token and provide the required details

6. Click "Generate" and copy the generated token

   

AgileSec API Endpoint

POST https://<platform-url>/v3/scan/create/

Request Format

Headers

Content-Type: application/json
isg-api-token: <your-api-token>

Request Body

  {
    "sensorName": "<sensor name>",
    "sensorType": "Github Sensor",
    "sensorConfig": {
       "url": "<github api url>",
       "branch": "<branch name>",
       "token": "<personal access token>",
       "include_paths": "<include patterns>",
       "exclude_paths": "<exclude patterns>"
    },
    "callbackId": "<callback id>",
    "labels": [
        {
            "<label name>": "<label value>"
        }
    ],
    "priority": "<priority>",
    "incrementalScan": true,
    "autoResolutionInterval": 5
  }

Remote Scan Execution

Scans may be run on remote host machines with the AgileSec Remote Sensor Package.

Download Remote Sensor Package

Generate Platform Token

7. In the Download Remote UI, click "Generate Token"

8. Copy the generated token

9. Store securely in an environment variable such as SENSOR_TOKEN:

    export SENSOR_TOKEN="your-generated-token"
   

Create Configuration File

Create a YAML configuration file (e.g., github-config.yml) with your scan settings. An example configuration can be found in config/sample-configs/github.yml.

Step 4: Run the Sensor

Execute the Sensor with your configuration file:

• Linux

  Bash

  # Set environment variables
  export SENSOR_TOKEN="your-sensor-token"
  export GITHUB_TOKEN="your-github-token"
  
  # Run Sensor
  ./unified_sensor_linux -c github-config.yml
  

Remote Scan Execution Configuration Examples

• GitHub Enterprise (With Auth)

  YAML

  scan_config:
    plugins:
      - isg_github
      - trigger_discover
      - export
    config:
      isg_github:
        name: github
        plugin_config:
          url: "<https://github.mycompany.com>"
          token: "${env:GITHUB_TOKEN}"
          include_paths:
            - "internal-team"
          exclude_paths:
            - "internal-team/archived-*"
  

• Scan Specific Branch

  YAML

  scan_config:
    plugins:
      - isg_github
      - trigger_discover
      - export
    config:
      isg_github:
        name: github
        plugin_config:
          url: "<https://github.com>"
          token: "${env:GITHUB_TOKEN}"
          branch: "develop"
          include_paths:
            - "myorg/myrepo"
  

Known Limitations

Rate Limiting

GitHub enforces API rate limits. Large organizations with many repositories may hit rate limits. Always use a Personal Access Token; usually that has higher limits. Also, for individual repositories you can use the Git Sensor.

Binary Files

While the Sensor scans files, opaque binary blobs without recognized headers may not be deeply analyzed.

Troubleshooting Common Errors

• repository not found (404)

  • Cause: The URL is incorrect, OR the credentials provided do not have access to the private repository.

  • Fix: Check the URL.

• authentication failed (401)

  • Cause: Invalid credentials.

  • Fix: Verify the credentials are correct by testing with a manual git clone command.

• unable to access (402/Connection Refused)

  • Cause: Network connectivity issue.

  • Fix: Ensure the machine running the Sensor can reach the GitHub server URL. Check firewalls and proxies.

• could not find remote branch

  • Cause: The specified branch does not exist on the remote.

  • Fix: Verify the branch name matches exactly (case-sensitive).

Getting Support

Collect diagnostic information:

• Sensor version

• Configuration file (redact tokens)

• Log output

• GitHub details (cloud vs enterprise, URL, version)

Contact Support

• Portal: https://support.keyfactor.com