garfield/wpscan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
cd5b45f98bd2c0cd16143aee25436a706a75bdc3
wpscan/doc_yard/WpscanOptions.html
Christian Mehlmauer cd5b45f98b docs
2013-06-09 16:07:04 +02:00

1785 lines
68 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: WpscanOptions
&mdash; Documentation by YARD 0.8.6.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (W)</a> &raquo;
<span class="title">WpscanOptions</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: WpscanOptions
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">WpscanOptions</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/wpscan/wpscan_options.rb</dd>
</dl>
<div class="clear"></div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="ACCESSOR_OPTIONS-constant" class="">ACCESSOR_OPTIONS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='symbol'>:enumerate_plugins</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_only_vulnerable_plugins</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_all_plugins</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_themes</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_only_vulnerable_themes</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_all_themes</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_timthumbs</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_usernames</span><span class='comma'>,</span>
<span class='symbol'>:enumerate_usernames_range</span><span class='comma'>,</span>
<span class='symbol'>:proxy</span><span class='comma'>,</span>
<span class='symbol'>:proxy_auth</span><span class='comma'>,</span>
<span class='symbol'>:threads</span><span class='comma'>,</span>
<span class='symbol'>:url</span><span class='comma'>,</span>
<span class='symbol'>:wordlist</span><span class='comma'>,</span>
<span class='symbol'>:force</span><span class='comma'>,</span>
<span class='symbol'>:update</span><span class='comma'>,</span>
<span class='symbol'>:verbose</span><span class='comma'>,</span>
<span class='symbol'>:username</span><span class='comma'>,</span>
<span class='symbol'>:password</span><span class='comma'>,</span>
<span class='symbol'>:follow_redirection</span><span class='comma'>,</span>
<span class='symbol'>:wp_content_dir</span><span class='comma'>,</span>
<span class='symbol'>:wp_plugins_dir</span><span class='comma'>,</span>
<span class='symbol'>:help</span><span class='comma'>,</span>
<span class='symbol'>:config_file</span><span class='comma'>,</span>
<span class='symbol'>:exclude_content_based</span><span class='comma'>,</span>
<span class='symbol'>:basic_auth</span><span class='comma'>,</span>
<span class='symbol'>:debug_output</span>
<span class='rbracket'>]</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="protected ">
<span class="summary_signature">
<a href="#clean_option-class_method" title="clean_option (class method)">+ (Object) <strong>clean_option</strong>(option) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'>
<p>Will removed the '-' or '--' chars at the beginning of option and replace
any remaining '-' by '_'.</p>
</div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#get_opt_long-class_method" title="get_opt_long (class method)">+ (Object) <strong>get_opt_long</strong> </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'>
<p>Even if a short option is given (IE : -u), the long one will be returned
(IE : --url).</p>
</div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#is_long_option%3F-class_method" title="is_long_option? (class method)">+ (Boolean) <strong>is_long_option?</strong>(option) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_from_arguments-class_method" title="load_from_arguments (class method)">+ (Object) <strong>load_from_arguments</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Will load the options from ARGV return WpscanOptions.</p>
</div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#option_to_instance_variable_setter-class_method" title="option_to_instance_variable_setter (class method)">+ (Object) <strong>option_to_instance_variable_setter</strong>(option) </a>
</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#basic_auth%3D-instance_method" title="#basic_auth= (instance method)">- (Object) <strong>basic_auth=</strong>(basic_auth) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#debug_output%3D-instance_method" title="#debug_output= (instance method)">- (Object) <strong>debug_output=</strong>(debug_output) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_all_plugins%3D-instance_method" title="#enumerate_all_plugins= (instance method)">- (Object) <strong>enumerate_all_plugins=</strong>(enumerate_all_plugins) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_all_themes%3D-instance_method" title="#enumerate_all_themes= (instance method)">- (Object) <strong>enumerate_all_themes=</strong>(enumerate_all_themes) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_only_vulnerable_plugins%3D-instance_method" title="#enumerate_only_vulnerable_plugins= (instance method)">- (Object) <strong>enumerate_only_vulnerable_plugins=</strong>(enumerate_only_vulnerable_plugins) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_only_vulnerable_themes%3D-instance_method" title="#enumerate_only_vulnerable_themes= (instance method)">- (Object) <strong>enumerate_only_vulnerable_themes=</strong>(enumerate_only_vulnerable_themes) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_options_from_string-instance_method" title="#enumerate_options_from_string (instance method)">- (Object) <strong>enumerate_options_from_string</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Will set enumerate_* from the string value IE : if value = vp =&gt;
:enumerate_only_vulnerable_plugins will be set to true multiple enumeration
are possible : 'u,p' =&gt; :enumerate_usernames and :enumerate_plugins
Special case for usernames, a range is possible : <a
href="http://1-10">u</a> will enumerate usernames from 1 to 10.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_plugins%3D-instance_method" title="#enumerate_plugins= (instance method)">- (Object) <strong>enumerate_plugins=</strong>(enumerate_plugins) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enumerate_themes%3D-instance_method" title="#enumerate_themes= (instance method)">- (Object) <strong>enumerate_themes=</strong>(enumerate_themes) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#has_options%3F-instance_method" title="#has_options? (instance method)">- (Boolean) <strong>has_options?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (WpscanOptions) <strong>initialize</strong> </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of WpscanOptions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#proxy%3D-instance_method" title="#proxy= (instance method)">- (Object) <strong>proxy=</strong>(proxy) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#proxy_auth%3D-instance_method" title="#proxy_auth= (instance method)">- (Object) <strong>proxy_auth=</strong>(auth) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set_option_from_cli-instance_method" title="#set_option_from_cli (instance method)">- (Object) <strong>set_option_from_cli</strong>(cli_option, cli_value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>string cli_option : --url, -u, --proxy etc string cli_value : the option
value.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#threads%3D-instance_method" title="#threads= (instance method)">- (Object) <strong>threads=</strong>(threads) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_h-instance_method" title="#to_h (instance method)">- (Object) <strong>to_h</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>return Hash.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#url%3D-instance_method" title="#url= (instance method)">- (Object) <strong>url=</strong>(url) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wordlist%3D-instance_method" title="#wordlist= (instance method)">- (Object) <strong>wordlist=</strong>(wordlist) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="WpscanOptions (class)">WpscanOptions</a></span></tt>) <strong>initialize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>A new instance of WpscanOptions</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='const'>ACCESSOR_OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_option'>option</span><span class='op'>|</span>
<span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_option'>option</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="clean_option-class_method">
+ (<tt>Object</tt>) <strong>clean_option</strong>(option) <span class="extras">(protected)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Will removed the '-' or '--' chars at the beginning of option and replace
any remaining '-' by '_'</p>
<p>param string option return string</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
253
254
255
256</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 253</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_clean_option'>clean_option</span><span class='lparen'>(</span><span class='id identifier rubyid_option'>option</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cleaned_option'>cleaned_option</span> <span class='op'>=</span> <span class='id identifier rubyid_option'>option</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^--?</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_cleaned_option'>cleaned_option</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>-</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_opt_long-class_method">
+ (<tt>Object</tt>) <strong>get_opt_long</strong> <span class="extras">(protected)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Even if a short option is given (IE : -u), the long one will be returned
(IE : --url)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 221</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_opt_long'>get_opt_long</span>
<span class='const'>GetoptLong</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--url</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-u</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--enumerate</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-e</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>OPTIONAL_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--username</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-U</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--wordlist</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-w</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--threads</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-t</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--force</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-f</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>NO_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--help</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-h</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>NO_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--verbose</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-v</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>NO_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--proxy</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--proxy-auth</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--update</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>NO_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--follow-redirection</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>NO_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--wp-content-dir</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--wp-plugins-dir</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--config-file</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-c</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--exclude-content-based</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--basic-auth</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>REQUIRED_ARGUMENT</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--debug-output</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>GetoptLong</span><span class='op'>::</span><span class='const'>NO_ARGUMENT</span><span class='rbracket'>]</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="is_long_option?-class_method">
+ (<tt>Boolean</tt>) <strong>is_long_option?</strong>(option) <span class="extras">(protected)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
244
245
246</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 244</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_long_option?'>is_long_option?</span><span class='lparen'>(</span><span class='id identifier rubyid_option'>option</span><span class='rparen'>)</span>
<span class='const'>ACCESSOR_OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:#{</span><span class='const'>WpscanOptions</span><span class='period'>.</span><span class='id identifier rubyid_clean_option'>clean_option</span><span class='lparen'>(</span><span class='id identifier rubyid_option'>option</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_from_arguments-class_method">
+ (<tt>Object</tt>) <strong>load_from_arguments</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Will load the options from ARGV return WpscanOptions</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156
157
158
159
160
161
162
163
164</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 154</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_from_arguments'>load_from_arguments</span>
<span class='id identifier rubyid_wpscan_options'>wpscan_options</span> <span class='op'>=</span> <span class='const'>WpscanOptions</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>if</span> <span class='const'>ARGV</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>0</span>
<span class='const'>WpscanOptions</span><span class='period'>.</span><span class='id identifier rubyid_get_opt_long'>get_opt_long</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_arg'>arg</span><span class='op'>|</span>
<span class='id identifier rubyid_wpscan_options'>wpscan_options</span><span class='period'>.</span><span class='id identifier rubyid_set_option_from_cli'>set_option_from_cli</span><span class='lparen'>(</span><span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_wpscan_options'>wpscan_options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="option_to_instance_variable_setter-class_method">
+ (<tt>Object</tt>) <strong>option_to_instance_variable_setter</strong>(option) <span class="extras">(protected)</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
258
259
260
261
262
263</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 258</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_option_to_instance_variable_setter'>option_to_instance_variable_setter</span><span class='lparen'>(</span><span class='id identifier rubyid_option'>option</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cleaned_option'>cleaned_option</span> <span class='op'>=</span> <span class='const'>WpscanOptions</span><span class='period'>.</span><span class='id identifier rubyid_clean_option'>clean_option</span><span class='lparen'>(</span><span class='id identifier rubyid_option'>option</span><span class='rparen'>)</span>
<span class='id identifier rubyid_option_syms'>option_syms</span> <span class='op'>=</span> <span class='const'>ACCESSOR_OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_grep'>grep</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cleaned_option'>cleaned_option</span><span class='rbrace'>}</span><span class='tstring_content'>$</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_option_syms'>option_syms</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>?</span> <span class='symbol'>:#{</span><span class='id identifier rubyid_option_syms'>option_syms</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="basic_auth=-instance_method">
- (<tt>Object</tt>) <strong>basic_auth=</strong>(basic_auth)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
125
126
127
128</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 125</span>
<span class='kw'>def</span> <span class='id identifier rubyid_basic_auth='>basic_auth=</span><span class='lparen'>(</span><span class='id identifier rubyid_basic_auth'>basic_auth</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Invalid basic authentication format, login:password expected</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_basic_auth'>basic_auth</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='ivar'>@basic_auth</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Basic </span><span class='embexpr_beg'>#{</span><span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_encode64'>encode64</span><span class='lparen'>(</span><span class='id identifier rubyid_basic_auth'>basic_auth</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="debug_output=-instance_method">
- (<tt>Object</tt>) <strong>debug_output=</strong>(debug_output)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
130
131
132</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 130</span>
<span class='kw'>def</span> <span class='id identifier rubyid_debug_output='>debug_output=</span><span class='lparen'>(</span><span class='id identifier rubyid_debug_output'>debug_output</span><span class='rparen'>)</span>
<span class='const'>Typhoeus</span><span class='op'>::</span><span class='const'>Config</span><span class='period'>.</span><span class='id identifier rubyid_verbose'>verbose</span> <span class='op'>=</span> <span class='id identifier rubyid_debug_output'>debug_output</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_all_plugins=-instance_method">
- (<tt>Object</tt>) <strong>enumerate_all_plugins=</strong>(enumerate_all_plugins)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95
96
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_all_plugins='>enumerate_all_plugins=</span><span class='lparen'>(</span><span class='id identifier rubyid_enumerate_all_plugins'>enumerate_all_plugins</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_enumerate_all_plugins'>enumerate_all_plugins</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='ivar'>@enumerate_plugins</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='ivar'>@enumerate_only_vulnerable_plugins</span> <span class='op'>===</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please choose only one plugin enumeration option</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@enumerate_all_plugins</span> <span class='op'>=</span> <span class='id identifier rubyid_enumerate_all_plugins'>enumerate_all_plugins</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_all_themes=-instance_method">
- (<tt>Object</tt>) <strong>enumerate_all_themes=</strong>(enumerate_all_themes)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119
120
121
122
123</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 117</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_all_themes='>enumerate_all_themes=</span><span class='lparen'>(</span><span class='id identifier rubyid_enumerate_all_themes'>enumerate_all_themes</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_enumerate_all_themes'>enumerate_all_themes</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='ivar'>@enumerate_themes</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='ivar'>@enumerate_only_vulnerable_themes</span> <span class='op'>===</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please choose only one theme enumeration option</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@enumerate_all_themes</span> <span class='op'>=</span> <span class='id identifier rubyid_enumerate_all_themes'>enumerate_all_themes</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_only_vulnerable_plugins=-instance_method">
- (<tt>Object</tt>) <strong>enumerate_only_vulnerable_plugins=</strong>(enumerate_only_vulnerable_plugins)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
85
86
87
88
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 85</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_only_vulnerable_plugins='>enumerate_only_vulnerable_plugins=</span><span class='lparen'>(</span><span class='id identifier rubyid_enumerate_only_vulnerable_plugins'>enumerate_only_vulnerable_plugins</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_enumerate_only_vulnerable_plugins'>enumerate_only_vulnerable_plugins</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='ivar'>@enumerate_all_plugins</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='ivar'>@enumerate_plugins</span> <span class='op'>===</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please choose only one plugin enumeration option</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@enumerate_only_vulnerable_plugins</span> <span class='op'>=</span> <span class='id identifier rubyid_enumerate_only_vulnerable_plugins'>enumerate_only_vulnerable_plugins</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_only_vulnerable_themes=-instance_method">
- (<tt>Object</tt>) <strong>enumerate_only_vulnerable_themes=</strong>(enumerate_only_vulnerable_themes)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
109
110
111
112
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_only_vulnerable_themes='>enumerate_only_vulnerable_themes=</span><span class='lparen'>(</span><span class='id identifier rubyid_enumerate_only_vulnerable_themes'>enumerate_only_vulnerable_themes</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_enumerate_only_vulnerable_themes'>enumerate_only_vulnerable_themes</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='ivar'>@enumerate_all_themes</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='ivar'>@enumerate_themes</span> <span class='op'>===</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please choose only one theme enumeration option</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@enumerate_only_vulnerable_themes</span> <span class='op'>=</span> <span class='id identifier rubyid_enumerate_only_vulnerable_themes'>enumerate_only_vulnerable_themes</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_options_from_string-instance_method">
- (<tt>Object</tt>) <strong>enumerate_options_from_string</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Will set enumerate_* from the string value IE : if value = vp =&gt;
:enumerate_only_vulnerable_plugins will be set to true multiple enumeration
are possible : 'u,p' =&gt; :enumerate_usernames and :enumerate_plugins
Special case for usernames, a range is possible : <a
href="http://1-10">u</a> will enumerate usernames from 1 to 10</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 189</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_options_from_string'>enumerate_options_from_string</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='comment'># Usage of self is mandatory because there are overridden setters
</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='rbrace'>}</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enumerate_only_vulnerable_plugins'>enumerate_only_vulnerable_plugins</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vp</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enumerate_plugins'>enumerate_plugins</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>p</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enumerate_all_plugins'>enumerate_all_plugins</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ap</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='ivar'>@enumerate_timthumbs</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tt</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enumerate_only_vulnerable_themes'>enumerate_only_vulnerable_themes</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vt</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enumerate_themes'>enumerate_themes</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>t</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enumerate_all_themes'>enumerate_all_themes</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>at</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_grep'>grep</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^u</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_username_enum_value'>username_enum_value</span><span class='op'>|</span>
<span class='ivar'>@enumerate_usernames</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='comment'># Check for usernames range
</span> <span class='id identifier rubyid_matches'>matches</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>\[([\d]+)-([\d]+)\]</span><span class='regexp_end'>}</span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_username_enum_value'>username_enum_value</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_matches'>matches</span>
<span class='ivar'>@enumerate_usernames_range</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_matches'>matches</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='op'>..</span><span class='id identifier rubyid_matches'>matches</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_plugins=-instance_method">
- (<tt>Object</tt>) <strong>enumerate_plugins=</strong>(enumerate_plugins)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79
80
81
82
83</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_plugins='>enumerate_plugins=</span><span class='lparen'>(</span><span class='id identifier rubyid_enumerate_plugins'>enumerate_plugins</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_enumerate_plugins'>enumerate_plugins</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='ivar'>@enumerate_all_plugins</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='ivar'>@enumerate_only_vulnerable_plugins</span> <span class='op'>===</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please choose only one plugin enumeration option</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@enumerate_plugins</span> <span class='op'>=</span> <span class='id identifier rubyid_enumerate_plugins'>enumerate_plugins</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enumerate_themes=-instance_method">
- (<tt>Object</tt>) <strong>enumerate_themes=</strong>(enumerate_themes)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103
104
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enumerate_themes='>enumerate_themes=</span><span class='lparen'>(</span><span class='id identifier rubyid_enumerate_themes'>enumerate_themes</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_enumerate_themes'>enumerate_themes</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='ivar'>@enumerate_all_themes</span> <span class='op'>===</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='ivar'>@enumerate_only_vulnerable_themes</span> <span class='op'>===</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please choose only one theme enumeration option</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@enumerate_themes</span> <span class='op'>=</span> <span class='id identifier rubyid_enumerate_themes'>enumerate_themes</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="has_options?-instance_method">
- (<tt>Boolean</tt>) <strong>has_options?</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
134
135
136</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 134</span>
<span class='kw'>def</span> <span class='id identifier rubyid_has_options?'>has_options?</span>
<span class='op'>!</span><span class='id identifier rubyid_to_h'>to_h</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="proxy=-instance_method">
- (<tt>Object</tt>) <strong>proxy=</strong>(proxy)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63
64
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_proxy='>proxy=</span><span class='lparen'>(</span><span class='id identifier rubyid_proxy'>proxy</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_proxy'>proxy</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Invalid proxy format. Should be host:port.</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@proxy</span> <span class='op'>=</span> <span class='id identifier rubyid_proxy'>proxy</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="proxy_auth=-instance_method">
- (<tt>Object</tt>) <strong>proxy_auth=</strong>(auth)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71
72
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_proxy_auth='>proxy_auth=</span><span class='lparen'>(</span><span class='id identifier rubyid_auth'>auth</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Invalid proxy auth format, username:password expected</span><span class='tstring_end'>'</span></span>
<span class='kw'>else</span>
<span class='ivar'>@proxy_auth</span> <span class='op'>=</span> <span class='id identifier rubyid_auth'>auth</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set_option_from_cli-instance_method">
- (<tt>Object</tt>) <strong>set_option_from_cli</strong>(cli_option, cli_value)
</h3><div class="docstring">
<div class="discussion">
<p>string cli_option : --url, -u, --proxy etc string cli_value : the option
value</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 168</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_option_from_cli'>set_option_from_cli</span><span class='lparen'>(</span><span class='id identifier rubyid_cli_option'>cli_option</span><span class='comma'>,</span> <span class='id identifier rubyid_cli_value'>cli_value</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'>WpscanOptions</span><span class='period'>.</span><span class='id identifier rubyid_is_long_option?'>is_long_option?</span><span class='lparen'>(</span><span class='id identifier rubyid_cli_option'>cli_option</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span>
<span class='const'>WpscanOptions</span><span class='period'>.</span><span class='id identifier rubyid_option_to_instance_variable_setter'>option_to_instance_variable_setter</span><span class='lparen'>(</span><span class='id identifier rubyid_cli_option'>cli_option</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='id identifier rubyid_cli_value'>cli_value</span>
<span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_cli_option'>cli_option</span> <span class='op'>===</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>--enumerate</span><span class='tstring_end'>'</span></span> <span class='comment'># Special cases
</span> <span class='comment'># Default value if no argument is given
</span> <span class='id identifier rubyid_cli_value'>cli_value</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vt,tt,u,vp</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_cli_value'>cli_value</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='id identifier rubyid_enumerate_options_from_string'>enumerate_options_from_string</span><span class='lparen'>(</span><span class='id identifier rubyid_cli_value'>cli_value</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknow option : </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cli_option'>cli_option</span><span class='rbrace'>}</span><span class='tstring_content'> with value </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cli_value'>cli_value</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="threads=-instance_method">
- (<tt>Object</tt>) <strong>threads=</strong>(threads)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_threads='>threads=</span><span class='lparen'>(</span><span class='id identifier rubyid_threads'>threads</span><span class='rparen'>)</span>
<span class='ivar'>@threads</span> <span class='op'>=</span> <span class='id identifier rubyid_threads'>threads</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_threads'>threads</span> <span class='op'>:</span> <span class='id identifier rubyid_threads'>threads</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_h-instance_method">
- (<tt>Object</tt>) <strong>to_h</strong>
</h3><div class="docstring">
<div class="discussion">
<p>return Hash</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
139
140
141
142
143
144
145
146
147
148
149
150</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 139</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='const'>ACCESSOR_OPTIONS</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_option'>option</span><span class='op'>|</span>
<span class='id identifier rubyid_instance_variable'>instance_variable</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_option'>option</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_instance_variable'>instance_variable</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:#{</span><span class='id identifier rubyid_option'>option</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_instance_variable'>instance_variable</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_options'>options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="url=-instance_method">
- (<tt>Object</tt>) <strong>url=</strong>(url)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_url='>url=</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Empty URL given</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_url'>url</span>
<span class='ivar'>@url</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_add_http_protocol'>add_http_protocol</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="wordlist=-instance_method">
- (<tt>Object</tt>) <strong>wordlist=</strong>(wordlist)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpscan/wpscan_options.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wordlist='>wordlist=</span><span class='lparen'>(</span><span class='id identifier rubyid_wordlist'>wordlist</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_wordlist'>wordlist</span><span class='rparen'>)</span>
<span class='ivar'>@wordlist</span> <span class='op'>=</span> <span class='id identifier rubyid_wordlist'>wordlist</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The file </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_wordlist'>wordlist</span><span class='rbrace'>}</span><span class='tstring_content'> does not exist</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jun 9 16:05:18 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.6.1 (ruby-1.9.3).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink