feat: support chaitin-waf plugin by lingsamuel · Pull Request #9838 · apache/apisix

lingsamuel · 2023-07-14T10:58:57Z

Description

Fixes # (issue)

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

Signed-off-by: Ling Samuel (WSL) <[email protected]>

soulbird · 2023-07-31T10:08:00Z

+404 page not found
+```
+
+当满足匹配条件时，正常请求依然可以触达：


触达上游？

soulbird · 2023-07-31T10:08:25Z

+
+local function get_conf(conf, metadata)
+    local t = {
+        mode = "block", -- block or monitor or off, default off


default value is ’off‘ ?

soulbird · 2023-07-31T10:09:30Z

+
+    if conf.match then
+        for _, match in ipairs(conf.match) do
+            local exp, err = expr.new(match.vars)


Can we cache the result of expression compilation？

We will do it after this pr

Add TODO pls

soulbird · 2023-07-31T10:10:01Z

+        config = {
+            type = "object",
+            properties = {
+                -- connect timeout, in milliseconds, integer, default 1s (1000ms)


Annotation looks unnecessary

let's move it to the properties item desc?

soulbird · 2023-07-31T10:11:55Z

+                type = "object",
+                properties = {
+                    host = {
+                        type = "string",


It is recommended to use a stricter schema definition. https://github.com/apache/apisix/blob/master/apisix/schema_def.lua#L40

soulbird · 2023-07-31T10:15:39Z

+     - 9200
+     - "127.0.0.1:9201"
+plugins:
+    - chaitin-waf


The plugin has been enabled by default, there is no need to add it separately

leslie-tsang · 2023-07-31T10:31:59Z

+        config = {
+            type = "object",
+            properties = {
+                -- connect timeout, in milliseconds, integer, default 1s (1000ms)


let's move it to the properties item desc?

kayx23 · 2023-08-01T01:50:58Z

+{"code": 403, "success":false, "message": "blocked by Chaitin SafeLine Web Application Firewall", "event_id": "51a268653f2c4189bfa3ec66afbcb26d"}
+```
+
+## Disable Plugin


Suggested change

## Disable Plugin

## Delete Plugin

This sections of all plugin docs (en/zh) have been corrected previously. Reference to the latest here: https://apisix.apache.org/docs/apisix/next/plugins/response-rewrite/#delete-plugin

kayx23 · 2023-08-01T01:52:45Z

+
+## Disable Plugin
+
+To disable the `chaitin-waf` plugin, remove the plugin configuration in the plugin configuration:


Suggested change

To disable the `chaitin-waf` plugin, remove the plugin configuration in the plugin configuration:

To remove the `chaitin-waf` plugin, delete the the corresponding JSON configuration from the Plugin configuration:

kayx23 · 2023-08-01T03:32:54Z

+{"code": 403, "success":false, "message": "blocked by Chaitin SafeLine Web Application Firewall", "event_id": "51a268653f2c4189bfa3ec66afbcb26d"}
+```
+
+## 禁用插件


Suggested change

## 禁用插件

## 删除插件

kayx23 · 2023-08-01T03:35:11Z

+| add_header               | bool          | false    | true          | Whether to add response headers                                                                                                                                                                                                                                                                                                                           |
+| add_debug_header         | bool          | false    | false         | Whether or not to add debugging headers, effective when `add_header` is `true`.                                                                                                                                                                                                                                                                           |
+| config                   | object        | false    |               | Configuration of the Chaitin SafeLine WAF service. When the route is not configured, the parameters configured in the metadata are used.                                                                                                                                                                                                                  |
+| config.connect_timeout   | integer       | false    |               | connect timeout, in milliseconds, integer                                                                                                                                                                                                                                                                                                                 |


feat: support chaitin-waf plugin

b787e58

Signed-off-by: Ling Samuel (WSL) <[email protected]>

lingsamuel marked this pull request as draft July 14, 2023 10:59

lingsamuel added 3 commits July 19, 2023 00:34

support healthcheck

82e4d3f

match var

75ca6d5

add zh doc for chaitin waf

869e0e5

Signed-off-by: Ling Samuel (WSL) <[email protected]>

lingsamuel force-pushed the chaitin-waf branch from 73e55b2 to 477194f Compare July 20, 2023 01:03

support test server

f328133

Signed-off-by: Ling Samuel (WSL) <[email protected]>

lingsamuel force-pushed the chaitin-waf branch from 477194f to f328133 Compare July 20, 2023 01:09

lingsamuel added 12 commits July 21, 2023 09:01

support config, add test

a91024a

make lint

bb12f60

timeout and remote_addr

264e8fe

format doc

e3771ab

fix test

30bd27a

update

607d83b

Remove incorrect health check impl

c1ed348

Signed-off-by: Ling Samuel (WSL) <[email protected]>

Merge branch 'master' into chaitin-waf

ac872fe

add chaitin-waf doc/en

8e2c4a6

Merge branch 'master' into chaitin-waf

38acc83

add chaitin waf to config.json

48f593a

Signed-off-by: Ling Samuel (WSL) <[email protected]>

fix plugins test

7fb78d3

lingsamuel requested review from AlinsRan, juststillthinking, kingluo and leslie-tsang July 28, 2023 06:57

lingsamuel marked this pull request as ready for review July 28, 2023 06:57

juststillthinking requested a review from soulbird July 28, 2023 06:59

soulbird reviewed Jul 31, 2023

View reviewed changes

leslie-tsang reviewed Aug 1, 2023

View reviewed changes

kayx23 reviewed Aug 1, 2023

View reviewed changes

juststillthinking added 2 commits August 1, 2023 11:21

refactor: resolve review comments

60ab472

refactor: resolve review comments

eaf4b9a

kayx23 reviewed Aug 1, 2023

View reviewed changes

refactor: resolve review comments

4d36ce9

kayx23 reviewed Aug 1, 2023

View reviewed changes

refactor: resolve review comments

c37d40f

leslie-tsang approved these changes Aug 1, 2023

View reviewed changes

soulbird approved these changes Aug 1, 2023

View reviewed changes

juststillthinking merged commit 455d5bf into apache:master Aug 1, 2023

kldcty pushed a commit to kldcty/apisix that referenced this pull request Aug 8, 2023

feat: support chaitin-waf plugin (apache#9838)

b0145e7


		## Disable Plugin

		To disable the `chaitin-waf` plugin, remove the plugin configuration in the plugin configuration:

	To disable the `chaitin-waf` plugin, remove the plugin configuration in the plugin configuration:
	To remove the `chaitin-waf` plugin, delete the the corresponding JSON configuration from the Plugin configuration:

	\| config.connect_timeout \| integer \| false \| \| connect timeout, in milliseconds, integer \|
	\| config.connect_timeout \| integer \| false \| \| connect timeout, in milliseconds \|

Uh oh!

Conversation

lingsamuel commented Jul 14, 2023

Description

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kayx23 Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kayx23 Aug 1, 2023 •

edited

Loading