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

615 lines
23 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::RPC::JSON::Request
&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::RPC::JSON::Request";
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="../../RPC.html" title="Msf::RPC (module)">RPC</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../JSON.html" title="Msf::RPC::JSON (module)">JSON</a></span></span>
&raquo;
<span class="title">Request</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>Class: Msf::RPC::JSON::Request
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Msf::RPC::JSON::Request</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>EM::Deferrable</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/rpc/json/request.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a JSON-RPC request. This is an EM::Deferrable class and instances respond to #callback and #errback to store callback actions.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Notification.html" title="Msf::RPC::JSON::Notification (class)">Notification</a></span></p>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="JSON_MEDIA_TYPE-constant" class="">JSON_MEDIA_TYPE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="JSON_RPC_VERSION-constant" class="">JSON_RPC_VERSION =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="JSON_RPC_RESPONSE_REQUIRED_MEMBERS-constant" class="">JSON_RPC_RESPONSE_REQUIRED_MEMBERS =
</dt>
<dd><pre class="code"><span class='qsymbols_beg'>%i(</span><span class='tstring_content'>jsonrpc</span><span class='words_sep'> </span><span class='tstring_content'>id</span><span class='tstring_end'>)</span></span></pre></dd>
<dt id="JSON_RPC_RESPONSE_MEMBER_TYPES-constant" class="">JSON_RPC_RESPONSE_MEMBER_TYPES =
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='comment'># A String specifying the version of the JSON-RPC protocol.
</span> <span class='label'>jsonrpc:</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='comment'># An identifier established by the Client that MUST contain a String,
</span> <span class='comment'># Number, or NULL value if included. If it is not included it is assumed
</span> <span class='comment'># to be a notification. The value SHOULD normally not be Null [1] and
</span> <span class='comment'># Numbers SHOULD NOT contain fractional parts [2]
</span> <span class='label'>id:</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='const'>NilClass</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='rbrace'>}</span></pre></dd>
<dt id="JSON_RPC_ERROR_RESPONSE_REQUIRED_MEMBERS-constant" class="">JSON_RPC_ERROR_RESPONSE_REQUIRED_MEMBERS =
</dt>
<dd><pre class="code"><span class='qsymbols_beg'>%i(</span><span class='tstring_content'>code</span><span class='words_sep'> </span><span class='tstring_content'>message</span><span class='tstring_end'>)</span></span></pre></dd>
<dt id="JSON_RPC_ERROR_RESPONSE_MEMBER_TYPES-constant" class="">JSON_RPC_ERROR_RESPONSE_MEMBER_TYPES =
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='comment'># A Number that indicates the error type that occurred.
</span> <span class='comment'># This MUST be an integer.
</span> <span class='label'>code:</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='comment'># A String providing a short description of the error.
</span> <span class='comment'># The message SHOULD be limited to a concise single sentence.
</span> <span class='label'>message:</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='rbracket'>]</span>
<span class='rbrace'>}</span></pre></dd>
</dl>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(uri, api_token: nil, method:, params: nil, namespace: nil, symbolize_names: true, is_notification: false, private_key_file: nil, cert_chain_file: nil, verify_peer: nil) &#x21d2; Request </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Instantiate a Request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#send-instance_method" title="#send (instance method)">#<strong>send</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sends the JSON-RPC request using an EM::HttpRequest object, then validates and processes the JSON-RPC response.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(uri, api_token: nil, method:, params: nil, namespace: nil, symbolize_names: true, is_notification: false, private_key_file: nil, cert_chain_file: nil, verify_peer: nil) &#x21d2; <tt><span class='object_link'><a href="" title="Msf::RPC::JSON::Request (class)">Request</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Instantiate a Request.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>uri</span>
<span class='type'>(<tt>URI::HTTP</tt>)</span>
&mdash;
<div class='inline'>
<p>the JSON-RPC service URI</p>
</div>
</li>
<li>
<span class='name'>api_token</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the API token. Default: nil</p>
</div>
</li>
<li>
<span class='name'>method</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the JSON-RPC method name.</p>
</div>
</li>
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Array</tt>, <tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the JSON-RPC method parameters. Default: nil</p>
</div>
</li>
<li>
<span class='name'>namespace</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the namespace for the JSON-RPC method. The namespace will be prepended to the method name with a period separator. Default: nil</p>
</div>
</li>
<li>
<span class='name'>symbolize_names</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>If true, symbols are used for the names (keys) when processing JSON objects; otherwise, strings are used. Default: true</p>
</div>
</li>
<li>
<span class='name'>is_notification</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>If true, the request is created as a notification; otherwise, a standard request. Default: false</p>
</div>
</li>
<li>
<span class='name'>private_key_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the SSL private key file used for the HTTPS request. Default: nil</p>
</div>
</li>
<li>
<span class='name'>cert_chain_file</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the SSL cert chain file used for the HTTPS request. Default: nil</p>
</div>
</li>
<li>
<span class='name'>verify_peer</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>indicates whether a server should request a certificate from a peer, to be verified by user code. Default: nil</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/json/request.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'><span class='object_link'><a href="../../../top-level-namespace.html#uri-instance_method" title="#uri (method)">uri</a></span></span><span class='comma'>,</span> <span class='label'>api_token:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>method:</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>namespace:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>is_notification:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>private_key_file:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cert_chain_file:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>verify_peer:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@uri</span> <span class='op'>=</span> <span class='id identifier rubyid_uri'><span class='object_link'><a href="../../../top-level-namespace.html#uri-instance_method" title="#uri (method)">uri</a></span></span>
<span class='ivar'>@api_token</span> <span class='op'>=</span> <span class='id identifier rubyid_api_token'>api_token</span>
<span class='ivar'>@namespace</span> <span class='op'>=</span> <span class='id identifier rubyid_namespace'>namespace</span>
<span class='ivar'>@symbolize_names</span> <span class='op'>=</span> <span class='id identifier rubyid_symbolize_names'>symbolize_names</span>
<span class='ivar'>@is_notification</span> <span class='op'>=</span> <span class='id identifier rubyid_is_notification'>is_notification</span>
<span class='ivar'>@headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>Accept:</span> <span class='const'><span class='object_link'><a href="#JSON_MEDIA_TYPE-constant" title="Msf::RPC::JSON::Request::JSON_MEDIA_TYPE (constant)">JSON_MEDIA_TYPE</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='label_end'>&#39;:</span> <span class='const'><span class='object_link'><a href="#JSON_MEDIA_TYPE-constant" title="Msf::RPC::JSON::Request::JSON_MEDIA_TYPE (constant)">JSON_MEDIA_TYPE</a></span></span><span class='comma'>,</span>
<span class='label'>Authorization:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Bearer </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_token</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_absolute_method_name'>absolute_method_name</span> <span class='op'>=</span> <span class='ivar'>@namespace</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_method'>method</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@namespace</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_method'>method</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_request_msg'>request_msg</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>jsonrpc:</span> <span class='const'><span class='object_link'><a href="#JSON_RPC_VERSION-constant" title="Msf::RPC::JSON::Request::JSON_RPC_VERSION (constant)">JSON_RPC_VERSION</a></span></span><span class='comma'>,</span>
<span class='label'>method:</span> <span class='id identifier rubyid_absolute_method_name'>absolute_method_name</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_request_msg'>request_msg</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Msf::RPC::JSON::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_generate_id'>generate_id</span> <span class='kw'>unless</span> <span class='id identifier rubyid_is_notification'>is_notification</span>
<span class='id identifier rubyid_request_msg'>request_msg</span><span class='lbracket'>[</span><span class='symbol'>:params</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='ivar'>@request_options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>head:</span> <span class='ivar'>@headers</span><span class='comma'>,</span>
<span class='label'>body:</span> <span class='id identifier rubyid_request_msg'>request_msg</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
<span class='rbrace'>}</span>
<span class='comment'># add SSL options if specified
</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_private_key_file'>private_key_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_cert_chain_file'>cert_chain_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_verify_peer'>verify_peer</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>TrueClass</span><span class='rparen'>)</span> <span class='op'>||</span>
<span class='id identifier rubyid_verify_peer'>verify_peer</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>FalseClass</span><span class='rparen'>)</span>
<span class='id identifier rubyid_ssl_options'>ssl_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_ssl_options'>ssl_options</span><span class='lbracket'>[</span><span class='symbol'>:private_key_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_private_key_file'>private_key_file</span> <span class='kw'>unless</span> <span class='id identifier rubyid_private_key_file'>private_key_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_ssl_options'>ssl_options</span><span class='lbracket'>[</span><span class='symbol'>:cert_chain_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_cert_chain_file'>cert_chain_file</span> <span class='kw'>unless</span> <span class='id identifier rubyid_cert_chain_file'>cert_chain_file</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_ssl_options'>ssl_options</span><span class='lbracket'>[</span><span class='symbol'>:verify_peer</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_verify_peer'>verify_peer</span> <span class='kw'>if</span> <span class='id identifier rubyid_verify_peer'>verify_peer</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>TrueClass</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_verify_peer'>verify_peer</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>FalseClass</span><span class='rparen'>)</span>
<span class='ivar'>@request_options</span><span class='lbracket'>[</span><span class='symbol'>:ssl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ssl_options'>ssl_options</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="send-instance_method">
#<strong>send</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Sends the JSON-RPC request using an EM::HttpRequest object, then validates and processes the JSON-RPC response.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/json/request.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span>
<span class='id identifier rubyid_http'>http</span> <span class='op'>=</span> <span class='const'>EM</span><span class='op'>::</span><span class='const'>HttpRequest</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@uri</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='ivar'>@request_options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_callback'>callback</span> <span class='kw'>do</span>
<span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_errback'>errback</span> <span class='kw'>do</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</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:03:27 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