Stormspotter creates an “attack graph” of the resources in an Azure subscription. It enables red teams and pentesters to visualize the attack surface and pivot opportunities within a tenant, and supercharges your defenders to quickly orient and prioritize incident response work.
It needs reader access to the subscription you wish to import and/or Directory. Read access to the Azure AD tenants.
- Stormspotter is developed in Python 3.8.
- Install Neo4j. Currently, neo4j 4.0 may cause errors when launching Stormdash if you do not manually configure it with an SSL cert. Installation directions for your preferred operating system are located here, although you may prefer the ease of a docker container:
docker run --name stormspotter -p7474:7474 -p7687:7687 -d --env NEO4J_AUTH=neo4j/[password] neo4j:3.5.18
In order to avoid conflicting packages, it is highly recommended to run Stormspotter in a virtual environment.
- Install the requirements
- From the repository (RECOMMENDED)
git clone https://github.com/Azure/Stormspotter cd Stormspotter pipenv install .
- Via pipenv
python -m pip install pipenv pipenv install stormspotter==1.0.0a0
Current login types supported:
- Azure CLI (must use
- Service Principal Client ID/Secret
Gather and view resources
- Run stormspotter to gather resource and object information
- Via CLI login
- Via Service Principal
stormspotter --service-principal -u <client id> -p <client secret> -t <tenant id>
- Run stormdash to launch dashboard
stormdash -dbu <neo4j-user> -dbp <neo4j-pass>
- During installation, a
.stormspotterfolder is created in the user's home directory. Place the results zip file into
~/.stormspotter/inputfolder. You may also place the zip file into the folder before running
stormdashand it will be processed when Stormspotter starts. When a file is successfully processed, it will be moved into
- Browse to http://127.0.0.1:8050 to interact with the graph.
- With Stormspotter currently in alpha, not all resource types have been implemented in Stormdash. You may see labels with missing icons and/or simply display the "name" and "type" fields. You can still view the data associated with these assets by clicking the "Raw Data" slider. Over time, more resources will be properly implemented.
- The node expansion feature has not been implemented yet. This feature will allow you to interact with a node to see all of its relations. As a fallback to Stormdash, you can visit the Neo4J instance directly to use this feature.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.