GitBook: [master] 37 pages and one asset modified

offensive-hub · Jan 7, 2020 · 1880220 · 1880220
1 parent 61008f2
commit 1880220
Show file tree

Hide file tree

Showing 38 changed files with 111 additions and 58 deletions.
diff --git a/.gitbook/assets/settings_02.jpg b/.gitbook/assets/settings_02.jpg
diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
-# Black Widow
+---
+description: >-
+  black-widow: the most useful, powerful and complete offensive penetration
+  testing tool
+---
 
-[![Python 3.x](https://img.shields.io/badge/python-3.x-yellow.svg)](https://www.python.org/) [![License](https://img.shields.io/badge/license-GPLv3-red.svg)](https://raw.githubusercontent.com/FabrizioFubelli/black-widow/master/LICENSE) [![Docker Pulls](https://img.shields.io/docker/pulls/offensive/black-widow.svg)](https://hub.docker.com/r/offensive/black-widow) 
+# black-widow
+
+[![Python 3.x](https://img.shields.io/badge/python-3.x-yellow.svg)](https://www.python.org/) [![License](https://img.shields.io/badge/license-GPLv3-red.svg)](https://raw.githubusercontent.com/FabrizioFubelli/black-widow/master/LICENSE) [![Docker Pulls](https://img.shields.io/docker/pulls/offensive/black-widow.svg)](https://hub.docker.com/r/offensive/black-widow)
 
 ![image](https://raw.githubusercontent.com/offensive-hub/black-widow/master/resources/black-widow-img.png)
 
@@ -119,11 +125,6 @@ It provides easy ways to execute many kinds of information gatherings and attack
 * [Material Dashboard](https://github.com/creativetimofficial/material-dashboard)
 
 ### Follow Us:
-&ensp;
-[![Python 3.x](resources/social/facebook-icon.png)](https://www.facebook.com/offensive.black.widow) 
-&ensp;
-[![Python 3.x](resources/social/instagram-icon.png)](https://www.instagram.com/8l4ck_w1d0w) 
-&ensp;
-[![Python 3.x](resources/social/twitter-icon.png)](https://twitter.com/Offensive_Hub) 
-&ensp;
-[![Python 3.x](resources/social/youtube-icon.png)](https://www.youtube.com/playlist?list=PLUrUcT-zI_BfkAagJ5eAgOW8TcVYY5gB6&fbclid=IwAR1hWrMt1vchrDTr8MbAyrOk3l2KZ09uogc8tl38D052w3F1bSk5HyVXn-8) 
+
+  [![Python 3.x](.gitbook/assets/facebook-icon.png)](https://www.facebook.com/offensive.black.widow)   [![Python 3.x](.gitbook/assets/instagram-icon.png)](https://www.instagram.com/8l4ck_w1d0w)   [![Python 3.x](.gitbook/assets/twitter-icon.png)](https://twitter.com/Offensive_Hub)   [![Python 3.x](.gitbook/assets/youtube-icon.png)](https://www.youtube.com/playlist?list=PLUrUcT-zI_BfkAagJ5eAgOW8TcVYY5gB6&fbclid=IwAR1hWrMt1vchrDTr8MbAyrOk3l2KZ09uogc8tl38D052w3F1bSk5HyVXn-8)
+
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,22 +1,23 @@
 # Table of contents
 
-* [index](SUMMARY.md)
-* [arguments](app/arguments.md)
-* [env](app/env.md)
-* [gui](app/gui.md)
-* [helpers](app/helpers.md)
-  * [network](app/helpers/network.md)
-  * [storage](app/helpers/storage.md)
-  * [util](app/helpers/util.md)
-  * [validators](app/helpers/validators.md)
-* [managers](app/managers.md)
-  * [crypto](app/managers/crypto.md)
-  * [injection](app/managers/injection.md)
-  * [parser](app/managers/parser.md)
-  * [request](app/managers/request.md)
+* [black-widow](README.md)
+* [index](summary.md)
+* [arguments](arguments.md)
+* [env](env.md)
+* [GUI](gui.md)
+* [helpers](helpers/README.md)
+  * [network](helpers/network.md)
+  * [storage](helpers/storage.md)
+  * [util](helpers/util.md)
+  * [validators](helpers/validators.md)
+* [managers](managers/README.md)
+  * [crypto](managers/crypto.md)
+  * [injection](managers/injection.md)
+  * [parser](managers/parser.md)
+  * [request](managers/request.md)
   * [Sniffer](managers/sniffer.md)
-* [services](app/services.md)
-  * [logger](app/services/logger.md)
-  * [multitask](app/services/multitask.md)
-  * [serializer](app/services/serializer.md)
+* [services](services/README.md)
+  * [logger](services/logger.md)
+  * [multitask](services/multitask.md)
+  * [serializer](services/serializer.md)
 
diff --git a/app/arguments.md b/app/arguments.md
diff --git a/app/env.md b/app/env.md
diff --git a/app/gui.md b/app/gui.md
diff --git a/app/helpers.md b/app/helpers.md
diff --git a/app/helpers/network.md b/app/helpers/network.md
diff --git a/app/helpers/storage.md b/app/helpers/storage.md
diff --git a/app/helpers/util.md b/app/helpers/util.md
diff --git a/app/helpers/validators.md b/app/helpers/validators.md
diff --git a/app/managers.md b/app/managers.md
diff --git a/app/managers/crypto.md b/app/managers/crypto.md
diff --git a/app/managers/injection.md b/app/managers/injection.md
diff --git a/app/managers/parser.md b/app/managers/parser.md
diff --git a/app/managers/request.md b/app/managers/request.md
diff --git a/app/services.md b/app/services.md
diff --git a/app/services/logger.md b/app/services/logger.md
diff --git a/app/services/multitask.md b/app/services/multitask.md
diff --git a/app/services/serializer.md b/app/services/serializer.md
diff --git a/arguments.md b/arguments.md
@@ -0,0 +1,2 @@
+# arguments
+
diff --git a/env.md b/env.md
@@ -0,0 +1,2 @@
+# env
+
diff --git a/gui.md b/gui.md
@@ -0,0 +1,27 @@
+---
+description: Graphical User Interface
+---
+
+# GUI
+
+## **black-widow** provides a very modern, simple and fast graphical user interface.
+
+Unlike most cyber security and penetration testing tools, black-widow has a pretty **Web GUI** built with [**Django**](https://www.djangoproject.com/) and served by the integrated ****[**Gunicorn Server**](https://gunicorn.org/).
+
+![](.gitbook/assets/settings_02.jpg)
+
+The package [app.gui](https://github.com/offensive-hub/black-widow/tree/master/app/gui) implements a complete **Django** application which interface with **black-widow** [managers](managers/).
+
+The Django application use a [SQLight](https://sqlite.org/index.html) database to save the necessary data. That database is stored on default black-widow [storage](https://github.com/offensive-hub/black-widow/tree/master/app/storage) path.
+
+## app.gui
+
+* [manage.py](https://github.com/offensive-hub/black-widow/blob/master/app/gui/manage.py) Implements the methods **django\_gui\(\)** and **django\_cmd\(...\)**:
+  * **django\_gui\(\)** starts the Gunicorn server and opens the default user browser;
+  * **django\_cmd\(...\)** executes a django command with user inputs.
+* [web](https://github.com/offensive-hub/black-widow/tree/master/app/gui/web) Django project package root
+  * [web.black\_widow](https://github.com/offensive-hub/black-widow/tree/master/app/gui/web/black_widow) The main Django application package, which implements [**views**](https://github.com/offensive-hub/black-widow/tree/master/app/gui/web/black_widow/views), [**models**](https://github.com/offensive-hub/black-widow/tree/master/app/gui/web/black_widow/models), and [**templates**](https://github.com/offensive-hub/black-widow/tree/master/app/gui/web/black_widow/templates)\*\*\*\*
+  * [web.settings.py](https://github.com/offensive-hub/black-widow/blob/master/app/gui/web/settings.py) Django settings for web project
+  * [web.urls.py](https://github.com/offensive-hub/black-widow/blob/master/app/gui/web/urls.py) Django URL Configuration
+  * [web.wsgi.py](https://github.com/offensive-hub/black-widow/blob/master/app/gui/web/wsgi.py) Used directly by Gunicorn and contains the WSGI config for Django project
+
diff --git a/helpers/README.md b/helpers/README.md
@@ -0,0 +1,2 @@
+# helpers
+
diff --git a/helpers/network.md b/helpers/network.md
@@ -0,0 +1,2 @@
+# network
+
diff --git a/helpers/storage.md b/helpers/storage.md
@@ -0,0 +1,2 @@
+# storage
+
diff --git a/helpers/util.md b/helpers/util.md
@@ -0,0 +1,2 @@
+# util
+
diff --git a/helpers/validators.md b/helpers/validators.md
@@ -0,0 +1,2 @@
+# validators
+
diff --git a/managers/README.md b/managers/README.md
@@ -0,0 +1,2 @@
+# managers
+
diff --git a/managers/crypto.md b/managers/crypto.md
@@ -0,0 +1,2 @@
+# crypto
+
diff --git a/managers/injection.md b/managers/injection.md
@@ -0,0 +1,2 @@
+# injection
+
diff --git a/managers/parser.md b/managers/parser.md
@@ -0,0 +1,2 @@
+# parser
+
diff --git a/managers/request.md b/managers/request.md
@@ -0,0 +1,2 @@
+# request
+
diff --git a/services/README.md b/services/README.md
@@ -0,0 +1,2 @@
+# services
+
diff --git a/services/logger.md b/services/logger.md
@@ -0,0 +1,2 @@
+# logger
+
diff --git a/services/multitask.md b/services/multitask.md
@@ -0,0 +1,2 @@
+# multitask
+
diff --git a/services/serializer.md b/services/serializer.md
@@ -0,0 +1,2 @@
+# serializer
+
diff --git a/summary.md b/summary.md
@@ -0,0 +1,22 @@
+# index
+
+* [index](summary.md)
+* [arguments](arguments.md)
+* [env](env.md)
+* [gui](gui.md)
+* [helpers](helpers/)
+  * [network](helpers/network.md)
+  * [storage](helpers/storage.md)
+  * [util](helpers/util.md)
+  * [validators](helpers/validators.md)
+* [managers](managers/)
+  * [crypto](managers/crypto.md)
+  * [injection](managers/injection.md)
+  * [parser](managers/parser.md)
+  * [request](managers/request.md)
+  * [Sniffer](managers/sniffer.md)
+* [services](services/)
+  * [logger](services/logger.md)
+  * [multitask](services/multitask.md)
+  * [serializer](services/serializer.md)
+