logstash-filter-forwarded 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9836c06be1410c903946dd50caa1db25579a8b9b
-  data.tar.gz: 8d1113c740982044469e4b3ca019d4ef5de091fc
+SHA256:
+  metadata.gz: 0f1f500dbb7cc97b1db2a9afe092813613d05657f5157216bb9c315bd92a3532
+  data.tar.gz: 2ca815eb8a258526b17d76cf11f7b0a79956eea1d9cccdacc7b2b14b2dd764e4
 SHA512:
-  metadata.gz: b3564a029f707a9e3985572c9dadc97c3cbce86db446d6e552217119fad0262ae7993bd22f2f746d264f70cdb471d6538321cc665b366080bbd2ebce318dfdd4
-  data.tar.gz: 12f5ccc4062b569e666bf57f7dd8553c73eac3aaa6d4b7d9f705f0ab5506140433296b4a4fab3d9555c40c4c4aa5e5a1a1024a70cc6465e16247ac6cf318075f
+  metadata.gz: 85064a1bbc5b269be6502649408f36e5fccc2fd1927d323ad54e02f6ed31e2b76207fddcfe5e9ce585ab953388af1c86eef82714ae051dc175bb21ed1ffdabd5
+  data.tar.gz: a9208a31e127eeab8bbab09379e66c4b3886bd1cb87633d3b54312af2b054e29f95f6692c4a4e8c28192b04c48ba2eb2bf8b142c6e6c0bcf92cde983a9e3eeae

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### v1.0.5
+
+Don't set the proxy list as an event field if it is empty.
+
 ### v1.0.4
 
 Remove port numbers from ip addresses

data/lib/logstash/filters/forwarded.rb

@@ -11,26 +11,26 @@ require "ipaddress" # needed for validity check
 
 class LogStash::Filters::Forwarded < LogStash::Filters::Base
   config_name "forwarded"
-  
+
   # The field containing the x-forwarded-for string
   config :source, :validate => :string, :required => true
 
-  # list of ip patterns that private ips start with. 
+  # list of ip patterns that private ips start with.
   config :private_ipv4_prefixes, :validate => :array, :required => false, :default => ["10.0.0.0/8", "192.168.0.0/16" ,"172.16.0.0/12"]
 
   # Private IP Addresses have the following ranges:
   # 10.0.0.0    - 10.255.255.255
   # 172.16.0.0  - 172.31.255.255
-  # 192.168.0.0 - 192.168.255.255 
+  # 192.168.0.0 - 192.168.255.255
 
   # The name of the new field containing client ip (optional)
   config :target_client_ip, :validate => :string, :required => false, :default => "forwarded_client_ip"
 
   # The name of the new field containing proxy list (optional)
   config :target_proxy_list, :validate => :string, :required => false, :default => "forwarded_proxy_list"
-  
+
   public
-  def register    
+  def register
     @private_ipv4_ranges = @private_ipv4_prefixes.collect do | adress |
       begin
         IPAddr.new(adress)
@@ -52,11 +52,11 @@ class LogStash::Filters::Forwarded < LogStash::Filters::Base
       return unless forwarded and !forwarded.empty?
 
       client_ip, proxies = analyse(forwarded)
-      
+
       event.set(@target_client_ip, client_ip) if client_ip
       event.set(@target_proxy_list, proxies) if proxies
-      filter_matched(event)     
-      
+      filter_matched(event)
+
     rescue Exception => e
       @logger.debug("Unknown error while looking up GeoIP data", :exception => e, :field => @source, :event => event)
       # raise e
@@ -66,7 +66,7 @@ class LogStash::Filters::Forwarded < LogStash::Filters::Base
   def analyse(ip)
     return nil, nil if ip.nil?
       # convert the x-forwarded-for string into an array of its comma separated value, if it isn't already.
-      ip_list = ip.is_a?(Array) ? ip : ip.downcase.split(",")  
+      ip_list = ip.is_a?(Array) ? ip : ip.downcase.split(",")
 
       # remove some well-known invalid values
       ip_list = ip_list.map { |x| x.strip }.reject { |x| ["-", "unknown"].include? x}
@@ -76,20 +76,20 @@ class LogStash::Filters::Forwarded < LogStash::Filters::Base
 
       # get the first public ip in the list
       client_ip = get_client_ip(ip_list)
-      
+
       # remove the public / client ip from the list and use the remainder as the list of proxies involved.
-      proxies = ip_list.nil? ? [] : ip_list - [client_ip]
-      
+      proxies = ip_list.nil? ? nil : ip_list - [client_ip]
+
       return client_ip, proxies
   end # def analyse
 
   def get_client_ip(ip_array)
       ip_array.each do | ip |
-        begin          
+        begin
           next if !IPAddress.valid? ip
 
-          ipo = IPAddr.new(ip)            
-          is_private = ipo.ipv6? ? is_private_ipv6(ip) : is_private_ipv4(ipo)         
+          ipo = IPAddr.new(ip)
+          is_private = ipo.ipv6? ? is_private_ipv6(ip) : is_private_ipv4(ipo)
           return ip if !is_private
         rescue => e
           # not a valid ip, moving on.
@@ -104,7 +104,7 @@ class LogStash::Filters::Forwarded < LogStash::Filters::Base
     tokens = ip.split(":")
     if tokens.size <=2 then tokens[0] else ip end
   end
-  
+
   def is_private_ipv6(ip)
     ip.start_with?("fd") || ip.start_with?("fc")
   end # is_private_ipv6

data/logstash-filter-forwarded.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-forwarded'
-  s.version         = '1.0.4'
+  s.version         = '1.0.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "$summary"
   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/filters/forwarded_spec.rb

@@ -6,16 +6,16 @@ require "logstash/timestamp"
 describe LogStash::Filters::Forwarded do
 
   let(:plugin) { LogStash::Filters::Forwarded.new("source" => "message") }
-  
+
   before do
     plugin.register
     plugin.filter(event)
   end
-  
+
   # Private IP Addresses have the following ranges:
   #10.0.0.0    - 10.255.255.255
   #172.16.0.0  - 172.31.255.255
-  #192.168.0.0 - 192.168.255.255 
+  #192.168.0.0 - 192.168.255.255
 
 
   context "1) multiple client ips" do

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-forwarded
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Inga Feick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.60'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
   name: logstash-core-plugin-api
@@ -24,16 +24,16 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.60'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: ipaddress
@@ -41,13 +41,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
@@ -55,10 +55,12 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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
+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
 email: inga.feick@trivago.com
 executables: []
 extensions: []
@@ -85,19 +87,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
-summary: $summary
+summary: "$summary"
 test_files:
 - spec/filters/forwarded_spec.rb