wazuh-ruby-client 0.3.2 → 0.3.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/codeql-analysis.yml +70 -0
  3. data/.rubocop.yml +59 -0
  4. data/CHANGELOG.md +29 -0
  5. data/README.md +18 -1
  6. data/Rakefile +5 -1
  7. data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +10 -13
  8. data/docs/Wazuh/Api/Endpoints/Agents.html +483 -204
  9. data/docs/Wazuh/Api/Endpoints/Cache.html +7 -7
  10. data/docs/Wazuh/Api/Endpoints/Ciscat.html +10 -13
  11. data/docs/Wazuh/Api/Endpoints/Cluster.html +52 -58
  12. data/docs/Wazuh/Api/Endpoints/Decoders.html +27 -39
  13. data/docs/Wazuh/Api/Endpoints/Experimental.html +63 -96
  14. data/docs/Wazuh/Api/Endpoints/Lists.html +15 -21
  15. data/docs/Wazuh/Api/Endpoints/Manager.html +44 -62
  16. data/docs/Wazuh/Api/Endpoints/Rootcheck.html +36 -52
  17. data/docs/Wazuh/Api/Endpoints/Rules.html +49 -68
  18. data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +20 -31
  19. data/docs/Wazuh/Api/Endpoints/Summary.html +7 -7
  20. data/docs/Wazuh/Api/Endpoints/Syscheck.html +26 -33
  21. data/docs/Wazuh/Api/Endpoints/Syscollector.html +43 -61
  22. data/docs/Wazuh/Api/Endpoints/V4/ActiveResponse.html +198 -0
  23. data/docs/Wazuh/Api/Endpoints/V4/Agents.html +1079 -0
  24. data/docs/Wazuh/Api/Endpoints/V4/Cache.html +195 -0
  25. data/docs/Wazuh/Api/Endpoints/V4/Ciscat.html +126 -0
  26. data/docs/Wazuh/Api/Endpoints/V4/Cluster.html +126 -0
  27. data/docs/Wazuh/Api/Endpoints/V4/Decoders.html +126 -0
  28. data/docs/Wazuh/Api/Endpoints/V4/Experimental.html +126 -0
  29. data/docs/Wazuh/Api/Endpoints/V4/Lists.html +126 -0
  30. data/docs/Wazuh/Api/Endpoints/V4/Manager.html +126 -0
  31. data/docs/Wazuh/Api/Endpoints/V4/Rootcheck.html +126 -0
  32. data/docs/Wazuh/Api/Endpoints/V4/Rules.html +126 -0
  33. data/docs/Wazuh/Api/Endpoints/V4/SecurityConfigurationAssessment.html +126 -0
  34. data/docs/Wazuh/Api/Endpoints/V4/Summary.html +126 -0
  35. data/docs/Wazuh/Api/Endpoints/V4/Syscheck.html +126 -0
  36. data/docs/Wazuh/Api/Endpoints/V4/Syscollector.html +126 -0
  37. data/docs/Wazuh/Api/Endpoints/V4/Vulnerabilities.html +399 -0
  38. data/docs/Wazuh/Api/Endpoints/V4.html +403 -0
  39. data/docs/Wazuh/Api/Endpoints.html +9 -14
  40. data/docs/Wazuh/Api/Errors/WazuhError.html +9 -9
  41. data/docs/Wazuh/Api/Errors.html +6 -6
  42. data/docs/Wazuh/Api.html +7 -7
  43. data/docs/Wazuh/Client.html +35 -190
  44. data/docs/Wazuh/Config.html +20 -11
  45. data/docs/Wazuh/Logger.html +6 -6
  46. data/docs/Wazuh/Sawyer/Connection/Token.html +208 -0
  47. data/docs/Wazuh/Sawyer/Connection.html +19 -7
  48. data/docs/Wazuh/Sawyer/Request.html +78 -6
  49. data/docs/Wazuh/Sawyer.html +8 -8
  50. data/docs/Wazuh.html +16 -16
  51. data/docs/WazuhRubyClient.html +7 -7
  52. data/docs/_index.html +149 -7
  53. data/docs/class_list.html +3 -3
  54. data/docs/css/style.css +2 -2
  55. data/docs/file.README.html +39 -18
  56. data/docs/file_list.html +2 -2
  57. data/docs/frames.html +2 -2
  58. data/docs/index.html +39 -18
  59. data/docs/js/app.js +25 -3
  60. data/docs/method_list.html +269 -69
  61. data/docs/top-level-namespace.html +6 -6
  62. data/lib/wazuh/api/endpoints/agents.rb +1 -1
  63. data/lib/wazuh/api/endpoints/rootcheck.rb +1 -1
  64. data/lib/wazuh/api/endpoints/security_configuration_assessment.rb +1 -1
  65. data/lib/wazuh/api/endpoints/syscollector.rb +1 -1
  66. data/lib/wazuh/api/endpoints/v4/cluster.rb +127 -0
  67. data/lib/wazuh/api/endpoints/v4/vulnerabilities.rb +47 -0
  68. data/lib/wazuh/api/endpoints/v4.rb +2 -1
  69. data/lib/wazuh/client.rb +0 -1
  70. data/lib/wazuh/sawyer/connection.rb +2 -2
  71. data/lib/wazuh/sawyer/request.rb +21 -15
  72. data/lib/wazuh/version.rb +1 -1
  73. data/lib/wazuh-ruby-client/version.rb +1 -1
  74. metadata +23 -3
  75. data/.travis.yml +0 -7
data/docs/Wazuh/Api/Endpoints/V4/Vulnerabilities.html ADDED
@@ -0,0 +1,399 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Wazuh::Api::Endpoints::V4::Vulnerabilities
8
+
9
+ &mdash; Documentation by YARD 0.9.25
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Wazuh::Api::Endpoints::V4::Vulnerabilities";
19
+ relpath = '../../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../../_index.html">Index (V)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../../Wazuh.html" title="Wazuh (module)">Wazuh</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Api.html" title="Wazuh::Api (module)">Api</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../V4.html" title="Wazuh::Api::Endpoints::V4 (module)">V4</a></span></span>
41
+ &raquo;
42
+ <span class="title">Vulnerabilities</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Wazuh::Api::Endpoints::V4::Vulnerabilities
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="../V4.html" title="Wazuh::Api::Endpoints::V4 (module)">Wazuh::Api::Endpoints::V4</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/wazuh/api/endpoints/v4/vulnerabilities.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h2>
100
+ Instance Method Summary
101
+ <small><a href="#" class="summary_toggle">collapse</a></small>
102
+ </h2>
103
+
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#vulnerabilities-instance_method" title="#vulnerabilities (instance method)">#<strong>vulnerabilities</strong>(agent_id, options = {}) &#x21d2; Object </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'>
124
+ <p>Get vulnerabilities Returns the vulnerabilities of an agent.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ </ul>
131
+
132
+
133
+
134
+
135
+ <div id="instance_method_details" class="method_details_list">
136
+ <h2>Instance Method Details</h2>
137
+
138
+
139
+ <div class="method_details first">
140
+ <h3 class="signature first" id="vulnerabilities-instance_method">
141
+
142
+ #<strong>vulnerabilities</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
143
+
144
+
145
+
146
+
147
+
148
+ </h3><div class="docstring">
149
+ <div class="discussion">
150
+
151
+ <p>Get vulnerabilities Returns the vulnerabilities of an agent</p>
152
+
153
+
154
+ </div>
155
+ </div>
156
+ <div class="tags">
157
+ <p class="tag_title">Parameters:</p>
158
+ <ul class="param">
159
+
160
+ <li>
161
+
162
+ <span class='name'>agent_id</span>
163
+
164
+
165
+ <span class='type'>(<tt>String</tt>)</span>
166
+
167
+
168
+
169
+ </li>
170
+
171
+ <li>
172
+
173
+ <span class='name'>options</span>
174
+
175
+
176
+ <span class='type'>(<tt>Hash</tt>)</span>
177
+
178
+
179
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
180
+
181
+
182
+ &mdash;
183
+ <div class='inline'>
184
+ <p>a customizable set of options</p>
185
+ </div>
186
+
187
+ </li>
188
+
189
+ </ul>
190
+
191
+
192
+
193
+
194
+
195
+
196
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
197
+ <ul class="option">
198
+
199
+ <li>
200
+ <span class="name">:wait_for_complete</span>
201
+ <span class="type">(<tt>wait_for_complete</tt>)</span>
202
+ <span class="default">
203
+
204
+ </span>
205
+
206
+ &mdash; <div class='inline'>
207
+ <p>Disable timeout response</p>
208
+ </div>
209
+
210
+ </li>
211
+
212
+ <li>
213
+ <span class="name">:offset</span>
214
+ <span class="type">(<tt>offset</tt>)</span>
215
+ <span class="default">
216
+
217
+ </span>
218
+
219
+ &mdash; <div class='inline'>
220
+ <p>First element to return in the collection</p>
221
+ </div>
222
+
223
+ </li>
224
+
225
+ <li>
226
+ <span class="name">:limit</span>
227
+ <span class="type">(<tt>limit</tt>)</span>
228
+ <span class="default">
229
+
230
+ </span>
231
+
232
+ &mdash; <div class='inline'>
233
+ <p>Maximum number of elements to return. Although up to 100.000 can be specified, it is recommended not to exceed 500 elements. Responses may be slower the more this number is exceeded.</p>
234
+ </div>
235
+
236
+ </li>
237
+
238
+ <li>
239
+ <span class="name">:sort</span>
240
+ <span class="type">(<tt>sort</tt>)</span>
241
+ <span class="default">
242
+
243
+ </span>
244
+
245
+ &mdash; <div class='inline'>
246
+ <p>Sort the collection by a field or fields (separated by comma). Use +/- at the beggining to list in ascending or descending order. Use &#39;.&#39; for nested fields. For example, &#39;field2&#39; may be selected with &#39;field1.field2&#39;</p>
247
+ </div>
248
+
249
+ </li>
250
+
251
+ <li>
252
+ <span class="name">:search</span>
253
+ <span class="type">(<tt>search</tt>)</span>
254
+ <span class="default">
255
+
256
+ </span>
257
+
258
+ &mdash; <div class='inline'>
259
+ <p>Look for elements containing the specified string. To obtain a complementary search, use &#39;-&#39; at the beggining</p>
260
+ </div>
261
+
262
+ </li>
263
+
264
+ <li>
265
+ <span class="name">:select</span>
266
+ <span class="type">(<tt>select</tt>)</span>
267
+ <span class="default">
268
+
269
+ </span>
270
+
271
+ &mdash; <div class='inline'>
272
+ <p>Select which fields to return (separated by comma). Use &#39;.&#39; for nested fields. For example, &#39;field2&#39; may be selected with &#39;field1.field2&#39;</p>
273
+ </div>
274
+
275
+ </li>
276
+
277
+ <li>
278
+ <span class="name">:q</span>
279
+ <span class="type">(<tt>q</tt>)</span>
280
+ <span class="default">
281
+
282
+ </span>
283
+
284
+ &mdash; <div class='inline'>
285
+ <p>Query to filter results by. For example q=“status=active”</p>
286
+ </div>
287
+
288
+ </li>
289
+
290
+ <li>
291
+ <span class="name">:distinct</span>
292
+ <span class="type">(<tt>distinct</tt>)</span>
293
+ <span class="default">
294
+
295
+ </span>
296
+
297
+ &mdash; <div class='inline'>
298
+ <p>Look for distinct values.</p>
299
+ </div>
300
+
301
+ </li>
302
+
303
+ <li>
304
+ <span class="name">:architecture</span>
305
+ <span class="type">(<tt>architecture</tt>)</span>
306
+ <span class="default">
307
+
308
+ </span>
309
+
310
+ &mdash; <div class='inline'>
311
+ <p>Filter by architecture</p>
312
+ </div>
313
+
314
+ </li>
315
+
316
+ <li>
317
+ <span class="name">:cve</span>
318
+ <span class="type">(<tt>cve</tt>)</span>
319
+ <span class="default">
320
+
321
+ </span>
322
+
323
+ &mdash; <div class='inline'>
324
+ <p>Filter by CVE</p>
325
+ </div>
326
+
327
+ </li>
328
+
329
+ <li>
330
+ <span class="name">:name</span>
331
+ <span class="type">(<tt>name</tt>)</span>
332
+ <span class="default">
333
+
334
+ </span>
335
+
336
+ &mdash; <div class='inline'>
337
+ <p>Filter by name</p>
338
+ </div>
339
+
340
+ </li>
341
+
342
+ <li>
343
+ <span class="name">:version</span>
344
+ <span class="type">(<tt>version</tt>)</span>
345
+ <span class="default">
346
+
347
+ </span>
348
+
349
+ &mdash; <div class='inline'>
350
+ <p>Filter by CVE version</p>
351
+ </div>
352
+
353
+ </li>
354
+
355
+ </ul>
356
+
357
+
358
+
359
+ <p class="tag_title">See Also:</p>
360
+ <ul class="see">
361
+
362
+ <li><a href="https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.vulnerability_controller.get_vulnerability_agent" target="_parent" title="https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.vulnerability_controller.get_vulnerability_agent">https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.vulnerability_controller.get_vulnerability_agent</a></li>
363
+
364
+ </ul>
365
+
366
+ </div><table class="source_code">
367
+ <tr>
368
+ <td>
369
+ <pre class="lines">
370
+
371
+
372
+ 40
373
+ 41
374
+ 42</pre>
375
+ </td>
376
+ <td>
377
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/v4/vulnerabilities.rb', line 40</span>
378
+
379
+ <span class='kw'>def</span> <span class='id identifier rubyid_vulnerabilities'>vulnerabilities</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
380
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/vulnerability/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
381
+ <span class='kw'>end</span></pre>
382
+ </td>
383
+ </tr>
384
+ </table>
385
+ </div>
386
+
387
+ </div>
388
+
389
+ </div>
390
+
391
+ <div id="footer">
392
+ Generated on Thu Feb 3 21:40:18 2022 by
393
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
394
+ 0.9.25 (ruby-2.6.3).
395
+ </div>
396
+
397
+ </div>
398
+ </body>
399
+ </html>