logstash-output-tcp 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74e0474b7a4e935ba8952b80b5b4169f2b472730
-  data.tar.gz: bb736f1d5f6ff2c3cf870262d24c10f7f400df79
+  metadata.gz: 4389bec372bcd792d65085047d3e61e809062ace
+  data.tar.gz: 17a8ec05a14153a46f187a47fb88ae1b032692bb
 SHA512:
-  metadata.gz: 3dd3dc38a97f307321cbdaeebe0a3410c3df4fcc3d5c15d2f7c959788b350e3faad77a17eb87209693c06b7a47bd5c58e725e2056972d905cd01d697a1527721
-  data.tar.gz: bbbe0a64aca9112bc5f9db6fdc6a467957f1078c7e17efb8144afff94f2705e834baeb6f66882a0e1feddd6f98912fe7f8f6912991950d57cad8a4c60f217fb6
+  metadata.gz: 45b25dac4c91cdf81bcdfb3cfc1129078d429f484f16bf2924388064168b935aed561e7243bdfb2a85a4808ee7ff73dce276c4c9854ce3f33c853fe51b4a3e9d
+  data.tar.gz: 350ce2abbc36f8d1b0291ecfd1c772da8494b12bfe27e0a209d8648151f4a4e2d84c3a47454d25eb43acbf61d15685cf26d28e58e18ed0c5807c707a608720fd

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.0
+ - Added SSL support to this plugin (@michaelweiser)
+
 ## 3.1.1
   - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
 

data/lib/logstash/outputs/tcp.rb

@@ -2,6 +2,7 @@
 require "logstash/outputs/base"
 require "logstash/namespace"
 require "thread"
+require "logstash/util/socket_peer"
 
 # Write events over a TCP socket.
 #
@@ -30,6 +31,33 @@ class LogStash::Outputs::Tcp < LogStash::Outputs::Base
   # `client` connects to a server.
   config :mode, :validate => ["server", "client"], :default => "client"
 
+  # Enable SSL (must be set for other `ssl_` options to take effect).
+  config :ssl_enable, :validate => :boolean, :default => false
+
+  # Verify the identity of the other end of the SSL connection against the CA.
+  # For input, sets the field `sslsubject` to that of the client certificate.
+  config :ssl_verify, :validate => :boolean, :default => false
+
+  # The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.
+  config :ssl_cacert, :validate => :path
+
+  # SSL certificate path
+  config :ssl_cert, :validate => :path
+
+  # SSL key path
+  config :ssl_key, :validate => :path
+
+  # SSL key passphrase
+  config :ssl_key_passphrase, :validate => :password, :default => nil
+
+  # The format to use when writing events to the file. This value
+  # supports any string and can include `%{name}` and other dynamic
+  # strings.
+  #
+  # If this setting is omitted, the full json representation of the
+  # event will be written as a single line.
+  config :message_format, :validate => :string, :deprecated => true
+
   class Client
     public
     def initialize(socket, logger)
@@ -57,25 +85,63 @@ class LogStash::Outputs::Tcp < LogStash::Outputs::Base
     end # def write
   end # class Client
 
+  private
+  def setup_ssl
+    require "openssl"
+
+    @ssl_context = OpenSSL::SSL::SSLContext.new
+    @ssl_context.cert = OpenSSL::X509::Certificate.new(File.read(@ssl_cert))
+    @ssl_context.key = OpenSSL::PKey::RSA.new(File.read(@ssl_key),@ssl_key_passphrase)
+    if @ssl_verify
+      @cert_store = OpenSSL::X509::Store.new
+      # Load the system default certificate path to the store
+      @cert_store.set_default_paths
+      if File.directory?(@ssl_cacert)
+        @cert_store.add_path(@ssl_cacert)
+      else
+        @cert_store.add_file(@ssl_cacert)
+      end
+      @ssl_context.cert_store = @cert_store
+      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER|OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+    end
+  end # def setup_ssl
+
   public
   def register
     require "socket"
     require "stud/try"
+    if @ssl_enable
+      setup_ssl
+    end # @ssl_enable
+
     if server?
       workers_not_supported
 
       @logger.info("Starting tcp output listener", :address => "#{@host}:#{@port}")
-      @server_socket = TCPServer.new(@host, @port)
+      begin
+        @server_socket = TCPServer.new(@host, @port)
+      rescue Errno::EADDRINUSE
+        @logger.error("Could not start TCP server: Address in use",
+                      :host => @host, :port => @port)
+        raise
+      end
+      if @ssl_enable
+        @server_socket = OpenSSL::SSL::SSLServer.new(@server_socket, @ssl_context)
+      end # @ssl_enable
       @client_threads = []
 
       @accept_thread = Thread.new(@server_socket) do |server_socket|
         loop do
-          client_thread = Thread.start(server_socket.accept) do |client_socket|
+          Thread.start(server_socket.accept) do |client_socket|
+            # monkeypatch a 'peer' method onto the socket.
+            client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
+            @logger.debug("Accepted connection", :client => client_socket.peer,
+                          :server => "#{@host}:#{@port}")
             client = Client.new(client_socket, @logger)
             Thread.current[:client] = client
+            @client_threads << Thread.current
             client.run
           end
-          @client_threads << client_thread
         end
       end
 
@@ -113,7 +179,22 @@ class LogStash::Outputs::Tcp < LogStash::Outputs::Base
   private
   def connect
     Stud::try do
-      return TCPSocket.new(@host, @port)
+      client_socket = TCPSocket.new(@host, @port)
+      if @ssl_enable
+        client_socket = OpenSSL::SSL::SSLSocket.new(client_socket, @ssl_context)
+        begin
+          client_socket.connect
+        rescue OpenSSL::SSL::SSLError => ssle
+          @logger.error("SSL Error", :exception => ssle,
+                        :backtrace => ssle.backtrace)
+          # NOTE(mrichar1): Hack to prevent hammering peer
+          sleep(5)
+          raise
+        end
+      end
+      client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
+      @logger.debug("Opened connection", :client => "#{client_socket.peer}")
+      return client_socket
     end
   end # def connect
 

data/logstash-output-tcp.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-tcp'
-  s.version         = '3.1.1'
+  s.version         = '3.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Write 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/logstash-plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-tcp
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Write events over a TCP socket.