nrperb 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2004-2011 Bulat Shakirzyanov
+
+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.md

@@ -0,0 +1,24 @@
+# NRPErb
+
+Ruby interface to Nagios Remote Plugin Executor daemon.
+Let's you run remote nagios checks from ruby
+
+```ruby
+require 'nrpe'
+
+NRPE.session :host => '10.190.157.127', :port => 5666 do |session|
+  result = session.execute('check_load')
+  puts result.ok?
+  puts result.warning?
+  puts result.critical?
+  puts result.text
+end
+```
+
+## Install
+
+* clone repository
+* run `bundle install`
+* run `bundle exec check_nrpe -h`
+* ...
+* profit

data/bin/check_nrpe

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+
+require 'optparse'
+require 'nrpe'
+
+options = {
+  :command => '_NRPE_CHECK'
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: check_nrpe -H <host> [-n] [-u] [-p <port>] [-t <timeout>] [-c <command>] [<arglist...>]"
+
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("-n", nil, "Do not use ssl") do |n|
+    options[:use_ssl] = false
+  end
+
+  opts.on("-u", nil, "Make socket timeouts return an UNKNOWN state instead of CRITICAL") do |n|
+    options[:unknown_on_timeout] = true
+  end
+
+  opts.on("-H", :REQUIRED, "=MANDATORY", "The address of the host running the NRPE daemon") do |host|
+    options[:host] = host
+  end
+
+  opts.on("-p", "=MANDATORY", Integer, "The port on which the daemon is running (default=5666)") do |port|
+    options[:port] = port
+  end
+
+  opts.on("-t", "=MANDATORY", Integer, "Number of seconds before connection times out (default=10)") do |timeout|
+    options[:timeout] = timeout
+  end
+
+  opts.on("-c", "=MANDATORY", String, "The name of the command that the remote daemon should run") do |command|
+    options[:command] = command
+  end
+
+  opts.separator ""
+  opts.separator "Optional arguments that should be passed to the command."
+  opts.separator "Multiple arguments should be separated by a space."
+  opts.separator "If provided, this must be the last option supplied on the command line."
+  opts.separator ""
+end.parse!
+
+NRPE.session(options) do |session|
+  begin
+    result = session.execute(options[:command])
+    $stdout.puts(result.text)
+    exit result.code
+  rescue Errno::ETIMEDOUT, Timeout::Error => e
+    $stderr.puts 'Socket timed out'
+    exit 2 if options[:unknown_on_timeout]
+    exit 3
+  rescue Errno::ECONNREFUSED => e
+    $stderr.puts 'Connection refused'
+    exit 3
+  end
+end

data/lib/nrpe.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "bundler/setup"
+
+module NRPE
+  autoload :Packet,  'nrpe/packet'
+  autoload :Result,  'nrpe/result'
+  autoload :Session, 'nrpe/session'
+
+  def NRPE.session(options)
+    session = Session.new(options)
+    begin
+      yield session if block_given?
+    ensure
+      session.close
+    end
+  end
+end

data/lib/nrpe/packet.rb

@@ -0,0 +1,59 @@
+require 'zlib'
+
+module NRPE
+  class Packet < Struct.new(:packet_version, :packet_type, :crc32, :result_code, :buffer, :random)
+    NRPE_PACKET_VERSION_3 = 3
+    NRPE_PACKET_VERSION_2 = 2
+    NRPE_PACKET_VERSION_1 = 1
+
+    QUERY_PACKET = 1
+    RESPONSE_PACKET = 2
+
+    MAX_PACKETBUFFER_LENGTH = 1024
+
+    MAX_PACKET_SIZE = 12 + 1024
+
+    def initialize(*args)
+      if args.length == 1
+        super(*args.first.unpack("nnNnA#{MAX_PACKETBUFFER_LENGTH}n"))
+      else
+        super
+      end
+    end
+
+    def packet_version
+      super || NRPE_PACKET_VERSION_2
+    end
+
+    def packet_type=(type)
+      raise "Invalid packet type" unless [QUERY_PACKET, RESPONSE_PACKET].include?(type)
+      super
+    end
+
+    def result_code
+      super || 0
+    end
+
+    def random
+      super || 1
+    end
+
+    def to_s
+      [packet_version, packet_type, crc32, result_code, buffer, random].pack("nnNna#{MAX_PACKETBUFFER_LENGTH}n")
+    end
+
+    def crc32
+      crc32 = calculate_crc32 unless crc32
+    end
+
+    def validate_crc32
+      raise 'Invalid CRC32' unless crc32 == calculate_crc32
+    end
+
+    private
+
+    def calculate_crc32
+      Zlib::crc32([packet_version, packet_type, 0, result_code, buffer, random].pack("nnNna#{MAX_PACKETBUFFER_LENGTH}n"))
+    end
+  end
+end

data/lib/nrpe/result.rb

@@ -0,0 +1,25 @@
+module NRPE
+  class Result
+    CODE_OK = 0
+    CODE_WARNING = 1
+    CODE_CRITICAL = 2
+
+    attr_reader :code, :text
+
+    def initialize(code, text)
+      @code, @text = code, text
+    end
+
+    def ok?
+      @code == CODE_OK
+    end
+
+    def warning?
+      @code == CODE_WARNING
+    end
+
+    def critical?
+      @code == CODE_CRITICAL
+    end
+  end
+end

data/lib/nrpe/session.rb

@@ -0,0 +1,71 @@
+require 'socket'
+require 'openssl'
+require 'timeout'
+
+module NRPE
+  class Session
+    def initialize(options)
+      process_options!(options)
+    end
+
+    def close
+      socket.close if @socket
+    end
+
+    def execute(check)
+      send_query(check)
+      response = read_response
+
+      Result.new(response.result_code, response.buffer)
+    end
+
+    private
+
+    def send_query(check)
+      packet = Packet.new.tap do |p|
+        p.packet_type = Packet::QUERY_PACKET
+        p.buffer = check
+      end
+      socket.write(packet.to_s)
+    end
+
+    def read_response
+      response = Packet.new(socket.read(Packet::MAX_PACKET_SIZE))
+      response.validate_crc32
+      response
+    end
+
+    def process_options!(options)
+      raise ArgumentError, "host is a required option" if options[:host].nil?
+      options[:port]    ||= 5666
+      options[:timeout] ||= 10
+      options[:use_ssl] ||= true
+      @options = options
+    end
+
+    def socket
+      @socket ||= begin
+        optval = [Integer(@options[:timeout]), 0].pack("l_2")
+
+        socket = timeout(@options[:timeout]) do
+          TCPSocket.open(@options[:host], @options[:port])
+        end
+
+        socket.setsockopt(:SOCKET, :RCVTIMEO, optval)
+        socket.setsockopt(:SOCKET, :SNDTIMEO, optval)
+
+        if @options[:use_ssl]
+          ssl_context = OpenSSL::SSL::SSLContext.new "SSLv23_client"
+          ssl_context.ciphers = 'ADH'
+          socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+          socket.sync_close = true
+          socket.connect
+        end
+
+        ObjectSpace.define_finalizer(self, proc {|id| socket.close})
+
+        socket
+      end
+    end
+  end
+end

data/lib/nrpe/version.rb

@@ -0,0 +1,3 @@
+module NRPE
+  VERSION = "0.1.0" unless defined?(::NRPE::VERSION)
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: nrperb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bulat Shakirzyanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-21 00:00:00.000000000Z
+dependencies: []
+description: NRPErb is a nagios remote plugin executor protocol implementation in
+  Ruby, that lets you ruby remove nagios checks from your ruby scripts
+email:
+- mallluhuct@gmail.com
+executables:
+- check_nrpe
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/check_nrpe
+- lib/nrpe/packet.rb
+- lib/nrpe/result.rb
+- lib/nrpe/session.rb
+- lib/nrpe/version.rb
+- lib/nrpe.rb
+- LICENSE
+- README.md
+homepage: http://github.com/avalanche123/nrperb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Execute nagios remote plugins from ruby
+test_files: []