openvas-cli 0.1.1 → 0.2.0

data/lib/openvas-cli/openvas-cli.rb

@@ -1,273 +0,0 @@
-require 'rubygems'
-require 'socket' 
-require 'timeout'
-require 'openssl'
-require 'base64'
-require 'nokogiri'
-require 'time'
-
-require 'vas_exceptions'
-
-
-# = OpenvasCli
-#
-# Provides connectivity to OpenVAS Management service.
-#
-# Author::    Reed Swenson (mailto:fleureed@gmail.com)
-# Copyright:: Copyright (c) 2010 eBankSystems, Inc.
-# License::   GPL v2.0
-class OpenvasCli
-  
-  # OpenVAS username.
-  # 
-  # Will be used for all requests.  
-  # 
-  # Defaults to: +admin+ 
-  def self.user
-    @@user ||= "admin"
-  end
-  
-  # See: user
-  def self.user=(val)
-    @@user = val
-  end
-  
-  # OpenVAS passowrd
-  #
-  # Defaults to: ""
-  def self.password
-    @@password ||= ""
-  end
-  
-  # See password
-  def self.password=(val)
-    @@password = val
-  end
-  
-  # Hostname or IP that hosts the OpenVAS Management service.
-  #
-  # Defaults to: +localhost+
-  def self.host
-    @@host ||= "localhost"
-  end
-
-  # See: host
-  def self.host=(val)
-    @@host = val
-  end
-
-  # Port on which the OpenVAS Management Service is listening.
-  #
-  # Defaults to: 9390  
-  def self.port
-    @@port ||= 9390
-  end
-
-  # See: port
-  def self.port=(val)
-    @@port = val
-  end
-
-  # Communications timeout in seconds.
-  #
-  # Defaults to: 5  
-  def self.time_out
-    @@time_out ||= 5
-  end
-
-  # See: time_out
-  def self.time_out=(val)
-    @@time_out = val
-  end
-
-  # Communications buffer size in bytes.
-  #
-  # Defaults to: 512  
-  def self.buffer_size
-    @@buffer_size ||= 512
-  end
-
-  # See: buffer_size
-  def self.buffer_size=(val)
-    @@buffer_size = val
-  end
-  
-  # By default, new will attempt to log into the OpenVAS management service.
-  # If this is set to +false+, the client will bypas the login when initialized.
-  # Before the client can send or receive any messages, login must be called.
-  #
-  # Defaults to: +true+
-  def self.auto_login
-    @@auto_login ||= true
-  end
-
-  # See: auto_login
-  def self.auto_login=(val)
-    @@auto_login = val
-  end
-  
-  # Log4r style Logger used by the client.
-  def self.logger
-    @@logger
-  end
-
-  # See: logger 
-  def self.logger=(val)
-    @@logger = val
-  end
-  
-  # Initializes the client, connectes to the OpenVas Managment service specified 
-  # by host & port, and unless auto_login is set to +false+, loggs in using 
-  # username and password.
-  def initialize()
-    connect
-    
-    if OpenvasCli.auto_login == true
-      login
-    end
-  end
-  
-  # Closes the active connection and sets it up for re-connection.
-  def close
-    @socket.close if @socket
-    @socket = nil
-  end
-  
-  # Logs into the OpenVAS Management service using the specified username and
-  # passoword.  By default, this method is called by new unless auto_login is 
-  # set to +false+.
-  def login
-    log_message("Logging in: :user => #{OpenvasCli.user}", :info)
-    areq = Nokogiri::XML::Builder.new { |xml|
-      xml.authenticate {
-        xml.credentials {
-          xml.username { xml.text(OpenvasCli.user) }
-          xml.password { xml.text(OpenvasCli.password) }
-        }
-      }
-    }
-    
-    send_receive(areq.doc)
-  end
-  
-  # Sends a message to the OpenVAS Management service and receives a response.
-  # If, for some reaon, the connection has been severed, it will re-establish 
-  # the connection and attempts to login again. 
-  # ---
-  # Parameters:
-  # [request] an Nokogiri::XML::Document or String to send to the management service.
-  # ---
-  # Returns:
-  # * A Nokogiri::XML::Document that contains the response from the management service.
-  # ---
-  # Exceptions:
-  # [VasExceptions::CommunicationException] When the transmission times out or encounters an unexpected end of file.
-  # [VasExceptions::CommandException] When the management service does not send back a 20* response status.
-  # ---
-  # Usage:
-  #     cli = OpenvasCli.new
-  #     req = Nokogiri::XML::Builder.new{ |xml|
-  #       xml.do_something
-  #     }
-  #     response = cli.send_receive(req.doc)
-  #     #parse the response and do something meaningful
-  def send_receive (request)
-    if request.kind_of? String
-      tosend = request
-    else
-      tosend = request.to_xml
-    end
-    
-    unless @socket && @socket.state !~ /closed/i
-      log_message("Socket closed, Reconnecting", :info)
-      connect
-      login
-    end
-    log_message("Sending: #{tosend}", :debug)
-
-    @socket.puts(tosend)
-
-    rbuf=''
-    size=0
-    begin  
-      begin
-      timeout(OpenvasCli.time_out) {
-          a = @socket.sysread(OpenvasCli.buffer_size)
-          size=a.length
-          rbuf << a
-      }
-      rescue Timeout::Error
-        size=0
-        msg = "Command Timed Out (#{$!})\nCommand: #{tosend}"
-        log.message msg, :error
-        raise VasExceptions::CommunicationException.new(msg)
-      rescue EOFError
-        msg = "EOFError(#{$!})\nReceived: #{rbuf}\nCommand: #{tosend}"
-        log_message msg, :error
-        raise VasExceptions::CommunicationException.new(msg)
-      end
-    end while size>=OpenvasCli.buffer_size
-    response= Nokogiri::XML(rbuf)
-    
-    log_message "RECEIVED: #{response.to_xml}", :debug
-    
-    unless extract_value_from("//@status", response) =~ /20\d/
-      msg = "Command Failed: #{extract_value_from("//@status_text", response)}\n" +
-            "Command: #{tosend}" 
-      log_message msg, :error
-      raise VasExceptions::CommandException.new(msg)
-    end
-    
-    response
-  end
-  
-private
-
-  def log_message(msg, level)
-    if OpenvasCli.logger
-      case level
-      when :debug
-        OpenvasCli.logger.debug msg
-      when :info
-        OpenvasCli.logger.info msg
-      when :warn
-        OpenvasCli.logger.warn msg
-      when :error
-        OpenvasCli.logger.error msg
-      when :fatal
-        OpenvasCli.logger.fatal msg
-      end
-    end
-  end
-
-  def extract_value_from(x_str, n)
-    ret = ""
-    if x_str =~ /@/
-      ret = n.at_xpath(x_str).value  if n.at_xpath(x_str)
-    else
-      tn =  n.at_xpath(x_str)
-      if tn
-        if tn.children.count > 0
-          tn.children.each { |tnc|
-            if tnc.text?
-              ret = tnc.text
-            end
-          }
-        else
-          ret = tn.text
-        end
-      end
-    end
-    
-    ret
-  end
-  
-  def connect
-    log_message("Connecting: :host => #{OpenvasCli.host}, :port => #{OpenvasCli.port}", :info)
-    plain_socket       = TCPSocket.open(OpenvasCli.host, OpenvasCli.port)
-    ssl_context        = OpenSSL::SSL::SSLContext.new
-    @socket            = OpenSSL::SSL::SSLSocket.new(plain_socket, ssl_context)
-    @socket.sync_close = true
-    @socket.connect
-  end
-end

data/spec/openvas-cli/openvas-cli_spec.rb

@@ -1,45 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'nokogiri'
-
-
-describe "OpenvasCli" do
-  before(:all) do
-    @cli = OpenvasCli.new
-  end
-  
-  after(:all) do
-    @cli.close
-  end
-
-  it 'should create a valid instance with the provided credentials' do
-    #handled in the before(:all) block
-  end
-  
-  it 'should pull rule definitions', :slow => true do
-    defs = @cli.get_rule_defs
-    defs.count.should > 0
-    
-    defs.each { |d|
-      d.oid.should_not be nil
-      d.name.should_not be nil
-      d.name.length.should > 0
-    }
-    
-  end
-  
-  it 'should throw a command exception' do
-    bad_msg = Nokogiri::XML::Builder.new { |xml|
-      xml.foo
-    }
-    
-    lambda {@cli.send_receive(bad_msg.doc)}.should raise_error(VasExceptions::CommandException)
-  end
-  
-  it 'should throw a CommunicationException' do
-    bad_msg = Nokogiri::XML::Builder.new { |xml|
-      xml.get_schedules(:details => '1', :sort_field => 'next_time')
-    }
-    
-    lambda {@cli.send_receive(bad_msg.doc)}.should raise_error(VasExceptions::CommunicationException)
-  end
-end