Skip to main content

AzureFox - offensive-focused Azure situational awareness CLI

Project description

AzureFox

AzureFox logo

AzureFox is a Python CLI for offensive-focused Azure situational awareness. It helps operators and testers figure out what Azure identity, network, secrets, and workload exposure they can actually see from management-plane read paths.

Quickstart

pip install azurefox

By default, AzureFox writes artifacts into your current directory. If you want them somewhere else, pass --outdir:

azurefox --outdir ./azurefox-demo whoami --output table
azurefox --outdir ./azurefox-demo all-checks --output table

Currently Supported Azure Commands

Section Commands
core inventory
identity whoami, rbac, principals, permissions, privesc, role-trusts, lighthouse, auth-policies, managed-identities
config arm-deployments, env-vars
secrets keyvault, tokens-credentials
resource automation, devops, acr, api-mgmt, databases, resource-trusts
storage storage
network nics, dns, endpoints, network-effective, network-ports
compute workloads, app-services, functions, aks, vms, vmss, snapshots-disks
orchestration all-checks

Need A Test Lab?

Don't have an Azure environment handy? The companion repo AzureFox OpenTofu Proof Lab spins up a deliberately insecure Azure lab for demos, validation, and practice.

Use a disposable subscription you control. It is risky on purpose.

CLI Invocation

Shared flags like --tenant, --subscription, --output, --outdir, and --debug work before or after the command.

These forms are equivalent:

azurefox dns --output json --outdir ./azurefox-demo
azurefox --output json --outdir ./azurefox-demo dns

Use azurefox <command> --help or azurefox help <command> for command-specific help.

Install Profiles

AzureFox installs the live Azure runtime dependencies by default so pip install azurefox is ready for real Azure command execution.

If you prefer an isolated virtual environment:

python -m venv .venv
# macOS/Linux
source .venv/bin/activate
# Windows PowerShell
# .venv\Scripts\Activate.ps1
pip install azurefox

For local source-based development, use pip install -e '.[dev]'.

AzureFox is intended to work on macOS, Linux, and Windows. The command examples below use portable relative paths like ./azurefox-demo; shell syntax mainly differs for virtualenv activation and environment-variable export.

Live operator guidance is built into azurefox help and azurefox help <command>. Longer-form planning and wiki-source material lives under wiki/.

  • pip install azurefox installs the normal operator profile from PyPI, including the Azure SDK dependencies used by the implemented live commands
  • pip install -e . installs the same live Azure command profile from a local checkout
  • pip install -e '.[dev]' installs contributor tooling on top of the default live Azure dependencies; this is the normal repo development profile

Auth Precedence

  1. Azure CLI credential
  2. Environment/service principal credential

Web auth (browser-based) via Azure CLI

If you want web-based authentication, run az login first (outside AzureFox), then run AzureFox. AzureFox does not currently launch its own browser auth flow.

Azure CLI example:

az login
az account set --subscription <subscription-id>
azurefox inventory --subscription <subscription-id>

Non-web auth (no az login required)

If you do not want to use web auth, set service principal environment variables and pass CLI flags for tenant/subscription targeting.

Environment credential + CLI options example:

# macOS/Linux
export AZURE_TENANT_ID=<tenant-id>
export AZURE_CLIENT_ID=<client-id>
export AZURE_CLIENT_SECRET=<client-secret>
export AZUREFOX_DEVOPS_ORG=<org-name> # only needed for the devops command
azurefox whoami --tenant <tenant-id> --subscription <subscription-id>
# Windows PowerShell
$env:AZURE_TENANT_ID="<tenant-id>"
$env:AZURE_CLIENT_ID="<client-id>"
$env:AZURE_CLIENT_SECRET="<client-secret>"
$env:AZUREFOX_DEVOPS_ORG="<org-name>" # only needed for the devops command
azurefox whoami --tenant <tenant-id> --subscription <subscription-id>

AZUREFOX_DEVOPS_ORG is only needed when running the devops command. The identity used for devops still needs access to the Azure DevOps organization, not just ARM access to the tenant or subscription.

Output Modes

  • --output table (default)
  • --output json
  • --output csv

All commands write artifacts under <outdir>/:

  • loot/<command>.json
  • json/<command>.json
  • table/<command>.txt
  • csv/<command>.csv
  • run-summary.json for all-checks

Sections And All-Checks

AzureFox keeps flat standalone commands and also supports grouped execution:

azurefox all-checks
azurefox all-checks --section identity
azurefox all-checks --section config
azurefox all-checks --section secrets
azurefox all-checks --section resource
azurefox all-checks --section network
azurefox all-checks --section storage
azurefox all-checks --section compute

Treat all-checks as a broader validation pass, not a quick spot check. It can take much longer than a single command, especially when a full section is writing grouped artifacts.

Current section mappings:

  • identity: whoami, rbac, principals, permissions, privesc, role-trusts, lighthouse, auth-policies, managed-identities
  • config: arm-deployments, env-vars
  • secrets: keyvault, tokens-credentials
  • resource: automation, devops, acr, api-mgmt, databases, resource-trusts
  • storage: storage
  • network: nics, dns, endpoints, network-effective, network-ports
  • compute: workloads, app-services, functions, aks, vms, vmss, snapshots-disks
  • core: inventory

Help

AzureFox supports generic and scoped help:

azurefox help
azurefox help identity
azurefox help permissions
azurefox dns --help
azurefox -h identity
azurefox -h permissions

Command help includes ATT&CK cloud leads as investigation prompts, not proof that a technique occurred.

For ad hoc demos or local testing, use a dedicated path like --outdir ./azurefox-demo so artifacts do not pile up in the repo root.

Fixture Mode

Set AZUREFOX_FIXTURE_DIR to run against local fixture files rather than Azure APIs.

# macOS/Linux
AZUREFOX_FIXTURE_DIR=tests/fixtures/lab_tenant azurefox rbac --output json
# Windows PowerShell
$env:AZUREFOX_FIXTURE_DIR="tests/fixtures/lab_tenant"
azurefox rbac --output json

Development

pip install -e '.[dev]'
ruff check .
pytest

CI runs lint plus unit, contract, and smoke tests. Integration tests are opt-in.

Attribution

AzureFox is inspired by CloudFox, created by Bishop Fox. The command model and operator workflow goals in this project are heavily shaped by CloudFox's approach to cloud situational awareness and attack-path-focused enumeration.

This project is an independent implementation and is not affiliated with or endorsed by Bishop Fox.

License

AzureFox is licensed under the MIT License to match CloudFox's licensing model. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

azurefox-1.2.0.tar.gz (129.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

azurefox-1.2.0-py3-none-any.whl (106.2 kB view details)

Uploaded Python 3

File details

Details for the file azurefox-1.2.0.tar.gz.

File metadata

  • Download URL: azurefox-1.2.0.tar.gz
  • Upload date:
  • Size: 129.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for azurefox-1.2.0.tar.gz
Algorithm Hash digest
SHA256 290a0baf806dcddc18fc4af93cc9dc0c3e61a4064c8d0ce81c183db059a01b0a
MD5 019f08ce9cbfebe2947ac0a802fcee1c
BLAKE2b-256 707274b7602c1dbee06c0c31a3be15060da16024930a2d6388da60bcae93055f

See more details on using hashes here.

Provenance

The following attestation bundles were made for azurefox-1.2.0.tar.gz:

Publisher: release.yml on TacoRocket/AzureFox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file azurefox-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: azurefox-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 106.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for azurefox-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a89b79f384d2312335b297a535c4bd698f44ddcb6b44b9f9186ea62fc6218d65
MD5 652f491bbea446c871e11fa1b7d7efaa
BLAKE2b-256 46a3d42224b4c5945d7626ccec12fbcb34984fc7e054ee0694013ae287fff17e

See more details on using hashes here.

Provenance

The following attestation bundles were made for azurefox-1.2.0-py3-none-any.whl:

Publisher: release.yml on TacoRocket/AzureFox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page