I would like to explain my work disassembling highly optimized regular expressions. A project like this might discourage many people, but to me, it is very exciting work! I like this kind of investigative work and want to explain what, exactly, I did, why I did it and how!
What's the problem?
The SQLi rules in the core rule set consist of 43 rules. 25 of them have been optimized with the Perl module Regexp::Assemble. This module assembles multiple regular expressions into one regular expression.
The source patterns were lost over the years as they were taken from the old CRS project and partly from other projects, and source code management migrations led to the situation we are facing now.
Unfortunately, there is no tool for disassembling an optimized regex, so we did not have a chance to undo this optimization process and regain the original patterns.
Why are the optimized patterns a problem?
An optimized regex without its original source regex can not be maintained.
We had to update an SQLi rule because of a false positive, but we did not understand the regex or even know which part of the regex caused the false positive. Another problem was that some of the rules were manually expanded and mistakes were made.
How do you update a regex that you do not understand? There's no way! This would mean that the rules are no longer maintained and extended. That would be really bad! It's also very bad for an open source project and its maintainability to have incomprehensible regexes. On top of it, there were complaints from people who said they would not install CRS. They were reluctant to install rules they could not understand.
I encountered this long-running problem when @lifeforms reported a false positive in rule 942410. See Github issue 761.
This was the rule before my work:
That's scary, isn't? How can you figure out this regex within a reasonable period of time?
I like detective work, so I started disassembling the optimized regex to find out where I could eliminate the false positive. I succeeded and wrote the source of the regex in util/regexp-assemble/regexp-942410.data. This means that from now on, we can easily update the source patterns and rebuild the optimized regex.
After updating this rule to avoid this false positive, I was hooked and the other contributors asked me to update ALL optimized regexes. Needless to say, I agreed immediately.
How did I do it?
I worked in vim and with keen eyes. I hopped from bracket to bracket and typed one letter behind the other.
Let's look at the example of rule 942150:
SecRule MATCHED_VARS "@rx (?i)\b(?:c(?:o(?:n(?:v(?:ert(?:_tz)?)?|cat(?:_ws)?|nection_id)|(?:mpres)?s|ercibility|(?:un)?t|llation|alesce)|ur(?:rent_(?:time(?:stamp)?|date|user)|(?:dat|tim)e)|h(?:ar(?:(?:acter)?_length|set)?|r)|iel(?:ing)?|ast|r32)| ... )\W*\("
Let's start at the beginning of the regex:
(i)\b(. We see an ignore case flag for the whole regex and a word boundary. Our work begins with the opening bracket. This is a relatively simple example because the corresponding closing bracket for this first opening bracket is right at the end of the regex. A
\W*\( follows the closing bracket, which stands for no or multiple non-word characters and an opening bracket. This means all of the alternatives that we find will end with this pattern. That's the first important finding.
We now proceed: We take the
ert and the
_zt and now reach a
| operator. That means we have our first word:
We now move back again because we have some question marks after the closing brackets. This means that
convert and even
conv are also valid alternatives.
We then move behind the
| to find more alternatives. Since we are still in the
con( bracket, we now find the words
concat_ws. And because of the question mark,
concat is a valid word as well. After the next
|, we find
So far we have found the following alternatives:
Remember, these start with a
\b and end with the mentioned
Now we leave the
con( bracket and move up to the
co( bracket, where we take apart the next regexes. And so on. It's basically a routine piece of work.
Two things are important: You always have to know which bracket you are currently working in. And secondly, which letter is in front and at the end of this bracket.
Many hours later, the work is done and I have created the following files in the folder util/regexp-assemble:
I want to thank the CRS community for their tests! @dune73 ran fairly big tests against the optimized rules and found two behavioral changes. @lifeforms has done some testing with sqlmap and his own written tests. He found three errors. @emphazer manually checked the output of Regexp::Assemble line by line via diff and found four small but important errors such as a
) instead of a
]. I was able to eliminate these errors relatively quickly.
I did face some problems during my work: Some regexes were not optimized at all.
Or, for special regular expressions, the Regexp::Assemble module doesn't work correctly. For example, the regex
\(? is optimized to
(a)(b)\2 is optimized to
(a)(b)2. We have bypassed these bugs by using
[(]? instead of
(a)(b)(?:\2) instead of
Finally, one optimization process created an ugly output due to its optimization method. The optimization process works from the beginning to the end of the pattern, regardless of whether the optimization would be better starting at the end of the pattern or not. The workaround was to pre-optimize the regex in the source file already.
The bottom line is that we now have optimized regexes that are easier to read.
The work is not finished yet. Because 'complexity is the enemy of security,' we've laid an important cornerstone by disassembling the rules. Because the SQLi rules are understandable, the CRS community can now reorganize them. We can remove redundancies, discover holes in the coverage and consolidate and optimize the rules.
Outside of the SQLi rules, there are about 10 rules that could be disassembled as well.
This further development is very important, as it will bring better performance and hopefully even better detection rates than we currently have.
If you are interested in helping us enhance the CRS, your help is very welcome!
Franziska Buehler / @bufrasch