# canshield

**Repository Path**: xbystudy/canshield

## Basic Information

- **Project Name**: canshield
- **Description**: 该仓库为CAN总线提供了一个基于深度学习的信号级入侵检测框架。 CANShield由三个模块组成：1）一个数据预处理模块，用于处理信号级别的高维CAN数据流，并将其解析为适合深度学习模型的时间序列;2）由多个深度自编码器（AE）网络组成的数据分析器模块，每个网络分析来自不同时间尺度和粒度的时间序列数据;3）最后是一个攻击检测模块，该模块使用集成方法做出最终决策。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-24
- **Last Updated**: 2024-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CANShield
This repository provides a deep learning-based signal-level intrusion detection framework for the CAN bus. CANShield consists of three modules: 1) a data preprocessing module that handles the high-dimensional CAN data stream at the signal level and parses them into time series suitable for a deep learning model; 2) a data analyzer module consisting of multiple deep autoencoder (AE) networks, each analyzing the time-series data from a different temporal scale and granularity; and 3) finally an attack detection module that uses an ensemble method to make the final decision.

![CANShield Workflow](doc/canshield_workflow.jpg)


## Clone CANShield

```
git clone https://github.com/shahriar0651/canshield.git
cd canshield
```

## Install Mambaforge
### Download and Install Mambaforge
```
wget https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
chmod +x Mambaforge-$(uname)-$(uname -m).sh
./Mambaforge-$(uname)-$(uname -m).sh
```
### Create Environment
```
mamba env create --file dependency/environment.yaml
```
Or update the existing env
```
mamba env update --file dependency/environment.yaml --prune
```

### Activate Environment
```
mamba activate canshield
```

## Download Dataset

### Download SynCAN Dataset

```
cd src
chmod +x download_syncan_dataset.sh
./download_syncan_dataset.sh
```

Here is the tree file structure after downloading the synCAN dataset:
```
datasets/
└── can-ids/
    └── syncan
        ├── ambients
        │   ├── train_1.csv
        │   ├── train_2.csv
        │   ├── train_3.csv
        │   └── train_4.csv
        ├── attacks
        │   ├── test_continuous.csv
        │   ├── test_flooding.csv
        │   ├── test_plateau.csv
        │   ├── test_playback.csv
        │   └── test_suppress.csv
        ├── License terms.txt
        └── README.md
```

## Building CANShield

### Training multiple autoencoders
```
python run_development_canshield.py
```

## Evaluating CANShield

### Testing on the test dataset
```
python run_evaluation_canshield.py
```

## Visualizing Results

### Visualize results on the test dataset
```
python run_visualization_results.py
```

## Citation
```bibtex
@article{shahriar2023canshield,
  title={CANShield: Deep-Learning-Based Intrusion Detection Framework for Controller Area Networks at the Signal Level}, 
  author={Shahriar, Md Hasan and Xiao, Yang and Moriano, Pablo and Lou, Wenjing and Hou, Y. Thomas},
  journal={IEEE Internet of Things Journal}, 
  year={2023},
  volume={10},
  number={24},
  pages={22111-22127},
  doi={10.1109/JIOT.2023.3303271}
}
```