nessus 0.0.1.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 825f74b9310ffb651d9ec525d7d40419e9528ea8
+  data.tar.gz: d77bd6c102bc7becfea59d182e11516723ecb29e
+SHA512:
+  metadata.gz: ab37c5926f975501ac7a872db4e4c814bee41d21050d744e322d15b67b8c94e069d8c4d3012eb5bfe2154587a0f390c0cd8b32fe3b90bbeb552dc5d380947446
+  data.tar.gz: d737f0c6b2ea3be02d2dd701cad9cb9bff489394d89761c5081042b54e7316edf5f0192ce4c9275768bfdcc6474fbd89c89d592993fb1a85b29579af4af43b74

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    nessus (0.0.1.beta.1)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    method_source (0.8.2)
+    multipart-post (1.2.0)
+    pry (0.9.12.3)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    slop (3.4.6)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  nessus!
+  pry
+  rake
+  yard

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Erran Carey, Marcus J. Carey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Nessus
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nessus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nessus
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+task :default => :install

data/lib/nessus.rb

@@ -0,0 +1,6 @@
+require 'nessus/client'
+require 'nessus/version'
+
+# @author Erran Carey <me@errancarey.com>
+module Nessus
+end

data/lib/nessus/client.rb

@@ -0,0 +1,98 @@
+require 'cgi'
+require 'faraday'
+require 'json'
+require 'pry'
+require 'nessus/client/file'
+require 'nessus/client/policy'
+require 'nessus/client/report'
+require 'nessus/client/report2'
+require 'nessus/client/scan'
+require 'nessus/version'
+
+module Nessus
+  # @author Erran Carey <me@errancarey.com>
+  class Client
+    include Nessus::Client::File
+    include Nessus::Client::Policy
+    include Nessus::Client::Report
+    include Nessus::Client::Report2
+    include Nessus::Client::Scan
+
+    class << self
+      # @!attribute verify_ssl
+      #   @return [Boolean] whether to verify SSL with Faraday (default: true)
+      attr_accessor :verify_ssl
+    end
+
+    # @!attribute connection
+    #   @return [Faraday::Connection]
+    attr_reader :connection
+
+    # @param [String] host the base URL to use when connecting to the Nessus API
+    def initialize(host)
+      @verify_ssl = Nessus::Client.verify_ssl.nil? ? true : false
+      @connection = Faraday.new host, :ssl => { :verify => @verify_ssl }
+      @connection.headers[:user_agent] = "Nessus.rb v#{Nessus::VERSION}".freeze
+    end
+
+    # POST /login
+    #
+    # @param [String] login the username of the account to use for authentication
+    # @param [String] password the password of the account to use for authentication
+    def authenticate(login, password)
+      payload = {
+        :login => login,
+        :password => password,
+        :json => 1
+      }
+      resp = post '/login', payload
+
+      if resp['reply']['status'].eql? 'OK'
+        connection.headers[:cookie] = "token=#{resp['reply']['contents']['token']}"
+      end
+
+      true
+    end
+
+    # @return [String] {#inspect}'s output with a censored session token
+    def inspect
+      inspected = super
+
+      if connection
+        cookie = CGI::Cookie.parse(connection.headers[:cookie])
+
+        if cookie.keys.include? 'token'
+          inspected.gsub cookie['token'], ('*' * cookie['token'].length)
+        end
+      end
+
+      inspected
+    end
+
+    # @param [String] url the URL/path to send a GET request using the
+    #   connection object and default headers/parameters
+    # @param [Hash] params the query parameters to send with the request
+    # @param [Hash] headers the headers to send along with the request
+    def get(url, params = {}, headers = {})
+      params ||= {}
+      params[:json] ||= 1
+
+      params  = connection.params.merge(params)
+      headers = connection.headers.merge(headers)
+      resp    = connection.get url, params, headers
+      JSON.parse(resp.body)
+    end
+
+    # @param [String] url the URL/path to send a GET request using the
+    #   connection object and default headers/payload
+    # @param [Hash] payload the JSON body to send with the request
+    # @param [Hash] headers the headers to send along with the request
+    def post(url, payload = nil, headers = nil, &block)
+      payload ||= {}
+      payload[:json] ||= 1
+
+      resp = connection.post(url, payload, headers, &block)
+      JSON.parse(resp.body)
+    end
+  end
+end

data/lib/nessus/client/chapter.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/feed.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/file.rb

@@ -0,0 +1,14 @@
+module Nessus
+  class Client
+    # @author Erran Carey <me@errancarey.com>
+    module File
+      # GET /file/report/download
+      #
+      # @param [String] uuid the unique ID (name) of the report to download
+      # @return [String] the specified report as an XML string
+      def download_report(uuid)
+        connection.get '/file/report/download', :report => uuid
+      end
+    end
+  end
+end

data/lib/nessus/client/plugins.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/policy.rb

@@ -0,0 +1,12 @@
+module Nessus
+  class Client
+    # @author Erran Carey <me@errancarey.com>
+    module Policy
+      # GET /policy/list
+      def policies
+        resp = get '/policy/list'
+        resp['reply']['contents']['policies']['policy']
+      end
+    end
+  end
+end

data/lib/nessus/client/preferences.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/report.rb

@@ -0,0 +1,15 @@
+module Nessus
+  class Client
+    # @author Erran Carey <me@errancarey.com>
+    module Report
+      # GET /report/list
+      #
+      # @return [Array<Hash>] an array of report hashes
+      def reports
+        resp = get '/report/list'
+
+        resp['reply']['contents']['reports']['report']
+      end
+    end
+  end
+end

data/lib/nessus/client/report2.rb

@@ -0,0 +1,7 @@
+module Nessus
+  class Client
+    # @author Erran Carey <me@errancarey.com>
+    module Report2
+    end
+  end
+end

data/lib/nessus/client/scan.rb

@@ -0,0 +1,34 @@
+module Nessus
+  class Client
+    # @author Erran Carey <me@errancarey.com>
+    module Scan
+      # POST /scan/new
+      #
+      # @param [String] target a string that contains the scan target(s)
+      # @param [Fixnum] policy_id a numeric ID that references the policy to use
+      # @param [String] scan_name the name to assign to this scan
+      # @param [Fixnum] seq a unique identifer for the specific request
+      def create_scan(target, policy_id, scan_name, seq = nil)
+        payload = {
+          :target => target,
+          :policy_id => policy_id,
+          :scan_name => scan_name,
+          :json => 1
+        }
+        payload[:seq] = seq if seq
+        resp = post '/scan/new', payload
+
+        resp['reply']['contents']['scan']
+      end
+
+      # GET /scan/list
+      #
+      # @return [Array<Hash>] an array of scan hashes
+      def scans
+        resp = get '/scan/list'
+
+        resp['reply']['contents']['scans']['scan']
+      end
+    end
+  end
+end

data/lib/nessus/client/server.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/timezones.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/users.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/client/uuid.rb

@@ -0,0 +1,4 @@
+module Nessus
+  class Client
+  end
+end

data/lib/nessus/version.rb

@@ -0,0 +1,4 @@
+module Nessus
+  # The version of the Nessus.rb library
+  VERSION = '0.0.1.beta.1'
+end

data/nessus.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nessus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nessus'
+  spec.version       = Nessus::VERSION
+  spec.authors       = ['Erran Carey', 'Marcus J. Carey']
+  spec.email         = ['me@errancarey.com', 'mjc@threatagent.com']
+  spec.description   = %q{A Ruby client for the Nessus 5.x JSON REST API}
+  spec.summary       = %q{A Ruby client for the Nessus 5.x JSON REST API. UPDATE_ME}
+  spec.homepage      = 'https://github.com/threatagent/nessus.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard'
+
+  spec.add_runtime_dependency     'faraday'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: nessus
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta.1
+platform: ruby
+authors:
+- Erran Carey
+- Marcus J. Carey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client for the Nessus 5.x JSON REST API
+email:
+- me@errancarey.com
+- mjc@threatagent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/nessus.rb
+- lib/nessus/client.rb
+- lib/nessus/client/chapter.rb
+- lib/nessus/client/feed.rb
+- lib/nessus/client/file.rb
+- lib/nessus/client/plugins.rb
+- lib/nessus/client/policy.rb
+- lib/nessus/client/preferences.rb
+- lib/nessus/client/report.rb
+- lib/nessus/client/report2.rb
+- lib/nessus/client/scan.rb
+- lib/nessus/client/server.rb
+- lib/nessus/client/timezones.rb
+- lib/nessus/client/users.rb
+- lib/nessus/client/uuid.rb
+- lib/nessus/version.rb
+- nessus.gemspec
+homepage: https://github.com/threatagent/nessus.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the Nessus 5.x JSON REST API. UPDATE_ME
+test_files: []
+has_rdoc: