fluent-plugin-filter-geoip2 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ac882bd000f48b5d8a4ec195553746e4c98017402222bdd685c64cbf8554ecc
+  data.tar.gz: c82f952ba08b6a1892c100bb5daf097354eb065b44c7a8bc693f3a7a420ab627
+SHA512:
+  metadata.gz: b6723cf6facb64af533f39e878b9b91bcc4b6aeeea6d892b33fd0657ec5a7b344e79d20774f53e18790a1ce7bc57386078ea32e7287adeac5014e99f6b1379df
+  data.tar.gz: 36424fe02a0484646bfd42d07e8807c41d2f989f694f6eb4e4d9291837606a3b5e750407a912f990b2f05aa231ac23a4be54b868a1ddb2db7fd7c516764372b6

data/.gitignore

@@ -0,0 +1,43 @@
+*.gem
+*.rbc
+*.mmdb
+/test*.rb
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+Gemfile.lock
+geoip
+
+# RubyMine
+.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-out_solr.gemspec
+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 2017 Tokyo Home Security Operation Center
+
+   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,327 @@
+# Fluent::Plugin::GeoIP2Filter
+
+This is a [Fluentd](http://fluentd.org/) filter plugin for adding [GeoIP data](http://dev.maxmind.com/geoip/geoip2/geolite2/) to record. Supports the new Maxmind v2 database formats.
+
+## Installation
+
+Install it yourself as:
+
+```
+$ gem install fluent-plugin-filter-geoip2
+```
+
+## How to build
+
+```
+$ gem install bundler
+$ bundle install
+$ rake test
+$ rake build
+$ rake install
+```
+
+## Config parameters
+
+### enable_auto_download
+
+If true, enable to download GeoIP2 database autometically (default: true).
+
+```
+enable_auto_download true
+```
+
+### md5_url
+
+GeoIP2 MD5 checksum URL (default: http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz.md5)
+
+```
+md5_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz.md5
+```
+
+### download_url
+
+GeoIP2 database download URL (default: http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz).
+
+```
+download_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz
+```
+
+### md5_path
+
+GeoIP2 MD5 checksum path. (default: ./geoip/database/GeoLite2-City.md5)
+
+```
+md5_path ./geoip/database/GeoLite2-City.md5
+```
+
+### database_path
+
+GeoIP2 database path. (default: ./geoip/database/GeoLite2-City.md5)
+
+```
+database_path ./geoip/database/GeoLite2-City.mmdb
+```
+
+### md5_asn_url
+
+GeoIP2 MD5 checksum URL (default: http://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz.md5)
+
+```
+md5_asn_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz.md5
+```
+
+### download_asn_url
+
+GeoIP2 database download URL (default: http://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz).
+
+```
+download_asn_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz
+```
+
+### md5_asn_path
+
+GeoIP2 MD5 checksum path. (default: ./geoip/database/GeoLite2-ASN.md5)
+
+```
+md5_asn_path ./geoip/database/GeoLite2-ASN.md5
+```
+
+### database_asn_path
+
+GeoIP2 database path. (default: ./geoip/database/GeoLite2-ASN.mmdb)
+
+```
+database_asn_path ./geoip/database/GeoLite2-ASN.mmdb
+```
+
+### lookup_field
+
+Specify the field name that IP address is stored (default: ip).
+
+```
+lookup_field host
+```
+
+### output_field
+
+Specify the field name that store the result (default: geoip).
+
+```
+output_field geoip
+```
+
+### field_delimiter
+
+Specify the field delimiter (default .).
+
+```
+field_delimiter .
+```
+
+### flatten
+
+If true, to flatten the result using field_delimiter (default: false).
+
+```
+flatten false
+```
+
+### locale
+
+Get the data for the specified locale (default: en).
+
+```
+locale en
+```
+
+### continent
+
+If true, to get continent information (default: true).
+
+```
+continent true
+```
+
+### country
+
+If true, to get country information (default: true).
+
+```
+country true
+```
+
+### city
+
+If true, to get city information (default: true).
+
+```
+city true
+```
+
+### location
+
+If true, to get location information (default: true).
+
+```
+location true
+```
+
+### postal
+
+If true, to get postal information (default: fasle).
+
+```
+postal false
+```
+
+### registered_country
+
+If true, to get registered country information (default: false).
+
+```
+registered_country false
+```
+
+### represented_country
+
+If true, to get represented country information (default: false).
+
+```
+represented_country false
+```
+
+### subdivisions
+
+If true, to get subdivisions information (default: false).
+
+```
+subdivisions false
+```
+
+### traits
+
+If true, to get traits information (default: false).
+
+```
+traits false
+```
+
+### connection_type
+
+If true, to get connection type information (default: false).
+
+```
+connection_type false
+```
+
+### Autonomous System
+
+Autonomous System (default: true).
+
+```
+autonomous_system true
+```
+
+
+## Plugin setup examples
+
+```
+<filter tail.log>
+  @type geoip2
+
+  enable_auto_download true
+
+  lookup_field clientip
+  output_field geoip
+  field_delimiter .
+  flatten false
+
+  locale en
+</filter>
+```
+
+Assuming following inputs are coming:
+
+```javascript
+{
+  "clientip": "200.114.49.218"
+}
+```
+
+then output bocomes as belows:
+
+```javascript
+{
+  "ufw_ips": "106.154.25.44",
+  "geoip": {
+    "continent": {
+      "code": "AS",
+      "geoname_id": 6255147,
+      "name": "Asia"
+    },
+    "country": {
+      "geoname_id": 1861060,
+      "iso_code": "JP",
+      "name": "Japan"
+    },
+    "location": {
+      "latitude": 35.69,
+      "longitude": 139.69,
+      "time_zone": "Asia/Tokyo"
+    },
+    "autonomous_system": {
+      "number": 2516,
+      "organization": "KDDI CORPORATION"
+    }
+  }
+}
+```
+
+
+## Example command
+
+Start fluentd using example fluent.conf.
+
+```
+$ fluentd -c ~/github/fluent-plugin-filter-geoip/fluent.conf
+2017-03-13 15:11:31 +0900 [info]: reading config file path="/Users/mosuka/github/fluent-plugin-filter-geoip/fluent.conf"
+2017-03-13 15:11:31 +0900 [info]: starting fluentd-0.12.33
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-filter-geoip' version '0.0.1'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-grok-parser' version '1.0.0'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-output-solr' version '0.4.0'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-ua-parser' version '1.1.0'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluentd' version '0.12.33'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluentd' version '0.12.32'
+2017-03-13 15:11:31 +0900 [info]: adding filter pattern="messages" type="geoip"
+2017-03-13 15:11:31 +0900 [info]: Current MD5: cc1f9a6f7def282bc33cb477f3379d9f
+2017-03-13 15:11:31 +0900 [info]: Fetched MD5: cc1f9a6f7def282bc33cb477f3379d9f
+2017-03-13 15:11:32 +0900 [info]: adding match pattern="messages" type="stdout"
+2017-03-13 15:11:32 +0900 [info]: adding source type="forward"
+2017-03-13 15:11:32 +0900 [info]: using configuration file: <ROOT>
+  <source>
+    @type forward
+    port 24224
+  </source>
+  <filter messages>
+    @type geoip
+    enable_auto_download true
+    lookup_field clientip
+    output_field geoip
+    field_delimiter .
+    flatten false
+    locale en
+  </filter>
+  <match messages>
+    type stdout
+  </match>
+</ROOT>
+2017-03-13 15:11:32 +0900 [info]: listening fluent socket on 0.0.0.0:24224
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tokyohomesoc/fluent-plugin-filter-geoip2.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-filter-geoip2.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-filter-geoip2"
+  spec.version       = "0.1.4"
+  spec.authors       = ["imcotop SOC"]
+  spec.email         = ["imcotop@icloud.com"]
+
+  spec.summary       = "Fluent filter plugin for adding GeoIP data to record."
+  spec.description   = "Fluent filter plugin for adding GeoIP data to record. Supports the new Maxmind v2 database formats."
+  spec.homepage      = "https://github.com/OlehPalanskyi/fluent-plugin-filter-geoip2"
+
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'fluentd', '~> 0.12.32'
+  spec.add_runtime_dependency 'maxminddb', '~> 0.1.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.14.6'
+  spec.add_development_dependency 'rake', '~> 11.1.2'
+  spec.add_development_dependency 'test-unit', '~> 3.1.5'
+  spec.add_development_dependency 'minitest', '~> 5.8.3'
+end

data/fluent.conf

@@ -0,0 +1,36 @@
+<source>
+  @type forward
+  port 24224
+</source>
+
+<filter messages>
+  @type geoip2
+
+  enable_auto_download true
+  md5_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.md5
+  download_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+  md5_path ./geoip/database/GeoLite2-City.md5
+  database_path ./geoip/database/GeoLite2-City.mmdb
+
+  lookup_field clientip
+  output_field geoip
+  field_delimiter .
+  flatten false
+
+  locale en
+
+  continent true
+  country true
+  city true
+  location true
+  postal true
+  registered_country true
+  represented_country true
+  subdivisions true
+  traits true
+  connection_type true
+</filter>
+
+<match messages>
+  type stdout
+</match>

data/lib/fluent/plugin/filter_geoip2.rb

@@ -0,0 +1,520 @@
+require 'maxminddb'
+require 'json'
+require 'fileutils'
+require 'open-uri'
+require 'zlib'
+require 'fileutils'
+
+module Fluent
+  class GeoIP2Filter < Filter
+    Fluent::Plugin.register_filter('geoip2', self)
+
+    DEFAULT_ENABLE_DOWNLOAD = true
+
+    DEFAULT_MD5_CITY_URL = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz.md5'
+    DEFAULT_DOWNLOAD_CITY_URL = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz'
+    DEFAULT_MD5_CITY_PATH = './geoip/database/GeoLite2-City.md5'
+    DEFAULT_DATABASE_CITY_PATH = './geoip/database/GeoLite2-City.mmdb'
+
+    DEFAULT_MD5_ASN_URL = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz.md5'
+    DEFAULT_DOWNLOAD_ASN_URL = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-ASN.tar.gz'
+    DEFAULT_MD5_ASN_PATH = './geoip/database/GeoLite2-ASN.md5'
+    DEFAULT_DATABASE_ASN_PATH = './geoip/database/GeoLite2-ASN.mmdb'
+
+    DEFAULT_LOOKUP_FIELD = 'ip'
+    DEFAULT_OUTPU_FIELD = 'geoip'
+    DEFAULT_FIELD_DELIMITER = '.'
+    DEFAULT_FLATTEN = false
+
+    DEFAULT_LOCALE = 'en'
+
+    DEFAULT_CITY = true
+    DEFAULT_CONTINENT = true
+    DEFAULT_COUNTRY = true
+    DEFAULT_LOCATION = true
+    DEFAULT_POSTAL = false
+    DEFAULT_REGISTERED_COUNTRY = false
+    DEFAULT_REPRESENTED_COUNTRY = false
+    DEFAULT_SUBDIVISIONS = false
+    DEFAULT_TRAITS = false
+    DEFAULT_CONNECTION_TYPE = false
+    DEFAULT_AUTONOMOUS_SYSTEM = true
+
+    config_param :enable_auto_download, :bool, :default => DEFAULT_ENABLE_DOWNLOAD,
+                 :desc => 'If true, enable to download GeoIP2 database autometically (default: %s).' % DEFAULT_ENABLE_DOWNLOAD
+
+    config_param :md5_city_url, :string, :default => DEFAULT_MD5_CITY_URL,
+                 :desc => 'GeoIP2 MD5 checksum URL (default: %s)' % DEFAULT_MD5_CITY_URL
+
+    config_param :download_city_url, :string, :default => DEFAULT_DOWNLOAD_CITY_URL,
+                 :desc => 'GeoIP2 database download URL (default: %s).' % DEFAULT_DOWNLOAD_CITY_URL
+
+    config_param :md5_city_path, :string, :default => DEFAULT_MD5_CITY_PATH,
+                 :desc => 'GeoIP2 MD5 checksum path. (default: %s)' % DEFAULT_MD5_CITY_PATH
+
+    config_param :database_city_path, :string, :default => DEFAULT_DATABASE_CITY_PATH,
+                 :desc => 'GeoIP2 database path. (default: %s)' % DEFAULT_DATABASE_CITY_PATH
+
+    config_param :md5_asn_url, :string, :default => DEFAULT_MD5_ASN_URL,
+                 :desc => 'GeoIP2 MD5 checksum URL (default: %s)' % DEFAULT_MD5_ASN_URL
+
+    config_param :download_asn_url, :string, :default => DEFAULT_DOWNLOAD_ASN_URL,
+                 :desc => 'GeoIP2 database download URL (default: %s).' % DEFAULT_DOWNLOAD_ASN_URL
+
+    config_param :md5_asn_path, :string, :default => DEFAULT_MD5_ASN_PATH,
+                 :desc => 'GeoIP2 MD5 checksum path. (default: %s)' % DEFAULT_MD5_ASN_PATH
+
+    config_param :database_asn_path, :string, :default => DEFAULT_DATABASE_ASN_PATH,
+                 :desc => 'GeoIP2 database path. (default: %s)' % DEFAULT_DATABASE_ASN_PATH
+
+    config_param :lookup_field, :string, :default => DEFAULT_LOOKUP_FIELD,
+                 :desc => 'Specify the field name that IP address is stored (default: %s).' % DEFAULT_LOOKUP_FIELD
+
+    config_param :output_field, :string, :default => DEFAULT_OUTPU_FIELD,
+                 :desc => 'Specify the field name that store the result (default: %s).' % DEFAULT_OUTPU_FIELD
+
+    config_param :field_delimiter, :string, :default => DEFAULT_FIELD_DELIMITER,
+                 :desc => 'Specify the field delimiter (default %s).' % DEFAULT_FIELD_DELIMITER
+
+    config_param :flatten, :bool, :default => DEFAULT_FLATTEN,
+                 :desc => 'If true, to flatten the result using field_delimiter (default: %s).' % DEFAULT_FLATTEN
+
+    config_param :locale, :string, :default => DEFAULT_LOCALE,
+                 :desc => 'Get the data for the specified locale (default: %s).' % DEFAULT_LOCALE
+
+    config_param :continent, :bool, :default => DEFAULT_CONTINENT,
+                 :desc => 'If true, to get continent information (default: %s).' % DEFAULT_CONTINENT
+
+    config_param :country, :bool, :default => DEFAULT_COUNTRY,
+                 :desc => 'If true, to get country information (default: %s).' % DEFAULT_COUNTRY
+
+    config_param :city, :bool, :default => DEFAULT_CITY,
+                 :desc => 'If true, to get city information (default: %s).' % DEFAULT_CITY
+
+    config_param :location, :bool, :default => DEFAULT_LOCATION,
+                 :desc => 'If true, to get location information (default: %s).' % DEFAULT_LOCATION
+
+    config_param :postal, :bool, :default => DEFAULT_POSTAL,
+                 :desc => 'If true, to get postal information (default: %s).' % DEFAULT_POSTAL
+
+    config_param :registered_country, :bool, :default => DEFAULT_REGISTERED_COUNTRY,
+                 :desc => 'If true, to get registered country information (default: %s).' % DEFAULT_REGISTERED_COUNTRY
+
+    config_param :represented_country, :bool, :default => DEFAULT_REPRESENTED_COUNTRY,
+                 :desc => 'If true, to get represented country information (default: %s).' % DEFAULT_REPRESENTED_COUNTRY
+
+    config_param :subdivisions, :bool, :default => DEFAULT_SUBDIVISIONS,
+                 :desc => 'If true, to get subdivisions information (default: %s).' % DEFAULT_SUBDIVISIONS
+
+    config_param :traits, :bool, :default => DEFAULT_TRAITS,
+                 :desc => 'If true, to get traits information (default: %s).' % DEFAULT_TRAITS
+
+    config_param :connection_type, :bool, :default => DEFAULT_CONNECTION_TYPE,
+                 :desc => 'If true, to get connection type information (default: %s).' % DEFAULT_CONNECTION_TYPE
+
+    config_param :autonomous_system, :bool, :default => DEFAULT_AUTONOMOUS_SYSTEM,
+                 :desc => 'Autonomous System (default: %s).' % DEFAULT_AUTONOMOUS_SYSTEM
+
+
+
+
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      super
+
+      if enable_auto_download then
+        download_database @download_city_url, @md5_city_url, @database_city_path, @md5_city_path
+        download_database @download_asn_url, @md5_asn_url, @database_asn_path, @md5_asn_path
+      end
+
+      @database_city = MaxMindDB.new(@database_city_path)
+      @database_asn = MaxMindDB.new(@database_asn_path)
+    end
+
+    def filter(tag, time, record)
+      ip = record[@lookup_field]
+
+      unless ip.nil? then
+
+        geoip_city = {}
+        geoip_asn = {}
+        begin
+          geoip_city = @database_city.lookup(ip)
+          geoip_asn = @database_asn.lookup(ip)
+        rescue IPAddr::InvalidAddressError => e
+          # Do nothing if if InvalidAddressError
+          return record
+        end
+
+        if geoip_city.found? then
+
+          unless @flatten then
+            record.merge!({@output_field => {}})
+          end
+
+          if @continent then
+            continent_hash = {}
+
+            unless geoip_city.continent.code.nil? then
+              continent_hash['continent_code'] = geoip_city.continent.code
+            end
+            unless geoip_city.continent.geoname_id.nil? then
+              continent_hash['continent_geoname_id'] = geoip_city.continent.geoname_id
+            end
+            unless geoip_city.continent.iso_code.nil? then
+              continent_hash['continent_iso_code'] = geoip_city.continent.iso_code
+            end
+            unless geoip_city.continent.name(@locale).nil? then
+              continent_hash['continent_name'] = geoip_city.continent.name(@locale)
+            end
+
+            unless continent_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(continent_hash, [@output_field], @field_delimiter))
+              else
+                record[@output_field].merge!(continent_hash)
+              end
+            end
+          end
+
+          if @country then
+            country_hash = {}
+
+            unless geoip_city.country.code.nil? then
+              country_hash['country_code'] = geoip_city.country.code
+            end
+            unless geoip_city.country.geoname_id.nil? then
+              country_hash['country_geoname_id'] = geoip_city.country.geoname_id
+            end
+            unless geoip_city.country.iso_code.nil? then
+              country_hash['country'] = geoip_city.country.iso_code
+            end
+            unless geoip_city.country.name(@locale).nil? then
+              country_hash['country_name'] = geoip_city.country.name(@locale)
+            end
+
+            unless country_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(country_hash, [@output_field], @field_delimiter))
+              else
+                record[@output_field].merge!(country_hash)
+              end
+            end
+          end
+
+          if @city then
+            city_hash = {}
+
+            unless geoip_city.city.code.nil? then
+              city_hash['city_code'] = geoip_city.city.code
+            end
+            unless geoip_city.city.geoname_id.nil? then
+              city_hash['city_geoname_id'] = geoip_city.city.geoname_id
+            end
+            unless geoip_city.city.iso_code.nil? then
+              city_hash['city_iso_code'] = geoip_city.city.iso_code
+            end
+            unless geoip_city.city.name(@locale).nil? then
+              city_hash['city'] = geoip_city.city.name(@locale)
+            end
+
+            unless city_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(city_hash, [@output_field], @field_delimiter))
+              else
+                record[@output_field].merge!(city_hash)
+              end
+            end
+          end
+
+          if @location then
+            location_hash = {}
+
+            unless geoip_city.location.latitude.nil? or geoip_city.location.longitude.nil? then
+               location_hash['location'] = { "lat" => geoip_city.location.latitude, "lon" => geoip_city.location.longitude}
+            end
+            unless geoip_city.location.latitude.nil? then
+              location_hash['latitude'] = geoip_city.location.latitude
+            end
+            unless geoip_city.location.longitude.nil? then
+              location_hash['longitude'] = geoip_city.location.longitude
+            end
+            unless geoip_city.location.metro_code.nil? then
+              location_hash['metro_code'] = geoip_city.location.metro_code
+            end
+            unless geoip_city.location.time_zone.nil? then
+              location_hash['time_zone'] = geoip_city.location.time_zone
+            end
+
+            unless location_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(location_hash, [@output_field], @field_delimiter))
+              else
+                record[@output_field].merge!(location_hash)
+              end
+            end
+          end
+
+          if @postal then
+            postal_hash = {}
+
+            unless geoip_city.postal.code.nil? then
+              postal_hash['postal_code'] = geoip_city.postal.code
+            end
+
+            unless postal_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(postal_hash, [@output_field], @field_delimiter))
+              else
+                record[@output_field].merge!(postal_hash)
+              end
+            end
+          end
+
+          if @registered_country then
+            registered_country_hash = {}
+
+            unless geoip_city.registered_country.code.nil? then
+              registered_country_hash['code'] = geoip_city.registered_country.code
+            end
+            unless geoip_city.registered_country.geoname_id.nil? then
+              registered_country_hash['geoname_id'] = geoip_city.registered_country.geoname_id
+            end
+            unless geoip_city.registered_country.iso_code.nil? then
+              registered_country_hash['iso_code'] = geoip_city.registered_country.iso_code
+            end
+            unless geoip_city.registered_country.name(@locale).nil? then
+              registered_country_hash['name'] = geoip_city.registered_country.name(@locale)
+            end
+
+            unless registered_country_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(registered_country_hash, [@output_field, 'registered_country'], @field_delimiter))
+              else
+                record[@output_field].merge!({'registered_country' => registered_country_hash})
+              end
+            end
+          end
+
+          if @represented_country then
+            represented_country_hash = {}
+
+            unless geoip_city.represented_country.code.nil? then
+              represented_country_hash['code'] = geoip_city.represented_country.code
+            end
+            unless geoip_city.represented_country.geoname_id.nil? then
+              represented_country_hash['geoname_id'] = geoip_city.represented_country.geoname_id
+            end
+            unless geoip_city.represented_country.iso_code.nil? then
+              represented_country_hash['iso_code'] = geoip_city.represented_country.iso_code
+            end
+            unless geoip_city.represented_country.name(@locale).nil? then
+              represented_country_hash['name'] = geoip_city.represented_country.name(@locale)
+            end
+
+            unless represented_country_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(represented_country_hash, [@output_field, 'represented_country'], @field_delimiter))
+              else
+                record[@output_field].merge!({'represented_country' => represented_country_hash})
+              end
+            end
+          end
+
+          if @subdivisions then
+            subdivision_arry = []
+
+            i = 0
+            geoip_city.subdivisions.each do |subdivision|
+              subdivision_hash = {}
+
+              unless subdivision.code.nil? then
+                subdivision_hash['code_%d' % [i]] = subdivision.code
+              end
+              unless subdivision.geoname_id.nil? then
+                subdivision_hash['geoname_id_%d' % [i]] = subdivision.geoname_id
+              end
+              unless subdivision.iso_code.nil? then
+                subdivision_hash['iso_code_%d' % [i]] = subdivision.iso_code
+              end
+              unless subdivision.name(@locale).nil? then
+                subdivision_hash['name_%d' % [i]] = subdivision.name(@locale)
+              end
+
+              unless subdivision_hash.empty? then
+                subdivision_arry.push(subdivision_hash)
+              end
+
+              i = i + 1
+            end
+
+            unless subdivision_arry.empty? then
+              if @flatten then
+                subdivision_arry.each do |subdivision|
+                  record.merge!(to_flatten(subdivision, [@output_field, 'subdivisions'], @field_delimiter))
+                end
+              else
+                record[@output_field].merge!({'subdivisions' => subdivision_arry})
+              end
+            end
+          end
+
+          if @traits then
+            traits_hash = {}
+
+            unless geoip_city.traits.is_anonymous_proxy.nil? then
+              traits_hash['is_anonymous_proxy'] = geoip_city.traits.is_anonymous_proxy
+            end
+            unless geoip_city.traits.is_satellite_provider.nil? then
+              traits_hash['is_satellite_provider'] = geoip_city.traits.is_satellite_provider
+            end
+
+            unless traits_hash.empty? then
+              if @flatten then
+                record.merge!(to_flatten(traits_hash, [@output_field, 'traits'], @field_delimiter))
+              else
+                record[@output_field].merge!({'traits' => traits_hash})
+              end
+            end
+          end
+
+          if @connection_type then
+            unless geoip_city.connection_type.nil? then
+              if @flatten then
+                record.merge!(to_flatten(geoip_city.connection_type, [@output_field, 'connection_type'], @field_delimiter))
+              else
+                record[@output_field].merge!({'connection_type' => geoip_city.connection_type})
+              end
+            end
+          end
+
+          if geoip_asn.found? then
+            if @autonomous_system then
+              autonomous_system_hash = {}
+
+              autonomous_system_hash['number'] = geoip_asn['autonomous_system_number']
+              autonomous_system_hash['organization'] = geoip_asn['autonomous_system_organization']
+
+              unless autonomous_system_hash.empty? then
+                if @flatten then
+                  record.merge!(to_flatten(autonomous_system_hash, [@output_field, 'as'], @field_delimiter))
+                else
+                  record[@output_field].merge!({'as' => autonomous_system_hash})
+                end
+              end
+            end
+          end
+
+          log.debug "Record: %s" % record.inspect
+        else
+          log.debug "It was not possible to look up the #{ip}."
+        end
+      end
+
+      return record
+    end
+
+    def to_flatten(hash, stack=[], delimiter='/')
+      output = {}
+
+      hash.keys.each do |key|
+        stack.push key
+
+        if hash[key].instance_of?(Hash) then
+          output.merge!(to_flatten(hash[key], stack, delimiter))
+        else
+          output[stack.join(delimiter)] = hash[key]
+        end
+
+        stack.pop
+      end
+
+      return output
+    end
+
+    def download_database(download_url, md5_url, database_path, md5_path)
+      # database directory
+      database_dir = File.dirname database_path
+      md5_dir = File.dirname md5_path
+
+      # create database directory if directory does not exist.
+      FileUtils.mkdir_p(database_dir) unless File.exist?(database_dir)
+      FileUtils.mkdir_p(md5_dir) unless File.exist?(md5_dir)
+
+      # create empty md5 file if file does not exist.
+      File.open(md5_path, 'wb').close() unless File.exist?(md5_path)
+
+      # read saved md5
+      current_md5 = nil
+      begin
+        open(md5_path, 'rb') do |data|
+          current_md5 = data.read
+        end
+        log.info "Current MD5: %s" % current_md5
+      rescue => e
+        log.warn e.message
+      end
+
+      # fetch md5
+      fetched_md5 = nil
+      begin
+        open(md5_url, 'rb') do |data|
+          fetched_md5 = data.read
+        end
+        log.info "Fetched MD5: %s" % fetched_md5
+      rescue => e
+        log.warn e.message
+      end
+
+      # check md5
+      unless current_md5 == fetched_md5 then
+        # download new database
+        download_path = database_dir + '/' + File.basename(download_url)
+        begin
+          log.info "Download: %s" % download_url
+          open(download_path, 'wb') do |output|
+            open(download_url, 'rb') do |data|
+              output.write(data.read)
+            end
+          end
+          log.info "Download done: %s" % download_path
+        rescue => e
+          log.warn e.message
+        end
+
+        # unzip new database temporaly
+        tmp_database_path = database_dir + '/tmp_' + File.basename(database_path)
+        log.info "temp_database_path: %s" %  tmp_database_path
+        log.info "PWD %s" % File.expand_path(tmp_database_path)
+        begin
+          log.info "Unzip: %s" % download_path
+            Zlib::GzipReader.open(download_path) do |gz|
+            Archive::Tar::Minitar.unpack(gz, './tmp')
+          end
+          src_path = Dir.glob('./tmp/' + File.basename(download_path, ".tar.gz") + '_*/' + File.basename(download_path, ".tar.gz")  + '.mmdb')
+          FileUtils.mv(src_path, database_dir)
+          FileUtils.rm_rf('./tmp')
+          log.info "Unzip done: %s" % tmp_database_path
+        rescue => e
+          puts e.message
+        end
+
+        # check mkd5
+        temp_md5 = Digest::MD5.hexdigest(File.open(download_path, 'rb').read)
+        log.info "New MD5: %s" % temp_md5
+        if fetched_md5 == temp_md5 then
+          # record new md5
+          log.info "Save: %s" % md5_path
+          File.write(md5_path, fetched_md5)
+          log.info "Save done: %s" % md5_path
+        else
+          log.info "MD5 missmatch: Fetched MD5 (%s) != New MD5 (%s) ; " % [fetched_md5, temp_md5]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter-geoip2
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- imcotop SOC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.32
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.32
+- !ruby/object:Gem::Dependency
+  name: maxminddb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.11
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+description: Fluent filter plugin for adding GeoIP data to record. Supports the new
+  Maxmind v2 database formats.
+email:
+- imcotop@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-filter-geoip2.gemspec
+- fluent.conf
+- lib/fluent/plugin/filter_geoip2.rb
+homepage: https://github.com/OlehPalanskyi/fluent-plugin-filter-geoip2
+licenses:
+- Apache-2.0
+metadata: {}
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Fluent filter plugin for adding GeoIP data to record.
+test_files: []