diff --git a/README.md b/README.md index 2504835..db5ce7b 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,28 @@ # XSpear XSpear is XSS Scanner on ruby gems - + + +## TOC +- [XSpear](#xspear) + * [Key features](#key-features) + * [Installation](#installation) + + [Dependency gems](#dependency-gems) + * [Usage on cli](#usage-on-cli) + + [Result types](#result-types) + + [Verbose Mode](#verbose-mode) + + [Case by Case](#case-by-case) + + [Sample log](#sample-log) + * [Usage on ruby code](#usage-on-ruby-code) + * [Add Scanning Module](#add-scanning-module) + * [Update](#update) + * [Development](#development) + * [Contributing](#contributing) + * [Donate](#donate) + * [License](#license) + * [Code of Conduct](#code-of-conduct) + * [ScreenShot](#screenshot) + * [Video](#video) ## Key features - Pattern matching based XSS scanning @@ -53,7 +74,7 @@ And then execute: $ bundle ### Dependency gems -`colorize` `selenium-webdriver` `terminal-table`
+`colorize` `selenium-webdriver` `terminal-table` `progress_bar`
If you configured it to install automatically in the Gem library, but it behaves abnormally, install it with the following command. ``` @@ -394,7 +415,7 @@ $ xspear -u "http://testphp.vulnweb.com/listproducts.php?cat=123&zfdfasdf=124fff {"starttime":"2019-08-14 23:58:12 +0900","endtime":"2019-08-14 23:58:44 +0900","issue_count":24,"issue_list":[{"id":0,"type":"INFO","issue":"STATIC ANALYSIS","method":"GET","param":"-","payload":"","description":"Found Server: nginx/1.4.1"},{"id":1,"type":"INFO","issue":"STATIC ANALYSIS","method":"GET","param":"-","payload":"","description":"Not set HSTS"},{"id":2,"type":"INFO","issue":"STATIC ANALYSIS","method":"GET","param":"-","payload":"","description":"Content-Type: text/html"},{"id":3,"type":"LOW","issue":"STATIC ANALYSIS","method":"GET","param":"-","payload":"","description":"Not Set X-Frame-Options"},{"id":4,"type":"MIDUM","issue":"STATIC ANALYSIS","method":"GET","param":"-","payload":"","description":"Not Set CSP"},{"id":5,"type":"INFO","issue":"DYNAMIC ANALYSIS","method":"GET","param":"cat","payload":"XsPeaR\"","description":"Found SQL Error Pattern"},{"id":6,"type":"INFO","issue":"REFLECTED","method":"GET","param":"cat","payload":"rEfe6","description":"reflected parameter"},{"id":7,"type":"INFO","issue":"FILERD RULE","method":"GET","param":"cat","payload":"onhwul=64","description":"not filtered event handler on{any} pattern"},{"id":8,"type":"HIGH","issue":"XSS","method":"GET","param":"cat","payload":"","description":"reflected XSS Code"},{"id":9,"type":"HIGH","issue":"XSS","method":"GET","param":"cat","payload":"