antfarm-core 0.5.0.beta1

data/lib/antfarm/plugins/load-host.rb

@@ -0,0 +1,105 @@
+################################################################################
+#                                                                              #
+# 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.  #
+#                                                                              #
+################################################################################
+
+module Antfarm
+  module Plugin
+    class FileDoesNotExistError < Antfarm::AntfarmError; end
+
+    class LoadHost
+      include Antfarm::Plugin
+
+      def initialize
+        super({ :name   => 'Load Host',
+                :desc   => 'Given a file with one IP address per line, create a new IP Interface in the DB',
+                :author => 'Bryan T. Richardson <btricha>' },
+              [ { :name     => :input_file,
+                  :desc     => 'File with IP addresses in it',
+                  :type     => String,
+                  :required => true },
+                { :name     => :tags,
+                  :desc     => 'Comma-separated list of tags for each interface',
+                  :type     => String,
+                  :required => false }
+              ])
+      end
+
+      def run(options)
+        print_message "Parsing file #{options[:input_file]}"
+
+        begin
+          File.open(options[:input_file]) do |file|
+            file.each do |line|
+              data = line.strip.split(' ')
+
+              if data.length == 1
+                iface = Antfarm::Model::IpInterface.find_by_address(data[0])
+
+                if iface.nil?
+                  Antfarm::Model::IpInterface.create(:address => data[0])
+                else
+                  node      = iface.layer3_interface.layer2_interface.node
+                  node.name = data[0]
+                  node.save
+                end
+              else
+                name = data.shift
+                node = Antfarm::Model::Node.find_by_name(name)
+
+                if node.nil?
+                  node      = Antfarm::Model::Node.new
+                  node.name = name
+                  node.save
+
+                  for address in data
+                    iface = Antfarm::Model::IpInterface.find_by_address(address)
+                    if iface.nil?
+                      Antfarm::Model::IpInterface.create(:address => address)
+                    else
+                      l2iface      = iface.layer3_interface.layer2_interface
+                      l2iface.node = node
+                      l2iface.save
+                    end
+                  end
+                else
+                  # TODO
+                end
+              end
+            end
+          end
+        rescue Errno::ENOENT
+          raise FileDoesNotExistError, "The file '#{options[:input_file]}' doesn't exist"
+        rescue Exception => e
+          raise Antfarm::AntfarmError, e.message
+        end
+      end
+    end
+  end
+end

data/lib/antfarm/plugins/load-network.rb

@@ -0,0 +1,71 @@
+################################################################################
+#                                                                              #
+# 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.  #
+#                                                                              #
+################################################################################
+
+module Antfarm
+  module Plugin
+    class FileDoesNotExistError < Antfarm::AntfarmError; end
+
+    class LoadNetwork
+      include Antfarm::Plugin
+
+      def initialize
+        super({ :name   => 'Load Network',
+                :desc   => 'Given a file with one IP network address per line, create a new IP Network in the DB',
+                :author => 'Bryan T. Richardson <btricha>' },
+              [ { :name     => :input_file,
+                  :desc     => 'File with IP networks in it',
+                  :type     => String,
+                  :required => true }
+              ])
+      end
+
+      def run(options)
+        print_message "Parsing file #{options[:input_file]}"
+
+        begin
+          File.open(options[:input_file]) do |file|
+            file.each do |line|
+              print_message "Loading network #{line.strip}"
+
+              unless Antfarm::Model::IpNetwork.find_by_address line.strip
+                Antfarm::Model::IpNetwork.create :address => line.strip
+              end
+            end
+          end
+        rescue Errno::ENOENT
+          raise FileDoesNotExistError, "The file '#{options[:input_file]}' doesn't exist"
+        rescue Exception => e
+          raise Antfarm::AntfarmError, e.message
+        end
+      end
+    end
+  end
+end

data/lib/antfarm/plugins/nmap/parse-xml.rb

@@ -0,0 +1,84 @@
+################################################################################
+#                                                                              #
+# 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.  #
+#                                                                              #
+################################################################################
+
+module Antfarm
+  module Plugin
+    module Nmap
+      class FileDoesNotExistError < Antfarm::AntfarmError; end
+
+      class ParseXml
+        include Antfarm::Plugin
+
+        def initialize
+          super({ :name   => 'Parse Nmap XML Output',
+                  :desc   => 'Parses the XML result of an Nmap scan and creates an IP interface for each host',
+                  :author => 'Bryan T. Richardson <btricha>' },
+                [ { :name     => :input,
+                    :desc     => 'Nmap XML output file or directory',
+                    :type     => String,
+                    :required => true }
+                ])
+        end
+
+        def run(options)
+          input   = options[:input]
+
+          if File.directory?(input)
+            Find.find(input) do |path|
+              if File.file?(path)
+                parse(path)
+              end
+            end
+          else
+            parse(input)
+          end
+        end
+
+        def parse(file)
+          print_message "Parsing file #{file}"
+
+          begin
+            results = REXML::Document.new(File.new(file))
+            results.elements.each('nmaprun') do |scan|
+              scan.elements.each('host') do |host|
+                Antfarm::Model::IpInterface.create :address => host.elements['address'].attributes['addr']
+              end
+            end
+          rescue Errno::ENOENT
+            raise FileDoesNotExistError, "The file #{file} doesn't exist"
+          rescue Exception => e
+            raise Antfarm::AntfarmError, e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/antfarm/version.rb

@@ -0,0 +1,9 @@
+module Antfarm
+  MAJOR = 0
+  MINOR = 5
+  BUG   = 0
+
+  def self.version
+    return "#{MAJOR}.#{MINOR}.#{BUG}"
+  end
+end

data/lib/tasks/spec.rake

@@ -0,0 +1,56 @@
+################################################################################
+#                                                                              #
+# 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.  #
+#                                                                              #
+################################################################################
+
+require 'spec/rake/spectask'
+
+SPEC_SUITES = [
+  { :id => :models, :title => 'models', :files => %w(spec/models/*_spec.rb) }
+]
+
+namespace :spec do
+  SPEC_SUITES.each do |suite|
+    desc "Run all specs in #{suite[:title]} spec suite"
+    Spec::Rake::SpecTask.new(suite[:id]) do |t|
+      files = []
+
+      if suite[:files]
+        suite[:files].each { |glob| files += Dir[glob] }
+      end
+
+      if suite[:dirs]
+        suite[:dirs].each { |glob| files += Dir["#{glob}/**/*_spec.rb"] }
+      end
+
+      t.spec_files = files
+      t.spec_opts  = [ '--color' ]
+    end
+  end
+end

data/man/antfarm-plugins.1

@@ -0,0 +1,69 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "ANTFARM\-PLUGINS" "1" "September 2010" "" "ANTFARM"
+.
+.SH "NAME"
+\fBantfarm\-plugins\fR \-\- plugins for the ANTFARM passive network mapping tool
+.
+.SH "DESCRIPTION"
+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.
+.
+.P
+ANTFARM plugins provide an easy way to extend the parsing and outputting of
+data into and out of ANTFARM. Currently available plugins are described below.
+.
+.SH "PLUGINS"
+load\-host:
+.
+.P
+Given a file that contains a list of IP addresses, one per line, this plugin
+simply creates an IpInterface model for each address provided.
+.
+.TP
+\fB\-\-input\-file\fR \fIfile\fR
+The location of the file containing the IP addresses
+.
+.P
+load\-network:
+.
+.P
+Given a file that contains a list of IP networks, one per line, this plugin
+simply creates and IpNetwork model for each network address provided.
+.
+.TP
+\fB\-\-input\-file\fR \fIfile\fR
+The location of the file containing the IP network addresses
+.
+.SH "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.
+.
+.P
+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:
+.
+.P
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+.
+.P
+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.
+.
+.P
+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/man/antfarm-plugins.1.ronn

@@ -0,0 +1,57 @@
+antfarm-plugins(1) -- plugins for the ANTFARM passive network mapping tool
+==========================================================================
+
+## DESCRIPTION
+
+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 plugins provide an easy way to extend the parsing and outputting of
+data into and out of ANTFARM. Currently available plugins are described below.
+
+## PLUGINS
+
+load-host:
+
+Given a file that contains a list of IP addresses, one per line, this plugin
+simply creates an IpInterface model for each address provided.
+
+  * `--input-file` <file>:
+    The location of the file containing the IP addresses
+
+load-network:
+
+Given a file that contains a list of IP networks, one per line, this plugin
+simply creates and IpNetwork model for each network address provided.
+
+  * `--input-file` <file>:
+    The location of the file containing the IP network addresses
+
+## 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.