While we don't recommend their use, regular expressions are sometimes a "necessary evil" during the development of iRules. This article will discuss the commands that support regular expressions and some tools you can use to help in coming up with the format you are looking for. Other articles in the series:
A regular expression is essentially a string that is used to describe or match a set of strings, according to certain syntax rules.
Regular expressions ("REs") come in two basic flavors: extended REs ("ERE"s) and basic REs ("BREs"). For you unix heads out there, EREs are roughly the same as used by traditional egrep, while BREs are roughly those of the traditional ed. The TCL implementation of REs adds a third flavor, advanced REs ("AREs") which are basically EREs with some significant extensions.
It is beyond the scope of this article to document the regular expression syntax. A great reference is included in the re_syntax document in the TCL Built-In Commands section of the TCL documentation.
Regular Expression Examples
So what does a regular expression look like? It can be as simple as a string of characters to search for an exact match to "abc"
RE: {abc}
Or a builtin escape string that searches for all sequences of non-whitespace in a string
RE: {\S+}
Or a set of ranges of characters that search for all three lowercase letter combinations
RE: {[a-z][a-z][a-z]}
Or even a sequence of numbers representing a credit card number.
For more information on the syntax, see the re_syntax manual page in the TCL documentation, you won't be sorry.
Commands that support regular expressions
In the TCL language, the following built in commands support regular expressions:
regexp- Match a regular expression against a string regsub - Perform substitutions based on regular expression pattern matching lsearch - See if a list contains a particular element switch - Evaluate one of several scripts, depending on a given value
iRules also has an operator to make regular expression comparisons in commands like "if", "matchclass" and "findclass"
matches_regex- Tests if one string matches a regular expression.
Think twice, no three times, about using Regular Expressions
Regular expressions are fairly CPU intensive and in most cases there are faster, more efficient, alternatives available. There are the rare cases, such as the Credit Card scrubber iRule, that would be very difficult to implement with string searches. But, for most other cases, we highly suggest you search for alternate methods. The "switch -glob" and "string match" commands use a "glob style" matching that is a small subset of regular expressions, but allows for wildcards and sets of strings which in most cases will do exactly what you need.
In every case, if you are thinking about using regular expressions to do straight string comparisons, please, please, please, make use of the "equals", "contains", "starts_with", and "ends_with" iRule operators, or the glob matching mentioned above. Not only will they perform significantly faster, they will do the exact same thing.
Here's an example:
BAD: if { [regexp {bcd} "abcde"] } { BAD: if { "abcde" matches_regex "bcd" } { BETTER: if { [string match "*bcd*" "abcde"] } { BEST: if { "abcde" contains "bcd" } {
Conclusion
Regular expressions are available for those tricky situations where you just need to perform some crazy insane search like "string contains 123 but only if follows by "abc" or "def", or it contains a 5 digit number that is a valid US zip code". Also, if you need to find the exact location of a string within a string (for instance to replace one string for another), then regexp and regsub will likely work for you (if a Stream Profile doesn't). So, in some cases, a regular expression is likely the only option. Just keep in mind that even multiple string and comparison tests are more efficient than the most simple regular expression, so use them wisely.
