The official ID2T repository is now in GitHub and can be found in https://github.com/tklab-tud/ID2T

Jens Keim 8ab4e8eab0 use new get_avg_delay_distributions in MembersMgmt 2 years ago
code 8ab4e8eab0 use new get_avg_delay_distributions in MembersMgmt 2 years ago
code_boost c468253ce7 change avg_delay handling for extended conversations of UDP 2 years ago
logo 29683b4714 delete captures and fix exceptions in building 4 years ago
resources 4dccb1f527 add botnet delay resource pcap 2 years ago
.gitignore 4b6e575608 change id2t_result dir name lower case 3 years ago
.gitmodules ccd2e2506a Added pybind11 submodule (version 2.2.3) 3 years ago
LICENSE.md 8547eb372d merge id2t_2_artifacts_fixes branch 4 years ago
README.md c70de0f679 update authors 3 years ago
build.sh 92d68f7855 add --debug parameter to build script 3 years ago

README.md

ID2T - Intrusion Detection Dataset Toolkit

A toolkit for injecting synthetic attacks into PCAP files.

Synopsis

As Intrusion Detection Systems encounter growing importance in the area of network security, the need of high quality network datasets for evaluation against real-world attacks rises.

Comparability of the results must be ensured by use of publicly available datasets. Existing datasets, however, suffer from several disadvantages. Often they do not provide ground truth knowledge, consist of outdated traffic and do not contain any payload because of privacy reasons. Moreover, frequently datasets do not contain latest attacks and missing attack labels make it difficult to identify existing attacks and enable a transparent comparison of Intrusion Detection Systems.

The ID2T toolkit was first proposed in [1] and [2] and targets the injection of attacks into existing network datasets. At first, it analyzes a given dataset and collects statistics from it. These statistics are stored into a local database. Next, these statistics can be used to define attack parameters for the injection of one or multiple attacks. Finally, the application creates the required attack packets and injects them into the existing file. Resulting in a new PCAP with the injected attacks and a label file indicating the position (timestamps) of the first and last attack packet.

ID2T was also presented in Blackhat Europe 2017 as part of the Arsenal session (https://www.blackhat.com/eu-17/arsenal/schedule/index.html).

References

[1] Garcia Cordero et al. (2015) ID2T: a DIY Dataset Creation Toolkit for Intrusion Detection System

[2] Vasilomanolakis et al. (2016) Towards the creation of synthetic, yet realistic, intrusion detection datasets

Getting Started

Dependencies

ID2T is written using Python 3 and C++ 11. The main logic is programmed in Python whereas performance critical components are programmed in C++11. The C++11 module uses the Libtins library. The python and c++ modules interact with each other through the pybind11 library.

Required C++ Libraries/Programs

The following packages/libraries are required to compile the ID2T C++ modules

  • cmake (minimum version 2.8)
    • ubuntu: apt install build-essential cmake
    • arch: pacman -S cmake
    • macos: brew install cmake
  • libtins (minimum version 3.4)
    • ubuntu: apt install libtins-dev (if you cannot find it in the official repository, install it manually from here)
    • arch: (install from AUR, i.e. pacaur -S libtins, or manually from here).
    • macos: brew install libtins
  • python development libraries
    • ubuntu: apt install python3-dev
    • arch: pacman -S python python-pip
    • macos: brew install python
  • sqlite (minimum version 3.0)
    • ubuntu: apt install sqlite3
    • arch: pacman -S sqlite
    • macos: brew install sqlite
  • tcpdump
    • ubuntu: apt install tcpdump
    • arch: pacman -S tcpdump
    • macos: brew install libdnet
  • coreutils (needed for greadlink)
    • macos: brew install coreutils

Required Python Packages

The following python packages are required to run ID2T. Install the packages with your preferred package manager. For example, you can use pip3 (pip for python 3). Install pip3 in ubuntu with apt install python3-pip and install the packages with sudo pip3 install <packagename>.

Notes on the Minimum Package Versions

The minimum version stated in the previous requirements are the versions we used in the development of ID2T. Other (older) versions might also work; however, we can neither guarantee nor support them. Furthermore, some compilation scripts would need to be manually modified to accommodate these older versions.

Dependency installation script

ID2T provides a dependency installation script, which is called during the execution of ./build.sh.

Supported Systems

  • Linux Distributions
    • Arch-based
    • Debian-based
  • macOS
Tested with
  • Arch Linux
  • Antergos
  • Kali
  • macOS (High) Sierra
  • Ubuntu (16.04, 17.10)
  • Zorin OS

Compilation and Installation

Clone the repository to get started with the installation: git clone https://git.tk.informatik.tu-darmstadt.de/SPIN/ID2T-toolkit

Install dependencies, initialize submodules, build the C++ modules and create the ID2T executables: ./build.sh

Or initialize its submodules manually:

git submodule init
git submodule update

To skip dependency installation use the --non-interactive argument: ./build.sh --non-interactive

Run ID2T with the command ./id2t.

Run unit tests with the command ./run_tests.

Run efficiency tests with the command ./test_efficiency.

Usage examples

In this section, we provide examples on how ID2T is used.

Injecting an attack into an existing dataset

In the following we inject the PortscanAttack into the dataset pcap_capture.pcap:

./id2t -i /home/user/pcap_capture.pcap -a PortscanAttack ip.src=192.168.178.2 mac.src=32:08:24:DC:8D:27 inject.at-timestamp=1476301843

Explanation: The parameter -i/--input takes the path to the PCAP file. This triggers the statistics calculation of the file. After the calculation, the statistics are stored into a SQLite database. If the statistics were already computed in an earlier run, the data is retrieved from the generated database. This saves time as the calculation of the statistics may take long time - depending on the PCAP file size.

An attack can be injected by providing -a/--attack followed by the attack name and the attack parameters. The available attacks and the allowed attack parameters vary, see the attack-specific wiki articles for a reference of supported attack parameters. The parameter -a/--attack can be provided multiple times for injection of multiple attacks. In this case the attacks are injected sequentially.

After injecting the attack, the application generates a XML label file containing the timestamps of the first and last attack packet. The file name is equal to the output file, except with _labels.xml as suffix. The toolkit recognizes if the input dataset has an associated label file. This requires a file naming according to the aforementioned scheme, e.g., mydataset.pcap and mydataset_labels.xml. In this case ID2T parses the label file and the resulting output label file contains the labels from the input label file plus the labels from the recently added attack(s).

The Statistics database

Whenever ID2T processes a pcap file, it creates a database detailing many things related to the network traffic it has processed. These details can be seen using the query mode of ID2T. To specify a query against a pcap file, use the option `-q/--query. For example, if we want to know the IP address with the most activity in the pcap file 'test.pcap' we can issue the command:

./id2t -i test.pcap -q 'most_used(ipAddress);'

The query mode serves as a place where standard SQL queries (known as user-defined queries) can be issued against the database created for a pcap file. Furthermore, the most commonly used queries are provided with special keywords known as named queries.

  • A user-defined query looks like this:
    • e.g. SELECT ipAddress FROM ip_statistics WHERE pktsSent > 1000
  • A pre-defined query, known as named query, looks like this:
    • e.g. most_used(ipAddress), random(all(ipAddress))

The named queries can be further divided into two classes:

  • selectors - gather information from the database; the result can be a list of values
    • e.g. all(ipAddress)
  • extractors - can be applied on gathered data and always reduce the result set to a single element
    • e.g. random(...) returns a randomly chosen element of the list

A complete list of supported named queries can be found in section Named Queries. The database scheme, required for building SQL queries, is documented in the wiki article DB Tables and Fields

If -q/--query is called without an argument, the application enters into REPL query mode. This mode is like a standard read-eval-print-loop (REPL) for SQL queries. In this mode, the user can repeatedly input queries (each query must finish with a ";" (semicolon)); send the query by pressing ENTER and see the response in the terminal:

Example query mode usage: ./id2t -i test.pcap -q

Example output:

Input file: /home/user/pcap_capture.pcap
Located statistics database at: /home/pjattke/ID2T_data/db/99/137/81a0a71b0f36.sqlite3
Loaded file statistics in 0.00 sec from statistics database.
Entering into query mode...
Enter statement ending by ';' and press ENTER to send query. Exit by sending an empty query..
most_used(ipAddress);
Query 'most_used(ipAddress);' returned:
203.114.236.243
avg(ttlValue);
Query 'avg(pktsSent);' returned:
5.322

Command reference

Application Arguments

By calling ./id2t -h, a list of available application arguments with a short description is shown.

Statistics DB Queries

Named Queries

Selectors are named queries which return a single element or a list of elements, depending on the values in the database and the query.

For example, the named query most_used(ipAddress) may return a single IP address if the most used IP address, based on the sum of packets sent and received, is unique. If there are multiple IP addresses with the same number of packets sent plus packets received, a list of IP addresses is returned. As the user cannot know how many values are returned, the extractors are ignored if the result is a single element.

most_used(ipAddress | macAddress | portNumber | protocolName | ttlValue)

least_used(ipAddress | macAddress | portNumber | protocolName | ttlValue)

avg(pktsReceived | pktsSent | kbytesSent | kbytesReceived | ttlValue | mss)

all(ipAddress | ttlValue | mss | macAddress | portNumber | protocolName)

There are also parameterizable selectors which take conditions as input. Following two examples to show the syntax by example:

ipAddress(macAddress=AA:BB:CC:DD:EE:FF, pktsSent > 1000, kbytesReceived < 1000)
-> returns one or multiple IP addresses matching the given criterias
Supports the fields: macAddress, ttlValue, ttlCount, portName, portNumber, portDirection, kbytesSent, kbytesReceived, pktsSent, pktsReceived,

macAddress(ipAddress=192.168.178.2)
-> returns the MAC address matching the given criteria
Supports the field: ipAddress

Parameterizable selectors also allow for specifying another query in the condition instead of a specific value, like the following example demonstrates:

macAddress(ipAddress in most_used(ipAddress))

Conditions inside parameterizable selectors can contain all the usual comparison operators (<, <=, =, >=, >) when the right side of the condition is a single value. If the right side is a list, such as the return value of e.g. most_used(), the in-operator is to be used instead, unless the list is reduced to a single value by the use of an extractor.

The following examples provide a demonstration of how lists can be used inside parameterizable selectors:

macAddress(ipAddress in ipAddress(pktssent > 1))         -> Returns the MAC addresses of all IP addresses that sent more than one packet
macAddress(ipAddress = random(ipAddress(pktssent > 1)))  -> Returns the MAC address of a random IP address out of all IP addresses that sent more than one packet
macAddress(ipAddress in [192.168.189.1,192.168.189.143]) -> Returns the MAC address of all IP addresses in the provided list

Extractors are to be used on the result of a named query. If the result is a list, applying an extractor reduces the result set to a single element. If the result is already a single element, the extractor is ignored.

random(...)  -> returns a random element from a list
first(...)   -> returns the first element from a list
last(...)    -> returns the last element from a list

Named queries are designed to be combined with extractors, like random(all(ipAddress))

Versioning

The SemVer is used for versioning. For currently available versions of ID2T, see page releases.

Release History

  • 0.1.0: Initial release
    • Added attack: Portscan Attack

Authors

  • Dr. Emmanouil Vasilomanolakis - ID2T idea, guidance and suggestions during development

  • Carlos Garcia - ID2T idea, guidance and suggestions during development

  • Aidmar Wainakh - analysis and development of attacks as part of his Master Thesis

  • Jens Keim - current maintainer, development of multiple attacks and general improvements

  • Stefan Schmidt - volunteer contributor, development of multiple attacks and general improvements

  • Leon Böck - guidance and suggestions during development of Membership Management Communication Attack

  • Nikolay Milanov - development of first prototype within his Master Thesis

  • Patrick Jattke - development of first public release as part of his Bachelor Thesis

  • Dustin Born - development of Membership Management Communication Attack

  • Christof Jugel - development of Membership Management Communication Attack

  • Marcel Juschak - development of Membership Management Communication Attack

  • Joshua Kühlberg - development of Membership Management Communication Attack

  • Denis Waßmann - development of Membership Management Communication Attack

  • Stefano Acquaviti - development of multiple attacks and general improvements

  • Roey Regev - development of multiple attacks and general improvements

  • Jonathan Speth - development of multiple attacks and general improvements

License

Distributed under the MIT license. See LICENSE for more information.