rxio 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21d639b6ff5ae29bd9a9a2366052f6f85b3d144f
-  data.tar.gz: ccc2d8efc56666c875281a3c0cf8486fd8073e29
+  metadata.gz: 4c9ca3ae8857d65bc146a20200d72feba5876cfb
+  data.tar.gz: 411f6c8e7ea2a455d7ce261b4de5f4883f8ee205
 SHA512:
-  metadata.gz: c2f4cb064c3ada748bb99bde0a717cf51959b1266127ca53c0c339d2e786f62df5f14be48f99308d68e5e5ccac5bec9a80b707f352419f360098c8e09572e6d1
-  data.tar.gz: d3897e1c11e055d4b66e65022cb63da5b48a420c1c1153a332fc76ffbbf4eaa5129c6d4145f7158efcbe010aec5b5fcc23c95e4814d9154926ac5078f6dd2cfd
+  metadata.gz: 342d8d61b7240292c3925f8ab7e7447f80d40f6c12d73ae6df65004d4960cf3b8fdc5f3f74da0168c666e3317e5ccd845e93b102716318c1370a03d5cb28a188
+  data.tar.gz: 4c12c281829622777e8013f7bdc323516acef82004b83c5bc232005548e1d1fdfdad19045ca51f05545d11c9f79d53c3ccfe2df8b1f89b46547d5a6a397a90de

data/README.md

@@ -32,6 +32,38 @@ This will execute the service / client main loop. The handler module provides th
 The _run_ method on both *Service* & *Client* is blocking and will only return after the main loop has terminated.
 A _stop_ method is also provided to request the main loop to terminate.
 
+### SSL Support
+
+RxIO provides support for secure communication through [OpenSSL](https://www.openssl.org/).
+To create a secure server, pass the ssl parameters to RxIO::Service.new:
+
+```ruby
+s = RxIO::Service.new 'localhost', 4444, ExampleServiceHandler, { cert: './certificate.pem', pkey: './private.key' }
+s.startup
+```
+
+Creating a secure client is as simple as:
+
+```ruby
+c = RxIO::Client.new 'localhost', 4444, TestClientHandler, true
+c.startup
+```
+
+#### SSL Params
+
+When creating a secure client, the last argument to RxIO::Client.new is a hash through which the following can be specified:
+
+* *verify_peer* - true/false (Verify the Peer Certificate)
+
+#### Ignoring SSL Certificate Errors
+
+Although strongly discouraged for obvious security reasons, the SSL Peer Certificate verification can be disabled:
+
+```ruby
+c = RxIO::Client.new 'localhost', port, TestClientHandler, true, verify_peer: false
+c.startup
+```
+
 ### Running in the background
 
 While the _run_ / _stop_ methods offer a simple way to implement a single service/client within the current thread, some situations may require wrapping in a separate thread.

data/lib/rxio/client.rb

@@ -4,6 +4,7 @@
 # External Includes
 require 'thread'
 require 'socket'
+require 'openssl'
 require 'runify'
 
 # Internal Includes
@@ -32,7 +33,15 @@ module RxIO
 		# @param [String] addr Address to which the client should connect
 		# @param [Fixnum] port Port on which the client should connect
 		# @param [Module] service_handler Module implementing service client logic
-		def initialize addr, port, service_handler
+		# @param [Boolean] ssl Create a secure client
+		# @param [Hash] ssl_params SSL Parameters - see README
+		def initialize addr, port, service_handler, ssl = false, ssl_params = { verify_peer: true }
+
+			# Set SSL Context
+			if ssl
+				@ssl_ctx = OpenSSL::SSL::SSLContext.new
+				@ssl_ctx.verify_mode = ssl_params[:verify_peer] ? OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT : OpenSSL::SSL::VERIFY_NONE
+			end
 
 			# Set Address & Port
 			@addr = addr
@@ -126,6 +135,13 @@ module RxIO
 			# Check Socket
 			return nil unless @sock
 
+			# Wrap into SSL Socket
+			if @ssl_ctx
+				@sock = OpenSSL::SSL::SSLSocket.new @sock, @ssl_ctx
+				@sock.sync_close
+				@sock.connect
+			end
+
 			# Reset Client Buffers
 			@client[:lock].synchronize { @client[:obuf] = '' }
 			@client[:ibuf] = ''

data/lib/rxio/service.rb

@@ -4,6 +4,7 @@
 # External Includes
 require 'thread'
 require 'socket'
+require 'openssl'
 require 'runify'
 
 # Internal Includes
@@ -29,7 +30,15 @@ module RxIO
 		# @param [String] addr Address on which the service should listen
 		# @param [Fixnum] port Port on which the service should listen
 		# @param [Module] service_handler Module implementing the service logic
-		def initialize addr, port, service_handler
+		# @param [Hash] ssl_params Optional SSL Parameters ({ cert: '/path/to/cert', pkey: '/path/to/privatekey' }) - will create a secure server if not nil
+		def initialize addr, port, service_handler, ssl_params = nil
+
+			# Set SSL Params
+			if ssl_params
+				@ssl_ctx = OpenSSL::SSL::SSLContext.new
+				@ssl_ctx.cert = OpenSSL::X509::Certificate.new File.read(ssl_params[:cert])
+				@ssl_ctx.key = OpenSSL::PKey::RSA.new File.read(ssl_params[:pkey])
+			end
 
 			# Set Address & Port
 			@addr = addr
@@ -58,6 +67,7 @@ module RxIO
 
 				# Create TCP Socket Server
 				@serv = TCPServer.new @addr, @port
+				@serv = OpenSSL::SSL::SSLServer.new @serv, @ssl_ctx if @ssl_ctx
 				@socks << @serv
 
 				# Update Service
@@ -152,7 +162,7 @@ module RxIO
 		def acpt_sock s
 
 			# Accept
-			ns = s.accept_nonblock
+			ns = s.accept rescue nil
 
 			# Register Client
 			add_client ns if ns

data/lib/rxio/version.rb

@@ -5,5 +5,5 @@
 module RxIO
 
 	# Version
-	VERSION = '1.1.1'
+	VERSION = '1.2.0'
 end

data/rxio.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
 	spec.add_development_dependency 'bundler'
 	spec.add_development_dependency 'rake'
 	spec.add_runtime_dependency 'minitest'
+	spec.add_runtime_dependency 'openssl'
 	spec.add_runtime_dependency 'runify'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rxio
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eresse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: runify
   requirement: !ruby/object:Gem::Requirement