kdd99_feature_extractor - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #go #docker #macos #windows #vue #pytorch #ios #openai #open-source

kdd99_feature_extractor

(★ 119)

Utility for extraction of subset of KDD '99 features from realtime network traffic or .pcap file

File Explorer

Download Latest Version (.zip)

- FindPCAP.cmake
- extractor_output_header.txt
- flag_values.txt
- protocol_values.txt
- service_values.txt
- tcp_state_diagram.png
- tcp_state_diagram.xml
- CMakeLists.txt
- Config.cpp
- Config.h
- Conversation.cpp
- Conversation.h
- ConversationFeatures.cpp
- ConversationFeatures.h
- ConversationReconstructor.cpp
- ConversationReconstructor.h
- FeatureUpdater.h
- FeatureUpdaterCount.cpp
- FeatureUpdaterCount.h
- FeatureUpdaterTime.cpp
- FeatureUpdaterTime.h
- FiveTuple.cpp
- FiveTuple.h
- IcmpConversation.cpp
- IcmpConversation.h
- IntervalKeeper.cpp
- IntervalKeeper.h
- IpDatagram.cpp
- IpDatagram.h
- IpFragment.cpp
- IpFragment.h
- IpReassembler.cpp
- IpReassembler.h
- IpReassemblyBuffer.cpp
- IpReassemblyBuffer.h
- IpReassemblyBufferHoleList.cpp
- IpReassemblyBufferHoleList.h
- main.cpp
- net.cpp
- net.h
- Packet.cpp
- Packet.h
- ReferenceCounter.cpp
- ReferenceCounter.h
- Sniffer.cpp
- Sniffer.h
- StatsCollector.h
- StatsEngine.cpp
- StatsEngine.h
- StatsPerHost.cpp
- StatsPerHost.h
- StatsPerService.cpp
- StatsPerService.h
- StatsPerServiceWithSrcPort.cpp
- StatsPerServiceWithSrcPort.h
- StatsWindow.cpp
- StatsWindow.h
- StatsWindowCount.cpp
- StatsWindowCount.h
- StatsWindowTime.cpp
- StatsWindowTime.h
- TcpConnection.cpp
- TcpConnection.h
- Timestamp.cpp
- Timestamp.h
- types.h
- UdpConversation.cpp
- UdpConversation.h
.gitignore
CMakeLists.txt
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/AI-IDS/kdd99_feature_extractor

Downloads the entire project code from GitHub to your computer.

cd kdd99_feature_extractor

Moves into the project folder you just downloaded.

2. CMake

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
CMake The tool used to generate build configuration.
C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kdd99_feature_extractor
Utility for extraction of subset of KDD '99 features [1] from realtime network traffic or .pcap file
This utility is a part of our project at University of Bergen.

Some feature might not be calculated exactly same way as in KDD, because there was no documentation explaining the details of KDD implementation found. Algorithms are based on some articles [2][3] and observation of values in KDD dataset.

Features in KDD should be the same as features introduced by Lee & Stolfo in their work [2].

## Status
* Current version is not 100% guarenteed to be perfect in sense that some features might be calculated bit different algorighms than KDD '99 dataset a Lee & Stolfo used. Hovewer, it is suitable for educational purposes.
* Compiled & tested in following environments:
  * Windows 7 x64, MSCV 2015 (14), WinPcap 4.1.3
  * Windows 7 x64, MSCV 2013 (12), WinPcap 4.1.3
  * Ubuntu 12.04 x64, gcc 4.6.3, libpcap 4.2

## Features
* Subset of KDD '99 features [1]
  * Content features (columns 10-22 of KDD) are not included
* Optional extra features - IP addresses, ports, timestamp of last packet (option `-e`)

## Main components
1. Sniffer
  * Network traffic sniffer & frame parser
2. IP reassembler
  * Only IP header "summaries" 
  * Payload not reassembled (content features not extracted, it is not needed)
3. Connection/Conversation reconstructor
  * Reconstructs conversations
  * Computes intrinsic features (columns 1-9 of KDD)
4. Statistical engine
  * Computes derived features (columns 23-41 of KDD)

## Build instructions to Linux (tested on Ubuntu)
1. Create a folder to temporal build files<br/>
   `mkdir build-files`<br/><br/>
2. Enter in the folder and compile the cache<br/>
  `cd build-files`<br/>
   `cmake -DCMAKE_BUILD_TYPE=Debug -G "CodeBlocks - Unix Makefiles" ..`<br/><br/>
3. Exit the folder of build cache and compile the project<br/>
  `cd ..`<br/>
  `cmake --build ./build-files --target kdd99extractor -- -j 4`<br/><br/>
4. Path to compiled project is:<br/>
  `build-files/src/kdd99extractor`<br/><br/>

## Planned sections in this readme
* TODOs (e.g. IP checksum checking not implemented)
* Known/possible problems, bugs & limitations

## Main sources of feature documentation
[1] KDD Cup 1999 Data, http://kdd.ics.uci.edu/databases/kddcup99/kddcup99.html

[2] [Lee, W. & Stolfo, S. J. (2000), 'A framework for 
onstructing features and models for intrusion detection systems', Information and System Security 3 (4) , 227-261.](http://wenke.gtisc.gatech.edu/ids-readings/lee_dmids_frmwk.pdf)

[3] [Dybey, D. & Dubey, J. (2014), 'A Survey Intrusion Detection with KDD99 Cup Dataset', International Journal of Computer Science and Information Technology Research 2 (3), 146-157.](http://www.researchpublish.com/download.php?file=A%20Survey%20Intrusion%20Detection%20with%20KDD99-403.pdf&act=book)