feat: chaitin waf response logging - #13763
Open
blaisewang wants to merge 2 commits into
Open
Conversation
lua-resty-t1k 1.2.0 can report the response back to the SafeLine WAF detection service in addition to the request. Bump the dependency and expose it through three new `config` options: - `log_resp` enables response reporting, off by default so existing configurations keep their current behavior - `resp_body_size` caps how much of the response body is buffered and reported, in KB, defaulting to 4 - `extra_ignored_content_types` skips further response content types on top of the built-in ignored list Wire up the `body_filter` and `log` phases to the corresponding library entry points. The report is sent from an ngx.timer during the log phase, so it does not delay the response, and the detection result is only visible in the SafeLine console: a response is never blocked or modified based on it. `get_conf` applied the metadata and route level config blocks with two copies of the same field-by-field assignment, which three more options would have made harder to keep in sync. Fold both into a local helper, keeping the existing precedence of route level config over metadata. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Add schema validation cases for the `resp_body_size` minimum and the `extra_ignored_content_types` type, plus round-trip cases asserting that a route configured with response logging still serves its response unchanged, and that the default configuration behaves the same way. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
lua-resty-t1k1.2.0 can report the response to the SafeLine WAF detection service in addition to the request. This PR bumps the dependency and exposes the capability through thechaitin-wafplugin.Until now the plugin only reported requests, so anything the WAF could have detected on the way out — data leaks in a response body, a successful exploit's output, an unexpected status code — was invisible to SafeLine. Enabling response reporting closes that gap without changing how requests are handled.
Three new
configoptions, available both at plugin level and in the plugin metadata:log_respfalseresp_body_size>= 0)40reports only the status line and headers.extra_ignored_content_typesContent-Typevalues to skip, on top of the built-in list.How it works:
body_filterandlogphases, delegating tot1k.do_body_filter()andt1k.do_log().body_filterbuffers up toresp_body_sizeKB of the response body; the report itself is sent from anngx.timerduring the log phase, after the response has been handed back to the client. It therefore adds no latency to the response.Content-Typeis in the ignored list (audio, video, font, image and other binary media types out of the box).One refactor was needed along the way:
get_confapplied the metadata and plugin levelconfigblocks with two verbatim copies of the same field-by-field assignment. Adding three more options would have meant keeping three copies in sync, so both are folded into a local helper. Precedence is unchanged — plugin level config still overrides metadata.Docs updated in both
enandzh, including a new "Response Logging" section that covers the async reporting model, the skip conditions, and the memory cost of buffering response bodies on routes serving large responses.Which issue(s) this PR fixes:
N/A — no existing issue; this adds a new capability to the plugin.
Checklist