microsoft/wafbench

WAFBench (wb) is a tool to measure the performance of WAF(Web Application Firewall) . It's based on latest code of ab (ApacheBench), and adds support for real trace replaying, framework of testing waf (FTW), and some other features.

WAF Bench (WB) Tool Suits

/\ \  _ \ \   /\  __ \   /\  ___\    /\  == \   /\  ___\   /\ "-.\ \   /\  ___\   /\ \_\ \
\ \ \/ ".\ \  \ \  __ \  \ \  __\    \ \  __<   \ \  __\   \ \ \-.  \  \ \ \____  \ \  __ \  
 \ \__/".~\_\  \ \_\ \_\  \ \_\       \ \_____\  \ \_____\  \ \_\\"\_\  \ \_____\  \ \_\ \_\
  \/_/   \/_/   \/_/\/_/   \/_/        \/_____/   \/_____/   \/_/ \/_/   \/_____/   \/_/\/_/

WAF (Web Application Firewall) Bench tool suits is designed to verify the correctness and measure the performance of WAF.

Motivation

Real Traffic Performance Testing

The WAF's performance fluctuates greatly as the input traffic varies. The existing tool, i.e. ab, can test the performance under only one kind of customized request, which can not reproduce the real traffic scenario. In addition, ab can only customize some fields of the request, which is inconvenient for testing.

In order to get the performance experienced by the real customer and further improve WAF's efficiency, we build wb, an ab-like tool, which could send multiple and fully-customized packets in one invoking. Besides, WAF Bench tool suits accepts YAML-based input, which can customize your packet and reproduce multiple different packets easily.

Automatic WAF Correctness Testing

Automatic WAF correctness testing can relieve developers from the heavy and tedious verifying works. There are two important factors for conducting a WAF correctness testing: the testing framework and test cases.

For the testing framework, we provide a FTW-Compatible Tool which leverages wb as its underlying tool. Its performance is better than FTW.

For test cases, we provide several generators for different purposes:

• Generate YAML files from the real traffic logs.
• Generate YAML files from the WAF rule set.

Currently, they are still in development.

Feature

WAF Bench

WAF Bench (wb) is the ab-like tool for conducting performance testing.

• M0 - Send/Receive HTTP&HTTPS requests/responses
• M0 - Report performance statistics
• M0 - Set the limit of testing time or total request number in testing
• M0 - Support customized packets input
• M0 - Provide debug mode with 4 level
• M0 - Support automatically adding sequence number in URL
• M0 - Support request rate limit
• M2 - Support docker app

Python-based WAF Bench

Python WAF Bench (pywb) is an enhanced tools of wb.

• M1 - Compatible with wb
• M1 - Send multiple file and directories in once executing.
• M1 - Infer Content-Type from the file extension automatically
• M2 - Support pip install
• M2 - Support docker app

FTW-compatible Tool

• M2 - Generate traffic form YAML file (in the format of FTW framework)
• M2 - Generate comparison condition file from YAML files
• M2 - Support status, log_contains, no_log_contains, expect_error directives as FTW framework
• M2 - Can search the compare result by test title and give out very detailed results (raw YAML, raw request, raw response, compare result)
• M2 - Support docker app

Auto-Test Generator

• M3 - Automatically generate requests by ModSecurity rule set for testing the coverage of WAF

Usage

Install by Dockerfile (Recommended)

Using WAFBench at Docker environment is the easiest and recommended method.

• Docker is necessary for build and usage.

# Install Docker
curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh
# Clone this repository
git clone https://github.com/microsoft/WAFBench.git
# Build WAFBench
docker build -t wafbench WAFBench

• Commands

If you install WAFBench by Dockerfile, wb, pywb, ftw_compatible_tool has been install in image wafbench. You can use them just as a local application by below commands:

docker run -ti --rm wafbench wb
docker run -ti --rm wafbench pywb
docker run -ti --rm wafbench ftw_compatible_tool

The detail usage can be found at their corresponding sections.

• Example

The black box regression test with crs-v3.1 (please replace hostname and port to the service under test)

docker run -ti --rm -v `pwd`:/data --rm wafbench ftw_compatible_tool -d /data/regression.db -x "load util/regression-test/crs-v3.1/black-box/ | gen | start hostname:port| report | exit"

The result file is regression.db with sqlite3 format, you can open it by DB Browser for SQLite.

Install at native machine

Prerequisites

Some software or libraries may be necessary for further build / usage. All of them are listed below:

• C Compiler with good C11 support (tested with gcc 4.8)
• C++ Compiler with good C++11 support (tested with g++ 4.8)
• pthread library (tested with glibc 2.17, which includes pthread)
• GNU Make (tested with GNU Make 3.82)
• libev library (tested with libev 4.0.0)
• CMake 2.8 or higher (tested with CMake 2.8)
• Boost libraries (tested with 1.53.0)
• Python 2 (tested with 2.7.5)
• pip python package management tool (tested with 8.1.2)
• ftw python module (tested with ftw 1.1.4)
• wget library (tested with wget-1.14-15.e17_4.1)
• expat library (tested with expat-devel-2.1.0-10.e17_3)
• openssl library (tested with openssl-devel-1.0.2k-12.e17)

The WB tool suites are developed and tested under CentOS 7 (Linux version 3.10, AMD 64 architecture) in a 32 core (Intel Xeon E5 @ 2.30GHz) Server.

Note: If you don't aim to conduct complex WAF testing tasks there is a cheat sheet below summarizing common testing instructions ranging from install to usage, by which you can focus on your goal; The Advance Usage section just gives you more detailed information of WB if considering it as a black box cannot satisfy your demand.

Cheat Sheet

This tutorial is based on CentOS 7 (Linux version 3.10, AMD 64 architecture). WB also can work on other Linux distribution since there is no dependencies on CentOS.

Install Dependencies

On CentOS:

Before installing dependencies using yum in CentOS, we recommend you to enable the EPEL repo to find some packages listed below (yum --enablerepo=extras install epel-release).

However you can find these packages in your own source using 'yum search ...'

sudo yum install gcc gcc-c++ make                # Install build-essential
sudo yum install libev-devel.x86_64              # Install development headers for libev
sudo yum install cmake                           # Install CMake
sudo yum install boost-devel.x86_64              # Install boost libraries
sudo yum install python2                         # Install python2
sudo yum install python2-pip.noarch              # Install python2 pip
sudo pip install ftw                             # Install ftw module
sudo yum install wget.x86_64                     # Install wget
sudo yum install expat-devel                     # Install expat
sudo yum install openssl-devel                   # Install openssl

or just type

sudo yum install gcc gcc-c++ make libev-devel.x86_64 cmake boost-devel.x86_64 python2 python2-pip.noarch wget.x86_64 expat-devel openssl-devel
sudo pip install ftw

Download WB tools suits

Just clone this repo to your machines.

git clone [email protected]:Microsoft/WAFBench.git

Install wb

Please refer to wb Readme

cd wb
make
make install

Conduct Performance Test / AB-like Test

Assuming that the server is at 10.0.1.1:18081 running we can:

./pywb/main.py -t 10 -c 20  10.0.1.1:18081

Or send requests from a file such as requests.dat:

./pywb/main.py -t 10 -c 25 -F ./example/packets/test-2-packets.yaml 10.0.1.1:18081

• More information about pywb, please refer to pywb Readme
• About the format of request file, please refer to wb Readme

Advance Usage

Since the components are independent to each other, the detailed build, install and use tutorials are maintained in their own folder. You can access them at:

• wb
• pywb
• ftw_compatible_tool

Attributions

WB uses the following libraries.

Framework for Testing WAFs (FTW!)

https://github.com/fastly/ftw

Copyright 2016 Fastly
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Changelog

For changelog, you may refer to CHANGELOG.md.

wafbench's Issues

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Check localhost instead of my defined hostname

Hi folks,

I used the example you made for the docker:

docker run -ti --rm -v pwd:/data --rm wafbench ftw_compatible_tool -d /data/regression.db -x "load util/regression-test/crs-v3.1/black-box/ | gen | start hostname:port| report | exit"

I changed hostname:port to www.mywebsite.com:443 or www.mywebsite.com:80 but it still check my localhost ( I guess the default value from the regression-test)!

Examples:

docker run -ti --rm -v pwd:/data --rm wafbench ftw_compatible_tool -d /data/regression.db -x "load util/regression-test/crs-v3.1/black-box/ | gen | start www.mywebsite.com:443| report | exit"

OR

docker run -ti --rm -v pwd:/data --rm wafbench ftw_compatible_tool -d /data/regression.db -x "load util/regression-test/crs-v3.1/black-box/ | gen | start www.mywebsite.com:80| report | exit"

Can you please advise what should be done?

Note: I fixed the issue by changing the original files in WAFBench/util/regression-test, I converted all dest_addr and port to my host name and port number.