Update TODO

titansec · Feb 14, 2020 · e031408 · e031408
1 parent c272c92
commit e031408
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -187,16 +187,46 @@ Please submit bug reports, wishlists, or patches by
 TODO
 ====
 
-* 01. upload anti rebot module
-* 02. upload anti hotlink module
-* 03. upload cookie guard module
-* 04. upload anti detection module
-* 05. upload anti webshell module
-* 06. upload anti csrf module
-* 07. 放开动态配置规则引擎API
-* 08. 放开动态配置行为分析引擎API
-
-[MORE](https://github.com/miracleqi/OpenWAF_TODO)
+* V1.0.0 β has the following optimization compared with v0.0.6, and the following content documents will be improved from February 17, 2020 to February 21, 2020.
+
+```txt
+性能优化：
+  Update: 变量，按需获取。不必每个请求都加载所有变量
+  Add: 配置初始化。无需在请求过程中处理不必要的配置校验及转换。
+  Add: 基于配置初始化，规则引擎设置二级缓存(变量缓存级transform结果缓存)
+  Add: 基于配置初始化，接入规则设置二级缓存，实现快速匹配(由原来的顺序匹配O(N)，改为缓存定位O(1))
+
+功能变更：
+  Add: 接入规则中”路径path”支持区分大小写(默认不区分)
+  Update: ngx.request_id 代替 random_id
+  Add: 规则引擎中 opts 的ngx_var 设置项支持动态变量
+  Add: 可从XFF中获取真实来源IP。
+  Add: 支持响应体内容替换
+  Fix: 修复变量hash上限告警提示
+  Update: 接入规则POST和DELETE的API支持批量添加或批量删除接入规则
+  Add: 支持IPv6
+  Update: OpenWAF 颁发的cookie，默认追加HttpOnly属性。
+  Add: 新增接入规则的PATCH API
+  Add: 新增策略的PATCH API
+  Upload: 接入规则host字段支持数组类型
+  Add: 可用规则生成不同频率级别的CC防护
+  Add: 添加规则集机制。可设置不同规则集，并在策略中引用指定规则集。(策略未引用规则集，则默认加载所有规则生效，兼容了无规则集的旧版本)
+  Add: 新增规则集APIs。包含增删改查。
+  Add: 日志写入本地文件(同时支持原有tcp/udp外发)
+  Update: 自定义响应头支持配置动态变量
+  Update:“重定向”动作支持配置动态变量
+  Add: 新增 errlog API，可通过调用API查询错误日志
+  Add: 新增luajit API，便于判断环境是lua还是luajit
+  Update: 统计：支持按关键字进行分类统计。
+  Add: 新增PSET功能，可自定义“对象”
+  Update: POST user_defined_rules API 不再支持 {index} 参数
+```
+* What are the considerations for upgrading from V0.0.6 to V1.0.0β. Time: February 17, 2020 to February 21, 2020
+* Release version v1.0.0 β and update docker. Time: February 17, 2020 to February 21, 2020
+* Support connecting SSO
+* Dynamic token
+* APISG(API Security gateway)
+* Mock
 
 [Back to TOC](#table-of-contents)
 

diff --git a/README_CN.md b/README_CN.md
@@ -192,16 +192,46 @@ Please submit bug reports, wishlists, or patches by
 TODO
 ====
 
-* 01. 上传人机识别模块
-* 02. 上传防盗链模块
-* 03. 上传cookie防篡改模块
-* 04. 上传基于频率的模糊识别防探测模块
-* 05. 上传WebShell上传防护模块
-* 06. 上传防CSRF模块
-* 07. 放开动态配置规则引擎API
-* 08. 放开动态配置行为分析引擎API
-
-[MORE](https://github.com/miracleqi/OpenWAF_TODO)
+* V1.0.0β 较 V0.0.6 有以下优化，2020年02月17至2020年02月21完善以下内容文档。
+
+```txt
+性能优化：
+  Update: 变量，按需获取。不必每个请求都加载所有变量
+  Add: 配置初始化。无需在请求过程中处理不必要的配置校验及转换。
+  Add: 基于配置初始化，规则引擎设置二级缓存(变量缓存级transform结果缓存)
+  Add: 基于配置初始化，接入规则设置二级缓存，实现快速匹配(由原来的顺序匹配O(N)，改为缓存定位O(1))
+
+功能变更：
+  Add: 接入规则中”路径path”支持区分大小写(默认不区分)
+  Update: ngx.request_id 代替 random_id
+  Add: 规则引擎中 opts 的ngx_var 设置项支持动态变量
+  Add: 可从XFF中获取真实来源IP。
+  Add: 支持响应体内容替换
+  Fix: 修复变量hash上限告警提示
+  Update: 接入规则POST和DELETE的API支持批量添加或批量删除接入规则
+  Add: 支持IPv6
+  Update: OpenWAF 颁发的cookie，默认追加HttpOnly属性。
+  Add: 新增接入规则的PATCH API
+  Add: 新增策略的PATCH API
+  Upload: 接入规则host字段支持数组类型
+  Add: 可用规则生成不同频率级别的CC防护
+  Add: 添加规则集机制。可设置不同规则集，并在策略中引用指定规则集。(策略未引用规则集，则默认加载所有规则生效，兼容了无规则集的旧版本)
+  Add: 新增规则集APIs。包含增删改查。
+  Add: 日志写入本地文件(同时支持原有tcp/udp外发)
+  Update: 自定义响应头支持配置动态变量
+  Update:“重定向”动作支持配置动态变量
+  Add: 新增 errlog API，可通过调用API查询错误日志
+  Add: 新增luajit API，便于判断环境是lua还是luajit
+  Update: 统计：支持按关键字进行分类统计。
+  Add: 新增PSET功能，可自定义“对象”
+  Update: POST user_defined_rules API 不再支持 {index} 参数
+```
+* 从 V0.0.6 升级至 V1.0.0β 需要哪些注意事项。时间: 2020年02月17至2020年02月21
+* 发布 V1.0.0β 版本，更新 docker。时间: 2020年02月17至2020年02月21
+* 支持对接 sso
+* 动态令牌
+* APISG(API安全网关)
+* mock
 
 [Back to TOC](#table-of-contents)