6336c84ff5
Co-authored-by: stas <statis@microsoft.com> |
||
---|---|---|
Scripts | ||
ado | ||
cli | ||
docs | ||
src | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
GeoPol.xml | ||
LICENSE.txt | ||
NOTICE.md | ||
PRIVACY.md | ||
README.md | ||
SECURITY.md |
README.md
REST API Fuzz Testing (RAFT)
A self hosted REST API Fuzzing-As-A-Service platform
RAFT enables painless fuzzing of REST API's using multiple fuzzers in parallel. Using a single command line baked into your CI/CD pipeline developers can launch fuzz jobs against their services.
Following Swagger/OpenAPI tools are currently supported by RAFT
Tool | Description |
---|---|
RESTler | RAFT has first class integration with this Microsoft Research tool - the first stateful fuzzing tool designed to automatically test your REST API's driven by your swagger/OpenApi specification. |
ZAP | RAFT supports Swagger/OpenAPI scanning functionality provided by ZAP |
Dredd | RAFT supports Swagger/OpenAPI scanning functionality provided by Dredd |
Schemathesis | RAFT supports Swagger/OpenAPI scanning functionality provided by Schemathesis |
As a platform, RAFT is designed to host any API fuzzers that are packaged into a docker container. These can be configured and used in the system via configuration files and require no code changes to integrate.
Getting Started
This project is designed to run on Azure. See https://azure.com/free to create a free subscription and receive $200 in credits. You can run this service (and much more!) free for 30 days!
To deploy the service download the CLI release and run python raft.py service deploy
. See
the documentation for more details and the video tutorials linked below.
Once deployed, read about how to submit a job and use the samples to try out the service and fuzzers!
Documentation
Swagger Documentation
Once the service is created, you can examine the REST interface of the service by browsing to the swagger page at https://<deploymentName>-raft-apiservice.azurewebsites.net/swagger
Interesting in native code fuzzing?
Take a look at our sibling project OneFuzz
Microsoft Open Source Code of Conduct
https://opensource.microsoft.com/codeofconduct
Trademarks
Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
Preferred Languages
We prefer all communications to be in English.