apifuzzer's Introduction

APIFuzzer — HTTP API Testing Framework

APIFuzzer reads your API description and step by step fuzzes the fields to validate if you application can cope with the fuzzed parameters. Does not require coding.

Supported API Description Formats

Swagger

Work in progress

API Blueprint

Installation

Fetch the most recent code from GitHub

$ git clone https://github.com/KissPeter/APIFuzzer.git

Install requirements. If you don't have pip installed, then sudo apt-get install python-pip -y

$ pip2.7 install -r APIFuzzer/requirements.txt

Quick Start

Check the help (some of them are not implemented yet):

$ python2.7  fuzzer.py -h
usage: fuzzer.py [-h] -s SRC_FILE [-r REPORT_DIR] [--level LEVEL]
                 [-u ALTERNATE_URL] [-t TEST_RESULT_DST]
                 [--log {warn,error,debug,info,warning,critical,notset}]

API fuzzer configuration

optional arguments:
  -h, --help        show this help message and exit
  -s SRC_FILE, --src_file SRC_FILE
                    API definition file path
  -r REPORT_DIR, --report_dir REPORT_DIR
                    Directory where error reports will be saved, default:
                    /tmp/
  --level LEVEL     Test deepness: [1,2], higher is the deeper !!!Not
                    implemented!!!
  -u ALTERNATE_URL, --url ALTERNATE_URL
                    Use CLI defined url instead compile the url from the API
                    definition. Useful for testing
  -t TEST_RESULT_DST, --test_report TEST_RESULT_DST
                    JUnit test result xml save path !!!Not implemented!!!
  --log {warn,error,debug,info,warning,critical,notset}
                    Use different log level than the default WARNING

Usage example:

Start the sample application (install the necessary packages listed in test/requirements_for_test.txt):
$ python2.7 test/test_application.py

Start the fuzzer:
$ python2.7 fuzzer.py -s test/test_swagger_definition.json -u http://localhost:5000/ -r /tmp/reports/ 

Check the reports:
$ ls -1 /tmp/reports/

Recommend Projects