Skip to content

Commit

Permalink
Edited the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
st3r30byt3 committed Dec 11, 2014
1 parent 151aab5 commit 1d79983
Showing 1 changed file with 27 additions and 23 deletions.
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ SPARTA v1.0 BETA (http://sparta.secforce.com)
Authors:
----
SECFORCE
Antonio Quina (@st3r30byt3)
Leonidas Stavliotis (@lstavliotis)

Antonio Quina (@st3r30byt3)
Leonidas Stavliotis (@lstavliotis)


Description
Expand All @@ -21,18 +22,21 @@ Requirements
It is recommended that Kali Linux is used as it already has most tools installed, however SPARTA would most likely also work in Debian based systems.

Kali (preferred):
apt-get install python-elixir

apt-get install python-elixir

Ubuntu 12.04+ (untested)
apt-get install python-elixir python-qt4

apt-get install python-elixir python-qt4

Other than these, the following tools are required for SPARTA to have its minimum functionality:
- nmap (for adding hosts)
- hydra (for the brute tab)
- cutycapt (for screenshots)

In Kali Linux these can be installed with:
apt-get install nmap hydra cutycapt

apt-get install nmap hydra cutycapt

Installation
----
Expand All @@ -49,17 +53,17 @@ Source code

The source code is structured in folders as such:

[app] - Contains the functionality (logic) as well as the models used by both the logic and gui
[controller] - The controller interfaces between the gui and the logic (MVC design)
[db] - Contains everything related to database, database tables, etc
[images] - Icons and images
[parsers] - Contains nmap xml output parser files
[scripts] - Contains custom scripts used by SPARTA
[ui] - Contains the gui (.ui and .py generated by Qt Creator). Do not manually edit these.
[wordlists] - Contains wordlists used by SPARTA
README.txt - This file.
sparta.conf - SPARTA's configuration file. Edit it to add custom tools and commands. If deleted, SPARTA will regenerate a new one.
sparta.py - The main program. The one that needs to be executed by the user.
* [app] - Contains the functionality (logic) as well as the models used by both the logic and gui
* [controller] - The controller interfaces between the gui and the logic (MVC design)
* [db] - Contains everything related to database, database tables, etc
* [images] - Icons and images
* [parsers] - Contains nmap xml output parser files
* [scripts] - Contains custom scripts used by SPARTA
* [ui] - Contains the gui (.ui and .py generated by Qt Creator). Do not manually edit these.
* [wordlists] - Contains wordlists used by SPARTA
* README.txt - This file.
* sparta.conf - SPARTA's configuration file. Edit it to add custom tools and commands. If deleted, SPARTA will regenerate a new one.
* sparta.py - The main program. The one that needs to be executed by the user.


Known issues
Expand All @@ -69,15 +73,15 @@ SPARTA uses a third-party tool called Cutycapt to take screenshots. One of the p

It can be compiled in Kali by following these instructions:

% sudo apt-get install subversion libqt4-webkit libqt4-dev g++
% svn co svn://svn.code.sf.net/p/cutycapt/code/ cutycapt
% cd cutycapt/CutyCapt
% qmake
% make
% ./CutyCapt --url=http://www.example.org --out=example.png
% sudo apt-get install subversion libqt4-webkit libqt4-dev g++
% svn co svn://svn.code.sf.net/p/cutycapt/code/ cutycapt
% cd cutycapt/CutyCapt
% qmake
% make
% ./CutyCapt --url=http://www.example.org --out=example.png


Credits
----

Credits where credits are due. The nmap XML output parsing engine was largely based on code by yunshu ([email protected]), modified by ketchup and modified by us. SPARTA relies heavily on nmap, hydra, cutycapt, python, PyQt, Elixir and many other tools and technologies so we would like to thank all of the people involved in the creation of those. Thanks as well to our incredible team at SECFORCE for the countless bug reports and feedback. Last but not least, thank you for using SPARTA. Let us know how we can improve it! Happy hacking!
Credits where credits are due. The nmap XML output parsing engine was largely based on code by yunshu, modified by ketchup and modified by us. SPARTA relies heavily on nmap, hydra, cutycapt, python, PyQt, Elixir and many other tools and technologies so we would like to thank all of the people involved in the creation of those. Credits to Bernardo Damele A.G. for the ms08-067_check script used by smbenum.sh. Thanks as well to our incredible team at SECFORCE for the countless bug reports and feedback. Last but not least, thank you for using SPARTA. Let us know how we can improve it! Happy hacking!

0 comments on commit 1d79983

Please sign in to comment.