Add Docfx

docfx/.gitignore

@@ -0,0 +1,10 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
+obj

docfx/api/.gitignore

@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest

docfx/api/index.md

@@ -0,0 +1,3 @@
+# Explore
+
+You can explore the Attack Surface Analyzer API using the navigation bar to the left.

docfx/docfx.json

@@ -0,0 +1,66 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "Lib.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src":"../Lib"
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}

docfx/index.md

@@ -0,0 +1,116 @@
+# Attack Surface Analyzer 
+Attack Surface Analyzer is a [Microsoft](https://github.com/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
+![Nuget](https://img.shields.io/nuget/v/Microsoft.CST.AttackSurfaceAnalyzer.Cli?link=https://www.nuget.org/packages/Microsoft.CST.AttackSurfaceAnalyzer.CLI&link=https://www.nuget.org/packages/Microsoft.CST.AttackSurfaceAnalyzer.CLI) ![Nuget](https://img.shields.io/nuget/dt/Microsoft.CST.AttackSurfaceAnalyzer.Cli?link=https://www.nuget.org/packages/Microsoft.CST.AttackSurfaceAnalyzer.CLI&link=https://www.nuget.org/packages/Microsoft.CST.AttackSurfaceAnalyzer.CLI)
+
+If you have the [.NET Core SDK](https://dotnet.microsoft.com/download) 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](https://github.com/Microsoft/AttackSurfaceAnalyzer/releases/latest) page.
+
+## Documentation
+
+Documentation is available on the [Wiki](https://github.com/Microsoft/AttackSurfaceAnalyzer/wiki/).
+
+### API Documentation
+
+#### Main Branch
+
+[https://microsoft.github.io/AttackSurfaceAnalyzer/api/](https://microsoft.github.io/AttackSurfaceAnalyzer/api/)
+
+#### Version 2.3
+[https://microsoft.github.io/AttackSurfaceAnalyzer/v2.3/api/](https://microsoft.github.io/AttackSurfaceAnalyzer/v2.3/api/)
+
+#### Version 2.2
+[https://microsoft.github.io/AttackSurfaceAnalyzer/v2.2/api/](https://microsoft.github.io/AttackSurfaceAnalyzer/v2.2/api/)
+
+## New Features in 2.3
+
+- Rewritten GUI with Rule Authoring and Testing in GUI.
+- New Collectors
+
+## Overview
+
+Attack Surface Analyzer 2 replaces the original [Attack Surface Analyzer](https://www.microsoft.com/en-us/download/details.aspx?id=24487) 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.
+
+## Core Features
+
+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
+- Services
+- Network Ports
+- Certificates
+- Registry
+- COM Objects
+- Event Logs
+- Firewall Settings
+- Saved Wifi Networks
+
+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``` with ```asa.exe``` as appropriate for your platform.
+
+### CLI Mode
+To start a default all collectors run: ```asa collect -a```
+
+To compare the last two collection runs: ```asa export-collect```
+
+For other commands run: ```asa --help```
+
+### GUI Mode
+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](https://github.com/Microsoft/AttackSurfaceAnalyzer/wiki).
+
+## Building
+
+To build Attack Surface Analyzer, see [BUILD](https://github.com/Microsoft/AttackSurfaceAnalyzer/blob/main/BUILD.md).
+
+## Versions
+The latest stable version of Attack Surface Analyzer is 2.2 (see [Release\v2.2](https://github.com/Microsoft/AttackSurfaceAnalyzer/tree/release/v2.2)).  
+
+2.3 is now in development on the `main` branch.  You can see the features coming [here](https://github.com/microsoft/attacksurfaceanalyzer/issues?q=is%3Aissue+milestone%3Av2.3+).
+
+## Contributing
+
+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](https://opensource.microsoft.com/codeofconduct/).
+
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Reporting Security Issues
+
+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).
+
+## License
+
+Attack Surface Analyzer 2 is licensed under the
+[MIT license](https://github.com/Microsoft/AttackSurfaceAnalyzer/blob/main/LICENSE).

docfx/toc.yml

@@ -0,0 +1,5 @@
+- name: Articles
+  href: articles/
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md