fluent-plugin-syslog-tls 0.5.0

data/test/helper.rb

@@ -0,0 +1,34 @@
+# Copyright 2016 Acquia, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.start
+
+Coveralls.wear! if ENV['TRAVIS']
+
+# Fluentd sets default encoding to ASCII-8BIT, but coverall can load git data which can contain UTF-8 characters
+at_exit do
+  Encoding.default_internal = 'UTF-8' if defined?(Encoding) && Encoding.respond_to?(:default_internal)
+  Encoding.default_external = 'UTF-8' if defined?(Encoding) && Encoding.respond_to?(:default_external)
+end
+
+require 'test/unit'
+require 'fluent/test'
+require 'minitest/pride'
+require 'minitest/stub_any_instance'
+
+require 'webmock/test_unit'
+WebMock.disable_net_connect!

data/test/ssl.rb

@@ -0,0 +1,51 @@
+require 'socket'
+require 'openssl'
+
+module SSLTestHelper
+  def ssl_server
+    @ssl_server ||= begin
+      tcp_server = TCPServer.new("localhost", 33000 + Random.rand(1000))
+      ssl_context = OpenSSL::SSL::SSLContext.new
+      ssl_context.cert = certificate
+      ssl_context.key = rsa_key
+      OpenSSL::SSL::SSLServer.new(tcp_server, ssl_context)
+    end
+  end
+
+  def ssl_client
+    tcp = TCPSocket.new("localhost", ssl_server.addr[1])
+    ctx = OpenSSL::SSL::SSLContext.new
+    ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_NONE)
+    ctx.cert = certificate
+    ctx.key = rsa_key
+    OpenSSL::SSL::SSLSocket.new(tcp, ctx)
+  end
+
+  def rsa_key
+    @rsa_key ||= OpenSSL::PKey::RSA.new(2048)
+  end
+
+  def certificate
+    @cert ||= begin
+      cert = OpenSSL::X509::Certificate.new
+      cert.subject = cert.issuer = OpenSSL::X509::Name.parse("/C=BE/O=Test/OU=Test/CN=Test")
+      cert.not_before = Time.now
+      cert.not_after = Time.now + 365 * 24 * 60 * 60
+      cert.public_key = rsa_key.public_key
+      cert.serial = 0x0
+      cert.version = 2
+
+      ef = OpenSSL::X509::ExtensionFactory.new
+      ef.subject_certificate = cert
+      ef.issuer_certificate = cert
+      cert.extensions = [
+        ef.create_extension("basicConstraints","CA:TRUE", true),
+        ef.create_extension("subjectKeyIdentifier", "hash"),
+        # ef.create_extension("keyUsage", "cRLSign,keyCertSign", true),
+      ]
+      cert.add_extension ef.create_extension("authorityKeyIdentifier", "keyid:always,issuer:always")
+      cert.sign(rsa_key, OpenSSL::Digest::SHA1.new)
+      cert
+    end
+  end
+end

data/test/syslog_tls/test_logger.rb

@@ -0,0 +1,48 @@
+# Copyright 2016 Acquia, Inc.
+# Copyright 2016 t.e.morgan.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'helper'
+require 'date'
+require 'syslog_tls/logger'
+
+class LoggerTest < Test::Unit::TestCase
+  def test_logger_defaults
+    io = StringIO.new
+    l = SyslogTls::Logger.new(io, "TOKEN")
+    time = Time.now
+    l.log(:WARN, "MESSAGE", time: time)
+    assert_equal "<132>1 #{time.to_datetime.rfc3339} - - - - [TOKEN] MESSAGE\n", io.string
+  end
+
+  def test_logger_default_headers
+    io = StringIO.new
+    l = SyslogTls::Logger.new(io, "TOKEN")
+    l.hostname("hostname")
+    l.app_name("appname")
+    l.procid($$)
+    l.facility("SYSLOG")
+    time = Time.now
+    l.log(:WARN, "MESSAGE", time: time)
+    assert_equal "<44>1 #{time.to_datetime.rfc3339} hostname appname #{$$} - [TOKEN] MESSAGE\n", io.string
+  end
+
+  def test_logger_closed
+    io = StringIO.new
+    l = SyslogTls::Logger.new(io, "TOKEN")
+    assert_false l.closed?
+    l.close
+    assert_true l.closed?
+  end
+end

data/test/syslog_tls/test_protocol.rb

@@ -0,0 +1,150 @@
+# Copyright 2016 Acquia, Inc.
+# Copyright 2016 t.e.morgan.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'helper'
+require 'date'
+require 'syslog_tls/protocol'
+
+class ProtocolTest < Test::Unit::TestCase
+  def test_header_defaults
+    h = SyslogTls::Header.new
+
+    # Check defaults
+    assert_equal 'INFO', h.severity
+    assert_equal 'LOCAL0', h.facility
+    assert_equal 1, h.version
+    assert_equal SyslogTls::NIL_VALUE, h.hostname
+    assert_equal SyslogTls::NIL_VALUE, h.app_name
+    assert_equal SyslogTls::NIL_VALUE, h.procid
+    assert_equal SyslogTls::NIL_VALUE, h.msgid
+
+    assert_equal "<#{h.pri}>1 #{h.timestamp.to_datetime.rfc3339} - - - -", h.to_s
+  end
+
+  def test_header_facility_setter
+    h = SyslogTls::Header.new
+    assert_raise do
+      h.facility = "NON_EXISTING"
+    end
+    SyslogTls::Header::FACILITIES.each do |facility, _|
+      assert_nothing_raised do
+        h.facility = facility
+      end
+    end
+  end
+
+  def test_header_severity_setter
+    h = SyslogTls::Header.new
+    assert_raise do
+      h.severity = "NON_EXISTING"
+    end
+    SyslogTls::Header::SEVERITIES.each do |severity, _|
+      assert_nothing_raised do
+        h.severity = severity
+      end
+    end
+  end
+
+  def test_header_timestamp_setter
+    h = SyslogTls::Header.new
+    assert_raise do
+      h.timestamp = Time.now.to_i
+    end
+    assert_nothing_raised do
+      h.timestamp = Time.now
+    end
+  end
+
+  def test_header_hostname
+    h = SyslogTls::Header.new
+    h.hostname = "hostname"
+    assert_equal "<#{h.pri}>1 #{h.timestamp.to_datetime.rfc3339} hostname - - -", h.to_s
+  end
+
+  def test_header_appname
+    h = SyslogTls::Header.new
+    h.app_name = "appname"
+    assert_equal "<#{h.pri}>1 #{h.timestamp.to_datetime.rfc3339} - appname - -", h.to_s
+  end
+
+  def test_header_procid
+    h = SyslogTls::Header.new
+    h.procid = $$
+    assert_equal "<#{h.pri}>1 #{h.timestamp.to_datetime.rfc3339} - - #{$$} -", h.to_s
+  end
+
+  def test_header_msgid
+    h = SyslogTls::Header.new
+    h.msgid = "msgid"
+    assert_equal "<#{h.pri}>1 #{h.timestamp.to_datetime.rfc3339} - - - msgid", h.to_s
+  end
+
+  def test_structured_data_defaults
+    id = "hash@IANA-ID"
+    sd = SyslogTls::StructuredData.new(id)
+    assert_equal "[#{id}]", sd.to_s
+  end
+
+  def test_structured_data_key
+    id = "hash@IANA-ID"
+    sd = SyslogTls::StructuredData.new(id)
+    sd.data["key"] = "val"
+    assert_equal "[#{id} key=\"val\"]", sd.to_s
+  end
+
+  def test_structured_data_escaping
+    id = "hash@IANA-ID"
+    sd = SyslogTls::StructuredData.new(id)
+    sd.data["key"] = '\]"'
+    assert_equal "[#{id} key=\"\\\\\\]\\\"\"]", sd.to_s
+  end
+
+  def test_messsage_defaults
+    m = SyslogTls::Message.new
+    assert_not_nil m.header
+    assert_true m.structured_data.is_a? Array
+    assert_equal 0, m.structured_data.length
+    assert_equal "", m.msg
+
+    assert_equal "<134>1 #{m.header.timestamp.to_datetime.rfc3339} - - - - -\n", m.to_s
+  end
+
+  def test_message_msg
+    m = SyslogTls::Message.new
+    m.msg = "TEST"
+    assert_equal "<134>1 #{m.header.timestamp.to_datetime.rfc3339} - - - - - TEST\n", m.to_s
+  end
+
+  def test_message_sd
+    m = SyslogTls::Message.new
+    m.structured_data << SyslogTls::StructuredData.new("TEST_ID")
+    assert_equal "<134>1 #{m.header.timestamp.to_datetime.rfc3339} - - - - [TEST_ID]\n", m.to_s
+  end
+
+  def test_message_multiple_sd
+    m = SyslogTls::Message.new
+    m.structured_data << SyslogTls::StructuredData.new("TEST_ID")
+    m.structured_data << SyslogTls::StructuredData.new("TEST_ID2")
+    assert_equal "<134>1 #{m.header.timestamp.to_datetime.rfc3339} - - - - [TEST_ID][TEST_ID2]\n", m.to_s
+  end
+
+  def test_message_multiple_sd_msg
+    m = SyslogTls::Message.new
+    m.structured_data << SyslogTls::StructuredData.new("TEST_ID")
+    m.structured_data << SyslogTls::StructuredData.new("TEST_ID2")
+    m.msg = "MSG"
+    assert_equal "<134>1 #{m.header.timestamp.to_datetime.rfc3339} - - - - [TEST_ID][TEST_ID2] MSG\n", m.to_s
+  end
+end

data/test/syslog_tls/test_ssl_transport.rb

@@ -0,0 +1,54 @@
+# Copyright 2016 Acquia, Inc.
+# Copyright 2016 t.e.morgan.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'helper'
+require 'ssl'
+require 'syslog_tls/ssl_transport'
+
+class SSLTransportTest < Test::Unit::TestCase
+  include SSLTestHelper
+
+  def test_ok_connection
+    server = ssl_server
+    st = Thread.new {
+      client = server.accept
+      assert_equal "TESTTEST2\n", client.gets
+      client.close
+    }
+    SyslogTls::SSLTransport.stub_any_instance(:get_ssl_connection, ssl_client) do
+      t = SyslogTls::SSLTransport.new("localhost", server.addr[1], max_retries: 3)
+      t.write("TEST")
+      t.write("TEST2\n")
+    end
+    st.join
+  end
+
+  def test_retry
+    client = Object.new
+    def client.connect
+      true
+    end
+    def client.write(s)
+      raise "Test"
+    end
+
+    SyslogTls::SSLTransport.stub_any_instance(:get_ssl_connection, client) do
+      assert_raises RuntimeError do
+        t = SyslogTls::SSLTransport.new("localhost", 33000, max_retries: 3)
+        t.write("TEST\n")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-syslog-tls
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- thomas morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-config-placeholders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub_any_instance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Syslog TLS output plugin with formatting support, for Fluentd
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docs/configuration.md
+- fluent-plugin-syslog-tls.gemspec
+- lib/fluent/plugin/out_syslog_tls.rb
+- lib/syslog_tls/facility.rb
+- lib/syslog_tls/logger.rb
+- lib/syslog_tls/lookup_from_const.rb
+- lib/syslog_tls/protocol.rb
+- lib/syslog_tls/severity.rb
+- lib/syslog_tls/ssl_transport.rb
+- lib/syslog_tls/version.rb
+- test/fluent/test_out_syslog_tls.rb
+- test/helper.rb
+- test/ssl.rb
+- test/syslog_tls/test_logger.rb
+- test/syslog_tls/test_protocol.rb
+- test/syslog_tls/test_ssl_transport.rb
+homepage: https://github.com/zarqman/fluent-plugin-syslog-tls
+licenses:
+- Apache v2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Fluent Syslog TLS output plugin
+test_files:
+- test/fluent/test_out_syslog_tls.rb
+- test/helper.rb
+- test/ssl.rb
+- test/syslog_tls/test_logger.rb
+- test/syslog_tls/test_protocol.rb
+- test/syslog_tls/test_ssl_transport.rb