增加翻译功能

Author: Hypdncy

.gitignore

@@ -2,6 +2,8 @@
 .idea/
 database/
 template.company/
+/test.py
+/内部员工README.md
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -5,49 +5,119 @@ GitHub:`https://github.com/Hypdncy/NessusToReport`
 
 *版权所有，侵权必究*
 
-*本项目，仅仅代表个人，如有侵权，请通知我删除*
+*本项目，仅仅代表个人，如有侵权，请联系我删除*
 
-## 配置
+## 原理说明
 
-1. config.py：用户配置信息的位置  
+1. 程序将会自动扫描nessus目录下的csv文件，将他们读取
+1. 程序将只保留csv中的紧急,高危,中危漏洞，并且与数据库，自定义配置漏洞信息做匹配
+    1. 匹配成功部分将会读取数据库中的漏洞信息，写入到loops.json中
+    1. 匹配失败部分将会写入到errors.json中
+        1. 若开启翻译，程序将会联网翻译该漏洞信息，并且再次写入到loops.json中
+        1. 未开启翻译，程序将会抛出`漏洞PluginId`异常终止
+1. 程序将自动将自动根据模板生成docx文档
 
-    1. data.date:配置时间,参见default
-    1. data.monitor:配置监督者,参见default
-    1. data.manager:配置管理者,参见default
-    1. data.work:配置工作者,参见default
-    1. datasystems:配置IP和系统的关系，该项错误可能导致报错
-    1. ignores:报告生成过程中忽略的nessusid
-    1. nessus_vuln_self:自定义的漏洞信息
+## 安装说明
 
-    *若漏洞不存在数据库中，可以通过配置自定义nessus_vuln_self来添加*
-        
-1. cnf/default.py:默认的信息配置，该部分的信息会更新到data中，默认信息
-1. cnf/data.py：全局信息
+建议在windows下安装python3版本
 
-变量覆盖顺序：config.py > default.py > data.py
+```shell script
+root@hypdncy:~# pip install -r requirement.txt
+```
+
+## 配置说明
+
+#### 基本配置
+
+##### 配置时间信息
+
+1. 配置位置：cnf/default.py中`def_default.data`参数
+1. 配置默认：默认配置为当天的时间
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会替换文档中的时间相关信息
+
+##### 修改人员信息
+
+1. 配置位置：cnf/default.py中`def_default.monitor`,`def_default.manager`,`def_default.work`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会替换文档中的参与人员信息
+
+##### 配置客户信息
+
+1. 配置位置：config.py中`config.user`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会替换文档中的客户相关信息
+
+##### 配置系统信息
+
+1. 配置位置：config.py中`config.systems`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会替换文档中的`实施范围`表
+
+#### 漏洞配置
+
+##### 配置自定义漏洞信息
+
+1. 配置位置：config.py中`config.nessus_vuln_self`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会覆盖数据库中的漏洞信息，主要用于防止因为`漏洞PluginId`异常发生报错
+
+##### 配置自定义漏洞等级
+
+1. 配置位置：config.py中`config.nessus_risk_self`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会覆盖数据库中的漏洞等级，主要用于解决`JavaScript`,`PHP`等版本漏洞风险等级过高
+
+##### 配置自定义漏洞忽略
+
+1. 配置位置：config.py中`config.nessus_ignore_ids`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置将会忽略`nessus_ignore_ids`所对应的漏洞，把他们排除在外
+
+#### 翻译配置
+
+##### 配置翻译功能
+
+1. 配置位置：config.py中`config.translate_status`参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置开启后将会自动翻译数据库中不存在的漏洞信息，并且防止因为`漏洞PluginId`异常发生报错
+
+##### 配置翻译接口
+
+1. 配置位置：config.py中`config.translate_api`,`config.translate_url`,`config.translate_appid`,`config.translate_secret`,参数
+1. 配置方法：按照参数栗子进行配置
+1. 配置说明：该配置会决定使用的翻译API
 
-## 使用
+## 使用说明
 
 1. 导入nessus的csv，放置到csv/nessus/目录下
 1. 更新属于自己的模板文档并放置在template目录下
-    
-    1. 将modle/docx_draw_host.py中"公司信息"替换为"$自己的公司"
-    
-1. 配置default.py、config.py为自己的信息
+1. 配置如上的信息
 1. 执行命令
 
 ```shell script
-python main.py -t host # 指定扫描报告类型
-python main.py # 默认主机扫描报告
+root@hypdncy:~# python main.py -t host # 指定扫描报告类型
+root@hypdncy:~# python main.py # 默认主机扫描报告
 ```
 
-> 配置出错
+## 技巧说明
 
-出错的时候一般都是漏洞信息不再数据库中也不在config.py中，这时不存在的漏洞信息将会自动dump到errors.json中,
+1. 建议使用windows+python3
+1. 遇到数据库中不存在的漏洞信息时：
+    1. 使用`配置自定义漏洞信息`功能，重新生成报告
+        1. 读取errors.json中的文件
+        1. 人工翻译并把它粘贴到`config.nessus_vuln_self`中
+    1. 开启`配置翻译功能`，重新生成报告
+1. 遇到漏洞风险等级定义过高
+    1. 使用`配置自定义漏洞等级`功能，重新生成报告
+        1. 在loops.json中寻找该漏洞的名称（从已经生成的word中获取）
+        1. 获取名称对应的id，把它粘贴到`config.nessus_risk_self`
+1. 遇到多余的，不想要漏洞
+    1. 使用`配置自定义漏洞忽略`功能，重新生成报告
 
-可以翻译该文件中的字符串，并将其更新到config.py的nessus_vuln_self中
+> 记得使用完`配置自定义漏洞等级`,`配置自定义漏洞忽略`功能后将他们注释，防止下次生成报告时，使用该次的配置
 
-## 更新
+## 更新说明
 
 1. 项目不定期发布漏洞库vuln.db，在release中可以下载，并替换到./cnf/目录下
 2. 各位可以将errors.json中的信息写到到updatedb.txt中，并且push到github，我将会翻译并将其更新其到数据库中
@@ -58,3 +128,4 @@ python main.py # 默认主机扫描报告
 
 ## 特别谢鸣
 
+Mr,YaDong:感谢YaDong同学的翻译建议与漏洞库更新

cnf/const.py

@@ -115,3 +115,10 @@
             "共发现安全漏洞{risk_count}个,存在的安全隐患主要包括{risk_includes}等安全漏洞,详情见如下章节。"
     }
 }
+# 翻译风险等级
+translate_risk = {
+    "Critical": "紧急",
+    "High": "高危",
+    "Medium": "中危",
+    "Low": "低危"
+}

cnf/default.py

@@ -36,16 +36,17 @@
 def_default = {
     # "date": "%Y-%m-%d",不填写即为默认
     "date": {
-        # 年
+        # 年, "2020"
         "year": datetime_cn.strftime('%Y'),
-        # 月
+        # 月, "07"
         "month": datetime_cn.strftime('%m'),
-        # 日
+        # 日, "07"
         "day": datetime_cn.strftime('%d'),
-        # 起始日期
+        # 起始日期, "2020-07-07"
         "start": datetime_cn.strftime('%Y-%m-%d'),
-        # 截止日期
+        # 截止日期, "2020-07-07"
         "end": datetime_cn.strftime('%Y-%m-%d'),
+        # 以下为web扫描专用
         "prepare": "0.1",
         "execute": "0.7",
         "compile": "0.1",

cnf/vuln.db

@@ -50,7 +50,10 @@
 }
 
 # 配置忽略的漏洞ID
-ignores = []
+nessus_ignore_ids = [
+    # 举个栗子
+    # "0000", "0001"
+]
 
 # 自定义漏洞信息，ID:info
 nessus_vuln_self = {
@@ -65,3 +68,31 @@
     #     "plugin_id": 18405
     # },
 }
+
+nessus_risk_self = {
+    "紧急": [
+
+    ],
+    "高危": [
+
+    ],
+    "中危": [
+
+    ],
+    "低危": [
+        # javascript漏洞系列
+        "18405",
+    ],
+}
+
+
+# 是否开启翻译功能，True or False
+translate_status = True
+# 翻译功能使用的API:baidu or youdao
+translate_api = "baidu"
+# 开启翻译功能后配置以下信息
+translate_url = 'http://api.fanyi.baidu.com/api/trans/vip/translate'
+# 翻译api的应用id
+translate_appid = '00000000000000000'
+# 翻译api的秘钥
+translate_secret = 'xxxxxxxxxxxxxxxxxxxx'