tcp_syslog 1.0.2 → 1.0.3

data/Changelog.md

@@ -1,3 +1,7 @@
+## 1.0.3 (2011-11-26)
+
+* Added SSL support with peer verification
+
 ## 1.0.2 (2011-06-29)
 
 * Relax version requirements for active_support (Yawn)

data/Rakefile

@@ -19,7 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Rails syslog logger using TCP instead of UDP}
   gem.email = "philippe.lafoucriere@gmail.com"
   gem.authors = ["Philippe Lafoucrière"]
-  gem.version = '1.0.2'
+  gem.version = '1.0.3'
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'

data/lib/tcp_syslog.rb

@@ -2,7 +2,7 @@ require 'socket'
 require 'syslog'
 require 'logger'
 require 'system_timer'
-
+require 'openssl'
 # TcpSyslog is used are a dead-simple replacement for
 # syslog ruby libs. None of them is able to send logs
 # to a remote server, and even less in TCP.
@@ -69,11 +69,15 @@ class TcpSyslog < ActiveSupport::BufferedLogger
   # ** +facility+ : defaults to user
   # ** +progname+ : defaults to 'rails'
   # ** +auto_flushing+ : number of messages to buffer before flushing
+  # ** +ssl+ : defaults to nil
+  # *** +cert : "/path/to/cert"
+  # *** +key : "/path/to/key"
+  # *** +ca_file : "/path/to/ca_file"
   #
   def initialize(options = {})
     @level = LOGGER_LEVEL_MAP[options[:level]] || Logger::DEBUG
     @host = options[:host] || 'localhost'
-    @port = options[:port] = '514'
+    @port = options[:port] || '514'
     @facility = options[:facility] || Syslog::LOG_USER
     @progname = options[:progname] || 'rails'
     @buffer = Hash.new { |h,k| h[k] = [] }
@@ -81,6 +85,7 @@ class TcpSyslog < ActiveSupport::BufferedLogger
     @auto_flushing = options[:auto_flushing] || 1
     @local_ip = local_ip
     @remove_ansi_colors = options[:remove_ansi_colors] || true
+    @ssl = options[:ssl]
     return if defined? SYSLOG
     self.class.const_set :SYSLOG, true
   end
@@ -121,11 +126,35 @@ class TcpSyslog < ActiveSupport::BufferedLogger
   end
 
   def socket
-    @socket[Thread.current] ||= TCPSocket.new(@host, @port)
+    @socket[Thread.current] ||= new_socket
   end
 
+  def ssl?
+    !@ssl.nil?
+  end
+  
   protected
-
+  
+  def new_socket
+    ssl? ? ssl_socket : tcp_socket
+  end
+  
+  def tcp_socket
+    TCPSocket.new(@host, @port)
+  end
+  
+  def ssl_socket
+    ssl_context = OpenSSL::SSL::SSLContext.new
+    ssl_context.cert = OpenSSL::X509::Certificate.new(File.open(@ssl[:cert]))
+    ssl_context.key = OpenSSL::PKey::RSA.new(File.open(@ssl[:key]))
+    ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    ssl_context.ca_file = @ssl[:ca_file]
+    ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context)
+    ssl_socket.sync_close = true
+    ssl_socket.connect
+    ssl_socket
+  end
+  
   # Clean up messages so they're nice and pretty.
   def clean(message)
     message = message.to_s.dup
@@ -156,7 +185,7 @@ class TcpSyslog < ActiveSupport::BufferedLogger
       msg.split("\n").each do |line|
         write_on_socket(severity, line)
       end
-    rescue Errno::ECONNREFUSED, Errno::EPIPE, Timeout::Error  => e
+    rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EPIPE, Timeout::Error, OpenSSL::SSL::SSLError => e
       # can't log anything, stop trying
       @socket[Thread.current] = nil
     end

data/tcp_syslog.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{tcp_syslog}
-  s.version = "1.0.2"
+  s.name = "tcp_syslog"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philippe Lafoucri\303\250re"]
-  s.date = %q{2011-06-29}
-  s.description = %q{Rails syslog logger using TCP instead of UDP}
-  s.email = %q{philippe.lafoucriere@gmail.com}
+  s.date = "2011-11-27"
+  s.description = "Rails syslog logger using TCP instead of UDP"
+  s.email = "philippe.lafoucriere@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -29,11 +29,11 @@ Gem::Specification.new do |s|
     "test/tcp_syslog_benchmark.rb",
     "test/test_tcp_syslog.rb"
   ]
-  s.homepage = %q{http://github.com/tech-angels/tcp_syslog}
+  s.homepage = "http://github.com/tech-angels/tcp_syslog"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Send logs to syslog using TCP instead of UDP}
+  s.rubygems_version = "1.8.10"
+  s.summary = "Send logs to syslog using TCP instead of UDP"
   s.test_files = [
     "test/helper.rb",
     "test/tcp_syslog_benchmark.rb",

data/test/test_tcp_syslog.rb

@@ -14,6 +14,7 @@ class TestTcpSyslog < ActiveSupport::TestCase
       assert_equal 'rails', @logger.progname
       assert_equal 1, @logger.auto_flushing
       assert_equal Logger::DEBUG, @logger.level
+      assert_equal false, @logger.ssl?
     end
 
     should "have defined debug, info, warn, error, fatal methods" do
@@ -26,16 +27,35 @@ class TestTcpSyslog < ActiveSupport::TestCase
 
     context "on add message" do
       setup do
-        message = "This message to be sent to syslog"
+        @message = "This message to be sent to syslog"
+      end
+
+      should "have sent the message to syslog using plain TCP" do
+        mock.proxy(TCPSocket).new(@logger.host, @logger.port)
+        dont_allow(OpenSSL::SSL::SSLSocket).new
         mock.proxy(@logger).flush
-        mock.proxy(@logger).log(Logger::INFO, message)
-        mock.proxy(@logger).write_on_socket(Logger::INFO, message)
-        @logger.add(Logger::INFO, message)
+        mock.proxy(@logger).log(Logger::INFO, @message)
+        mock.proxy(@logger).write_on_socket(Logger::INFO, @message)
+        @logger.add(Logger::INFO, @message)
+        RR.verify
       end
 
-      should "have sent the message to syslog" do
+      should "have sent the message to syslog using SSL with peer verification" do
+        @logger = TcpSyslog.new(
+          :ssl => {
+            :cert => "/path/to/cert",
+            :key => "/path/to/key",
+            :ca_file => "/path/to/ca_file"
+          }
+        )
+        mock(@logger).ssl_socket{mock!.write(anything)}
+        mock.proxy(@logger).flush
+        mock.proxy(@logger).log(Logger::INFO, @message)
+        mock.proxy(@logger).write_on_socket(Logger::INFO, @message)
+        @logger.add(Logger::INFO, @message)
         RR.verify
       end
+
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tcp_syslog
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - "Philippe Lafoucri\xC3\xA8re"
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 +02:00
-default_executable: 
+date: 2011-11-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: shoulda
-  version_requirements: *id001
+  requirement: *id001
+  type: :development
   prerelease: false
+  name: shoulda
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,12 +43,12 @@ dependencies:
         - 6
         - 0
         version: 0.6.0
-  name: yard
-  version_requirements: *id002
+  requirement: *id002
+  type: :development
   prerelease: false
+  name: yard
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,12 +59,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  name: bundler
-  version_requirements: *id003
+  requirement: *id003
+  type: :development
   prerelease: false
+  name: bundler
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,12 +75,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  name: jeweler
-  version_requirements: *id004
+  requirement: *id004
+  type: :development
   prerelease: false
+  name: jeweler
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -91,12 +89,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rcov
-  version_requirements: *id005
+  requirement: *id005
+  type: :development
   prerelease: false
+  name: rcov
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -107,12 +105,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  name: activesupport
-  version_requirements: *id006
+  requirement: *id006
+  type: :development
   prerelease: false
+  name: activesupport
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -121,12 +119,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rr
-  version_requirements: *id007
+  requirement: *id007
+  type: :development
   prerelease: false
+  name: rr
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -135,12 +133,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: i18n
-  version_requirements: *id008
+  requirement: *id008
+  type: :development
   prerelease: false
+  name: i18n
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -149,12 +147,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: SystemTimer
-  version_requirements: *id009
+  requirement: *id009
+  type: :development
   prerelease: false
+  name: SystemTimer
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -165,12 +163,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  name: activesupport
-  version_requirements: *id010
+  requirement: *id010
+  type: :runtime
   prerelease: false
+  name: activesupport
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -181,9 +179,10 @@ dependencies:
         - 2
         - 3
         version: 1.2.3
-  name: SystemTimer
-  version_requirements: *id011
+  requirement: *id011
+  type: :runtime
   prerelease: false
+  name: SystemTimer
 description: Rails syslog logger using TCP instead of UDP
 email: philippe.lafoucriere@gmail.com
 executables: []
@@ -205,7 +204,6 @@ files:
 - test/helper.rb
 - test/tcp_syslog_benchmark.rb
 - test/test_tcp_syslog.rb
-has_rdoc: true
 homepage: http://github.com/tech-angels/tcp_syslog
 licenses: 
 - MIT
@@ -235,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Send logs to syslog using TCP instead of UDP