GCP KMS Connector User Guide

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

Overview

The GCP KMS Connector integrates Google Cloud Platform Key Management Service (GCP KMS) with Keyfactor's AgileSec Platform. This Connector allows you to discover, inventory, and analyze cryptographic assets across global GCP KMS regions.

What Gets Scanned

The GCP KMS Connector can discover the following cryptographic asset types:

• KMS Keys: All customer-managed and GCP-managed public asymmetric (RSA, ECC) KMS keys in a GCP project. Either scan the entire project or only specific regions.

• Key Locations: Locations of all public keys.

Prerequisites

Ensure you meet the following requirements to enable scanning.

Network Access

Ensure HTTPS network connectivity from AgileSec platform or remote execution machine to GCP KMS endpoints.

Supported Authentication Methods

GCP KMS Connector supports authentication using a json key auth.json:

1. Create a GCP Project Service Account

   1. Go to https://console.cloud.google.com/iam-admin/serviceaccounts

   2. Select the desired Project

   3. Click + Create Service Account

2. Create JSON key

   1. Under the Service Account, go to Keys

   2. Click Add Key->Create New Key

   3. Create JSON Key

3. Save the resulting auth.json key file securely.

GCP KMS Required Access Rights

The GCP Service Account requires the following minimum permissions.

Remote Execution Requirements

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

Running the Connector

AgileSec GCP KMS 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 Fields

The following parameters are used to configure AgileSec GCP KMS 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": "GCP KMS",
    "sensorConfig": {
       "auth_json": "<GCP auth json>",
       "project": "<GCP project>",
       "regions": [<project regions list>]
    },
    "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., gcpkms-config.yml) with your scan settings. An example configuration can be found in config/sample-configs/gcpkms.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 gcpkms-config.yml
  

• Windows (PowerShell)

  PowerShell

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

Remote Scan Execution Configuration Examples

• Scan All Regions in a GCP Project

  YAML

  scan_config:
    plugins:
      - gcpkms_import
      - trigger_discover
      - export
    config:
      gcpkms_import:
        name: gcpkms
        plugin_config:
          auth_json: "${file:/path/to/auth.json}"
          project: "${file:/path/to/auth.json:project_id}"
  

• Scan Specific Regions in a GCP Project

  YAML

  scan_config:
    plugins:
      - gcpkms_import
      - trigger_discover
      - export
    config:
      gcpkms_import:
        name: gcpkms
        plugin_config:
          auth_json: "${file:/path/to/auth.json}"
          project: "${file:/path/to/auth.json:project_id}"
          regions: ["global"]
  

Known Limitations

Disabled Keys

GCP KMS does not allow disabled keys to be scanned. Only enabled keys may be scanned by the GCP KMS Connector.

Incremental Scanning

Currently incremental scanning must still visit all key rings.

Troubleshooting

To assist with troubleshooting, see the GCP KMS error library: https://docs.cloud.google.com/kms/docs/reference/ekm_errors

Getting Support

Collect diagnostic information:

• Connector version

• Configuration file (redact tokens)

• Log output

Contact Support

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