Updated Home (markdown)

Gabe Stocco 2019-05-17 20:55:19 -07:00
Родитель a3d01af834
Коммит 0d867685fe
1 изменённых файлов: 22 добавлений и 7 удалений

29
Home.md

@ -37,7 +37,22 @@ The assumption is that both data collection and data analysis will be run on the
elements are collected in the baseline and subsequent scans.
## Running ASA from the GUI
To run ASA, navigate to the Attack Surface Analyzer program folder where it was downloaded and right-click asa.exe (Windows), and select Run as administrator from the context menu that appears. For Linux and MacOS, ensure the user account is an administrator and the files are located in an appropriate administrator folder to run it as needed.
### Full GUI (Electron)
The Full GUI is a standalone Electron application powered by an ASP.NET backend which performs the heavy lifting. The Full GUI is currently available on Windows 10 and Linux.
#### Windows
Navigate to the Attack Surface Analyzer program folder where it was downloaded and right-click ```asa.exe```, and select Run as administrator from the context menu that appears.
#### Linux
```sudo asa```
### Slim GUI
The 'Slim' GUI is just the ASP.NET backend that powers the Electron GUI. This allows you to bring your own browser and is a smaller download. Further, the Slim GUI should function on older versions of Windows, where the Full GUI is restricted to Windows 10.
#### Startup
- Windows, open an Administrator Command Prompt and run ```AttackSurfaceAnalyzer-GUI.exe```.
- Mac OS/Linux, use sudo - ```sudo AttackSurfaceAnalyzer-GUI```.
#### Operating
- Once you have started ```AttackSurfaceAnalyzer-GUI``` navigate to ```localhost:5000``` in your browser of choice.
### Collecting Data
* Select Scan located from the top menu or Start Scan from the home page. **Note**: Scanning should never be run on live production servers since it can severely degrade the performance of the system.
@ -60,15 +75,15 @@ The CLI version of the tool comes with built-in help using a help parameter i.e.
Follow the same general baseline and product snapshot procedures for the GUI application.
## Performance Considerations
Note that analyzer has very high CPU and memory demands, and often takes a considerable amount of time to complete. Analyses should never be run on live production servers since it can severely degrade the performance of the system. Use of the file system or registry (on Windows systems) will add significant time to the collection and analysis.
Note that analyzer has high CPU and disk I/O demands, and may take a considerable amount of time to complete. Analyses should never be run on live production servers since it can severely degrade the performance of the system.
## System Requirements
### Operating System Support
ASA is tested on Windows 7 (CLI version only), Windows 10, Ubuntu and MacOS systems. Using the GUI and CLI releases does not have any prerequisites.
ASA is tested on Windows 7 (CLI version only), Windows 10, Linux (currently Mint) and MacOS systems. No installed pre-requisites or redistributables are required, beyond those of .NET Core.
Our core technologies are .NET Core 2.1 and Electron. No other systems are tested at present but .NET Core is supported on the following versions of Windows:
Our core technologies are .NET Core 2.2 and Electron. No other systems are tested at present but .NET Core is supported on the following versions of Windows:
* Windows 7 SP1
* Windows 8.1
* Windows 10 Anniversary Update (version 1607) or later versions
@ -77,14 +92,14 @@ Our core technologies are .NET Core 2.1 and Electron. No other systems are test
* Windows Server 2012 R2 (Full Server or Server Core)
* Windows Server 2016 or later versions (Full Server, Server Core, or Nano Server)
Additional OS compatibility for .NET Core is located here https://github.com/dotnet/core/blob/master/release-notes/2.1/2.1-supported-os.md.
Additional OS compatibility for .NET Core is located here https://github.com/dotnet/core/blob/master/release-notes/2.2/2.2-supported-os.md.
Due to limitations in functionality of Server Core available, only the command line option is likely to be fully supported.
## Installation
### Binaries
The application does not come with an installation program but binaries are provided with each master branch update for convenience and can be downloaded for immediate use or you may build the source code and run it. Pre-built binaries are located under the [releases](https://github.com/Microsoft/AttackSurfaceAnalyzer/releases) menu.
The application does not come with an installation program but binaries are provided with each mast and release branch update for convenience and can be downloaded for immediate use or you may build the source code and run it. Pre-built binaries are located under [releases](https://github.com/Microsoft/AttackSurfaceAnalyzer/releases).
### Library
Installing Attack Surface Analyzer via NuGet
@ -98,7 +113,7 @@ ASA does not add or change any environment variables. If you believe it has don
Note that .cab files generated from versions of Attack Surface Analyzer are not compatible with Attack Surface Analyzer 2.0. You will need to run a new baseline and product scan to perform the analysis.
# Support
For submitting defects, just use the standard Github Issues link.
For submitting defects, just use the standard GitHub Issues link.
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [secure@microsoft.com](mailto:secure@microsoft.com). 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](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).