-
Notifications
You must be signed in to change notification settings - Fork 478
Commit checklist
BEFORE committing anything please follow the steps below:
- Do an update: git pull (or) git fetch && git merge <-- Ensure your changes are compatible with the latest code.
- Do a rebase with the current branch.
- Re-test your changes: Run OWTF, make sure basic functionality works + what you changed is still working.
- Make sure everything is working as expected: run all the tests before committing: cd tests; ./run_tests.py --all.
- Make sure the your code is PEP-8 compliant by running (requires flake8 module.)
FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -e '\.py$')
if [ -n "$FILES" ]; then
flake8 -r $FILES
fi
This can also be used a pre-commit Git hook. For more information, refer to Git hooks.
- Once you are happy that your changes are working, please add the details to the changelog
- Please try to use useful commit messages with the component name, for eg. [ui], [api], etc.
- Send a pull request!
If you haven't read Contributing, you are recommended to read it before contributing.
NOTE: Due to the recent changes in the OWTF repo, all contributors are suggested to use a fresh clone of the repo
This wiki and the OWTF README document contains a lot of information, please take your time and read these instructions carefully.
We provide a CHANGELOG that provides details about almost every OWTF release.
Be sure to read the CONTRIBUTING guidelines before reporting a new OWTF issue or opening a pull request.
If you have any questions about the OWTF usage or want to share some information with the community, please go to one of the following places:
- IRC channel
#owtf(irc.freenode.net)
Google Summer of Code 2018 Guide
Installation
Getting Started
- Define where your tools are
- Run OWASP OWTF
- HTTP Auth Configurations
- Simulation mode
- AUX plugins usage
- FAQ
SET usage
Cookbooks (GSoC 2014 Projects UPDATE)
-
Zest Integration:
- Quick Guide to get started with Zest,ZAP and Replay
- Zest and ZAP API Installation
- Zest and ZAP integration Introduction
- Zest Runner module
- Forward HTTP request to ZAP
- Zest script creation from single HTTP transaction
- Zest script creation from multiple HTTP transactions
- Zest Script Creator module
- HTTP Request Editing Window (Replay Function)
- Zest Script Recording Functionality
- Zest scripting console
Development
-
Plugins:
-
Tests:
Contact