logstash-filter-panfinder 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '026826e70335a20a7b26beb8dd24d5cb140c2e13a65379de1b985de00ab8c6af'
+  data.tar.gz: 43d4e16dd316d64ca905e5382c2b1bc0c461b6b35e9fa8b4e53b6548294d7795
+SHA512:
+  metadata.gz: 2f1722a9066f6f5141f21d330d7619d37783c621ac158cf6ef2ab35d866e57b6d0c1048b551c029980ab2e522f327a4fce54a2be6ac534a23f0424aa23a1ad44
+  data.tar.gz: c9b3f56d54657a895bd7265660c4bb702266a2642cb399e2f391a6d827c5d265a6ca1a3fca30627e068628db9727e169c1df8f1113e56b01657cf3b5af0c4d45

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+ - first version providing regex match, luhn check and sanatizing messages

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:
+* Daniel Niecke
+
+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/DEVELOPER.md

@@ -0,0 +1,91 @@
+# logstash-filter-panfinder
+Panfinder filter plugin.
+
+## Docker Dev Environment
+
+This plugin is developed within a docker container but you could also install jruby directly on your machine or within another VM.
+To run a docker container use the following command (maybe change the path to this repo):
+
+```sh
+docker build -t ruby_dev -f Dockerfile.dev . 
+docker run -it --name panfinder --rm -v $HOME/git/logstash-filter-panfinder:/logstash-filter-panfinder ruby_dev bash
+```
+
+Within the container execute the follwing command to set everything up:
+
+```sh
+cd /logstash-filter-panfinder && bundle install
+```
+
+## Testing
+
+To execute all tests execute the following command:
+
+```sh
+bundle exec rspec
+```
+
+### Test in Logstash
+
+Run a logstash container with 
+
+```sh
+docker run -it -v $HOME/git/logstash-filter-panfinder:/logstash-filter-panfinder --rm --name logstash7 logstash:7.10.2 bash
+```
+
+And add a filter under /usr/share/logstash/pipeline/logstash.conf
+
+```
+input {
+  file {
+    path => "/tmp/logs"
+    start_position => "beginning"
+  }
+}
+
+filter {
+  panfinder { }
+}
+
+output {
+  file {
+   path => "/tmp/out"
+ }
+}
+```
+
+Install the Plugin
+
+```sh
+bin/logstash-plugin install /logstash-filter-panfinder/logstash-filter-panfinder-0.0.1.gem
+```
+
+Run Logstash
+
+```sh
+ bin/logstash
+```
+
+## Build
+
+```sh
+gem build logstash-filter-panfinder.gemspec
+```
+
+## Publish
+
+Add rubygems to container
+
+```sh
+echo "---
+:rubygems_api_key: rubygems_xxxx
+:status: :ok" > /root/.gem/credentials
+chmod 0600 ~/.gem/credentials
+```
+
+```sh
+bundle install
+bundle exec rake vendor
+bundle exec rspec
+bundle exec rake publish_gem
+```

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2020 Elastic and contributors
+
+   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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-example.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-example)
+
+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 build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting config examples, you can use the asciidoc `[source,json]` 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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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/panfinder.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::Panfinder < LogStash::Filters::Base
+
+  # Setting the config_name here is required. This is how you
+  # configure this filter from your Logstash config.
+  #
+  # filter {
+  #   panfinder {
+  #     source => "message"
+  #     luhn => true
+  #     sanitize => false
+  #   }
+  # }
+  #
+  config_name "panfinder"
+
+  config :source, :validate => :string, :default => 'message'
+  config :luhn, :validate => :boolean, :default => true
+  config :sanitize, :validate => :boolean, :default => false
+
+  public
+  def register
+  end # def register
+
+  public
+  def filter(event)
+
+    # this array will contain all numbers that satisfy the regex
+    pans_maybe = []
+    # this array will contain all pans which will be added to event
+    pans_valid = []
+
+    msg = event.get(@source)
+
+    unless msg
+      return
+    end
+
+    # match all elements from 14-19 numbers 
+    # https://baymard.com/checkout-usability/credit-card-patterns
+    # https://regex101.com/r/nDQwVZ/1
+    # following patterns match 
+    # 4-4-4-4
+    # 4-4-4-4-3
+    # 4-4-5
+    # 4-5-6
+    # 4-6-4
+    # 4-6-5
+    # and everythin with 13-19 digits without any special characters
+    pans_maybe = msg.scan(/(\D|^)((\d{13,19})|(\d{4}\D{0,1}((\d{4}\D{0,1}\d{4}\D{0,1}\d{4}(\D{0,1}\d{3}|))|(\d{4}\D{0,1}\d{5})|(\d{5}\D{0,1}\d{6})|\d{6}\D{0,1}(\d{5}|\d{4}))))(\D|$)/)
+
+    unless pans_maybe.empty?
+      pans_maybe.each do |pan_number_match|
+        pan_number = pan_number_match[1]
+        # if luhn is enabled check the pan_number otherwise always add the pan_number
+        if (not @luhn) || luhn_valid?(pan_number)
+          pans_valid.append(pan_number)
+          if @sanitize 
+            msg = msg.gsub(pan_number, "###! sanitizeD PAN !###")
+          end
+        end
+      end
+      # if any pans where valid add them to the event
+      unless pans_valid.empty?
+        event.set("pans", pans_valid)
+        if @sanitize
+        event.set(@source, msg)
+        end
+      end
+    end
+
+    @logger.debug? && @logger.debug("PANs found: #{event.get("pans")}")
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+
+  private
+  # https://stackoverflow.com/questions/9188360/implementing-the-luhn-algorithm-in-ruby
+  def luhn_valid?(cc_number)
+    number = cc_number.
+      gsub(/\D/, ''). # remove non-digits
+      reverse  # read from right to left
+  
+    sum, i = 0, 0
+  
+    number.each_char do |ch|
+      n = ch.to_i
+  
+      # Step 1
+      n *= 2 if i.odd?
+  
+      # Step 2
+      n = 1 + (n - 10) if n >= 10
+  
+      sum += n
+      i   += 1
+    end
+  
+    # Step 3
+    (sum % 10).zero?
+  end
+
+end # class LogStash::Filters::Panfinder

data/logstash-filter-panfinder.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-panfinder'
+  s.version         = '0.0.2'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This panfinder filter looks for PANs in your log files and can also remove them from the logs."
+  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"
+  s.authors = ["Daniel Niecke"]
+  s.email = 'daniel@niecke-it.de'
+  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  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/panfinder_spec.rb

@@ -0,0 +1,175 @@
+# encoding: utf-8
+require 'spec_helper'
+require "logstash/filters/panfinder"
+
+describe LogStash::Filters::Panfinder do
+  describe "Panfinder tests" do
+    let(:config) do <<-CONFIG
+      filter {
+        panfinder {
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "some text") do
+      expect(subject.get("pans")).to be_nil
+    end
+
+    pans = {
+      # Visa
+      "text 4111111111111111 some more text"    => "4111111111111111",
+      "text 4111141011111111116 some more text" => "4111141011111111116",
+
+      # Mastercard
+      "text 5500000000000004 some more text" => "5500000000000004",
+      "text 2720990000000015 some more text" => "2720990000000015",
+      
+      # Maestro
+      "text 67012345678901236 some more text" => "67012345678901236",
+
+      # AMEX
+      "text 340000000000009 some more text" => "340000000000009",
+      "text 370000000000002 some more text" => "370000000000002",
+
+      # JCB
+      "text 3528000000000007 some more text" => "3528000000000007",
+
+      # Diners/Discover
+      "text 30000000000004 some more text" => "30000000000004",
+      "text 6011111111111117 some more text" => "6011111111111117",
+    }
+
+    pans.each do |input, output|
+      sample("message" => input) do
+        expect(subject.get("pans")).to eq([output])
+      end
+    end
+
+    # test data which are not luhn compatible
+    pans_no_lun = [
+      "text 4111111112111111 some more text",
+      "text 4111141011111211116 some more text",
+      "text 5500000010000004 some more text",
+      "text 2720990001000015 some more text",
+      "text 67012345679901236 some more text",
+      "text 340000010000009 some more text",
+      "text 370000010000002 some more text",
+      "text 3528000100000007 some more text",
+      "text 30000001000004 some more text",
+      "text 6011111211111117 some more text",
+    ]
+    pans_no_lun.each do |input|
+      sample("message" => input) do
+        expect(subject.get("pans")).to be_nil
+      end
+    end
+
+    # formated pans
+    pans_formated = {
+      # Visa
+      "text 4111 1111 1111 1111 some more text"    => "4111 1111 1111 1111",
+      "text 4111.1111.1111.1111 some more text"    => "4111.1111.1111.1111",
+
+      # Mastercard
+      "text 5500 0000 0000 0004 some more text" => "5500 0000 0000 0004",
+      "text 2720#9900#0000#0015 some more text" => "2720#9900#0000#0015",
+      
+      # AMEX
+      "text 3400 000000 00009 some more text" => "3400 000000 00009",
+      "text 3700-000000-00002 some more text" => "3700-000000-00002",
+
+      # JCB
+      "text 3528 0000 0000 0007 some more text" => "3528 0000 0000 0007",
+
+      # Diners/Discover
+      "text 3000 000000 0004 some more text" => "3000 000000 0004",
+      "text 6011 1111 1111 1117 some more text" => "6011 1111 1111 1117",
+    }
+    pans_formated.each do |input, output|
+      sample("message" => input) do
+        expect(subject.get("pans")).to eq([output])
+      end
+    end
+
+    # multiple pan
+    pans_formated = {
+      "text 4111 1111 1111 1111 some more text 2720#9900#0000#0015 and not luhn 67012345679901236"    => ["4111 1111 1111 1111", "2720#9900#0000#0015"],
+    }
+    pans_formated.each do |input, output|
+      sample("message" => input) do
+        expect(subject.get("pans")).to eq(output)
+      end
+    end
+
+  end
+
+  describe "Panfinder tests without luhn check" do
+    let(:config) do <<-CONFIG
+      filter {
+        panfinder {
+          luhn => false
+        }
+      }
+    CONFIG
+    end
+
+    # multiple pan
+    pans_formated = {
+      "text 4111 1111 1111 1111 some more text 2720#9900#0000#0015 and not luhn 67012345679901236"    => ["4111 1111 1111 1111", "2720#9900#0000#0015", "67012345679901236"],
+    }
+    pans_formated.each do |input, output|
+      sample("message" => input) do
+        expect(subject.get("pans")).to eq(output)
+      end
+    end
+  end
+
+  describe "Panfinder with sanitize" do
+    let(:config) do <<-CONFIG
+      filter {
+        panfinder {
+          luhn => true
+          sanitize => true
+        }
+      }
+    CONFIG
+    end
+  
+    # multiple pan
+    pans_formated = {
+      "text 4111 1111 1111 1111 some more text 2720#9900#0000#0015 and not luhn 67012345679901236"    => "text ###! sanitizeD PAN !### some more text ###! sanitizeD PAN !### and not luhn 67012345679901236",
+    }
+    pans_formated.each do |input, output|
+      sample("message" => input) do
+        expect(subject.get("message")).to eq(output)
+      end
+    end
+  end
+
+  describe "Panfinder with sanitize" do
+    let(:config) do <<-CONFIG
+      filter {
+        panfinder {
+          luhn => false
+          sanitize => true
+        }
+      }
+    CONFIG
+    end
+  
+    # multiple pan
+    pans_formated = {
+      "text 4111 1111 1111 1111 some more text 2720#9900#0000#0015 and not luhn 67012345679901236"    => "text ###! sanitizeD PAN !### some more text ###! sanitizeD PAN !### and not luhn ###! sanitizeD PAN !###",
+    }
+    pans_formated.each do |input, output|
+      sample("message" => input) do
+        expect(subject.get("message")).to eq(output)
+      end
+    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,88 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-panfinder
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Daniel Niecke
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-10 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: 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: daniel@niecke-it.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/panfinder.rb
+- logstash-filter-panfinder.gemspec
+- spec/filters/panfinder_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: This panfinder filter looks for PANs in your log files and can also remove
+  them from the logs.
+test_files:
+- spec/filters/panfinder_spec.rb
+- spec/spec_helper.rb