logstash-output-elasticsearch 5.1.0-java → 5.1.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e747b0ecd3b13e55c194f3baec4991095a6fe35
-  data.tar.gz: dce871709afbdaf6d303a273d7743dc92b964212
+  metadata.gz: 7460d82e37205595de8bb7fb7f4a7a9cfdeb6817
+  data.tar.gz: 361096568a9c9c0a5fa58d9b495b761f19312b29
 SHA512:
-  metadata.gz: 8ec8d71aea257c1bdb59122e45ac0472681dd91efd074b360678e273c7bdd15ef7211e2984a2bac84b3ebb4b2b6277c456451abf300f222e632680f40d3f2a6a
-  data.tar.gz: f315ec0e2e6f5ed3b9fc91ec30082a9bc2cf5910def149539ba4bf62def32f45b084fd26c0e948f47f142a5ca6d86496bd2cba7d9d41aa717c6af66b6396f11e
+  metadata.gz: ab9ddc3ff94a908c473e79869a3fd2b41682c7facbab54183c40294119b5c23907156a16f677c3181b5f8519670843cc380cd08528b13366f4ce8db3e5837104
+  data.tar.gz: 4eb8391a5fb0df0666a30afabb67ba27e913dfb996e03e0a24edb9e8c73cb8214bfd1e686373385bed0d636034d812207e8930f036d6ff57b001a7c18d3378d7

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.1.1
+- Hide user and password from the URL logged during sniffing process.
+
 ## 5.1.0
 - Add check_connection_timeout parameter (default 10m)
 - Set default timeout to 60s

data/lib/logstash/outputs/elasticsearch/http_client/manticore_adapter.rb

@@ -1,4 +1,5 @@
 require 'manticore'
+require "logstash/outputs/elasticsearch/safe_url"
 
 module LogStash; module Outputs; class ElasticSearch; class HttpClient;
   class ManticoreAdapter
@@ -28,13 +29,10 @@ module LogStash; module Outputs; class ElasticSearch; class HttpClient;
     # @see    Transport::Base#perform_request
     #
     def perform_request(url, method, path, params={}, body=nil)
-      
-      
       params = (params || {}).merge @request_options
       params[:body] = body if body
       url_and_path = (url + path).to_s # Convert URI object to string
 
-
       resp = @manticore.send(method.downcase, url_and_path, params)
 
       # Manticore returns lazy responses by default
@@ -46,7 +44,8 @@ module LogStash; module Outputs; class ElasticSearch; class HttpClient;
       # template installation. We might need a better story around this later
       # but for our current purposes this is correct
       if resp.code < 200 || resp.code > 299 && resp.code != 404
-        raise ::LogStash::Outputs::ElasticSearch::HttpClient::Pool::BadResponseCodeError.new(resp.code, url_and_path, body)
+        safe_url = ::LogStash::Outputs::ElasticSearch::SafeURL.without_credentials(url)
+        raise ::LogStash::Outputs::ElasticSearch::HttpClient::Pool::BadResponseCodeError.new(resp.code, safe_url + path, body)
       end
 
       resp

data/lib/logstash/outputs/elasticsearch/http_client/pool.rb

@@ -6,12 +6,12 @@ module LogStash; module Outputs; class ElasticSearch; class HttpClient;
 
       def initialize(response_code, url, body)
         @response_code = response_code
-        @url = url
+        @url = ::LogStash::Outputs::ElasticSearch::SafeURL.without_credentials(url)
         @body = body
       end
 
       def message
-        "Got response code '#{response_code}' contact Elasticsrearch at URL '#{@url}'"
+        "Got response code '#{response_code}' contact Elasticsearch at URL '#{@url}'"
       end
     end
     class HostUnreachableError < Error;
@@ -19,7 +19,7 @@ module LogStash; module Outputs; class ElasticSearch; class HttpClient;
 
       def initialize(original_error, url)
         @original_error = original_error
-        @url = url
+        @url = ::LogStash::Outputs::ElasticSearch::SafeURL.without_credentials(url)
       end
 
       def message

data/lib/logstash/outputs/elasticsearch/safe_url.rb

@@ -0,0 +1,16 @@
+module LogStash; module Outputs; class ElasticSearch;
+  module SafeURL
+    PLACEHOLDER = "~hidden~".freeze
+
+    module_function
+
+    # Takes a URI object and returns a copy of it with any user or password
+    # information replaced with a placeholder `~hidden~`.
+    def without_credentials(url)
+      url.dup.tap do |u|
+        u.user = PLACEHOLDER if u.user
+        u.password = PLACEHOLDER if u.password
+      end
+    end
+  end
+end end end

data/logstash-output-elasticsearch.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-elasticsearch'
-  s.version         = '5.1.0'
+  s.version         = '5.1.1'
   s.licenses        = ['apache-2.0']
   s.summary         = "Logstash Output to Elasticsearch"
   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/unit/safe_url_spec.rb

@@ -0,0 +1,46 @@
+require "logstash/outputs/elasticsearch/safe_url"
+require "uri"
+
+describe ::LogStash::Outputs::ElasticSearch::SafeURL do
+  let(:placeholder) { ::LogStash::Outputs::ElasticSearch::SafeURL::PLACEHOLDER }
+
+  context "#without_credentials" do
+    subject { described_class.without_credentials(url) }
+
+    shared_examples_for "returning a new object" do
+      it "should return a new url object" do
+        expect(subject.object_id).not_to be == url.object_id
+      end
+    end
+
+    context "when given a url without credentials" do
+      let(:url) { URI.parse("https://example.com/") }
+
+      it_behaves_like "returning a new object"
+
+      it "should return the same url" do
+        expect(subject).to be == url
+      end
+    end
+
+    context "when url contains credentials" do
+      let(:url) { URI.parse("https://user:pass@example.com/") }
+
+      it_behaves_like "returning a new object"
+      
+      it "should hide the user" do
+        expect(subject.user).to be == placeholder
+      end
+
+      it "should hide the password" do
+        expect(subject.user).to be == placeholder
+      end
+
+      context "#to_s" do
+        it "should not contain credentials" do
+          expect(subject.to_s).to be == "https://#{placeholder}:#{placeholder}@example.com/"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +189,7 @@ files:
 - lib/logstash/outputs/elasticsearch/http_client/manticore_adapter.rb
 - lib/logstash/outputs/elasticsearch/http_client/pool.rb
 - lib/logstash/outputs/elasticsearch/http_client_builder.rb
+- lib/logstash/outputs/elasticsearch/safe_url.rb
 - lib/logstash/outputs/elasticsearch/template_manager.rb
 - logstash-output-elasticsearch.gemspec
 - spec/es_spec_helper.rb
@@ -215,6 +216,7 @@ files:
 - spec/unit/outputs/elasticsearch_spec.rb
 - spec/unit/outputs/elasticsearch_ssl_spec.rb
 - spec/unit/outputs/error_whitelist_spec.rb
+- spec/unit/safe_url_spec.rb
 homepage: http://logstash.net/
 licenses:
 - apache-2.0
@@ -266,3 +268,4 @@ test_files:
 - spec/unit/outputs/elasticsearch_spec.rb
 - spec/unit/outputs/elasticsearch_ssl_spec.rb
 - spec/unit/outputs/error_whitelist_spec.rb
+- spec/unit/safe_url_spec.rb