Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions maze-security/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Custom Integration: Maze

<img src="maze-icon.png" alt="Maze" width="100">

## runZero requirements

- Superuser access to the [Custom Integrations configuration](https://console.runzero.com/custom-integrations) in runZero.

## Maze requirements

- Maze API key with access to the Investigations API.

## Steps

### Maze configuration

1. Obtain your **API Key** from the Maze platform.
2. Confirm API access to `https://api.mazehq.com/v1/investigations/search`.

### runZero configuration

1. (OPTIONAL) - Make any necessary changes to the script to align with your environment.
- Adjust `DEFAULT_DAYS_BACK` to control how far back investigations are fetched (default: 30 days).
- Modify custom attribute mappings as needed.
2. [Create the Credential for the Custom Integration](https://console.runzero.com/credentials).
- Select the type `Custom Integration Script Secrets`.
- For `access_key`, input a placeholder value (unused in this integration).
- Use the `access_secret` field for your **Maze API Key**.
3. [Create the Custom Integration](https://console.runzero.com/custom-integrations/new).
- Add a Name and Icon for the integration (e.g., "maze"). The icon is included in this directory.
- Toggle `Enable custom integration script` to input the finalized script.
- Click `Validate` to ensure it has valid syntax.
- Click `Save` to create the Custom Integration.
4. [Create the Custom Integration task](https://console.runzero.com/ingest/custom/).
- Select the Credential and Custom Integration created in steps 2 and 3.
- Update the task schedule to recur at the desired timeframes.
- Select the Explorer you would like the Custom Integration to run from.
- Click `Save` to kick off the first task.

### What's next?

- You will see the task kick off on the [tasks](https://console.runzero.com/tasks) page like any other integration.
- The task will update existing assets with vulnerability investigation data pulled from Maze.
- The task will create new assets when there are no existing assets that meet merge criteria (hostname, MAC, etc).
- You can search for assets enriched by this custom integration with the runZero search `custom_integration:maze`.

### Notes

- The integration fetches investigations updated within the last 30 days by default. Adjust `DEFAULT_DAYS_BACK` in the script to change this.
- Each investigation is mapped to a **Vulnerability** on the corresponding asset, including CVE, CVSS scores, exploitability verdict, and root cause analysis.
- When `related_scanner_findings` data is available, additional metadata (cloud platform, region, scanner type, account ID) is included as custom attributes.
- The integration includes retry logic for transient API errors (5xx) with up to 3 attempts per request.
4 changes: 4 additions & 0 deletions maze-security/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "Maze",
"type": "inbound"
}
Loading