wazuh-ruby-client 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee6623bb491081899d0769df71e12fca755e9dc68bf86b6dfb1a36fc8e0a3ad
-  data.tar.gz: c9536ba23160a14a47c8f41ba6846edde3b49dbf1c6d008d66be3c177dec1655
+  metadata.gz: 57ef8d1a92fc16dc1b46148569a6b6b4f3c9fe4ca1729ad705205efc5952f15c
+  data.tar.gz: 5303f74c914950dcf658b69922dfae54940456dee9f60c30441f1971a9b9e849
 SHA512:
-  metadata.gz: 623e3f6a34bfc98fed98cf08f0c4ec2adfcf20d28bcab4b5d0b3a68d36219d75271ba44212428246b629fff74d284221e0322a49213cf52121f12f8733a2bd42
-  data.tar.gz: 7527db0567ed152561ee7d372e95fec140998fab2e21c814c447e53f3bad0740b24193aaef950107189bb89420d11516e6fd2f76fc0a9bafea4708d0a122887b
+  metadata.gz: 7d81defd979d50b0d95d3654e95a61085a866018a513e0281e15036eb97bb8a1b30d42969db9d8f496329b6f7002aa21f3e6931b5c805adb8c4f7924113fcfa3
+  data.tar.gz: dafe1028ee3baf8ab58621abdbef71bd8793bd1fadc866021c0b6f729be5349e93d07b52f0b395e8f498bdf2e72a3310573376435a42cc658bb8da5950ae1c97

data/.github/workflows/rspec-ci.yml

@@ -8,10 +8,10 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Set up Ruby 2.6.5
+    - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6.5
+        ruby-version: 2.6
 
     - name: Install bundler2
       run: gem install bundler

data/.gitignore

@@ -15,6 +15,8 @@ Gemfile.lock
 *.crt
 *.key
 *.ca
+*.bak
 .env
 .bundle
 .DS_Store
+log

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.2.5]
+
+- Get all items with `offset_request`
+  - So far only 500 items(Wazuh API default) have been retrieved that contain a `totalItems` field such as `#all_agents` .
+  - For such an endpoint, implemented `offset_request` to fetch all items.
+  - This change does not change the type of the return value. However, it may take some time because it sends repeated requests to get all the items.
+
 ## [0.2.4] - 2020-03-31
 
 - `agents_by_group` also returns the `item` field.

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

@@ -1,3 +1,3 @@
 module WazuhRubyClient
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

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

@@ -23,8 +23,7 @@ module Wazuh
         # @return [Array] Returns Array containing agents
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-agents
         def all_agents(options = {})
-          data = get '/agents', options
-          data.items
+          offset_request('get', '/agents', options)
         end
 
         # Returns various information from an agent.
@@ -290,8 +289,7 @@ module Wazuh
         # @option options [String] q
         # @see https://documentation.wazuh.com/3.11/user-manual/api/reference.html#get-agents-in-a-group
         def agents_by_group(group_id, options = {})
-          data = get "/agents/groups/#{group_id}", options
-          data.items
+          offset_request('get', "/agents/groups/#{group_id}", options)
         end
 
         # Get agents without group

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

@@ -35,8 +35,7 @@ module Wazuh
         #   Filters by final score.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results-from-an-agent
         def ciscat_result(agent_id, options = {})
-          data = get "/ciscat/#{agent_id}/results", options
-          data.items
+          offset_request("get", "/ciscat/#{agent_id}/results", options)
         end
       end
     end

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

@@ -116,8 +116,7 @@ module Wazuh
         # @option options [category] :category
         #   Filters by category of log
         def cluster_logs_by_node(node_id, options)
-          data = get "/cluster/#{node_id}/logs", options
-          data.items
+          offset_request("get", "/cluster/#{node_id}/logs", options)
         end
 
         # Get summary of ossec.log from a specific node in cluster
@@ -142,8 +141,7 @@ module Wazuh
         # Get nodes info
         #
         def nodes(options = {})
-          data = get '/cluster/nodes', options
-          data.items
+          offset_request('get', '/cluster/nodes', options)
         end
 
         # Restart a specific node in cluster

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

@@ -23,8 +23,7 @@ module Wazuh
         #   Allowed values: enabled, disabled, all
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders
         def all_decoders(options = {})
-          data = get '/decoders', options
-          data.items
+          offset_request("get", "/decoders", options)
         end
 
         # Get all decoders files
@@ -50,8 +49,7 @@ module Wazuh
         #   Name of the decoder file to download.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders-files
         def all_decoders_files(options = {})
-          data = get '/decoders/files', options
-          data.items
+          offset_request('get', '/decoders/files', options)
         end
 
         # Get all parent decoders
@@ -67,8 +65,7 @@ module Wazuh
         #   Looks for elements with the specified string.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-parent-decoders
         def all_parent_decoders(options = {})
-          data = get '/decoders/parents', options
-          data.items
+          offset_request('get', '/decoders/parents', options)
         end
 
         # Get decoders by name
@@ -86,8 +83,7 @@ module Wazuh
         #   Looks for elements with the specified string.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-decoders-by-name
         def decoders_by_name(decoder_name, options = {})
-          data = get "/decoders/#{decoder_name}", options
-          data.items
+          offset_request("get", "/decoders/#{decoder_name}", options)
         end
       end
     end

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

@@ -42,8 +42,7 @@ module Wazuh
         #   Filters by board_serial.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info-of-all-agents
         def experimental_hardware(options = {})
-          data = get '/experimental/syscollector/hardware', options
-          data.items
+          offset_request('get', '/experimental/syscollector/hardware', options)
         end
 
         # Get network address info of all agents
@@ -72,8 +71,7 @@ module Wazuh
         #   Filters by netmask.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-all-agents
         def experimental_netaddr(options = {})
-          data = get '/experimental/syscollector/netaddr', options
-          data.items
+          offset_request('get', '/experimental/syscollector/netaddr', options)
         end
 
         # Get network interface info of all agents
@@ -109,8 +107,7 @@ module Wazuh
         # @option options [rx_dropped] :rx_dropped
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-all-agents
         def experimental_netiface(options = {})
-          data = get '/experimental/syscollector/netiface', options
-          data.items
+          offset_request('get', '/experimental/syscollector/netiface', options)
         end
 
         # Get network protocol info of all agents
@@ -137,8 +134,7 @@ module Wazuh
         #   Filters by dhcp.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-all-agents
         def experimental_netproto(options = {})
-          data = get '/experimental/syscollector/netproto', options
-          data.items
+          offset_request('get', '/experimental/syscollector/netproto', options)
         end
 
         # Get os info of all agents
@@ -168,8 +164,7 @@ module Wazuh
         #   Filters by release.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info-of-all-agents
         def experimental_os(options = {})
-          data = get '/experimentalsyscollector/os', options
-          data.items
+          offset_request('get', '/experimentalsyscollector/os', options)
         end
 
         # Get packages info of all agents
@@ -198,8 +193,7 @@ module Wazuh
         #   Filters by format.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info-of-all-agents
         def experimental_packages(options = {})
-          data = get '/experimental/syscollector/packages', options
-          data.items
+          offset_request('get', '/experimental/syscollector/packages', options)
         end
 
         # Get ports info of all agents
@@ -232,8 +226,7 @@ module Wazuh
         #   Filters by state.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-all-agents
         def experimental_ports(options = {})
-          data = get '/experimental/syscollector/ports', options
-          data.items
+          offset_request('get', '/experimental/syscollector/ports', options)
         end
 
         # Get processes info of all agents
@@ -280,8 +273,7 @@ module Wazuh
         #   Filters by process suser.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info-of-all-agents
         def experimental_processes(options = {})
-          data = get '/experimental/syscollector/processes', options
-          data.items
+          offset_request('get', '/experimental/syscollector/processes', options)
         end
 
         # Get CIS-CAT results
@@ -309,8 +301,7 @@ module Wazuh
         # @option options [score] :score
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results
         def experimental_ciscat_results(options = {})
-          data = get '/experimental/ciscat/results', options
-          data.items
+          offset_request('get', '/experimental/ciscat/results', options)
         end
       end
     end

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

@@ -18,8 +18,7 @@ module Wazuh
         #   Filters by path.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-lists
         def cdb_lists(options = {})
-          data = get '/lists', options
-          data.items
+          offset_request('get', '/lists', options)
         end
 
         # Get paths from all lists
@@ -35,8 +34,7 @@ module Wazuh
         #   Looks for elements with the specified string.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-paths-from-all-lists
         def cdb_files_path(options = {})
-          data = get '/lists/files', options
-          data.items
+          offset_request('get', '/lists/files', options)
         end
       end
     end

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

@@ -90,8 +90,7 @@ module Wazuh
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ossec-log
         def manager_log
-          data = get '/manager/logs'
-          data.items
+          offset_request('get', '/manager/logs')
         end
 
         # Get summary of ossec.log

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

@@ -39,8 +39,7 @@ module Wazuh
         # @option options [search] :search
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-cis-requirements
         def rootcheck_cis_requirements(agent_id, options = {})
-          data = get "/rootcheck/#{agent_id}/cis", options
-          data.items
+          offset_request('get', "/rootcheck/#{agent_id}/cis", options)
         end
 
         # Get rootcheck database
@@ -56,8 +55,7 @@ module Wazuh
         # @option options [status] :status
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-database
         def rootcheck_database(agent_id, options = {})
-          data = get "/rootcheck/#{agent_id}", options
-          data.items
+          offset_request('get', "/rootcheck/#{agent_id}", options)
         end
 
         # Get rootcheck pci requirements
@@ -70,8 +68,7 @@ module Wazuh
         # @option options [search] :search
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-pci-requirements
         def rootcheck_pic_requirements(agent_id, options = {})
-          data = get "/rootcheck/#{agent_id}/pci", options
-          data.items
+          offset_request('get', "/rootcheck/#{agent_id}/pci", options)
         end
 
         # Run rootcheck scan in all agents

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

@@ -7,64 +7,56 @@ module Wazuh
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-rules
         def all_rules(options = {})
-          data = get '/rules', options
-          data.items
+          offset_request('get', '/rules', options)
         end
 
         # Returns the files of all rules.
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-files-of-rules
         def rule_files(options = {})
-          data = get '/rules/files', options
-          data.items
+          offset_request('get', '/rules/files', options)
         end
 
         # Returns the GDPR requirements of all rules.
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rule-gdpr-requirements
         def gdpr_rules(options = {})
-          data = get '/rules/gdpr', options
-          data.items
+          offset_request('get', '/rules/gdpr', options)
         end
 
         # Returns the GPG13 requirements of all rules.
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rule-gpg13-requirements
         def gpg13_rules(options = {})
-          data = get '/rules/gpg13', options
-          data.items
+          offset_request('get', '/rules/gpg13', options)
         end
 
         # Returns the groups of all rules.
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rule-groups
         def rules_groups(options = {})
-          data = get '/rules/groups', options
-          data.items
+          offset_request('get', '/rules/groups', options)
         end
 
         # Returns the HIPAA requirements of all rules.
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rule-hipaa-requirements
         def hipaa_rules(options = {})
-          data = get '/rules/hipaa', options
-          data.items
+          offset_request('get', '/rules/hipaa', options)
         end
 
         # Returns the NIST-800-53 requirements of all rules.
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rule-nist-800-53-requirements
         def nist_800_53_rules(options = {})
-          data = get '/rules/nist-800-53', options
-          data.items
+         offset_request('get', '/rules/nist-800-53', options)
         end
 
         # Returns the PCI requirements of all rules
         #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rule-pci-requirements
         def pic_rules(options = {})
-          data = get '/rules/pci', options
-          data.items
+          offset_request('get', '/rules/pci', options)
         end
 
         # Returns the rules with the specified id.
@@ -80,8 +72,7 @@ module Wazuh
         #   Looks for elements with the specified string.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rules-by-id
         def rule_by_id(rule_id, options = {})
-          data = get "/rules/#{rule_id}", options
-          data.items
+          offset_request('get', "/rules/#{rule_id}", options)
         end
       end
     end

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

@@ -39,8 +39,7 @@ module Wazuh
         #   Looks for elements with the specified string.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-security-configuration-assessment-sca-checks-database
         def checks_sca_database(agent_id, policy_id, options = {})
-          data = get "/sca/#{agent_id}/checks/#{policy_id}", options
-          data.items
+          offset_request('get', "/sca/#{agent_id}/checks/#{policy_id}", options)
         end
 
         # Get security configuration assessment (SCA) database
@@ -66,8 +65,7 @@ module Wazuh
         #   Query to filter results by. This is specially useful to filter by total checks passed, failed or total score (fields pass, fail, score).
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-security-configuration-assessment-sca-database
         def sca_database(agent_id, options = {})
-          data = get "/sca/#{agent_id}", options
-          data.items
+          offset_request('get', "/sca/#{agent_id}", options)
         end
       end
     end

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

@@ -33,8 +33,7 @@ module Wazuh
         #   Returns the files with the specified hash (md5, sha1 or sha256).
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-syscheck-files
         def syscheck_files(agent_id, options = {})
-          data = get "/syscheck/#{agent_id}", options
-          data.items
+          offset_request('get', "/syscheck/#{agent_id}", options)
         end
 
         # Clears the syscheck database for the specified agent.

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

@@ -38,8 +38,7 @@ module Wazuh
         #   Filters by netmask.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-an-agent
         def netaddr(agent_id, options = {})
-          data = get "/syscollector/#{agent_id}/netaddr", options
-          data.items
+          offset_request('get', "/syscollector/#{agent_id}/netaddr", options)
         end
 
         # Returns the agent’s network interface info
@@ -75,8 +74,7 @@ module Wazuh
         # @option options [rx_dropped] :rx_dropped
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-an-agent
         def netiface(agent_id, options = {})
-          data = get "/syscollector/#{agent_id}/netiface", options
-          data.items
+          offset_request('get', "/syscollector/#{agent_id}/netiface", options)
         end
 
         # Returns the agent’s network protocol info.
@@ -102,8 +100,7 @@ module Wazuh
         #   Filters by dhcp.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-an-agent
         def netproto(agent_id, options = {})
-          data = get "/syscollector/#{agent_id}/netproto", options
-          data.items
+          offset_request('get', "/syscollector/#{agent_id}/netproto", options)
         end
 
         # Returns the agent’s OS info.
@@ -141,8 +138,7 @@ module Wazuh
         #   Filters by format.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info
         def packages(agent_id, options = {})
-          data = get "/syscollector/#{agent_id}/packages", options
-          data.items
+          offset_request('get', "/syscollector/#{agent_id}/packages", options)
         end
 
         # Get ports info of an agent
@@ -175,8 +171,7 @@ module Wazuh
         #   Filters by state.
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-an-agent
         def ports(agent_id, options = {})
-          data = get "/syscollector/#{agent_id}/ports", options
-          data.items
+          offset_request('get', "/syscollector/#{agent_id}/ports", options)
         end
 
         # Get processes info
@@ -224,8 +219,7 @@ module Wazuh
         # 
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info
         def processes(agent_id, options = {})
-          data = get "/syscollector/#{agent_id}/processes", options
-          data.items
+          offset_request('get', "/syscollector/#{agent_id}/processes", options)
         end
       end
     end

data/lib/wazuh/sawyer/request.rb

@@ -18,6 +18,18 @@ module Wazuh
         request(:delete, path, options)
       end
 
+      def offset_request(method, path, options = {})
+        items = []
+        data = send(method, path, options)
+        0.step(data.totalItems, 500) { |offset|
+          options[:offset] = offset
+          d = send(method, path, options)
+          items.concat(d.items)
+        }
+
+        items
+      end
+
       private
 
       def request(method, path, options)

data/lib/wazuh/version.rb

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

data/wazuh-ruby-client.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.1.4"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wazuh-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - mrtc0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement