Revision as of 14:03, 12 March 2019

Overview

OWASP is going to apply to participate in the inaugural Google Season of Docs We will be requesting project ideas to help us complete our organization application which is due April 23rd.

OWASP Project Documentation Requests

Tips to get you started in no particular order:

* Read Google Season of Docs Project Ideas
* Read Program Rules

OWASP ZAP

OWASP Zed Attack Proxy Project (ZAP) one of the world’s most popular free security tools and is actively maintained by hundreds of international volunteers. Previous GSoC students have implemented key parts of the ZAP core functionality and have been offered (and accepted) jobs based on their work on ZAP.

Documenting the API

ZAP has an extremely powerful API that allows you to do nearly everything that possible via the desktop interface. It is considered on of ZAPs strengths and is heavily used for automation. Unfortunately is also not particularly well documented and we get many queries about it on the support groups.

Existing documentation includes:

• https://github.com/zaproxy/zaproxy/wiki/ApiDetails
• https://github.com/zaproxy/zaproxy/wiki/ApiGen_Index

This project would:

1. Explain the concepts behind the UI
2. Explain how it can be used at a high level
3. Detail all of the API calls

The documentation should be suitable for publishing as web pages and for printing on paper.