antfarm 0.4.0 → 0.5.0.beta2

data/README.md

@@ -0,0 +1,160 @@
+# ANTFARM
+
+ANTFARM (Advanced Network Toolkit For Assessments and Remote Mapping) is a
+passive network mapping application that utilizes output from existing network
+examination tools to populate its OSI-modeled database. This data can then be
+used to form a ‘picture’ of the network being analyzed.
+
+ANTFARM can also be described as a data fusion tool that does not directly
+interact with the network. The analyst can use a variety of passive or active
+data gathering techniques, the outputs of which are loaded into ANTFARM and
+incorporated into the network map. Data gathering can be limited to completely
+passive techniques when minimizing the risk of disrupting the operational
+network is a concern.
+
+Please note that version 0.5.0 is the first version where ANTFARM is broken up
+into two separate components - the core and the command line interface.
+
+If you are looking for a version of ANTFARM pre 0.5.0, please download one of
+the tagged versions from the ANTFARM-CORE project at
+http://github.com/antfarm-core.
+
+## STATUS OF BETA RELEASE
+
+Because version 0.5.0 is the first version that has the client split out from
+the core ANTFARM library, the client gem is staying in a 'beta' status while
+the core library is in 'beta' status.
+
+Note that in order to install a pre-release version of a gem (such as the beta
+version of ANTFARM 0.5.0), you must specify the --pre-release option when using
+`gem install` along with the full version name (i.e. --version 0.5.0.beta).
+
+Also, if you have version 0.4.0 and 0.5.0 installed, you can specify which
+version to use when running ANTFARM from the command line.
+
+To run version 0.4.0, do the following:
+
+    $> antfarm _0.4.0_ <command> <options>
+
+To run version 0.5.0, just replace 0.4.0 with 0.5.0 or just leave it off. The
+`_<version>_` syntax is used by the executable for each gem to allow the user
+to specify a specific version. Otherwise, the latest version is used.
+
+## SYNOPSIS
+
+`antfarm` [ <global options> ] command|plugin [ <command/plugin options> ]
+
+`antfarm` -h, --help
+
+## DISCLAIMER
+
+While the ANTFARM tool itself is completely passive (it does not have any
+built-in means of gathering data directly from devices or networks), network
+admin tools that users of ANTFARM may choose to gather data with may or may not
+be passive. The authors of ANTFARM hold no responsibility in how users decide to
+gather data they wish to feed into ANTFARM.
+
+## FILES
+
+Unless it already exists, a '.antfarm' directory is created in the current
+user's home directory. This directory will contain a default configuration file,
+the SQLite3 database used by ANTFARM (if the user specifies for SQLite3 to be
+used, which is also the default), and log files generated when using ANTFARM.
+Custom plugins created by users will be made available to the ANTFARM
+application when they are placed in the '.antfarm/plugins' directory.
+
+Each plugin developed for ANTFARM specifies the input and/or output requirements
+when being used. To see what inputs are required for a particular plugin, type:
+
+    $ antfarm help <plugin>
+
+## OPTIONS
+
+ANTFARM's default method of operation is to parse input data or generate output
+data using a specified plugin. The plugin to use is specified on the command
+line as a sub-command, and each plugin developed specifies it's own required
+arguments. Global ANTFARM commands include:
+
+  * `-e`, `--env` <env>:
+    The ANTFARM environment to use when executing the given sub-command. The
+    default environment is 'antfarm'. Setting the environment variable affects
+    things like database used, log file used and configuration settings used.
+
+  * `-l`, `--log-level` <level>:
+    The log level used when executing the given sub-command. Optional levels
+    include debug, info, warn, error and fatal. The default log level used is
+    'warn'.
+
+  * `-v`, `--version`:
+    Display the current version of ANTFARM.
+
+  * `-h`, `--help`:
+    Display useful help information for ANTFARM.
+
+## EXAMPLES
+
+Display the default help message for ANTFARM:
+
+    $ antfarm -h
+
+    or
+
+    $ antfarm help
+
+Show information about all the plugins currently available in ANTFARM:
+
+    $ antfarm show
+
+Show information specific to an available ANTFARM plugin:
+
+    $ antfarm help <plugin>
+
+Execute an ANTFARM plugin:
+
+    $ antfarm load_host --input-file path/to/host/data.txt
+
+Execute an ANTFARM plugin using a specified environment:
+
+    $ antfarm -e foo load_host --input-file path/to/host/data.txt
+
+Execute an ANTFARM plugin using a specified environment and log level:
+
+    $ antfarm -e foo -l debug load_host --input-file path/to/host/data.txt
+
+## VERSIONING INFORMATION
+
+This project uses the major/minor/bugfix method of versioning, similar to the
+ANTFARM-CORE project. Note that the major version number for this project will
+always match the major version number for the ANTFARM-CORE project. Any changes
+to the command line interface will be reflected in the minor version number.
+
+## HOMEPAGE
+
+See http://ccss-sandia.github.com/antfarm for more details.
+
+## COPYRIGHT
+
+Copyright (2008-2010) Sandia Corporation. Under the terms of Contract
+DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains certain
+rights in this software.
+
+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, distribute with modifications,
+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
+ABOVE 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.
+
+Except as contained in this notice, the name(s) of the above copyright holders
+shall not be used in advertising or otherwise to promote the sale, use or other
+dealings in this Software without prior written authorization.

data/bin/antfarm

@@ -1,170 +1,152 @@
 #! /usr/bin/ruby
+ 
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
 
-# Copyright (2008) Sandia Corporation.
-# Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
-# the U.S. Government retains certain rights in this software.
-#
-# Original Author: Bryan T. Richardson, Sandia National Laboratories <btricha@sandia.gov>
-#
-# This library is free software; you can redistribute it and/or modify it
-# under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation; either version 2.1 of the License, or (at
-# your option) any later version.
-#
-# This library is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
-# details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with this library; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
-
-require File.dirname(__FILE__) + "/../config/boot"
-
-require 'find'
-require 'ostruct'
-require 'scparse'
-require 'dbmanage'
-require 'cpscript'
-require 'yaml'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 
-if (defined? USER_DIR) && File.exists?("#{USER_DIR}/config/defaults.yml")
-  defaults = YAML::load(IO.read("#{USER_DIR}/config/defaults.yml"))
-end
-defaults ||= Hash.new
+SUB_COMMANDS = ['help', 'db', 'console', 'show', 'version']
 
-@opts = OpenStruct.new
-@opts.environment = defaults['environment'] || 'antfarm'
-@opts.log_level = defaults['log_level'] || 'warn'
+def parse_options(defaults = {}, args = ARGV)
+  defaults['environment'] ||= 'antfarm'
+  defaults['log_level']   ||= 'warn'
 
-app = SCParse::ScriptCommandParser.new('antfarm')
-app.options = OptionParser.new do |opts|
-  opts.on('-e ENV', "Antfarm environment to use") do |env|
-    @opts.environment = env
-  end
-  opts.on('-l LEVEL', [:debug, :info, :warn, :error, :fatal], "Antfarm log level to use (debug, info, warn, error, fatal)") do |level|
-    # Level comes in as a Symbol -- must convert it to a String
-    # since ENV array doesn't seem to like symbols
-    @opts.log_level = level.to_s
+  sub_commands = SUB_COMMANDS.collect { |s| "  #{s}" }
+  plugins      = Array.new
+  # TODO <scrapcoder>: figure out how to order these alphabetically...
+  Antfarm::Plugin.discover { |p| plugins << "  #{p}" }
+
+  return Trollop::options(args) do
+    version 'ANTFARM 0.5.0 (c) Sandia National Laboratories'
+    banner  <<-EOS
+
+ANTFARM is a passive network mapping and data fusion application.
+Please see the man page (`gem man antfarm`) for more information.
+Please see the man page for ANTFARM plugins (`gem man antfarm-plugins`)
+for more detailed information about each plugin available.
+
+Available Subcommands:
+#{sub_commands.join("\n")}
+
+Available Plugins:
+#{plugins.join("\n")}
+
+Global Options:
+    EOS
+    opt     :env,       'Antfarm environment to use', :default => defaults['environment']
+    opt     :log_level, 'Antfarm log level to use',   :default => defaults['log_level']
+    # TODO <scrapcoder>: ugh... this is ugly
+    stop_on sub_commands.collect { |s| s.strip } + plugins.collect { |p| p.strip }
   end
 end
-app.set_prerequisites_block do |cmd|
-  bootstrap
-end
 
-app.add_command(SCParse::HelpCommand.new)
-app.add_command(Antfarm::DBManager.new)
-app.add_command(Antfarm::CPScript.new)
+require 'rubygems'
+require 'trollop'
 
-version = SCParse::Script.new('version', 'version.rb', false)
-version.set_execution_block do |cmd,args|
-  ARGV.clear
-  load cmd.path
-end
-app.add_command(version)
-
-rails = SCParse::Script.new('rails', 'script/server')
-rails.set_execution_block do |cmd,args|
-  ARGV.clear
-  ARGV << "webrick"
-  ARGV << "-e"
-  ARGV << @opts.environment
-  ARGV.concat(args)
-  load cmd.path
+begin
+  require 'antfarm-core'
+rescue LoadError
+  # If the above require fails, then maybe we're not using gems so let's assume
+  # the core library is in the same directory as this application and try to
+  # load it again.
+  $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../antfarm-core/lib')
+  require 'antfarm-core'
 end
-app.add_command(rails)
 
-console = SCParse::Script.new('console', 'console.rb', false)
-console.set_execution_block do |cmd,args|
-  ARGV.clear
-  ARGV << @opts.environment
-  load cmd.path
-end
-app.add_command(console)
-
-# TODO: Take into account situation where a directory
-# in the user's script directory might have the same
-# name as a directory in the application's script
-# directory.  What if actual scripts have the same name... ??
-#
-# Scripts can be categorized using directories.  If directories
-# exist in the scripts directory, turn them into a command.
-sub_commands = Hash.new
-Find.find(ANTFARM_ROOT + "/lib/scripts/") do |path|
-  if File.directory?(path)
-    base_name = File.basename(path)
-    unless base_name == 'scripts'
-      command = SCParse::Command.new(base_name)
-      app.add_command(command)
-      sub_commands[base_name] = command
-    end
-  elsif File.file?(path) && path =~ /rb$/
-    dir = File.basename(File.dirname(path))
-    name = File.basename(path, ".*")
-    script = SCParse::Script.new(name, path)
-    script.set_execution_block do |cmd,args|
-      ARGV.clear
-      ARGV.concat(args)
-      load cmd.path
-    end
-    if dir == 'scripts'
-      app.add_command(script)
+Antfarm::Helpers.outputter = STDOUT
+
+require 'yaml'
+defaults = YAML::load(IO.read(Antfarm::Helpers.defaults_file))
+
+require 'antfarm/cli'
+
+options = parse_options(defaults)
+
+ENV['ANTFARM_ENV']       = options[:env]
+ENV['ANTFARM_LOG_LEVEL'] = options[:log_level]
+
+require "#{ANTFARM_ROOT}/config/environment"
+
+framework = Antfarm::CLI::Framework.new
+
+begin
+  arg = ARGV.shift
+  case arg
+  when 'help'
+    if ARGV.empty?
+      parse_options defaults, ['-h']
+    elsif ARGV.first == 'db'
+      framework.db ['-h']
+    elsif ARGV.first == 'console'
+      framework.console ['-h']
+    elsif ARGV.first == 'show'
+      framework.show ['-h']
+    elsif ARGV.first == 'version'
+      framework.version ['-h']
     else
-      sub_commands[dir].add_command(script)
+      framework.use ARGV.shift
+      framework.show_info
+      framework.show_options
     end
-  end
-end
+  when 'db'
+    framework.db ARGV
+  when 'console'
+    framework.console
+  when 'show'
+    framework.show
+  when 'version'
+    framework.version
+  when nil
+    parse_options defaults, ['-h']
+  else
+    framework.use arg
+    options = Trollop::options do
+      banner <<-EOS
 
-sub_commands.clear
-if defined? USER_DIR
-  Find.find("#{USER_DIR}/scripts") do |path|
-    if File.directory?(path)
-      base_name = File.basename(path)
-      unless base_name == 'scripts'
-        # Checks to see if the 'custom' command already
-        # exists, and if not, creates one.
-        # Not doing this up front so a custom command
-        # will only be created if custom scripts exist.
-        if (custom = app.has_command?('custom')) == nil
-          custom = SCParse::Command.new('custom')
-          app.add_command(custom)
-        end
-        command = SCParse::Command.new(base_name)
-        custom.add_command(command)
-        sub_commands[base_name] = command
-      end
-    elsif File.file?(path) && path =~ /rb$/
-      dir = File.basename(File.dirname(path))
-      name = File.basename(path, ".*")
-      script = SCParse::Script.new(name, path)
-      script.set_execution_block do |cmd,args|
-        ARGV.clear
-        ARGV.concat(args)
-        load cmd.path
-      end
-      if dir == 'scripts'
-        # Checks to see if the 'custom' command already
-        # exists, and if not, creates one. Not doing this
-        # up front so a custom command will only be created
-        # if custom scripts exist.
-        if (custom = app.has_command?('custom')) == nil
-          custom = SCParse::Command.new('custom')
-          app.add_command(custom)
-          sub_commands['custom'] = custom
-        end
-        custom.add_command(script)
-      else
-        sub_commands[dir].add_command(script)
+Plugin - #{framework.plugin.info[:name]} (#{framework.plugin.name})
+#{framework.plugin.info[:author]}
+
+#{framework.plugin.info[:desc]}
+
+Options:
+      EOS
+      framework.plugin.options.each do |option|
+        name = option.delete(:name)
+        desc = option.delete(:desc)
+        opt name, desc, option
       end
     end
+    framework.run options
   end
+rescue => err
+# puts err
+# parse_options defaults, ['-h']
 end
-
-def bootstrap
-  ENV['ANTFARM_ENV'] = @opts.environment
-  ENV['ANTFARM_LOG_LEVEL'] = @opts.log_level
-  require "#{ANTFARM_ROOT}/config/environment"
-end
-
-app.parse!