v1.0

Author: Coldwave96

GNB_asp.pickle

@@ -1,31 +1,71 @@
-# WebShell AIHunter : 机器学习算法检测Webshell
+# WebShell AIHunter - 机器学习算法检测Webhell
 
-![](https://raw.githubusercontent.com/Coldwave96/WebShell-AIHunter/master/logo.png)
+<div style="align: center">
+<img src="https://raw.githubusercontent.com/Coldwave96/WebShell-AIHunter/master/logo.png"/>
+</div>
 
+<p align="center">
+  <a><img src="https://img.shields.io/badge/Python-2-blue"></a>
+  <a><img src="https://img.shields.io/github/v/release/coldwave96/WebShell-AIHunter"></a>
+  <a><img src="https://img.shields.io/github/issues/coldwave96/WebShell-AIHunter"></a>
+  <a><img src="https://img.shields.io/badge/Platform-Linux%20%7C%20Windows-orange"></a>
+</p>
 
-![](https://img.shields.io/github/issues/coldwave96/WebShell-AIHunter)
+<p align="center">
+  <a href="https://coldwave96.github.io/">Welcome to my personal blog（＾◇＾）</a>
+</p>
 
-### 基于文本的WebShell检测系统
+<hr>
 
-    系统采用机器学习算法（朴素贝叶斯算法），利用词袋加IF-TDF模型对数据进行预处理及特征提取，实现了基于文本的WebShell检测系统，目前支持检测php，asp和jsp三种类型的WebShell文件。
+## 工具介绍
 
-### 调用方法
+- [⇥] 机器学习NB算法（朴素贝叶斯算法）
 
-    首先是模型的训练，分别运行train_php，train_asp，train_jsp文件，将自动生成vocabulary_php.pickle，vocabulary_asp.pickle，vocabulary_jsp.pickle这3个字典文件以及GNB_php.pickle，GNB_asp.pickle，GNB_jsp.pickle这3个模型文件。
-    检测只需运行check.py文件即可。
-    
-### 数据格式
-    
-    数据存放文件夹形式默认结构如下：
-    >Data
-        >check
-        >normal
-            >asp
-            >jsp
-            >php
-        >WebShell
-            >asp
-            >jsp
-            >php
-     PS.WebShell文件夹存放3种格式的WebShell文件，normal文件夹存放3种格式的正常文件，check文件夹下存放待检测的文件。
-        所有文件下可以有子文件，但是不支持压缩文件包。
+- [⇥] 词袋加IF-TDF模型对数据进行预处理及特征提取
+
+- [⇥] 基于文本的WebShell检测
+
+- [⇥] 支持检测php，asp和jsp三种类型的Webshell
+
+## 数据格式
+
+⚠️⚠️ Data文件夹形式默认结构如下：
+
+* Data
+    * check
+    * normal
+        * asp
+        * jsp
+        * php
+    * WebShell
+        * asp
+        * jsp
+        * php
+
+> 💎 Tips:
+>
+> 1.训练时需自行填充Data文件夹下对应目录的文件
+>
+> 2.WebShell文件夹存放3种格式的WebShell文件，normal文件夹存放3种格式的正常文件，check文件夹下存放待检测的文件
+>
+> 3.待检测文件无需分类别存放
+>
+> 4.所有文件下可以有子文件，但是不支持压缩文件包。
+>
+> 5.训练和检测时只会打开对应格式的文件，错误格式文件会自动跳过
+>
+> 6.Release只会发布训练好的模型和检测脚本
+
+## 使用方法
+
+### 检测
+
+* 只需要下载Release的版本，将待检测文件放入Data/check文件夹下，执行`python check.py`命令即可
+
+### 训练
+
+* 下载整个项目的源代码
+
+* 按照[数据格式](#webshell-aihunter---webhell)部分分别填充黑白样本文件
+
+* 依次执行`python train_php.py`、`python train_asp.py`、`python train_jsp.py`命令即可训练模型