Nessus6 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fd4cdfa535bfd5f763074b2364aec98c58c128b
+  data.tar.gz: ea9e76b76ec8b8944933bd4258cd6460b3daac07
+SHA512:
+  metadata.gz: aa72aa5257c78b7751279ff72cf953e46c3a8b05b71d419988059245e772ecd5c75b3e8937c1a811c3d329ab41a067037dc8391578f4a9e63ab22cac264d01d4
+  data.tar.gz: 3c7d133ebdc754dcff55b64e57a31129abc4a28cc2286176e0f393253c343ced1e294c831bc23373a5df781d571e923e103deb7670ca031802a938902dd196b1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Nessus6.gemspec
+gemspec

data/Nessus6.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Nessus6/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Nessus6"
+  spec.version       = Nessus6::VERSION
+  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.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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_runtime_dependency "hurley", "~> 0.1"
+end

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Nessus6'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Nessus6
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/Nessus6/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/Nessus6.rb

@@ -0,0 +1,63 @@
+require 'hurley'
+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'
+
+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
+
+    def initialize(credentials, nessus)
+      nessus[:port] = '8834' unless nessus.key?(:port)
+
+      # Create our client
+      @client = Hurley::Client.new 'https://' + nessus[:ip] + ':' + nessus[:port]
+      @client.ssl_options.skip_verification = true
+
+      authenticate credentials
+
+      build_clients @client
+
+      @client
+    end
+
+    def authenticate(credentials)
+      # Open up a session and get our token so we can make queries
+      @session = Nessus6::Session.new @client
+      if credentials[:username] && credentials[:password]
+        @token = @session.create(credentials[:username], credentials[:password])
+        @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.'
+      end
+    end
+
+    def logout
+      @session.destroy
+    end
+
+    private
+
+    def build_clients(client)
+      @session = Nessus6::Session.new client
+      @editor = Nessus6::Editor.new client
+      @users = Nessus6::Users.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
+    end
+  end
+end

data/lib/Nessus6/editor/methods.rb

@@ -0,0 +1,108 @@
+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/errors/bad_request.rb

@@ -0,0 +1,7 @@
+# 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

data/lib/Nessus6/errors/conflict.rb

@@ -0,0 +1,6 @@
+# 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

data/lib/Nessus6/errors/forbidden.rb

@@ -0,0 +1,6 @@
+# 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

data/lib/Nessus6/errors/internal_server_error.rb

@@ -0,0 +1,5 @@
+# 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

data/lib/Nessus6/errors/not_found.rb

@@ -0,0 +1,6 @@
+# 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

data/lib/Nessus6/errors/unauthorized.rb

@@ -0,0 +1,8 @@
+# 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

data/lib/Nessus6/errors/unknown.rb

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

data/lib/Nessus6/file/methods.rb

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,100 @@
+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
+
+    def create(name)
+      response = @client.post('folders', name: name)
+      verify_create response
+    end
+
+    def delete(folder_id)
+      response = @client.delete("folders/#{folder_id}")
+      verify_delete response
+    end
+
+    def edit(folder_id, name)
+      response = @client.put("folders/#{folder_id}", name: name)
+      verify_edit response
+    end
+
+    alias_method :rename, :edit
+
+    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

@@ -0,0 +1,167 @@
+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
+
+    def add_user(group_id, user_id)
+      response = @client.post("groups/#{group_id}/users/#{user_id}")
+      verify_add_user response
+    end
+
+    def create(name)
+      response = @client.post('groups', name: name)
+      verify_create response
+    end
+
+    def delete(group_id)
+      response = @client.delete("groups/#{group_id}")
+      verify_delete response
+    end
+
+    def delete_user(group_id, user_id)
+      response = @client.delete("groups/#{group_id}/users/#{user_id}")
+      verify_delete_user response
+    end
+
+    def edit(group_id, name)
+      response = @client.put("groups/#{group_id}", name: name)
+      verify_edit response
+    end
+
+    alias_method :rename, :edit
+
+    def list
+      response = @client.get('groups')
+      verify_list response
+    end
+
+    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

data/lib/Nessus6/permissions/methods.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'Nessus6/errors/forbidden' # 403
+require 'Nessus6/errors/not_found' # 404
+require 'Nessus6/errors/unknown'
+
+module Nessus6
+  # The Editor class is for interacting with Nessus6 templates
+  class Permissions
+    def initialize(client)
+      @client = client
+    end
+
+    def change(object_type, object_id, permissions)
+      response = @client.put("permissions/#{object_type}/#{object_id}",
+                             body: permissions)
+      verify_change response
+    end
+
+    def list(object_type, object_id)
+      response = @client.get("permissions/#{object_type}/#{object_id}")
+      verify_list response
+    end
+
+    private
+
+    def verify_change(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 403
+        fail ForbiddenError, 'You do not have permission to edit 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 object'
+      when 404
+        fail NotFoundError, 'Object does not exist'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+  end
+end

data/lib/Nessus6/scans/methods.rb

@@ -0,0 +1,88 @@
+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 Editor class is for interacting with Nessus6 templates
+  class Scans
+    def initialize(client)
+      @client = client
+    end
+
+    def launch(scan_id, alt_targets = nil)
+      if alt_targets.is_a? Array
+        response = @client.post "scans/#{scan_id}/launch",
+                                alt_targets: alt_targets
+      else
+        response = @client.post "scans/#{scan_id}/launch"
+      end
+
+      verify_launch response
+    end
+
+    def list
+      response = @client.get 'scans'
+      JSON.parse response.body
+    end
+
+    def pause(scan_id)
+      response = @client.post "scans/#{scan_id}/pause"
+      verify_pause response
+    end
+
+    def stop(scan_id)
+      response = @client.post "scans/#{scan_id}/stop"
+      verify_stop response
+    end
+
+    private
+
+    def verify_launch(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 403
+        fail ForbiddenError, 'This scan is disabled.'
+      when 404
+        fail NotFoundError, 'Scan does not exist.'
+      when 500
+        fail InternalServerError, 'Failed to launch scan. This is usually due to the'\
+          ' scan already running.'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_pause(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 403
+        fail ForbiddenError, 'This scan is disabled.'
+      when 409
+        fail ConflictError, 'Scan is not active.'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_stop(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 404
+        fail NotFoundError, 'Scan does not exist.'
+      when 409
+        fail ConflictError, 'Scan is not active.'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+  end
+end

data/lib/Nessus6/session/methods.rb

@@ -0,0 +1,142 @@
+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
+  class Session
+    attr_reader :token
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(username, password)
+      response = @client.post('session',
+                          username: username, password: password)
+      verified = verify_create response
+      @token = verified['token']
+    end
+
+    def destroy
+      response = @client.delete('session')
+
+      case response.status_code
+      when 200
+        @token = ''
+        return true
+      when 401
+        fail 'No session exists'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def edit(user)
+      if user[:name] && user[:email]
+        response = @client.put('session', name: user[:name],
+                                          email: user[:email])
+      elsif user[:name]
+        response = @client.put('session', name: user[:name])
+      elsif user[:email]
+        response = @client.put('session', email: user[:email])
+      else
+        fail "User's name or email was not provided in hash form."
+      end
+      verify_edit response
+    end
+
+    def get
+      verify_get @client.get('session')
+    end
+
+    def password(new_password)
+      response = @client.put('session/chpasswd', password: new_password)
+      verify_password response
+    end
+
+    def keys
+      response = @client.put('session/keys')
+      verify_keys response
+    end
+
+    private
+
+    def verify_create(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 400
+        fail BadRequestError, 'Username format is not valid'
+      when 401
+        fail UnauthorizedError, 'Username or password is invalid'
+      when 500
+        fail InternalServerError, 'Too many users are connected'
+      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 edit the session data'
+      when 500
+        fail InternalServerError, 'Server failed to edit the user'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_get(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 403
+        fail ForbiddenError,
+             'You do not have permission to view the session data'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_password(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 400
+        fail BadRequestError, 'Password is too short'
+      when 401
+        fail UnauthorizedError,
+             'You do not have permission to change this password'
+      when 500
+        fail InternalServerError, 'Server failed to change the password'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_keys(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 401
+        fail UnauthorizedError,
+             'You are not logged in / authenticated'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+  end
+end

data/lib/Nessus6/users/methods.rb

@@ -0,0 +1,180 @@
+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
+  class Users
+    def initialize(client)
+      @client = client
+    end
+
+    def create(credentials, user_perm, user_info = {})
+      new_user = {}.tap do |user|
+        user[:username] = credentials[:username]
+        user[:password] = credentials[:password]
+        user[:permissions] = user_perm[:permissions]
+        user[:type] = user_perm[:type]
+        user[:name] = user_info[:name] if user_info.key?(:name)
+        user[:email] = user_info[:email] if user_info.key?(:email)
+      end
+
+      response = @client.post('users', new_user)
+
+      verify_create response
+    end
+
+    def delete(user_id)
+      response = @client.delete("users/#{user_id}")
+      verify_delete response
+    end
+
+    def edit(user_id, permissions, user_info = {})
+      edit_user = {}.tap do |user|
+        user[:permissions] = permissions
+        user[:name] = user_info[:name] if user_info.key?(:name)
+        user[:email] = user_info[:email] if user_info.key?(:email)
+      end
+      response = @client.post("users/#{user_id}", edit_user)
+      verify_edit response
+    end
+
+    def get(user_id)
+      response = @client.get("users/#{user_id}")
+      verify_get response
+    end
+
+    def list
+      response = @client.get('users')
+      verify_list response
+    end
+
+    def password(user_id, new_password)
+      response = @client.post("users/#{user_id}/chpasswd",
+                              password: new_password)
+      verify_password response
+    end
+
+    def keys(user_id)
+      response = @client.get("users/#{user_id}/keys")
+      verify_keys response
+    end
+
+    private
+
+    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 this user'
+      when 409
+        fail ConflictError, 'User already exists'
+      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 true
+      when 403
+        fail ForbiddenError, 'Not authorized to delete users'
+      when 404
+        fail NotFoundError, 'You do not have permission to delete this user'
+      when 409
+        fail ConflictError, 'Cannot delete your own account'
+      when 500
+        fail InternalServerError,
+             'Failed to delete the user due to an interal server error'
+      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 this user'
+      when 404
+        fail NotFoundError, 'User does not exist'
+      when 409
+        fail ConflictError, 'Cannot edit your own permissions'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_get(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 404
+        fail NotFoundError, 'User 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_password(response)
+      case response.status_code
+      when 200
+        return true
+      when 400
+        fail BadRequestError, 'Password is too short'
+      when 403
+        fail ForbiddenError,
+             'You do not have permission to change the users password'
+      when 404
+        fail NotFoundError, 'User does not exist'
+      when 500
+        fail InternalServerError, 'Server failed to change the password'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+
+    def verify_keys(response)
+      case response.status_code
+      when 200
+        return JSON.parse response.body
+      when 403
+        fail ForbiddenError, 'You do not have permission to generate API keys'
+      when 404
+        fail NotFoundError, 'User does not exist'
+      when 500
+        fail InternalServerError, 'Server failed to change the keys'
+      else
+        fail UnknownError, 'An unknown error occurred. Please consult Nessus' \
+                           'for further details.'
+      end
+    end
+  end
+end

data/lib/Nessus6/version.rb

@@ -0,0 +1,3 @@
+module Nessus6
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: Nessus6
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Kirsche
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: hurley
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Gem for interacting with the Tenable Nessus 6 REST API.
+email:
+- kev.kirsche@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Nessus6.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/Nessus6.rb
+- lib/Nessus6/editor/methods.rb
+- lib/Nessus6/errors/bad_request.rb
+- lib/Nessus6/errors/conflict.rb
+- lib/Nessus6/errors/forbidden.rb
+- lib/Nessus6/errors/internal_server_error.rb
+- 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/version.rb
+homepage: https://github.com/kkirsche/Nessus6
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: "[Under Construction] Nessus 6 API Gem"
+test_files: []