wazuh-ruby-client 0.3.2 → 0.3.5

data/docs/top-level-namespace.html

@@ -6,15 +6,15 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.16
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "";
   relpath = '';
 </script>
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 18 20:12:27 2020 by
+  Generated on Thu Feb  3 21:40:17 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.1).
+  0.9.25 (ruby-2.6.3).
 </div>
 
     </div>

data/lib/wazuh/api/endpoints/agents.rb

@@ -4,7 +4,7 @@ module Wazuh
       module Agents
         #
         # Returns a list with the available agents.
-        # 
+        #
         # @option options [String] :offset
         #   First element to return in the collection.
         # @option options [String] :limit

data/lib/wazuh/api/endpoints/rootcheck.rb

@@ -21,7 +21,7 @@ module Wazuh
         end
 
         # Get last rootcheck scan
-        # Returns the timestamp of the last rootcheck scan. 
+        # Returns the timestamp of the last rootcheck scan.
         #
         # @param [String] agent_id
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-rootcheck-scan

data/lib/wazuh/api/endpoints/security_configuration_assessment.rb

@@ -15,7 +15,7 @@ module Wazuh
         #   Filters by policy description
         # @option options [rationale] :rationale
         #   Filters by rationale
-        # @option options [remediation] :remediation 
+        # @option options [remediation] :remediation
         #   Filters by remediation
         # @option options [file] :file
         #   Filters by file

data/lib/wazuh/api/endpoints/syscollector.rb

@@ -216,7 +216,7 @@ module Wazuh
         #   Filters by process sgroup.
         # @option options [suser] :suser
         #   Filters by process suser.
-        # 
+        #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info
         def processes(agent_id, options = {})
           offset_request('get', "/syscollector/#{agent_id}/processes", options)

data/lib/wazuh/api/endpoints/v4/cluster.rb

@@ -4,6 +4,133 @@ module Wazuh
       module V4
         module Cluster
           include ::Wazuh::Api::Endpoints::Cluster
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_cluster_node
+          def local_node_info(options = {})
+            offset_request('get', '/cluster/local/info', options)
+          end
+
+          alias_method :get_cluster_node, :local_node_info
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_cluster_nodes
+          def nodes_info(options = {})
+            offset_request('get', '/cluster/nodes', options)
+          end
+
+          alias_method :get_cluster_nodes, :nodes_info
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_healthcheck
+          def nodes_healthcheck(options = {})
+            offset_request('get', '/cluster/healthcheck', options)
+          end
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_status
+          def cluster_status(options = {})
+            get '/cluster/status', options
+          end
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_config
+          def local_node_config(options = {})
+            offset_request('get', '/cluster/local/config', options)
+          end
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_api_config
+          def nodes_api_config(options = {})
+            offset_request('get', '/cluster/api/config', options)
+          end
+
+          alias_method :get_api_config, :nodes_api_config
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_status_node
+          def node_status(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/status", options)
+          end
+
+          alias_method :get_status_node, :node_status
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_info_node
+          def node_info(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/info", options)
+          end
+
+          alias_method :get_info_node, :node_info
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_configuration_node
+          def node_config(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/configuration", options)
+          end
+
+          alias_method :get_configuration_node, :node_config
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_node
+          def node_stats(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats", options)
+          end
+
+          alias_method :get_stats_node, :node_stats
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_hourly_node
+          def node_stats_hour(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/hourly", options)
+          end
+
+          alias_method :get_stats_hourly_node, :node_stats_hour
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_weekly_node
+          def node_stats_week(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/weekly", options)
+          end
+
+          alias_method :get_stats_weekly_node, :node_stats_week
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_analysisd_node
+          def node_stats_analysisd(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/analysisd", options)
+          end
+
+          alias_method :get_stats_analysisd_node, :node_stats_analysisd
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_remoted_node
+          def node_stats_remoted(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/remoted", options)
+          end
+
+          alias_method :get_stats_remoted_node, :node_stats_remoted
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_log_node
+          def node_logs(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/logs", options)
+          end
+
+          alias_method :get_log_node, :node_logs
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_log_summary_node
+          def node_logs_summary(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/logs/summary", options)
+          end
+
+          alias_method :get_log_summary_node, :node_logs_summary
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.put_restart
+          def restart_nodes(options = {})
+            offset_request('put', "/cluster/restart", options)
+          end
+
+          alias_method :put_restart, :restart_nodes
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_conf_validation
+          def check_nodes_config(options = {})
+            offset_request('get', "/cluster/configuration/validationj", options)
+          end
+
+          alias_method :get_conf_validation, :check_nodes_config
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_node_config
+          def node_active_configuration(node_id, component, configuration, options = {})
+            offset_request('get', "/cluster/#{node_id}/configuration/#{component}/#{configuration}", options)
+          end
+
+          alias_method :get_node_config, :node_active_configuration
         end
       end
     end

data/lib/wazuh/api/endpoints/v4/vulnerabilities.rb

@@ -0,0 +1,47 @@
+module Wazuh
+  module Api
+    module Endpoints
+      module V4
+        module Vulnerabilities
+          # Get vulnerabilities
+          # Returns the vulnerabilities of an agent
+          #
+          # @param [String] agent_id
+          # @option options [wait_for_complete] :wait_for_complete
+          #   Disable timeout response
+          # @option options [offset] :offset
+          #   First element to return in the collection
+          # @option options [limit] :limit
+          #   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.
+          # @option options [sort] :sort
+          #   Sort the collection by a field or fields (separated by comma).
+          #   Use +/- at the beggining to list in ascending or descending order. Use '.' for nested fields.
+          #   For example, '{field1: field2}' may be selected with 'field1.field2'
+          # @option options [search] :search
+          #   Look for elements containing the specified string.
+          #   To obtain a complementary search, use '-' at the beggining
+          # @option options [select] :select
+          #   Select which fields to return (separated by comma).
+          #   Use '.' for nested fields. For example, '{field1: field2}' may be selected with 'field1.field2'
+          # @option options [q] :q
+          #   Query to filter results by. For example q="status=active"
+          # @option options [distinct] :distinct
+          #   Look for distinct values.
+          # @option options [architecture] :architecture
+          #   Filter by architecture
+          # @option options [cve] :cve
+          #   Filter by CVE
+          # @option options [name] :name
+          #   Filter by name
+          # @option options [version] :version
+          #   Filter by CVE version
+          # @see https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.vulnerability_controller.get_vulnerability_agent
+          def vulnerabilities(agent_id, options = {})
+            offset_request('get', "/vulnerability/#{agent_id}", options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wazuh/api/endpoints/v4.rb

@@ -13,7 +13,7 @@ require_relative 'v4/security_configuration_assessment'
 require_relative 'v4/summary'
 require_relative 'v4/syscheck'
 require_relative 'v4/syscollector'
-
+require_relative 'v4/vulnerabilities'
 
 module Wazuh
   module Api
@@ -34,6 +34,7 @@ module Wazuh
         include Syscheck
         include Syscollector
         include SecurityConfigurationAssessment
+        include Vulnerabilities
       end
     end
   end

data/lib/wazuh/client.rb

@@ -31,4 +31,3 @@ module Wazuh
     end
   end
 end
-

data/lib/wazuh/sawyer/connection.rb

@@ -18,7 +18,7 @@ module Wazuh
         options[:ssl].merge!({ verify: false }) unless verify_ssl
 
         opts = {
-          :links_parser => ::Sawyer::LinkParsers::Simple.new
+          links_parser: ::Sawyer::LinkParsers::Simple.new
         }
 
         case api_version
@@ -29,7 +29,7 @@ module Wazuh
         when 4
           raise "user and password is required on v4 api" if !basic_user || !basic_password
           opts[:faraday] = ::Faraday.new(options) do |conn|
-            conn.request :authorization, 'Bearer', -> { Token.jwt(endpoint, options, basic_user, basic_password) }
+            conn.request :authorization, 'Bearer', Token.jwt(endpoint, options, basic_user, basic_password)
           end
         end
 

data/lib/wazuh/sawyer/request.rb

@@ -2,49 +2,55 @@
 module Wazuh
   module Sawyer
     module Request
+      MAX_ITEM_NUM = 500
+
       def get(path, options = {})
-        request(:get, path, options)
+        request(:get, path, options).data
       end
 
       def post(path, options = {})
-        request(:post, path, options)
+        request(:post, path, options).data
       end
 
       def put(path, options = {})
-        request(:put, path, options)
+        request(:put, path, options).data
       end
 
       def delete(path, options = {})
-        request(:delete, path, options)
+        request(:delete, path, options).data
       end
 
+      # The response format is different for v3 and v4.
+      # In v3, it is a camel case like `totalItems` and `items`,
+      # but in v4, it is snake case like total_affected_items.
+      # offset_request will fill this gap.
+      # This function is used if there are `affected_items` or `items` in the response.
       def offset_request(method, path, options = {})
         items = []
         data = send(method, path, options)
         total_items = api_version == 3 ? data.totalItems : data.total_affected_items
-        0.step(total_items, 500) { |offset|
+        0.step(total_items, MAX_ITEM_NUM) do |offset|
           options[:offset] = offset
           d = send(method, path, options)
           _items = api_version == 3 ? data.items : d.affected_items
           items.concat(_items)
-        }
+        end
 
         items
       end
 
-
       private
 
       def request(method, path, options, query_options={})
         response = case method
-        when :get, :delete
-          connection.call(method, URI::Parser.new.escape(path), nil, {query: options})
-        when :post, :put
-          data = options unless options.empty?
-          connection.call(method, URI::Parser.new.escape(path), data, {query: query_options})
-        end
-
-        return response.data.data if response.status == 200
+                   when :get, :delete
+                     connection.call(method, URI::Parser.new.escape(path), nil, {query: options})
+                   when :post, :put
+                     data = options unless options.empty?
+                     connection.call(method, URI::Parser.new.escape(path), data, {query: query_options})
+                   end
+
+        return response.data if response.status == 200
 
         raise Wazuh::Api::Errors::WazuhError.new(response.body, response)
       end

data/lib/wazuh/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Wazuh
-  VERSION = '0.3.2'
+  VERSION = '0.3.5'
 end

data/lib/wazuh-ruby-client/version.rb

@@ -1,3 +1,3 @@
 module WazuhRubyClient
-  VERSION = "0.3.2"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wazuh-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.5
 platform: ruby
 authors:
 - mrtc0
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -185,10 +185,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/rspec-ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -212,6 +213,23 @@ files:
 - docs/Wazuh/Api/Endpoints/Summary.html
 - docs/Wazuh/Api/Endpoints/Syscheck.html
 - docs/Wazuh/Api/Endpoints/Syscollector.html
+- docs/Wazuh/Api/Endpoints/V4.html
+- docs/Wazuh/Api/Endpoints/V4/ActiveResponse.html
+- docs/Wazuh/Api/Endpoints/V4/Agents.html
+- docs/Wazuh/Api/Endpoints/V4/Cache.html
+- docs/Wazuh/Api/Endpoints/V4/Ciscat.html
+- docs/Wazuh/Api/Endpoints/V4/Cluster.html
+- docs/Wazuh/Api/Endpoints/V4/Decoders.html
+- docs/Wazuh/Api/Endpoints/V4/Experimental.html
+- docs/Wazuh/Api/Endpoints/V4/Lists.html
+- docs/Wazuh/Api/Endpoints/V4/Manager.html
+- docs/Wazuh/Api/Endpoints/V4/Rootcheck.html
+- docs/Wazuh/Api/Endpoints/V4/Rules.html
+- docs/Wazuh/Api/Endpoints/V4/SecurityConfigurationAssessment.html
+- docs/Wazuh/Api/Endpoints/V4/Summary.html
+- docs/Wazuh/Api/Endpoints/V4/Syscheck.html
+- docs/Wazuh/Api/Endpoints/V4/Syscollector.html
+- docs/Wazuh/Api/Endpoints/V4/Vulnerabilities.html
 - docs/Wazuh/Api/Errors.html
 - docs/Wazuh/Api/Errors/WazuhError.html
 - docs/Wazuh/Client.html
@@ -219,6 +237,7 @@ files:
 - docs/Wazuh/Logger.html
 - docs/Wazuh/Sawyer.html
 - docs/Wazuh/Sawyer/Connection.html
+- docs/Wazuh/Sawyer/Connection/Token.html
 - docs/Wazuh/Sawyer/Request.html
 - docs/WazuhRubyClient.html
 - docs/_index.html
@@ -269,6 +288,7 @@ files:
 - lib/wazuh/api/endpoints/v4/summary.rb
 - lib/wazuh/api/endpoints/v4/syscheck.rb
 - lib/wazuh/api/endpoints/v4/syscollector.rb
+- lib/wazuh/api/endpoints/v4/vulnerabilities.rb
 - lib/wazuh/api/error.rb
 - lib/wazuh/api/errors/wazuh_error.rb
 - lib/wazuh/client.rb

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.17.3