hpfeeds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03b7575438eb4799c7d0b2e9a25795020f24c501
+  data.tar.gz: 931209087d6e02e8b34d73d14485e6277747bd46
+SHA512:
+  metadata.gz: 24dd1cea9aa0de6f341ecce8a960c1ce8d857b60eb11606458fbbbc7afbcb72164753c86bdfad6daf2f8bb3877f5658c3dda0dec212c2e74366867e0bfed1530
+  data.tar.gz: a6db74ca3dc4808fbc72208c73a28c729af8d84e27c70e3877c5d306b3368932a0ecaa60adb344e2b8df4c6c2ac3a75a4617c9c660f21704b950c71141beff4c

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+== 0.1.0
+First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Francesco Coda Zabetta
+
+MIT License
+
+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,60 @@
+# HPFeeds
+
+This gem should be used to make easy to interact (publish, subscribe) with a [HPFeeds broker](https://redmine.honeynet.org/projects/hpfeeds/wiki).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hpfeeds'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hpfeeds
+
+## Usage
+
+Here is a basic example:
+
+```ruby
+require "hpfeeds"
+
+def on_data(name, chan, payload)
+	puts "[%s] %s: %s" % [ chan, name, payload ]
+	# just an example here...
+	@hp.publish('channel', 'message')
+end
+
+def on_error(data)
+	STDERR.puts "ERROR: " + data.inspect
+end
+
+begin
+  @hp = HPFeeds::Client.new ({
+    host: hpfeeds_server_name_here,
+    port:   10000,
+    ident:  'XXXX',
+    secret: '123456'
+  })
+  channels = %w[ chan1 chan2 chanN ]
+  @hp.subscribe(*channels)
+  @hp.run(method(:on_data), method(:on_error))
+
+rescue => e
+  puts "Exception: #{e}"
+ensure
+  @hp.close if @hp
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'rake/clean'

data/lib/hpfeeds.rb

@@ -0,0 +1,7 @@
+require 'hpfeeds/version'
+
+module HPFeeds
+  autoload :Client, 'hpfeeds/client'
+  autoload :Exception, 'hpfeeds/exception'
+  autoload :Decoder, 'hpfeeds/decoder'
+end

data/lib/hpfeeds/client.rb

@@ -0,0 +1,149 @@
+require 'logger'
+require 'socket'
+
+module HPFeeds
+  OP_ERROR     = 0
+  OP_INFO	     = 1
+  OP_AUTH	     = 2
+  OP_PUBLISH   = 3
+  OP_SUBSCRIBE = 4
+
+  BUFSIZE    = 16384
+  HEADERSIZE = 5
+
+  class Client
+	  def initialize(options)
+      @host   = options[:host]
+      @port   = options[:port] || 10000
+      @ident  = options[:ident]
+      @secret = options[:secret]
+
+      @timeout   = options[:timeout]   || 3
+      @reconnect = options[:reconnect] || true
+      @sleepwait = options[:sleepwait] || 20
+
+      @connected = false
+		  @stopped   = false
+
+	  	@decoder      = Decoder.new
+      @logger       = Logger.new($stdout)
+      @logger.level = Logger::INFO
+
+      tryconnect
+	  end
+
+	  def tryconnect
+	    loop do
+		    begin
+		      connect()
+		      break
+	      rescue => e
+			    @logger.warn("#{e.class} caugthed while connecting: #{e}. Reconnecting in #{@sleepwait} seconds...")
+			    sleep(@sleepwait)
+	      end
+		  end
+    end
+
+    def connect
+      @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
+      begin
+        @logger.debug("connecting #{@host}:#{@port}")
+        sockaddr = Socket.pack_sockaddr_in( @port, @host )
+        @socket.connect(sockaddr)
+      rescue => e
+        raise Exception.new("Could not connect to broker: #{e}.")
+      end
+      @logger.debug("waiting for data")
+      header = recv_timeout(HEADERSIZE)
+      opcode, len = @decoder.parse_header(header)
+      @logger.debug("received header, opcode = #{opcode}, len = #{len}")
+
+      if opcode == OP_INFO
+        data = recv_timeout(len)
+        @logger.debug("received data = #{data}")
+        name, rand = @decoder.parse_info(data)
+        @logger.debug("received INFO, name = #{name}, rand = #{rand}")
+        @brokername = name
+        auth = @decoder.msg_auth(rand, @ident, @secret)
+        @socket.send(auth, 0)
+			else
+				raise Exception('Expected info message at this point.')
+      end
+      @logger.info("connected to #{@host}, port #{@port}")
+      @connected = true
+      # set keepalive
+      @socket.setsockopt(Socket::Option.bool(:INET, :SOCKET, :KEEPALIVE, true))
+    end
+
+    def subscribe(*channels)
+      for c in channels
+        @logger.info("subscribing to #{c}")
+        message = @decoder.msg_subscribe(@ident, c)
+        @socket.send(message, 0)
+      end
+    end
+
+    def publish(data, *channels)
+      for c in channels
+        @logger.info("publish to #{c}: #{data}")
+        message = @decoder.msg_publish(@ident, c, data)
+        @socket.send(message, 0)
+      end
+    end
+
+    def stop
+      @stopped = true
+    end
+
+    def close
+      begin
+        @logger.debug("Closing socket")
+        @socket.close
+      rescue => e
+        @logger.warn("Socket exception when closing: #{e}")
+      end
+    end
+
+    def run(message_callback, error_callback)
+      begin
+        while !@stopped
+          while @connected
+            header = @socket.recv(HEADERSIZE)
+            if header.empty?
+              @connected = false
+              break
+            end
+            opcode, len = @decoder.parse_header(header)
+            @logger.debug("received header, opcode = #{opcode}, len = #{len}")
+            data = @socket.recv(len)
+            @logger.debug("received #{data.length} bytes of data")
+            if opcode == OP_ERROR
+              error_callback.call(data)
+            elsif opcode == OP_PUBLISH
+              name, chan, payload = @decoder.parse_publish(data)
+              @logger.info("received #{payload.length} bytes of data from #{name} on channel #{chan}")
+              message_callback.call(name, chan, payload)
+		        end
+          end
+          @logger.debug("Lost connection, trying to connect again...")
+          tryconnect
+        end
+
+      rescue => e
+        message = "#{e.class} caugthed in main loop: #{e}\n"
+        message += e.backtrace.join("\n")
+		    @logger.error(message)
+		  end
+    end
+
+  private
+    def recv_timeout(len=BUFSIZE)
+      if IO.select([@socket], nil, nil, @timeout)
+        @socket.recv(len)
+      else
+        raise Exception.new("Connection receive timeout.")
+      end
+    end
+
+  end
+end

data/lib/hpfeeds/decoder.rb

@@ -0,0 +1,49 @@
+require 'digest/sha1'
+
+module HPFeeds
+  class Decoder
+
+    def parse_header(header)
+      raise Exception.new("Malformed header") if header.length < 5
+  	  len = header[0,4].unpack("l>")[0]
+		  op = header[4,1].unpack("C")[0]
+      return op, len
+    end
+
+    def parse_info(data)
+      len = data[0,1].unpack("C")[0]
+      raise Exception.new("Malformed data") if data.length <= len
+			name = data[1,len]
+			rand = data[(1+len)..-1]
+      return name, rand
+    end
+
+    def parse_publish(data)
+			len = data[0,1].unpack("C")[0]
+			name = data[1,len]
+			len2 = data[(1+len),1].ord
+			chan = data[(1+len+1),len2]
+			payload = data[(1+len+1+len2)..-1]
+      return name, chan, payload
+    end
+
+    def msg_auth(rand, ident, secret)
+  		mac = Digest::SHA1.digest(rand + secret)
+	  	msg_hdr(OP_AUTH, [ident.length].pack("C") + ident + mac)
+    end
+
+    def msg_subscribe(ident, chan)
+		  msg_hdr(OP_SUBSCRIBE, [ident.length].pack("C") + ident + chan)
+	  end
+
+    def msg_publish(ident, chan, msg)
+		  msg_hdr(OP_PUBLISH, [ident.length].pack("C") + ident + [chan.length].pack("C") + chan + msg)
+	  end
+
+  private
+
+	  def msg_hdr(op, data)
+		  [5+data.length].pack("l>") + [op].pack("C") + data
+	  end
+  end
+end

data/lib/hpfeeds/exception.rb

@@ -0,0 +1,3 @@
+module HPFeeds
+  class Exception < RuntimeError; end
+end

data/lib/hpfeeds/version.rb

@@ -0,0 +1,3 @@
+module HPFeeds
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: hpfeeds
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Coda Zabetta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for HPFeeds protocol
+email:
+- francesco.codazabetta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hpfeeds/exception.rb
+- lib/hpfeeds/decoder.rb
+- lib/hpfeeds/client.rb
+- lib/hpfeeds/version.rb
+- lib/hpfeeds.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/vicvega/hpfeeds-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for HPFeeds protocol
+test_files: []