Nessus6 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45de2929582d290d256e02d1e7ca7b8cd91cd559
-  data.tar.gz: ef441435d1ef84096b44319284fae90e6ee6dbec
+  metadata.gz: 8ea57398554fa50d66e69cbd4f764fdfdf70800f
+  data.tar.gz: 59fbbc502baedf879a692a4413433bdccbf390de
 SHA512:
-  metadata.gz: 07ad4b0de59890b92c5048c60743aed6c48c932d6a12f7b69cb5d10df72ce1296ccd49a1479d059e1b1df2972f5ded92b86ac1cfd1145d85e85d69a3391466ea
-  data.tar.gz: 23a8777b7b42bafdc63c5bf2e67fbc208b99182801945cdf158ce6ce40fc8203a92a55f954c673f17672c483013addb7377f29390e9ad41fc6014031b9972322
+  metadata.gz: 311e47c8a8e10bca9fac1cf82f60eb3196b24c4e7b5224b848406006fbc4b7aef0f8f074605c33a4e5fefceb3d51d1e3e7df49f562a1e34199a5222df62b279b
+  data.tar.gz: 9612248b7da4daffbb06bbd205656a05f38b5f0f86d0fe42b998a847f1e8ddc42588138e6513f95b8639192a8383cea3e95554b1f1feb0753c594ead2058c55b

data/Nessus6.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'Nessus6/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "Nessus6"
+  spec.name          = 'Nessus6'
   spec.version       = Nessus6::VERSION
-  spec.authors       = ["Kevin Kirsche"]
-  spec.email         = ["kev.kirsche@gmail.com"]
+  spec.authors       = ['Kevin Kirsche']
+  spec.email         = ['kev.kirsche@gmail.com']
   spec.license       = 'Apache-2.0'
 
   spec.summary       = %q{[Under Construction] Nessus 6 API Gem}
   spec.description   = %q{Gem for interacting with the Tenable Nessus 6 REST API.}
-  spec.homepage      = "https://github.com/kkirsche/Nessus6"
+  spec.homepage      = 'https://github.com/kkirsche/Nessus6'
 
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.8"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'yard', '~> 0.8'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
-  spec.add_runtime_dependency "hurley", "~> 0.1"
+  spec.add_runtime_dependency 'hurley', '~> 0.1'
 end

data/lib/Nessus6/editor.rb

@@ -1,11 +1,3 @@
-require 'json'
-require 'Nessus6/errors/bad_request' # 400
-require 'Nessus6/errors/forbidden' # 403
-require 'Nessus6/errors/not_found' # 404
-require 'Nessus6/errors/conflict' # 409
-require 'Nessus6/errors/internal_server_error' # 500
-require 'Nessus6/errors/unknown' # Unknown Error Code
-
 module Nessus6
   # The Editor class is for interacting with Nessus6 templates. Templates are
   # used to create scans or policies with predefined parameters.

data/lib/Nessus6/file.rb

@@ -1,8 +1,3 @@
-require 'json'
-require 'hurley'
-require 'Nessus6/errors/internal_server_error'
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The File class is for uploading files to Nessus.
   # https://localhost:8834/api#/resources/file

data/lib/Nessus6/folder.rb

@@ -1,10 +1,3 @@
-require 'json'
-require 'Nessus6/errors/internal_server_error'
-require 'Nessus6/errors/forbidden'
-require 'Nessus6/errors/bad_request'
-require 'Nessus6/errors/not_found'
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The Folders class is for interacting with Nessus6 folders. Folders are used
   # to sort and organize a user's scan results.

data/lib/Nessus6/group.rb

@@ -1,10 +1,3 @@
-require 'json'
-require 'Nessus6/errors/internal_server_error' # 500
-require 'Nessus6/errors/forbidden' # 403
-require 'Nessus6/errors/bad_request' # 400
-require 'Nessus6/errors/not_found' # 404
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The Groups class is for interacting with Nessus6 user groups. Groups are
   # utilized to make sharing easier.

data/lib/Nessus6/permission.rb

@@ -1,8 +1,3 @@
-require 'json'
-require 'Nessus6/errors/forbidden' # 403
-require 'Nessus6/errors/not_found' # 404
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The Permissions class is for interacting with Nessus6 user permissions.
   # Permissions are used to provide access rights to a given object.

data/lib/Nessus6/plugin.rb

@@ -0,0 +1,53 @@
+module Nessus6
+  # The Plugin class is for interacting with Nessus6 plugins.
+  # https://localhost:8834/api#/resources/plugins
+  class Plugin
+    include Nessus6::Verification
+
+    public
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the list of plugin families. This request requires standard user
+    # permissions.
+    #
+    # @return [Hash]
+    def families
+      response = @client.get('plugins/families')
+      verify response,
+             forbidden: 'You do not have permission to view plugin families',
+             internal_server_error: 'Server failed to retrieve the plugin '\
+                                    'family list.'
+    end
+
+    # Returns the list of plugins in a family. This request requires standard
+    # user permissions.
+    #
+    # @param plugin_family_id [String] The id of the family to lookup.
+    # @return [Hash]
+    def family_details(plugin_family_id)
+      response = @client.get("plugins/families/#{plugin_family_id}")
+      verify response,
+             forbidden: 'You do not have permission to view the plugin family',
+             not_found: 'Plugin family not found',
+             internal_server_error: 'Server failed to retrieve the plugin '\
+                                    'family details.'
+    end
+
+    # Returns the details for a given plugin. This request requires standard
+    # user permissions.
+    #
+    # @param plugin_id [String] The id of the plugin.
+    # @return [Hash]
+    def plugin_details(plugin_id)
+      response = @client.get("plugins/plugin/#{plugin_id}")
+      verify response,
+             forbidden: 'You do not have permission to view the plugin',
+             not_found: 'Plugin not found',
+             internal_server_error: 'Server failed to retrieve the plugin '\
+                                    'details.'
+    end
+  end
+end

data/lib/Nessus6/plugin_rules.rb

@@ -0,0 +1,92 @@
+module Nessus6
+  # The Plugin class is for interacting with Nessus6 plugins.
+  # https://localhost:8834/api#/resources/plugins
+  class PluginRules
+    include Nessus6::Verification
+
+    public
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the list of plugin families. This request requires standard user
+    # permissions.
+    #
+    # @return [Hash]
+    def list
+      response = @client.get('plugins-rules')
+      verify response,
+             forbidden: 'You do not have permission to view plugin rules list',
+             internal_server_error: 'Server failed to create the group'
+    end
+
+    # Returns the list of plugins in a family. This request requires standard
+    # user permissions.
+    #
+    # @param plugin_id [String, Fixnum] The id of the plugin to apply the rule
+    #   to.
+    # @param type [String] The new severity to apply (recast_critical,
+    #   recast_high, recast_medium, recast_low, recast_info, exclude).
+    # @param host [String] The host to apply the rule to.
+    # @param date [String] The expiration date of the plugin rule
+    # @return [Hash]
+    def create(plugin_id, type, host, date = nil)
+      if date.nil?
+        response = @client.post('plugin-rules', plugin_id: plugin_id,
+                                                type: type,
+                                                host: host)
+      else
+        response = @client.post('plugin-rules', plugin_id: plugin_id,
+                                                type: type,
+                                                host: host,
+                                                date: date)
+      end
+      verify response,
+             bad_request: 'An argument is missing or invalid',
+             forbidden: 'You do not have permission to create this plugin rule',
+             not_found: 'Plugin family not found',
+             internal_server_error: 'Server failed to create the plugin rule'
+    end
+
+    # Deletes a plugin rule. This request requires read only user permissions.
+    #
+    # @param rule_id [String, Fixnum] The id of the rule to delete.
+    # @return [Hash]
+    def delete(rule_id)
+      response = @client.delete("plugin-rules/#{rule_id}")
+      verify response,
+             forbidden: 'You do not have permission to delete the rule.',
+             not_found: 'Rule with that ID could not be found',
+             internal_server_error: 'Server failed to create the group'
+    end
+
+    # Modify a plugin rule for the current user. This request requires read only
+    # user permissions.
+    #
+    # @param rule_id [String, Fixnum] The id of the rule to delete.
+    # @param plugin_id [String, Fixnum] The id of the plugin to apply the rule
+    #   to.
+    # @param type [String] The new severity to apply (recast_critical,
+    #   recast_high, recast_medium, recast_low, recast_info, exclude).
+    # @param host [String] The host to apply the rule to.
+    # @param date [String] The expiration date of the plugin rule
+    # @return [Hash]
+    def edit(rule_id, plugin_id, type, host, date = nil)
+      if date.nil?
+        response = @client.put("plugin-rules/#{rule_id}", plugin_id: plugin_id,
+                                                          type: type,
+                                                          host: host)
+      else
+        response = @client.put("plugin-rules/#{rule_id}", plugin_id: plugin_id,
+                                                          type: type,
+                                                          host: host,
+                                                          date: date)
+      end
+      verify response,
+             forbidden: 'You do not have permission to delete the rule.',
+             not_found: 'Rule with that ID could not be found',
+             internal_server_error: 'Server failed to create the group'
+    end
+  end
+end

data/lib/Nessus6/scan.rb

@@ -1,10 +1,3 @@
-require 'json'
-require 'Nessus6/errors/forbidden' # 403
-require 'Nessus6/errors/not_found' # 404
-require 'Nessus6/errors/conflict' # 409
-require 'Nessus6/errors/internal_server_error' # 500
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The Scans class is for interacting with Nessus6 scans.
   # https://localhost:8834/api#/resources/scans

data/lib/Nessus6/scanner.rb

@@ -0,0 +1,33 @@
+module Nessus6
+  # The Scanner class provides details about the available scanners
+  # https://localhost:8834/api#/resources/server
+  class Scanner
+    include Nessus6::Verification
+
+    public
+
+    # Returns the scanner list. This request requires administrator user
+    # permissions.
+    #
+    # @return [Hash]
+    def list
+      response = @client.get('scanners')
+      verify response,
+             forbidden: 'You do not have permission to view the list',
+             internal_server_error: 'Server failed to retrieve properties'
+    end
+
+    # Returns the agent list for the given scanner. This request requires
+    # administrator user permissions.
+    #
+    # @param scanner_id [String, Fixnum] The id of the scanner to query for
+    #   agents.
+    # @return [Hash]
+    def list_agents(scanner_id)
+      response = @client.get("scanners/#{scanner_id}/agents")
+      verify response,
+             forbidden: 'You do not have permission to view the list of agents',
+             internal_server_error: 'Server failed to retrieve agent list'
+    end
+  end
+end

data/lib/Nessus6/server.rb

@@ -0,0 +1,27 @@
+module Nessus6
+  # The Server class returns information about the Nessus Server itself
+  # https://localhost:8834/api#/resources/server
+  class Server
+    include Nessus6::Verification
+
+    public
+
+    # Returns the Nessus server version and other properties.
+    #
+    # @return [Hash]
+    def properties
+      response = @client.get('server/properties')
+      verify response,
+             internal_server_error: 'Server failed to retrieve properties'
+    end
+
+    # Returns the Nessus server status.
+    #
+    # @return [Hash]
+    def status
+      response = @client.get('server/status')
+      verify response,
+             internal_server_error: 'Server failed to retrieve status'
+    end
+  end
+end

data/lib/Nessus6/session.rb

@@ -1,10 +1,3 @@
-require 'json'
-require 'Nessus6/errors/bad_request'
-require 'Nessus6/errors/forbidden'
-require 'Nessus6/errors/internal_server_error'
-require 'Nessus6/errors/unauthorized'
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The Session class is used to create a session with Nessus6. User sessions
   # allow us to interact throughout our applications.

data/lib/Nessus6/user.rb

@@ -1,11 +1,3 @@
-require 'json'
-require 'Nessus6/errors/bad_request'
-require 'Nessus6/errors/conflict'
-require 'Nessus6/errors/forbidden'
-require 'Nessus6/errors/internal_server_error'
-require 'Nessus6/errors/not_found'
-require 'Nessus6/errors/unknown'
-
 module Nessus6
   # The Users class allows us to interact with Nessus 6 users.
   # Users can utilize Nessus based on their given role.

data/lib/Nessus6/verification.rb

@@ -1,3 +1,12 @@
+require 'json'
+require 'nessus6/errors/bad_request'
+require 'nessus6/errors/conflict'
+require 'nessus6/errors/forbidden'
+require 'nessus6/errors/internal_server_error'
+require 'nessus6/errors/not_found'
+require 'nessus6/errors/unauthorized'
+require 'nessus6/errors/unknown'
+
 module Nessus6
   # The verification class allows methods to verify responses from Nessus
   module Verification

data/lib/Nessus6/version.rb

@@ -1,3 +1,3 @@
 module Nessus6
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Nessus6
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kevin Kirsche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +124,11 @@ files:
 - lib/Nessus6/folder.rb
 - lib/Nessus6/group.rb
 - lib/Nessus6/permission.rb
+- lib/Nessus6/plugin.rb
+- lib/Nessus6/plugin_rules.rb
 - lib/Nessus6/scan.rb
+- lib/Nessus6/scanner.rb
+- lib/Nessus6/server.rb
 - lib/Nessus6/session.rb
 - lib/Nessus6/user.rb
 - lib/Nessus6/verification.rb
@@ -149,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: "[Under Construction] Nessus 6 API Gem"