This repository has been archived by the owner on May 9, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
113 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,190 +1,32 @@ | ||
# Windows Protocol Test Suites | ||
# CVE-2020-1206 Uninitialized Kernel Memory Read POC | ||
|
||
**Windows Protocol Test Suites** provide interoperability testing against the implementation of Windows open specifications including File Services, Identity Management, Remote Desktop and etc. | ||
(c) 2020 ZecOps, Inc. - https://www.zecops.com - Find Attackers' Mistakes | ||
POC to check for CVE-2020-1206 / "SMBleed" | ||
Expected outcome: Local file containing target computer kernel memory. | ||
Intended only for educational and testing in corporate environments. | ||
ZecOps takes no responsibility for the code, use at your own risk. | ||
Please contact sales@ZecOps.com if you are interested in agent-less DFIR tools for Servers, Endpoints, and Mobile Devices to detect SMBleed and other types of attacks automatically. | ||
|
||
Originally developed for in-house testing of the Microsoft Open Specifications, Microsoft Protocol Test Suites have been used extensively during Plugfests and interoperability labs to test against partner implementations. | ||
A Test Suite evaluates whether a protocol or protocol family implementation meets certain interoperability requirements. | ||
Test Suites do not cover every protocol requirement and in no way certify an implementation, even if all tests pass. | ||
However, each test suite provides users with a useful indication of interoperability. | ||
## Usage | ||
|
||
* **SMB1 Server Test Suite**. It covers the requirements documented by [MS-SMB], and those documented by other protocols which are related to [MS-SMB], i.e. [MS-FSCC] and [MS-CIFS]. | ||
* **File Server Family Test Suite**. It is designed to test implementations of file server protocol family including [MS-SMB2], [MS-DFSC], [MS-SWN], [MS-FSRVP], [MS-FSA], [MS-RSVD] and [MS-SQOS]. | ||
* **RDP Client Family Test Suite**. It provides interoperability testing for client implementation of RDP family protocols including [MS-RDPBCGR], [MS-RDPEDISP], [MS-RDPEDYC], [MS-RDPEGFX], [MS-RDPEGT], [MS-RDPEI], [MS-RDPEMT], [MS-RDPEUDP], [MS-RDPEUSB], [MS-RDPEVOR] and [MS-RDPRFX]. | ||
* **RDP Server Family Test Suite**. It provides interoperability testing for server implementation of RDP family protocols including [MS-RDPBCGR], [MS-RDPEDYC], [MS-RDPEMT] and [MS-RDPELE]. | ||
* **Kerberos Server Test Suite**. It is designed to test server implementations of Kerberos protocols including [MS-KILE], [MS-KKDCP] and [MS-PAC]. | ||
* **SMBD Server Test Suite**. It is designed to test the implementations of SMB2&3 direct (RDMA) protocol, as specified in [MS-SMBD] and [MS-SMB2]. | ||
* **Branch Cache Test Suite**. It is designed to test the implementations of [MS-PCCRTP], [MS-PCCRR], [MS-PCHC] and [MS-PCCRC] protocol. | ||
* **AZOD Test Suite**. It is designed to test the implementations of [MS-AZOD] protocol. | ||
* **ADFamily Test Suite**. It is designed to test the implementations of the Active Directory protocols including [MS-ADTS], [MS-APDS], [MS-DRSR] [MS-FRS2], [MS-LSAD], [MS-LSAT], [MS-SAMR] and [MS-NRPC]. | ||
* **ADFSPIP Client Test Suite**. It is designed to test the implementations of ADFS Proxy and Web Application Proxy integration, as described in [MS-ADFSPIP]. | ||
* **ADOD Test Suite**. It is designed to test the implementations of [MS-ADOD] protocol. | ||
`SMBleed.exe server_name ip_address domain user pass share_name remote_path local_path` | ||
|
||
## Components | ||
Windows Protocol Test Suites contain 4 components: | ||
![demo](demo.gif) | ||
|
||
* **CommonScripts**. Common scripts used by each test suite. Normally they're used to deploy the environment. | ||
* **ProtocolTestManager**. A UI tool to help you configure and run test cases. | ||
* **ProtoSDK**. The protocol library used by each test suite. It provides the data structures of the protocol messages, the methods to encode and decode the messages, the methods to send and receive messages and etc. | ||
* **TestSuites**. All Test Suites code and documents are saved here and categorized by folder representing each test suite. | ||
## Compiled POC | ||
|
||
You can get the compiled POC [here](https://github.com/ZecOps/CVE-2020-1206-POC/releases). | ||
|
||
## Prerequisites | ||
The Test Suites are developed and must be installed on a Windows platform. | ||
You should install the software listed below based on your testing purpose, including their own dependencies. | ||
## Compiling | ||
|
||
1. [Visual Studio](https://visualstudio.microsoft.com/downloads/) 2017 or higher ([Visual Studio 2017 Community](https://aka.ms/vs/15/release/vs_community.exe) recommended), installed with these individual components from the installer: | ||
|
||
|Section|Individual Component in Visual Studio 2017|Individual Component in Visual Studio 2019|Run Windows Protocol Test Suites|Build Windows Protocol Test Suites from source code| | ||
|---|---|---|---|---| | ||
|.NET|.NET Framework 4.7.1 SDK|.NET Framework 4.7.1 SDK||Required| | ||
|.NET|.NET Framework 4.7.1 targeting pack|.NET Framework 4.7.1 targeting pack|Required|Required| | ||
|Compilers, build tools, and runtime|C# and Visual Basic Roslyn compilers|C# and Visual Basic Roslyn compilers||Required| | ||
|Compilers, build tools, and runtime|VC++ 2017 version 15.9 v14.16 latest v141 tools|MSVC v141 - VS 2017 C++ x64/x86 build tools (v14.16)||Required<sup>[1](#footnote1)</sup>| | ||
|Compilers, build tools, and runtime|Visual C++ 2017 Redistributable Update|C++ 2019 Redistributable Update|Required<sup>[1](#footnote1)</sup>|Required<sup>[1](#footnote1)</sup>| | ||
|Debugging and testing|Testing tools core features||Required<sup>[2](#footnote2)</sup>|Required<sup>[2](#footnote2)</sup>| | ||
|Developent Activities|Visual Studio C++ core features|C++ core features||Required<sup>[1](#footnote1)</sup>| | ||
|SDKs, libraries, and frameworks|Windows 10 SDK (10.0.16299.0) for Desktop C++ [x86 and x64]|Windows 10 SDK (10.0.16299.0)||Required<sup>[1](#footnote1)</sup>| | ||
Use Visual Studio to compile the following projects: | ||
|
||
Note: | ||
1. `ProtoSDK\Asn1Base\Asn1Base.csproj` | ||
2. `ProtoSDK\MS-XCA\Xca.csproj` | ||
3. `ProtoSDK\MS-SMB2\Smb2.sln` | ||
|
||
<a name="footnote1">1</a>: This individual component is required by ADFamily, MS-SMBD or Protocol Test Manager which have C++ code. | ||
Use the resulting exe file to run the POC. | ||
|
||
<a name="footnote2">2</a>: This individual component is installed in Visual Studio 2019 by default. | ||
## References | ||
|
||
1. [Spec Explorer 2010 v3.5.3146.0](https://visualstudiogallery.msdn.microsoft.com/271d0904-f178-4ce9-956b-d9bfa4902745/) | ||
|
||
It is required if you want to build or run the test suites. It is used to implement test scenarios and cases utilizing [Model-Based Testing](#Model-Based-Testing). | ||
|
||
1. [Protocol Test Framework build 1.0 (build 1.0.7500.0)](https://github.com/Microsoft/ProtocolTestFramework/releases/tag/1.0.7500.0) | ||
|
||
You can use a released MSI file or build it from source code. | ||
|
||
1. Enable .NET Framework 3.5.1 | ||
|
||
1. _Turn Windows features on or off_ | ||
1. Enable _.NET Framework 3.5 (includes .NET 2.0 and 3.0)_ | ||
|
||
This is necessary for WiX Toolset. | ||
|
||
1. [WiX Toolset v3.14](https://wixtoolset.org/releases/v3-14-0-2927/) | ||
|
||
1. [WiX Toolset Visual Studio 2017 Extension](https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension) or [Wix Toolset Visual Studio 2019 Extension](https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2019Extension) | ||
|
||
WiX Toolset components required if you want to build test suites or Protocol Test Manager from source code. | ||
|
||
1. [NuGet CLI](https://www.nuget.org/downloads) | ||
|
||
It is required if you want to build Protocol Test Manager. Please download `nuget.exe` into a suitable folder and add that folder to `Path` environment variable | ||
|
||
1. Microsoft Message Analyzer | ||
|
||
It is required if you want to build or run ADFamily, ADOD and AZOD test suites. | ||
|
||
November 25 2019 - Microsoft Message Analyzer (MMA) has been retired and removed from public-facing sites on microsoft.com. A private MMA build is available for testing purposes; to request it, send an email to [getmma@microsoft.com](mailto:getmma@microsoft.com). | ||
|
||
1. [Open XML SDK](https://www.microsoft.com/en-us/download/details.aspx?id=30425) | ||
|
||
It is required if you want to build or run ADFamily test suite. | ||
|
||
1. [Network Direct DDK](https://www.microsoft.com/en-us/download/details.aspx?id=26645) | ||
|
||
From `NetworkDirect_DDK.zip` extract `ndspi.h` and `ndstatus.h` into project path `ProtoSDK\RDMA\include`. This is to build SMBD test suite. | ||
|
||
|
||
You can use the script in `InstallPrerequisites` folder to automatically download and install these software. | ||
|
||
Tips when using the script in `InstallPrerequisites` folder: | ||
|
||
* To run the script, open **Windows PowerShell**, and execute the commands below in the **PowerShell Window**: | ||
|
||
``` | ||
cd WindowsProtocolTestSuites\InstallPrerequisites | ||
.\InstallPrerequisites.ps1 | ||
``` | ||
|
||
* If you meet errors about **Execution Policy**, make sure you run **Windows PowerShell** as **Administrator**, and type the following and enter: | ||
|
||
``` | ||
Set-ExecutionPolicy RemoteSigned | ||
``` | ||
|
||
You could run the command below to verify if the **Execution Policy** is correctly set: | ||
|
||
``` | ||
Get-ExecutionPolicy | ||
``` | ||
|
||
Then rerun the script. | ||
|
||
## Model-Based Testing | ||
|
||
Some test suites use [Model-Based Testing](https://msdn.microsoft.com/en-us/library/ee620469.aspx): | ||
|
||
* **SMB1 Server Test Suite** | ||
* **File Server Family Test Suite** | ||
* **Kerberos Server Test Suite** | ||
* **SMBD Server Test Suite** | ||
* **BranchCache Server Test Suite** | ||
* **ADFamily Test Suite** | ||
* **ADFSPIP Client Test Suite** | ||
* **AZOD Test Suite** | ||
* **ADOD Test Suite** | ||
|
||
If you want to regenerate Model-Based Test cases, you must install Visual Studio 2012. | ||
|
||
## Build | ||
|
||
After you [clone a copy](https://help.github.com/articles/cloning-a-repository/) of this repo, you can run `build.cmd` for Protocol Test Manager and each test suite separately after you have installed all the softwares required for build listed in [Prerequisites](#prerequisites) | ||
|
||
### Build Protocol Test Manager | ||
|
||
``` | ||
cd WindowsProtocolTestSuites\ProtocolTestManager | ||
build.cmd | ||
``` | ||
|
||
After the build succeeds, the MSI file of Protocol Test Manager should be generated in the folder `WindowsProtocolTestSuite\drop\ProtocolTestManager\installer\`. | ||
|
||
### Build a test suite | ||
|
||
``` | ||
cd WindowsProtocolTestSuites\TestSuites\FileServer\src | ||
build.cmd | ||
``` | ||
|
||
After the build succeeds, the MSI file of each test suite should be generated in the folder `WindowsProtocolTestSuite\drop\TestSuites\\[TestSuiteName]\deploy\`. | ||
Take File Server test suite as an example, `FileServer-TestSuite-ServerEP.msi` should be generated in the folder `WindowsProtocolTestSuite\drop\TestSuites\FileServer\deploy\`. | ||
|
||
## How to use test suites | ||
|
||
Take File Server test suite as an example, you can learn how to configure and run test suite by Protocol Test Manager referring to this [tutorial](./Doc/File%20Server%20SMB2%20Test%20Suite%20Lab%20Tutorial_v2.pdf). | ||
|
||
## Upgrade from an older version | ||
|
||
You can download and install the latest msi of test suites, Protocol Test Manager and Protocol Test Framework to upgrade them to the latest version. Or uninstall the old version and then install the new one. | ||
|
||
## Run | ||
|
||
After the build succeeds, you could set up the test environment, install Protocol Test Manager and install/configure/run the test suite according to its **User Guide**. | ||
Each test suite has its own **User Guide** in the `WindowsProtocolTestSuites\TestSuites\[TestSuiteName]\docs` folder. | ||
There are two more documents in the same folder: | ||
|
||
* **Technical Document**. The Open Specifications documentation for protocols, published by Microsoft. It's the basis of developing Test Suites. | ||
* **Test Design Spec**. It provides information about the test scope and test suite design. | ||
|
||
## Contribute | ||
|
||
You can find contributing guide [here](./CONTRIBUTING.md). | ||
|
||
## License | ||
|
||
Windows Protocol Test Suites are under the [MIT license](./LICENSE.txt). | ||
|
||
## Contact | ||
The following resources are for Windows protocol test suite news, discussion, and support: | ||
* View news announcements in [Open Specification Windows Protocols Forum](https://social.msdn.microsoft.com/Forums/en-US/home?forum=os_windowsprotocols). | ||
* Discuss test suites issues [here](./issues) on the github. | ||
* For [Open Specifications Protocols](https://msdn.microsoft.com/en-us/library/gg685446.aspx) support, contact dochelp@microsoft.com. | ||
|
||
## Microsoft Open Source Code of Conduct | ||
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. | ||
* TO_BE_ADDED |