https://github.com/SpecterOps/AzureHound
Azure Data Exporter for BloodHound
https://github.com/SpecterOps/AzureHound
azure go
Last synced: 2 days ago
JSON representation
Azure Data Exporter for BloodHound
- Host: GitHub
- URL: https://github.com/SpecterOps/AzureHound
- Owner: SpecterOps
- License: gpl-3.0
- Created: 2022-05-26T18:48:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T19:03:19.000Z (15 days ago)
- Last Synced: 2025-04-28T20:22:41.546Z (15 days ago)
- Topics: azure, go
- Language: Go
- Homepage:
- Size: 906 KB
- Stars: 679
- Watchers: 25
- Forks: 91
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# AzureHound
The BloodHound data collector for Microsoft Azure
[](https://pkg.go.dev/github.com/SpecterOps/azurehound)
## Get AzureHound
### Release Binaries
Download the appropriate binary for your platform from one of our [Releases](https://github.com/SpecterOps/azurehound/releases).
#### Rolling Release
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/SpecterOps/azurehound/releases/tag/rolling).
> **Warning:** The rolling release may be unstable.
## Compiling
##### Prerequisites
- [Go 1.18](https://go.dev/dl/) or later
To build this project from source run the following:
```sh
go build -ldflags="-s -w -X github.com/bloodhoundad/azurehound/v2/constants.Version=`git describe tags --exact-match 2> /dev/null || git rev-parse HEAD`"
```
## Documentation
Please refer to the [BloodHound Community Edition documentation](https://bloodhound.specterops.io/home) for:
- [AzureHound Community Edition](https://bloodhound.specterops.io/collect-data/ce-collection/azurehound)
- [AzureHound Community Edition Flags](https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags)
## Usage
### Quickstart
**Print all Azure Tenant data to stdout**
```sh
❯ azurehound list -u "$USERNAME" -p "$PASSWORD" -t "$TENANT"
```
**Print all Azure Tenant data to file**
```sh
❯ azurehound list -u "$USERNAME" -p "$PASSWORD" -t "$TENANT" -o "mytenant.json"
```
**Print all Azure Tenant data to file, reusing your existing authentication from the Azure CLI**
```
❯ JWT=$(az account get-access-token --resource https://graph.microsoft.com | jq -r .accessToken)
❯ azurehound list --jwt "$JWT"
```
**Configure and start data collection service for BloodHound Enterprise**
```sh
❯ azurehound configure
(follow prompts)
❯ azurehound start
```
### CLI
```
❯ azurehound --help
AzureHound vx.x.x
Created by the BloodHound Enterprise team at SpecterOps - [https://bloodhoundenterprise.io](https://specterops.io/bloodhound-overview/)
The official tool for collecting Azure data for BloodHound Community Edition and BloodHound Enterprise
Usage:
azurehound [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
configure Configure AzureHound
help Help about any command
list Lists Azure Objects
start Start Azure data collection service for BloodHound Enterprise
Flags:
-c, --config string AzureHound configuration file (default: /Users/dlees/.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
--log-file string Output logs to this file
--proxy string Sets the proxy URL for the AzureHound service
-r, --refresh-token string Use an acquired refresh token to authenticate into Azure
-v, --verbosity int AzureHound verbosity level (defaults to 0) [Min: -1, Max: 2]
--version version for azurehound
Use "azurehound [command] --help" for more information about a command.
```