Skip to content

Commit 6d8f15c

Browse files
committed
Added some improvements to README total out release
1 parent 50c0fc9 commit 6d8f15c

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

README.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<br>
33
<a href="https://github.com/theinfecteddrake"><img src="https://i.imgur.com/QAbaVdU.png" alt="TIDoS"></a>
44
<br>
5-
TIDoS Framework
5+
The TIDoS Framework
66
<br>
77
</h1>
88

@@ -54,6 +54,10 @@ Here is some light on what the framework is all about:
5454

5555
### Installation :-
5656

57+
#### Global Installation:
58+
59+
> NOTE: For installing globally, you will need to default your Python version to 2.x.
60+
5761
* Clone the repository locally and navigate there:
5862
```
5963
git clone https://github.com/theinfecteddrake/tidos-framework.git
@@ -71,11 +75,26 @@ Thats it! Now you are good to go! Now lets run the tool:
7175
tidos
7276
```
7377

78+
#### Manual Installation (Locally) :
79+
80+
TIDoS needs some libraries to run, which can be installed via `aptitude` or `yum` Package Managers.
81+
```
82+
sudo apt-get install libncurses5 libxml2 nmap tcpdump scons libexiv2-dev python-pyexiv2 build-essential python-pip default-libmysqlclient-dev python-xmpp
83+
```
84+
Now after these dependencies are finished installing, we need to install the remaining Python Package dependencies, hence run:
85+
```
86+
pip2 install -r requirements.txt
87+
```
88+
Thats it, You now have TIDoS at your service. Fire it up using:
89+
```
90+
python2 tidos.py
91+
```
92+
7493
### Getting Started :-
7594

7695
TIDoS is made to be comprehensive and versatile. It is a highly flexible framework where you just have to select and use modules.
7796

78-
But before that, you need to set your own `API KEYS` for various OSINT purposes. To do so, open up `API_KEYS.py` under `files/` directory and set your own keys and access tokens for `SHODAN`, `CENSYS`, `FULL CONTACT`, `GOOGLE` and `WHATCMS`. Public `API KEYS` and `ACCESS TOKENS` for `SHODAN` and `WHATCMS` have been provided with the TIDoS release itself. You can still add your own... `no harm!`
97+
But before that, you need to set your own `API KEYS` for various OSINT & Scanning and Enumeration purposes. To do so, open up `API_KEYS.py` under `files/` directory and set your own keys and access tokens for `SHODAN`, `CENSYS`, `FULL CONTACT`, `GOOGLE` and `WHATCMS`. Public `API KEYS` and `ACCESS TOKENS` for `SHODAN` and `WHATCMS` have been provided with the TIDoS release itself. You can still add your own... `no harm!`
7998

8099
Finally, as the framework opens up, enter the website name `eg. http://www.example.com` and let TIDoS lead you. Thats it! Its as easy as that.
81100

@@ -88,7 +107,7 @@ To update this tool, use `tidos_updater.py` module under `tools/` folder.
88107

89108
### Flawless Features :-
90109

91-
TIDoS Framework presently supports the following: `and is under active development`
110+
TIDoS Framework presently supports the following: `and more modules are under active development`
92111

93112
* __Reconnaissance + OSINT__
94113

@@ -192,7 +211,7 @@ TIDoS Framework presently supports the following: `and is under active developme
192211
- Missing `SPF` Records
193212
- Missing `DMARC` Records
194213
+ Host Header Injection
195-
- Port Based Injection `via Web-Sockets`
214+
- Port Based `Web Socket Based`
196215
- `X-Forwarded-For` Header Injection
197216
+ Security Headers Analysis `Live Capture`
198217
+ Cross-Site Tracing `HTTP TRACE Method`
@@ -302,25 +321,23 @@ There are some bruteforce modules to be added:
302321
- Normal Bug Fixing Stuffs. `As per the issues being raised`
303322
- Some other perks:
304323
- Working on a way for contributing new modules easily.
305-
- A complete new method of multi-threaded fuzzing.
324+
- A complete new method of multi-threaded fuzzing of parameters.
306325
- Keeping better of new console stuff.
307326

308327
### Disclaimer:
309328

310329
TIDoS is provided as a offensive web application audit framework. It has built-in modules which can reveal potential misconfigurations and vulnerabilties in web applications which could possibly be exploited maliciously.
311330

312-
__THEREFORE, I AM NOT EXCLUSIVELY RESPONSIBLE FOR ANY MISUSE OF THIS TOOLKIT.__
331+
__THEREFORE, I AM NOT EXCLUSIVELY RESPONSIBLE FOR ANY MISUSE OR DAMAGE DUE TO THIS TOOLKIT.__
313332

314333
### Final Words:
315334

316-
This project is presently under active development so you may want to put it on a watch, since it is updated frequently `(you can take a look at past commits history)`. This project is one of the best frameworks I have ever built and I would really like your constructive criticism, suggestions and help in converting this project into the best web penetration testing framework ever built `and trust me, it will be ;)`.
335+
This project is presently under active development so you may want to put it on a watch, since it is updated frequently `(you can take a look at past commits history)`. This project is one of the best frameworks I have ever built and I would really like your constructive criticisms, suggestions and help in converting this project into the best web penetration testing framework ever built `and trust me, it will be ;)`.
317336

318-
> __TEMPORARY UPDATE__:
319-
>
320-
> Please avoid doing pull requests temporarily, since work on v2 of this framework has already begun, which actually will fix the shitty code which I casually wrote all the way through. :)
337+
> TEMPORARY UPDATE:
338+
>
339+
> Please avoid doing any pull requests temporarily as work for v2 of this framework is already underway and in active development.
321340
322341
Got any suggestions? Encountering bugs with this framework? Raise up an [issue](https://github.com/theInfectedDrake/TIDoS-Framework/issues/new) or hit me up via DM on [twitter](https://twitter.com/infecteddrake).
323342

324-
> Copyright © __The Infected Drake__.
325-
326-
343+
> Copyright © __The Infected Drake__

0 commit comments

Comments
 (0)