reverse-skills-max: initial public release (restored, redacted, hardened)
This commit is contained in:
@@ -0,0 +1,201 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to the Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by the Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding any notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. Please do not remove or change
|
||||
the license header comment from a contributed file except when
|
||||
necessary.
|
||||
|
||||
Copyright 2026 mukul975
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,505 @@
|
||||
---
|
||||
name: performing-plc-firmware-security-analysis
|
||||
description: 'This skill covers analyzing Programmable Logic Controller (PLC) firmware
|
||||
for security vulnerabilities including hardcoded credentials, insecure update mechanisms,
|
||||
backdoor functions, memory corruption flaws, and undocumented debug interfaces.
|
||||
It addresses firmware extraction from common PLC platforms (Siemens S7, Allen-Bradley,
|
||||
Schneider Modicon), static analysis of firmware images, dynamic analysis in emulated
|
||||
environments, and comparison against known-good baselines to detect tampering.
|
||||
|
||||
'
|
||||
domain: cybersecurity
|
||||
subdomain: ot-ics-security
|
||||
tags:
|
||||
- ot-security
|
||||
- ics
|
||||
- scada
|
||||
- industrial-control
|
||||
- iec62443
|
||||
- firmware-analysis
|
||||
- plc-security
|
||||
version: 1.0.0
|
||||
author: mahipal
|
||||
license: Apache-2.0
|
||||
nist_csf:
|
||||
- PR.IR-01
|
||||
- DE.CM-01
|
||||
- ID.AM-05
|
||||
- GV.OC-02
|
||||
mitre_attack:
|
||||
- T1078
|
||||
- T1190
|
||||
- T1059
|
||||
- T1003
|
||||
- T1110
|
||||
---
|
||||
|
||||
# Performing PLC Firmware Security Analysis
|
||||
|
||||
## When to Use
|
||||
|
||||
- When assessing PLC security as part of an IEC 62443 component security evaluation (IEC 62443-4-2)
|
||||
- When validating firmware integrity after a suspected compromise or supply chain attack
|
||||
- When evaluating the security of a new PLC platform before deployment in critical infrastructure
|
||||
- When performing vulnerability research on industrial control system devices in an authorized lab
|
||||
- When responding to an incident where PLC logic or firmware tampering is suspected
|
||||
|
||||
**Do not use** on live production PLCs without explicit authorization and safety controls in place. Firmware extraction and analysis should be performed on lab devices or offline backups. Never upload PLC firmware to public analysis services. See performing-ics-penetration-testing for authorized live testing procedures.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Isolated lab environment with the target PLC hardware or an emulated environment
|
||||
- PLC programming software for the target platform (Siemens TIA Portal, Rockwell Studio 5000, Schneider EcoStruxure)
|
||||
- Firmware extraction tools (binwalk, firmware-mod-kit, JTAG/SWD debugger)
|
||||
- Static analysis tools (Ghidra, IDA Pro, Binary Ninja with ARM/MIPS/PowerPC support)
|
||||
- Understanding of PLC architecture (real-time OS, ladder logic execution, I/O scanning)
|
||||
- Reference copy of known-good firmware for integrity comparison
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Acquire PLC Firmware for Analysis
|
||||
|
||||
Extract or obtain PLC firmware through authorized methods. This can be done by downloading from the vendor, extracting from a lab device, or obtaining from a project backup.
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
"""PLC Firmware Acquisition and Integrity Verification.
|
||||
|
||||
Supports firmware extraction from project files, network downloads,
|
||||
and binary image comparison against known-good baselines.
|
||||
"""
|
||||
|
||||
import hashlib
|
||||
import json
|
||||
import os
|
||||
import struct
|
||||
import sys
|
||||
import zipfile
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
class PLCFirmwareAcquisition:
|
||||
"""Handles PLC firmware acquisition from various sources."""
|
||||
|
||||
def __init__(self, output_dir="firmware_analysis"):
|
||||
self.output_dir = Path(output_dir)
|
||||
self.output_dir.mkdir(exist_ok=True)
|
||||
self.manifest = {
|
||||
"acquisition_date": datetime.now().isoformat(),
|
||||
"firmware_samples": [],
|
||||
}
|
||||
|
||||
def extract_from_siemens_project(self, project_path):
|
||||
"""Extract firmware/program blocks from Siemens TIA Portal project.
|
||||
|
||||
TIA Portal projects (.ap16/.ap17) are ZIP archives containing
|
||||
XML-encoded PLC program blocks and system configuration.
|
||||
"""
|
||||
print(f"[*] Analyzing Siemens project: {project_path}")
|
||||
results = {"platform": "Siemens", "blocks": []}
|
||||
|
||||
if zipfile.is_zipfile(project_path):
|
||||
with zipfile.ZipFile(project_path, "r") as zf:
|
||||
for info in zf.infolist():
|
||||
# Program blocks are stored as XML in specific paths
|
||||
if "ProgramBlocks" in info.filename or "SystemBlocks" in info.filename:
|
||||
block_data = zf.read(info.filename)
|
||||
block_hash = hashlib.sha256(block_data).hexdigest()
|
||||
|
||||
block_path = self.output_dir / info.filename.replace("/", "_")
|
||||
block_path.write_bytes(block_data)
|
||||
|
||||
results["blocks"].append({
|
||||
"name": info.filename,
|
||||
"size": info.file_size,
|
||||
"sha256": block_hash,
|
||||
"extracted_to": str(block_path),
|
||||
})
|
||||
print(f" [+] Extracted: {info.filename} ({info.file_size} bytes)")
|
||||
|
||||
self.manifest["firmware_samples"].append(results)
|
||||
return results
|
||||
|
||||
def extract_from_rockwell_project(self, acd_path):
|
||||
"""Extract program data from Rockwell Studio 5000 ACD file.
|
||||
|
||||
ACD files contain controller program, tags, and configuration.
|
||||
"""
|
||||
print(f"[*] Analyzing Rockwell project: {acd_path}")
|
||||
results = {"platform": "Rockwell/Allen-Bradley", "blocks": []}
|
||||
|
||||
with open(acd_path, "rb") as f:
|
||||
header = f.read(256)
|
||||
# ACD files have a specific signature
|
||||
if b"RSLogix" in header or b"Studio 5000" in header:
|
||||
f.seek(0)
|
||||
full_data = f.read()
|
||||
file_hash = hashlib.sha256(full_data).hexdigest()
|
||||
|
||||
results["blocks"].append({
|
||||
"name": os.path.basename(acd_path),
|
||||
"size": len(full_data),
|
||||
"sha256": file_hash,
|
||||
"header_signature": header[:16].hex(),
|
||||
})
|
||||
print(f" [+] Project hash: {file_hash}")
|
||||
|
||||
self.manifest["firmware_samples"].append(results)
|
||||
return results
|
||||
|
||||
def compute_firmware_hash(self, firmware_path):
|
||||
"""Compute multiple hashes of a firmware image for integrity tracking."""
|
||||
data = Path(firmware_path).read_bytes()
|
||||
return {
|
||||
"file": str(firmware_path),
|
||||
"size": len(data),
|
||||
"md5": hashlib.md5(data).hexdigest(),
|
||||
"sha256": hashlib.sha256(data).hexdigest(),
|
||||
"sha512": hashlib.sha512(data).hexdigest(),
|
||||
}
|
||||
|
||||
def compare_firmware_integrity(self, current_fw, baseline_fw):
|
||||
"""Compare current firmware against known-good baseline."""
|
||||
current_hash = self.compute_firmware_hash(current_fw)
|
||||
baseline_hash = self.compute_firmware_hash(baseline_fw)
|
||||
|
||||
match = current_hash["sha256"] == baseline_hash["sha256"]
|
||||
|
||||
result = {
|
||||
"comparison_date": datetime.now().isoformat(),
|
||||
"current_firmware": current_hash,
|
||||
"baseline_firmware": baseline_hash,
|
||||
"integrity_match": match,
|
||||
"verdict": "PASS - Firmware matches baseline" if match else "FAIL - Firmware modified!",
|
||||
}
|
||||
|
||||
if not match:
|
||||
# Find the offset where files diverge
|
||||
current_data = Path(current_fw).read_bytes()
|
||||
baseline_data = Path(baseline_fw).read_bytes()
|
||||
min_len = min(len(current_data), len(baseline_data))
|
||||
|
||||
first_diff = None
|
||||
diff_count = 0
|
||||
for i in range(min_len):
|
||||
if current_data[i] != baseline_data[i]:
|
||||
if first_diff is None:
|
||||
first_diff = i
|
||||
diff_count += 1
|
||||
|
||||
result["first_difference_offset"] = f"0x{first_diff:08x}" if first_diff else None
|
||||
result["total_different_bytes"] = diff_count
|
||||
result["size_difference"] = len(current_data) - len(baseline_data)
|
||||
|
||||
return result
|
||||
|
||||
def save_manifest(self):
|
||||
"""Save acquisition manifest."""
|
||||
manifest_path = self.output_dir / "acquisition_manifest.json"
|
||||
with open(manifest_path, "w") as f:
|
||||
json.dump(self.manifest, f, indent=2)
|
||||
print(f"\n[*] Manifest saved: {manifest_path}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
acq = PLCFirmwareAcquisition()
|
||||
|
||||
if len(sys.argv) < 2:
|
||||
print("Usage:")
|
||||
print(" python process.py extract-siemens <project.ap17>")
|
||||
print(" python process.py extract-rockwell <project.acd>")
|
||||
print(" python process.py compare <current.bin> <baseline.bin>")
|
||||
sys.exit(1)
|
||||
|
||||
cmd = sys.argv[1]
|
||||
if cmd == "extract-siemens" and len(sys.argv) > 2:
|
||||
acq.extract_from_siemens_project(sys.argv[2])
|
||||
elif cmd == "extract-rockwell" and len(sys.argv) > 2:
|
||||
acq.extract_from_rockwell_project(sys.argv[2])
|
||||
elif cmd == "compare" and len(sys.argv) > 3:
|
||||
result = acq.compare_firmware_integrity(sys.argv[2], sys.argv[3])
|
||||
print(json.dumps(result, indent=2))
|
||||
else:
|
||||
print("Invalid command")
|
||||
sys.exit(1)
|
||||
|
||||
acq.save_manifest()
|
||||
```
|
||||
|
||||
### Step 2: Perform Static Analysis of Firmware Image
|
||||
|
||||
Use binwalk for firmware unpacking and Ghidra for disassembly to identify security issues in the firmware binary.
|
||||
|
||||
```bash
|
||||
# Step 2a: Unpack firmware image with binwalk
|
||||
binwalk -e firmware.bin
|
||||
# Output: _firmware.bin.extracted/
|
||||
|
||||
# Identify firmware components
|
||||
binwalk firmware.bin
|
||||
# Look for: file system images, compressed sections, bootloader, RTOS kernel
|
||||
|
||||
# Extract strings for credential and configuration analysis
|
||||
strings -n 8 firmware.bin > firmware_strings.txt
|
||||
|
||||
# Search for hardcoded credentials
|
||||
grep -iE "(password|passwd|pwd|secret|key|credential|login|admin|root)" firmware_strings.txt
|
||||
|
||||
# Search for network configuration
|
||||
grep -iE "(http|ftp|telnet|ssh|snmp|modbus|192\.168|10\.|172\.)" firmware_strings.txt
|
||||
|
||||
# Search for debug/backdoor indicators
|
||||
grep -iE "(debug|backdoor|test_mode|factory|service_port|hidden)" firmware_strings.txt
|
||||
|
||||
# Search for cryptographic material
|
||||
grep -iE "(BEGIN RSA|BEGIN CERTIFICATE|AES|DES|private.key)" firmware_strings.txt
|
||||
|
||||
# Step 2b: Entropy analysis to detect encrypted/compressed sections
|
||||
binwalk -E firmware.bin
|
||||
# High entropy sections may contain encrypted payloads or compressed data
|
||||
|
||||
# Step 2c: Analyze with Ghidra (headless mode)
|
||||
analyzeHeadless /tmp/ghidra_project PLC_FW \
|
||||
-import firmware.bin \
|
||||
-processor ARM:LE:32:Cortex \
|
||||
-postScript FindCryptoConstants.java \
|
||||
-postScript FindHardcodedStrings.java \
|
||||
-log /tmp/ghidra_analysis.log
|
||||
```
|
||||
|
||||
### Step 3: Analyze PLC Communication Stack Security
|
||||
|
||||
Examine how the PLC handles industrial protocol requests, focusing on authentication bypass, buffer overflows in packet parsing, and command injection vulnerabilities.
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
"""PLC Protocol Security Analyzer.
|
||||
|
||||
Tests PLC protocol implementation for common vulnerabilities
|
||||
including authentication bypass, malformed packet handling,
|
||||
and function code access control.
|
||||
|
||||
WARNING: Only run against lab/test PLCs, never production systems.
|
||||
"""
|
||||
|
||||
import socket
|
||||
import struct
|
||||
import sys
|
||||
import time
|
||||
from dataclasses import dataclass
|
||||
|
||||
|
||||
@dataclass
|
||||
class ProtocolTestResult:
|
||||
test_name: str
|
||||
target: str
|
||||
protocol: str
|
||||
result: str # PASS, FAIL, ERROR
|
||||
severity: str
|
||||
detail: str
|
||||
|
||||
|
||||
class ModbusSecurityTester:
|
||||
"""Tests Modbus/TCP implementation security."""
|
||||
|
||||
def __init__(self, target_ip, target_port=502):
|
||||
self.target = target_ip
|
||||
self.port = target_port
|
||||
self.results = []
|
||||
|
||||
def _send_modbus(self, unit_id, func_code, data=b""):
|
||||
"""Send a Modbus/TCP request and return response."""
|
||||
# MBAP Header: transaction_id(2) + protocol_id(2) + length(2) + unit_id(1)
|
||||
mbap = struct.pack(">HHHB", 0x0001, 0x0000, len(data) + 2, unit_id)
|
||||
pdu = struct.pack("B", func_code) + data
|
||||
|
||||
try:
|
||||
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||
sock.settimeout(5)
|
||||
sock.connect((self.target, self.port))
|
||||
sock.send(mbap + pdu)
|
||||
response = sock.recv(1024)
|
||||
sock.close()
|
||||
return response
|
||||
except Exception as e:
|
||||
return None
|
||||
|
||||
def test_authentication_required(self):
|
||||
"""Test if PLC requires authentication for read/write operations."""
|
||||
# Test unauthenticated read
|
||||
read_data = struct.pack(">HH", 0, 10) # Read 10 registers from address 0
|
||||
response = self._send_modbus(1, 3, read_data)
|
||||
|
||||
if response and len(response) > 8 and response[7] != 0x83:
|
||||
self.results.append(ProtocolTestResult(
|
||||
test_name="Modbus Authentication - Read",
|
||||
target=self.target,
|
||||
protocol="Modbus/TCP",
|
||||
result="FAIL",
|
||||
severity="high",
|
||||
detail="PLC accepts unauthenticated Modbus read commands. No authentication required.",
|
||||
))
|
||||
|
||||
# Test unauthenticated write
|
||||
write_data = struct.pack(">HH", 100, 0) # Write 0 to register 100
|
||||
response = self._send_modbus(1, 6, write_data)
|
||||
|
||||
if response and len(response) > 8 and response[7] != 0x86:
|
||||
self.results.append(ProtocolTestResult(
|
||||
test_name="Modbus Authentication - Write",
|
||||
target=self.target,
|
||||
protocol="Modbus/TCP",
|
||||
result="FAIL",
|
||||
severity="critical",
|
||||
detail="PLC accepts unauthenticated Modbus WRITE commands. Any host can modify registers.",
|
||||
))
|
||||
|
||||
def test_function_code_access_control(self):
|
||||
"""Test if PLC restricts dangerous function codes."""
|
||||
dangerous_funcs = {
|
||||
8: "Diagnostics (can restart communications)",
|
||||
17: "Report Slave ID (information disclosure)",
|
||||
43: "Encapsulated Interface Transport (device identification)",
|
||||
}
|
||||
|
||||
for fc, desc in dangerous_funcs.items():
|
||||
response = self._send_modbus(1, fc, b"\x00\x00")
|
||||
if response and len(response) > 8:
|
||||
error_code = response[7]
|
||||
if error_code != (fc | 0x80): # Not an exception response
|
||||
self.results.append(ProtocolTestResult(
|
||||
test_name=f"Function Code Access - FC{fc}",
|
||||
target=self.target,
|
||||
protocol="Modbus/TCP",
|
||||
result="FAIL",
|
||||
severity="medium",
|
||||
detail=f"PLC responds to FC{fc} ({desc}) without access control",
|
||||
))
|
||||
|
||||
def test_invalid_unit_id(self):
|
||||
"""Test PLC response to broadcast and invalid unit IDs."""
|
||||
# Broadcast (unit ID 0) - should be carefully handled
|
||||
read_data = struct.pack(">HH", 0, 1)
|
||||
response = self._send_modbus(0, 3, read_data)
|
||||
|
||||
if response and len(response) > 8 and response[7] != 0x83:
|
||||
self.results.append(ProtocolTestResult(
|
||||
test_name="Broadcast Unit ID Handling",
|
||||
target=self.target,
|
||||
protocol="Modbus/TCP",
|
||||
result="FAIL",
|
||||
severity="high",
|
||||
detail="PLC responds to broadcast unit ID 0. This enables broadcast write attacks.",
|
||||
))
|
||||
|
||||
def test_malformed_packet_handling(self):
|
||||
"""Test PLC resilience against malformed Modbus packets."""
|
||||
# Oversized length field
|
||||
malformed = struct.pack(">HHH", 0x0001, 0x0000, 0xFFFF) + b"\x01\x03\x00\x00\x00\x01"
|
||||
try:
|
||||
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||
sock.settimeout(5)
|
||||
sock.connect((self.target, self.port))
|
||||
sock.send(malformed)
|
||||
time.sleep(1)
|
||||
|
||||
# Verify PLC is still responsive
|
||||
read_data = struct.pack(">HH", 0, 1)
|
||||
response = self._send_modbus(1, 3, read_data)
|
||||
sock.close()
|
||||
|
||||
if response is None:
|
||||
self.results.append(ProtocolTestResult(
|
||||
test_name="Malformed Packet - Oversized Length",
|
||||
target=self.target,
|
||||
protocol="Modbus/TCP",
|
||||
result="FAIL",
|
||||
severity="critical",
|
||||
detail="PLC became unresponsive after receiving oversized length field. Possible DoS vulnerability.",
|
||||
))
|
||||
else:
|
||||
self.results.append(ProtocolTestResult(
|
||||
test_name="Malformed Packet - Oversized Length",
|
||||
target=self.target,
|
||||
protocol="Modbus/TCP",
|
||||
result="PASS",
|
||||
severity="info",
|
||||
detail="PLC correctly handles oversized length field without crashing",
|
||||
))
|
||||
except Exception as e:
|
||||
pass
|
||||
|
||||
def run_all_tests(self):
|
||||
"""Run all Modbus security tests."""
|
||||
print(f"\n{'='*60}")
|
||||
print(f"PLC MODBUS SECURITY ANALYSIS - {self.target}:{self.port}")
|
||||
print(f"{'='*60}")
|
||||
|
||||
self.test_authentication_required()
|
||||
self.test_function_code_access_control()
|
||||
self.test_invalid_unit_id()
|
||||
self.test_malformed_packet_handling()
|
||||
|
||||
for r in self.results:
|
||||
icon = "[FAIL]" if r.result == "FAIL" else "[PASS]"
|
||||
print(f"\n {icon} {r.test_name}")
|
||||
print(f" Severity: {r.severity}")
|
||||
print(f" Detail: {r.detail}")
|
||||
|
||||
return self.results
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) < 2:
|
||||
print("Usage: python plc_protocol_tester.py <target_plc_ip> [port]")
|
||||
print("WARNING: Only use against lab/test PLCs!")
|
||||
sys.exit(1)
|
||||
|
||||
target = sys.argv[1]
|
||||
port = int(sys.argv[2]) if len(sys.argv) > 2 else 502
|
||||
|
||||
tester = ModbusSecurityTester(target, port)
|
||||
tester.run_all_tests()
|
||||
```
|
||||
|
||||
## Key Concepts
|
||||
|
||||
| Term | Definition |
|
||||
|------|------------|
|
||||
| PLC Firmware | The embedded software running on a Programmable Logic Controller, including the real-time operating system, protocol stacks, and I/O drivers |
|
||||
| Ladder Logic | Graphical programming language for PLCs that represents relay logic circuits, stored as program blocks in PLC memory |
|
||||
| Function Block | Reusable PLC programming element that encapsulates logic with defined inputs/outputs, can be analyzed for malicious modifications |
|
||||
| Firmware Integrity | Verification that PLC firmware has not been modified from the vendor-supplied or approved version using cryptographic hash comparison |
|
||||
| IEC 62443-4-2 | Component security requirements in the IEC 62443 standard, defining security capabilities required for IACS components including PLCs |
|
||||
| JTAG/SWD | Hardware debug interfaces (Joint Test Action Group / Serial Wire Debug) used for firmware extraction and low-level analysis |
|
||||
|
||||
## Tools & Systems
|
||||
|
||||
- **Binwalk**: Firmware analysis tool for scanning, extracting, and analyzing embedded firmware images
|
||||
- **Ghidra**: NSA-developed reverse engineering framework supporting ARM, MIPS, PowerPC architectures common in PLCs
|
||||
- **EMUX/FIRMADYNE**: Firmware emulation frameworks for dynamic analysis of embedded device firmware
|
||||
- **PLCinject**: Research tool for analyzing PLC logic injection vulnerabilities (use only in authorized lab settings)
|
||||
- **OpenPLC**: Open-source PLC platform useful as a test target for security research
|
||||
|
||||
## Output Format
|
||||
|
||||
```
|
||||
PLC Firmware Security Analysis Report
|
||||
=======================================
|
||||
Device: [PLC Model and Firmware Version]
|
||||
Analysis Date: YYYY-MM-DD
|
||||
Methodology: Static + Dynamic Analysis
|
||||
|
||||
FIRMWARE INTEGRITY:
|
||||
SHA-256: [hash]
|
||||
Baseline Match: [Yes/No]
|
||||
Vendor Signature Valid: [Yes/No/Not Signed]
|
||||
|
||||
VULNERABILITIES FOUND:
|
||||
[PLC-001] [Severity] [Title]
|
||||
CWE: [CWE-ID]
|
||||
Detail: [Technical description]
|
||||
Impact: [Operational impact]
|
||||
Remediation: [Fix or mitigation]
|
||||
```
|
||||
@@ -0,0 +1,46 @@
|
||||
# API Reference — Performing PLC Firmware Security Analysis
|
||||
|
||||
## Libraries Used
|
||||
- **subprocess**: Execute binwalk for firmware extraction
|
||||
- **hashlib**: MD5/SHA256 firmware hashing
|
||||
- **re**: Credential and vulnerability pattern scanning
|
||||
- **pathlib**: Recursive file scanning of extracted firmware
|
||||
- **math**: Shannon entropy calculation
|
||||
|
||||
## CLI Interface
|
||||
```
|
||||
python agent.py extract --firmware plc_fw.bin [--output /tmp/fw_extract]
|
||||
python agent.py metadata --firmware plc_fw.bin
|
||||
python agent.py creds --dir /tmp/fw_extract
|
||||
python agent.py vulns --dir /tmp/fw_extract
|
||||
python agent.py full --firmware plc_fw.bin [--output /tmp/fw_extract]
|
||||
```
|
||||
|
||||
## Core Functions
|
||||
|
||||
### `extract_firmware(firmware_file, output_dir)` — Binwalk extraction
|
||||
### `analyze_firmware_metadata(firmware_file)` — Hash and entropy analysis
|
||||
High entropy (>7.5) may indicate encryption or compression.
|
||||
|
||||
### `scan_for_credentials(extract_dir)` — Hardcoded credential detection
|
||||
Patterns: passwords, default creds, private keys, API keys, connection strings.
|
||||
|
||||
### `scan_for_vulnerabilities(extract_dir)` — Code vulnerability patterns
|
||||
Detects: command injection (system/popen), buffer overflow risk (strcpy/gets),
|
||||
insecure protocols (telnet/FTP), debug mode, backdoor indicators.
|
||||
|
||||
### `full_analysis(firmware_file, output_dir)` — Complete analysis pipeline
|
||||
|
||||
## Vulnerability Patterns
|
||||
| Pattern | Risk | Indicator |
|
||||
|---------|------|-----------|
|
||||
| command_injection | HIGH | system(), popen(), exec() |
|
||||
| buffer_overflow_risk | HIGH | strcpy, strcat, sprintf, gets |
|
||||
| insecure_protocol | MEDIUM | telnet, ftp, http:// |
|
||||
| debug_enabled | MEDIUM | debug=true, DEBUG_MODE |
|
||||
| backdoor_indicator | CRITICAL | backdoor, rootkit, reverse shell |
|
||||
|
||||
## Dependencies
|
||||
```
|
||||
pip install binwalk
|
||||
```
|
||||
@@ -0,0 +1,184 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Agent for performing PLC firmware security analysis."""
|
||||
|
||||
import json
|
||||
import argparse
|
||||
import subprocess
|
||||
import hashlib
|
||||
import re
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
|
||||
|
||||
def extract_firmware(firmware_file, output_dir="/tmp/fw_extract"):
|
||||
"""Extract firmware image using binwalk."""
|
||||
Path(output_dir).mkdir(parents=True, exist_ok=True)
|
||||
cmd = ["binwalk", "-e", "-C", output_dir, firmware_file]
|
||||
try:
|
||||
result = subprocess.run(cmd, capture_output=True, text=True, timeout=120)
|
||||
extracted = list(Path(output_dir).rglob("*"))
|
||||
files = [str(f.relative_to(output_dir)) for f in extracted if f.is_file()]
|
||||
return {
|
||||
"firmware": firmware_file, "output_dir": output_dir,
|
||||
"files_extracted": len(files),
|
||||
"file_list": files[:50],
|
||||
"binwalk_output": result.stdout[:1000],
|
||||
}
|
||||
except FileNotFoundError:
|
||||
return {"error": "binwalk not installed — pip install binwalk"}
|
||||
except Exception as e:
|
||||
return {"error": str(e)}
|
||||
|
||||
|
||||
def analyze_firmware_metadata(firmware_file):
|
||||
"""Analyze firmware file metadata and calculate hashes."""
|
||||
data = Path(firmware_file).read_bytes()
|
||||
magic_bytes = data[:16].hex()
|
||||
return {
|
||||
"firmware": firmware_file,
|
||||
"size_bytes": len(data),
|
||||
"md5": hashlib.md5(data).hexdigest(),
|
||||
"sha256": hashlib.sha256(data).hexdigest(),
|
||||
"magic_bytes": magic_bytes,
|
||||
"entropy": _calculate_entropy(data),
|
||||
}
|
||||
|
||||
|
||||
def _calculate_entropy(data):
|
||||
"""Calculate Shannon entropy of binary data."""
|
||||
import math
|
||||
if not data:
|
||||
return 0
|
||||
freq = [0] * 256
|
||||
for byte in data:
|
||||
freq[byte] += 1
|
||||
entropy = 0
|
||||
length = len(data)
|
||||
for f in freq:
|
||||
if f > 0:
|
||||
p = f / length
|
||||
entropy -= p * math.log2(p)
|
||||
return round(entropy, 2)
|
||||
|
||||
|
||||
def scan_for_credentials(extract_dir):
|
||||
"""Scan extracted firmware for hardcoded credentials."""
|
||||
findings = []
|
||||
patterns = {
|
||||
"hardcoded_password": re.compile(r'(?:password|passwd|pwd)\s*[=:]\s*["\']?([^\s"\']{3,})', re.I),
|
||||
"default_credential": re.compile(r'(?:admin|root|user|operator)[:;]\s*([^\s:]{3,})', re.I),
|
||||
"private_key": re.compile(r"-----BEGIN (?:RSA |EC |DSA )?PRIVATE KEY-----"),
|
||||
"api_key": re.compile(r"(?:api[_-]?key|apikey|secret[_-]?key)\s*[=:]\s*[\"']?([a-zA-Z0-9_\-]{16,})", re.I),
|
||||
"connection_string": re.compile(r"(?:mysql|postgres|mongodb|redis)://[^\s\"']+", re.I),
|
||||
}
|
||||
p = Path(extract_dir)
|
||||
for f in p.rglob("*"):
|
||||
if f.is_file() and f.stat().st_size < 1_000_000:
|
||||
try:
|
||||
content = f.read_text(encoding="utf-8", errors="replace")
|
||||
for pattern_name, pattern in patterns.items():
|
||||
matches = pattern.findall(content)
|
||||
if matches:
|
||||
findings.append({
|
||||
"file": str(f.relative_to(p)),
|
||||
"type": pattern_name,
|
||||
"matches": [m[:50] if isinstance(m, str) else str(m)[:50] for m in matches[:5]],
|
||||
})
|
||||
except Exception:
|
||||
continue
|
||||
return {
|
||||
"extract_dir": extract_dir,
|
||||
"files_scanned": sum(1 for _ in p.rglob("*") if _.is_file()),
|
||||
"credential_findings": len(findings),
|
||||
"findings": findings[:30],
|
||||
"severity": "CRITICAL" if findings else "INFO",
|
||||
}
|
||||
|
||||
|
||||
def scan_for_vulnerabilities(extract_dir):
|
||||
"""Scan extracted firmware for common vulnerability patterns."""
|
||||
findings = []
|
||||
p = Path(extract_dir)
|
||||
vuln_patterns = {
|
||||
"command_injection": re.compile(r"(?:system|popen|exec)\s*\(", re.I),
|
||||
"buffer_overflow_risk": re.compile(r"(?:strcpy|strcat|sprintf|gets)\s*\("),
|
||||
"insecure_protocol": re.compile(r"(?:telnet|ftp|http://|tftp)", re.I),
|
||||
"debug_enabled": re.compile(r"(?:debug\s*=\s*(?:true|1|on)|DEBUG_MODE)", re.I),
|
||||
"backdoor_indicator": re.compile(r"(?:backdoor|rootkit|reverse.?shell)", re.I),
|
||||
}
|
||||
for f in p.rglob("*"):
|
||||
if f.is_file() and f.stat().st_size < 1_000_000 and f.suffix in (".c", ".h", ".py", ".sh", ".conf", ".cfg", ".xml", ".json", ".lua", ""):
|
||||
try:
|
||||
content = f.read_text(encoding="utf-8", errors="replace")
|
||||
for vuln_name, pattern in vuln_patterns.items():
|
||||
matches = pattern.findall(content)
|
||||
if matches:
|
||||
findings.append({
|
||||
"file": str(f.relative_to(p)),
|
||||
"vulnerability": vuln_name,
|
||||
"count": len(matches),
|
||||
"samples": matches[:3],
|
||||
})
|
||||
except Exception:
|
||||
continue
|
||||
config_files = list(p.rglob("*.conf")) + list(p.rglob("*.cfg")) + list(p.rglob("*.ini"))
|
||||
return {
|
||||
"extract_dir": extract_dir,
|
||||
"vulnerability_findings": len(findings),
|
||||
"config_files_found": len(config_files),
|
||||
"findings": findings[:30],
|
||||
}
|
||||
|
||||
|
||||
def full_analysis(firmware_file, output_dir="/tmp/fw_extract"):
|
||||
"""Run full firmware security analysis pipeline."""
|
||||
metadata = analyze_firmware_metadata(firmware_file)
|
||||
extraction = extract_firmware(firmware_file, output_dir)
|
||||
if extraction.get("error"):
|
||||
return {"metadata": metadata, "extraction": extraction}
|
||||
credentials = scan_for_credentials(output_dir)
|
||||
vulnerabilities = scan_for_vulnerabilities(output_dir)
|
||||
return {
|
||||
"generated": datetime.utcnow().isoformat(),
|
||||
"metadata": metadata,
|
||||
"extraction": {"files_extracted": extraction["files_extracted"]},
|
||||
"credentials": credentials,
|
||||
"vulnerabilities": vulnerabilities,
|
||||
"risk_level": "CRITICAL" if credentials["credential_findings"] > 0 else "HIGH" if vulnerabilities["vulnerability_findings"] > 5 else "MEDIUM",
|
||||
}
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="PLC Firmware Security Analysis Agent")
|
||||
sub = parser.add_subparsers(dest="command")
|
||||
e = sub.add_parser("extract", help="Extract firmware image")
|
||||
e.add_argument("--firmware", required=True)
|
||||
e.add_argument("--output", default="/tmp/fw_extract")
|
||||
m = sub.add_parser("metadata", help="Analyze firmware metadata")
|
||||
m.add_argument("--firmware", required=True)
|
||||
c = sub.add_parser("creds", help="Scan for hardcoded credentials")
|
||||
c.add_argument("--dir", required=True, help="Extracted firmware directory")
|
||||
v = sub.add_parser("vulns", help="Scan for vulnerability patterns")
|
||||
v.add_argument("--dir", required=True)
|
||||
f = sub.add_parser("full", help="Full firmware analysis")
|
||||
f.add_argument("--firmware", required=True)
|
||||
f.add_argument("--output", default="/tmp/fw_extract")
|
||||
args = parser.parse_args()
|
||||
if args.command == "extract":
|
||||
result = extract_firmware(args.firmware, args.output)
|
||||
elif args.command == "metadata":
|
||||
result = analyze_firmware_metadata(args.firmware)
|
||||
elif args.command == "creds":
|
||||
result = scan_for_credentials(args.dir)
|
||||
elif args.command == "vulns":
|
||||
result = scan_for_vulnerabilities(args.dir)
|
||||
elif args.command == "full":
|
||||
result = full_analysis(args.firmware, args.output)
|
||||
else:
|
||||
parser.print_help()
|
||||
return
|
||||
print(json.dumps(result, indent=2, default=str))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user