logstash-filter-real_ip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88e7483965ddd5c17fa615a7d996119471c37c3fe962c960e4100fec3072af04
+  data.tar.gz: d0eea1f5ecdf8d83188df244d9c01ca2f521affee30c56c3e6d694085ac1683c
+SHA512:
+  metadata.gz: b7fbcf884b25d0aaf0801ab27ec7288d5864c007947f2834a6c3026178cc72a333c2d0da4fc49b5fed8d43e21b189aed2c9ab5be3175e33cfdc4eba02393bdb3
+  data.tar.gz: f2d85853339251efb7eb5a52eb1fde05d0d3ee0c5164e2384f29e5484e970903fbfc400de50ea53d5de140cda5c15baad2136639f57fdd159b8c6709a323748c

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Ferdinand Holzer - ferdinand.holzer@gmail.com, fholzer@gvcgroup.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+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
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/real_ip.rb

@@ -0,0 +1,204 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "ipaddr"
+
+# Evaluate an HTTP request's client address like Apache httpd's mod_remoteip or
+# Nginx's realip module.
+#
+# For an event like this:
+# [source,ruby]
+#     {
+#         "remote_addr" => "10.1.1.1"
+#         "x_fwd_for" => ["1.2.3.4", "10.2.2.2"]
+#     }
+# An example configuration looks like so:
+# [source,ruby]
+#     filter {
+#       real_ip {
+#         remote_address_field => "remote_addr"
+#         x_forwarded_for_field => "x_fwd_for"
+#         trusted_networks => [
+#           "10.0.0.0/8",
+#           "192.168.0.0/16"
+#         ]
+#       }
+#     }
+# This will evaluate the real client IP, writing it to a new field "realip".
+# For above example event that would be "1.2.3.4"
+#
+# Often web servers don't provide the value of the X-Forwarded-For header as
+# an array. For ease of use the real_ip plugin provides capabilities to parse
+# such a comma-separated string. To enable this feature, use the
+# `x_forwarded_for_is_string` option.
+# [source,ruby]
+#     {
+#         "remote_addr" => "10.1.1.1"
+#         "x_fwd_for" => "1.2.3.4, 10.2.2.2"
+#     }
+# An example configuration looks like so:
+# [source,ruby]
+#     filter {
+#       real_ip {
+#         remote_address_field => "remote_addr"
+#         x_forwarded_for_field => "x_fwd_for"
+#         x_forwarded_for_is_string => true
+#         trusted_networks => [
+#           "10.0.0.0/8",
+#           "192.168.0.0/16"
+#         ]
+#       }
+#     }
+#
+# In case the plugin fails to evaluate the real client IP, it will add a tag to
+# the event, by default `_real_ip_lookup_failure`.
+# The plugin will fail if one of below it true:
+# * The `remote_address` field is absent.
+# * The `remote_address` field doesn't contain an IP address.
+# * The filter is configured using `x_forwarded_for_is_string = true`, but the
+# `x_forwarded_for` field isn't a string.
+# * The `x_forwarded_for` field contains anything other that IP addresses.
+#
+class LogStash::Filters::RealIp < LogStash::Filters::Base
+  config_name "real_ip"
+
+  # Name of the field that contains the layer 3 remote IP address
+  config :remote_address_field, :validate => :string, :default => ""
+
+  # Name of the field that contains the X-Forwarded-For header value
+  config :x_forwarded_for_field, :validate => :string, :default => ""
+
+  # Specifies whether the `x_forwarded_for_field` contains a comman-separated
+  # string instead of an array.
+  config :x_forwarded_for_is_string, :validate => :boolean, :default => false
+
+  # A list of trusted networks addresses. Be sure that you only specify
+  # addresses that you trust will correctly manipulate the X-Forwarded-For
+  # header.
+  config :trusted_networks, :validate => :array, :default => []
+
+  # Name of the field that this plugin will write the evaluated real client IP
+  # address to.
+  config :target_field, :validate => :string, :default => "real_ip"
+
+  # In case of error during evaluation, these tags will be set.
+  config :tags_on_failure, :validate => :array, :default => ["_real_ip_lookup_failure"]
+
+  public
+  def register
+    if @remote_address_field.length < 1
+      raise LogStash::ConfigurationError, I18n.t(
+        "logstash.agent.configuration.invalid_plugin_register",
+        :plugin => "filter",
+        :type => "real_ip",
+        :error => "The configuration option 'remote_address_field' must be a non-zero length string"
+      )
+    end
+
+    if @x_forwarded_for_field.length < 1
+      raise LogStash::ConfigurationError, I18n.t(
+        "logstash.agent.configuration.invalid_plugin_register",
+        :plugin => "filter",
+        :type => "real_ip",
+        :error => "The configuration option 'x_forwarded_for_field' must be a non-zero length string"
+      )
+    end
+
+    @trusted_networks.map! {|e| IPAddr.new(e)}
+  end # def register
+
+  private
+  def match(address)
+    # Try every combination of address and network, first match wins
+    @trusted_networks.each do |n|
+      @logger.debug("Checking IP inclusion", :address => address, :network => n)
+      if n.include?(address)
+        true
+        return
+      end
+    end
+    false
+  end # def match
+
+  public
+  def filter(event)
+    remote_addr = event.get(@remote_address_field)
+    fwdfor = event.get(@x_forwarded_for_field)
+
+    # check for presence of remote_address_field
+    if remote_addr == nil
+      @logger.warn("remote_address_field missing from event", :event => event)
+      @tags_on_failure.each {|tag| event.tag(tag)}
+      return
+    end
+
+    # check for presence of x_forwarded_for_field
+    if fwdfor == nil
+      @logger.info("x_forwarded_for_field missing from event", :event => event)
+      event.set(@target_field, remote_addr)
+      filter_matched(event)
+      return
+    end
+
+
+    begin
+      ip = IPAddr.new(remote_addr)
+    rescue ArgumentError => e
+      @logger.warn("Invalid IP address in remote_addr field", :address => remote_addr, :event => event)
+      @tags_on_failure.each {|tag| event.tag(tag)}
+      return
+    end
+
+    # If remote_addr isn't trusted, we don't even have to look at the X-Forwarded-For header
+    if match(ip) == false
+      @logger.debug? and @logger.debug("remote_addr isn't trusted. evaluating to remote_addr", :address => remote_addr)
+      event.set(@target_field, remote_addr)
+      filter_matched(event)
+      return
+    end
+
+    if @x_forwarded_for_is_string
+      if not fwdfor.kind_of?(String)
+        @logger.warn("x_forwarded_for_field isn't of type string", :event => event)
+        @tags_on_failure.each {|tag| event.tag(tag)}
+        return
+      end
+
+      fwdfor = fwdfor.gsub(/[ +]/, '').split(/,/)
+    else
+      # If there's only one IP in the X-Forwarded-For header, it's a string instead
+      # of an Array.
+      if not fwdfor.kind_of?(Array)
+        @logger.debug? and @logger.debug("creating array from single string value xfwdfor", :xfwdfor => fwdfor)
+        fwdfor = [fwdfor]
+      end
+    end
+
+    # In case X-Forwarded-For header is set, but empty
+    if fwdfor.length == 1 and fwdfor[0].length < 1
+      @logger.debug? and @logger.debug("xfwdfor header was present but empty, evaluate to remote_addr", :address => remote_addr)
+      event.set(@target_field, remote_addr)
+      filter_matched(event)
+      return
+    end
+
+    # check each IP in x_forwarded_for_field from last to first
+    (fwdfor.length - 1).downto(0) do |i|
+      begin
+        ip = IPAddr.new(fwdfor[i])
+      rescue ArgumentError => e
+        @logger.warn("Invalid IP address", :address => fwdfor[i], :event => event)
+        @tags_on_failure.each {|tag| event.tag(tag)}
+        return
+      end
+
+      # return on the first non-match against our trusted networks
+      if match(ip) == false
+        event.set(@target_field, fwdfor[i])
+        filter_matched(event)
+        return
+      end
+    end
+
+  end # def filter
+end # class LogStash::Filters::RealIp

data/logstash-filter-real_ip.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-real_ip'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Evaluates real client IP from X-Forwarded-For header'
+  s.description   = ''
+  s.homepage      = 'https://github.com/fholzer/logstash-filter-real_ip'
+  s.authors       = ['Ferdinand Holzer']
+  s.email         = 'ferdinand.holzer@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/real_ip_spec.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/real_ip"
+
+describe LogStash::Filters::RealIp do
+  describe "Evaluates real IP correctly" do
+    let(:config) do <<-CONFIG
+      filter {
+        real_ip {
+          remote_address_field => "remote_addr"
+          x_forwarded_for_field => "xfwdfor"
+          trusted_networks => ["10.0.0.0/8", "192.168.0.0/16"]
+        }
+      }
+    CONFIG
+    end
+
+    sample("dummy") do
+      expect(subject).to include("tags")
+      expect(subject.get('tags')).to include("_real_ip_lookup_failure")
+    end
+
+    sample("remote_addr" => "1.2.3.4") do
+      if subject.get('tags') then expect(subject.get('tags')).not_to include("_real_ip_lookup_failure") end
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4") do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('10.2.3.4')
+    end
+
+    sample("remote_addr" => "1.2.3.4", "xfwdfor" => "") do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => "1.2.3.4") do
+      expect(subject.get("tags")).to eq(nil)
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => ["1.2.3.4", "192.168.3.4"]) do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+  end
+
+  describe "Evaluates real IP correctly with flat string xfwfor" do
+    let(:config) do <<-CONFIG
+      filter {
+        real_ip {
+          remote_address_field => "remote_addr"
+          x_forwarded_for_field => "xfwdfor"
+          x_forwarded_for_is_string => true
+          trusted_networks => ["10.0.0.0/8", "192.168.0.0/16"]
+        }
+      }
+    CONFIG
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => "1.2.3.4") do
+      expect(subject.get("tags")).to eq(nil)
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => "1.2.3.4,+192.168.3.4") do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => "1.2.3.4, 192.168.3.4,+ 192.168.4.5") do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+  end
+
+  describe "Evaluates real IP correctly to non-default target field" do
+    let(:config) do <<-CONFIG
+      filter {
+        real_ip {
+          remote_address_field => "remote_addr"
+          x_forwarded_for_field => "xfwdfor"
+          target_field => "evaluated_ip"
+          trusted_networks => ["10.0.0.0/8", "192.168.0.0/16"]
+        }
+      }
+    CONFIG
+    end
+
+    sample("remote_addr" => "1.2.3.4") do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("evaluated_ip")
+      expect(subject.get('evaluated_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => "") do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("evaluated_ip")
+      expect(subject.get('evaluated_ip')).to eq('10.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => "1.2.3.4") do
+      expect(subject.get("tags")).to eq(nil)
+      expect(subject).to include("evaluated_ip")
+      expect(subject.get('evaluated_ip')).to eq('1.2.3.4')
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => ["1.2.3.4", "192.168.3.4"]) do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("evaluated_ip")
+      expect(subject.get('evaluated_ip')).to eq('1.2.3.4')
+    end
+  end
+
+  describe "works correctly with IPv6 in trusted_networks, x-fwd-for" do
+    let(:config) do <<-CONFIG
+      filter {
+        real_ip {
+          remote_address_field => "remote_addr"
+          x_forwarded_for_field => "xfwdfor"
+          trusted_networks => ["10.0.0.0/8", "2606:2800:220:1:248:1893:25c8:1946/120"]
+        }
+      }
+    CONFIG
+    end
+
+    sample("remote_addr" => "10.2.3.4", "xfwdfor" => ["1.2.3.4", "2606:2800:220:1:248:1893:25c8:1946"]) do
+      expect(subject).not_to include("tags")
+      expect(subject).to include("real_ip")
+      expect(subject.get('real_ip')).to eq('1.2.3.4')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-real_ip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ferdinand Holzer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: ferdinand.holzer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/real_ip.rb
+- logstash-filter-real_ip.gemspec
+- spec/filters/real_ip_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fholzer/logstash-filter-real_ip
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message:
+rdoc_options: []
+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.6.11
+signing_key:
+specification_version: 4
+summary: Evaluates real client IP from X-Forwarded-For header
+test_files:
+- spec/filters/real_ip_spec.rb
+- spec/spec_helper.rb