tenable-ruby 0.4.0 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ad4945418eed9203a963b29176367b98faa3edd12883d97cc49d8cdc893fba
-  data.tar.gz: 24c17741e683b65c0c3c2362d7414f099153a7222bad4af37b2f3cb54b99523c
+  metadata.gz: 0ffe53830580db35bbb25fa2b418ef6fd4de79d276b65d65689f662270e1ea2e
+  data.tar.gz: 2a47587b3045d58b9b05ba186e288068da080ebd7497e129587ed7d8430011dc
 SHA512:
-  metadata.gz: 4f1a50612125ce469b30e90ec69bc88b307646a1765841564fd127a539dfd8e1c8004fd82ff9a6d6dec0832e298c756edaa4dc67abd85db54039df0d0ddb627e
-  data.tar.gz: 9cd6b2b9b3462a0750104aded927326facfe1efe097ac0520a3118baf3b836803c69145600bac9395145f10f5aa70f463170cb43f59d7afd2278fe7edea70bc8
+  metadata.gz: 718a5e61e6005ccb0500248309dc985614a37dd9905d45e8fac03d74281b1c61369500e61bba9f29b1a6391c35c17bc873ba0ef0a7c4927f5586197edf202d59
+  data.tar.gz: 89f12942cec5d12d0fbaa4775affa2805c362242434b229168fffa09c79d5219cfbc2cdb58e38c560abf11a79506809bb107a6b59dd1cf10dbc948ea151e635c

data/lib/tenable-ruby.rb

@@ -526,11 +526,11 @@ module TenableRuby
 
     # Performs scan with scan policy provided (uuid of policy or policy name).
     # Name is your scan name and opts is your scan configuration hash
-    # (foldername is optional - folder where to save the scan (if that folder exists))
+    # (scan_folder is optional - folder where to save the scan (if that folder exists))
     # (scanner_id is optional - ID of the scanner/cloud scanner you want to run this scan on)
     #
     # returns: JSON parsed object with scan info
-    def scan_quick_policy(policyname, name, opts = {}, foldername = nil, scanner_id = nil)
+    def scan_quick_policy(policyname, name, opts = {}, scan_folder = nil, scanner_id = nil)
       policies = list_policies['policies']
       if policies.nil?
         raise TenableRuby::Error::TenableError, "Tenable API request 'list_policies' responded with 'nil'"
@@ -548,16 +548,18 @@ module TenableRuby
       settings.merge!(opts)
       settings['name'] = name
       settings['policy_id'] = policy['id']
-      unless foldername.nil?
+      if scan_folder.is_a?(Integer)
+        settings['folder_id'] = scan_folder
+      elsif scan_folder.is_a?(String)
         folders = list_folders['folders']
         if folders.nil?
           raise TenableRuby::Error::TenableError, "Tenable API request 'list_folders' responded with 'nil'"
         end
-        selected_folders = folders.select do |folder|
-          folder['name'] == foldername
-        end
-        unless selected_folders.size == 0
-          settings['folder_id'] = selected_folders.first['id']
+        selected_folder = folders.find { |f| f['name'] == scan_folder }
+        if selected_folder
+          settings['folder_id'] = selected_folder['id']
+        else
+          raise TenableRuby::Error::TenableError, "Could not find folder with name #{scan_folder}"
         end
       end
       unless scanner_id.nil?
@@ -570,7 +572,12 @@ module TenableRuby
     #
     # Reference: https://developer.tenable.com/reference#scans-get-latest-status
     def scan_status(scan_id)
-      http_get(:uri => "/scans/#{scan_id}/latest-status", :fields => header)['status']
+      response = http_get(:uri => "/scans/#{scan_id}/latest-status", :fields => header)
+      if response.is_a?(Hash) and response.has_key?('status')
+        response['status']
+      else
+        raise TenableRuby::Error::TenableError, "Tenable.io did not return a valid status response"
+      end
     end
 
     # Parse the scan status command to determine if a scan has finished
@@ -692,6 +699,48 @@ module TenableRuby
       http_get(:uri => "/container-security/api/v1/reports/by_image_digest?image_digest=#{image_digest}", :fields => header)
     end
 
+    # Creates a new target group for the current user.
+    #
+    # Reference:
+    # https://developer.tenable.com/reference#target-groups-create
+    def create_target_group(name, members, acls: nil)
+      http_post(:uri => "/target-groups", :fields => header,
+        :data => {:name => name, :members => members, :acls => acls})
+    end
+
+    # Returns the current target groups.
+    #
+    # Reference:
+    # https://developer.tenable.com/reference#target-groups-list
+    def list_target_groups
+      http_get(:uri => "/target-groups", :fields => header)
+    end
+
+    # Returns details for the specified target group.
+    #
+    # Reference:
+    # https://developer.tenable.com/reference#target-groups-details
+    def get_target_group(group_id)
+      http_get(:uri => "/target-groups/#{group_id}", :fields => header)
+    end
+
+    # Updates a target group.
+    #
+    # Reference:
+    # https://developer.tenable.com/reference#target-groups-edit
+    def update_target_group(group_id, name, members, acls: nil)
+      http_put(:uri => "/target-groups/#{group_id}", :fields => header,
+        :data => {:name => name, :members => members, :acls => acls})
+    end
+
+    # Deletes a target group.
+    #
+    # Reference:
+    # https://developer.tenable.com/reference#target-groups-delete
+    def delete_target_group(group_id)
+      http_delete(:uri => "/target-groups/#{group_id}", :fields => header)
+    end
+
     private
 
     # Perform HTTP put method with uri, data and fields
@@ -799,7 +848,6 @@ module TenableRuby
       uri = opts[:uri]
       fields = opts[:fields] || {}
       raw_content = opts[:raw_content] || false
-      json = {}
       tries = @httpretry
 
       request = Net::HTTP::Get.new(uri)
@@ -815,11 +863,17 @@ module TenableRuby
           sleep @httpsleep
           retry
         else
-          return json
+          raise TenableRuby::Error::TenableError.new("#{e}: No more retries for http GET '#{opts[:uri]}'")
         end
-      rescue URI::InvalidURIError
-        return json
+      rescue URI::InvalidURIError => e
+        raise TenableRuby::Error::TenableError.new("#{e}: http GET '#{opts[:uri]}'")
+      end
+
+      if response.code.to_s != "200"
+        raise TenableRuby::Error::TenableError.new(response: response),
+          "Tenable API request '#{opts[:uri]}' responded with response code #{response.code}"
       end
+
       if !raw_content
         parse_json(response.body)
       else
@@ -854,7 +908,6 @@ module TenableRuby
       fields = opts[:fields] || {}
       body = opts[:body]
       ctype = opts[:ctype]
-      json = {}
       tries = @httpretry
 
       request = Net::HTTP::Post.new(uri)
@@ -873,10 +926,10 @@ module TenableRuby
           sleep @httpsleep
           retry
         else
-          return json
+          raise TenableRuby::Error::TenableError.new("#{e}: No more retries for http POST '#{opts[:uri]}'")
         end
-      rescue URI::InvalidURIError
-        return json
+      rescue URI::InvalidURIError => e
+        raise TenableRuby::Error::TenableError.new("#{e}: http POST '#{opts[:uri]}'")
       end
 
       if response.code.to_s != "200"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tenable-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: '0.5'
 platform: ruby
 authors:
 - Patrick Craston
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Ruby library for communicating with the tenable.io API.
@@ -25,7 +25,7 @@ homepage: https://gitlab.com/intruder/tenable-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby library for communicating with the tenable.io API
 test_files: []