Switch to go-re2 #1005
Open
Switch to go-re2 #1005
Conversation
This file contains 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
Go's Regexp seems to be very costly for Coraza (and perhaps others). Profiling Coraza/Caddy (w/OWASP4), with the 'wrk' benchmark tool shows the following: 31.68% caddy caddy [.] regexp.(*machine).add 16.80% caddy caddy [.] regexp.(*machine).step 16.55% caddy caddy [.] regexp.(*machine).match 4.47% caddy caddy [.] regexp.(*inputString).step 3.45% caddy caddy [.] regexp.(*machine).alloc 3.13% caddy caddy [.] regexp.lazyFlag.match After switching over to Re2, those disappear.
|
We provide a plugin to make it easy to swap in go-re2 https://github.com/corazawaf/coraza-wasilibs go-re2 is a pretty heavyweight dependency so it's probably better to still keep it opt-in rather than only supporting it. I think for caddy we just want to provide a build tag that uses coraza-wasilibs |
|
I don't think we should migrate right away but defintively we need a section on how to use wasilibs. Mind working that out @monkburger? see https://github.com/corazawaf/coraza-wasilibs |
|
Maybe for regex engines, we should have build flags... I was also working on hyperscan integration |
|
@monkburger Are you up for working on #1005 (comment)? |
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.
When running Coraza within Caddy, profiling was showing elevated regexp.* usage. After discussions on Slack, it was demonstrated that the Go-Re2 offers much lower CPU / slightly better performance with Go-Re2 compared to the standard regexp. (There are legions of discussions about Go's regexp engine being slow on the web)
Since this is a drop-in replacement, existing testing doesn't require adjustment as far as I can see. (if this is an issue I can send another PR)
Make sure that you've checked the boxes below before you submit PR:
Thanks for your contribution ❤️