cotopaxi 1.6.0

Set of tools for security testing of Internet of Things devices using specific network protocols.

 .d8888b.           888                                       d8b 
d88P  Y88b          888                                       Y8P 
888    888          888
888         .d88b.  888888 .d88b.  88888b.   8888b.  888  888 888 
888        d88""88b 888   d88""88b 888 "88b     "88b 'Y8bd8P' 888 
888    888 888  888 888   888  888 888  888 .d888888   X88K   888 
Y88b  d88P Y88..88P Y88b. Y88..88P 888 d88P 888  888 .d8""8b. 888 
 "Y8888P"   "Y88P"   "Y888 "Y88P"  88888P"  "Y888888 888  888 888 
                                   888
                                   888
                                   888

Set of tools for security testing of Internet of Things devices using protocols: AMQP, CoAP, DTLS, HTCPCP, HTTP, HTTP/2, gRPC, KNX, mDNS, MQTT, MQTT-SN, QUIC, RTSP, SSDP.

License:

Cotopaxi uses GNU General Public License, version 2: https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html

Disclaimer

Cotopaxi toolkit is intended to be used only for authorized security testing!

Some tools (especially vulnerability tester and protocol fuzzer) can cause some devices or servers to stop acting in the intended way -- for example leading to crash or hang of tested entities or flooding with network traffic another entities.

Make sure you have permission from the owners of tested devices or servers before running these tools!

Make sure you check with your local laws before running these tools!

Installation

To install minimal Cotopaxi version (without Machine Learning and development tools):

pip install cotopaxi

Almost complete installation (without scapy-ssl_tls required for DTLS support):

pip install cotopaxi[all]

For more detailed documentation about installation see: Installation Guide

Integration with Metasploit

If you want to use Cotopaxi tools from Metasploit see: Metasploit integration

Acknowlegments

Machine learning classificator used in the device_identification tool was trained using corpus "IMC 2019 payload dataset" provided by authors of the following paper:

Title: Information Exposure for Consumer IoT Devices: A Multidimensional, Network-Informed Measurement Approach Authors: Jingjing Ren, Daniel J. Dubois, David Choffnes, Anna Maria Mandalari, Roman Kolcun, Hamed Haddadi Venue: Internet Measurement Conference (IMC) 2019 URL: https://moniotrlab.ccis.neu.edu/imc19dataset/

We would like to thank above listed authors for sharing this corpus!

Tools in this package:

• service_ping
• server_fingerprinter
• device_identification
• traffic_analyzer
• resource_listing
• protocol_fuzzer (for fuzzing servers)
• client_proto_fuzzer (for fuzzing clients)
• vulnerability_tester (for testing servers)
• client_vuln_tester (for testing clients)
• amplifier_detector
• active_scanner

Protocols supported by different tools (left box describes working implementation in Python 2 and right one for Python 3):

Tool	AMQP	CoAP	DTLS	HTCPCP	HTTP/2	gRPC	KNX	mDNS	MQTT	MQTT-SN	QUIC	RTSP	SSDP
service_ping	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑
server_fingerprinter	☐☐	☑☑	☑☑	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐
device_identification	☐☑	☐☑	☐☑	☐☑	☐☐	☐☐	☐☐	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑
traffic_analyzer	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑	☐☑
resource_listing	☐☐	☑☑	N/A	☐☐	☐☐	☐☐	☐☐	☑☑	☐☐	☐☐	N/A	☑☑	☑☑
protocol_fuzzer	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑
client_proto_fuzzer	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑
vulnerability_tester	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑
client_vuln_tester	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑	☑☑
amplifier_detector	N/A	☑☑	☑☑	N/A	N/A	N/A	N/A	☑☑	N/A	☑☑	☑☑	N/A	☑☑
active_scanner	☐☐	☐☐	☑☑	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐	☐☐

For more detailed documentation of each tool see: Tools

Supported vulnerabilites

Vulnerabilities identified by Cotopaxi team, that can be tested using Cotopaxi:

• BOTAN_000
• COAPTHON_000 (CVE-2018-12679)
• COAPTHON3_000 (CVE-2018-12679)
• CONTIKI_000 (CVE-2018-19417)
• FLUENTBIT_000 (CVE-2019-9749)
• IOTIVITY_000 (CVE-2019-9750)
• MADMAZE-HTCPCP_000
• MATRIXSSL_000
• MATRIXSSL_001 (CVE-2019-14431)
• MATRIXSSL_002
• MATRIXSSL_003
• SSDP-RESPONDER_000 (CVE-2019-14323)
• TINYDTLS_001
• TINYDTLS_002
• TINYDTLS_003
• TINYSVCMDNS_002 (CVE-2019-9747)
• WAKAAMA_000 (CVE-2019-9004)
• ZYXEL_000

Other vulnerabilities supported by Cotopaxi:

• ER_COAP_000
• ER_COAP_001
• ER_COAP_002
• TINYDTLS_000 (CVE-2017-7243)
• TINYSVCMDNS_000 (CVE-2017-12087)
• TINYSVCMDNS_001 (CVE-2017-12130)
• TP-LINK_000 (CVE-2018-18428
• TP-LINK_001
• FLIR_000
• FOSCAM_000 (CVE-2018-19077)
• FOSCAM_001 (CVE-2018-19067)
• HIKVISION_000 (CVE-2014-4878)
• HIKVISION_001 (CVE-2014-4879)
• HIKVISION_002 (CVE-2014-4880)
• UBIQUITTI_000 (CVE-2019-12727)
• GSTREAMER_000 (CVE-2019-9928)
• NETFLIX_000 (CVE-2019-10028)
• BEWARD_000
• FALCON_000

New vulnerabilities can be easily added to the database in vulnerabilities.yaml and payloads in cotopaxi/vulnerabilities//<payload.raw>.

Known issues / limitations

There are some known issues or limitations caused by using scapy as network library:

• testing services running on the same machine can result in issues occurred by not delivering some packets,
• multiple tools running against the same target can result in interference between them (packets may be indicated as a response to another request).

See more at: https://scapy.readthedocs.io/en/latest/troubleshooting.html#

Development

For more detailed information about development of Cotopaxi see: Development guide