Nessus6 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d5f74268631e12a7f57ba4a136bd591da5b1a37
-  data.tar.gz: f6eb5f515119e9b788c4ada09eefad0169d282d8
+  metadata.gz: a93311faca0577293ac581d90586cf5cdce9788e
+  data.tar.gz: 2d86c0f842b306a16a92e72020566e5de5571567
 SHA512:
-  metadata.gz: 14fc6d68c0e61e0076f90e35de06ffe5ff4a7972a6960dec149b3686fa2c5e18db81d1f01e2f2e48a3e25c8ff0ef13f210b9b57e4d85fadf78b6dc0a1444b805
-  data.tar.gz: 2448df2fefbbc269f1ca485cc63fa120da2b624175ce3faea7cf65b8d8e32da36b2d52d0be6a844abf83f6de08da8269a4e2a48eafb22ee0c09fa549cdbef5da
+  metadata.gz: 9256f00ef92a34916df54c11d9f0b507799236b37d3c3855569494cdbf0d6a3c8aee787a772a6cfbd8f87cda0974eef16277753cb2cdaaf799240a75f8ed7941
+  data.tar.gz: a2ec430c521b43f956ee211e27030308b9dbac328920df8224c7073938e07f66495908ade94850e5f85dfb0a8756e9b8050817483e5279b21db5aba1414eaf2c

data/lib/Nessus6.rb

@@ -10,6 +10,7 @@ require 'Nessus6/group'
 require 'Nessus6/permission'
 require 'Nessus6/plugin'
 require 'Nessus6/plugin_rule'
+require 'Nessus6/policy'
 require 'Nessus6/scan'
 require 'Nessus6/scanner'
 require 'Nessus6/server'
@@ -23,7 +24,8 @@ module Nessus6
   class Client
     attr_accessor :client
     attr_reader :editor, :file, :folder, :group, :permission, :plugin,
-                :plugin_rule, :scan, :scanner, :server, :session, :user
+                :plugin_rule, :policy, :scan, :scanner, :server, :session,
+                :user
 
     def initialize(credentials, nessus)
       nessus[:port] = '8834' unless nessus.key?(:port)
@@ -66,6 +68,7 @@ module Nessus6
       @group = Nessus6::Group.new client
       @permission = Nessus6::Permission.new client
       @plugin = Nessus6::Plugin.new client
+      @policy = Nessus6::Policy.new client
       @plugin_rule = Nessus6::PluginRule.new client
       @scan = Nessus6::Scan.new client
       @scanner = Nessus6::Scanner.new client

data/lib/Nessus6/error/method_not_allowed.rb

@@ -0,0 +1,7 @@
+module Nessus6
+  module Error
+    # MethodNotAllowedError is a 405 error.
+    class MethodNotAllowedError < StandardError
+    end
+  end
+end

data/lib/Nessus6/policy.rb

@@ -0,0 +1,94 @@
+# The Nessus6 module is used to interact with Nessus version 6 servers.
+module Nessus6
+  # The Policy class is for defining scan test parameters.
+  # https://localhost:8834/api#/resources/policies
+  class Policy
+    include Nessus6::Verification
+
+    public
+
+    def initialize(client)
+      @client = client
+    end
+
+
+    # Changes the parameters of a policy
+    #
+    # @param policy_id [String, Fixnum] The id of the policy to change
+    # @param uuid [String] The uuid for the editor template to use
+    # @param settings_acl [Array] An array containing permissions to apply to the policy
+    # @return [Hash]
+    def configure(policy_id, uuid, settings_acl)
+      response = @client.put "policies/#{policy_id}", uuid: uuid, 'settings.acl' => settings_acl
+      verify response,
+             not_found: 'The requested policy does not exist.',
+             internal_server_error: 'Error occurred while saving the configuration.'
+    end
+
+    # Copy a policy
+    #
+    # @param policy_id [String, Fixnum] The id of the policy to copy
+    # @return [Hash]
+    def copy(policy_id)
+      response = @client.post "policies/#{policy_id}/copy"
+      verify response,
+             unauthorized: 'You do not have permission to copy this policy.',
+             not_found: 'The requested policy does not exist.',
+             internal_server_error: 'Failed to copy the policy. Internal server error.'
+    end
+
+    # Creates a policy
+    #
+    # @param uuid [String] The uuid of the editor template to use
+    # @return [Hash]
+    def create(uuid)
+      response = @client.post 'policies', uuid: uuid
+      verify response,
+             not_found: 'Could not find a scan with the requested UUID',
+             internal_server_error: 'Failed to save policy. Internal server error.'
+    end
+
+
+    # Delete a policy
+    #
+    # @param policy_id [String, Fixnum] The id of the policy to delete
+    # @return [Hash]
+    def delete(policy_id)
+      response = @client.delete "policies/#{policy_id}"
+      verify response,
+             unauthorized: 'You do not have permission to delete the policy.',
+             not_found: 'Could not find a policy with the provided ID.',
+             not_allowed: 'Policy is in use by a scan.'
+    end
+
+    # Returns the details for the given policy
+    #
+    # @param policy_id [String, Fixnum] The id of the policy to retrieve.
+    # @return [Hash]
+    def details(policy_id)
+      response = @client.get "policies/#{policy_id}"
+      verify response,
+             not_found: 'Could not find a policy with that ID.'
+    end
+
+    # Export the given policy
+    #
+    # @param policy_id [String, Fixnum] The id of the policy to export
+    # @return [Hash]
+    def export(policy_id)
+      response = @client.get "policies/#{policy_id}/export"
+      verify response,
+             unauthorized: 'You do not have permission to export the policy.',
+             not_found: 'Policy with the provided ID does not exist'
+    end
+
+    # Returns the policy list
+    #
+    # @return [Hash] Policy resource(s)
+    def list
+      response = @client.get 'policies'
+      verify response,
+             internal_server_error: 'Internal server error occurred.'
+    end
+  end
+end

data/lib/Nessus6/scan.rb

@@ -115,6 +115,30 @@ module Nessus6
              conflict: 'Scan is not active.'
     end
 
+    # Resumes a scan
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to resume
+    # @return [Hash]
+    def resume(scan_id)
+      response = @client.post "scans/#{scan_id}/resume"
+      verify response,
+             not_found: 'A scan with that ID could not be located',
+             conflict: "The scan is not active and / or couldn't be resumed"
+    end
+
+    # Enables or disables a scan schedule
+    #
+    # @param scan_id [String, Fixnum] The id of the scan
+    # @param enabled [String, Trueclass, Falseclass] Enables or disables the
+    #   scan schedule
+    # @return [Hash] With enabled, control, rules, starttime, and timezone
+    def schedule(scan_id, enabled)
+      response = client.put "scans/#{scan_id}/schedule", enabled: enabled
+      verify response,
+             not_found: 'A scan with that ID could not be located',
+             internal_server_error: 'The scan does not have a schedule enabled'
+    end
+
     # Stops a scan.
     #
     # @param scan_id [String, Fixnum] The id of the scan to stop.

data/lib/Nessus6/verification.rb

@@ -3,6 +3,7 @@ require 'Nessus6/error/bad_request'
 require 'Nessus6/error/conflict'
 require 'Nessus6/error/forbidden'
 require 'Nessus6/error/internal_server_error'
+require 'Nessus6/error/method_not_allowed'
 require 'Nessus6/error/not_found'
 require 'Nessus6/error/unauthorized'
 require 'Nessus6/error/unknown'
@@ -25,6 +26,8 @@ module Nessus6
         fail Nessus6::Error::ForbiddenError, "#{message[:forbidden]}"
       when 404
         fail Nessus6::Error::NotFoundError, "#{message[:not_found]}"
+      when 405
+        fail Nessus6::Error::MethodNotAllowedError, "#{message[:not_allowed]}"
       when 409
         fail Nessus6::Error::ConflictError, "#{message[:conflict]}"
       when 500

data/lib/Nessus6/version.rb

@@ -1,5 +1,5 @@
 # The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # VERSION is the current version of the Nessus6 gem
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Nessus6
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kevin Kirsche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - lib/Nessus6/error/conflict.rb
 - lib/Nessus6/error/forbidden.rb
 - lib/Nessus6/error/internal_server_error.rb
+- lib/Nessus6/error/method_not_allowed.rb
 - lib/Nessus6/error/not_found.rb
 - lib/Nessus6/error/unauthorized.rb
 - lib/Nessus6/error/unknown.rb
@@ -127,6 +128,7 @@ files:
 - lib/Nessus6/permission.rb
 - lib/Nessus6/plugin.rb
 - lib/Nessus6/plugin_rule.rb
+- lib/Nessus6/policy.rb
 - lib/Nessus6/scan.rb
 - lib/Nessus6/scanner.rb
 - lib/Nessus6/server.rb
@@ -159,4 +161,3 @@ signing_key:
 specification_version: 4
 summary: "[Under Construction] Nessus 6 API Gem"
 test_files: []
-has_rdoc: