Files
metasploit-gs/api/Msf/DBManager/Import/Report.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

310 lines
13 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::DBManager::Import::Report
&mdash; 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::DBManager::Import::Report";
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 (R)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../DBManager.html" title="Msf::DBManager (class)">DBManager</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Import.html" title="Msf::DBManager::Import (module)">Import</a></span></span>
&raquo;
<span class="title">Report</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::DBManager::Import::Report
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Import.html" title="Msf::DBManager::Import (module)">Msf::DBManager::Import</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/db_manager/import/report.rb</dd>
</dl>
</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="#import_report-instance_method" title="#import_report (instance method)">#<strong>import_report</strong>(report, args, base_dir) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="import_report-instance_method">
#<strong>import_report</strong>(report, args, base_dir) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>report</span>
<span class='type'>(<tt>REXML::Element</tt>)</span>
&mdash;
<div class='inline'>
<p>to be imported</p>
</div>
</li>
<li>
<span class='name'>args</span>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
<li>
<span class='name'>base_dir</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7
8
9
10
11
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
38
39
40
41
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/db_manager/import/report.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import_report'>import_report</span><span class='lparen'>(</span><span class='id identifier rubyid_report'>report</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_base_dir'>base_dir</span><span class='rparen'>)</span>
<span class='id identifier rubyid_tmp'>tmp</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:ifd</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:zip_tmp</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_report_info'>report_info</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_report'>report</span><span class='period'>.</span><span class='id identifier rubyid_elements'>elements</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_e'>e</span><span class='op'>|</span>
<span class='id identifier rubyid_node_name'>node_name</span> <span class='op'>=</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_node_value'>node_value</span> <span class='op'>=</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span>
<span class='comment'># These need to be converted back to arrays:
</span> <span class='id identifier rubyid_array_attrs'>array_attrs</span> <span class='op'>=</span> <span class='qwords_beg'>%w|</span><span class='tstring_content'>addresses</span><span class='words_sep'> </span><span class='tstring_content'>file-formats</span><span class='words_sep'> </span><span class='tstring_content'>options</span><span class='words_sep'> </span><span class='tstring_content'>sections</span><span class='tstring_end'>|</span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_array_attrs'>array_attrs</span><span class='period'>.</span><span class='id identifier rubyid_member?'>member?</span> <span class='id identifier rubyid_node_name'>node_name</span>
<span class='id identifier rubyid_node_value'>node_value</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_node_value'>node_value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Don&#39;t restore these values:
</span> <span class='id identifier rubyid_skip_nodes'>skip_nodes</span> <span class='op'>=</span> <span class='qwords_beg'>%w|</span><span class='tstring_content'>id</span><span class='words_sep'> </span><span class='tstring_content'>workspace-id</span><span class='words_sep'> </span><span class='tstring_content'>artifacts</span><span class='tstring_end'>|</span></span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_skip_nodes'>skip_nodes</span><span class='period'>.</span><span class='id identifier rubyid_member?'>member?</span> <span class='id identifier rubyid_node_name'>node_name</span>
<span class='id identifier rubyid_report_info'>report_info</span><span class='lbracket'>[</span><span class='id identifier rubyid_node_name'>node_name</span><span class='period'>.</span><span class='id identifier rubyid_parameterize'>parameterize</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_node_value'>node_value</span>
<span class='kw'>end</span>
<span class='comment'># Use current workspace
</span> <span class='id identifier rubyid_report_info'>report_info</span><span class='lbracket'>[</span><span class='symbol'>:workspace_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:workspace</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='comment'># Create report, need new ID to record artifacts
</span> <span class='id identifier rubyid_report_id'>report_id</span> <span class='op'>=</span> <span class='id identifier rubyid_report_report'>report_report</span><span class='lparen'>(</span><span class='id identifier rubyid_report_info'>report_info</span><span class='rparen'>)</span>
<span class='comment'># Handle artifacts
</span> <span class='id identifier rubyid_report'>report</span><span class='period'>.</span><span class='id identifier rubyid_elements'>elements</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>artifacts</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_elements'>elements</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_artifact'>artifact</span><span class='op'>|</span>
<span class='id identifier rubyid_artifact_opts'>artifact_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_artifact'>artifact</span><span class='period'>.</span><span class='id identifier rubyid_elements'>elements</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_attr'>attr</span><span class='op'>|</span>
<span class='id identifier rubyid_skip_nodes'>skip_nodes</span> <span class='op'>=</span> <span class='qwords_beg'>%w|</span><span class='tstring_content'>id</span><span class='words_sep'> </span><span class='tstring_content'>accessed-at</span><span class='tstring_end'>|</span></span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_skip_nodes'>skip_nodes</span><span class='period'>.</span><span class='id identifier rubyid_member?'>member?</span> <span class='id identifier rubyid_attr'>attr</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_symboled_attr'>symboled_attr</span> <span class='op'>=</span> <span class='id identifier rubyid_attr'>attr</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_parameterize'>parameterize</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='id identifier rubyid_artifact_opts'>artifact_opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_symboled_attr'>symboled_attr</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_attr'>attr</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span>
<span class='kw'>end</span>
<span class='comment'># Use new Report as parent
</span> <span class='id identifier rubyid_artifact_opts'>artifact_opts</span><span class='lbracket'>[</span><span class='symbol'>:report_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_report_id'>report_id</span>
<span class='comment'># Update to full path
</span> <span class='id identifier rubyid_artifact_opts'>artifact_opts</span><span class='lbracket'>[</span><span class='symbol'>:file_path</span><span class='rbracket'>]</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='id identifier rubyid_tmp'>tmp</span><span class='rparen'>)</span>
<span class='id identifier rubyid_msf_import_artifact'>msf_import_artifact</span><span class='lparen'>(</span><span class='id identifier rubyid_artifact_opts'>artifact_opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:01:49 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>