adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
gh-pages
metasploit-gs/api/WorkspaceDataProxy.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

664 lines
22 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: WorkspaceDataProxy
&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 = "WorkspaceDataProxy";
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 (W)</a> &raquo;
<span class="title">WorkspaceDataProxy</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: WorkspaceDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/workspace_data_proxy.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="#add_workspace-instance_method" title="#add_workspace (instance method)">#<strong>add_workspace</strong>(workspace_name) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_workspace-instance_method" title="#default_workspace (instance method)">#<strong>default_workspace</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_workspaces-instance_method" title="#delete_workspaces (instance method)">#<strong>delete_workspaces</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#find_workspace-instance_method" title="#find_workspace (instance method)">#<strong>find_workspace</strong>(workspace_name) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_workspace-instance_method" title="#update_workspace (instance method)">#<strong>update_workspace</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#workspace-instance_method" title="#workspace (instance method)">#<strong>workspace</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#workspace=-instance_method" title="#workspace= (instance method)">#<strong>workspace=</strong>(workspace) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>TODO: Tracking of the current workspace should be moved out of the datastore.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#workspaces-instance_method" title="#workspaces (instance method)">#<strong>workspaces</strong>(opts = {}) &#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="add_workspace-instance_method">
#<strong>add_workspace</strong>(workspace_name) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16
17
18
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_add_workspace'>add_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_workspace_name'>workspace_name</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_workspace_name'>workspace_name</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_add_workspace'>add_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem adding workspace</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="default_workspace-instance_method">
#<strong>default_workspace</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28
29
30
31
32
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_workspace'>default_workspace</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_ws'>ws</span> <span class='op'>=</span> <span class='id identifier rubyid_find_workspace'>find_workspace</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="Msf/DBManager.html" title="Msf::DBManager (class)">DBManager</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Msf/DBManager/Workspace.html" title="Msf::DBManager::Workspace (module)">Workspace</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Msf/DBManager/Workspace.html#DEFAULT_WORKSPACE_NAME-constant" title="Msf::DBManager::Workspace::DEFAULT_WORKSPACE_NAME (constant)">DEFAULT_WORKSPACE_NAME</a></span></span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ws'>ws</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_ws'>ws</span> <span class='op'>=</span> <span class='id identifier rubyid_add_workspace'>add_workspace</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="Msf/DBManager.html" title="Msf::DBManager (class)">DBManager</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Msf/DBManager/Workspace.html" title="Msf::DBManager::Workspace (module)">Workspace</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Msf/DBManager/Workspace.html#DEFAULT_WORKSPACE_NAME-constant" title="Msf::DBManager::Workspace::DEFAULT_WORKSPACE_NAME (constant)">DEFAULT_WORKSPACE_NAME</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ws'>ws</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem finding default workspace</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_workspaces-instance_method">
#<strong>delete_workspaces</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_workspaces'>delete_workspaces</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_delete_workspaces'>delete_workspaces</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem deleting workspaces</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="find_workspace-instance_method">
#<strong>find_workspace</strong>(workspace_name) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5
6
7
8
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find_workspace'>find_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_workspace_name'>workspace_name</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_workspace_name'>workspace_name</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_workspaces'>workspaces</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem finding workspace</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_workspace-instance_method">
#<strong>update_workspace</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82
83
84
85
86
87
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_workspace'>update_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_update_workspace'>update_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem updating workspace</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="workspace-instance_method">
#<strong>workspace</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40
41
42
43
44
45
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_workspace'>workspace</span>
<span class='kw'>begin</span>
<span class='kw'>if</span> <span class='ivar'>@current_workspace</span>
<span class='ivar'>@current_workspace</span>
<span class='kw'>else</span>
<span class='comment'># This is mostly a failsafe to prevent bad things from happening. @current_workspace should always be set
</span> <span class='comment'># outside of here, but this will save us from crashes/infinite loops if that happens
</span> <span class='ivar'>@current_workspace</span> <span class='op'>=</span> <span class='id identifier rubyid_default_workspace'>default_workspace</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving workspace</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="workspace=-instance_method">
#<strong>workspace=</strong>(workspace) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>TODO: Tracking of the current workspace should be moved out of the datastore. See MS-3095.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
52
53
54
55
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 52</span>
<span class='kw'>def</span> <span class='id identifier rubyid_workspace='>workspace=</span><span class='lparen'>(</span><span class='id identifier rubyid_workspace'>workspace</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='ivar'>@current_workspace</span> <span class='op'>=</span> <span class='id identifier rubyid_workspace'>workspace</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem setting workspace</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="workspaces-instance_method">
#<strong>workspaces</strong>(opts = {}) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62
63
64
65
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/workspace_data_proxy.rb', line 60</span>
<span class='kw'>def</span> <span class='id identifier rubyid_workspaces'>workspaces</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_workspaces'>workspaces</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving workspaces</span><span class='tstring_end'>&quot;</span></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:02:53 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>
Reference in New Issue View Git Blame Copy Permalink