Nessus6 0.1.1 → 0.1.2

data/lib/Nessus6/verification.rb

@@ -0,0 +1,29 @@
+module Nessus6
+  # The verification class allows methods to verify responses from Nessus
+  module Verification
+    private
+
+    def verify(response, message = nil)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 400
+        fail Nessus6::Error::BadRequestError, "#{message[:bad_request]}"
+      when 401
+        fail Nessus6::Error::UnauthorizedError, "#{message[:unauthorized]}"
+      when 403
+        fail Nessus6::Error::ForbiddenError, "#{message[:forbidden]}"
+      when 404
+        fail Nessus6::Error::NotFoundError, "#{message[:not_found]}"
+      when 409
+        fail Nessus6::Error::ConflictError, "#{message[:conflict]}"
+      when 500
+        fail Nessus6::Error::InternalServerError,
+             "#{message[:internal_server_error]}"
+      else
+        fail Nessus6::Error::UnknownError, 'An unknown error occurred. ' \
+                           'Please consult Nessus for further details.'
+      end
+    end
+  end
+end

data/lib/Nessus6/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Nessus6
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kevin Kirsche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: hurley
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,8 @@ files:
 - bin/console
 - bin/setup
 - lib/Nessus6.rb
-- lib/Nessus6/editor/methods.rb
+- lib/Nessus6/editor.rb
+- lib/Nessus6/errors/authentication_error.rb
 - lib/Nessus6/errors/bad_request.rb
 - lib/Nessus6/errors/conflict.rb
 - lib/Nessus6/errors/forbidden.rb
@@ -105,13 +120,14 @@ files:
 - lib/Nessus6/errors/not_found.rb
 - lib/Nessus6/errors/unauthorized.rb
 - lib/Nessus6/errors/unknown.rb
-- lib/Nessus6/file/methods.rb
-- lib/Nessus6/folders/methods.rb
-- lib/Nessus6/groups/methods.rb
-- lib/Nessus6/permissions/methods.rb
-- lib/Nessus6/scans/methods.rb
-- lib/Nessus6/session/methods.rb
-- lib/Nessus6/users/methods.rb
+- lib/Nessus6/file.rb
+- lib/Nessus6/folder.rb
+- lib/Nessus6/group.rb
+- lib/Nessus6/permission.rb
+- lib/Nessus6/scan.rb
+- lib/Nessus6/session.rb
+- lib/Nessus6/user.rb
+- lib/Nessus6/verification.rb
 - lib/Nessus6/version.rb
 homepage: https://github.com/kkirsche/Nessus6
 licenses:

data/lib/Nessus6/editor/methods.rb

@@ -1,108 +0,0 @@
-require 'json'
-require 'Nessus6/errors/forbidden'
-require 'Nessus6/errors/not_found'
-require 'Nessus6/errors/unknown'
-
-module Nessus6
-  # The Editor class is for interacting with Nessus6 templates
-  class Editor
-    def initialize(client)
-      @client = client
-    end
-
-    def audits(type, object_id, file_id)
-      response = @client.get("editor/#{type}/#{object_id}/audits/#{file_id}")
-      verify_audits response
-    end
-
-    def details(type, template_uuid)
-      response = @client.get("editor/#{type}/templates/#{template_uuid}")
-      verify_details response
-    end
-
-    def edit(type, id)
-      response = @client.get("editor/#{type}/#{id}")
-      verify_edit response
-    end
-
-    def list(type)
-      response = @client.get("editor/#{type}/templates")
-      verify response
-    end
-
-    def plugin_description(policy_id, family_id, plugin_id)
-      response = @client.get("editor/policy/#{policy_id}/families/#{family_id}/plugins/#{plugin_id}")
-      verify_plugin_description response
-    end
-
-    private
-
-    def verify_audits(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to export the audit file'
-      when 404
-        fail NotFoundError, 'Audit file does not exist'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_details(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to open the template'
-      when 404
-        fail NotFoundError, 'Template does not exist'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_edit(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to open the object'
-      when 404
-        fail NotFoundError, 'Object does not exist'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_list(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to view the list'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_plugin_description(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-  end
-end

data/lib/Nessus6/file/methods.rb

@@ -1,34 +0,0 @@
-require 'json'
-require 'hurley'
-require 'Nessus6/errors/internal_server_error'
-require 'Nessus6/errors/unknown'
-
-module Nessus6
-  # The Editor class is for interacting with Nessus6 templates
-  class File
-    def initialize(client)
-      @client = client
-    end
-
-    def upload(file_path, file_type, encrypted = 0)
-      response = @client.post('file/upload',
-                              file: Hurley::UploadIO.new(file_path, file_type),
-                              no_enc: encrypted)
-      verify_upload response
-    end
-
-    private
-
-    def verify_upload(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 500
-        fail InternalServerError, 'File failed to upload'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-  end
-end

data/lib/Nessus6/folders/methods.rb

@@ -1,118 +0,0 @@
-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 Editor class is for interacting with Nessus6 templates
-  class Folders
-    def initialize(client)
-      @client = client
-    end
-
-    # Creates a new folder for the current user. This request requires
-    # read-only user permissions.
-    #
-    # @param name [String] The name of the folder.
-    # @return [Hash]
-    def create(name)
-      response = @client.post('folders', name: name)
-      verify_create response
-    end
-
-    # Deletes a folder. This request requires read-only user permissions.
-    #
-    # @param folder_id [String, Fixnum] The id of the folder to delete.
-    # @return [Hash]
-    def delete(folder_id)
-      response = @client.delete("folders/#{folder_id}")
-      verify_delete response
-    end
-
-    # Rename a folder for the current user. This request requires read-only
-    # user permissions.
-    #
-    # @param folder_id [String, Fixnum] The id of the folder to edit.
-    # @param name [String] The name of the folder.
-    # @return [Hash]
-    def edit(folder_id, name)
-      response = @client.put("folders/#{folder_id}", name: name)
-      verify_edit response
-    end
-
-    alias_method :rename, :edit
-
-    # Returns the current user's scan folders.
-    #
-    # @return [Hash] { "folders": [folder Resource] }
-    def list
-      response = @client.get('folders')
-      verify_list response
-    end
-
-    private
-
-    def verify_create(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 400
-        fail BadRequestError, 'Folder name is invalid'
-      when 403
-        fail ForbiddenError, 'You do not have permission to create a folder'
-      when 500
-        fail InternalServerError, 'Server failed to create the folder'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_delete(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError, 'Cannot delete a system folder'
-      when 404
-        fail NotFoundError, 'Folder does not exist'
-      when 500
-        fail InternalServerError, 'Server failed to delete the folder'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_edit(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError, 'Cannot rename a system folder'
-      when 404
-        fail NotFoundError, 'Folder does not exist'
-      when 500
-        fail InternalServerError, 'Server failed to rename the folder'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_list(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to view the folder list'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-  end
-end

data/lib/Nessus6/groups/methods.rb

@@ -1,202 +0,0 @@
-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 Editor class is for interacting with Nessus6 templates
-  class Groups
-    def initialize(client)
-      @client = client
-    end
-
-    # Add a user to the group. This request requires administrator user
-    # permissions.
-    #
-    # @param group_id [String, Fixnum] The unique id of the group.
-    # @param user_id [String, Fixnum] The unique id of the user.
-    # @return [Hash]
-    def add_user(group_id, user_id)
-      response = @client.post("groups/#{group_id}/users/#{user_id}")
-      verify_add_user response
-    end
-
-    # Create a group. This request requires administrator user
-    # permissions.
-    #
-    # @param name [String, Fixnum] The name of the group.
-    # @return [Hash]
-    def create(name)
-      response = @client.post('groups', name: name)
-      verify_create response
-    end
-
-    # Delete a group. This request requires administrator user
-    # permissions.
-    #
-    # @param group_id [String, Fixnum] The unique id of the group.
-    # @return [Hash]
-    def delete(group_id)
-      response = @client.delete("groups/#{group_id}")
-      verify_delete response
-    end
-
-    # Deletes a user from the group. This request requires administrator user
-    # permissions.
-    #
-    # @param group_id [String, Fixnum] The unique id of the group.
-    # @param user_id [String, Fixnum] The unique id of the user.
-    # @return [Hash]
-    def delete_user(group_id, user_id)
-      response = @client.delete("groups/#{group_id}/users/#{user_id}")
-      verify_delete_user response
-    end
-
-    # Edit a group. This request requires administrator user permissions.
-    #
-    # @param group_id [String, Fixnum] The unique id of the group.
-    # @param name [String] The name of the group.
-    # @return [Hash]
-    def edit(group_id, name)
-      response = @client.put("groups/#{group_id}", name: name)
-      verify_edit response
-    end
-
-    alias_method :rename, :edit
-
-    # Returns the group list. This request requires read-only user permissions.
-    #
-    # @return [Hash]
-    def list
-      response = @client.get('groups')
-      verify_list response
-    end
-
-    # Return the group user list. This request requires administrator user
-    # permissions.
-    #
-    # @param group_id [String, Fixnum] The unique id of the group.
-    # @return [Hash]
-    def list_users(group_id)
-      response = @client.get("groups/#{group_id}/users")
-      verify_list_users response
-    end
-
-    private
-
-    def verify_add_user(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to add users to a group'
-      when 404
-        fail NotFoundError, 'Group or user does not exist'
-      when 500
-        fail InternalServerError, 'Server failed to add the user to the group'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_create(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 400
-        fail BadRequestError, 'Field is invalid'
-      when 403
-        fail ForbiddenError, 'You do not have permission to create a group'
-      when 500
-        fail InternalServerError, 'Server failed to create the group'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_delete(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 400
-        fail BadRequestError, 'Group does not exist'
-      when 403
-        fail ForbiddenError, 'You do not have permission to delete the group'
-      when 500
-        fail InternalServerError, 'Server failed to delete the group'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_delete_user(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to delete users from a group'
-      when 404
-        fail NotFoundError, 'Group or user does not exist'
-      when 500
-        fail InternalServerError,
-             'Server failed to remove the user from the group'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_edit(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 400
-        fail BadRequestError, 'Field is invalid'
-      when 403
-        fail ForbiddenError, 'You do not have permission to edit a group'
-      when 404
-        fail NotFoundError, 'Group does not exist'
-      when 500
-        fail InternalServerError, 'Server failed to edit / rename the group'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_list(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to view the groups list'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-
-    def verify_list_users(response)
-      case response.status_code
-      when 200
-        return JSON.parse response.body
-      when 403
-        fail ForbiddenError,
-             'You do not have permission to view the groups users list'
-      when 404
-        fail NotFoundError, 'Group does not exist'
-      else
-        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
-                           'for further details.'
-      end
-    end
-  end
-end