Support both, encoded and non encoded api-key formats on plugin configuration

Author: alexcams

README.md

@@ -59,7 +59,7 @@ export ES_VERSION=5.1.1
 
 - Edit Logstash `Gemfile` and add the local plugin path, for example:
 ```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+gem "logstash-output-elasticsearch", :path => "/your/local/logstash-output-elasticsearch"
 ```
 - Install plugin
 ```sh
@@ -72,8 +72,10 @@ bin/plugin install --no-verify
 ```
 - Run Logstash with your plugin
 ```sh
-bin/logstash -e 'filter {awesome {}}'
+bin/logstash -e 'output { elasticsearch { hosts => ["http://example:9200"] user => "example" password => "example" } }'
 ```
+** Note **: This is a simple example for elasticsearch output plugin config, for more detailed information check [Logstash documentation](https://www.elastic.co/docs/reference/logstash/plugins/plugins-outputs-elasticsearch).
+
 At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
 
 #### 2.2 Run in an installed Logstash
@@ -82,7 +84,7 @@ You can use the same **2.1** method to run your plugin in an installed Logstash
 
 - Build your plugin gem
 ```sh
-gem build logstash-filter-awesome.gemspec
+gem build logstash-output-elasticsearch.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh

lib/logstash/outputs/elasticsearch/http_client_builder.rb

@@ -188,9 +188,14 @@ def self.setup_basic_auth(logger, params)
  def self.setup_api_key(logger, params)
  api_key = params["api_key"]
 
- return {} unless (api_key && api_key.value)
+ return {} unless (api_key&.value)
 
- { "Authorization" => "ApiKey " + Base64.strict_encode64(api_key.value) }
+ api_key_value = api_key.value
+ if api_key_value =~ /\A[^:]+:[^:]+\z/
+ api_key_value = Base64.strict_encode64(api_key_value)
+ end
+
+ { "Authorization" => "ApiKey " + api_key_value }
  end
 
  private

spec/unit/http_client_builder_spec.rb

@@ -26,6 +26,44 @@
  end
  end
 
+ describe "auth setup with api-key" do
+ let(:klass) { LogStash::Outputs::ElasticSearch::HttpClientBuilder }
+
+ context "when api-key is not encoded (id:api-key)" do
+ let(:api_key) { "id:api-key" }
+ let(:api_key_secured) do
+ secured = double("api_key")
+ allow(secured).to receive(:value).and_return(api_key)
+ secured
+ end
+ let(:options) { { "api_key" => api_key_secured } }
+ let(:logger) { double("logger") }
+ let(:api_key_header) { klass.setup_api_key(logger, options) }
+
+ it "returns the correct encoded api-key header" do
+ expected = "ApiKey #{Base64.strict_encode64(api_key)}"
+ expect(api_key_header["Authorization"]).to eql(expected)
+ end
+ end
+
+ context "when api-key is already encoded" do
+ let(:api_key) { Base64.strict_encode64("id:api-key") }
+ let(:api_key_secured) do
+ secured = double("api_key")
+ allow(secured).to receive(:value).and_return(api_key)
+ secured
+ end
+ let(:options) { { "api_key" => api_key_secured } }
+ let(:logger) { double("logger") }
+ let(:api_key_header) { klass.setup_api_key(logger, options) }
+
+ it "returns the api-key header as is" do
+ expected = "ApiKey #{api_key}"
+ expect(api_key_header["Authorization"]).to eql(expected)
+ end
+ end
+ end
+
  describe "customizing action paths" do
  let(:hosts) { [ ::LogStash::Util::SafeURI.new("http://localhost:9200") ] }
  let(:options) { {"hosts" => hosts } }