fluent-plugin-ufw 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ce14b9ba65d679b766d8272ff2fecd874092232
+  data.tar.gz: 60da6bd04292d7195c4a4a3be9ecd56ed6244130
+SHA512:
+  metadata.gz: 3080699686fc25a7a66edb52e2b191f32de2ea006372e827a292f04c55d7196a26689fd13a2128878c8b5c32e222ce22e5fbdfcc2e786f7eff094d2363974108
+  data.tar.gz: 7512b05ca4bd9aeddd749afe94b487a82381f0bc9fd8634f1096e476aacc8ec723c6d55bf36f18a502f5b614357eecc77342c4f042909ec809b942b311940226

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+sudo: true
+before_install:
+  - gem update bundler
+
+rvm:
+#  - 1.9.3	
+#  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+
+gemfile:
+  - Gemfile
+
+install:
+  - bundle exec rake build
+  - sudo fluent-gem install --local pkg/fluent-plugin-ufw-0.0.1.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fluent-plugin-ufw.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,176 @@
+                                 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

data/README.md

@@ -0,0 +1,74 @@
+fluent-plugin-ufw
+==================
+[![Build Status](https://travis-ci.org/mamewotoko/fluent-plugin-ufw.svg?branch=master)](https://travis-ci.org/mamewotoko/fluent-plugin-ufw)
+
+A fluent plugin to parse [ufw](https://help.ubuntu.com/community/UFW) log
+
+## Installation
+either A or B
+
+### A. build gem file and install
+
+```
+bundle exec rake build
+sudo fluent-gem install --local pkg/fluent-plugin-ufw-0.0.1.gem
+```
+
+### B. copy plugin file
+
+```
+cp lib/fluent/plugin/parser_ufw.rb /etc/fluent/plugin/
+```
+
+## fluentd config
+specify `format ufw` in fluent.config like example below.
+
+```
+<source>
+ @type tail
+ read_from_head true
+ format ufw
+ 
+ path /var/log/ufw/ufw.log*
+ pos_file /var/log/ufw/ufw.pos
+ tag ufw.combined
+</source>
+```
+
+## Fields in log
+* read [Interpreting Log Entries of UFW](https://help.ubuntu.com/community/UFW#Interpreting_Log_Entries)
+
+## Test
+
+```
+bundle install
+bundle exec rake
+```
+
+## TODO
+* release gem
+
+## License
+
+```
+Copyright (c) 2017 Takashi Masuyama. All rights reserved.
+
+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.
+```
+
+## References
+* [UFW](https://help.ubuntu.com/community/UFW)
+
+----
+Takashi Masuyama < mamewotoko@gmail.com >  
+http://mamewo.ddo.jp/

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test

data/fluent-plugin-ufw.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-ufw"
+  s.version     = "0.0.2"
+  s.authors     = ["Takashi Masuyama"]
+  s.email       = ["mamewotoko@gmail.com"]
+  s.homepage    = "https://github.com/mamewotoko/fluent-plugin-ufw"
+  s.summary     = %q{Fluentd plugin to parse ufw log}
+  s.description = %q{Fluentd plugin to parse ufw log}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.license       = "Apache-2.0"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/parser_ufw.rb

@@ -0,0 +1,51 @@
+require 'fluent/parser'
+
+module Fluent
+  class TextParser
+    class UFWParser < Parser
+      # Register this parser as "time_key_value"
+      Plugin.register_parser("ufw", self)
+
+      def configure(conf)
+        super
+        @time_format = "%b %d %H:%M:%S"
+        @pattern = /(?<time>[^ ]+ +[^ ]+ [^ ]+) (?<host>[^ ]+) kernel: \[[0-9. ]*\] \[(?<action>[^\]]*)\] (?<body>.*)/
+
+        #$log.info "ufw is configured"
+        # TimeParser class is already given. It takes a single argument as the time format
+        # to parse the time string with.
+        @time_parser = TimeParser.new(@time_format)
+      end
+
+      def parse(text)
+        #$log.info "parse called: $text"
+        m = @pattern.match(text)
+        unless m
+          yield nil, nil
+          return
+        end
+        time = m['time']
+        time = @time_parser.parse(time)
+        host = m['host']
+        action = m['action']
+
+        record = {
+          "host" => host,
+          "action" => action
+        }
+
+        body = m['body']
+        body.split(' ').each do |pair|
+          key, value = pair.split('=', 2)
+          record[key] = value
+        end
+
+#        record.each { |key,value|
+#          $log.info "#{key} #{value}"
+#        }
+        time, record = convert_values(time, record)
+        yield time, record
+      end
+    end
+  end
+end

data/test/fluent/plugin/test_parser_ufw.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class UFWTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    
+    @parser = Fluent::Test::ParserTestDriver.new(Fluent::TextParser::UFWParser).configure({})
+    @expected = {
+      'host' => 'hostnm',
+      'action' => 'UFW BLOCK',
+      'IN' => 'br-9e24f5d888e0',
+      'OUT' => "",
+      'PHYSIN' => 'veth9f1178d',
+      'MAC' => '02:42:e1:a2:93:db:02:42:ac:13:00:02:08:00',
+      'SRC' => '172.19.0.2',
+      'DST' => '172.19.0.1',
+      'LEN' => '40',
+      'TOS' => '0x00',
+      'PREC' => '0x00',
+      'TTL' => '64',
+      'ID' => '38516',
+      'DF' => nil,
+      'PROTO' => 'TCP',
+      'SPT' => '7777',
+      'DPT' => '49338',
+      'WINDOW' => '0',
+      'RES' => '0x00',
+      'RST' => nil,
+      'URGP' => '0'
+    }
+  end
+
+  def test_parse
+    @parser.instance.parse('Aug  1 19:03:54 hostnm kernel: [341682.476244] [UFW BLOCK] IN=br-9e24f5d888e0 OUT= PHYSIN=veth9f1178d MAC=02:42:e1:a2:93:db:02:42:ac:13:00:02:08:00 SRC=172.19.0.2 DST=172.19.0.1 LEN=40 TOS=0x00 PREC=0x00 TTL=64 ID=38516 DF PROTO=TCP SPT=7777 DPT=49338 WINDOW=0 RES=0x00 RST URGP=0 ') { |time, record|
+      expected_time = Fluent::EventTime.from_time(Time.strptime('1/Aug 19:03:54', '%d/%b %H:%M:%S'))
+      assert_equal(expected_time, time)
+      assert_equal(@expected, record)
+    }
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'fluent/plugin/parser_ufw'
+
+require 'test/unit'
+require 'fluent/test'
+require 'fluent/test/helpers'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-ufw
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Takashi Masuyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin to parse ufw log
+email:
+- mamewotoko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-ufw.gemspec
+- lib/fluent/plugin/parser_ufw.rb
+- test/fluent/plugin/test_parser_ufw.rb
+- test/test_helper.rb
+homepage: https://github.com/mamewotoko/fluent-plugin-ufw
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to parse ufw log
+test_files: []