Skip to content
GitLab

Command line user interface · Changes

Page history
Fixing markdown authored by Tasos Laskos's avatar Tasos Laskos
Hide whitespace changes
Inline Side-by-side
guides/user/Command-line-user-interface.md
View page @ 731ef8d7
......@@ -153,9 +153,9 @@ in your gems path._
<h3 id='version'><a href='#version'>Version (--version)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -164,9 +164,9 @@ Outputs the Arachni banner and version information.
<h3 id='verbosity'><a href='#verbosity'>Verbosity (-v)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -286,9 +286,9 @@ Arachni - Web Application Security Scanner Framework v0.4.2
<h3 id='debug'><a href='debug'>Debug mode (--debug)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -403,9 +403,9 @@ $ cat debug.log
<h3 id='only-positives'><a href='#only-positives'>Only positives (--only-positives)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -414,9 +414,9 @@ This will suppress all messages except for positive matches -- vulnerabilities.
<h3 id='http-req-limit'><a href='#http-req-limit'>HTTP request limit (--http-req-limit)</a></h3>
**Expects**: integer
**Expects**: `integer`
**Default**: 60
**Default**: `60`
**Multiple invocations**: no
......@@ -429,9 +429,9 @@ Limit how many concurrent HTTP request are sent.
<h3 id='http-timeout'><a href='#http-timeout'>HTTP timeout (--http-timeout)</a></h3>
**Expects**: integer (milliseconds)
**Expects**: `integer (milliseconds)`
**Default**: 50000
**Default**: `50000`
**Multiple invocations**: no
......@@ -440,9 +440,9 @@ Limit how long the HTTP client should wait for a response from the server.
<h3 id='https-only'><a href='#https-only'>HTTP timeout (--https-only)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -452,9 +452,9 @@ _(Target URL must be an HTTPS one as well.)_
<h3 id='cookie-jar'><a href='#cookie-jar'>Cookie jar (--cookie-jar)</a></h3>
**Expects**: cookiejar file
**Expects**: `cookiejar file`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -470,9 +470,9 @@ You should also take a look at the _--exclude-cookie_ option discussed later.
<h3 id='cookie-string'><a href='#cookie-string'>Cookie string (--cookie-string)</a></h3>
**Expects**: string
**Expects**: `string`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -487,9 +487,9 @@ Cookies, as a string, to be sent to the web application.
<h3 id='user-agent'><a href='#user-agent'>User agent (--user-agent)</a></h3>
**Expects**: string
**Expects**: `string`
**Default**: "Arachni/<version>"
**Default**: `"Arachni/<version>"`
**Multiple invocations**: no
......@@ -499,9 +499,9 @@ Default is _Arachni/&lt;version&gt;_.
<h3 id='custom-header'><a href='#custom-header'>Custom header (--custom-header)</a></h3>
**Expects**: string
**Expects**: `string`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -517,9 +517,9 @@ Allows you to specify custom headers in the form of key-value pairs.
<h3 id='authed-by'><a href='#authed-by'>Authorized by (--authed-by)</a></h3>
**Expects**: string
**Expects**: `string`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -536,9 +536,9 @@ The _--authed-by_ value should contain information about the person who authoriz
<h3 id='login-check-url'><a href='#login-check-url'>Login check URL (--login-check-url)</a></h3>
**Expects**: string
**Expects**: `string`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -552,9 +552,9 @@ this should indicate that the scanner is logged in.
<h3 id='login-check-pattern'><a href='#login-check-pattern'>Login check pattern (--login-check-pattern)</a></h3>
**Expects**: string
**Expects**: `string`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -569,9 +569,9 @@ A positive match should indicate that the scanner is logged in.
<h3 id='save-profile'><a href='#save-profile'>Save profile (--save-profile)</a></h3>
**Expects**: filename
**Expects**: `filename`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -587,9 +587,9 @@ This option allows you to save your current running configuration, all the optio
<h3 id='load-profile'><a href='#load-profile'>Load profile (--load-profile)</a></h3>
**Expects**: Arachni Framework Profile (.afp) file
**Expects**: `Arachni Framework Profile (.afp) file`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -605,9 +605,9 @@ The load profile option does not restrict your ability to specify more options o
<h3 id='show-profile'><a href='#show-profile'>Show profile (--show-profile)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -623,9 +623,9 @@ This option will output the running configuration as a string of command line ar
<h3 id='exclude'><a href='#exclude'>Exclude (--exclude/-e)</a></h3>
**Expects**: regexp
**Expects**: `regexp`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -722,9 +722,9 @@ Arachni - Web Application Security Scanner Framework v0.4.2
<h3 id='exclude-page'><a href='#exclude-page'>Exclude page by content (--exclude-page)</a></h3>
**Expects**: regexp
**Expects**: `regexp`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -734,9 +734,9 @@ and excludes pages whose content matching that expression from the crawl process
<h3 id='include'><a href='#include'>Include (--include/-i)</a></h3>
**Expects**: regexp
**Expects**: `regexp`
**Default**: '.*'
**Default**: `'.*'`
**Multiple invocations**: yes
......@@ -746,9 +746,9 @@ When a regular expression is passed to the _--include_ option, *only* URLs match
<h3 id='redundant'><a href='#redundant'>Redundant (--redundant)</a></h3>
**Expects**: regexp:integer
**Expects**: `regexp:integer`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -764,9 +764,9 @@ This option is useful when auditing a website that has a lot of redundant pages
<h3 id='auto-redundant'><a href='#auto-redundant'>Auto-redundant (--auto-redundant)</a></h3>
**Expects**: integer
**Expects**: `integer`
**Default**: disabled (with a value of 10 if none has been specified)
**Default**: `disabled (with a value of 10 if none has been specified)`
**Multiple invocations**: no
......@@ -801,9 +801,9 @@ http://test.com/path.php?stuff=blah&stuff2=1
<h3 id='follow-subdomains'><a href='#follow-subdomains'>Follow subdomains (-f/--follow-subdomains)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -812,9 +812,9 @@ This flag will cause Arachni to follow links to subdomains.
<h3 id='depth'><a href='#depth'>Depth limit (--depth)</a></h3>
**Expects**: integer
**Expects**: `integer`
**Default**: infinite
**Default**: `infinite`
**Multiple invocations**: no
......@@ -823,9 +823,9 @@ It specifies how deep into the site structure the crawler should go.
<h3 id='link-count'><a href='#link-count'>Link count limit (--link-count)</a></h3>
**Expects**: integer
**Expects**: `integer`
**Default**: infinite
**Default**: `infinite`
**Multiple invocations**: no
......@@ -834,9 +834,9 @@ It specifies how many links the crawler should follow.
<h3 id='redirect-limit'><a href='#redirect-limit'>Redirect limit (--redirect-limit)</a></h3>
**Expects**: integer
**Expects**: `integer`
**Default**: infinite
**Default**: `infinite`
**Multiple invocations**: no
......@@ -845,9 +845,9 @@ It specifies how many redirects the crawler should follow.
<h3 id='extend-paths'><a href='#extend-paths'>Extend paths (--extend-paths)</a></h3>
**Expects**: file
**Expects**: `file`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -857,9 +857,9 @@ The file must contains one path per line.
<h3 id='restrict-paths'><a href='#restrict-paths'>Restrict paths (--restrict-paths)</a></h3>
**Expects**: file
**Expects**: `file`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -871,9 +871,9 @@ Uses the paths contained in file instead of performing a crawl.
<h3 id='audit-links'><a href='#audit-links'>Audit links (--audit-links/-g)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -882,9 +882,9 @@ Tells Arachni to audit the link elements of the page and their variables.
<h3 id='audit-forms'><a href='#audit-forms'>Audit forms (--audit-forms/-p)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -893,9 +893,9 @@ Tells Arachni to audit the form elements of the page and their inputs.
<h3 id='audit-cookies'><a href='#audit-cookies'>Audit cookies (--audit-cookies/-c)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -904,9 +904,9 @@ Tells Arachni to audit the cookies of the page.
<h3 id='exclude-cookie'><a href='#exclude-cookie'>Exclude cookie (--exclude-cookie)</a></h3>
**Expects**: cookie name
**Expects**: `cookie name`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -920,9 +920,9 @@ This is very unlikely but it's better to err on the side of caution.
<h3 id='exclude-vector'><a href='#exclude-vector'>Exclude cookie (--exclude-vector)</a></h3>
**Expects**: input name
**Expects**: `input name`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -931,9 +931,9 @@ Tells Arachni to exclude -- not audit -- an input vector by name.
<h3 id='audit-headers'><a href='#audit-headers'>Audit headers (--audit-headers)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -947,9 +947,9 @@ Tells Arachni to audit the HTTP headers of the page.
<h3 id='audit-cookies-extensively'><a href='#audit-cookies-extensively'>Audit cookies extensively (--audit-cookies-extensively)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -960,9 +960,9 @@ If enabled Arachni will submit all links and forms of the page along with the co
<h3 id='fuzz-methods'><a href='#fuzz-methods'>Fuzz methods (--fuzz-methods)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -974,9 +974,9 @@ HTTP request methods.
<h3 id='exclude-binaries'><a href='#exclude-binaries'>Exclude binaries (--exclude-binaries)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -989,9 +989,9 @@ Disables inclusion of binary HTTP response bodies in the audit.
<h3 id='lsmod'><a href='#lsmod'>List modules (--lsmod)</a></h3>
**Expects**: regular expression
**Expects**: `regular expression`
**Default**: disabled OR .*
**Default**: `disabled OR .*`
**Multiple invocations**: yes
......@@ -1130,9 +1130,9 @@ Path: /home/zapotek/builds/arachni/gems/gems/arachni-0.4.1dev/modules/audit/xs
<h3 id='modules'><a href='#modules'>Modules (--modules/-m)</a></h3>
**Expects**: modname,modname,... OR '*'
**Expects**: `modname,modname,... OR '*'`
**Default**: '*' -- all modules
**Default**: `'*' -- all modules`
**Multiple invocations**: no
......@@ -1171,9 +1171,9 @@ The above will load all modules except for the 'backup_files' and 'xss' modules.
<h3 id='lsrep'><a href='#lsrep'>List reports (--lsrep)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -1341,9 +1341,9 @@ Path: /home/zapotek/builds/arachni/gems/gems/arachni-0.4.1dev/reports/stdout.r
<h3 id='repload'><a href='#repload'>Load a report (--repload)</a></h3>
**Expects**: Arachni Framework Report (.afr) file
**Expects**: `Arachni Framework Report (.afr) file`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -1496,9 +1496,9 @@ Arachni - Web Application Security Scanner Framework v0.4.2
<h3 id='report'><a href='#report'>Report (--report)</a></h3>
**Expects**: repname
**Expects**: `repname`
**Default**: stdout
**Default**: `stdout`
**Multiple invocations**: yes
......@@ -1609,9 +1609,9 @@ Arachni - Web Application Security Scanner Framework v0.4.2
<h3 id='lsplug'><a href='#lsplug'>List plugins (--lsplug)</a></h3>
**Expects**: <n/a>
**Expects**: `<n/a>`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -2108,9 +2108,9 @@ Path: /home/zapotek/workspace/arachni/plugins/form_dicattack.rb
<h3 id='plugin'><a href='#plugin'>Plugin (--plugin)</a></h3>
**Expects**: plugin name
**Expects**: `plugin name`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: yes
......@@ -2417,9 +2417,9 @@ Arachni - Web Application Security Scanner Framework v0.4.2
<h3 id='proxy_server'><a href='#proxy_server'>Proxy server (--proxy)</a></h3>
**Expects**: server:port
**Expects**: `server:port`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -2428,9 +2428,9 @@ Tells Arachni to send all requests via a proxy server.
<h3 id='proxy-auth'><a href='#proxy-auth'>Proxy authentication (--proxy-auth)</a></h3>
**Expects**: username:password
**Expects**: `username:password`
**Default**: disabled
**Default**: `disabled`
**Multiple invocations**: no
......@@ -2439,9 +2439,9 @@ Tells Arachni authenticate itself with the proxy server using the supplied usern
<h3 id='proxy-type'><a href='#proxy-type'>Proxy type (--proxy-type)</a></h3>
**Expects**: http, http_1_0, socks4, socks5, socks4a
**Expects**: `http, http_1_0, socks4, socks5, socks4a`
**Default**: disabled OR http
**Default**: `disabled OR http`
**Multiple invocations**: no
......@@ -2664,4 +2664,4 @@ Arachni - Web Application Security Scanner Framework v0.4.2
--proxy-type=<type> Proxy type; can be http, http_1_0, socks4, socks5, socks4a
(Default: http)
```
\ No newline at end of file
```