Welcome to w3af's documentation
===============================

This document is the user's guide for the Web Application Attack and Audit Framework (w3af), its goal is to provide a basic overview of what the framework is, how it works and what you can do with it.

w3af is a complete environment for auditing and exploiting Web applications. This environment provides a solid platform for web vulnerability assessments and penetration tests.

.. |Github| image:: images/github-logo.png
   :scale: 50 %                                   
   :target: https://github.com/andresriancho/w3af/
   :alt: Github repository

.. |w3af| image:: images/w3af-logo.png          
   :scale: 50 %                          
   :target: https://w3af.org/            
   :alt: w3af homepage                   

.. |irc| image:: images/irc.png                
   :scale: 50 %                          
   :target: irc://irc.freenode.net:8001/w3af
   :alt: IRC channel                        

.. |usersml| image:: images/mailing_list.png          
   :scale: 50 %                             
   :target: https://lists.sourceforge.net/lists/listinfo/w3af-users
   :alt: Users mailing list                                        

.. |developml| image:: images/mailing_list.png                                 
   :scale: 50 %                                                      
   :target: https://lists.sourceforge.net/lists/listinfo/w3af-develop
   :alt: Developers mailing list                                     

.. |twitter| image:: images/twitter-logo.png                                   
   :scale: 15 %                                                      
   :target: http://twitter.com/w3af                                  
   :alt: Twitter feed       
                                            
+-----------------------------------------------------------------------------------------+---------------------+
| `Github repository <https://github.com/andresriancho/w3af/>`_                           |  |Github|           |
+-----------------------------------------------------------------------------------------+---------------------+
| `w3af homepage <https://w3af.org/>`_                                                    |  |w3af|             |
+-----------------------------------------------------------------------------------------+---------------------+
| `IRC channel <irc://irc.freenode.net:8001/w3af>`_                                       |  |irc|              |
+-----------------------------------------------------------------------------------------+---------------------+
| `Users mailing list <https://lists.sourceforge.net/lists/listinfo/w3af-users>`_         |  |usersml|          |
+-----------------------------------------------------------------------------------------+---------------------+
| `Developers mailing list <https://lists.sourceforge.net/lists/listinfo/w3af-develop>`_  |  |developml|        |
+-----------------------------------------------------------------------------------------+---------------------+
| `Twitter feed <http://twitter.com/w3af>`_                                               |  |twitter|          |
+-----------------------------------------------------------------------------------------+---------------------+

Contents
--------

.. toctree::
   :maxdepth: 2

   install
   advanced-install
   update

   phases
   basic-ui
   scripts
   authentication
   common-use-cases
   advanced-use-cases
   docker

   exploitation
   advanced-exploitation

   report-a-bug
   contribute

GUI documentation
-----------------
.. toctree::
   :maxdepth: 3

   gui/index

REST API documentation
----------------------
.. toctree::
   :maxdepth: 3

   api/index

Advanced tips and tricks
------------------------
.. toctree::
   :maxdepth: 2

   advanced-tips-tricks