send_nsca 0.4.9

data/README.rdoc

@@ -0,0 +1,17 @@
+key_a[key_index]= send_nsca
+
+Description goes here.
+
+== 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 kevinzen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "send_nsca"
+    gem.summary = %Q{A pure ruby implementation of the send_nsca program for sending passive alerts to Nagios through NSCA.}
+    gem.description = %Q{A pure ruby implementation of the send_nsca program for sending passive alerts to Nagios through NSCA.}
+    gem.email = "kbedell@backchannelmedia.com"
+    gem.homepage = "http://github.com/kevinzen/send_nsca"
+    gem.authors = ["kevinzen"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.require_path = "lib"
+    gem.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"] + Dir["spec/**/*"]
+    gem.test_files   = Dir["spec/**/*"]
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "send_nsca #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/send_nsca/send_nsca.rb

@@ -0,0 +1,149 @@
+module SendNsca
+
+  class NscaConnection
+
+    require 'socket'      # Sockets are in standard library
+    
+    # todo: replace timeout with a better method of handling communication timeouts.
+    require 'timeout'
+    
+    # params for connecting to the nsca/nagios server
+    attr_accessor  :nscahost
+    attr_accessor  :port
+    
+    #  connection status and error if one found
+    attr_reader   :connected
+    attr_reader   :error
+    
+    # read from the nsca/nagios server
+    attr_accessor  :xor_key_and_timestamp
+
+    # converted from :xor_key_and_timestamp
+    attr_accessor  :xor_key_and_timestamp_str
+    attr_accessor  :xor_key_string
+    attr_accessor  :xor_key
+    attr_accessor  :timestring    
+    attr_accessor  :timestamp_hex
+    attr_accessor  :timestamp
+
+    # status data to send to nagios
+    # Currently all 4 are required, meaning we only support 'service' passive checkins. 
+    # todo: add host checkins
+    attr_accessor  :hostname
+    attr_accessor  :service
+    attr_accessor  :return_code
+    attr_accessor  :status
+
+    # for sending to nsca
+    attr_accessor  :crc
+    PACKET_VERSION = 3
+    PACK_STRING = "nxx N a4 n a64 a128 a512xx"
+
+    CRC_TABLE = [ 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d]
+
+    def initialize(args)
+      
+      # connecting to nagios
+      @nscahost = args[:nscahost]
+      @port = args[:port]
+      @hostname = args[:hostname]
+      @service = args[:service]
+      @return_code = args[:return_code]
+      @status = args[:status]
+      @connected = false
+
+    end
+
+    def connect_and_get_keys
+      begin
+        timeout(1) do #the server has one second to answer
+          @tcp_client = TCPSocket.open(@nscahost, @port)
+          @connected = true
+          @xor_key_and_timestamp = @tcp_client.recv(132)
+        end
+      rescue
+        @connected = false
+        @error = "send_ncsa - error connecting to nsca/nagios: #{$!}"
+        puts  @error
+        raise # re-raise same exception
+      end
+      timestamp_for_logging
+    end
+    
+    def convert_timestamp
+      # convert timestamp for use in comm to nagios
+      @timestring = @xor_key_and_timestamp[@xor_key_and_timestamp.length-4,@xor_key_and_timestamp.length]
+    end
+
+    def timestamp_for_logging
+      # convert timestamp in a format we can log
+      @xor_key_and_timestamp_str = @xor_key_and_timestamp.unpack("H*")
+      @timestring_for_log = @xor_key_and_timestamp_str[0][256,8]
+      @timestamp_hex = @timestring_for_log.hex
+      @timestamp = Time.at(@timestamp_hex)
+    end
+
+    def convert_xor_key
+      # strip off the last 4 characters which are the timestamp
+      @xor_key = @xor_key_and_timestamp[0,@xor_key_and_timestamp.length-4]
+    end
+
+    def intialize_nsca_connection
+      connect_and_get_keys
+      convert_timestamp
+      convert_xor_key
+    end
+  
+    def send_nsca
+      intialize_nsca_connection
+      @crc = 0 
+      nsca_params = [PACKET_VERSION, @crc, @timestring, @return_code, @hostname, @service, @status ]
+      string_to_send_without_crc = nsca_params.pack(PACK_STRING)
+      
+      @crc = SendNsca::NscaConnection.crc32(string_to_send_without_crc)
+      nsca_params = [PACKET_VERSION, @crc, @timestring, @return_code, @hostname, @service, @status ]
+      string_to_send_with_crc = nsca_params.pack(PACK_STRING)
+      
+#      puts("DEBUG: PACKET_VERSION = #{PACKET_VERSION},\n @crc = #{@crc},\n  @timestring = #{@timestring},\n  @timestamp_hex = #{Time.at(timestamp_hex)},\n  @return_code #{@return_code},\n  @hostname = #{@hostname},\n  @service = #{@service},\n  @status = #{@status}\n")
+#      puts "string_to_send_with_crc = #{string_to_send_with_crc.length}"
+#      puts "string_to_send_with_crc = #{string_to_send_with_crc.unpack('H*')}"
+      
+       encrypted_string_to_send = SendNsca::NscaConnection.xor(@xor_key, string_to_send_with_crc)
+#      puts "encrypted_string_to_send = #{encrypted_string_to_send.length}"
+#      puts "encrypted_string_to_send = #{encrypted_string_to_send.unpack('H*')}"
+
+      @tcp_client.send(encrypted_string_to_send, 0)
+      @tcp_client.close
+    end
+
+    def self.crc32(c)
+        r = 0xFFFFFFFF
+        c.each_byte do |b|
+            r ^= b
+            8.times do
+              r = (r>>1) ^ (0xEDB88320 * (r & 1))
+            end
+        end
+        r ^ 0xFFFFFFFF
+    end
+    
+    def self.xor(xor_key, str)
+
+      str_a = str.unpack("C*")
+      key_a = xor_key.unpack("C*")
+      
+      result = []
+      key_index = 0
+      str_index = 0
+      str_a.each do |c|
+        result[str_index] = str_a[str_index] ^ key_a[key_index]
+        str_index += 1
+        key_index = key_index == xor_key.length-1 ? 0 : key_index += 1
+      end
+      ret_val = result.pack("C*")
+    end
+
+  end
+
+end
+

data/lib/send_nsca.rb

@@ -0,0 +1,3 @@
+module SendNsca
+end
+require File.join(File.dirname(__FILE__), 'send_nsca', 'send_nsca')

data/lib/tasks/nagios.rake

@@ -0,0 +1,64 @@
+namespace :nagios do
+  desc <<-DESC
+  Sends summary emails to those users who have requested they get a summary email of their clicks periodically. By default, this is everyone.
+  DESC
+  task :send_ok => [:environment] do
+    # make sure the params were passed correctly
+    if ENV['nag_host'].nil? || ENV['monitored_host'].nil? || ENV['service'].nil? || ENV['msg'].nil?
+      puts "Must pass params like this: rake nagios:send_ok nag_host=hostname monitored_host=this_hostname service=\"service-name\" msg=\"here's the message for the alert\""
+    else  
+      args = {
+        :nscahost => ENV['nag_host'],
+        :port => 5667,
+        :hostname => ENV['nag_host'],
+        :service => ENV['service'],
+        :return_code => 0,
+        :status => ENV['service']
+      }
+      nsca_connection = SendNsca::NscaConnection.new(args)
+      nsca_connection.send_nsca
+    end
+  end
+
+  desc <<-DESC
+  Resets all accounts that are set up to receie weekly or daily summaries so that the next time the summaries job is run they receive their summary email
+  DESC
+  task :send_warning => [:environment] do
+    # make sure the params were passed correctly
+    if ENV['nag_host'].nil? || ENV['monitored_host'].nil? || ENV['service'].nil? || ENV['msg'].nil?
+      puts "Must pass params like this: rake nagios:send_ok nag_host=hostname monitored_host=this_hostname service=\"service-name\" msg=\"here's the message for the alert\""
+    else  
+      args = {
+        :nscahost => ENV['nag_host'],
+        :port => 5667,
+        :hostname => ENV['nag_host'],
+        :service => ENV['service'],
+        :return_code => 1,
+        :status => ENV['service']
+      }
+      nsca_connection = SendNsca::NscaConnection.new(args)
+      nsca_connection.send_nsca
+    end
+  end
+
+  desc <<-DESC
+  Resets a single account so that it will receive a summary email the next time the job is run. Pass account by email like this: rake email:reset_by_email email=account@email.com
+  DESC
+  task :send_critical => [:environment] do
+    # make sure the params were passed correctly
+    if ENV['nag_host'].nil? || ENV['monitored_host'].nil? || ENV['service'].nil? || ENV['msg'].nil?
+      puts "Must pass params like this: rake nagios:send_ok nag_host=hostname monitored_host=this_hostname service=\"service-name\" msg=\"here's the message for the alert\""
+    else  
+      args = {
+        :nscahost => ENV['nag_host'],
+        :port => 5667,
+        :hostname => ENV['nag_host'],
+        :service => ENV['service'],
+        :return_code => 2,
+        :status => ENV['service']
+      }
+      nsca_connection = SendNsca::NscaConnection.new(args)
+      nsca_connection.send_nsca
+    end
+ end
+end

data/spec/send_nsca_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+include SendNsca
+
+describe "SendNsca" do
+
+  before(:each) do
+    # do something here if needed
+  end
+
+  it "should create a valid crc" do 
+    
+    #    Hello crc = 4157704578
+    hello = "Hello"
+    crc_hello = SendNsca::NscaConnection.crc32(hello)
+    crc_hello.should eql 4157704578
+    
+    #    world! crc = 2459426729
+    world = " world!"
+    hello_world_1 = SendNsca::NscaConnection.crc32(world)
+    hello_world_1.should eql 2459426729
+    
+    #    Hello World crc = 1243066710
+    hello_world = "Hello World"
+    hello_world_2 = SendNsca::NscaConnection.crc32(hello_world)
+    hello_world_2.should eql 1243066710
+  end
+
+  it "should perform valid xor encryption that can be deencrypted" do 
+  
+    xor_key = "\377\376\375"
+    str = "Hello!"
+    encrypted_str = SendNsca::NscaConnection.xor(xor_key,str)
+    deencrypted_str = SendNsca::NscaConnection.xor(xor_key,encrypted_str)
+    deencrypted_str.should eql str
+
+    xor_key = "adsfkahudsflihasdflkahdsfoaiudfh-3284rqiuy8rtq49087ty  2-\123\666\001\004\377"
+    str = "Hey There This is awesome!!!\000!"
+    encrypted_str = SendNsca::NscaConnection.xor(xor_key,str)
+    deencrypted_str = SendNsca::NscaConnection.xor(xor_key,encrypted_str)
+    deencrypted_str.should eql str
+    
+    str = "\000\000\000\000\111\222\333\123\321"
+    encrypted_str = SendNsca::NscaConnection.xor(xor_key,str)
+    deencrypted_str = SendNsca::NscaConnection.xor(xor_key,encrypted_str)
+    deencrypted_str.should eql str
+  end
+  
+  it "should correctly send a message to the server" do 
+    
+    args = {
+      :nscahost => "192.168.1.216",
+      :port => 5667,
+      :hostname => "kbedell",
+      :service => "passive-checkin-test01" ,
+      :return_code => 0,
+      :status => "TEST" 
+    }
+    nsca_connection = SendNsca::NscaConnection.new(args)
+  
+    nsca_connection.send_nsca
+
+  end
+  
+end
+

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'send_nsca'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: send_nsca
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 9
+  version: 0.4.9
+platform: ruby
+authors: 
+- kevinzen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A pure ruby implementation of the send_nsca program for sending passive alerts to Nagios through NSCA.
+email: kbedell@backchannelmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/send_nsca.rb
+- lib/send_nsca/send_nsca.rb
+- lib/tasks/nagios.rake
+- spec/send_nsca_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kevinzen/send_nsca
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A pure ruby implementation of the send_nsca program for sending passive alerts to Nagios through NSCA.
+test_files: 
+- spec/send_nsca_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb