[Update]#Fixes for QA. Update Docs

stanislav-web · Jun 6, 2017 · d4c2eb5 · d4c2eb5
1 parent 8e3f617
commit d4c2eb5
Show file tree

Hide file tree

Showing 3 changed files with 136 additions and 173 deletions.
diff --git a/docs/Installation-and-update.md b/docs/Installation-and-update.md
@@ -1,12 +1,11 @@
 ### Installation
 
-Python v3.2 is minor requirement.
+Python v3.3 is minor requirement.
 At the moment, the package can be installed from this repository [https://github.com/stanislav-web/OpenDoor](https://github.com/stanislav-web/OpenDoor)
 Now being tested, and the next will be published in other sources, such as Pypi.
 
 |  Python | Linux  |  OSX | Windows  |
 |:-:|:-:|:-:|:-:|
-|3.2|[![Build Status](https://travis-ci.org/stanislav-web/OpenDoor.svg?branch=master)](https://travis-ci.org/stanislav-web/OpenDoor)    | ?  | [![Build status](https://ci.appveyor.com/api/projects/status/3hmrb64ofdssi4qd?svg=true)](https://ci.appveyor.com/project/stanislav-web/opendoor)|
 |3.3|[![Build Status](https://travis-ci.org/stanislav-web/OpenDoor.svg?branch=master)](https://travis-ci.org/stanislav-web/OpenDoor)    | ?  | [![Build status](https://ci.appveyor.com/api/projects/status/3hmrb64ofdssi4qd?svg=true)](https://ci.appveyor.com/project/stanislav-web/opendoor)|
 |3.4|[![Build Status](https://travis-ci.org/stanislav-web/OpenDoor.svg?branch=master)](https://travis-ci.org/stanislav-web/OpenDoor)    | ?  | [![Build status](https://ci.appveyor.com/api/projects/status/3hmrb64ofdssi4qd?svg=true)](https://ci.appveyor.com/project/stanislav-web/opendoor)|
 |3.5|[![Build Status](https://travis-ci.org/stanislav-web/OpenDoor.svg?branch=master)](https://travis-ci.org/stanislav-web/OpenDoor)    | ?  | [![Build status](https://ci.appveyor.com/api/projects/status/3hmrb64ofdssi4qd?svg=true)](https://ci.appveyor.com/project/stanislav-web/opendoor)|

diff --git a/docs/Usage.md b/docs/Usage.md
@@ -1,6 +1,6 @@
 #### Basic usage
 ```
- python3 opendoor.py --host http://www.example.com
+python3 opendoor.py --host http://www.example.com
 ```
 #### Help
 ```
@@ -66,190 +66,198 @@ Wordlist tools:
 ```
 #### Arguments description usage
 
- - **Application tools**
+##### Application tools
+------
 
-    **--update** - update sources from CVS to latest
+**--update** - update sources from CVS to latest
 
-    ```
-    opendoor --update
-    ```
+```python
+opendoor --update
+```
 
-    **--version** - see current package version and compare with server's latest
+**--version** - see current package version and compare with server's latest
 
-    ```
-    opendoor --version
-    ```
+```python
+opendoor --version
+```
 
-    **--examples** - get some examples of usage
+**--examples** - get some examples of usage
 
-    ```
-    opendoor --examples
-    ```
+```python
+opendoor --examples
+```
 
-    **--docs** - open this documentation
+**--docs** - open this documentation
 
-    ```
-    opendoor --docs
-    ```
+```python
+opendoor --docs
+```
 
- - **Required arguments**
+##### Required arguments
+------
 
-    **--host** - target host (ip). Also might be required protocol. See examples
+**--host** - target host (ip). Also might be required protocol. See examples
 
-    ```
-    opendoor --host www.example.com
-    opendoor --host https://www.example.com
-    opendoor --host 127.0.0.1
-    ```
+```python
+opendoor --host www.example.com
+opendoor --host https://www.example.com
+opendoor --host 127.0.0.1
+```
 
- - **Request tools**
+##### Request tools
+------
 
-    **--port -p** - custom port. Default 80 for HTTP and 443 for HTTPS
+**--port -p** - custom port. Default 80 for HTTP and 443 for HTTPS
 
-    ```
-    opendoor --host www.example.com # use default 80 port
-    opendoor --host https://www.example.com # use default 443 port
-    opendoor --host https://www.example.com --port 444 # use custom port
-    opendoor --host http://www.example.com --p 8080 # use custom port
-    ```
+```python
+opendoor --host www.example.com # use default 80 port
+opendoor --host https://www.example.com # use default 443 port
+opendoor --host https://www.example.com --port 444 # use custom port
+opendoor --host http://www.example.com --p 8080 # use custom port
+```
 
-    **--method -m** - scan request method. Use HEAD as default for more faster requests but also you can apply any of the possible methods
+**--method -m** - scan request method. Use HEAD as default for more faster requests but also you can apply any of the possible methods
 
-    ```
-    opendoor --host https://www.example.com # use default HEAD request method
-    opendoor --host https://www.example.com -m GET
-    opendoor --host https://www.example.com --method TRACE
-    ```
+```python
+opendoor --host https://www.example.com # use default HEAD request method
+opendoor --host https://www.example.com -m GET
+opendoor --host https://www.example.com --method TRACE
+```
 
-    **--delay -d** - delay between requests threading. Use to bypass the restrictions of requests per second for the target server
+**--delay -d** - delay between requests threading. Use to bypass the restrictions of requests per second for the target server
 
-    ```
-    opendoor --host https://www.example.com --delay 3 # 3 sec between requests
-    opendoor --host https://www.example.com -d 0.3 # 300 ms between requests
-    ```
+```python
+opendoor --host https://www.example.com --delay 3 # 3 sec between requests
+opendoor --host https://www.example.com -d 0.3 # 300 ms between requests
+```
 
-    **--timeout** - request timeout (30 sec default). Maximum sec time for a response
+**--timeout** - request timeout (30 sec default). Maximum sec time for a response
 
-    ```
-    opendoor --host https://www.example.com --timeout 10
-    ```
+```python
+opendoor --host https://www.example.com --timeout 10
+```
 
-    **--retries -r** - max retries to reconnect (default 3)
+**--retries -r** - max retries to reconnect (default 3)
 
-    ```
-    opendoor --host https://www.example.com --retries 10
-    opendoor --host https://www.example.com --r 1
-    ```
+```python
+opendoor --host https://www.example.com --retries 10
+opendoor --host https://www.example.com --r 1
+```
 
-    **--accept-cookies** - accept and route cookies from responses. To be as natural as possible and bring the scanner closer to the user's browser use cookies receipt. After the first request, your session will accept and  send cookies inside current pool requests
+**--accept-cookies** - accept and route cookies from responses. To be as natural as possible and bring the scanner closer to the user's browser use cookies receipt. After the first request, your session will accept and  send cookies inside current pool requests
 
-    ```
-    opendoor --host https://www.example.com --accept-cookies
+```python
+opendoor --host https://www.example.com --accept-cookies
 
-    ```
-    **--tor** - using built-in proxy list. You can use proxy lists built into the package to ensure your scanning anonymity
+```
+**--tor** - using built-in proxy list. You can use proxy lists built into the package to ensure your scanning anonymity
 
-    ```
-    opendoor --host https://www.example.com --tor
+```python
+opendoor --host https://www.example.com --tor
 
-    ```
-    **--torlist** - path to custom proxylist. Choise your own checked proxy list. The list must have format: ***scheme:ip:port***
+```
+**--torlist** - path to custom proxylist. Choise your own checked proxy list. The list must have format: ***scheme:ip:port***
 
-    ```
-    opendoor --host https://www.example.com --torlist /home/user/scan/proxy.txt
-    ```
+```python
+opendoor --host https://www.example.com --torlist /home/user/scan/proxy.txt
+```
 
-    **---proxy** - custom permanent proxy server. Use your own froxy for all requests: ***scheme:ip:port***
+**---proxy** - custom permanent proxy server. Use your own froxy for all requests: ***scheme:ip:port***
 
-    ```
-    opendoor --host https://www.example.com --proxy socks5://127.0.0.1:8888
-    ```
+```python
+opendoor --host https://www.example.com --proxy socks5://127.0.0.1:8888
+```
 
-    **--random-agent** - randomize your user-agent per request. With each new request, your browser will change. This is both good and bad, because, frequent requests from several browsers can reveal the suspicion of the attack, and at the same time fall in confuse the DevOps, if you would use different proxy servers
+**--random-agent** - randomize your user-agent per request. With each new request, your browser will change. This is both good and bad, because, frequent requests from several browsers can reveal the suspicion of the attack, and at the same time fall in confuse the DevOps, if you would use different proxy servers
 
-    ```
-    opendoor --host https://www.example.com --random-agent
-    ```
+```python
+opendoor --host https://www.example.com --random-agent
+```
 
- - **Debug tools**
+##### Debug tools
+------
 
-    **--debug** - debug levels (1-3). Provides the ability to view detailed scanning progress
+**--debug** - debug levels (1-3). Provides the ability to view detailed scanning progress
      - 1 step by step scan proccess
      - 2 + request data view
      - 3 + response data view
 
-    ```
-    opendoor --host www.example.com --debug 1
-    ```
+```python
+opendoor --host www.example.com --debug 1
+```
 
- - **Sniff tools**
+##### Sniff tools
+------
 
-    **--indexof -i** - detect Apache Index of/. Use method GET as default. Large files and auth required pages will be detected automatically for every scan
+**--indexof -i** - detect Apache Index of/. Use method GET as default. Large files and auth required pages will be detected automatically for every scan
 
-    ```
-    opendoor --host www.example.com --indexof
-    opendoor --host www.example.com --i
-    ```
+```python
+opendoor --host www.example.com --indexof
+opendoor --host www.example.com --i
+```
 
- - **Stream tools**
+##### Stream tools
+------
 
-    **--threads -t** - allowed threads. In order not to harm your computer there is a limit of 25 threads
+**--threads -t** - allowed threads. In order not to harm your computer there is a limit of 25 threads
 
-    ```
-    opendoor --host www.example.com --threads 10
-    opendoor --host www.example.com --t 15
-    ```
+```python
+opendoor --host www.example.com --threads 10
+opendoor --host www.example.com --t 15
+```
 
- - **Wordlist tools**
+##### Wordlist tools
+------
 
-    **--scan -s** - the application allows you to scan in two directions. Not only for directories but also allows you to find subdomains
+**--scan -s** - the application allows you to scan in two directions. Not only for directories but also allows you to find subdomains
 
-    ```
-    opendoor --host example.com -scan directories # use as default
-    opendoor --host example.com -s subdomains
-    ```
+```python
+opendoor --host example.com -scan directories # use as default
+opendoor --host example.com -s subdomains
+```
 
-    **--wordlist -w** - if you don't  satisfied with the built-in list of directories or subdomains, you can assign your own
+**--wordlist -w** - if you don't  satisfied with the built-in list of directories or subdomains, you can assign your own
 
-    ```
-    opendoor --host example.com --wordlist /home/user/scan/mydirlist.dat
-    opendoor --host example.com --w /home/user/scan/mydirlist.dat
-    opendoor --host example.com --scan subdomains --wordlist /home/user/scan/mysubdomainslist.txt
-    ```
+```python
+opendoor --host example.com --wordlist /home/user/scan/mydirlist.dat
+opendoor --host example.com --w /home/user/scan/mydirlist.dat
+opendoor --host example.com --scan subdomains --wordlist /home/user/scan/mysubdomainslist.txt
+```
 
-    **--random-list** - shuffle scan list. This technique will allow you to use a mixed list of built-in or external dictionaries instead of the AB list order
+**--random-list** - shuffle scan list. This technique will allow you to use a mixed list of built-in or external dictionaries instead of the AB list order
 
-    ```
-    opendoor --host example.com --random-list
-    opendoor --host example.com --wordlist /home/user/scan/mydirlist.dat --random-list
+```python
+opendoor --host example.com --random-list
+opendoor --host example.com --wordlist /home/user/scan/mydirlist.dat --random-list
 
-    ```
+```
 
-    **--prefix** - append path prefix to scan host. Works for directories scan type
+**--prefix** - append path prefix to scan host. Works for directories scan type
 
-    ```
-    opendoor --host example.com --prefix en/
-    opendoor --host example.com --scan directories --prefix en/
-    ```
+```python
+opendoor --host example.com --prefix en/
+opendoor --host example.com --scan directories --prefix en/
+```
 
-    **--extensions -e** - extensions filter -e php,json e.g. If you know something more about the target host, you can apply a filter to the dictionary with extensions
+**--extensions -e** - extensions filter -e php,json e.g. If you know something more about the target host, you can apply a filter to the dictionary with extensions
 
-    ```
-    opendoor --host example.com --extensions php,html
-    opendoor --host example.com --e htm,py
-    ```
+```python
+opendoor --host example.com --extensions php,html
+opendoor --host example.com --e htm,py
+```
 
- - **Reports tools**
+##### Reports tools
+------
 
-    **--reports** - scan reporting format. At the moment there has several providers for reports. Also you can help develop by expanding this functionality
+**--reports** - scan reporting format. At the moment there has several providers for reports. Also you can help develop by expanding this functionality
 
-    ```
-    opendoor --host www.example.com # use default "std" report
-    opendoor --host www.example.com --reports json,html,txt
-    ```
+```python
+opendoor --host www.example.com # use default "std" report
+opendoor --host www.example.com --reports json,html,txt
+```
 
-    **--reports-dir** - path to custom reports dir. By default, scan reports are located in the "reports/" directory within the package. But you can set the path as you wish
+**--reports-dir** - path to custom reports dir. By default, scan reports are located in the "reports/" directory within the package. But you can set the path as you wish
 
-    ```
-    opendoor --host www.example.com --reports json,html,txt --reports-dir /home/usr/User/scans/reports
-    ```
+```python
+opendoor --host www.example.com --reports json,html,txt --reports-dir /home/usr/User/scans/reports
+```
diff --git a/tests/test_lib_arguments.py b/tests/test_lib_arguments.py