Attack Surface Analyzer
Attack Surface Analyzer is a Microsoft developed open source security tool that analyzes the attack surface of a target system and reports on potential security vulnerabilities introduced during the installation of software or system misconfiguration.
Getting Attack Surface Analyzer
If you have the .NET Core SDK installed you can install Attack Surface Analyzer with
dotnet tool install -g Microsoft.CST.AttackSurfaceAnalyzer.CLI.
Platform specific binaries for Attack Surface Analyzer are distributed via our GitHub releases page.
Documentation is available on the Wiki.
Documentation for the API is available on GitHub Pages.
New Features in 2.2
- Expanded analysis engine allowing users to define arbitrary boolean expressions across clauses and access sub properties of objects. See Authoring Rules on the wiki for more information on creating rules.
- Significantly improved collection and analysis performance.
- MacOS binary signature checking
- Support for C# 8 nullable reference types
- Improved database independent API
- Updated API documentation and Developer guide
Attack Surface Analyzer 2 replaces the original Attack Surface Analyzer tool, released publicly in 2012.
Potential users of Attack Surface Analyzer include:
- DevOps Engineers - View changes to the system attack surface introduced when your software is installed.
- IT Security Auditors - Evaluate risk presented by when third-party software is installed.
The core feature of Attack Surface Analyzer is the ability to "diff" an operating system's security configuration, before and after a software component is installed and to run arbitrary complex rules on the results to surface interesting findings. This is important because most installation processes require elevated privileges, and once granted, can lead to unintended system configuration changes.
Attack Surface Analyzer currently reports on changes to the following operating system components:
- File system (static snapshot and live monitoring available)
- User accounts
- Network Ports
- COM Objects
- Event Logs
- Firewall Settings
All data collected is stored in a set of local SQLite databases.
How to Use Attack Surface Analyzer
Run the following commands in an Administrator Shell (or as root). Replace
asa.exe as appropriate for your platform.
To start a default all collectors run:
asa collect -a
To compare the last two collection runs:
For other commands run:
For the GUI interface run:
asa gui and a browser window should open directed at
http://localhost:5000 with the web based interface.
Detailed information on how to use Attack Surface Analyzer can be found on our wiki.
To build Attack Surface Analyzer, see BUILD.
The latest stable version of Attack Surface Analyzer is 2.2 (see Release\v2.2).
2.3 is now in development on the
main branch. You can see the features coming here.
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.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., label, 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.
Reporting Security Issues
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at firstname.lastname@example.org. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.
Attack Surface Analyzer 2 is licensed under the MIT license.