+ +
+ + Features • + Installation • + Usage • + Scope +
-## Get AzureHoundAD +The Attack Path Management data collector for Microsoft Azure -#### Release Binaries +AzureHound collects data from Azure Active Directory (AzureAD) and Azure Resource Manager (AzureRM). It can then send this data to Attack Path Management, maybe BloodHound Enterprise for processing and analysis. -Download the appropriate binary for your platform from one of our [Releases](https://github.com/byt3n33dl3/AzureHoundAD/releases). +AzureHound uses the Microsoft Graph and Azure REST APIs to collect data. It can run on any operating system and doesn't require any external dependencies. Authentication Attack with AzureHound supports several authentication flows, including username or password, JWT, refresh token, service principal secret, and service principal certificate. + +- AzureHound is a Go binary that collects data from AzureAD and AzureRM via the MS Graph and Azure REST APIs. -#### Rolling Release +# Get AzureHoundAD + +Download the appropriate binary for your platform from one of our [Releases](https://github.com/byt3n33dl3/AzureHoundAD/releases). The rolling release contains pre-built binaries that are automatically kept up-to-date with the `main` branch and can be downloaded from [here](https://github.com/byt3n33dl3/AzureHoundAD/releases/tag/rolling). @@ -22,9 +31,7 @@ The rolling release contains pre-built binaries that are automatically kept up-t ## Compiling -#### Prerequisites - -- [Go 1.18](https://go.dev/dl) or later +- Go [1.18](https://go.dev/dl) or later To build this project from source run the following: @@ -34,8 +41,6 @@ go build -ldflags="-s -w -X github.com/byt3n33dl3/AzureHoundAD/v2/constants.Vers ## Usage -#### Quickstart - **Print all Azure Tenant data to stdout** ```sh @@ -57,12 +62,12 @@ go build -ldflags="-s -w -X github.com/byt3n33dl3/AzureHoundAD/v2/constants.Vers ❯ azurehound start ``` -## CLI +## Command Line ``` ❯ azurehound --help AzureHound vx.x.x -Created by the BloodHound Enterprise team - https://bloodhoundenterprise.io +Created by the BloodHound Enterprise team - The official tool for collecting Azure data for BloodHound and BloodHound Enterprise @@ -77,7 +82,7 @@ Available Commands: start Start Azure data collection service for BloodHound Enterprise Flags: - -c, --config string AzureHound configuration file (default: /Users/dlees/.config/azurehound/config.json) + -c, --config string AzureHound configuration file (.config/azurehound/config.json) -h, --help help for azurehound --json Output logs as json -j, --jwt string Use an acquired JWT to authenticate into Azure @@ -89,3 +94,10 @@ Flags: Use "azurehound [command] --help" for more information about a command. ``` + +
+
