# ICS-Forensics-Tools | Microsoft ICS Forensics Framework

**URL:** <https://onehack.st/t/ics-forensics-tools-microsoft-ics-forensics-framework/266346>\
**Category:** Tools & Scripts\
**Tags:** learning, tools, freebies, data-recovery\
**Created:** [November 29, 2023, 9:35pm UTC](https://onehack.st/t/ics-forensics-tools-microsoft-ics-forensics-framework/266346 "2023-11-29T21:35:56Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![WhiteHat](https://onehack.st/user_avatar/onehack.st/whitehat/32/162514_2.png) [@WhiteHat](https://onehack.st/u/WhiteHat)\
**Post date:** [November 29, 2023, 9:35pm UTC](https://onehack.st/t/ics-forensics-tools-microsoft-ics-forensics-framework/266346/1 "2023-11-29T21:35:56Z")

</div>

![image](https://onehack.st/uploads/default/original/3X/0/2/0273d5ccf9aaa26c0716381fff1eb14f9eff5633.png)

[![microsoft_security.png](https://github.com/microsoft/ics-forensics-tools/raw/main/assets/images/microsoft_security.png)](https://github.com/microsoft/ics-forensics-tools/blob/main/assets/images/microsoft_security.png)

# [Microsoft ICS Forensics Framework](https://azure.microsoft.com/en-us/products/iot-defender/)

Microsoft ICS Forensics Tools is an open source forensic framework for analyzing Industrial PLC metadata and project files.  
it enables investigators to identify suspicious artifacts on ICS environment for detection of compromised devices during incident response or manual check.  
open source framework, which allows investigators to verify the actions of the tool or customize it to specific needs.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

```auto
git clone https://github.com/microsoft/ics-forensics-tools.git

```

### Prerequisites

- Install Python \>= 3.9: [https://www.python.org/downloads](https://www.python.org/downloads)

### Installing

- Install python requirements

```auto
pip install -r requirements.txt

```

## Usage

### General application arguments:

| Args | Description | Required / Optional |
| --- | --- | --- |
| `-h`, `--help` | show this help message and exit | Optional |
| `-s`, `--save-config` | Save config file for easy future usage | Optional |
| `-c`, `--config` | Config file path, default is config.json | Optional |
| `-o`, `--output-dir` | Directory in which to output any generated files, default is output | Optional |
| `-v`, `--verbose` | Log output to a file as well as the console | Optional |
| `-p`, `--multiprocess` | Run in multiprocess mode by number of plugins/analyzers | Optional |

### Specific plugin arguments:

| Args | Description | Required / Optional |
| --- | --- | --- |
| `-h`, `--help` | show this help message and exit | Optional |
| `--ip` | Addresses file path, CIDR or IP addresses csv (ip column required). | |
| add more columns for additional info about each ip (username, pass, etc…) | Required | |
| `--port` | Port number | Optional |
| `--transport` | tcp/udp | Optional |
| `--analyzer` | Analyzer name to run | Optional |

### Executing examples in the command line

```auto
 python driver.py -s -v PluginName --ip ips.csv
 python driver.py -s -v PluginName --analyzer AnalyzerName
 python driver.py -s -v -c config.json --multiprocess

```

### Import as library example

from forensic.client.forensic\_client import ForensicClient from forensic.interfaces.plugin import PluginConfig forensic = ForensicClient() plugin = PluginConfig.from\_json({ “name”: “PluginName”, “port”: 123, “transport”: “tcp”, “addresses”: [{“ip”: “192.168.1.0/24”}, {“ip”: “10.10.10.10”}], “parameters”: { }, “analyzers”: }) forensic.scan([plugin])

## Architecture

[![architecture.png](https://github.com/microsoft/ics-forensics-tools/raw/main/assets/images/architecture.png)](https://github.com/microsoft/ics-forensics-tools/blob/main/assets/images/architecture.png)

## Adding Plugins

When developing locally make sure to mark src folder as “Sources root”

- Create new directory under plugins folder with your plugin name
- Create new Python file with your plugin name
- Use the following template to write your plugin and replace ‘General’ with your plugin name

from pathlib import Path from forensic.interfaces.plugin import PluginInterface, PluginConfig, PluginCLI from forensic.common.constants.constants import Transport class GeneralCLI(PluginCLI): def **init** (self, folder\_name): super(). **init** (folder\_name) self.name = “General” self.description = “General Plugin Description” self.port = 123 self.transport = Transport.TCP def flags(self, parser): self.base\_flags(parser, self.port, self.transport) parser.add\_argument(‘–general’, help=‘General additional argument’, metavar=“”) class General(PluginInterface): def **init** (self, config: PluginConfig, output\_dir: Path, verbose: bool): super(). **init** (config, output\_dir, verbose) def connect(self, address): self.logger.info(f"{self.config.name} connect") def export(self, extracted): self.logger.info(f"{self.config.name} export")

- Make sure to import your new plugin in the ` __init__.py` file under the plugins folder
- In the PluginInterface inherited class there is ‘config’ parameters, you can use this to access any data that’s available in the PluginConfig object (plugin name, addresses, port, transport, parameters).  
there are 2 mandatory functions (connect, export).  
the connect function receives single ip address and extracts any relevant information from the device and return it.  
the export function receives the information that was extracted from **all** the devices and there you can export it to file.
- In the PluginCLI inherited class you need to specify in the init function the default information related to this plugin.  
there is a single mandatory function (flags).  
In which you must call base\_flags, and you can add any additional flags that you want to have.

## Adding Analyzers

- Create new directory under analyzers folder with the plugin name that related to your analyzer.
- Create new Python file with your analyzer name
- Use the following template to write your plugin and replace ‘General’ with your plugin name

from pathlib import Path from forensic.interfaces.analyzer import AnalyzerInterface, AnalyzerConfig class General(AnalyzerInterface): def **init** (self, config: AnalyzerConfig, output\_dir: Path, verbose: bool): super(). **init** (config, output\_dir, verbose) self.plugin\_name = ‘General’ self.create\_output\_dir(self.plugin\_name) def analyze(self): pass

- Make sure to import your new analyzer in the ` __init__.py` file under the analyzers folder

## Resources and Technical data & solution:

[Microsoft Defender for IoT](https://azure.microsoft.com/en-us/services/iot-defender/#overview) is an agentless network-layer security solution that allows organizations to continuously monitor and discover assets, detect threats, and manage vulnerabilities in their IoT/OT and Industrial Control Systems (ICS) devices, on-premises and in Azure-connected environments.

[Section 52 under MSRC blog](https://msrc-blog.microsoft.com/?s=section+52)  
[ICS Lecture given about the tool](https://ics2022.sched.com/event/15DB2/deep-dive-into-plc-ladder-logic-forensics)  
[Section 52 - Investigating Malicious Ladder Logic | Microsoft Defender for IoT Webinar - YouTube](https://www.youtube.com/watch?v=g3KLq_IHId4&ab_channel=MicrosoftSecurityCommunity)

## 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.opensource.microsoft.com](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](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.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

## Legal Disclaimer

Copyright (c) 2018 Microsoft Corporation. All rights reserved.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## GitHub:

> **[GitHub - microsoft/ics-forensics-tools: Microsoft ICSpector (ICS Forensics Tools...](https://github.com/microsoft/ics-forensics-tools)**
>
> Microsoft ICSpector (ICS Forensics Tools framework) is an open-source forensics framework that enables the analysis of Industrial PLC metadata and project files.