netflow 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.2.0)
+    rake (0.9.2.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rspec (~> 2.3.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ian Morgan
+
+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.rdoc

@@ -0,0 +1,22 @@
+= netflow
+
+Ruby Netflow collector.
+
+  Netflow.start_collector
+
+
+== Contributing to netflow
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Ian Morgan. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "netflow"
+  gem.homepage = "http://github.com/seeingidog/netflow"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby Netflow collector based on EventMachine}
+  gem.description = %Q{Listens and parses netflow datagrams sent from network devices. More information on Netflow format: http://tools.ietf.org/html/rfc3954}
+  gem.email = "ian@ruby-code.com"
+  gem.authors = ["Ian Morgan"]
+  gem.add_runtime_dependency 'bindata'
+  gem.add_runtime_dependency 'eventmachine'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "netflow #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/netflow.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..','lib'))
+
+require 'netflow/collector'
+
+NetflowCollector.start_collector

data/lib/netflow.rb

@@ -0,0 +1,6 @@
+require 'bindata'
+require 'eventmachine'
+dir = File.expand_path(File.join(File.dirname(__FILE__),  'netflow'))
+['models/binary_models','parsers/parsers','storage/storage', 'collector'].each do |req|
+  require File.join(dir, req)
+end

data/lib/netflow/collector.rb

@@ -0,0 +1,25 @@
+class NetflowCollector
+
+  module Collector
+    def post_init
+      puts "Server listening."
+    end
+    def receive_data(data)
+      puts "Datagram recieved."
+      if data != nil
+        begin
+          Netflow.parse_packet(data)
+        rescue
+          puts "Error parsing packet"
+        end
+      end
+    end
+  end
+
+  def self.start_collector(bind_ip = '0.0.0.0', bind_port = 2055)
+    EventMachine::run do
+      EventMachine::open_datagram_socket(bind_ip, bind_port, Collector)
+    end
+  end
+
+end

data/lib/netflow/models/binary_models.rb

@@ -0,0 +1,72 @@
+class Header < BinData::Record
+  endian :big
+  uint16 :version
+end
+
+class Netflow5PDU < BinData::Record
+  endian :big
+  uint16 :version
+  uint16 :flow_records
+  uint32 :uptime
+  uint32 :unix_sec
+  uint32 :unix_nsec
+  uint32 :flow_seq_num
+  uint8  :engine_type
+  uint8  :engine_id
+  bit1   :sampling_type
+  bit14  :sampling_interval
+  array  :records, :initial_length => :flow_records do
+    uint32 :srcaddr
+    uint32 :dstaddr
+    uint32 :nexthop
+    uint16 :iface_in
+    uint16 :iface_out
+    uint32 :packets
+    uint32 :octets
+    uint32 :first_uptime
+    uint32 :last_uptime
+    uint16 :srcport
+    uint16 :dstport
+    uint8  :pad1
+    uint8  :tcpflags
+    uint8  :proto
+    uint8  :tos
+    uint16 :srcas
+    uint16 :dstas
+    uint8  :srcmask
+    uint8  :dstmask
+    uint16 :pad2
+  end
+end
+
+class TemplateFlowset < BinData::Record
+  endian :big
+  uint16 :flowset_id
+  uint16 :flowset_length
+  uint16 :flowset_template_id
+  uint16 :flowset_field_count
+  string :flowset, :read_length => :flowset_length
+end
+
+class Netflow9PDU < BinData::Record
+  endian :big
+  uint16 :version
+  uint16 :flow_records
+  uint32 :uptime
+  uint32 :unix_sec
+  uint32 :flow_seq_num
+  uint32 :source_id
+  template_flowset :template_flowset
+
+  uint16 :template_id
+  uint16 :data_flowset_length
+  #string :data, :read_length  =>  lambda { data_flowset_length - 32 }
+end
+
+class DataFlowset < BinData::Record
+  endian :big
+
+  uint16 :template_id
+  uint16 :data_flowset_length
+end
+

data/lib/netflow/parsers/parsers.rb

@@ -0,0 +1,16 @@
+class Netflow
+  def self.parse_packet(data)
+    begin
+      header = Header.read(data)
+      if header.version == 9
+        flowset = Netflow9PDU.read(data)
+      elsif header.version == 5
+        flowset = Netflow5PDU.read(data)
+      else
+        raise "Unsupported Netflow version"
+      end
+    rescue
+      raise "Error reading header."
+    end
+  end
+end

data/lib/netflow/storage/storage.rb

@@ -0,0 +1,2 @@
+class Netflow
+end

data/netflow.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "netflow"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ian Morgan"]
+  s.date = "2012-04-10"
+  s.description = "Listens and parses netflow datagrams sent from network devices. More information on Netflow format: http://tools.ietf.org/html/rfc3954"
+  s.email = "ian@ruby-code.com"
+  s.executables = ["netflow.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/netflow.rb",
+    "lib/netflow.rb",
+    "lib/netflow/collector.rb",
+    "lib/netflow/models/binary_models.rb",
+    "lib/netflow/parsers/parsers.rb",
+    "lib/netflow/storage/storage.rb",
+    "netflow.gemspec",
+    "spec/netflow_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/seeingidog/netflow"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby Netflow collector based on EventMachine"
+  s.test_files = [
+    "spec/netflow_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<bindata>, [">= 0"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<bindata>, [">= 0"])
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<bindata>, [">= 0"])
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+  end
+end
+

data/spec/netflow_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Netflow collector" do
+#  include EM::Spec
+#  it "should start an netflow collector" do
+#    em do
+#      Netflow.start_collector
+#      done
+#    end
+#  end
+
+end
+
+describe "Netflow parser" do
+  
+  it "should parse a mock netflow version 5 datagram" do
+    @mock_datagram5 = ''
+  end
+  it "should parse a mock netflow version 9 datagram" do
+    @mock_datagram6 = ''
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'netflow'
+#require "em-spec/rspec"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: netflow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154569940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2154569940
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2154568920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2154568920
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2154557140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *2154557140
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2154556320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154556320
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: &2154555300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154555300
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &2154553660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154553660
+description: ! 'Listens and parses netflow datagrams sent from network devices. More
+  information on Netflow format: http://tools.ietf.org/html/rfc3954'
+email: ian@ruby-code.com
+executables:
+- netflow.rb
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/netflow.rb
+- lib/netflow.rb
+- lib/netflow/collector.rb
+- lib/netflow/models/binary_models.rb
+- lib/netflow/parsers/parsers.rb
+- lib/netflow/storage/storage.rb
+- netflow.gemspec
+- spec/netflow_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/seeingidog/netflow
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4577197314272604240
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby Netflow collector based on EventMachine
+test_files:
+- spec/netflow_spec.rb
+- spec/spec_helper.rb