-
Notifications
You must be signed in to change notification settings - Fork 5
BP-2274: Add Cortex XSOAR integration admin and user guides #138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6e3638c
docs: add cortext xsoar integration docs
jeff-matthews d2970d0
chore: revisions from CR review
jeff-matthews 00e2ced
chore: fix link
jeff-matthews 1ecfd3f
feat: disable previous and next links at bottom of pages
jeff-matthews 3d61df1
chore: document custom CSS for disabling pagination
jeff-matthews File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| --- | ||
| title: Integrate BloodHound Enterprise with Cortex XSOAR | ||
| description: Learn how to integrate BloodHound Enterprise with Cortex XSOAR by Palo Alto Networks. | ||
| sidebarTitle: Configure integration | ||
| --- | ||
|
|
||
| <img noZoom src="/assets/enterprise-edition-pill-tag.svg" alt="Applies to BloodHound Enterprise only"/> | ||
|
|
||
| The BloodHound Enterprise integration for [Cortex XSOAR](https://www.paloaltonetworks.com/resources/datasheets/cortex-xsoar-for-mssps#:~:text=Cortex%20XSOAR%C2%AE%EF%B8%8F%20is%20a,of%20services%20for%20their%20clients.) lets you ingest and manage BloodHound Enterprise attack path findings in Cortex XSOAR as incidents. | ||
|
|
||
| Use this integration to: | ||
|
|
||
| - Automatically convert BloodHound Enterprise attack path findings into Cortex XSOAR incidents | ||
| - Attach remediation guidance and posture context to incidents | ||
| - Run playbooks and custom commands to analyze, triage, and remediate findings | ||
|
|
||
| Key capabilities include: | ||
|
|
||
| - Automated incident creation with titles, descriptions, remediation guidance, impact/exposure metrics, severity, and domain/environment context | ||
| - Playbook linking per incident to run custom analysis commands | ||
| - Custom commands: | ||
| - Object ID lookup by name | ||
| - Asset information by object ID | ||
| - Path analysis between two nodes in the BloodHound graph | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before installing and configuring the Cortex XSOAR integration, ensure that you have the following: | ||
|
|
||
| - Cortex XSOAR instance with an admin account | ||
| - BloodHound Enterprise tenant | ||
| - BloodHound Enterprise API key/ID pair | ||
|
|
||
| <Note>We recommend a [non-personal API key/ID pair](/integrations/bloodhound-api/working-with-api#create-a-non-personal-api-key%2Fid-pair).</Note> | ||
|
|
||
| ## Configure Cortex XSOAR | ||
|
|
||
| Set up the SpecterOps BloodHound Enterprise integration instance in Cortex XSOAR. | ||
|
|
||
| <Steps> | ||
| <Step title="Open integration instances"> | ||
| 1. Log in to your Cortex XSOAR instance. | ||
| 1. Go to **Settings & Info** > **Settings** > **Integrations** > **Instances**. | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/open-instances.png" | ||
| alt="Cortex XSOAR Integrations & Instances page with SpecterOps integration visible." | ||
| /> | ||
| </Frame> | ||
| </Step> | ||
|
|
||
| <Step title="Add SpecterOpsBHE instance"> | ||
| 1. Search for the SpecterOps integration. | ||
| 1. Click **Add Instance** for the SpecterOpsBHE integration. | ||
| 1. Configure settings. | ||
|
|
||
| | Field | Description | Required? | | ||
| |-------|-------------|:----------:| | ||
| | **Name** | Instance display name (default can be modified) | Yes | | ||
| | **BloodHound Enterprise Domain** | Your tenant domain, e.g., `https://example.bloodhoundenterprise.io` | Yes | | ||
| | **Token ID** | API token ID from BloodHound Enterprise | Yes | | ||
| | **Token Key** | API token key from BloodHound Enterprise | Yes | | ||
| | **Proxy URL** | Proxy URL to reach BloodHound Enterprise | No | | ||
| | **Proxy URL Username** | Username for proxy authentication | No | | ||
| | **Proxy URL Password** | Password for proxy authentication | No | | ||
| | **Finding Environment** | Scope findings to one environment | No | | ||
| | **Finding Category** | Scope findings to one category | No | | ||
|
|
||
| <Note>By default, **Finding Environment** and **Finding Category** are set to **All**.</Note> | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/add-bhe-instance.png" | ||
| alt="Cortex XSOAR instance configuration showing fetch settings." | ||
| /> | ||
| </Frame> | ||
| </Step> | ||
|
|
||
| <Step title="Enable fetching and schedule interval"> | ||
| 1. Check the **Fetches incidents** option (required). | ||
| 1. Set **Incident Type** to "SpecterOpsBHE Attack Path" (optional). | ||
| 1. Set the **Incidents Fetch Interval** to your preferred schedule (required). | ||
|
|
||
| <Note>The default fetch interval is 10 minutes.</Note> | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/schedule.png" | ||
| alt="Cortex XSOAR instance configuration detail view." | ||
| /> | ||
| </Frame> | ||
| </Step> | ||
|
|
||
| <Step title="Test and save the configuration"> | ||
| 1. Click **Test** to verify connectivity and credentials. | ||
| 1. Close the modal, then **Save** the instance. | ||
|
|
||
| <Tip>"Success" indicates working parameters and connectivity. "Error" indicates invalid parameters or connection failure.</Tip> | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/test-connection.png" | ||
| alt="Cortex XSOAR instance save confirmation." | ||
| /> | ||
| </Frame> | ||
| </Step> | ||
|
|
||
| <Step title="Manage multiple domains or disable instances"> | ||
| - To add additional BloodHound Enterprise domains, create more instances with **Add Instance**. | ||
| - To stop fetching, uncheck **Enable** to disable the instance. | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/manage-or-disable.png" | ||
| alt="List of multiple SpecterOpsBHE instances in Cortex XSOAR." | ||
| /> | ||
| </Frame> | ||
| </Step> | ||
| </Steps> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| title: Use Cortex XSOAR with BloodHound Enterprise | ||
| description: Learn how to use Cortex XSOAR with BloodHound Enterprise to monitor and manage attack path findings. | ||
| sidebarTitle: Analyze attack path incidents | ||
| --- | ||
|
|
||
| <img noZoom src="/assets/enterprise-edition-pill-tag.svg" alt="Applies to BloodHound Enterprise only"/> | ||
|
|
||
| After you configure the integration, Cortex XSOAR begins fetching BloodHound Enterprise attack path findings as incidents. Use the sections below to monitor ingestion, view incidents, and inspect details. | ||
|
|
||
| <Tip>See [install and configure](/integrations/cortex-xsoar/configure) for setup steps and fetch interval settings.</Tip> | ||
|
|
||
| ## Monitor ingestion and logs | ||
|
|
||
| You can view instance logs to confirm incidents are being fetched. | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/monitor-logs.png" | ||
jeff-matthews marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| alt="Cortex XSOAR instance logs showing incident fetch activity for SpecterOpsBHE integration." | ||
| /> | ||
| </Frame> | ||
|
|
||
| ## View incidents | ||
|
|
||
| Open the **Incidents** view to see all fetched attack path incidents. | ||
|
|
||
| <Tip>Click any incident to open its details.</Tip> | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/view-incidents.png" | ||
| alt="Cortex XSOAR Incidents list showing SpecterOpsBHE attack path incidents." | ||
| /> | ||
| </Frame> | ||
|
|
||
| ## Incident details | ||
|
|
||
| The incident details page includes key information about the attack path and related context: | ||
|
|
||
| - Incident name and ID | ||
| - Case details | ||
| - Quick View side panel with labels containing attack path data | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/incident-details.png" | ||
| alt="Incident details view showing case details and Quick View labels for attack path data." | ||
| /> | ||
| </Frame> | ||
|
|
||
| ## Work Plan and playbook | ||
|
|
||
| Click the **Work Plan** tab to view the playbook. The SpecterOpsBHE playbook runs custom commands to retrieve object-related information and analyze attack paths. You can click each task or script to view its results. | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/workplan-playbook.png" | ||
| alt="Work Plan view showing the playbook tasks and scripts executed for the incident." | ||
| /> | ||
| </Frame> | ||
|
|
||
| ## DBot panel | ||
|
|
||
| Use the DBot panel to review execution context and results. Locate the **root** section and expand it to see underlying data and command outputs related to the incident. | ||
|
|
||
| <Frame> | ||
| <img | ||
| src="/images/integrations/cortex-soar/dbot-panel.png" | ||
| alt="DBot panel expanded to show root context and command outputs for the incident." | ||
| /> | ||
| </Frame> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.