logstash-input-tcp 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc8a144097d1b6d3ee89c67da0a9598c20816dc0
-  data.tar.gz: db3e1d7399ee28bcdbad61d343c589249287ad3d
+  metadata.gz: d560100efd4b27bcef8c8865626a628de300b871
+  data.tar.gz: 4f22528b91f54d136f838ae5ea7878c7df493462
 SHA512:
-  metadata.gz: d8b9f22e646a94b0624d961075589d48899595e9aaedb4111fcc1cf6118a9173366f3caf6f7b0315c8048d0a6d850ee6da0319eea9f413413d5a6d2511d09c12
-  data.tar.gz: a5d0c419104ca62126ad38c4e3a0a83a81083df5febe5184a4c7edff44893a9b4141589830a99bbfaff365652cbcb43f8cdeb11e88d3fe6b341e36b32911a175
+  metadata.gz: 28bd63a130f1fa48f9470800baea3bc2ea14c9541dd754886ed21428a184ffa2c060b2e12089172acf77297e3136ce471fb3337ce0664e276c7a41fdbf230192
+  data.tar.gz: e03a18054310108f46336a10375d68dddfdcaba824102de882335aaa824634a05e4ae78357798f469a861e2ca79b144e9dfb642b88264480ee34b6036c84c300

data/CHANGELOG.md

@@ -1,5 +1,8 @@
+## 3.0.1
+ - properly convert sslsubject to string before assigning to event field, added specs, see https://github.com/logstash-plugins/logstash-input-tcp/pull/38
+
 ## 3.0.0
- - Deprecate ssl_cacert as it's confusing, does it job but when willing to add a chain of certificated the name and behaviour is a bit confusing. 
+ - Deprecate ssl_cacert as it's confusing, does it job but when willing to add a chain of certificated the name and behaviour is a bit confusing.
  - Add ssl_extra_chain_certs that allows you to specify a list of certificates path that will be added to the CAStore.
  - Make ssl_verify=true as a default value, if using ssl and performing validation is not reasonable as security might be compromised.
  - Add tests to verify behaviour under different SSL connection circumstances.

data/lib/logstash/inputs/tcp.rb

@@ -38,7 +38,7 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
   config :ssl_verify, :validate => :boolean, :default => true
 
   # The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.
-  config :ssl_cacert, :validate => :path, :deprecated => "This setting is deprecated in favor of extra_chain_cert as it sets a more clear expectation to add more X509 certificates to the store"
+  config :ssl_cacert, :validate => :path, :deprecated => "This setting is deprecated in favor of ssl_extra_chain_certs as it sets a more clear expectation to add more X509 certificates to the store"
 
   # SSL certificate path
   config :ssl_cert, :validate => :path
@@ -153,7 +153,7 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
       codec.decode(read(socket)) do |event|
         event["host"] ||= client_address
         event["port"] ||= client_port
-        event["sslsubject"] ||= socket.peer_cert.subject if @ssl_enable && @ssl_verify
+        event["sslsubject"] ||= socket.peer_cert.subject.to_s if @ssl_enable && @ssl_verify
         decorate(event)
         output_queue << event
       end
@@ -176,7 +176,7 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
     codec.respond_to?(:flush) && codec.flush do |event|
       event["host"] ||= client_address
       event["port"] ||= client_port
-      event["sslsubject"] ||= socket.peer_cert.subject if @ssl_enable && @ssl_verify
+      event["sslsubject"] ||= socket.peer_cert.subject.to_s if @ssl_enable && @ssl_verify
       decorate(event)
       output_queue << event
     end

data/logstash-input-tcp.gemspec

@@ -1,17 +1,16 @@
 Gem::Specification.new do |s|
-
-  s.name            = 'logstash-input-tcp'
-  s.version         = '3.0.0'
-  s.licenses        = ['Apache License (2.0)']
-  s.summary         = "Read events over a TCP socket."
-  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
-  s.authors         = ["Elastic"]
-  s.email           = 'info@elastic.co'
-  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.name          = 'logstash-input-tcp'
+  s.version       = '3.0.1'
+  s.licenses      = ['Apache License (2.0)']
+  s.summary       = "Read events over a TCP socket."
+  s.description   = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors       = ["Elastic"]
+  s.email         = 'info@elastic.co'
+  s.homepage      = "http://www.elastic.co/guide/en/logstash/current/index.html"
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir['lib/**/*', 'spec/**/*', '*.gemspec', '*.md', 'CONTRIBUTORS', 'Gemfile', 'LICENSE', 'NOTICE.TXT', 'CHANGELOG.md', 'README.md']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -31,4 +30,3 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'flores', '~> 0.0.6'
   s.add_development_dependency 'stud', '~> 0.0.22'
 end
-

data/spec/inputs/tcp_spec.rb

@@ -33,7 +33,7 @@ describe LogStash::Inputs::Tcp do
 
   it "should read plain with unicode" do
     event_count = 10
-    port = 5511
+    port = rand(1024..65535)
     conf = <<-CONFIG
       input {
         tcp {
@@ -61,7 +61,7 @@ describe LogStash::Inputs::Tcp do
   end
 
   it "should read events with plain codec and ISO-8859-1 charset" do
-    port = 5513
+    port = rand(1024..65535)
     charset = "ISO-8859-1"
     conf = <<-CONFIG
       input {
@@ -89,7 +89,7 @@ describe LogStash::Inputs::Tcp do
   end
 
   it "should read events with json codec" do
-    port = 5514
+    port = rand(1024..65535)
     conf = <<-CONFIG
       input {
         tcp {
@@ -124,7 +124,7 @@ describe LogStash::Inputs::Tcp do
   end
 
   it "should read events with json codec (testing 'host' handling)" do
-    port = 5514
+    port = rand(1024..65535)
     conf = <<-CONFIG
       input {
         tcp {
@@ -151,7 +151,7 @@ describe LogStash::Inputs::Tcp do
   end
 
   it "should read events with json_lines codec" do
-    port = 5515
+    port = rand(1024..65535)
     conf = <<-CONFIG
       input {
         tcp {
@@ -167,16 +167,17 @@ describe LogStash::Inputs::Tcp do
       "baz" => { "1" => "2" },
       "idx" => 0
     }
+    event_count = 5
 
     events = input(conf) do |pipeline, queue|
       socket = Stud::try(5.times) { TCPSocket.new("127.0.0.1", port) }
-      (1..5).each do |idx|
+      (1..event_count).each do |idx|
         data["idx"] = idx
         socket.puts(LogStash::Json.dump(data) + "\n")
       end
       socket.close
 
-      (1..5).map{queue.pop}
+      (1..event_count).map{queue.pop}
     end
 
     events.each_with_index do |event, idx|
@@ -189,7 +190,7 @@ describe LogStash::Inputs::Tcp do
 
   it "should one message per connection" do
     event_count = 10
-    port = 5516
+    port = rand(1024..65535)
     conf = <<-CONFIG
       input {
         tcp {
@@ -285,12 +286,17 @@ describe LogStash::Inputs::Tcp do
         subject(:input) { LogStash::Plugin.lookup("input", "tcp").new(config) }
 
         let(:config) do
-          { "host" => "0.0.0.0", "port" => port, "ssl_verify" => false,
-            "ssl_enable" => true, "ssl_cert" => certificate[0].path, "ssl_key" => certificate[1].path }
+          {
+            "host" => "0.0.0.0",
+            "port" => port,
+            "ssl_verify" => false,
+            "ssl_enable" => true,
+            "ssl_cert" => certificate[0].path,
+            "ssl_key" => certificate[1].path
+          }
         end
 
         let(:events) do
-
           socket = Stud::try(5.times) do
             ssl_context = OpenSSL::SSL::SSLContext.new
             socket = TCPSocket.new("127.0.0.1", port)
@@ -313,6 +319,12 @@ describe LogStash::Inputs::Tcp do
           expect(events.size).to be(nevents)
         end
 
+        it "should not contain sslsubject" do
+          events.each do |event|
+            expect(event["sslsubject"]).to be_nil
+          end
+        end
+
         describe "when ssl_verify is on" do
 
           let(:chain_of_certificates) { helper.chain_of_certificates }
@@ -327,9 +339,14 @@ describe LogStash::Inputs::Tcp do
           context "and the verification fails" do
 
             let(:config) do
-              { "host" => "0.0.0.0", "port" => port,
-                "ssl_enable" => true, "ssl_verify" => true,
-                "ssl_cert" => chain_of_certificates[:a_cert].path, "ssl_key" => chain_of_certificates[:a_key].path }
+              {
+                "host" => "0.0.0.0",
+                "port" => port,
+                "ssl_enable" => true,
+                "ssl_verify" => true,
+                "ssl_cert" => chain_of_certificates[:a_cert].path,
+                "ssl_key" => chain_of_certificates[:a_key].path
+              }
             end
 
             let(:client_certificate) { File.read(chain_of_certificates[:b_cert].path) }
@@ -347,13 +364,19 @@ describe LogStash::Inputs::Tcp do
               end
             end
           end
+
           context "and using the root CA" do
 
             let(:config) do
-              { "host" => "0.0.0.0", "port" => port,
-                "ssl_enable" => true, "ssl_verify" => true,
-                "ssl_cert" => chain_of_certificates[:a_cert].path, "ssl_key" => chain_of_certificates[:a_key].path,
-                "ssl_cacert" => chain_of_certificates[:root_ca].path }
+              {
+                "host" => "0.0.0.0",
+                "port" => port,
+                "ssl_enable" => true,
+                "ssl_verify" => true,
+                "ssl_cert" => chain_of_certificates[:a_cert].path,
+                "ssl_key" => chain_of_certificates[:a_key].path,
+                "ssl_cacert" => chain_of_certificates[:root_ca].path
+              }
             end
 
             let(:client_certificate) { File.read(chain_of_certificates[:aa_cert].path) }
@@ -364,6 +387,7 @@ describe LogStash::Inputs::Tcp do
                 socket = TCPSocket.new("127.0.0.1", port)
                 OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
               end
+
               result = helper.pipelineless_input(subject, nevents) do
                 socket.connect
                 nevents.times do |i|
@@ -371,6 +395,7 @@ describe LogStash::Inputs::Tcp do
                   socket.flush
                 end
               end
+
               socket.close rescue nil
 
               result
@@ -380,15 +405,25 @@ describe LogStash::Inputs::Tcp do
               expect(events.size).to be(nevents)
             end
 
+            it "should contain sslsubject" do
+              events.each do |event|
+                expect(event["sslsubject"]).to eq("/DC=org/DC=ruby-lang/CN=RubyAA_Cert")
+              end
+            end
           end
 
           context "using an extra chain of certificates" do
 
             let(:config) do
-              { "host" => "0.0.0.0", "port" => port,
-                "ssl_enable" => true, "ssl_verify" => true,
-                "ssl_cert" => chain_of_certificates[:b_cert].path, "ssl_key" => chain_of_certificates[:b_key].path,
-                "ssl_extra_chain_certs" => [ chain_of_certificates[:root_ca].path, chain_of_certificates[:a_cert].path, chain_of_certificates[:b_cert].path ] }
+              {
+                "host" => "0.0.0.0",
+                "port" => port,
+                "ssl_enable" => true,
+                "ssl_verify" => true,
+                "ssl_cert" => chain_of_certificates[:b_cert].path,
+                "ssl_key" => chain_of_certificates[:b_key].path,
+                "ssl_extra_chain_certs" => [ chain_of_certificates[:root_ca].path, chain_of_certificates[:a_cert].path, chain_of_certificates[:b_cert].path ]
+              }
             end
 
             let(:client_certificate) { File.read(chain_of_certificates[:c_cert].path) }
@@ -399,6 +434,7 @@ describe LogStash::Inputs::Tcp do
                 socket = TCPSocket.new("127.0.0.1", port)
                 OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
               end
+
               result = helper.pipelineless_input(subject, nevents) do
                 socket.connect
                 nevents.times do |i|
@@ -406,6 +442,7 @@ describe LogStash::Inputs::Tcp do
                   socket.flush
                 end
               end
+
               socket.close rescue nil
 
               result
@@ -414,14 +451,19 @@ describe LogStash::Inputs::Tcp do
             it "should receive events" do
               expect(events.size).to be(nevents)
             end
+
+            it "should contain sslsubject" do
+              events.each do |event|
+                expect(event["sslsubject"]).to eq("/DC=org/DC=ruby-lang/CN=RubyC_Cert")
+              end
+            end
           end
         end
-
       end
     end
+
     it_behaves_like "an interruptible input plugin" do
       let(:config) { { "port" => port } }
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-tcp
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -166,11 +166,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Read events over a TCP socket.
 test_files:
 - spec/inputs/tcp_spec.rb
 - spec/spec_helper.rb
-has_rdoc: