relp 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f83efde74951f5183dc18758bd7d92de7f0d47
-  data.tar.gz: b582704d3e53d7dce8712d78809e1798680bbebf
+  metadata.gz: 1eedad03bc936d4d6853527e61ad522606daa54c
+  data.tar.gz: fe0c593c39cf33c06e0b19e60477dc40805c8d82
 SHA512:
-  metadata.gz: cbf9e4b9037041a69397d9dd57fe742e2c7af1e76ec062633110f47e393fd8634182026b4e636f2c9a86da86a843e5b470519f3ff83ef21fecbe6df806fc0e71
-  data.tar.gz: 6353f83c40e2cae9ccd5fc6da7660f220dbd9fea6a3ac7746a16fb9ffd90cf3ac45390cc01d63dd525ad4a7483a0ac59abfa62689a2fde632aaa22dce7df3d8c
+  metadata.gz: 01e1d1bba7a58febbab70bbc55a2f824199dc24eafc584506cf7c6121ccedf1cc82f44d12cd0d27c55731c58b593dd80c099e1dac7eb6869fdf7a66a2e83c869
+  data.tar.gz: fef50599502268f20e910d7cf5f135a5b6373688298e11fe69f4eda63e9a4c9b319b2a5c900b3b8c23d30315242c8ccda21d232c9b9962fb5fe07da4e9573eda

data/CHANGELOG.md

@@ -5,10 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2017-09-11
+### Changed
+- Server side - new arguments sequence `(port, callback, host = '0.0.0.0' , tls_context = nil, logger = nil)`  
+- Improved RELP frame checking
 ## [Unreleased]
 ### Added
-- Started writing this changelog
-- This repo transferred to ViaQ org
+- Changelog
+- This repo transferred to ViaQ organization
 
 ## [0.1.1] - 2017-06-23
 ### Changed

data/README.md

@@ -1,6 +1,6 @@
 # RELP
 
-This library contains native implementation of [RELP protocol](http://www.rsyslog.com/doc/relp.html) in ruby. At the moment only server-side
+This library contains native implementation of [RELP protocol](http://www.rsyslog.com/doc/relp.html) in ruby with TLS support. At the moment only server-side
 is properly implemented and (to some extent) tested.
 
 ## Installation
@@ -23,16 +23,8 @@ Or install it yourself as:
 
 ### Server
 
-To run server just creat instance of `Relp::RelpServer.new(host, port, logger = nil, callback)`
-and than call method run on instance of server e.g. `server.run`
-
-`host` 
-  * This is a required setting.
-  * Value type is string
-  * There is no default value for this setting.
-  * Specifies address you want to bind to, use "0.0.0.0" to bind to any address
-
-
+To run server just create instance of `Relp::RelpServer.new(port, callback, host, tls_context, logger)`
+and then call method run on instance of server e.g. `server.run`
 
 `port` 
 
@@ -41,19 +33,37 @@ and than call method run on instance of server e.g. `server.run`
   * There is no default value for this setting.
   * Sets on which port you want to listen for incoming RELP connections
 
-
+`callback`
+  * This is a required setting.
+  * Method you want to be executed upon successfully accepted message, it has only one :string parameter, which is message itself.
+  
+`host` 
+  * This is a required setting.
+  * Value type is string
+  * Default value is "0.0.0.0' to bind any address
+  * Specifies address you want to bind to, use "0.0.0.0" to bind to any address
+ 
+`tls_context` 
+  * Value type is SSL_context_object = OpenSSL::SSL::SSLContext.new See -> OpenSSL <a href="http://ruby-doc.org/stdlib-2.0.0/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html">homepage</a>
+  * If is not set - server runs without TLS or SSL encryption
+  * Example of TLS/SSL context object:
+  ```ruby
+      sslContext = OpenSSL::SSL::SSLContext.new
+      sslContext.cert = OpenSSL::X509::Certificate.new(File.open("path/to/certificate/cert.pem"))
+      sslContext.key = OpenSSL::PKey::RSA.new(File.open("path/to/key/key.pem"))
+      sslContext.ca_file = 'path/to/certificate/authority/ca.pem'
+      sslContext.verify_mode = OpenSSL::SSL::VERIFY_PEER #only if you want verify peer
+  ```
+ 
 `logger`
   
   * This is optional setting
   * Value type is logger object
   * If is not set - default is `Logger.new(STDOUT)` with all levels of logging
  
-`callback`
-  * This is a required setting.
-  * Method you want to be executed upon successfully accepted message, it has only one :Hash parameter, which is message itself.
-  
+
 #### Important Methods
-  * `run` Start connceting clients
+  * `run` Start connecting clients
   *  `server_shutdown` Close connection to all clients and shutdown server
 
 ### Client

data/lib/relp/exceptions.rb

@@ -13,4 +13,7 @@ module Relp
 
   class InvalidCommand < RelpProtocolError
   end
-end
+
+  class MissingData < RelpProtocolError
+  end
+end

data/lib/relp/relp_protocol.rb

@@ -1,9 +1,19 @@
 require 'relp/exceptions'
 require 'socket'
+require "openssl"
+
 module Relp
   class RelpProtocol
     @@relp_version = '0'
     @@relp_software = 'librelp,1.2.13,http://librelp.adiscon.com'
+
+    def create_frame(txnr, command, message)
+      frame = {:txnr => txnr,
+               :command => command,
+               :message => message
+      }
+    end
+
     def frame_write(socket, frame)
       raw_data=[
           frame[:txnr],
@@ -24,9 +34,10 @@ module Relp
         frame = Hash.new
         if match = socket_content.match(/(^[0-9]+) ([\S]*) (\d+)([\s\S]*)/)
           frame[:txnr], frame[:command], frame[:data_length], frame[:message] = match.captures
+          check_message_length(frame)
           frame[:message].lstrip! #message could be empty
         else
-          raise raise Relp::FrameReadException.new('Problem with reading RELP frame')
+          raise Relp::FrameReadException.new('Problem with reading RELP frame')
         end
         @logger.debug "Reading Frame #{frame.inspect}"
       rescue IOError
@@ -54,5 +65,17 @@ module Relp
     def extract_message_information(message)
       informations = Hash[message.scan(/^(.*)=(.*)$/).map { |(key, value)| [key.to_sym, value] }]
     end
+
+    def check_message_length(frame)
+      if frame[:command] == "close"
+        real_length = frame[:message].length
+      else
+        real_length = frame[:message].length - 2
+      end
+      if real_length != frame[:data_length].to_i
+        @logger.error 'Lost data'
+        raise Relp::MissingData.new('Data length is not same as received data')
+      end
+    end
   end
 end

data/lib/relp/server.rb

@@ -1,10 +1,11 @@
 require 'relp/relp_protocol'
 require 'logger'
 require 'thread'
+require "openssl"
 
 module Relp
   class RelpServer < RelpProtocol
-    def initialize(host, port, logger = nil, callback)
+    def initialize(port, callback, host = '0.0.0.0' , tls_context = nil, logger = nil)
       @logger = logger
       @logger = Logger.new(STDOUT) if logger.nil?
       @socket_list = Array.new
@@ -12,8 +13,13 @@ module Relp
       @required_command = 'syslog'
 
       begin
-        @server = TCPServer.new(host, port)
-        @logger.info "Starting #{self.class} on %s:%i" % @server.local_address.ip_unpack
+        @server = TCPServer.new host, port
+        if tls_context
+          @logger.info "Starting #{self.class} with SSL enabled on %s:%i" % @server.local_address.ip_unpack
+          @server = OpenSSL::SSL::SSLServer.new(@server, tls_context)
+        else
+          @logger.info "Starting #{self.class} on %s:%i" % @server.local_address.ip_unpack
+        end
       rescue Errno::EADDRINUSE
         @logger.error  "ERROR Could not start relp server: Port #{port} in use"
         raise Errno::EADDRINUSE
@@ -42,6 +48,8 @@ module Relp
             @logger.info "Connection closed"
           rescue Relp::RelpProtocolError => err
             @logger.warn 'Relp error: ' + err.class.to_s + ' ' + err.message
+          rescue OpenSSL::SSL::SSLError => ssl_error
+            @logger.error "SSL Error", :exception => ssl_error
           rescue Exception => e
             @logger.debug e
           ensure
@@ -65,13 +73,6 @@ module Relp
       end
     end
 
-    def create_frame(txnr, command, message)
-      frame = {:txnr => txnr,
-               :command => command,
-               :message => message
-      }
-    end
-
     def ack_frame(socket, txnr)
       frame = {:txnr => txnr,
                :command => 'rsp',
@@ -82,7 +83,7 @@ module Relp
 
     def server_close_message(socket)
       Hash.new frame = {:txnr => 0,
-               :command => 'serverclose',
+               :command => 'close',
                :message => '0'
       }
       begin

data/lib/relp/version.rb

@@ -1,3 +1,3 @@
 module Relp
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jiří Vymazal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - lib/relp/version.rb
 - test/RELP_test.rb
 - test/test_helper.rb
+- test/unit/relp_protocol_test.rb
 homepage: https://github.com/ViaQ/Relp
 licenses:
 - MIT
@@ -96,10 +97,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of RELP (Reliable Event Logging Protocol) protocol.
 test_files:
-- test/test_helper.rb
 - test/RELP_test.rb
+- test/unit/relp_protocol_test.rb
+- test/test_helper.rb