Convert Figma logo to code with AI

dirkjanm logoBloodHound.py

A Python based ingestor for BloodHound

2,121
348
2,121
25
View on GitHub

Top Related Projects

dirkjanm's avatar

BloodHound.py

2,198

A Python based ingestor for BloodHound

SpecterOps's avatar

BloodHound-Legacy

10,278

Six Degrees of Domain Admin

Quick Overview

BloodHound.py is a Python-based ingestor for BloodHound, a tool used for Active Directory security assessment. It allows users to collect data about Active Directory environments without requiring administrator privileges on domain systems, making it a valuable tool for both red team operations and security audits.

Pros

  • Cross-platform compatibility (Windows, Linux, macOS)
  • Doesn't require administrative privileges for data collection
  • Supports various authentication methods (Kerberos, NTLM, username/password)
  • Lightweight and easy to deploy compared to the original C# BloodHound ingestor

Cons

  • May trigger security alerts in some environments due to its data collection activities
  • Requires careful handling of collected data to maintain security and privacy
  • Limited compared to the full C# BloodHound ingestor in terms of some advanced features
  • Potential for misuse if not handled responsibly

Code Examples

  1. Basic usage to collect all data:
from bloodhound import BloodHound

bh = BloodHound()
bh.collect_all()
  1. Collecting specific data types:
from bloodhound import BloodHound

bh = BloodHound()
bh.collect_users()
bh.collect_groups()
bh.collect_computers()
  1. Using alternative authentication methods:
from bloodhound import BloodHound

bh = BloodHound(username='user@domain.com', password='password')
# Or with Kerberos ticket
# bh = BloodHound(auth_method='kerberos', ticket_file='/path/to/ticket')
bh.collect_all()

Getting Started

To get started with BloodHound.py:

  1. Install the library:

    pip install bloodhound

  2. Import and use in your Python script:

    from bloodhound import BloodHound

bh = BloodHound(domain='domain.com')
bh.collect_all()

  3. Run the script with appropriate permissions in the target environment.

  4. Import the generated JSON files into the BloodHound GUI for analysis.

Remember to use this tool responsibly and only in environments where you have explicit permission to perform security assessments.

Competitor Comparisons

dirkjanm logo

BloodHound.py

2,198

A Python based ingestor for BloodHound

Pros of BloodHound.py

  • Python-based implementation, offering cross-platform compatibility
  • Lightweight and easy to integrate into existing Python-based workflows
  • Provides a command-line interface for easy automation and scripting

Cons of BloodHound.py

  • May have fewer features compared to the original BloodHound implementation
  • Potentially slower performance for large-scale data collection and analysis
  • Might require additional Python dependencies to be installed

Code Comparison

BloodHound.py:

def get_domain_controllers(self):
    q = """
    MATCH (n:Computer)
    WHERE n.domain={domain} AND n.objectsid ENDS WITH "-516"
    RETURN n.name
    """
    return self.cypher(q, domain=self.domain)

Both repositories are the same project, so there isn't a meaningful code comparison to make between them. The code snippet above is an example of how BloodHound.py interacts with the Neo4j database to retrieve domain controllers.

Summary

BloodHound.py is a Python implementation of the BloodHound tool, which is used for Active Directory security assessment. It offers cross-platform compatibility and ease of integration with Python-based workflows. However, it may have some limitations in terms of features and performance compared to the original C# implementation. The project is suitable for users who prefer working with Python or need to incorporate BloodHound functionality into existing Python scripts.

SpecterOps logo

BloodHound-Legacy

10,278

Six Degrees of Domain Admin

Pros of BloodHound-Legacy

  • More comprehensive and feature-rich, offering a full-fledged GUI application
  • Provides advanced visualization capabilities for Active Directory environments
  • Includes built-in analysis features and attack path identification

Cons of BloodHound-Legacy

  • Requires more setup and dependencies compared to the lightweight BloodHound.py
  • May have a steeper learning curve for users new to the tool
  • Less flexible for integration into custom scripts or automation workflows

Code Comparison

BloodHound-Legacy (C#):

public class SessionHandler
{
    public static void GetUserSessions(string computerName, ResolvedCollectionMethod collectionMethod)
    {
        // Implementation details
    }
}

BloodHound.py (Python):

def get_sessions(self):
    def worker():
        self.get_session_data()
    self.start_job('Sessions', worker)

The code snippets show different approaches to session handling. BloodHound-Legacy uses a more structured C# class, while BloodHound.py employs a simpler Python function with a worker method. This reflects the overall design philosophy of each project, with BloodHound-Legacy being more comprehensive and BloodHound.py focusing on simplicity and ease of use.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

BloodHound.py

Python 3 compatible PyPI version License: MIT

BloodHound.py is a Python based ingestor for BloodHound, based on Impacket.

The code in this branch is only compatible with BloodHound 4.2 and 4.3. For BloodHound CE, check out the bloodhound-ce branch

Installation

There are different install methods for BloodHound Community Edition (CE) and BloodHound legacy. You can only have one of the two tools installed at the same time, unless you use a virtual environment for both tools, or a package manager like pipx that automatically sets these up.

BloodHound Legacy

The following install methods are available:

  • Via pip: pip install bloodhound
  • Via pipx: pipx install bloodhound
  • By cloning this repository git clone https://github.com/dirkjanm/BloodHound.py and running pip install . from the project directory.

The BloodHound.py Legacy installation will add a command line tool bloodhound-python to your PATH.

BloodHound CE

The following install methods are available:

  • Via pip: pip install bloodhound-ce
  • Via pipx: pipx install bloodhound-ce
  • By cloning this repository git clone https://github.com/dirkjanm/BloodHound.py, checking out the CE branch git checkout bloodhound-ce and running pip install . from the project directory.

The BloodHound.py CE ingestor will add a command line tool bloodhound-ce-python to your PATH.

Usage

To use the ingestor, at a minimum you will need credentials of the domain you're logging in to. Credentials can be specified as username + password, NT hash or AES keys, or a Kerberos TGT in a ccache file. You will need to specify the -u option with a username of this domain (or username@domain for a user in a trusted domain). If you have your DNS set up properly and the AD domain is in your DNS search list, then BloodHound.py will automatically detect the domain for you. If not, you have to specify it manually with the -d option.

By default BloodHound.py will query LDAP and the individual computers of the domain to enumerate users, computers, groups, trusts, sessions and local admins. If you want to restrict collection, specify the --collectionmethod parameter, which supports the following options (similar to SharpHound):

  • Default - Performs group membership collection, domain trust collection, local admin collection, and session collection
  • Group - Performs group membership collection
  • LocalAdmin - Performs local admin collection
  • RDP - Performs Remote Desktop Users collection
  • DCOM - Performs Distributed COM Users collection
  • Container - Performs container collection (GPO/Organizational Units/Default containers)
  • PSRemote - Performs Remote Management (PS Remoting) Users collection
  • DCOnly - Runs all collection methods that can be queried from the DC only, no connection to member hosts/servers needed. This is equal to Group,Acl,Trusts,ObjectProps,Container
  • Session - Performs session collection
  • Acl - Performs ACL collection
  • Trusts - Performs domain trust enumeration
  • LoggedOn - Performs privileged Session enumeration (requires local admin on the target)
  • ObjectProps - Performs Object Properties collection for properties such as LastLogon or PwdLastSet
  • All - Runs all methods above, except LoggedOn
  • Experimental - Connects to individual hosts to enumerate services and scheduled tasks that may have stored credentials

Multiple collectionmethods should be separated by a comma, for example: -c Group,LocalAdmin

You can override some of the automatic detection options, such as the hostname of the primary Domain Controller if you want to use a different Domain Controller with -dc, or specify your own Global Catalog with -gc.

Limitations

BloodHound.py currently has the following limitations:

  • Supports most, but not all BloodHound (SharpHound) features. Currently GPO local groups are not supported, all other collection methods are implemented.

Docker usage

  1. Build container
    docker build -t bloodhound .
  2. Run container
    docker run -v ${PWD}:/bloodhound-data -it bloodhound
    After that you can run bloodhound-python inside the container, all data will be stored in the path from where you start the container.

Credits

BloodHound.py was originally written by Dirk-jan Mollema, Edwin van Vliet and Matthijs Gielen from Fox-IT (NCC Group). BloodHound.py is currently maintained by Dirk-jan Mollema from Outsider Security. The implementation and data model is based on the original tool from SpecterOps. Many thanks to everyone who contributed by testing, submitting issues and pull requests over the years.