tenable-ruby 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2231c6ad080a26cb3bc60ccc22754bca82e48f3a3f44c4a660188174d785303
-  data.tar.gz: f0249380a5a091595c10c5a2b0025866cb3b78f27b993e46f091c9b213d09428
+  metadata.gz: 0bbc552ceeab05ff6aebf6074bcdb2ec87da1f8edf79a09f0a067d1773352258
+  data.tar.gz: f1018caecbc01c67804dd3512702126b3e6041778b587f0f6d27fa9403bdd1b9
 SHA512:
-  metadata.gz: e4d9ca21d8b64969a924a3ca5ed71a1cb7c93bfffbb69db11917427f72a4cf194e9b9290887436c798ddd866e7bf736aebcc20406c7f789b341d64d157625422
-  data.tar.gz: 7440641a013b70196b7105f67da2c5e1c83bd98fe69ea3161bad3a9290d661f10df11cdc1e9b5cd0c116dab6311ccb11568e535f34f724b708f94508870e4aa1
+  metadata.gz: 67e194bbd92c3adb2806007517cc17b497dfa5524029ebc5a33b04822975675b35d170fd2def60f02f98255599ea2e44c20aab434e71179d863497373f3028e0
+  data.tar.gz: 1cd8b6f489252b80a3ce088aa6984debb3bf06b6a6377ee53629508af4e9eea734278acaa426ae68cd81c001da23df390e55145cccb7f8ad872f5e5d24fd3ee7

data/lib/tenable-ruby.rb

@@ -307,6 +307,29 @@ module TenableRuby
       http_put(options)
     end
 
+    # Unlinks an agent
+    #
+    # Reference
+    # https://developer.tenable.com/reference#agents-delete
+    def agent_unlink(scanner_id, agent_id)
+      http_delete(:uri => "scanners/#{scanner_id}/agents/#{agent_id}", :fields => header)
+    end
+
+    # Creates a bulk operation task to unlink agents
+    #
+    # Reference
+    # https://developer.tenable.com/reference#bulk-unlink-agents
+    def agent_bulk_unlink(scanner_id, agent_ids)
+      http_post(
+        :uri => "scanners/#{scanner_id}/agents/_bulk/unlink",
+        :fields => header,
+        :body => {
+          :items => agent_ids
+        },
+        :ctype => 'application/json',
+      )
+    end
+
     # Returns details of the specified asset.
     #
     # Reference:
@@ -526,11 +549,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 +571,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?
@@ -697,6 +722,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
@@ -804,7 +871,6 @@ module TenableRuby
       uri = opts[:uri]
       fields = opts[:fields] || {}
       raw_content = opts[:raw_content] || false
-      json = {}
       tries = @httpretry
 
       request = Net::HTTP::Get.new(uri)
@@ -820,11 +886,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
@@ -859,7 +931,6 @@ module TenableRuby
       fields = opts[:fields] || {}
       body = opts[:body]
       ctype = opts[:ctype]
-      json = {}
       tries = @httpretry
 
       request = Net::HTTP::Post.new(uri)
@@ -878,10 +949,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.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Patrick Craston
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-07-15 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: []