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/Ciscat.html ADDED
@@ -0,0 +1,418 @@
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::Ciscat
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::Ciscat";
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 (C)</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">Ciscat</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::Ciscat
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/ciscat.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="#ciscat_result-instance_method" title="#ciscat_result (instance method)">#<strong>ciscat_result</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>Returns the agent’s ciscat results info.</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="ciscat_result-instance_method">
141
+
142
+ #<strong>ciscat_result</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>Returns the agent’s ciscat results info</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
+ &mdash;
170
+ <div class='inline'>
171
+ <p>ID to agent</p>
172
+ </div>
173
+
174
+ </li>
175
+
176
+ <li>
177
+
178
+ <span class='name'>options</span>
179
+
180
+
181
+ <span class='type'>(<tt>Hash</tt>)</span>
182
+
183
+
184
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
185
+
186
+
187
+ &mdash;
188
+ <div class='inline'>
189
+ <p>a customizable set of options</p>
190
+ </div>
191
+
192
+ </li>
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+
201
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
202
+ <ul class="option">
203
+
204
+ <li>
205
+ <span class="name">:offset</span>
206
+ <span class="type">(<tt>offset</tt>)</span>
207
+ <span class="default">
208
+
209
+ </span>
210
+
211
+ &mdash; <div class='inline'>
212
+ <p>First element to return in the collection.</p>
213
+ </div>
214
+
215
+ </li>
216
+
217
+ <li>
218
+ <span class="name">:limit</span>
219
+ <span class="type">(<tt>limit</tt>)</span>
220
+ <span class="default">
221
+
222
+ </span>
223
+
224
+ &mdash; <div class='inline'>
225
+ <p>Maximum number of elements to return.</p>
226
+ </div>
227
+
228
+ </li>
229
+
230
+ <li>
231
+ <span class="name">:sort</span>
232
+ <span class="type">(<tt>sort</tt>)</span>
233
+ <span class="default">
234
+
235
+ </span>
236
+
237
+ &mdash; <div class='inline'>
238
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
239
+ the beginning to list in ascending or descending order.</p>
240
+ </div>
241
+
242
+ </li>
243
+
244
+ <li>
245
+ <span class="name">:search</span>
246
+ <span class="type">(<tt>search</tt>)</span>
247
+ <span class="default">
248
+
249
+ </span>
250
+
251
+ &mdash; <div class='inline'>
252
+ <p>Looks for elements with the specified string.</p>
253
+ </div>
254
+
255
+ </li>
256
+
257
+ <li>
258
+ <span class="name">:select</span>
259
+ <span class="type">(<tt>select</tt>)</span>
260
+ <span class="default">
261
+
262
+ </span>
263
+
264
+ &mdash; <div class='inline'>
265
+ <p>List of selected fields separated by commas.</p>
266
+ </div>
267
+
268
+ </li>
269
+
270
+ <li>
271
+ <span class="name">:benchmark</span>
272
+ <span class="type">(<tt>benchmark</tt>)</span>
273
+ <span class="default">
274
+
275
+ </span>
276
+
277
+ &mdash; <div class='inline'>
278
+ <p>Filters by benchmark.</p>
279
+ </div>
280
+
281
+ </li>
282
+
283
+ <li>
284
+ <span class="name">:profile</span>
285
+ <span class="type">(<tt>profile</tt>)</span>
286
+ <span class="default">
287
+
288
+ </span>
289
+
290
+ &mdash; <div class='inline'>
291
+ <p>Filters by evaluated profile.</p>
292
+ </div>
293
+
294
+ </li>
295
+
296
+ <li>
297
+ <span class="name">:pass</span>
298
+ <span class="type">(<tt>pass</tt>)</span>
299
+ <span class="default">
300
+
301
+ </span>
302
+
303
+ &mdash; <div class='inline'>
304
+ <p>Filters by passed checks.</p>
305
+ </div>
306
+
307
+ </li>
308
+
309
+ <li>
310
+ <span class="name">:fail</span>
311
+ <span class="type">(<tt>fail</tt>)</span>
312
+ <span class="default">
313
+
314
+ </span>
315
+
316
+ &mdash; <div class='inline'>
317
+ <p>Filters by failed checks.</p>
318
+ </div>
319
+
320
+ </li>
321
+
322
+ <li>
323
+ <span class="name">:error</span>
324
+ <span class="type">(<tt>error</tt>)</span>
325
+ <span class="default">
326
+
327
+ </span>
328
+
329
+ &mdash; <div class='inline'>
330
+ <p>Filters by encountered errors.</p>
331
+ </div>
332
+
333
+ </li>
334
+
335
+ <li>
336
+ <span class="name">:notchecked</span>
337
+ <span class="type">(<tt>notchecked</tt>)</span>
338
+ <span class="default">
339
+
340
+ </span>
341
+
342
+ &mdash; <div class='inline'>
343
+ <p>Filters by not checked.</p>
344
+ </div>
345
+
346
+ </li>
347
+
348
+ <li>
349
+ <span class="name">:unknown</span>
350
+ <span class="type">(<tt>unknown</tt>)</span>
351
+ <span class="default">
352
+
353
+ </span>
354
+
355
+ &mdash; <div class='inline'>
356
+ <p>Filters by unknown results.</p>
357
+ </div>
358
+
359
+ </li>
360
+
361
+ <li>
362
+ <span class="name">:score</span>
363
+ <span class="type">(<tt>score</tt>)</span>
364
+ <span class="default">
365
+
366
+ </span>
367
+
368
+ &mdash; <div class='inline'>
369
+ <p>Filters by final score.</p>
370
+ </div>
371
+
372
+ </li>
373
+
374
+ </ul>
375
+
376
+
377
+
378
+ <p class="tag_title">See Also:</p>
379
+ <ul class="see">
380
+
381
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results-from-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results-from-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results-from-an-agent</a></li>
382
+
383
+ </ul>
384
+
385
+ </div><table class="source_code">
386
+ <tr>
387
+ <td>
388
+ <pre class="lines">
389
+
390
+
391
+ 37
392
+ 38
393
+ 39</pre>
394
+ </td>
395
+ <td>
396
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/ciscat.rb', line 37</span>
397
+
398
+ <span class='kw'>def</span> <span class='id identifier rubyid_ciscat_result'>ciscat_result</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>
399
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/ciscat/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/results</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
400
+ <span class='kw'>end</span></pre>
401
+ </td>
402
+ </tr>
403
+ </table>
404
+ </div>
405
+
406
+ </div>
407
+
408
+ </div>
409
+
410
+ <div id="footer">
411
+ Generated on Sat Jan 25 00:19:40 2020 by
412
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
413
+ 0.9.16 (ruby-2.5.1).
414
+ </div>
415
+
416
+ </div>
417
+ </body>
418
+ </html>