logstash-output-pipe 3.0.7 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a835830fb6d2646383cb63699d04c6d55b38c0e142bbd740e54068ab32e3eaaa
-  data.tar.gz: 6f85588e9cccf73b68152421dc91f8ac7b32a0c53ed40aab8edee3b5d81e5927
+  metadata.gz: 30187b18ca17f42c0c76b8da5d75bbc5dc33885f5bbd57a49c79abad8af05f6f
+  data.tar.gz: a60dbcb7fd743dcb04ce16742e3a2212ec33f5a26e31869ced82bc42bc717164
 SHA512:
-  metadata.gz: 56b9b747a7aa8ae872012110b6ace759170209aa1f6dba92d2c05f153e7d192303b83a942bc0a0958ba77be29a2bbe38f93ced6de60653220611e58d2d10e93b
-  data.tar.gz: 8f7567edb2a8274fe625044fcc319caf027ce36dea5a9bfc364b5f1612984cab11bbd21c148f4e8844def61592f9a54732d5b3025bd6fefeb8116690654edf39
+  metadata.gz: 3317c089fff1821a0a86df0ec0d3e3c6ba5eeb97341e416c185e38fb821374719f8bdb9d4de49fee7a9fa69f9f7dc0fc61729033a0e0b8bcec1421849517985a
+  data.tar.gz: 1086fd66ff7c7fe07a1634eda83c73fdf331e8a447e75af36c3cf9a5eb2ccb006383c5a64a42fd0aa10bf4fe86c75406e09817f6c20278012f20d411ce618d10

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.0.0
+  - [BREAKING] `command` accept array form and no longer invokes a shell [#5](https://github.com/logstash-plugins/logstash-output-pipe/pull/5)
+  - Existing string commands with whitespace should be converted to array form
+
 ## 3.0.7
   - [DOC] Document `command` string form limitation [#6](https://github.com/logstash-plugins/logstash-output-pipe/pull/6)
 

data/VERSION

@@ -0,0 +1 @@
+4.0.0

data/docs/index.asciidoc

@@ -35,7 +35,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 [cols="<,<,<",options="header",]
 |=======================================================================
 |Setting |Input type|Required
-| <<plugins-{type}s-{plugin}-command>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-command>> |<<array,array>>|Yes
 | <<plugins-{type}s-{plugin}-message_format>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-ttl>> |<<number,number>>|No
 |=======================================================================
@@ -46,21 +46,27 @@ output plugins.
 &nbsp;
 
 [id="plugins-{type}s-{plugin}-command"]
-===== `command` 
+===== `command`
 
   * This is a required setting.
-  * Value type is <<string,string>>
+  * Value type is <<array,array>>
   * There is no default value for this setting.
 
-Command line to launch and pipe to
+Command line to launch and pipe to.
+
+Example:
+
+[source,ruby]
+----
+output {
+  pipe {
+    command => ["tee", "-a", "/tmp/logstash-%{host}.log"]
+  }
+}
+----
 
-NOTE: `command` is passed to `/bin/sh`, so any metacharacters
-(`;`, `|`, `>`, `&`, etc.) in field substitutions will be interpreted by the shell.
-If `command` contains such character(s), it is recommended
-to upgrade to plugin version 4.0.0 or later, which accepts `command`
-as an array and invokes the program directly bypassing shell interpretation.
 [id="plugins-{type}s-{plugin}-message_format"]
-===== `message_format` 
+===== `message_format`
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
@@ -73,7 +79,7 @@ If this setting is omitted, the full json representation of the
 event will be written as a single line.
 
 [id="plugins-{type}s-{plugin}-ttl"]
-===== `ttl` 
+===== `ttl`
 
   * Value type is <<number,number>>
   * Default value is `10`
@@ -85,4 +91,4 @@ Close pipe that hasn't been used for TTL seconds. -1 or 0 means never close.
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
 
-:default_codec!:
+:default_codec!:

data/lib/logstash/outputs/pipe.rb

@@ -20,21 +20,23 @@ class LogStash::Outputs::Pipe < LogStash::Outputs::Base
   config :message_format, :validate => :string
 
   # Command line to launch and pipe to
-  config :command, :validate => :string, :required => true
+  config :command, :validate => :array, :required => true
 
   # Close pipe that hasn't been used for TTL seconds. -1 or 0 means never close.
   config :ttl, :validate => :number, :default => 10
   public
   def register
+    if @command.empty?
+      raise LogStash::ConfigurationError, "The 'command' setting must not be empty"
+    end
+
     @pipes = {}
     @last_stale_cleanup_cycle = Time.now
   end # def register
 
   public
   def receive(event)
-    
-
-    command = event.sprintf(@command)
+    command = @command.map { |part| event.sprintf(part) }
 
     if @message_format
       output = event.sprintf(@message_format) + "\n"

data/logstash-output-pipe.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-pipe'
-  s.version         = ::File.read('version').split("\n").first
+  s.version         = ::File.read('VERSION').split("\n").first
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Pipes events to another program's standard input"
   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/pipe_spec.rb

@@ -32,4 +32,55 @@ describe LogStash::Outputs::Pipe do
     end
 
   end
+
+  describe "command resolution" do
+    let(:pipe)    { double("pipe") }
+    let(:payload) { "test_message; id > /tmp/INJECTED; #" }
+
+    before(:each) do
+      allow(PipeWrapper).to receive(:new).and_return(pipe)
+      allow(pipe).to receive(:puts)
+      subject.register
+    end
+
+    shared_examples "resolves command" do
+      it "passes the resolved command to PipeWrapper" do
+        expect(PipeWrapper).to receive(:new).with(expected_command, anything).and_return(pipe)
+        subject.receive(event)
+      end
+    end
+
+    context "string command coerced to array" do
+      subject { LogStash::Outputs::Pipe.new("command" => "logger -t audit %{message}") }
+      let(:event)            { LogStash::Event.new("message" => payload) }
+      let(:expected_command) { ["logger -t audit #{payload}"] }
+
+      include_examples "resolves command"
+    end
+
+    context "array command" do
+      context "each element resolved independently" do
+        subject { LogStash::Outputs::Pipe.new("command" => ["logger", "-t", "%{tag}", "--", "%{message}"]) }
+        let(:event)            { LogStash::Event.new("tag" => "audit", "message" => "hello") }
+        let(:expected_command) { ["logger", "-t", "audit", "--", "hello"] }
+
+        include_examples "resolves command"
+      end
+
+      context "single-element array" do
+        subject { LogStash::Outputs::Pipe.new("command" => ["logger -t audit %{message}"]) }
+        let(:event)            { LogStash::Event.new("message" => payload) }
+        let(:expected_command) { ["logger -t audit #{payload}"] }
+
+        include_examples "resolves command"
+      end
+    end
+  end
+
+  describe "validation" do
+    it "raises ConfigurationError when command is an empty array" do
+      plugin = LogStash::Outputs::Pipe.new("command" => [])
+      expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-pipe
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 4.0.0
 platform: ruby
 authors:
 - Elastic
@@ -71,6 +71,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- VERSION
 - docs/index.asciidoc
 - lib/logstash/outputs/pipe.rb
 - logstash-output-pipe.gemspec