wazuh-ruby-client 0.3.3 → 0.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/codeql-analysis.yml +70 -0
  3. data/CHANGELOG.md +25 -0
  4. data/README.md +18 -1
  5. data/Rakefile +4 -0
  6. data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +10 -13
  7. data/docs/Wazuh/Api/Endpoints/Agents.html +483 -204
  8. data/docs/Wazuh/Api/Endpoints/Cache.html +7 -7
  9. data/docs/Wazuh/Api/Endpoints/Ciscat.html +10 -13
  10. data/docs/Wazuh/Api/Endpoints/Cluster.html +52 -58
  11. data/docs/Wazuh/Api/Endpoints/Decoders.html +27 -39
  12. data/docs/Wazuh/Api/Endpoints/Experimental.html +63 -96
  13. data/docs/Wazuh/Api/Endpoints/Lists.html +15 -21
  14. data/docs/Wazuh/Api/Endpoints/Manager.html +44 -62
  15. data/docs/Wazuh/Api/Endpoints/Rootcheck.html +36 -52
  16. data/docs/Wazuh/Api/Endpoints/Rules.html +49 -68
  17. data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +20 -31
  18. data/docs/Wazuh/Api/Endpoints/Summary.html +7 -7
  19. data/docs/Wazuh/Api/Endpoints/Syscheck.html +26 -33
  20. data/docs/Wazuh/Api/Endpoints/Syscollector.html +43 -61
  21. data/docs/Wazuh/Api/Endpoints/V4/ActiveResponse.html +198 -0
  22. data/docs/Wazuh/Api/Endpoints/V4/Agents.html +1079 -0
  23. data/docs/Wazuh/Api/Endpoints/V4/Cache.html +195 -0
  24. data/docs/Wazuh/Api/Endpoints/V4/Ciscat.html +126 -0
  25. data/docs/Wazuh/Api/Endpoints/V4/Cluster.html +126 -0
  26. data/docs/Wazuh/Api/Endpoints/V4/Decoders.html +126 -0
  27. data/docs/Wazuh/Api/Endpoints/V4/Experimental.html +126 -0
  28. data/docs/Wazuh/Api/Endpoints/V4/Lists.html +126 -0
  29. data/docs/Wazuh/Api/Endpoints/V4/Manager.html +126 -0
  30. data/docs/Wazuh/Api/Endpoints/V4/Rootcheck.html +126 -0
  31. data/docs/Wazuh/Api/Endpoints/V4/Rules.html +126 -0
  32. data/docs/Wazuh/Api/Endpoints/V4/SecurityConfigurationAssessment.html +126 -0
  33. data/docs/Wazuh/Api/Endpoints/V4/Summary.html +126 -0
  34. data/docs/Wazuh/Api/Endpoints/V4/Syscheck.html +126 -0
  35. data/docs/Wazuh/Api/Endpoints/V4/Syscollector.html +126 -0
  36. data/docs/Wazuh/Api/Endpoints/V4/Vulnerabilities.html +399 -0
  37. data/docs/Wazuh/Api/Endpoints/V4.html +403 -0
  38. data/docs/Wazuh/Api/Endpoints.html +9 -14
  39. data/docs/Wazuh/Api/Errors/WazuhError.html +9 -9
  40. data/docs/Wazuh/Api/Errors.html +6 -6
  41. data/docs/Wazuh/Api.html +7 -7
  42. data/docs/Wazuh/Client.html +35 -190
  43. data/docs/Wazuh/Config.html +20 -11
  44. data/docs/Wazuh/Logger.html +6 -6
  45. data/docs/Wazuh/Sawyer/Connection/Token.html +208 -0
  46. data/docs/Wazuh/Sawyer/Connection.html +19 -7
  47. data/docs/Wazuh/Sawyer/Request.html +78 -6
  48. data/docs/Wazuh/Sawyer.html +8 -8
  49. data/docs/Wazuh.html +16 -16
  50. data/docs/WazuhRubyClient.html +7 -7
  51. data/docs/_index.html +149 -7
  52. data/docs/class_list.html +3 -3
  53. data/docs/css/style.css +2 -2
  54. data/docs/file.README.html +39 -18
  55. data/docs/file_list.html +2 -2
  56. data/docs/frames.html +2 -2
  57. data/docs/index.html +39 -18
  58. data/docs/js/app.js +25 -3
  59. data/docs/method_list.html +269 -69
  60. data/docs/top-level-namespace.html +6 -6
  61. data/lib/wazuh/api/endpoints/v4/vulnerabilities.rb +47 -0
  62. data/lib/wazuh/api/endpoints/v4.rb +2 -1
  63. data/lib/wazuh/version.rb +1 -1
  64. data/lib/wazuh-ruby-client/version.rb +1 -1
  65. metadata +25 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a1913446c22b5d499a25ad14253020584d44c4c8417ca05d052613d18317f72b
4
- data.tar.gz: 1b36d8f8243dada48a19234e923f54976862c734d34c8a5f8a0478e094a46b2d
3
+ metadata.gz: e5378e67cd9073d90868662fe577ddafdbbd774f5813ae4883646fb1573804ef
4
+ data.tar.gz: 475ab3b706db3da28ba4bf80f1234e2d3ebe37f5e94d73c5cef98e87f51fd2f5
5
5
  SHA512:
6
- metadata.gz: ecbc00e35e33f917a117938e79ac3e8ba6327e8387d92592d4b9510bf8b753bf93800f329d88573e1b94c0f51687fc92deec492fa11bf3ac4f62eeeeb4e0a155
7
- data.tar.gz: abedc111b0e09e7e7963885d004039227ef8add25bd501c623c8224625ba00e55222cc9e83bcb7205929185058c0d2759e97d939c6ea08dd68fb44cc99695df0
6
+ metadata.gz: b5cdd839f283f03626900446db96eb040ba368664c1110a3f04bb4e31468f7e9f01cba0382006c79f074a9c14dcfed2344e2d302010d780b2dcfe8e237ac4273
7
+ data.tar.gz: d6443f7b6f466542b8e705b18318fef5444ec8309afa3631db0188391013955496b8c5ad04a88efdf1dc49391c648dea5523e8ffe9441f00064f85ff8e0b8bad
@@ -0,0 +1,70 @@
1
+ # For most projects, this workflow file will not need changing; you simply need
2
+ # to commit it to your repository.
3
+ #
4
+ # You may wish to alter this file to override the set of languages analyzed,
5
+ # or to provide custom queries or build logic.
6
+ #
7
+ # ******** NOTE ********
8
+ # We have attempted to detect the languages in your repository. Please check
9
+ # the `language` matrix defined below to confirm you have the correct set of
10
+ # supported CodeQL languages.
11
+ #
12
+ name: "CodeQL"
13
+
14
+ on:
15
+ push:
16
+ branches: [ master ]
17
+ pull_request:
18
+ # The branches below must be a subset of the branches above
19
+ branches: [ master ]
20
+ schedule:
21
+ - cron: '40 20 * * 5'
22
+
23
+ jobs:
24
+ analyze:
25
+ name: Analyze
26
+ runs-on: ubuntu-latest
27
+ permissions:
28
+ actions: read
29
+ contents: read
30
+ security-events: write
31
+
32
+ strategy:
33
+ fail-fast: false
34
+ matrix:
35
+ language: [ 'ruby' ]
36
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37
+ # Learn more about CodeQL language support at https://git.io/codeql-language-support
38
+
39
+ steps:
40
+ - name: Checkout repository
41
+ uses: actions/checkout@v2
42
+
43
+ # Initializes the CodeQL tools for scanning.
44
+ - name: Initialize CodeQL
45
+ uses: github/codeql-action/init@v1
46
+ with:
47
+ languages: ${{ matrix.language }}
48
+ # If you wish to specify custom queries, you can do so here or in a config file.
49
+ # By default, queries listed here will override any specified in a config file.
50
+ # Prefix the list here with "+" to use these queries and those in the config file.
51
+ # queries: ./path/to/local/query, your-org/your-repo/queries@main
52
+
53
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
54
+ # If this step fails, then you should remove it and run the build manually (see below)
55
+ - name: Autobuild
56
+ uses: github/codeql-action/autobuild@v1
57
+
58
+ # ℹ️ Command-line programs to run using the OS shell.
59
+ # 📚 https://git.io/JvXDl
60
+
61
+ # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
62
+ # and modify them (or add more) to build your code if your project
63
+ # uses a compiled language
64
+
65
+ #- run: |
66
+ # make bootstrap
67
+ # make release
68
+
69
+ - name: Perform CodeQL Analysis
70
+ uses: github/codeql-action/analyze@v1
data/CHANGELOG.md CHANGED
@@ -7,6 +7,31 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [0.3.4]
11
+
12
+ Support Vulnerability API.
13
+
14
+ - [Support Vulnerability API by mrtc0 · Pull Request #33 · mrtc0/wazuh-ruby-client](https://github.com/mrtc0/wazuh-ruby-client/pull/33)
15
+
16
+ ## [0.3.3]
17
+
18
+
19
+ ## [0.3.2]
20
+
21
+ Bug fix.
22
+
23
+ - [Couldn't support proc object in old faraday · mrtc0/wazuh-ruby-client@d601b09](https://github.com/mrtc0/wazuh-ruby-client/commit/d601b090bfa9a74d3fb24d0534ce9f4ac5f454f6)
24
+
25
+ ## [0.3.1]
26
+
27
+ Bug fix.
28
+
29
+ - [Base64.encode is included return code #30](https://github.com/mrtc0/wazuh-ruby-client/pull/30)
30
+
31
+ ## [0.3.0]
32
+
33
+ - Support some v4 API (Thanks @pyama86)
34
+
10
35
  ## [0.2.9]
11
36
 
12
37
  - Adds availability to ignore env proxy settings [#25](https://github.com/mrtc0/wazuh-ruby-client/pull/25). Thanks @falegk
data/README.md CHANGED
@@ -23,6 +23,8 @@ Wazuh.configure do |config|
23
23
  config.basic_user = "foo"
24
24
  config.basic_password = "bar"
25
25
  config.verify_ssl = false
26
+ # if you are using the Wazuh version 4
27
+ # config.api_version = 4
26
28
  end
27
29
 
28
30
  client = Wazuh::Client.new
@@ -72,6 +74,7 @@ The following global settings are supported via `Wazuh.configure` .
72
74
  | logger | loggeer object |
73
75
  | endpoint | Wazuh API endpoint URL |
74
76
  | ignore_env_proxy | Ignores ENV proxy settings |
77
+ | api_version | Wazuh API Version (3 or 4) |
75
78
 
76
79
 
77
80
  ### Agents
@@ -151,9 +154,17 @@ List agents' processes.
151
154
  ...
152
155
  ```
153
156
 
157
+ ### Vulnerability
158
+
159
+ ```ruby
160
+ > client.vulnerabilities('000')
161
+ => [{:architecture=>"amd64", :cve=>"CVE-2016-4802", :name=>"curl", :version=>"7.47.0-1ubuntu2.14"}, {:architecture=>"amd64", :cve=>"CVE-2016-8620", :name=>"curl", :version=>"7.47.0-1ubun...
162
+ ```
163
+
154
164
  ### Other
155
165
 
156
- wazuh-ruby-client is support to all Wazuh API.
166
+ wazuh-ruby-client is supports some of the Wazuh API.
167
+ The v4 API is not yet supported.
157
168
 
158
169
  - [x] Active Response
159
170
  - [x] Agents
@@ -162,14 +173,20 @@ wazuh-ruby-client is support to all Wazuh API.
162
173
  - [x] Cluster
163
174
  - [x] Decoders
164
175
  - [x] Experimental
176
+ - [ ] Groups
165
177
  - [x] Lists
178
+ - [ ] Logtest
179
+ - [ ] Mitre
166
180
  - [x] Manager
167
181
  - [x] Rootcheck
168
182
  - [x] Rules
183
+ - [ ] Security
169
184
  - [x] Security Configuration Assessment
170
185
  - [x] Summary
171
186
  - [x] Syscheck
172
187
  - [x] Syscollector
188
+ - [ ] Tasks
189
+ - [x] Vulnerability
173
190
 
174
191
  Refer to the document of wazuh-ruby-client and Wazuh API Reference for the list of all available methods.
175
192
 
data/Rakefile CHANGED
@@ -4,3 +4,7 @@ require "rspec/core/rake_task"
4
4
  RSpec::Core::RakeTask.new(:spec)
5
5
 
6
6
  task :default => :spec
7
+
8
+ task :doc do
9
+ sh %{yardoc 'lib/**/*.rb' --output docs}
10
+ end
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  Module: Wazuh::Api::Endpoints::ActiveResponse
8
8
 
9
- &mdash; Documentation by YARD 0.9.16
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "Wazuh::Api::Endpoints::ActiveResponse";
19
19
  relpath = '../../../';
20
20
  </script>
@@ -76,7 +76,7 @@
76
76
 
77
77
  <dl>
78
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>
79
+ <dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span>, <span class='object_link'><a href="V4/ActiveResponse.html" title="Wazuh::Api::Endpoints::V4::ActiveResponse (module)">V4::ActiveResponse</a></span></dd>
80
80
  </dl>
81
81
 
82
82
 
@@ -121,8 +121,7 @@
121
121
 
122
122
 
123
123
  <span class="summary_desc"><div class='inline'>
124
- <p>Run an AR command in the agent Runs an Active Response command on a
125
- specified agent.</p>
124
+ <p>Run an AR command in the agent Runs an Active Response command on a specified agent.</p>
126
125
  </div></span>
127
126
 
128
127
  </li>
@@ -149,8 +148,7 @@ specified agent.</p>
149
148
  </h3><div class="docstring">
150
149
  <div class="discussion">
151
150
 
152
- <p>Run an AR command in the agent Runs an Active Response command on a
153
- specified agent.</p>
151
+ <p>Run an AR command in the agent Runs an Active Response command on a specified agent.</p>
154
152
 
155
153
 
156
154
  </div>
@@ -206,8 +204,7 @@ specified agent.</p>
206
204
  </span>
207
205
 
208
206
  &mdash; <div class='inline'>
209
- <p>Command running in the agent. If this value starts by !, then it refers to
210
- a script name instead of a command name.</p>
207
+ <p>Command running in the agent. If this value starts by !, then it refers to a script name instead of a command name.</p>
211
208
  </div>
212
209
 
213
210
  </li>
@@ -268,9 +265,9 @@ a script name instead of a command name.</p>
268
265
  </div>
269
266
 
270
267
  <div id="footer">
271
- Generated on Tue Feb 18 20:12:28 2020 by
268
+ Generated on Thu Feb 3 21:40:18 2022 by
272
269
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
273
- 0.9.16 (ruby-2.5.1).
270
+ 0.9.25 (ruby-2.6.3).
274
271
  </div>
275
272
 
276
273
  </div>