Files
wpscan/doc_rdoc/Browser.html
Christian Mehlmauer a38c709d74 Updated documentation
2013-04-30 23:06:37 +02:00

651 lines
22 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.
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<title>class Browser - RDoc Documentation</title>
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
<body id="top" class="class">
<nav id="metadata">
<nav id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<h3 class="section-header">
<input type="text" name="search" placeholder="Search" id="search-field"
title="Type to search, Up and Down to navigate, Enter to load">
</h3>
</form>
<ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="file-metadata">
<nav id="file-list-section" class="section">
<h3 class="section-header">Defined In</h3>
<ul>
<li>lib/common/browser.rb
<li>lib/common/browser/actions.rb
<li>lib/common/browser/options.rb
</ul>
</nav>
</div>
<div id="class-metadata">
<nav id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</nav>
<!-- Included Modules -->
<nav 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>
</ul>
</nav>
<!-- Extension Modules -->
<nav id="extends-section" class="section">
<h3 class="section-header">Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Browser/Actions.html">Browser::Actions</a>
</ul>
</nav>
<!-- Method Quickref -->
<nav 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 ><a href="#method-c-reset">::reset</a>
<li ><a href="#method-i-forge_request">#forge_request</a>
<li ><a href="#method-i-load_config">#load_config</a>
<li ><a href="#method-i-merge_request_params">#merge_request_params</a>
</ul>
</nav>
</div>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
<ul>
<li class="file"><a href="./CREDITS.html">CREDITS</a>
<li class="file"><a href="./Gemfile.html">Gemfile</a>
<li class="file"><a href="./Gemfile_lock.html">Gemfile.lock</a>
<li class="file"><a href="./LICENSE.html">LICENSE</a>
<li class="file"><a href="./README.html">README</a>
<li class="file"><a href="./README_md.html">README</a>
<li class="file"><a href="./conf/browser_conf_json.html">browser.conf.json</a>
<li class="file"><a href="./generate_doc_sh.html">generate_doc.sh</a>
</ul>
</nav>
<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>
<ul class="link-list">
<li><a href="./Array.html">Array</a>
<li><a href="./Browser.html">Browser</a>
<li><a href="./Browser/Actions.html">Browser::Actions</a>
<li><a href="./Browser/Options.html">Browser::Options</a>
<li><a href="./CacheFileStore.html">CacheFileStore</a>
<li><a href="./CheckerPlugin.html">CheckerPlugin</a>
<li><a href="./CustomOptionParser.html">CustomOptionParser</a>
<li><a href="./Ethon.html">Ethon</a>
<li><a href="./Ethon/Easy.html">Ethon::Easy</a>
<li><a href="./Ethon/Easy/Options.html">Ethon::Easy::Options</a>
<li><a href="./File.html">File</a>
<li><a href="./Gem.html">Gem</a>
<li><a href="./GenerateList.html">GenerateList</a>
<li><a href="./GitUpdater.html">GitUpdater</a>
<li><a href="./ListGeneratorPlugin.html">ListGeneratorPlugin</a>
<li><a href="./Object.html">Object</a>
<li><a href="./Plugin.html">Plugin</a>
<li><a href="./Plugins.html">Plugins</a>
<li><a href="./StatsPlugin.html">StatsPlugin</a>
<li><a href="./SvnParser.html">SvnParser</a>
<li><a href="./SvnUpdater.html">SvnUpdater</a>
<li><a href="./Terminal.html">Terminal</a>
<li><a href="./Terminal/Table.html">Terminal::Table</a>
<li><a href="./Terminal/Table/Style.html">Terminal::Table::Style</a>
<li><a href="./Typhoeus.html">Typhoeus</a>
<li><a href="./Typhoeus/Request.html">Typhoeus::Request</a>
<li><a href="./Typhoeus/Request/Cacheable.html">Typhoeus::Request::Cacheable</a>
<li><a href="./Typhoeus/Response.html">Typhoeus::Response</a>
<li><a href="./TyphoeusCache.html">TyphoeusCache</a>
<li><a href="./URI.html">URI</a>
<li><a href="./Updater.html">Updater</a>
<li><a href="./UpdaterFactory.html">UpdaterFactory</a>
<li><a href="./Vulnerabilities.html">Vulnerabilities</a>
<li><a href="./Vulnerabilities/Output.html">Vulnerabilities::Output</a>
<li><a href="./Vulnerability.html">Vulnerability</a>
<li><a href="./Vulnerability/Output.html">Vulnerability::Output</a>
<li><a href="./WebSite.html">WebSite</a>
<li><a href="./WpItem.html">WpItem</a>
<li><a href="./WpItem/Existable.html">WpItem::Existable</a>
<li><a href="./WpItem/Findable.html">WpItem::Findable</a>
<li><a href="./WpItem/Infos.html">WpItem::Infos</a>
<li><a href="./WpItem/Output.html">WpItem::Output</a>
<li><a href="./WpItem/Versionable.html">WpItem::Versionable</a>
<li><a href="./WpItem/Vulnerable.html">WpItem::Vulnerable</a>
<li><a href="./WpItems.html">WpItems</a>
<li><a href="./WpItems/Detectable.html">WpItems::Detectable</a>
<li><a href="./WpItems/Output.html">WpItems::Output</a>
<li><a href="./WpPlugin.html">WpPlugin</a>
<li><a href="./WpPlugin/Vulnerable.html">WpPlugin::Vulnerable</a>
<li><a href="./WpPlugins.html">WpPlugins</a>
<li><a href="./WpPlugins/Detectable.html">WpPlugins::Detectable</a>
<li><a href="./WpTarget.html">WpTarget</a>
<li><a href="./WpTarget/Malwares.html">WpTarget::Malwares</a>
<li><a href="./WpTarget/WpConfigBackup.html">WpTarget::WpConfigBackup</a>
<li><a href="./WpTarget/WpCustomDirectories.html">WpTarget::WpCustomDirectories</a>
<li><a href="./WpTarget/WpFullPathDisclosure.html">WpTarget::WpFullPathDisclosure</a>
<li><a href="./WpTarget/WpLoginProtection.html">WpTarget::WpLoginProtection</a>
<li><a href="./WpTarget/WpReadme.html">WpTarget::WpReadme</a>
<li><a href="./WpTarget/WpRegistrable.html">WpTarget::WpRegistrable</a>
<li><a href="./WpTheme.html">WpTheme</a>
<li><a href="./WpTheme/Findable.html">WpTheme::Findable</a>
<li><a href="./WpTheme/Versionable.html">WpTheme::Versionable</a>
<li><a href="./WpTheme/Vulnerable.html">WpTheme::Vulnerable</a>
<li><a href="./WpThemes.html">WpThemes</a>
<li><a href="./WpThemes/Detectable.html">WpThemes::Detectable</a>
<li><a href="./WpTimthumb.html">WpTimthumb</a>
<li><a href="./WpTimthumb/Existable.html">WpTimthumb::Existable</a>
<li><a href="./WpTimthumb/Output.html">WpTimthumb::Output</a>
<li><a href="./WpTimthumb/Versionable.html">WpTimthumb::Versionable</a>
<li><a href="./WpTimthumbs.html">WpTimthumbs</a>
<li><a href="./WpTimthumbs/Detectable.html">WpTimthumbs::Detectable</a>
<li><a href="./WpUser.html">WpUser</a>
<li><a href="./WpUser/BruteForcable.html">WpUser::BruteForcable</a>
<li><a href="./WpUser/Existable.html">WpUser::Existable</a>
<li><a href="./WpUsers.html">WpUsers</a>
<li><a href="./WpUsers/BruteForcable.html">WpUsers::BruteForcable</a>
<li><a href="./WpUsers/Detectable.html">WpUsers::Detectable</a>
<li><a href="./WpUsers/Output.html">WpUsers::Output</a>
<li><a href="./WpVersion.html">WpVersion</a>
<li><a href="./WpVersion/Findable.html">WpVersion::Findable</a>
<li><a href="./WpVersion/Output.html">WpVersion::Output</a>
<li><a href="./WpVersion/Vulnerable.html">WpVersion::Vulnerable</a>
<li><a href="./WpscanOptions.html">WpscanOptions</a>
</ul>
</nav>
</div>
</nav>
<div id="documentation">
<h1 class="class">class Browser</h1>
<div id="description" class="description">
</div><!-- description -->
<section id="5Buntitled-5D" class="documentation-section">
<!-- Constants -->
<section id="constants-list" class="section">
<h3 class="section-header">Constants</h3>
<dl>
<dt id="OPTIONS">OPTIONS
<dd class="description">
</dl>
</section>
<!-- Attributes -->
<section id="attribute-method-details" class="method-section section">
<h3 class="section-header">Attributes</h3>
<div id="attribute-i-cache_dir" class="method-detail">
<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="attribute-i-config_file" class="method-detail">
<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="attribute-i-hydra" class="method-detail">
<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>
</section><!-- attribute-method-details -->
<!-- Methods -->
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="method-c-instance" class="method-detail ">
<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 50</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="method-c-reset" class="method-detail ">
<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 57</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 -->
</section><!-- public-class-method-details -->
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="method-i-forge_request" class="method-detail ">
<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 90</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="method-i-load_config" class="method-detail ">
<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 68</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">&quot;[ERROR] Config file is a symlink.&quot;</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="method-i-merge_request_params" class="method-detail ">
<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 97</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-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 -->
</section><!-- public-instance-method-details -->
</section><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<footer id="validator-badges">
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>