CipherInsights Connector User Guide

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

Overview

The CipherInsights Connector integrates CipherInsights with Keyfactor's AgileSec Platform. This Connector allows users to import and analyze cryptographic findings from the CipherInsights API, bringing protocol-level and certificate-level visibility into the AgileSec ecosystem.

What Gets Scanned

The CipherInsights Connector can discover the following cryptographic asset types:

• X.509 Certificates: SSL/TLS certificates discovered by CipherInsights network scans

• TLS Protocol Information: TLS/SSL protocol versions, cipher suites, and key exchange algorithms observed on network endpoints

• SSH Protocol Information: SSH key exchange, encryption, and MAC algorithms observed on network endpoints

Prerequisites

Ensure you meet the following requirements to enable scanning.

Network Access

Ensure HTTPS network connectivity from AgileSec platform or remote execution machine to Cipher Insights endpoints.

Supported Authentication Methods

The CipherInsights Connector supports token-based authentication:

• Obtain an API token from your CipherInsights deployment.

• Provide the token in the Connector configuration via the token field.

CipherInsights Required Access Rights

At minimum, the default Operator role is required for proper CipherInsight API token access permissions.

Remote Execution Requirements

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

Running the Connector

AgileSec CipherInsights 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 connector 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 Options

The following parameters are used to configure AgileSec Cipher Insights 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": "CipherInsights",
    "sensorConfig": {
       "url": "<cipher insights api url>",
       "token": "<api token>",
       "time_frame": 24,
       "pagination_limit": 100
    },
    "callbackId": "<callback id>",
    "labels": [
        {
            "<label name>": "<label value>"
        }
    ],
    "priority": "<priority>"
  }

Remote Scan Execution

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

Download Remote Sensor Package

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 Remote Scan.

   

5. Click + Download Remote Sensor.

   

6. Download the sensor binary for your remote machine’s operating system

   

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., cipher_insights-config.yml) with your scan settings. An example configuration can be found at config/sample-configs/cipher_insights.yml.

Step 4: Run the Connector

Execute the Connector with your configuration file:

• Linux/macOS

  Bash

  # Set environment variables
  export SENSOR_TOKEN="your-sensor-token"
  
  # Run Connector
  ./unified_sensor_linux -c cipher_insights-config.yml
  

• Windows (PowerShell)

  PowerShell

  # Set environment variables
  $env:SENSOR_TOKEN = "your-sensor-token"
  
  # Run Connector
  .\\unified_sensor_windows.exe -c .\\cipher_insights-config.yml
  

Remote Scan Execution Configuration Examples

• Basic Configuration

  YAML

  scan_config:
    plugins:
      - cipher_insights
      - export
    config:
      cipher_insights:
        name: cipher_insights
        plugin_config:
          url: "<https://cipherinsights.example.com/api/v1/>"
          token: "${env:CI_TOKEN}"
          insecure: false
  

• With Time Frame and Pagination

  YAML

  scan_config:
    plugins:
      - cipher_insights
      - export
    config:
      cipher_insights:
        name: cipher_insights
        plugin_config:
          url: "<https://cipherinsights.example.com/api/v1/>"
          token: "${env:CI_TOKEN}"
          insecure: false
          time_frame: 24
          pagination_limit: 200
  

Known Limitations

API Rate Limiting

The CipherInsights API may enforce rate limits depending on deployment configuration. Large datasets may require pagination tuning. Adjust pagination_limit and time_frame to manage request volume.

Troubleshooting Common Errors

• CONFIG-404 – Unable to read/parse configuration file

  • Cause: The configuration file path is incorrect or the file is malformed.

  • Fix: Verify the config file path and validate JSON syntax.

• CONFIG-422 – Required attribute not found

  • Cause: A required configuration field (e.g., url or token) is missing.

  • Fix: Ensure all required fields are present in the configuration.

• 401 Unauthorized

  • Cause: Invalid or expired API token.

  • Fix: Verify the token is correct and has not expired.

• Connection refused or TLS errors

  • Cause: Network connectivity issue or certificate validation failure.

  • Fix: Ensure the Connector can reach the CipherInsights API. When using remote scan, set insecure: true for self-signed certificates.

Getting Support

Collect diagnostic information:

• Connector version

• Configuration file (redact tokens)

• Log output

• CipherInsights deployment details (URL, version)

Contact Support

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