673 lines
26 KiB
HTML
673 lines
26 KiB
HTML
|
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
<title>
|
||
|
|
Module: Msf::Exploit::Remote::HTTP::Splunk::Dashboards
|
||
|
|
|
||
|
|
— Documentation by YARD 0.9.37
|
||
|
|
|
||
|
|
</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../../../../../css/style.css" type="text/css" />
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../../../../../css/common.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
pathId = "Msf::Exploit::Remote::HTTP::Splunk::Dashboards";
|
||
|
|
relpath = '../../../../../';
|
||
|
|
</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 class="nav_wrap">
|
||
|
|
<iframe id="nav" src="../../../../../class_list.html?1"></iframe>
|
||
|
|
<div id="resizer"></div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="main" tabindex="-1">
|
||
|
|
<div id="header">
|
||
|
|
<div id="menu">
|
||
|
|
|
||
|
|
<a href="../../../../../_index.html">Index (D)</a> »
|
||
|
|
<span class='title'><span class='object_link'><a href="../../../../../Msf.html" title="Msf (module)">Msf</a></span></span> » <span class='title'><span class='object_link'><a href="../../../../Exploit.html" title="Msf::Exploit (class)">Exploit</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Remote.html" title="Msf::Exploit::Remote (class)">Remote</a></span></span> » <span class='title'><span class='object_link'><a href="../../HTTP.html" title="Msf::Exploit::Remote::HTTP (module)">HTTP</a></span></span> » <span class='title'><span class='object_link'><a href="../Splunk.html" title="Msf::Exploit::Remote::HTTP::Splunk (module)">Splunk</a></span></span>
|
||
|
|
»
|
||
|
|
<span class="title">Dashboards</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search">
|
||
|
|
|
||
|
|
<a class="full_list_link" id="class_list_link"
|
||
|
|
href="../../../../../class_list.html">
|
||
|
|
|
||
|
|
<svg width="24" height="24">
|
||
|
|
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
||
|
|
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
||
|
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
||
|
|
</svg>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="clear"></div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="content"><h1>Module: Msf::Exploit::Remote::HTTP::Splunk::Dashboards
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</h1>
|
||
|
|
<div class="box_info">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>Included in:</dt>
|
||
|
|
<dd><span class='object_link'><a href="../Splunk.html" title="Msf::Exploit::Remote::HTTP::Splunk (module)">Msf::Exploit::Remote::HTTP::Splunk</a></span></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>Defined in:</dt>
|
||
|
|
<dd>lib/msf/core/exploit/remote/http/splunk/dashboards.rb</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h2>Overview</h2><div class="docstring">
|
||
|
|
<div class="discussion">
|
||
|
|
|
||
|
|
<p>This module provides a way of interacting with Splunk dashboards</p>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tags">
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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="#create_dashboard-instance_method" title="#create_dashboard (instance method)">#<strong>create_dashboard</strong>(namespace, name, template, cookie) ⇒ Rex::Proto::Http::Response </a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="summary_desc"><div class='inline'>
|
||
|
|
<p>Creates a new Splunk dashboard in the specified namespace.</p>
|
||
|
|
</div></span>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
<li class="public ">
|
||
|
|
<span class="summary_signature">
|
||
|
|
|
||
|
|
<a href="#delete_dashboard-instance_method" title="#delete_dashboard (instance method)">#<strong>delete_dashboard</strong>(namespace, name, cookie) ⇒ Rex::Proto::Http::Response </a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="summary_desc"><div class='inline'>
|
||
|
|
<p>Deletes a Splunk dashboard from the specified namespace.</p>
|
||
|
|
</div></span>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
<li class="public ">
|
||
|
|
<span class="summary_signature">
|
||
|
|
|
||
|
|
<a href="#export_dashboard-instance_method" title="#export_dashboard (instance method)">#<strong>export_dashboard</strong>(namespace, name, cookie) ⇒ Rex::Proto::Http::Response </a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="summary_desc"><div class='inline'>
|
||
|
|
<p>Exports a Splunk dashboard to PDF.</p>
|
||
|
|
</div></span>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div id="instance_method_details" class="method_details_list">
|
||
|
|
<h2>Instance Method Details</h2>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="method_details first">
|
||
|
|
<h3 class="signature first" id="create_dashboard-instance_method">
|
||
|
|
|
||
|
|
#<strong>create_dashboard</strong>(namespace, name, template, cookie) ⇒ <tt><span class='object_link'><a href="../../../../../Rex/Proto/Http/Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></tt>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</h3><div class="docstring">
|
||
|
|
<div class="discussion">
|
||
|
|
|
||
|
|
<p>Creates a new Splunk dashboard in the specified namespace</p>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tags">
|
||
|
|
<p class="tag_title">Parameters:</p>
|
||
|
|
<ul class="param">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>namespace</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The Splunk namespace (usually a user or app) where the dashboard will be created</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>name</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The name of the dashboard</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>template</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The dashboard template content</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>cookie</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>Valid admin's cookie</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p class="tag_title">Returns:</p>
|
||
|
|
<ul class="return">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt><span class='object_link'><a href="../../../../../Rex/Proto/Http/Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>HTTP response object</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div><table class="source_code">
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<pre class="lines">
|
||
|
|
|
||
|
|
|
||
|
|
12
|
||
|
|
13
|
||
|
|
14
|
||
|
|
15
|
||
|
|
16
|
||
|
|
17
|
||
|
|
18
|
||
|
|
19
|
||
|
|
20
|
||
|
|
21
|
||
|
|
22
|
||
|
|
23
|
||
|
|
24
|
||
|
|
25
|
||
|
|
26
|
||
|
|
27
|
||
|
|
28
|
||
|
|
29
|
||
|
|
30
|
||
|
|
31
|
||
|
|
32
|
||
|
|
33
|
||
|
|
34
|
||
|
|
35
|
||
|
|
36
|
||
|
|
37</pre>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/http/splunk/dashboards.rb', line 12</span>
|
||
|
|
|
||
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_create_dashboard'>create_dashboard</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span><span class='comma'>,</span> <span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
||
|
|
<span class='id identifier rubyid_csrf'>csrf</span> <span class='op'>=</span> <span class='id identifier rubyid_extract_csrf_token'>extract_csrf_token</span><span class='lparen'>(</span><span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
||
|
|
|
||
|
|
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='id identifier rubyid_send_request_cgi'>send_request_cgi</span><span class='lparen'>(</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_splunk_dashboard_create_api_url'>splunk_dashboard_create_api_url</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='rparen'>)</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>method</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vars_get</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>output_mode</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>json</span><span class='tstring_end'>'</span></span>
|
||
|
|
<span class='rbrace'>}</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vars_post</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>eai:data</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_template'>template</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>eai:type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>views</span><span class='tstring_end'>'</span></span>
|
||
|
|
<span class='rbrace'>}</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cookie</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>headers</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-Splunk-Form-Key</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_csrf'>csrf</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-Requested-With</span><span class='label_end'>':</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>XMLHttpRequest</span><span class='tstring_end'>'</span></span>
|
||
|
|
<span class='rbrace'>}</span>
|
||
|
|
<span class='rparen'>)</span>
|
||
|
|
<span class='kw'>unless</span> <span class='id identifier rubyid_res'>res</span><span class='op'>&.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>201</span>
|
||
|
|
<span class='id identifier rubyid_fail_with'>fail_with</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module.html" title="Msf::Module (class)">Module</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module/Failure.html" title="Msf::Module::Failure (module)">Failure</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module/Failure.html#UnexpectedReply-constant" title="Msf::Module::Failure::UnexpectedReply (constant)">UnexpectedReply</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_peer'>peer</span><span class='embexpr_end'>}</span><span class='tstring_content'> Server did not respond with the expected HTTP 200</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
||
|
|
<span class='kw'>end</span>
|
||
|
|
|
||
|
|
<span class='id identifier rubyid_res'>res</span>
|
||
|
|
<span class='kw'>end</span></pre>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method_details ">
|
||
|
|
<h3 class="signature " id="delete_dashboard-instance_method">
|
||
|
|
|
||
|
|
#<strong>delete_dashboard</strong>(namespace, name, cookie) ⇒ <tt><span class='object_link'><a href="../../../../../Rex/Proto/Http/Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></tt>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</h3><div class="docstring">
|
||
|
|
<div class="discussion">
|
||
|
|
|
||
|
|
<p>Deletes a Splunk dashboard from the specified namespace</p>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tags">
|
||
|
|
<p class="tag_title">Parameters:</p>
|
||
|
|
<ul class="param">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>namespace</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The Splunk namespace where the dashboard resides</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>name</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The name of the dashboard to delete</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>cookie</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>Valid admin's cookie</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p class="tag_title">Returns:</p>
|
||
|
|
<ul class="return">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt><span class='object_link'><a href="../../../../../Rex/Proto/Http/Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>HTTP response object</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div><table class="source_code">
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<pre class="lines">
|
||
|
|
|
||
|
|
|
||
|
|
71
|
||
|
|
72
|
||
|
|
73
|
||
|
|
74
|
||
|
|
75
|
||
|
|
76
|
||
|
|
77
|
||
|
|
78
|
||
|
|
79
|
||
|
|
80
|
||
|
|
81
|
||
|
|
82
|
||
|
|
83
|
||
|
|
84
|
||
|
|
85
|
||
|
|
86
|
||
|
|
87
|
||
|
|
88
|
||
|
|
89
|
||
|
|
90
|
||
|
|
91</pre>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/http/splunk/dashboards.rb', line 71</span>
|
||
|
|
|
||
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete_dashboard'>delete_dashboard</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
||
|
|
<span class='id identifier rubyid_csrf'>csrf</span> <span class='op'>=</span> <span class='id identifier rubyid_extract_csrf_token'>extract_csrf_token</span><span class='lparen'>(</span><span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
||
|
|
|
||
|
|
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='id identifier rubyid_send_request_cgi'>send_request_cgi</span><span class='lparen'>(</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_splunk_dashboard_delete_api_url'>splunk_dashboard_delete_api_url</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>method</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vars_get</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>output_mode</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>json</span><span class='tstring_end'>'</span></span>
|
||
|
|
<span class='rbrace'>}</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cookie</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@cookie</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>headers</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-Requested-With</span><span class='label_end'>':</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>XMLHttpRequest</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-Splunk-Form-Key</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_csrf'>csrf</span>
|
||
|
|
<span class='rbrace'>}</span>
|
||
|
|
<span class='rparen'>)</span>
|
||
|
|
<span class='kw'>unless</span> <span class='id identifier rubyid_res'>res</span><span class='op'>&.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>200</span>
|
||
|
|
<span class='id identifier rubyid_fail_with'>fail_with</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module.html" title="Msf::Module (class)">Module</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module/Failure.html" title="Msf::Module::Failure (module)">Failure</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module/Failure.html#UnexpectedReply-constant" title="Msf::Module::Failure::UnexpectedReply (constant)">UnexpectedReply</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_peer'>peer</span><span class='embexpr_end'>}</span><span class='tstring_content'> Server did not respond with the expected HTTP 200</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
||
|
|
<span class='kw'>end</span>
|
||
|
|
|
||
|
|
<span class='id identifier rubyid_res'>res</span>
|
||
|
|
<span class='kw'>end</span></pre>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method_details ">
|
||
|
|
<h3 class="signature " id="export_dashboard-instance_method">
|
||
|
|
|
||
|
|
#<strong>export_dashboard</strong>(namespace, name, cookie) ⇒ <tt><span class='object_link'><a href="../../../../../Rex/Proto/Http/Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></tt>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</h3><div class="docstring">
|
||
|
|
<div class="discussion">
|
||
|
|
|
||
|
|
<p>Exports a Splunk dashboard to PDF</p>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tags">
|
||
|
|
<p class="tag_title">Parameters:</p>
|
||
|
|
<ul class="param">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>namespace</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The Splunk namespace where the dashboard resides</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>name</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>The name of the dashboard to export</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class='name'>cookie</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt>String</tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>Valid admin's cookie</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p class="tag_title">Returns:</p>
|
||
|
|
<ul class="return">
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
|
||
|
|
<span class='type'>(<tt><span class='object_link'><a href="../../../../../Rex/Proto/Http/Response.html" title="Rex::Proto::Http::Response (class)">Rex::Proto::Http::Response</a></span></tt>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
—
|
||
|
|
<div class='inline'>
|
||
|
|
<p>HTTP response object containing the exported PDF</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div><table class="source_code">
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<pre class="lines">
|
||
|
|
|
||
|
|
|
||
|
|
45
|
||
|
|
46
|
||
|
|
47
|
||
|
|
48
|
||
|
|
49
|
||
|
|
50
|
||
|
|
51
|
||
|
|
52
|
||
|
|
53
|
||
|
|
54
|
||
|
|
55
|
||
|
|
56
|
||
|
|
57
|
||
|
|
58
|
||
|
|
59
|
||
|
|
60
|
||
|
|
61
|
||
|
|
62
|
||
|
|
63</pre>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/http/splunk/dashboards.rb', line 45</span>
|
||
|
|
|
||
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_export_dashboard'>export_dashboard</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
||
|
|
<span class='id identifier rubyid_csrf'>csrf</span> <span class='op'>=</span> <span class='id identifier rubyid_extract_csrf_token'>extract_csrf_token</span><span class='lparen'>(</span><span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
||
|
|
|
||
|
|
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='id identifier rubyid_send_request_cgi'>send_request_cgi</span><span class='lparen'>(</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_splunk_dashboard_pdf_export_api_url'>splunk_dashboard_pdf_export_api_url</span><span class='lparen'>(</span><span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>method</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vars_post</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='lbrace'>{</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>input-dashboard</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>namespace</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_namespace'>namespace</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>splunk_form_key</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_csrf'>csrf</span>
|
||
|
|
<span class='rbrace'>}</span><span class='comma'>,</span>
|
||
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cookie</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_cookie'>cookie</span>
|
||
|
|
<span class='rparen'>)</span>
|
||
|
|
<span class='kw'>unless</span> <span class='id identifier rubyid_res'>res</span><span class='op'>&.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>200</span>
|
||
|
|
<span class='id identifier rubyid_fail_with'>fail_with</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module.html" title="Msf::Module (class)">Module</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module/Failure.html" title="Msf::Module::Failure (module)">Failure</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Module/Failure.html#UnexpectedReply-constant" title="Msf::Module::Failure::UnexpectedReply (constant)">UnexpectedReply</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_peer'>peer</span><span class='embexpr_end'>}</span><span class='tstring_content'> Server did not respond with the expected HTTP 200</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
||
|
|
<span class='kw'>end</span>
|
||
|
|
|
||
|
|
<span class='id identifier rubyid_res'>res</span>
|
||
|
|
<span class='kw'>end</span></pre>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="footer">
|
||
|
|
Generated on Fri May 8 17:02:35 2026 by
|
||
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||
|
|
0.9.37 (ruby-3.1.5).
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|