grok 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Sharpe
+
+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,55 @@
+= Grok
+
+Grok aims to be a replacement for the now antiquated SEC (Simple Event 
+Correlator).
+
+== Usage
+A simple Grok watcher needs very little in the way of configuration
+  require 'grok'
+  
+  configure do |c|
+    c.file = "/var/log/auth.log"
+    c.interval = 2
+    c.replay = 0
+  end
+
+The above script won't do very much, though.
+
+=== Configuration
+There's only a few configuration parameters for Grok at this stage
+
+* file: The log file to watch
+* interval: How often to check the log file for changes (in seconds)
+* replay: The number of lines to read from the bottom of the file on startup
+
+=== Responding to log events
+At it's most basic, you can simply get Grok to print a message as it
+receives them (pretty pointless)
+  on :log do
+    puts "I just got a log message"
+  end
+
+Lets try something a bit more useful though.  Lets say I want to know every
+time there's an SSH authenitcation failure.  For that, we can make use of the
+RegExp functionality in the event handlers
+
+  on :log, /sshd\[\d+\]: Failed password for ([\d\w]+) from ([\d\.]+)/ do |username, ip|
+    puts "SSH authentication failure for #{username} from #{ip}
+  end
+
+This is a bit better.  You could go further to have it automatically block the 
+IP with iptables if you wanted (see examples/ssh_sentry.rb).
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tim Sharpe. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "grok"
+    gem.summary = %Q{A ruby log event correlator}
+    gem.description = %Q{A more featureful replacement for SEC (Simple Event Correlator) in Ruby.}
+    gem.email = "tim@sharpe.id.au"
+    gem.homepage = "http://github.com/rodjek/grok"
+    gem.authors = ["Tim Sharpe"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "file-tail", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grok #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/ssh_sentry.rb

@@ -0,0 +1,11 @@
+require 'grok'
+
+configure do |c|
+  c.file = "/var/log/auth.log"
+  c.interval = 5
+  c.replay = 0
+end
+
+on :log, /Failed password for root from ([\d\.]+)/ do |ip|
+  ret = `/sbin/iptables -I INPUT --source #{ip} -j REJECT`
+end

data/lib/grok.rb

@@ -0,0 +1,18 @@
+require 'grok/watcher'
+
+$watcher = Grok::Watcher.new
+
+%w(configure on).each do |method|
+  eval(<<-EOF)
+    def #{method}(*args, &block)
+      $watcher.#{method}(*args, &block)
+    end
+  EOF
+end
+
+at_exit do
+  unless defined?(Test::Unit)
+    raise $! if $!
+    $watcher.start
+  end
+end

data/lib/grok/watcher.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'file/tail'
+
+module Grok
+  Config = Struct.new(:file, :interval, :replay)
+  
+  class Watcher
+    attr_accessor :config, :file, :interval, :match, :replay
+
+    def initialize(&b)
+      @events = {}
+      @config = Config.new("/var/log/messages", 10)
+
+      #instance_eval(&b) if block_given?
+    end
+
+    def configure(&b)
+      b.call(@config)
+    end
+
+    def on(event, match=//, &block)
+      match = match.to_s if match.is_a? Integer
+      (@events[event] ||= []) << [Regexp.new(match), block]
+    end
+
+    def dispatch(event, log)
+      if handler = find(event, log)
+        regexp, block = *handler
+        self.match = log.match(regexp).captures
+        invoke block
+      end
+    end
+
+    def start
+      File.open(@config.file) do |log|
+        log.extend(File::Tail)
+        log.interval = @config.interval
+        log.backward(@config.replay)
+        log.tail { |line|
+          dispatch(:log, line)
+        }
+      end
+    end
+
+  private
+    def find(type, log)
+      if events = @events[type]
+        events.detect {|regexp,_|
+          log.match(regexp)
+        }
+      end
+    end
+
+    def invoke(block)
+      mc = class << self; self; end
+      mc.send :define_method, :__grok_event_handler, &block
+
+      bargs = case block.arity <=> 0
+        when -1; match
+        when 0; []
+        when 1; match[0..block.arity-1]
+      end
+
+      catch(:halt) {
+        __grok_event_handler(*bargs)
+      }
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'grok'
+
+class Test::Unit::TestCase
+end

data/test/test_grok.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGrok < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: grok
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Tim Sharpe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-14 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: file-tail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A more featureful replacement for SEC (Simple Event Correlator) in Ruby.
+email: tim@sharpe.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/ssh_sentry.rb
+- lib/grok.rb
+- lib/grok/watcher.rb
+- test/helper.rb
+- test/test_grok.rb
+has_rdoc: true
+homepage: http://github.com/rodjek/grok
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby log event correlator
+test_files: 
+- test/helper.rb
+- test/test_grok.rb
+- examples/ssh_sentry.rb