Files
wpscan/doc_rdoc/Browser.html
Christian Mehlmauer bf10b25291 docs
2013-07-19 23:10:56 +02:00

668 lines
26 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
<title>Class: Browser</title>
<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
<script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
<script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
<script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
<script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
</head>
<body id="top" class="class">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./index.html#classes">Classes</a>
<a href="./index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="./lib/common/browser/actions_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="lib/common/browser/actions.rb">lib/common/browser/actions.rb</a></li>
<li><a href="./lib/common/browser/options_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="lib/common/browser/options.rb">lib/common/browser/options.rb</a></li>
<li><a href="./lib/common/browser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="lib/common/browser.rb">lib/common/browser.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="Object.html">Object</a></p>
</div>
<!-- Namespace Contents -->
<div id="namespace-list-section" class="section">
<h3 class="section-header">Namespace</h3>
<ul class="link-list">
<li><span class="type">MODULE</span> <a href="Browser/Actions.html">Browser::Actions</a></li>
<li><span class="type">MODULE</span> <a href="Browser/Options.html">Browser::Options</a></li>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-c-instance">::instance</a></li>
<li><a href="#method-c-reset">::reset</a></li>
<li><a href="#method-i-forge_request">#forge_request</a></li>
<li><a href="#method-i-load_config">#load_config</a></li>
<li><a href="#method-i-merge_request_params">#merge_request_params</a></li>
</ul>
</div>
<!-- Included Modules -->
<div id="includes-section" class="section">
<h3 class="section-header">Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Browser/Options.html">Browser::Options</a></li>
</ul>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="./CREDITS.html">CREDITS</a></li>
<li class="file"><a href="./Gemfile.html">Gemfile</a></li>
<li class="file"><a href="./LICENSE.html">LICENSE</a></li>
<li class="file"><a href="./README.html">README</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class/Module Index
<span class="search-toggle"><img src="./images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="./WpTarget.html">WpTarget</a></li>
<li><a href="./WpTarget/InterestingHeaders.html">WpTarget::InterestingHeaders</a></li>
<li><a href="./WpTarget/Malwares.html">WpTarget::Malwares</a></li>
<li><a href="./WpTarget/WpConfigBackup.html">WpTarget::WpConfigBackup</a></li>
<li><a href="./WpTarget/WpCustomDirectories.html">WpTarget::WpCustomDirectories</a></li>
<li><a href="./WpTarget/WpFullPathDisclosure.html">WpTarget::WpFullPathDisclosure</a></li>
<li><a href="./WpTarget/WpLoginProtection.html">WpTarget::WpLoginProtection</a></li>
<li><a href="./WpTarget/WpReadme.html">WpTarget::WpReadme</a></li>
<li><a href="./WpTarget/WpRegistrable.html">WpTarget::WpRegistrable</a></li>
<li><a href="./WpItem.html">WpItem</a></li>
<li><a href="./WpItem/Existable.html">WpItem::Existable</a></li>
<li><a href="./WpItem/Findable.html">WpItem::Findable</a></li>
<li><a href="./WpItem/Infos.html">WpItem::Infos</a></li>
<li><a href="./WpItem/Output.html">WpItem::Output</a></li>
<li><a href="./WpItem/Versionable.html">WpItem::Versionable</a></li>
<li><a href="./WpItem/Vulnerable.html">WpItem::Vulnerable</a></li>
<li><a href="./Typhoeus.html">Typhoeus</a></li>
<li><a href="./Typhoeus/Request.html">Typhoeus::Request</a></li>
<li><a href="./Typhoeus/Request/Cacheable.html">Typhoeus::Request::Cacheable</a></li>
<li><a href="./Typhoeus/Response.html">Typhoeus::Response</a></li>
<li><a href="./WpTheme.html">WpTheme</a></li>
<li><a href="./WpTheme/Findable.html">WpTheme::Findable</a></li>
<li><a href="./WpTheme/Versionable.html">WpTheme::Versionable</a></li>
<li><a href="./WpTheme/Vulnerable.html">WpTheme::Vulnerable</a></li>
<li><a href="./WpTimthumb.html">WpTimthumb</a></li>
<li><a href="./WpTimthumb/Existable.html">WpTimthumb::Existable</a></li>
<li><a href="./WpTimthumb/Output.html">WpTimthumb::Output</a></li>
<li><a href="./WpTimthumb/Versionable.html">WpTimthumb::Versionable</a></li>
<li><a href="./WpUsers.html">WpUsers</a></li>
<li><a href="./WpUsers/BruteForcable.html">WpUsers::BruteForcable</a></li>
<li><a href="./WpUsers/Detectable.html">WpUsers::Detectable</a></li>
<li><a href="./WpUsers/Output.html">WpUsers::Output</a></li>
<li><a href="./WpVersion.html">WpVersion</a></li>
<li><a href="./WpVersion/Findable.html">WpVersion::Findable</a></li>
<li><a href="./WpVersion/Output.html">WpVersion::Output</a></li>
<li><a href="./WpVersion/Vulnerable.html">WpVersion::Vulnerable</a></li>
<li><a href="./Browser.html">Browser</a></li>
<li><a href="./Browser/Actions.html">Browser::Actions</a></li>
<li><a href="./Browser/Options.html">Browser::Options</a></li>
<li><a href="./Terminal.html">Terminal</a></li>
<li><a href="./Terminal/Table.html">Terminal::Table</a></li>
<li><a href="./Terminal/Table/Style.html">Terminal::Table::Style</a></li>
<li><a href="./WpItems.html">WpItems</a></li>
<li><a href="./WpItems/Detectable.html">WpItems::Detectable</a></li>
<li><a href="./WpItems/Output.html">WpItems::Output</a></li>
<li><a href="./WpUser.html">WpUser</a></li>
<li><a href="./WpUser/BruteForcable.html">WpUser::BruteForcable</a></li>
<li><a href="./WpUser/Existable.html">WpUser::Existable</a></li>
<li><a href="./Vulnerabilities.html">Vulnerabilities</a></li>
<li><a href="./Vulnerabilities/Output.html">Vulnerabilities::Output</a></li>
<li><a href="./Vulnerability.html">Vulnerability</a></li>
<li><a href="./Vulnerability/Output.html">Vulnerability::Output</a></li>
<li><a href="./WpPlugin.html">WpPlugin</a></li>
<li><a href="./WpPlugin/Vulnerable.html">WpPlugin::Vulnerable</a></li>
<li><a href="./WpPlugins.html">WpPlugins</a></li>
<li><a href="./WpPlugins/Detectable.html">WpPlugins::Detectable</a></li>
<li><a href="./WpThemes.html">WpThemes</a></li>
<li><a href="./WpThemes/Detectable.html">WpThemes::Detectable</a></li>
<li><a href="./WpTimthumbs.html">WpTimthumbs</a></li>
<li><a href="./WpTimthumbs/Detectable.html">WpTimthumbs::Detectable</a></li>
<li><a href="./Array.html">Array</a></li>
<li><a href="./CacheFileStore.html">CacheFileStore</a></li>
<li><a href="./CheckerPlugin.html">CheckerPlugin</a></li>
<li><a href="./CustomOptionParser.html">CustomOptionParser</a></li>
<li><a href="./File.html">File</a></li>
<li><a href="./GenerateList.html">GenerateList</a></li>
<li><a href="./GitUpdater.html">GitUpdater</a></li>
<li><a href="./ListGeneratorPlugin.html">ListGeneratorPlugin</a></li>
<li><a href="./Object.html">Object</a></li>
<li><a href="./Plugin.html">Plugin</a></li>
<li><a href="./Plugins.html">Plugins</a></li>
<li><a href="./StatsPlugin.html">StatsPlugin</a></li>
<li><a href="./SvnParser.html">SvnParser</a></li>
<li><a href="./SvnUpdater.html">SvnUpdater</a></li>
<li><a href="./TyphoeusCache.html">TyphoeusCache</a></li>
<li><a href="./URI.html">URI</a></li>
<li><a href="./Updater.html">Updater</a></li>
<li><a href="./UpdaterFactory.html">UpdaterFactory</a></li>
<li><a href="./VersionCompare.html">VersionCompare</a></li>
<li><a href="./WebSite.html">WebSite</a></li>
<li><a href="./WpscanOptions.html">WpscanOptions</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">Browser</h1>
<div id="description" class="description">
</div><!-- description -->
<div id="5Buntitled-5D" class="documentation-section">
<!-- Constants -->
<div id="constants-list" class="section">
<h3 class="section-header">Constants</h3>
<dl>
<dt><a name="OPTIONS">OPTIONS</a></dt>
<dd class="description"></dd>
</dl>
</div>
<!-- Attributes -->
<div id="attribute-method-details" class="method-section section">
<h3 class="section-header">Attributes</h3>
<div id="cache_dir-attribute-method" class="method-detail">
<a name="cache_dir"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">cache_dir</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="config_file-attribute-method" class="method-detail">
<a name="config_file"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">config_file</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="hydra-attribute-method" class="method-detail">
<a name="hydra"></a>
<div class="method-heading attribute-method-heading">
<span class="method-name">hydra</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</div><!-- attribute-method-details -->
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="instance-method" class="method-detail ">
<a name="method-c-instance"></a>
<div class="method-heading">
<span class="method-name">instance</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@param [ Hash ] options</p>
<p>@return [ <a href="Browser.html">Browser</a> ]</p>
<div class="method-source-code" id="instance-source">
<pre>
<span class="ruby-comment"># File lib/common/browser.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">@@instance</span>
<span class="ruby-identifier">@@instance</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">@@instance</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- instance-source -->
</div>
</div><!-- instance-method -->
<div id="reset-method" class="method-detail ">
<a name="method-c-reset"></a>
<div class="method-heading">
<span class="method-name">reset</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="reset-source">
<pre>
<span class="ruby-comment"># File lib/common/browser.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reset</span>
<span class="ruby-identifier">@@instance</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- reset-source -->
</div>
</div><!-- reset-method -->
</div><!-- public-class-method-details -->
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="forge_request-method" class="method-detail ">
<a name="method-i-forge_request"></a>
<div class="method-heading">
<span class="method-name">forge_request</span><span
class="method-args">(url, params = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@param [ String ] url @param [ Hash ] params</p>
<p>@return [ <a href="Typhoeus/Request.html">Typhoeus::Request</a> ]</p>
<div class="method-source-code" id="forge_request-source">
<pre>
<span class="ruby-comment"># File lib/common/browser.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
<span class="ruby-constant">Typhoeus</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">merge_request_params</span>(<span class="ruby-identifier">params</span>))
<span class="ruby-keyword">end</span></pre>
</div><!-- forge_request-source -->
</div>
</div><!-- forge_request-method -->
<div id="load_config-method" class="method-detail ">
<a name="method-i-load_config"></a>
<div class="method-heading">
<span class="method-name">load_config</span><span
class="method-args">(config_file = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If an option was set but is not in the new <a
href="Browser.html#attribute-i-config_file">config_file</a> its value is
kept</p>
<p>@param [ String ] <a
href="Browser.html#attribute-i-config_file">config_file</a></p>
<p>@return [ void ]</p>
<div class="method-source-code" id="load_config-source">
<pre>
<span class="ruby-comment"># File lib/common/browser.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_config</span>(<span class="ruby-identifier">config_file</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@config_file</span> = <span class="ruby-identifier">config_file</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@config_file</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">symlink?</span>(<span class="ruby-ivar">@config_file</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-string">'[ERROR] Config file is a symlink.'</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">data</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-ivar">@config_file</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-constant">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">option_name</span> = <span class="ruby-identifier">option</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>[<span class="ruby-identifier">option_name</span>].<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:&quot;#{option_name}=&quot;</span>, <span class="ruby-identifier">data</span>[<span class="ruby-identifier">option_name</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- load_config-source -->
</div>
</div><!-- load_config-method -->
<div id="merge_request_params-method" class="method-detail ">
<a name="method-i-merge_request_params"></a>
<div class="method-heading">
<span class="method-name">merge_request_params</span><span
class="method-args">(params = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@param [ Hash ] params</p>
<p>@return [ Hash ]</p>
<div class="method-source-code" id="merge_request_params-source">
<pre>
<span class="ruby-comment"># File lib/common/browser.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_request_params</span>(<span class="ruby-identifier">params</span> = {})
<span class="ruby-identifier">params</span> = <span class="ruby-constant">Browser</span>.<span class="ruby-identifier">append_params_header_field</span>(
<span class="ruby-identifier">params</span>,
<span class="ruby-string">'User-Agent'</span>,
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">user_agent</span>
)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxy</span>
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">proxy</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@proxy</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxy_auth</span>
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">proxyauth</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@proxy_auth</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@basic_auth</span>
<span class="ruby-identifier">params</span> = <span class="ruby-constant">Browser</span>.<span class="ruby-identifier">append_params_header_field</span>(
<span class="ruby-identifier">params</span>,
<span class="ruby-string">'Authorization'</span>,
<span class="ruby-ivar">@basic_auth</span>
)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@request_timeout</span>
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">timeout</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@request_timeout</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@connect_timeout</span>
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">connecttimeout</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@connect_timeout</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># Used to enable the cache system if :cache_ttl &gt; 0</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:cache_ttl</span>)
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">cache_ttl</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@cache_ttl</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># Disable SSL-Certificate checks</span>
<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">ssl_verifypeer</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">ssl_verifyhost</span><span class="ruby-operator">:</span> <span class="ruby-value">0</span>)
<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">cookiejar</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@cache_dir</span> <span class="ruby-operator">+</span> <span class="ruby-string">'/cookie-jar'</span>)
<span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">cookiefile</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@cache_dir</span> <span class="ruby-operator">+</span> <span class="ruby-string">'/cookie-jar'</span>)
<span class="ruby-identifier">params</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- merge_request_params-source -->
</div>
</div><!-- merge_request_params-method -->
</div><!-- public-instance-method-details -->
</div><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 2</small>.</p>
</div>
</body>
</html>