From 536292ff2fec2bf99b225c0a1743356ce9cd83ca Mon Sep 17 00:00:00 2001 From: ajmeese7 Date: Thu, 9 Feb 2023 20:02:00 -0500 Subject: [PATCH] docs: improves README syntax highlighting --- Dockerfile | 1 - README.md | 39 +++++++++++++++++++++++---------------- 2 files changed, 23 insertions(+), 17 deletions(-) diff --git a/Dockerfile b/Dockerfile index 052a372..c184d8a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -31,4 +31,3 @@ RUN curl -L https://ftp.mozilla.org/pub/firefox/releases/${FIREFOX_VERSION}/linu ln -s /opt/firefox/firefox /usr/bin/firefox CMD ["python", "zeus.py"] - diff --git a/README.md b/README.md index d54a47f..57241a2 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ ---- [![GitHub stars](https://img.shields.io/github/stars/ekultek/zeus-scanner.svg?style=flat-square)](https://github.com/ekultek/zeus-scanner/stargazers) -[![GitHub forks](https://img.shields.io/github/forks/ekultek/zeus-scanner.svg?style=flat-square)](https://github.com/ekultek/zeus-scanner/network) -[![GitHub issues](https://img.shields.io/github/issues/ekultek/zeus-scanner.svg?style=flat-square)](https://github.com/ekultek/zeus-scanner/issues) +[![GitHub forks](https://img.shields.io/github/forks/ekultek/zeus-scanner.svg?style=flat-square)](https://github.com/ekultek/zeus-scanner/network) +[![GitHub issues](https://img.shields.io/github/issues/ekultek/zeus-scanner.svg?style=flat-square)](https://github.com/ekultek/zeus-scanner/issues) [![GitHub license](https://img.shields.io/badge/license-GPL-blue.svg?style=flat-square)](https://raw.githubusercontent.com/Ekultek/Zeus-Scanner/master/.github/LICENSE.md) [![Twitter](https://img.shields.io/twitter/url/https/github.com/ekultek/zeus-scanner.svg?style=social)](https://twitter.com/stay__salty) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://github.com/Ekultek/Zeus-Scanner#donations) @@ -38,7 +38,7 @@ ### What is Zeus? -Zeus is an advanced reconnaissance utility designed to make web application reconnaissance simple. Zeus comes complete with a powerful built-in URL parsing engine, multiple search engine compatibility, the ability to extract URLs from both ban and webcache URLs, the ability to run multiple vulnerability assessments on the target, and is able to bypass search engine captchas. +Zeus is an advanced reconnaissance utility designed to make web application reconnaissance simple. Zeus comes complete with a powerful built-in URL parsing engine, multiple search engine compatibility, the ability to extract URLs from both ban and webcache URLs, the ability to run multiple vulnerability assessments on the target, and is able to bypass search engine captchas. ### Features @@ -64,13 +64,18 @@ Zeus is an advanced reconnaissance utility designed to make web application reco ### Screenshots Running without a mandatory options, or running the `--help` flag will output Zeus's help menu: + ![zeus-help](https://user-images.githubusercontent.com/14183473/30176257-63391c62-93c7-11e7-94d7-68fde7818381.png) + A basic dork scan with the `-d` flag, from the given dork will launch an automated browser and pull the Google page results: + ![zeus-dork-scan](https://user-images.githubusercontent.com/14183473/30176252-618b191a-93c7-11e7-84d2-572c12994c4d.png) -Calling the `-s` flag will prompt for you to start the sqlmap API server `python sqlmapapi.py -s` from sqlmap, it will then connect to the API and perform a sqlmap scan on the found URL's. + +Calling the `-s` flag will prompt for you to start the sqlmap API server `python sqlmapapi.py -s` from sqlmap, it will then connect to the API and perform a sqlmap scan on the found URLs: + ![zeus-sqlmap-api](https://user-images.githubusercontent.com/14183473/30176259-6657b304-93c7-11e7-81f8-0ed09a6c0268.png) -You can see more screenshots [here](https://github.com/Ekultek/Zeus-Scanner/wiki/Screenshots) +You can see more screenshots [here](https://github.com/Ekultek/Zeus-Scanner/wiki/Screenshots). ### Demo @@ -89,8 +94,8 @@ There are some requirements for this to be run successfully. - If you want to run a port scan using nmap on the URL's IP addresses. You will need nmap on your system. - [Geckodriver](https://github.com/mozilla/geckodriver) is required to run the firefox web browser and will be installed the first time you run. It will be added to your `/usr/bin` so that it can be run in your ENV PATH. - You must be `sudo` for the first time running this so that you can add the driver to your PATH, you also may need to run as `sudo` depending on your permissions. _NOTE:_ `Depending on permissions you may need to be sudo for any run involving the geckodriver` - - `xvfb` is required by `pyvirtualdisplay`, it will be installed if not installed on your first run - + - `xvfb` is required by `pyvirtualdisplay`, it will be installed if not installed on your first run + ##### Python package requirements - [selenium-webdriver](http://www.seleniumhq.org/projects/webdriver/) package is required to automate the web browser and bypass API calls. @@ -110,20 +115,21 @@ You can download the latest [tar.gz](https://github.com/ekultek/zeus-scanner/tar ##### Ubuntu/Debian -``` +```shell sudo apt-get install libxml2-dev libxslt1-dev python-dev && git clone https://github.com/ekultek/zeus-scanner.git && cd zeus-scanner && sudo pip2 install -r requirements.txt && sudo python zeus.py -``` - +``` + ##### centOS -``` +```shell sudo apt-get install gcc python-devel libxml2-dev libxslt1-dev python-dev && git clone https://github.com/ekultek/zeus-scanner.git && cd zeus-scanner && sudo pip2 install -r requirements.txt && sudo python zeus.py ``` #### Backbox 64 bit installation: -``` + +```shell sudo -s << EOF aptitude purge firefox wget https://ftp.mozilla.org/pub/firefox/releases/57.0/linux-x86_64/en-US/firefox-57.0.tar.bz2 @@ -137,7 +143,8 @@ EOF ``` 32 bit installation: -``` + +```shell sudo -s << EOF aptitude purge firefox wget https://ftp.mozilla.org/pub/firefox/releases/57.0/linux-i686/en-US/firefox-57.0.tar.bz2 @@ -152,7 +159,7 @@ EOF ##### Others -``` +```shell sudo apt-get install libxml2-dev libxslt1-dev python-dev && git clone https://github.com/ekultek/zeus-scanner.git && cd zeus-scanner && sudo pip2 install -r requirements.txt && sudo python zeus.py ``` @@ -166,7 +173,7 @@ Zeus is created by a small team of developers that have an aspiration for inform - Bitcoin(BTC): `3DAQGcAQ194NGVs16Mmv75ip45CVuE8cZy` - [PayPal](https://www.paypal.me/ZeusScanner) - Or you can [Buy us a coffee](https://ko-fi.com/A28355P5) - + You can be assured that all donations will go towards Zeus funding to make it more reliable and even better, thank you from the Zeus development team ### Shoutouts @@ -177,7 +184,7 @@ OpenSource Projects is a Facebook community page who's goal is to give developer ### Translations - + - [Spanish](https://github.com/Ekultek/Zeus-Scanner/blob/master/.github/translations/README-spanish.md) - [Russian](https://github.com/Ekultek/Zeus-Scanner/blob/master/.github/translations/README-russian.md) - [French](https://github.com/Ekultek/Zeus-Scanner/blob/master/.github/translations/README-french.md)