292 lines
13 KiB
HTML
292 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
|
|
<title>class WpOptions - 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/wpscan/wp_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>
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<nav id="method-list-section" class="section">
|
|
<h3 class="section-header">Methods</h3>
|
|
|
|
<ul class="link-list">
|
|
|
|
<li><a href="#method-c-check_options">::check_options</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="./README.html">README</a>
|
|
|
|
<li class="file"><a href="./log_txt.html">log</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="./BruteForce.html">BruteForce</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="./GenerateList.html">GenerateList</a>
|
|
|
|
<li><a href="./GitUpdater.html">GitUpdater</a>
|
|
|
|
<li><a href="./ListGeneratorPlugin.html">ListGeneratorPlugin</a>
|
|
|
|
<li><a href="./Malwares.html">Malwares</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="./SvnParser.html">SvnParser</a>
|
|
|
|
<li><a href="./SvnUpdater.html">SvnUpdater</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="./Vulnerable.html">Vulnerable</a>
|
|
|
|
<li><a href="./WebSite.html">WebSite</a>
|
|
|
|
<li><a href="./WpConfigBackup.html">WpConfigBackup</a>
|
|
|
|
<li><a href="./WpDetector.html">WpDetector</a>
|
|
|
|
<li><a href="./WpEnumerator.html">WpEnumerator</a>
|
|
|
|
<li><a href="./WpFullPathDisclosure.html">WpFullPathDisclosure</a>
|
|
|
|
<li><a href="./WpItem.html">WpItem</a>
|
|
|
|
<li><a href="./WpLoginProtection.html">WpLoginProtection</a>
|
|
|
|
<li><a href="./WpOptions.html">WpOptions</a>
|
|
|
|
<li><a href="./WpPlugin.html">WpPlugin</a>
|
|
|
|
<li><a href="./WpPlugins.html">WpPlugins</a>
|
|
|
|
<li><a href="./WpReadme.html">WpReadme</a>
|
|
|
|
<li><a href="./WpTarget.html">WpTarget</a>
|
|
|
|
<li><a href="./WpTheme.html">WpTheme</a>
|
|
|
|
<li><a href="./WpThemes.html">WpThemes</a>
|
|
|
|
<li><a href="./WpTimthumbs.html">WpTimthumbs</a>
|
|
|
|
<li><a href="./WpUser.html">WpUser</a>
|
|
|
|
<li><a href="./WpUsernames.html">WpUsernames</a>
|
|
|
|
<li><a href="./WpVersion.html">WpVersion</a>
|
|
|
|
<li><a href="./WpVulnerability.html">WpVulnerability</a>
|
|
|
|
<li><a href="./WpscanOptions.html">WpscanOptions</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="documentation">
|
|
<h1 class="class">class WpOptions</h1>
|
|
|
|
<div id="description" class="description">
|
|
|
|
<p>Options Hash</p>
|
|
|
|
<h4 id="label-Options">Options</h4>
|
|
<ul><li>
|
|
<p><code>url</code> - The base URL of the WordPress site</p>
|
|
</li><li>
|
|
<p><code>only_vulnerable_ones</code> - Only detect vulnerable items</p>
|
|
</li><li>
|
|
<p><code>file</code> - Filename with items to detect</p>
|
|
</li><li>
|
|
<p><code>vulns_file</code> - XML file with vulnerabilities</p>
|
|
</li><li>
|
|
<p><code>vulns_xpath</code> - XPath for vulnerability XML file</p>
|
|
</li><li>
|
|
<p><code>vulns_xpath_2</code> - XPath for vulnerability XML file</p>
|
|
</li><li>
|
|
<p><code>wp_content_dir</code> - Name of the wp-content directory</p>
|
|
</li><li>
|
|
<p><code>show_progression</code> - Show a progress bar during enumeration</p>
|
|
</li><li>
|
|
<p><code>error_404_hash</code> - MD5 hash of a 404 page</p>
|
|
</li><li>
|
|
<p><code>type</code> - Type: plugins, themes</p>
|
|
</li></ul>
|
|
|
|
</div><!-- description -->
|
|
|
|
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- 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-check_options" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">check_options</span><span
|
|
class="method-args">(options)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="check_options-source">
|
|
<pre><span class="ruby-comment"># File lib/wpscan/wp_options.rb, line 34</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">check_options</span>(<span class="ruby-identifier">options</span>)
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'base_url must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:base_url</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:base_url</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'only_vulnerable_ones must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:only_vulnerable_ones</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'file must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:file</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:file</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'vulns_file must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:vulns_file</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:vulns_file</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'vulns_xpath must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:vulns_xpath</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:vulns_xpath</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'vulns_xpath_2 must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:vulns_xpath_2</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:vulns_xpath_2</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'wp_content_dir must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:wp_content_dir</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:wp_content_dir</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'show_progression must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:show_progression</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'error_404_hash must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:error_404_hash</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:error_404_hash</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-string">'type must be set'</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rplugins/</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rthemes/</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rtimthumbs/</span>
|
|
<span class="ruby-identifier">raise</span>(<span class="ruby-node">"Unknown type #{options[:type]}"</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- check_options-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- check_options-method -->
|
|
|
|
|
|
</section><!-- public-class-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> 3.12.
|
|
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
</footer>
|
|
|