Nessus6 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80b280c90c8525f396797ee7a8ede1eaafee968e
-  data.tar.gz: bb9bba8b28e74ffde223f0e88f2a15c7b285bd7a
+  metadata.gz: 45de2929582d290d256e02d1e7ca7b8cd91cd559
+  data.tar.gz: ef441435d1ef84096b44319284fae90e6ee6dbec
 SHA512:
-  metadata.gz: adca72a28588ee39fc1ccaee35eb9d78783637eaf136f702b984b62f88c7b3b61ff61e686a1153a2aeb907750723896bfa9bf494ca12e11bf7a7c8ee7f7c001a
-  data.tar.gz: 8ec5723e60ea92f8220dd9357b0359edd4d5074dccca9c394bce984c7870e8221a839cd3ae4848410e9a413d3928149dd7f164190ce5530ffc72c89858576880
+  metadata.gz: 07ad4b0de59890b92c5048c60743aed6c48c932d6a12f7b69cb5d10df72ce1296ccd49a1479d059e1b1df2972f5ded92b86ac1cfd1145d85e85d69a3391466ea
+  data.tar.gz: 23a8777b7b42bafdc63c5bf2e67fbc208b99182801945cdf158ce6ce40fc8203a92a55f954c673f17672c483013addb7377f29390e9ad41fc6014031b9972322

data/.travis.yml

@@ -1,3 +1,21 @@
 language: ruby
 rvm:
+  - 2.0.0
+  - 2.1.0
   - 2.1.5
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+  - rbx-2
+  - ruby-head
+  - jruby-head
+
+before_install:
+  - gem update --system
+  - gem --version
+
+gemfile:
+  - Gemfile
+
+notifications:
+  email: false

data/Nessus6.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   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"
 end

data/README.md

@@ -1,3 +1,5 @@
+[![Code Climate](https://codeclimate.com/github/kkirsche/Nessus6/badges/gpa.svg)](https://codeclimate.com/github/kkirsche/Nessus6) [![Test Coverage](https://codeclimate.com/github/kkirsche/Nessus6/badges/coverage.svg)](https://codeclimate.com/github/kkirsche/Nessus6/coverage)
+
 # Nessus6
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/Nessus6`. To experiment with that code, run `bin/console` for an interactive prompt.

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test/'
+  t.libs << 'bin/'
+  t.libs << 'lib/'
+  t.pattern = 'test/spec/**/*_spec.rb'
+end
+
+task :default => :test

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "Nessus6"
+require 'bundler/setup'
+require 'Nessus6'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/Nessus6.rb

@@ -1,19 +1,23 @@
 require 'hurley'
+# Must go first
+require 'Nessus6/verification'
+# Inherits from verification
 require 'Nessus6/version'
-require 'Nessus6/editor/methods'
-require 'Nessus6/session/methods'
-require 'Nessus6/users/methods'
-require 'Nessus6/file/methods'
-require 'Nessus6/folders/methods'
-require 'Nessus6/groups/methods'
-require 'Nessus6/permissions/methods'
-require 'Nessus6/scans/methods'
+require 'Nessus6/editor'
+require 'Nessus6/session'
+require 'Nessus6/user'
+require 'Nessus6/file'
+require 'Nessus6/folder'
+require 'Nessus6/group'
+require 'Nessus6/permission'
+require 'Nessus6/scan'
+require 'Nessus6/errors/authentication_error'
 
 module Nessus6
   # The Client class is used to interact with the Nessus API
   class Client
-    attr_reader :client, :editor, :session, :users, :file, :folders, :groups,
-                :permissions, :scans
+    attr_reader :client, :editor, :session, :user, :file, :folder, :group,
+                :permission, :scan
 
     def initialize(credentials, nessus)
       nessus[:port] = '8834' unless nessus.key?(:port)
@@ -37,9 +41,9 @@ module Nessus6
         @client.header['X-Cookie'] = "token = #{@token}"
       elsif credentials[:access_key] && credentials[:secret_key]
       else
-        fail AuthenticationError, 'Authentication credentials not provided. ' \
-          'Must provided either username and password or access key and' \
-          ' secret key.'
+        fail Nessus6::Error::AuthenticationError, 'Authentication credentials' \
+          ' not provided. Must provided either username and password or ' \
+          'access key and secret key.'
       end
     end
 
@@ -52,12 +56,12 @@ module Nessus6
     def build_clients(client)
       @session = Nessus6::Session.new client
       @editor = Nessus6::Editor.new client
-      @users = Nessus6::Users.new client
+      @user = Nessus6::User.new client
       @file = Nessus6::File.new client
-      @folders = Nessus6::Folders.new client
-      @groups = Nessus6::Groups.new client
-      @permissions = Nessus6::Permissions.new client
-      @scans = Nessus6::Scans.new client
+      @folder = Nessus6::Folder.new client
+      @group = Nessus6::Group.new client
+      @permission = Nessus6::Permission.new client
+      @scan = Nessus6::Scan.new client
     end
   end
 end

data/lib/Nessus6/editor.rb

@@ -0,0 +1,88 @@
+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.
+  # https://localhost:8834/api#/resources/editor
+  class Editor
+    include Nessus6::Verification
+
+    public
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Export the given audit file.
+    #
+    # @param type [String] The type of template to retrieve (scan or policy).
+    # @param object_id [String, Fixnum] The unique id of the object.
+    # @param file_id [String, Fixnum] The id of the file to export.
+    # @return [Hash]
+    def audits(type, object_id, file_id)
+      response = @client.get("editor/#{type}/#{object_id}/audits/#{file_id}")
+      verify response,
+             forbidden: 'You do not have permission to export the audit file',
+             not_found: 'Audit file does not exist',
+             internal_server_error: 'Internal server error occurred.'
+    end
+
+    # Returns the details for the given template.
+    #
+    # @param type [String] The type of template to retrieve (scan or policy).
+    # @param template_uuid [String] The uuid for the template.
+    # @return [Hash] Details for the given template
+    def details(type, template_uuid)
+      response = @client.get("editor/#{type}/templates/#{template_uuid}")
+      verify response,
+             forbidden: 'You do not have permission to open the template',
+             not_found: 'Template does not exist',
+             internal_server_error: 'Internal server error occurred.'
+    end
+
+    # Returns the requested object.
+    #
+    # @param type [String] The type of template to retrieve (scan or policy).
+    # @param id [String, Fixnum] The unique id of the object.
+    # @return [Hash] The requested object
+    def edit(type, id)
+      response = @client.get("editor/#{type}/#{id}")
+      verify response,
+             forbidden: 'You do not have permission to open the object',
+             not_found: 'Object does not exist',
+             internal_server_error: 'Internal server error occurred.'
+    end
+
+    # Returns the template list.
+    #
+    # @param type [String] The type of template to retrieve (scan or policy).
+    # @return [Hash] { "templates": [ template Resource ] }
+    def list(type)
+      response = @client.get("editor/#{type}/templates")
+      verify response,
+             forbidden: 'You do not have permission to view the list',
+             internal_server_error: 'Internal server error occurred.'
+    end
+
+    # Returns the plugin description. This request requires standard user
+    # permissions
+    #
+    # @param policy_id [String, Fixnum] The id of the policy to lookup.
+    # @param family_id [String, Fixnum] The id of the family to lookup within
+    #   the policy.
+    # @param plugin_id [String, Fixnum] The id of the plugin to lookup within
+    #   the family.
+    # @return [Hash] The plugin output
+    def plugin_description(policy_id, family_id, plugin_id)
+      response = @client.get("editor/policy/#{policy_id}/families/#{family_id}/plugins/#{plugin_id}")
+      verify response,
+             internal_server_error: 'Internal server error occurred.'
+    end
+  end
+end

data/lib/Nessus6/errors/authentication_error.rb

@@ -0,0 +1,8 @@
+module Nessus6
+  module Error
+    # Authentication error is thrown when the user cannot authenticate with
+    # Nessus
+    class AuthenticationError < StandardError
+    end
+  end
+end

data/lib/Nessus6/errors/bad_request.rb

@@ -1,7 +1,11 @@
-# BadRequestError represents HTTP 400 Responses
-# The server cannot or will not process the request
-# due to something that is perceived to be a client
-# error (e.g. malformed request syntax, invalid request
-# message framing, or deceptive request routing)
-class BadRequestError < StandardError
+module Nessus6
+  module Error
+    # BadRequestError represents HTTP 400 Responses
+    # The server cannot or will not process the request
+    # due to something that is perceived to be a client
+    # error (e.g. malformed request syntax, invalid request
+    # message framing, or deceptive request routing)
+    class BadRequestError < StandardError
+    end
+  end
 end

data/lib/Nessus6/errors/conflict.rb

@@ -1,6 +1,10 @@
-# ConflictError represents HTTP 409 Responses
-# Indicates that the request could not be processed
-# because of a conflict in the request such as an
-# edit conflict in the case of multiple updates.
-class ConflictError < StandardError
+module Nessus6
+  module Error
+    # ConflictError represents HTTP 409 Responses
+    # Indicates that the request could not be processed
+    # because of a conflict in the request such as an
+    # edit conflict in the case of multiple updates.
+    class ConflictError < StandardError
+    end
+  end
 end

data/lib/Nessus6/errors/forbidden.rb

@@ -1,6 +1,10 @@
-# ForbiddenError represents HTTP 403 Responses
-# The request was a valid request, but the server
-# is refusing to respond to it. Unlike 401 Unauthorized
-# responses, authenticating will make no difference
-class ForbiddenError < StandardError
+module Nessus6
+  module Error
+    # ForbiddenError represents HTTP 403 Responses
+    # The request was a valid request, but the server
+    # is refusing to respond to it. Unlike 401 Unauthorized
+    # responses, authenticating will make no difference
+    class ForbiddenError < StandardError
+    end
+  end
 end

data/lib/Nessus6/errors/internal_server_error.rb

@@ -1,5 +1,9 @@
-# InternalServerError represents HTTP 500 Responses
-# A generic error message, given when an unexpected condition
-# was encountered and no more specific message is suitable
-class InternalServerError < StandardError
+module Nessus6
+  module Error
+    # InternalServerError represents HTTP 500 Responses
+    # A generic error message, given when an unexpected condition
+    # was encountered and no more specific message is suitable
+    class InternalServerError < StandardError
+    end
+  end
 end

data/lib/Nessus6/errors/not_found.rb

@@ -1,6 +1,10 @@
-# NotFoundError represents HTTP 404 Responses
-# The requested resource could not be found but may be
-# available again in the future. Subsequent requests by
-# the client are permissible.
-class NotFoundError < StandardError
+module Nessus6
+  module Error
+    # NotFoundError represents HTTP 404 Responses
+    # The requested resource could not be found but may be
+    # available again in the future. Subsequent requests by
+    # the client are permissible.
+    class NotFoundError < StandardError
+    end
+  end
 end

data/lib/Nessus6/errors/unauthorized.rb

@@ -1,8 +1,12 @@
-# UnauthorizedError represents HTTP 401 Responses
-# Similar to 403 Forbidden, but specifically for use
-# when authentication is required and has failed or has
-# not yet been provided. The response must include a
-# WWW-Authenticate header field containing a challenge
-# applicable to the requested resource
-class UnauthorizedError < StandardError
+module Nessus6
+  module Error
+    # UnauthorizedError represents HTTP 401 Responses
+    # Similar to 403 Forbidden, but specifically for use
+    # when authentication is required and has failed or has
+    # not yet been provided. The response must include a
+    # WWW-Authenticate header field containing a challenge
+    # applicable to the requested resource
+    class UnauthorizedError < StandardError
+    end
+  end
 end

data/lib/Nessus6/errors/unknown.rb

@@ -1,4 +1,8 @@
-# UnknownError represents something that Nessus doesn't
-# provide an HTTP code for
-class UnknownError < StandardError
+module Nessus6
+  module Error
+    # UnknownError represents something that Nessus doesn't
+    # provide an HTTP code for
+    class UnknownError < StandardError
+    end
+  end
 end

data/lib/Nessus6/file.rb

@@ -0,0 +1,31 @@
+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
+  class File
+    include Nessus6::Verification
+
+    public
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Uploads a file. This request requires read only user permissions.
+    #
+    # @param file_path [String] Path to the file to upload
+    # @param file_type [String] MIME type. E.g. 'text/plain'
+    # @return [Hash] Returns a :fileuploaded string.
+    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 response,
+             internal_server_error: 'File failed to upload'
+    end
+  end
+end

data/lib/Nessus6/folder.rb

@@ -0,0 +1,72 @@
+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.
+  # https://localhost:8834/api#/resources/folders
+  class Folder
+    include Nessus6::Verification
+
+    public
+
+    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 response,
+             bad_request: 'Folder name is invalid',
+             forbidden: 'You do not have permission to create a folder.',
+             internal_server_error: 'Server failed to create the folder.'
+    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 response,
+             forbidden: 'Cannot delete a system folder.',
+             not_found: 'Folder does not exist.',
+             internal_server_error: 'Server failed to delete the folder.'
+    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 response,
+             forbidden: 'Cannot rename a system folder.',
+             not_found: 'Folder does not exist.',
+             internal_server_error: 'Server failed to rename the folder.'
+    end
+
+    alias_method :rename, :edit
+
+    # Returns the current user's scan folders.
+    #
+    # @return [Hash] { "folders": [folder Resource] }
+    def list
+      response = @client.get('folders')
+      verify response,
+             forbidden: 'You do not have permission to view the folder list.',
+             internal_server_error: 'An internal server error occurred.'
+    end
+  end
+end