logstash-output-jms 3.0.3 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc40b0019682516e29929ca3cff34388aca968efb37d45bdc293e86d8bc0e2c3
-  data.tar.gz: 93cf282e0e42ed4abe5ad3975f24e602294992f0cd7c2934416f7dda40104ab7
+  metadata.gz: f3d27d534c83d98949910785e963e44bf475d3ae0954b07c9944ba506e146615
+  data.tar.gz: 1d9e8d144efc3741ace3239ef5c343db69a87ef2664ed85396785213af2b867a
 SHA512:
-  metadata.gz: a7ba4161f4f739edebd5e205e47ecb4cd9f9adaf46de0989777a2ee82f8a6855f394dcd5a9dd559d78118cf789eb123c4cc3fe7f4c7c8b8adaa54a577e6d6e1a
-  data.tar.gz: 9a7b0913a86792e0ac8f65e516272d90bf152853db3d901c370d29bfac10702508baa2b6ba5228089a61751ff6a6a8eb901c3b2b581501c6d9d1fd22ad8a0824
+  metadata.gz: 1a16d6ab310543e0c983414c961e0057b5badd71b4b186edda338df6efc7be56f56c045ee0243bf2cb818fec9c970d357e6209f987c84ad3baade684775c1386
+  data.tar.gz: 04bcda04efd670503ca16d42c48b8dd7556bd29d28ca6bec7e2be6d2ad9e7124bbb29ca212b5e57b045c5b2bf2c97bcd9ed5fa2e43d058425bd19f7988902193

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.0.5
+  - Change `password` config type to `password` to prevent leaking in the debug logs [#15](https://github.com/logstash-plugins/logstash-output-jms/pull/15) 
+
+## 3.0.4
+  - Fixes an issue where `delivery_mode` directive was silently ignored.
+
 ## 3.0.3
   - Docs: Set the default_codec doc attribute.
 

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-jms.svg)](https://travis-ci.org/logstash-plugins/logstash-output-jms)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-output-jms.svg)](https://travis-ci.com/logstash-plugins/logstash-output-jms)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -52,7 +52,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-factory>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-jndi_context>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-jndi_name>> |<<string,string>>|No
-| <<plugins-{type}s-{plugin}-password>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-pub_sub>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-require_jars>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No
@@ -119,7 +119,7 @@ Name of JNDI entry at which the Factory can be found
 [id="plugins-{type}s-{plugin}-password"]
 ===== `password` 
 
-  * Value type is <<string,string>>
+  * Value type is <<password,password>>
   * There is no default value for this setting.
 
 Password to use when connecting to the JMS provider

data/lib/logstash/outputs/jms.rb

@@ -23,7 +23,7 @@ class LogStash::Outputs::Jms < LogStash::Outputs::Base
 
 # Name of delivery mode to use
 # Options are "persistent" and "non_persistent" if not defined nothing will be passed.
-config :delivery_mode, :validate => :string, :default => nil
+config :delivery_mode, :validate => %w(persistent non_persistent)
 
 # If pub-sub (topic) style should be used or not.
 # Mandatory
@@ -51,7 +51,7 @@ config :factory, :validate => :string
 # Username to connect to JMS provider with
 config :username, :validate => :string
 # Password to use when connecting to the JMS provider
-config :password, :validate => :string
+config :password, :validate => :password
 # Url to use when connecting to the JMS provider
 config :broker_url, :validate => :string
 
@@ -88,23 +88,34 @@ config :jndi_context, :validate => :hash
         :require_jars => @require_jars,
         :factory => @factory,
         :username => @username,
-        :password => @password,
+        :password => @password.nil? ? nil : @password.value,
         :broker_url => @broker_url,
         :url => @broker_url # "broker_url" is named "url" with Oracle AQ
         }
     end
 
     @logger.debug("JMS Config being used", :context => @jms_config)
-    @connection = JMS::Connection.new(@jms_config)
+    begin
+      # The jruby-jms adapter dynamically loads the Java classes that it extends, and may fail
+      @connection = JMS::Connection.new(@jms_config)
+    rescue NameError => ne
+      if @require_jars && !@require_jars.empty?
+        logger.warn('The `require_jars` directive was provided, but may not correctly map to a JNS provider', :require_jars => @require_jars)
+      end
+      logger.error('Failed to load JMS Connection, likely because a JMS Provider is not on the Logstash classpath '+
+                   'or correctly specified by the plugin\'s `require_jars` directive', :exception => ne.message, :backtrace => ne.backtrace)
+      fail(LogStash::PluginLoadingError, 'JMS Input failed to load, likely because a JMS provider was not available')
+    end
+
     @session = @connection.create_session()
 
     # Cache the producer since we should keep reusing this one.
     destination_key = @pub_sub ? :topic_name : :queue_name
     @producer = @session.create_producer(@session.create_destination(destination_key => @destination))
 
-    if !@delivery_mode.nil?
-      @producer.delivery_mode_sym = @deliver_mode
-    end
+    # If a delivery mode has been specified, inform the producer
+    @producer.delivery_mode_sym = @delivery_mode.to_sym unless @delivery_mode.nil?
+
   end # def register
 
   def receive(event)

data/logstash-output-jms.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
 	s.name            = 'logstash-output-jms'
-	s.version         = '3.0.3'
+	s.version         = '3.0.5'
 	s.licenses        = ['Apache License (2.0)']
 	s.summary         = "Push events to a JMS topic or queue."
 	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"

data/spec/outputs/jms_spec.rb

@@ -14,6 +14,7 @@ describe "outputs/jms" do
 
   context 'when initializing' do
     it "should register" do
+      pending('JMS Provider')
       output = LogStash::Plugin.lookup("output", "jms").new(jms_config)
       expect {output.register}.to_not raise_error
     end
@@ -26,10 +27,21 @@ describe "outputs/jms" do
 
   context 'when outputting messages' do
     it 'should send logstash event to jms queue' do
+      pending('JMS Provider')
       jms = LogStash::Outputs::Jms.new(jms_config)
       jms.register
       jms.receive(event)
       # Add code to check the message is correct on the queue.
     end
   end
+
+  describe "debugging `password`" do
+    let(:config) { jms_config.merge("password" => "$ecre&-key") }
+    it "should not show origin value" do
+
+      output = LogStash::Plugin.lookup("output", "jms").new(config)
+      expect(output.logger).to receive(:debug).with('<password>')
+      output.logger.send(:debug, output.password.to_s)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-jms
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.5
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -124,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Push events to a JMS topic or queue.