Skip to content

Installation

Jump to bottom
Sam Stepanyan edited this page Apr 27, 2021 · 57 revisions

Contents:

Before Installation

Supported Platforms

OWASP Nettacker runs on Windows Linux, and macOS operating systems. It is compatible with both Python 2 and Python 3.

Currently supported versions of Python are Python 2.7 and Python 3.6. If you are running more recent versions of Python e.g. 3.8/3.9 you might get some warnings/errors. These are currently being worked on.

Dependencies

Before installing this software, please verify that these packages are already installed on your machine:

  • libcurl4-openssl-dev
  • libssl-dev
  • libpq-dev

Open your command line interface (You might call it a terminal or a console, we'll use CLI after this) and use any package manager (yaourt , apt, apt-get, brew) for the installation. For example:

apt-get install libssl-dev

OR

sudo apt-get install libssl-dev

If you've installed the packages above and still cannot run OWASP Nettacker without errors, you might need to install these:

  • python-dev
  • python3-dev
  • libpq-dev
  • pkgconfig openssl-dev libffi-dev musl-dev make gcc git curl-dev librtmp libxml2-dev libxslt-dev

Also make sure that you have the latest version of PIP by running:

pip install --upgrade pip

on Windows you might need to do it like this:

python -m pip install --upgrade pip

Installation

You can install OWASP Nettacker by using one of the following options:

GitHub

To install directly from GitHub using git, execute this command:

git clone https://github.com/OWASP/Nettacker.git && cd Nettacker && pip install -r requirements.txt && python setup.py install

If you're done, proceed to "After Installation".

Zip

To install from a zip file, follow these steps:

  1. Download the source code.
  2. Uncompress the file: unzip master.zip
  3. In your CLI, go to the extracted directory (Nettacker-master) and run this command:

pip install -r requirements.txt && python setup.py install

If you're done, proceed to "After Installation".

Docker

To install from Docker, run this command:

batman@batmans-MacBook-Pro ~/Documents/GitHub/Nettacker (docker) $ docker-compose up
Starting nettacker_nettacker_1 ... done
Attaching to nettacker_nettacker_1
nettacker_1  | /usr/local/lib/python2.7/site-packages/paramiko/transport.py:33: CryptographyDeprecationWarning: Python 2 is no longer supported by the Python core team. Support for it is now deprecated in cryptography, and will be removed in a future release.
nettacker_1  |   from cryptography.hazmat.backends import default_backend
nettacker_1  |     
nettacker_1  |    ______          __      _____ _____  
nettacker_1  |   / __ \ \        / /\    / ____|  __ \ 
nettacker_1  |  | |  | \ \  /\  / /  \  | (___ | |__) |
nettacker_1  |  | |  | |\ \/  \/ / /\ \  \___ \|  ___/ 
nettacker_1  |  | |__| | \  /\  / ____ \ ____) | |     Version 0.0.1  
nettacker_1  |   \____/   \/  \/_/    \_\_____/|_|     SAME
nettacker_1  |                           _   _      _   _             _            
nettacker_1  |                          | \ | |    | | | |           | |            
nettacker_1  |   github.com/zdresearch  |  \| | ___| |_| |_ __ _  ___| | _____ _ __ 
nettacker_1  |   owasp.org              | . ` |/ _ \ __| __/ _` |/ __| |/ / _ \ '__|
nettacker_1  |   zdresearch.com         | |\  |  __/ |_| || (_| | (__|   <  __/ |   
nettacker_1  |                          |_| \_|\___|\__|\__\__,_|\___|_|\_\___|_|   
nettacker_1  |                                                
nettacker_1  |     
nettacker_1  | 
nettacker_1  |  * API Key: 132613b57c675d9d18cc9eb2dfea327e
nettacker_1  |  * Serving Flask app "api.engine" (lazy loading)
nettacker_1  |  * Environment: production
nettacker_1  |    WARNING: This is a development server. Do not use it in a production deployment.
nettacker_1  |    Use a production WSGI server instead.
nettacker_1  |  * Debug mode: off
nettacker_1  |  * Running on https://0.0.0.0:5000/ (Press CTRL+C to quit)

Now you can access Nettacker WebUI from https://127.0.0.1:5000 or while the docker is running, open a new terminal and use your command line.

batman@batmans-MacBook-Pro ~/Documents/GitHub/Nettacker (docker) $ docker exec -it nettacker_nettacker_1 python nettacker.py --help
/usr/local/lib/python2.7/site-packages/paramiko/transport.py:33: CryptographyDeprecationWarning: Python 2 is no longer supported by the Python core team. Support for it is now deprecated in cryptography, and will be removed in a future release.
  from cryptography.hazmat.backends import default_backend


    
   ______          __      _____ _____  
  / __ \ \        / /\    / ____|  __ \ 
 | |  | \ \  /\  / /  \  | (___ | |__) |
 | |  | |\ \/  \/ / /\ \  \___ \|  ___/ 
 | |__| | \  /\  / ____ \ ____) | |     Version 0.0.1  
  \____/   \/  \/_/    \_\_____/|_|     SAME
                          _   _      _   _             _            
                         | \ | |    | | | |           | |            
  github.com/zdresearch  |  \| | ___| |_| |_ __ _  ___| | _____ _ __ 
  owasp.org              | . ` |/ _ \ __| __/ _` |/ __| |/ / _ \ '__|
  zdresearch.com         | |\  |  __/ |_| || (_| | (__|   <  __/ |   
                         |_| \_|\___|\__|\__\__,_|\___|_|\_\___|_|   
                                               
    

usage: Nettacker [-L LANGUAGE] [-v VERBOSE_LEVEL] [-V] [-c] [-o LOG_IN_FILE]
                 [--graph GRAPH_FLAG] [-h] [-W] [--profile PROFILE]
                 [-i TARGETS] [-l TARGETS_LIST] [-m SCAN_METHOD]
                 [-x EXCLUDE_METHOD] [-u USERS] [-U USERS_LIST] [-p PASSWDS]
                 [-P PASSWDS_LIST] [-g PORTS] [-T TIMEOUT_SEC] [-w TIME_SLEEP]
                 [-r] [-s] [-t THREAD_NUMBER] [-M THREAD_NUMBER_HOST]
                 [-R SOCKS_PROXY] [--retries RETRIES] [--ping-before-scan]
                 [--method-args METHODS_ARGS] [--method-args-list]
                 [--start-api] [--api-host API_HOST] [--api-port API_PORT]
                 [--api-debug-mode] [--api-access-key API_ACCESS_KEY]
                 [--api-client-white-list]
                 [--api-client-white-list-ips API_CLIENT_WHITE_LIST_IPS]
                 [--api-access-log]
                 [--api-access-log-filename API_ACCESS_LOG_FILENAME]
                 [--api-cert API_CERT] [--api-cert-key API_CERT_KEY]

If you're done, proceed to "After Installation".

PyPI

(Not available until the first release!)

  • Use PyPI by running this command: pip install OWASP-Nettacker (not yet working)

After Installation

Use the nettacker command to run OWASP Nettacker in your CLI after installation. For example:

nettacker --version

The above command should result in output similar to this:

  
   ______          __      _____ _____  
  / __ \ \        / /\    / ____|  __ \ 
 | |  | \ \  /\  / /  \  | (___ | |__) |
 | |  | |\ \/  \/ / /\ \  \___ \|  ___/ 
 | |__| | \  /\  / ____ \ ____) | |     Version 0.0.1  
  \____/   \/  \/_/    \_\_____/|_|     SAME
                          _   _      _   _             _            
                         | \ | |    | | | |           | |            
  github.com/zdresearch  |  \| | ___| |_| |_ __ _  ___| | _____ _ __ 
  owasp.org              | . ` |/ _ \ __| __/ _` |/ __| |/ / _ \ '__|
  zdresearch.com         | |\  |  __/ |_| || (_| | (__|   <  __/ |   
                         |_| \_|\___|\__|\__\__,_|\___|_|\_\___|_|   
                                               
    

[+] you are running OWASP Nettacker version 0.0.1 with code name SAME

To see a help directory, with a list of available commands, run this:

nettacker --help

You will see relatively long output, and it will be an up-to-date list of commands for the version you installed.

You can run the software without fully installing, by changing to the nettacker directory and using python nettacker.py. Remember to install the requirements first, by executing pip install -r requirements.txt

If you're ready to move on with using OWASP Nettacker, continue to the Usage section in the right-hand menu at the top of this page.

If you need help or have a question, feel free to contact us through our mailing list or create an issue.

OWASP Nettacker's Wiki

Manuals

Miscellaneous

Clone this wiki locally