REST API client to consume w3af
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci
w3af_api_client
.gitignore
LICENSE
README.rst
circle.yml
requirements.txt
setup.py

README.rst

REST API client for w3af

Launch web application security scans using w3af's REST API

Build Status

Installation

$ pip install --upgrade w3af-api-client

Usage

The REST API client allows you to run scans and access results and log files.

from w3af_api_client import Connection, Scan

# Connect to the REST API and get it's version
conn = Connection('http://127.0.0.1:5000/')
print conn.get_version()

# Define the target and configuration
scan_profile = file('/path/to/profile.pw3af').read()
target_urls = ['http://example.target']

scan = Scan(conn)
scan.start(scan_profile, target_urls)

# Wait some time for the scan to start and then
scan.get_urls()
scan.get_log()
scan.get_findings()

Source code

Developers love code, here's all you need to understand, use and extend the client:

Reporting bugs

Report your issues and feature requests in w3af-api-client's issue tracker and we'll be more than glad to fix them.

Pull requests are more than welcome!