logstash-filter-ip2proxy 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa9eb567d56fcb6e98d32a54a8145b0888f6e2b50d1755aa91304a1edee714ab
-  data.tar.gz: d336a63fa77ee0b5dbb5b05d708a97b9ab666e8765fc68f8ebcf94be63a85d36
+  metadata.gz: bfc6055c80454901e9029421d264d5f55121839710680c66825abb54a4313cfa
+  data.tar.gz: d52dc6d54dbb10403bd7b939eb5e27cc9e457a1a254efac24bd605da95375d7b
 SHA512:
-  metadata.gz: d92c46b2b301680c47b9b04083c23068064273a23ef67821e3c856bec1e03705c6df79f030f54031d18b55b4a5397121c7cd765dff06d0907d6b26daf5ab13ac
-  data.tar.gz: 1fc1c255a8dcb9abe9afcec1f8cde4f845441673da5abc32e84eb32ab86607d3c1252d371a7faaf1e5ab564660de19aac2ddbe4a605ee1e11787aa3191521e43
+  metadata.gz: eb5b6b3fa711ee6dfd3eb8cd0215467a6d8b599d7f5643ece09734f4ef7be69df5604a131ecd189ed3491a90dc8e6cc0d1214dc92d8f4bfa7fdaa5bac34ec767
+  data.tar.gz: 85b7dc3363c7c12b547db340dc5850fe423c03f00f224291df89e378edae868907771da44c37282ad84243f877da91d065c476b5b1374828787e9643bccefa1e

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2024 IP2Location.com
+Copyright (c) 2025 IP2Location.com
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -3,7 +3,7 @@ This is IP2Proxy filter plugin for Logstash that enables Logstash's users to rev
 
 For the methods to use IP2Proxy filter plugin with Elastic Stack (Elasticsearch, Filebeat, Logstash, and Kibana), please take a look on this [tutorial](https://blog.ip2location.com/knowledge-base/how-to-use-ip2proxy-filter-plugin-with-elastic-stack).
 
-*Note: This plugin works in Logstash 7 and Logstash 8.*
+*Note: This plugin works in Logstash 7, 8 and 9*
 
 
 ## Dependencies (IP2PROXY BIN DATA FILE)

data/lib/logstash/filters/ip2proxy.rb

@@ -1,191 +1,191 @@
-# encoding: utf-8
-require "logstash/filters/base"
-require "logstash/namespace"
-
-require "logstash-filter-ip2proxy_jars"
-
-class LogStash::Filters::IP2Proxy < LogStash::Filters::Base
-  config_name "ip2proxy"
-
-  # The path to the IP2Proxy.BIN database file which Logstash should use.
-  # If not specified, this will default to the IP2PROXY-LITE-PX1.BIN database that embedded in the plugin.
-  config :database, :validate => :path
-
-  # The field containing the IP address.
-  # If this field is an array, only the first value will be used.
-  config :source, :validate => :string, :required => true
-
-  # The field used to define iplocation as target.
-  config :target, :validate => :string, :default => 'ip2proxy'
-
-  # The field used to allow user to enable the use of cache.
-  config :use_cache, :validate => :boolean, :default => true
-
-  # The field used to allow user to enable the use of memory mapped file.
-  config :use_memory_mapped, :validate => :boolean, :default => false
-
-  # The field used to allow user to hide unsupported fields.
-  config :hide_unsupported_fields, :validate => :boolean, :default => false
-
-  # The field used to define lookup type.
-  config :lookup_type, :validate => :string, :default => 'db'
-
-  # The field used to define the apikey of IP2location.io.
-  config :api_key, :validate => :string, :default => ''
-
-  # The field used to define the size of the cache. It is not required and the default value is 10 000 
-  config :cache_size, :validate => :number, :required => false, :default => 10_000
-
-  public
-  def register
-    if @lookup_type == "ws"
-      @logger.info("Using IP2Location.io API")
-      if @api_key == ""
-        raise "An IP2Location.io API key is required. You may sign up for a free API key at https://www.ip2location.io/pricing."
-      end
-    else
-      if @database.nil?
-        @database = ::Dir.glob(::File.join(::File.expand_path("../../../vendor/", ::File.dirname(__FILE__)),"IP2PROXY-LITE-PX1.BIN")).first
-  
-        if @database.nil? || !File.exists?(@database)
-          raise "You must specify 'database => ...' in your ip2proxy filter (I looked for '#{@database}')"
-        end
-      end
-      @logger.info("Using ip2proxy database", :path => @database)
-    end
-
-    @ip2proxyfilter = org.logstash.filters.IP2ProxyFilter.new(@source, @target, @database, @use_memory_mapped, @hide_unsupported_fields, @lookup_type, @api_key)
-  end
-
-  public
-  def filter(event)
-    ip = event.get(@source)
-
-    return unless filter?(event)
-    if @lookup_type == "ws"
-      if @ip2proxyfilter.handleEvent(event)
-        filter_matched(event)
-      else
-        tag_iplookup_unsuccessful(event)
-      end
-    else
-      if @use_cache
-        if value = IP2ProxyCache.find(event, ip, @ip2proxyfilter, @cache_size).get('ip2proxy')
-          event.set('ip2proxy', value)
-          filter_matched(event)
-        else
-          tag_iplookup_unsuccessful(event)
-        end
-      else
-        if @ip2proxyfilter.handleEvent(event)
-          filter_matched(event)
-        else
-          tag_iplookup_unsuccessful(event)
-        end
-      end
-    end
-  end
-
-  def tag_iplookup_unsuccessful(event)
-    @logger.debug? && @logger.debug("IP #{event.get(@source)} was not found in the database", :event => event)
-  end
-
-end # class LogStash::Filters::IP2Proxy
-
-class IP2ProxyOrderedHash
-  ONE = 1
-
-  attr_reader :times_queried # ip -> times queried
-  attr_reader :hash
-
-  def initialize
-    @times_queried = Hash.new(0) # ip -> times queried
-    @hash = {} # number of hits -> array of ips
-  end
-
-  def add(key)
-    hash[ONE] ||= []
-    hash[ONE] << key
-    times_queried[key] = ONE
-  end
-
-  def reorder(key)
-    number_of_queries = times_queried[key]
-
-    hash[number_of_queries].delete(key)
-    hash.delete(number_of_queries) if hash[number_of_queries].empty?
-
-    hash[number_of_queries + 1] ||= []
-    hash[number_of_queries + 1] << key
-  end
-
-  def increment(key)
-    add(key) unless times_queried.has_key?(key)
-    reorder(key)
-    times_queried[key] += 1
-  end
-
-  def delete_least_used
-    first_pile_with_something.shift.tap { |key| times_queried.delete(key) }
-  end
-
-  def first_pile_with_something
-    hash[hash.keys.min]
-  end
-end
-
-class IP2ProxyCache
-  ONE_DAY_IN_SECONDS = 86_400
-
-  @cache         = {}            # ip -> event
-  @timestamps    = {}            # ip -> time of caching
-  @times_queried = IP2ProxyOrderedHash.new # ip -> times queried
-  @mutex         = Mutex.new
-
-  class << self
-    attr_reader :cache
-    attr_reader :timestamps
-    attr_reader :times_queried
-
-    def find(event, ip, filter, cache_size)
-      synchronize do
-        if cache.has_key?(ip)
-          refresh_event(event, ip, filter) if too_old?(ip)
-        else
-          if cache_full?(cache_size)
-            make_room
-          end
-          cache_event(event, ip, filter)
-        end
-        times_queried.increment(ip)
-        cache[ip]
-      end
-    end
-
-    def too_old?(ip)
-      timestamps[ip] < Time.now - ONE_DAY_IN_SECONDS
-    end
-
-    def make_room
-      key = times_queried.delete_least_used
-      cache.delete(key)
-      timestamps.delete(key)
-    end
-
-    def cache_full?(cache_size)
-      cache.size >= cache_size
-    end
-
-    def cache_event(event, ip, filter)
-      filter.handleEvent(event)
-      cache[ip] = event
-      timestamps[ip] = Time.now
-    end
-
-    def synchronize(&block)
-      @mutex.synchronize(&block)
-    end
-
-    alias_method :refresh_event, :cache_event
-  end
-end
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+require "logstash-filter-ip2proxy_jars"
+
+class LogStash::Filters::IP2Proxy < LogStash::Filters::Base
+  config_name "ip2proxy"
+
+  # The path to the IP2Proxy.BIN database file which Logstash should use.
+  # If not specified, this will default to the IP2PROXY-LITE-PX1.BIN database that embedded in the plugin.
+  config :database, :validate => :path
+
+  # The field containing the IP address.
+  # If this field is an array, only the first value will be used.
+  config :source, :validate => :string, :required => true
+
+  # The field used to define iplocation as target.
+  config :target, :validate => :string, :default => 'ip2proxy'
+
+  # The field used to allow user to enable the use of cache.
+  config :use_cache, :validate => :boolean, :default => true
+
+  # The field used to allow user to enable the use of memory mapped file.
+  config :use_memory_mapped, :validate => :boolean, :default => false
+
+  # The field used to allow user to hide unsupported fields.
+  config :hide_unsupported_fields, :validate => :boolean, :default => false
+
+  # The field used to define lookup type.
+  config :lookup_type, :validate => :string, :default => 'db'
+
+  # The field used to define the apikey of IP2location.io.
+  config :api_key, :validate => :string, :default => ''
+
+  # The field used to define the size of the cache. It is not required and the default value is 10 000 
+  config :cache_size, :validate => :number, :required => false, :default => 10_000
+
+  public
+  def register
+    if @lookup_type == "ws"
+      @logger.info("Using IP2Location.io API")
+      if @api_key == ""
+        raise "An IP2Location.io API key is required. You may sign up for a free API key at https://www.ip2location.io/pricing."
+      end
+    else
+      if @database.nil?
+        @database = ::Dir.glob(::File.join(::File.expand_path("../../../vendor/", ::File.dirname(__FILE__)),"IP2PROXY-LITE-PX1.BIN")).first
+  
+        if @database.nil? || !File.exists?(@database)
+          raise "You must specify 'database => ...' in your ip2proxy filter (I looked for '#{@database}')"
+        end
+      end
+      @logger.info("Using ip2proxy database", :path => @database)
+    end
+
+    @ip2proxyfilter = org.logstash.filters.IP2ProxyFilter.new(@source, @target, @database, @use_memory_mapped, @hide_unsupported_fields, @lookup_type, @api_key)
+  end
+
+  public
+  def filter(event)
+    ip = event.get(@source)
+
+    return unless filter?(event)
+    if @lookup_type == "ws"
+      if @ip2proxyfilter.handleEvent(event)
+        filter_matched(event)
+      else
+        tag_iplookup_unsuccessful(event)
+      end
+    else
+      if @use_cache
+        if value = IP2ProxyCache.find(event, ip, @ip2proxyfilter, @cache_size).get('ip2proxy')
+          event.set('ip2proxy', value)
+          filter_matched(event)
+        else
+          tag_iplookup_unsuccessful(event)
+        end
+      else
+        if @ip2proxyfilter.handleEvent(event)
+          filter_matched(event)
+        else
+          tag_iplookup_unsuccessful(event)
+        end
+      end
+    end
+  end
+
+  def tag_iplookup_unsuccessful(event)
+    @logger.debug? && @logger.debug("IP #{event.get(@source)} was not found in the database", :event => event)
+  end
+
+end # class LogStash::Filters::IP2Proxy
+
+class IP2ProxyOrderedHash
+  ONE = 1
+
+  attr_reader :times_queried # ip -> times queried
+  attr_reader :hash
+
+  def initialize
+    @times_queried = Hash.new(0) # ip -> times queried
+    @hash = {} # number of hits -> array of ips
+  end
+
+  def add(key)
+    hash[ONE] ||= []
+    hash[ONE] << key
+    times_queried[key] = ONE
+  end
+
+  def reorder(key)
+    number_of_queries = times_queried[key]
+
+    hash[number_of_queries].delete(key)
+    hash.delete(number_of_queries) if hash[number_of_queries].empty?
+
+    hash[number_of_queries + 1] ||= []
+    hash[number_of_queries + 1] << key
+  end
+
+  def increment(key)
+    add(key) unless times_queried.has_key?(key)
+    reorder(key)
+    times_queried[key] += 1
+  end
+
+  def delete_least_used
+    first_pile_with_something.shift.tap { |key| times_queried.delete(key) }
+  end
+
+  def first_pile_with_something
+    hash[hash.keys.min]
+  end
+end
+
+class IP2ProxyCache
+  ONE_DAY_IN_SECONDS = 86_400
+
+  @cache         = {}            # ip -> event
+  @timestamps    = {}            # ip -> time of caching
+  @times_queried = IP2ProxyOrderedHash.new # ip -> times queried
+  @mutex         = Mutex.new
+
+  class << self
+    attr_reader :cache
+    attr_reader :timestamps
+    attr_reader :times_queried
+
+    def find(event, ip, filter, cache_size)
+      synchronize do
+        if cache.has_key?(ip)
+          refresh_event(event, ip, filter) if too_old?(ip)
+        else
+          if cache_full?(cache_size)
+            make_room
+          end
+          cache_event(event, ip, filter)
+        end
+        times_queried.increment(ip)
+        cache[ip]
+      end
+    end
+
+    def too_old?(ip)
+      timestamps[ip] < Time.now - ONE_DAY_IN_SECONDS
+    end
+
+    def make_room
+      key = times_queried.delete_least_used
+      cache.delete(key)
+      timestamps.delete(key)
+    end
+
+    def cache_full?(cache_size)
+      cache.size >= cache_size
+    end
+
+    def cache_event(event, ip, filter)
+      filter.handleEvent(event)
+      cache[ip] = event
+      timestamps[ip] = Time.now
+    end
+
+    def synchronize(&block)
+      @mutex.synchronize(&block)
+    end
+
+    alias_method :refresh_event, :cache_event
+  end
+end

data/lib/logstash-filter-ip2proxy_jars.rb

@@ -1,4 +1,4 @@
-require 'jar_dependencies'
-require_jar('com.ip2proxy.ip2proxy', 'ip2proxy', '3.4.0')
-require_jar('com.google.gson', 'gson', '2.11.0')
-require_jar('org.logstash.filters', 'logstash-filter-ip2proxy', '2.4.0')
+require 'jar_dependencies'
+require_jar('com.ip2proxy.ip2proxy', 'ip2proxy', '3.5.0')
+require_jar('com.google.gson', 'gson', '2.11.0')
+require_jar('org.logstash.filters', 'logstash-filter-ip2proxy', '2.5.0')

data/logstash-filter-ip2proxy.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ip2proxy'
-  s.version         = '2.4.0'
+  s.version         = '2.5.0'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Logstash filter IP2Proxy"
   s.description     = "IP2Proxy filter plugin for Logstash enables Logstash's users to reverse search of IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges and residential proxies using IP2Proxy BIN database."

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ip2proxy
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - IP2Location
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -56,15 +55,14 @@ files:
 - spec/filters/ip2proxy_spec.rb
 - spec/spec_helper.rb
 - vendor/jar-dependencies/com/google/gson/gson/2.11.0/gson-2.11.0.jar
-- vendor/jar-dependencies/com/ip2proxy/ip2proxy/ip2proxy/3.4.0/ip2proxy-3.4.0.jar
-- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2proxy/2.4.0/logstash-filter-ip2proxy-2.4.0.jar
+- vendor/jar-dependencies/com/ip2proxy/ip2proxy/ip2proxy/3.5.0/ip2proxy-3.5.0.jar
+- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2proxy/2.5.0/logstash-filter-ip2proxy-2.5.0.jar
 homepage: https://www.ip2location.com
 licenses:
 - Apache-2.0
 metadata:
   logstash_plugin: 'true'
   logstash_group: filter
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Logstash filter IP2Proxy
 test_files: