Skip to content
Merged
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
40 changes: 20 additions & 20 deletions docs/analyze-data/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: The BloodHound Dashboard
description: Learn how to use the BloodHound dashboard to analyze your data and identify attack paths.
mode: wide
sidebarTitle: Overview
---

<CardGroup cols={2}>
<Card title="Privilege Zones" icon="gem" href="/analyze-data/privilege-zones" horizontal />

<Card title="Search and Pathfinding" icon="search" href="/analyze-data/explore/search" horizontal />

<Card title="Search with Cypher" icon="code" href="/analyze-data/explore/cypher-search" horizontal />

<Card title="Posture" icon="chart-column" href="/analyze-data/posture-page" horizontal />

<Card title="BloodHound Configuration" icon="gear" href="/analyze-data/configuration" horizontal />

<Card title="Accept Attack Path Findings" icon="shield-check" href="/analyze-data/accept-findings" horizontal />
</CardGroup>
---
title: The BloodHound Dashboard
description: Learn how to use the BloodHound dashboard to analyze your data and identify attack paths.
mode: wide
sidebarTitle: Overview
---
<CardGroup cols={2}>
<Card title="Privilege Zones" icon="gem" href="/analyze-data/privilege-zones" horizontal />
<Card title="Search and Pathfinding" icon="search" href="/analyze-data/explore/search" horizontal />
<Card title="Search with Cypher" icon="code" href="/analyze-data/explore/cypher-search" horizontal />
<Card title="Posture" icon="chart-column" href="/analyze-data/posture-page" horizontal />
<Card title="BloodHound Configuration" icon="gear" href="/analyze-data/configuration" horizontal />
<Card title="Accept Attack Path Findings" icon="shield-check" href="/analyze-data/accept-findings" horizontal />
</CardGroup>
29 changes: 16 additions & 13 deletions docs/analyze-data/privilege-zones/certification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ This process gives you control over zone membership and helps prevent unexpected

<img
src="/images/privzones/certification.png"
alt="A view of the Privilege Zones certification tab"
title="Privilege Zones certification tab"
alt="A view of the Zone Builder certification tab"
style={{ width:"100%" }}
/>

Expand Down Expand Up @@ -42,7 +41,7 @@ You can configure certification requirements at the zone level (to affect all ru

## Manage certifications

The **Certification** tab in the **Privilege Zones** page allows administrators and power users to review, approve, or revoke certifications for objects in zones where manual certification has been configured.
The **Certifications** tab in the **Zone Builder** page allows administrators and power users to review, approve, or revoke certifications for objects in zones where manual certification has been configured.

<Note>
* You can certify or revoke certification only for objects in zones where certification is enabled.
Expand All @@ -52,40 +51,40 @@ The **Certification** tab in the **Privilege Zones** page allows administrators
To manage certifications:

<Steps>
<Step title="Open the Certification tab">
Navigate to the **Privilege Zones** > **Certification** tab.
<Step title="Open the Certifications tab">
Navigate to the **Privilege Zones** > **Certifications** tab.
</Step>

<Step title="Filter certifications">
Use one of the following methods to filter certifications:

<Tabs>
<Tab title="By Status" icon="circle-check">
Click the status drop-down menu and choose **Pending**, **User Certified**, or **Rejected** to view relevant certifications.
Click the status drop-down menu and choose **Pending**, **User Certified**, **Automatic Certification**, or **Rejected** to view relevant certifications.

<Note>Actions are only available for certifications that require manual approval. You cannot approve or revoke **Automatic Certifications**.</Note>

<img
src="/images/privzones/certification-status.gif"
alt="Privilege Zones certification status drop-down menu"
alt="An animated view of the Zone Builder certification status filter"
style={{ width:"100%" }}
/>
</Tab>
<Tab title="By Environment" icon="globe">
Click the environment drop-down menu and select the desired environment to view its certifications.

<img
src="/images/release_notes/8_4_0/certification-environment-filter.gif"
alt="Privilege Zones certification environment drop-down menu"
src="/images/privzones/certification-environment.gif"
alt="An animated view of the Zone Builder certification environment filter"
style={{ width:"100%" }}
/>
</Tab>
<Tab title="By Search" icon="search">
The **Certifications** tab also provides a search box and filters to help you identify specific certifications.

<img
src="/images/privzones/certifications-filter.png"
alt="Privilege Zones certifications filter"
src="/images/privzones/certifications-search-filter.png"
alt="A view of the Zone Builder certification search and filter options"
style={{ width:"50%" }}
/>
</Tab>
Expand All @@ -102,8 +101,12 @@ To manage certifications:
* Click **Skip Note** to complete the certification action without a note
* Click **Cancel** to exit without completing the certification action

<img src="/images/privzones/certification-note.png" alt="Privilege Zones certification note dialog" style={{ width:"50%" }} />
<img
src="/images/privzones/certification-note.png"
alt="A view of the certification note dialog in the Zone Builder certification tab"
style={{ width:"50%" }}
/>

<Tip>Notes are visible to all BloodHound users in the [History Log](/analyze-data/privilege-zones/history).<img src="/images/privzones/certification-note-history.png" alt="Show certification note in Privilege Zones history log" style={{ width:"100%" }} /></Tip>
<Tip>Notes are visible to all BloodHound users in the [History Log](/analyze-data/privilege-zones/history).<img src="/images/privzones/certification-note-history.png" alt="A view of a certification note in the Zone Builder history log" style={{ width:"100%" }} /></Tip>
</Step>
</Steps>
4 changes: 2 additions & 2 deletions docs/analyze-data/privilege-zones/history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The **History Log** provides a record of changes to your Zones and Labels, inclu

<img
src="/images/privzones/history-log.png"
alt="Privilege Zones history log"
alt="Zone Builder history log"
style={{ width:"100%" }}
/>

Expand All @@ -21,6 +21,6 @@ The **History Log** provides a search box and filters to help you identify speci

<img
src="/images/privzones/history-log-filter.png"
alt="Privilege Zones history log filter"
alt="Zone Builder history log filter"
style={{ width:"50%" }}
/>
105 changes: 75 additions & 30 deletions docs/analyze-data/privilege-zones/labels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,56 @@ description: Learn how to use labels to categorize and manage objects within Pri
---

import RuleWarning from '/snippets/privilege-zones/rule-warning.mdx';
import ZoneLabelViews from '/snippets/privilege-zones/zone-label-views.mdx';
import DeleteZoneLabel from '/snippets/privilege-zones/delete-zone-label.mdx';

<img noZoom src="/assets/enterprise-AND-community-edition-pill-tag.svg" alt="Applies to BloodHound Enterprise and CE"/>

Labels let you tag groups of objects for easier searching and filtering. Use labels to mark objects with common characteristics (e.g., "PCI", "Owned", "Production").
Labels let you tag groups of objects for easier searching and filtering. For example, you can label compromised assets with the default **Owned** label to quickly identify attack paths from non-compromised to compromised assets in your environment.

You can filter views and queries based on labels. For example, label PCI-scoped systems to quickly identify attack paths from non-PCI to PCI environments.
The **Owned** label represents objects that have been compromised in your environment. You can tag objects with the **Owned** label using rules or manually in the graph.

<Note>Unlike zones, BloodHound does not use labels in risk analysis—they're designed to help you organize and query your data.</Note>

The **Labels** tab offers two views:
<ZoneLabelViews tab="Labels" />

<Tabs>
<Tab title="Summary View">
The **Summary View** shows label names, rule counts, and member count.
The **Summary View** shows label names, rule counts, and object counts.
<img
src="/images/privzones/labels-summary-view.png"
alt="Privilege Zones summary view"
style={{ width:"100%" }}
alt="A view of the Zone Builder labels summary view"
/>
</Tab>
<Tab title="Detail View">
The **Detail View** lists every rule and member that each rule pulls into the associated label.
<Tab title="Details View">
The **Details View** displays all rules configured for the selected label and the objects that they pull into the label (organized by node type). Use the drop-down menus to filter the view by specific labels and domains in your environment.

Select a rule or object to display more details in the right panel, including:

- Rule definition and Cypher query
- Object properties and relationships

<Note>BloodHound displays objects for enabled rules only. To view objects related to a disabled rule, you must re-enable it.</Note>

<img
src="/images/privzones/labels-detail-view.png"
alt="Privilege Zones detail view"
style={{ width:"100%" }}
alt="A view of the Zone Builder labels detail view"
/>
</Tab>
</Tabs>

### Create a label

<Badge shape="rounded" size="sm" stroke color="purple">Enterprise Edition</Badge>

You can create custom labels to categorize objects based on any criteria relevant to your environment, such as business function, sensitivity level, or compliance requirements.

For example, you might create a label for PCI-scoped systems to quickly identify attack paths from non-PCI to PCI environments.

Creating a label involves configuring the label details and defining a rule.

<Steps>
<Step title="Open the Privilege Zones page">
<Step title="Open the Zone Builder page">
In the left menu, click **Privilege Zones** > **Labels** > **Create Label**.
</Step>

Expand All @@ -53,7 +67,7 @@ Creating a label involves configuring the label details and defining a rule.

<img
src="/images/privzones/create-label.png"
alt="Configure a new privilege zone label"
alt="A view of the Zone Builder create label page"
style={{ width:"70%" }}
/>

Expand All @@ -74,7 +88,7 @@ Creating a label involves configuring the label details and defining a rule.

<img
src="/images/privzones/define-label-rule.png"
alt="Define a rule for the privilege zone label"
alt="A view of the Zone Builder define label rule page"
style={{ width:"100%" }}
/>
</Step>
Expand All @@ -83,41 +97,72 @@ Creating a label involves configuring the label details and defining a rule.
</Step>
</Steps>

### Edit or delete a label
### Edit a label

To edit or delete an existing label, follow these steps:
To edit a label, follow these steps:

<Steps>
<Step title="Select a label">
Navigate to the **Labels** tab, select the label you want to edit or delete, and click **Edit Label**.
1. In the left menu, click **Privilege Zones**.

1. Click the **Labels** tab

1. By default, the **Owned** label is pre-selected. To edit a different label, select the label you want to edit.

If you're using BloodHound Enterprise, you can select a label from the **Summary View**.

<img
src="/images/privzones/edit-label-summary-view.png"
alt="A view of the Zone Builder edit label page in BloodHound Enterprise with the Summary View"
/>

Alternatively, BloodHound Enterprise and BloodHound Community Edition users can select a label using the dropdown menu on the **Details View**.

<img
src="/images/privzones/edit-label-details-view.png"
alt="A view of the Zone Builder edit label page in BloodHound with the Detail View"
/>

1. Click **Edit Label**.
</Step>

<Step title="Edit the label">
To edit the label:

1. Modify the label's name or description.
1. Click **Save Edits** to apply your changes.

<Tip>To manage how objects are included in the label, see [Rules](/analyze-data/privilege-zones/rules).</Tip>
</Step>
</Steps>

### Delete a label

<Badge shape="rounded" size="sm" stroke color="purple">Enterprise Edition</Badge>

<Step title="Edit or delete a label">
Choose one of the following actions:
You cannot delete the default **Owned** label, but you can edit its description and rules.

<Tabs>
<Tab title="Edit a label" icon="edit">
To edit the label:
<DeleteZoneLabel tab="label" />

1. Modify the label's name and description.
To delete an existing label, follow these steps:

1. Click **Save Edits** to apply your changes.
</Tab>
<Steps>
<Step title="Select a label">
Navigate to the **Labels** tab, select the label you want to delete, and click **Edit Label**.
</Step>

<Tab title="Delete a label" icon="trash-can">
To delete the label:
<Step title="Delete the label">
To delete the label:

1. Click <Icon icon="trash-can" /> **Delete Label** at the bottom of the page
1. Click <Icon icon="trash-can" /> **Delete Label** at the top of the page.
1. Confirm your action in the dialog.

<img
src="/images/privzones/confirm-label-delete.png"
alt="Confirm deletion of a custom privilege zone"
alt="A view of the Zone Builder confirm label delete dialog"
style={{ width:"70%" }}
/>

1. Click **Confirm** to delete the label.
</Tab>
</Tabs>
</Step>
</Steps>
20 changes: 12 additions & 8 deletions docs/analyze-data/privilege-zones/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Overview
description: Discover how Privilege Zones help you organize and segment your environment based on sensitivity and access level.
---

import ContactSales from '/snippets/privilege-zones/contact-sales.mdx';

<img noZoom src="/assets/enterprise-AND-community-edition-pill-tag.svg" alt="Applies to BloodHound Enterprise and CE" />

Privilege Zones help you organize objects in your environment into logical groups based on their privilege and risk levels. Using Privilege Zones, you can monitor and maintain the security posture of tiered isolation models.
Expand All @@ -16,30 +18,32 @@ Review these key concepts before exploring Privilege Zones. You can find detaile
| Concept | Description | Used in Risk Analysis |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | :-------------------: |
| **Zone** | A group of objects representing the hierarchy of control across all domains in an environment (based on access level) | <Icon icon="square-check" iconType="solid" color="#22c55e" /> |
| **Label** | A flexible way to categorize objects within a zone (or across zones) for easier searching and filtering | <Icon icon="square-xmark" iconType="solid" color="#ef4444" /> |
| **Rule** | A set of instructions that associates objects with zones and labels, based on object types, relationships (expansion), or Cypher queries | <Icon icon="square-check" iconType="solid" color="#22c55e" /> |
| **Tagging** | The process of associating objects with zones and labels using rules | <Icon icon="square-check" iconType="solid" color="#22c55e" /> |
| **Certification** | _[BHE only]_ An optional process to interrupt automatic inclusion of additional objects in a zone by requiring manual certification of the additional objects | <Icon icon="square-check" iconType="solid" color="#22c55e" /> |
| **Label** | A flexible way to categorize objects for easier searching and filtering | <Icon icon="square-xmark" iconType="solid" color="#ef4444" /> |
| **Certification** | <Badge shape="rounded" size="sm" stroke color="purple">Enterprise Edition</Badge> An optional process to interrupt automatic inclusion of additional objects in a zone by requiring manual certification of the additional objects | <Icon icon="square-check" iconType="solid" color="#22c55e" /> |

Zones organize objects into a strict hierarchy. BloodHound analyzes how object privileges are assigned and where they can be escalated across your environment.

By default, BloodHound includes a **Tier Zero** zone that represents a set of objects with full control over an environment *and* any objects with control over those objects. See [Tier Zero: Members and Modification](/get-started/security-boundaries/tier-zero-members) to learn more.

<Note>By default, you can [create up to two additional zones](/analyze-data/privilege-zones/zones) to match your organization's security model. If you need to create more zones, contact your account manager.</Note>
<ContactSales/>

If BloodHound detects an object in a lower-privileged zone controlling an object in a higher-privileged zone, it identifies it as a finding in the **Attack Paths** and **[Posture](/analyze-data/posture-page)** pages. For example, if a Tier One user can control a Tier Zero server, BloodHound flags it as a violation of the privilege model.
If BloodHound Enterprise detects an object in a lower-privileged zone controlling an object in a higher-privileged zone, it identifies it as a finding in the **Attack Paths** and **[Posture](/analyze-data/posture-page)** pages. For example, if a Tier One user can control a Tier Zero server, BloodHound flags it as a violation of the privilege model.

This analysis helps you identify and remediate privilege escalation paths and misconfigurations that violate your security model.

{/* TODO The following diagram illustrates the control relationships between a set of hypothetical zones: */}

## Features

The **Privilege Zones** page provides the following tabs:
The **Zone Builder** page provides tools for configuring and managing your privilege zones.

Once configured, BloodHound Enterprise analyzes your zones and displays findings in the **Attack Paths** and **Posture** pages.

The **Zone Builder** page provides the following tabs:

* **Zones**: A group of objects that represent the hierarchy of control across all domains in an environment based on access level
* **Labels**: A flexible way to categorize a group of objects in a single zone (or across multiple zones) for easier searching and filtering
* **Certification** _[BHE only]_: An optional process to interrupt automatic inclusion of additional objects in a zone by requiring manual certification of the additional objects
* **Certifications** <Badge shape="rounded" size="sm" stroke color="purple">Enterprise Edition</Badge>: An optional process to interrupt automatic inclusion of additional objects in a zone by requiring manual certification of the additional objects
* **History**: An audit log of changes made to your zones and labels over time

These tools enable further risk mitigation in your environments by highlighting the violations and misconfigurations in your tiered network model.
Loading