Skip to content

README.md

Latest commit

 

History

History
62 lines (38 loc) · 2.11 KB

README.md

File metadata and controls

62 lines (38 loc) · 2.11 KB

SecureStream Project

This repository contains the source code and notebooks for the SecureStream project, which focuses on anomaly detection in network traffic. The project utilizes Python scripts and Jupyter notebooks for creating models and running anomaly detection algorithms.

Setup

Virtual Environment

To set up the project environment, follow these steps:

  1. Clone this repository to your local machine.
  2. Navigate to the project directory.
cd securestream
  1. Create a Python virtual environment.
make venv
  1. Install the required libraries from the requirements.txt file.
make install

Run Anomaly Detection

To run the anomaly detection script, use the following command:

make run_anomaly_detection

This will execute the script responsible for detecting anomalies in network traffic.

Makefile Targets

  • venv: Create Python virtual environment.
  • install: Install required libraries from requirements.txt.
  • setup: Set up the project (create venv, install libraries, and perform configuration).
  • run_anomaly_detection: Run the anomaly detection script.
  • help: Display available Makefile targets.

Notebooks

The repository also contains Jupyter notebooks for creating models and analyzing network traffic data. Feel free to explore these notebooks for further insights into the project.

Usage of Data and Tools

  • Dataset: This project utilizes the CSE-CIC-IDS2018 dataset for training and evaluating the anomaly detection models. The dataset provides a comprehensive collection of network traffic data with labeled instances of various attacks and normal behavior.

  • cicflowmeter: Real-time tracking of network traffic is achieved using the cicflowmeter tool. This tool captures traffic data and feeds it into the anomaly detection system for analysis and detection of anomalies in real-time.

Contributors

If you have any further questions or need additional information, feel free to ask!