wazuh-ruby-client 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +20 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +7 -0
  5. data/CHANGELOG.md +0 -0
  6. data/Gemfile +5 -0
  7. data/LICENSE +21 -0
  8. data/README.md +74 -0
  9. data/Rakefile +6 -0
  10. data/docs/.nojekyll +0 -0
  11. data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +278 -0
  12. data/docs/Wazuh/Api/Endpoints/Agents.html +1877 -0
  13. data/docs/Wazuh/Api/Endpoints/Cache.html +415 -0
  14. data/docs/Wazuh/Api/Endpoints/Ciscat.html +418 -0
  15. data/docs/Wazuh/Api/Endpoints/Cluster.html +2270 -0
  16. data/docs/Wazuh/Api/Endpoints/Decoders.html +860 -0
  17. data/docs/Wazuh/Api/Endpoints/Experimental.html +2610 -0
  18. data/docs/Wazuh/Api/Endpoints/Lists.html +452 -0
  19. data/docs/Wazuh/Api/Endpoints/Manager.html +1596 -0
  20. data/docs/Wazuh/Api/Endpoints/Rootcheck.html +1025 -0
  21. data/docs/Wazuh/Api/Endpoints/Rules.html +872 -0
  22. data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +680 -0
  23. data/docs/Wazuh/Api/Endpoints/Summary.html +199 -0
  24. data/docs/Wazuh/Api/Endpoints/Syscheck.html +755 -0
  25. data/docs/Wazuh/Api/Endpoints/Syscollector.html +2069 -0
  26. data/docs/Wazuh/Api/Endpoints.html +292 -0
  27. data/docs/Wazuh/Api/Errors/TooManyRequestsError.html +398 -0
  28. data/docs/Wazuh/Api/Errors/WazuhError.html +290 -0
  29. data/docs/Wazuh/Api/Errors.html +117 -0
  30. data/docs/Wazuh/Api.html +133 -0
  31. data/docs/Wazuh/Client.html +521 -0
  32. data/docs/Wazuh/Config.html +223 -0
  33. data/docs/Wazuh/Faraday/Connection.html +110 -0
  34. data/docs/Wazuh/Faraday/Request.html +335 -0
  35. data/docs/Wazuh/Faraday/Response/RaiseError.html +191 -0
  36. data/docs/Wazuh/Faraday/Response.html +115 -0
  37. data/docs/Wazuh/Faraday.html +117 -0
  38. data/docs/Wazuh/Logger.html +201 -0
  39. data/docs/Wazuh.html +256 -0
  40. data/docs/WazuhRubyClient.html +121 -0
  41. data/docs/_index.html +391 -0
  42. data/docs/class_list.html +51 -0
  43. data/docs/css/common.css +1 -0
  44. data/docs/css/full_list.css +58 -0
  45. data/docs/css/style.css +496 -0
  46. data/docs/file.README.html +142 -0
  47. data/docs/file_list.html +56 -0
  48. data/docs/frames.html +17 -0
  49. data/docs/index.html +142 -0
  50. data/docs/js/app.js +292 -0
  51. data/docs/js/full_list.js +216 -0
  52. data/docs/js/jquery.js +4 -0
  53. data/docs/method_list.html +1059 -0
  54. data/docs/top-level-namespace.html +110 -0
  55. data/lib/tasks/api.rake +78 -0
  56. data/lib/wazuh/api/endpoints/active_response.rb +22 -0
  57. data/lib/wazuh/api/endpoints/agents.rb +175 -0
  58. data/lib/wazuh/api/endpoints/cache.rb +38 -0
  59. data/lib/wazuh/api/endpoints/ciscat.rb +43 -0
  60. data/lib/wazuh/api/endpoints/cluster.rb +199 -0
  61. data/lib/wazuh/api/endpoints/decoders.rb +91 -0
  62. data/lib/wazuh/api/endpoints/experimental.rb +309 -0
  63. data/lib/wazuh/api/endpoints/lists.rb +42 -0
  64. data/lib/wazuh/api/endpoints/manager.rb +156 -0
  65. data/lib/wazuh/api/endpoints/rootcheck.rb +93 -0
  66. data/lib/wazuh/api/endpoints/rules.rb +80 -0
  67. data/lib/wazuh/api/endpoints/security_configuration_assessment.rb +73 -0
  68. data/lib/wazuh/api/endpoints/summary.rb +15 -0
  69. data/lib/wazuh/api/endpoints/syscheck.rb +75 -0
  70. data/lib/wazuh/api/endpoints/syscollector.rb +227 -0
  71. data/lib/wazuh/api/endpoints.rb +37 -0
  72. data/lib/wazuh/api/error.rb +6 -0
  73. data/lib/wazuh/api/errors/too_many_requests_error.rb +22 -0
  74. data/lib/wazuh/api/errors/wazuh_error.rb +14 -0
  75. data/lib/wazuh/client.rb +27 -0
  76. data/lib/wazuh/config.rb +42 -0
  77. data/lib/wazuh/faraday/connection.rb +38 -0
  78. data/lib/wazuh/faraday/request.rb +38 -0
  79. data/lib/wazuh/faraday/response/raise_error.rb +11 -0
  80. data/lib/wazuh/logger.rb +13 -0
  81. data/lib/wazuh/version.rb +4 -0
  82. data/lib/wazuh-ruby-client/version.rb +3 -0
  83. data/lib/wazuh-ruby-client.rb +17 -0
  84. data/lib/wazuh_ruby_client.rb +2 -0
  85. data/wazuh-ruby-client.gemspec +43 -0
  86. metadata +200 -0
data/docs/Wazuh/Api/Endpoints/Lists.html ADDED
@@ -0,0 +1,452 @@
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::Lists
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Wazuh::Api::Endpoints::Lists";
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 (L)</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>
41
+ &raquo;
42
+ <span class="title">Lists</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::Lists
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="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/wazuh/api/endpoints/lists.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="#cdb_files-instance_method" title="#cdb_files (instance method)">#<strong>cdb_files</strong>(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 paths from all lists Returns the path from all lists.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#cdb_lists-instance_method" title="#cdb_lists (instance method)">#<strong>cdb_lists</strong>(options = {}) &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Get all lists Returns the content of all CDB lists.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ </ul>
155
+
156
+
157
+
158
+
159
+ <div id="instance_method_details" class="method_details_list">
160
+ <h2>Instance Method Details</h2>
161
+
162
+
163
+ <div class="method_details first">
164
+ <h3 class="signature first" id="cdb_files-instance_method">
165
+
166
+ #<strong>cdb_files</strong>(options = {}) &#x21d2; <tt>Object</tt>
167
+
168
+
169
+
170
+
171
+
172
+ </h3><div class="docstring">
173
+ <div class="discussion">
174
+
175
+ <p>Get paths from all lists Returns the path from all lists.</p>
176
+
177
+
178
+ </div>
179
+ </div>
180
+ <div class="tags">
181
+ <p class="tag_title">Parameters:</p>
182
+ <ul class="param">
183
+
184
+ <li>
185
+
186
+ <span class='name'>options</span>
187
+
188
+
189
+ <span class='type'>(<tt>Hash</tt>)</span>
190
+
191
+
192
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
193
+
194
+
195
+ &mdash;
196
+ <div class='inline'>
197
+ <p>a customizable set of options</p>
198
+ </div>
199
+
200
+ </li>
201
+
202
+ </ul>
203
+
204
+
205
+
206
+
207
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
208
+ <ul class="option">
209
+
210
+ <li>
211
+ <span class="name">:offset</span>
212
+ <span class="type">(<tt>offset</tt>)</span>
213
+ <span class="default">
214
+
215
+ </span>
216
+
217
+ &mdash; <div class='inline'>
218
+ <p>First element to return in the collection.</p>
219
+ </div>
220
+
221
+ </li>
222
+
223
+ <li>
224
+ <span class="name">:limit</span>
225
+ <span class="type">(<tt>limit</tt>)</span>
226
+ <span class="default">
227
+
228
+ </span>
229
+
230
+ &mdash; <div class='inline'>
231
+ <p>Maximum number of elements to return.</p>
232
+ </div>
233
+
234
+ </li>
235
+
236
+ <li>
237
+ <span class="name">:sort</span>
238
+ <span class="type">(<tt>sort</tt>)</span>
239
+ <span class="default">
240
+
241
+ </span>
242
+
243
+ &mdash; <div class='inline'>
244
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
245
+ the beginning to list in ascending or descending order.</p>
246
+ </div>
247
+
248
+ </li>
249
+
250
+ <li>
251
+ <span class="name">:search</span>
252
+ <span class="type">(<tt>search</tt>)</span>
253
+ <span class="default">
254
+
255
+ </span>
256
+
257
+ &mdash; <div class='inline'>
258
+ <p>Looks for elements with the specified string.</p>
259
+ </div>
260
+
261
+ </li>
262
+
263
+ </ul>
264
+
265
+
266
+
267
+ <p class="tag_title">See Also:</p>
268
+ <ul class="see">
269
+
270
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-paths-from-all-lists" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-paths-from-all-lists">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-paths-from-all-lists</a></li>
271
+
272
+ </ul>
273
+
274
+ </div><table class="source_code">
275
+ <tr>
276
+ <td>
277
+ <pre class="lines">
278
+
279
+
280
+ 36
281
+ 37
282
+ 38</pre>
283
+ </td>
284
+ <td>
285
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/lists.rb', line 36</span>
286
+
287
+ <span class='kw'>def</span> <span class='id identifier rubyid_cdb_files'>cdb_files</span><span class='lparen'>(</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>
288
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/lists/files</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
289
+ <span class='kw'>end</span></pre>
290
+ </td>
291
+ </tr>
292
+ </table>
293
+ </div>
294
+
295
+ <div class="method_details ">
296
+ <h3 class="signature " id="cdb_lists-instance_method">
297
+
298
+ #<strong>cdb_lists</strong>(options = {}) &#x21d2; <tt>Object</tt>
299
+
300
+
301
+
302
+
303
+
304
+ </h3><div class="docstring">
305
+ <div class="discussion">
306
+
307
+ <p>Get all lists Returns the content of all CDB lists.</p>
308
+
309
+
310
+ </div>
311
+ </div>
312
+ <div class="tags">
313
+ <p class="tag_title">Parameters:</p>
314
+ <ul class="param">
315
+
316
+ <li>
317
+
318
+ <span class='name'>options</span>
319
+
320
+
321
+ <span class='type'>(<tt>Hash</tt>)</span>
322
+
323
+
324
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
325
+
326
+
327
+ &mdash;
328
+ <div class='inline'>
329
+ <p>a customizable set of options</p>
330
+ </div>
331
+
332
+ </li>
333
+
334
+ </ul>
335
+
336
+
337
+
338
+
339
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
340
+ <ul class="option">
341
+
342
+ <li>
343
+ <span class="name">:offset</span>
344
+ <span class="type">(<tt>offset</tt>)</span>
345
+ <span class="default">
346
+
347
+ </span>
348
+
349
+ &mdash; <div class='inline'>
350
+ <p>First element to return in the collection.</p>
351
+ </div>
352
+
353
+ </li>
354
+
355
+ <li>
356
+ <span class="name">:limit</span>
357
+ <span class="type">(<tt>limit</tt>)</span>
358
+ <span class="default">
359
+
360
+ </span>
361
+
362
+ &mdash; <div class='inline'>
363
+ <p>Maximum number of elements to return.</p>
364
+ </div>
365
+
366
+ </li>
367
+
368
+ <li>
369
+ <span class="name">:sort</span>
370
+ <span class="type">(<tt>sort</tt>)</span>
371
+ <span class="default">
372
+
373
+ </span>
374
+
375
+ &mdash; <div class='inline'>
376
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
377
+ the beginning to list in ascending or descending order.</p>
378
+ </div>
379
+
380
+ </li>
381
+
382
+ <li>
383
+ <span class="name">:search</span>
384
+ <span class="type">(<tt>search</tt>)</span>
385
+ <span class="default">
386
+
387
+ </span>
388
+
389
+ &mdash; <div class='inline'>
390
+ <p>Looks for elements with the specified string.</p>
391
+ </div>
392
+
393
+ </li>
394
+
395
+ <li>
396
+ <span class="name">:path</span>
397
+ <span class="type">(<tt>path</tt>)</span>
398
+ <span class="default">
399
+
400
+ </span>
401
+
402
+ &mdash; <div class='inline'>
403
+ <p>Filters by path.</p>
404
+ </div>
405
+
406
+ </li>
407
+
408
+ </ul>
409
+
410
+
411
+
412
+ <p class="tag_title">See Also:</p>
413
+ <ul class="see">
414
+
415
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-lists" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-lists">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-lists</a></li>
416
+
417
+ </ul>
418
+
419
+ </div><table class="source_code">
420
+ <tr>
421
+ <td>
422
+ <pre class="lines">
423
+
424
+
425
+ 20
426
+ 21
427
+ 22</pre>
428
+ </td>
429
+ <td>
430
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/lists.rb', line 20</span>
431
+
432
+ <span class='kw'>def</span> <span class='id identifier rubyid_cdb_lists'>cdb_lists</span><span class='lparen'>(</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>
433
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/lists</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
434
+ <span class='kw'>end</span></pre>
435
+ </td>
436
+ </tr>
437
+ </table>
438
+ </div>
439
+
440
+ </div>
441
+
442
+ </div>
443
+
444
+ <div id="footer">
445
+ Generated on Sat Jan 25 00:19:40 2020 by
446
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
447
+ 0.9.16 (ruby-2.5.1).
448
+ </div>
449
+
450
+ </div>
451
+ </body>
452
+ </html>