updated docs

2012-12-07 20:18:02 +01:00
parent b85ce58fb2
commit b3cf67c8f3
20 changed files with 1618 additions and 132 deletions
--- a/doc/WpscanOptions.html
+++ b/doc/WpscanOptions.html
@@ -270,7 +270,7 @@ href="WpscanOptions.html">WpscanOptions</a></p>

          
          <div class="method-source-code" id="load_from_arguments-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 158</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 159</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">load_from_arguments</span>
  <span class="ruby-identifier">wpscan_options</span> = <span class="ruby-constant">WpscanOptions</span>.<span class="ruby-identifier">new</span>

@@ -308,7 +308,7 @@ href="WpscanOptions.html">WpscanOptions</a></p>

          
          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 50</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 51</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>
  <span class="ruby-constant">ACCESSOR_OPTIONS</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">option</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{option}&quot;</span>, <span class="ruby-keyword">nil</span>)
@@ -349,7 +349,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="clean_option-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 254</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 256</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">clean_option</span>(<span class="ruby-identifier">option</span>)
  <span class="ruby-identifier">cleaned_option</span> = <span class="ruby-identifier">option</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r^--?/</span>, <span class="ruby-string">''</span>)
  <span class="ruby-identifier">cleaned_option</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r-/</span>, <span class="ruby-string">'_'</span>)
@@ -381,7 +381,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="get_opt_long-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 225</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 226</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">get_opt_long</span>
  <span class="ruby-constant">GetoptLong</span>.<span class="ruby-identifier">new</span>(
      [<span class="ruby-string">&quot;--url&quot;</span>, <span class="ruby-string">&quot;-u&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span>],
@@ -398,7 +398,8 @@ any remaining ‘-’ by ‘_’</p>
      [<span class="ruby-string">&quot;--follow-redirection&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">NO_ARGUMENT</span>],
      [<span class="ruby-string">&quot;--wp-content-dir&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span>],
      [<span class="ruby-string">&quot;--wp-plugins-dir&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span>],
-      [<span class="ruby-string">&quot;--config-file&quot;</span>, <span class="ruby-string">&quot;-c&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span>]
+      [<span class="ruby-string">&quot;--config-file&quot;</span>, <span class="ruby-string">&quot;-c&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span>],
+      [<span class="ruby-string">&quot;--exclude-content-based&quot;</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span>]
  )
 <span class="ruby-keyword">end</span></pre>
          </div><!-- get_opt_long-source -->
@@ -427,7 +428,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="is_long_option-3F-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 245</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 247</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_long_option?</span>(<span class="ruby-identifier">option</span>)
  <span class="ruby-constant">ACCESSOR_OPTIONS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:&quot;#{WpscanOptions.clean_option(option)}&quot;</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -457,7 +458,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="option_to_instance_variable_setter-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 259</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 261</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">option_to_instance_variable_setter</span>(<span class="ruby-identifier">option</span>)
  <span class="ruby-identifier">cleaned_option</span> = <span class="ruby-constant">WpscanOptions</span>.<span class="ruby-identifier">clean_option</span>(<span class="ruby-identifier">option</span>)
  <span class="ruby-identifier">option_syms</span> = <span class="ruby-constant">ACCESSOR_OPTIONS</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-node">%r{^#{cleaned_option}$}</span>)
@@ -496,7 +497,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="enumerate_all_plugins-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 106</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 107</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_all_plugins=</span>(<span class="ruby-identifier">enumerate_all_plugins</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">enumerate_all_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@enumerate_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@enumerate_only_vulnerable_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Please choose only one plugin enumeration option&quot;</span>
@@ -530,7 +531,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="enumerate_all_themes-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 130</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 131</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_all_themes=</span>(<span class="ruby-identifier">enumerate_all_themes</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">enumerate_all_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@enumerate_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@enumerate_only_vulnerable_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Please choose only one theme enumeration option&quot;</span>
@@ -564,7 +565,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="enumerate_only_vulnerable_plugins-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 98</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 99</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_only_vulnerable_plugins=</span>(<span class="ruby-identifier">enumerate_only_vulnerable_plugins</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">enumerate_only_vulnerable_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@enumerate_all_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@enumerate_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Please choose only one plugin enumeration option&quot;</span>
@@ -598,7 +599,7 @@ any remaining ‘-’ by ‘_’</p>

          
          <div class="method-source-code" id="enumerate_only_vulnerable_themes-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 122</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 123</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_only_vulnerable_themes=</span>(<span class="ruby-identifier">enumerate_only_vulnerable_themes</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">enumerate_only_vulnerable_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@enumerate_all_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@enumerate_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Please choose only one theme enumeration option&quot;</span>
@@ -636,7 +637,7 @@ href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>

          
          <div class="method-source-code" id="enumerate_options_from_string-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 193</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 194</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_options_from_string</span>(<span class="ruby-identifier">value</span>)
  <span class="ruby-comment"># Usage of self is mandatory because there are overridden setters</span>

@@ -692,7 +693,7 @@ href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>

          
          <div class="method-source-code" id="enumerate_plugins-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 90</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 91</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_plugins=</span>(<span class="ruby-identifier">enumerate_plugins</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">enumerate_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@enumerate_all_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@enumerate_only_vulnerable_plugins</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Please choose only one plugin enumeration option&quot;</span>
@@ -726,7 +727,7 @@ href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>

          
          <div class="method-source-code" id="enumerate_themes-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 114</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 115</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">enumerate_themes=</span>(<span class="ruby-identifier">enumerate_themes</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">enumerate_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@enumerate_all_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@enumerate_only_vulnerable_themes</span> <span class="ruby-operator">===</span> <span class="ruby-keyword">true</span>)
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Please choose only one theme enumeration option&quot;</span>
@@ -760,7 +761,7 @@ href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>

          
          <div class="method-source-code" id="has_options-3F-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 138</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 139</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">has_options?</span>
  <span class="ruby-operator">!</span><span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">empty?</span>
 <span class="ruby-keyword">end</span></pre>
@@ -790,7 +791,7 @@ href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>

          
          <div class="method-source-code" id="proxy-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 74</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 75</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">proxy=</span>(<span class="ruby-identifier">proxy</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">':'</span>) <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Invalid proxy format. Should be host:port.&quot;</span>
@@ -824,7 +825,7 @@ href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>

          
          <div class="method-source-code" id="proxy_auth-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 82</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 83</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">proxy_auth=</span>(<span class="ruby-identifier">auth</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">':'</span>) <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Invalid proxy auth format, username:password expected&quot;</span>
@@ -859,7 +860,7 @@ value</p>

          
          <div class="method-source-code" id="set_option_from_cli-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 172</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 173</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_option_from_cli</span>(<span class="ruby-identifier">cli_option</span>, <span class="ruby-identifier">cli_value</span>)

  <span class="ruby-keyword">if</span> <span class="ruby-constant">WpscanOptions</span>.<span class="ruby-identifier">is_long_option?</span>(<span class="ruby-identifier">cli_option</span>)
@@ -902,7 +903,7 @@ value</p>

          
          <div class="method-source-code" id="threads-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 62</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 63</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">threads=</span>(<span class="ruby-identifier">threads</span>)
  <span class="ruby-ivar">@threads</span> = <span class="ruby-identifier">threads</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">threads</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">threads</span>.<span class="ruby-identifier">to_i</span>
 <span class="ruby-keyword">end</span></pre>
@@ -932,7 +933,7 @@ value</p>

          
          <div class="method-source-code" id="to_h-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 143</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 144</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_h</span>
  <span class="ruby-identifier">options</span> = {}

@@ -971,7 +972,7 @@ value</p>

          
          <div class="method-source-code" id="url-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 56</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 57</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">url=</span>(<span class="ruby-identifier">url</span>)
  <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Empty URL given&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">url</span>

@@ -1003,7 +1004,7 @@ value</p>

          
          <div class="method-source-code" id="wordlist-3D-source">
-            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 66</span>
+            <pre><span class="ruby-comment"># File lib/wpscan/wpscan_options.rb, line 67</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">wordlist=</span>(<span class="ruby-identifier">wordlist</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">wordlist</span>)
    <span class="ruby-ivar">@wordlist</span> = <span class="ruby-identifier">wordlist</span>