fluent-plugin-netflowipfix 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c262f1d06e957012b081fc752fd4552ee5bcf57
+  data.tar.gz: 45aef55456c7de2de658eb15a948e78c6411a731
+SHA512:
+  metadata.gz: 7cabd5c57778797095023ea89c4bd480a3bcff7ee13a41ebda246295ce2caee006c4e9fcd771728d14b8ae1d4a6feb8864140480b40383a4a1cb5d7e890fd1d9
+  data.tar.gz: df8a136a483827a82103a14f8d943f8649292d96ac9044be093e4564aa693ea928832d0026603eb8a347f9dab238955b49fd202f2945e8be33d9f62ebaaf1087

data/Gemfile

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

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 [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,83 @@
+# Netflow(v5/v9) and IPfix(v10) plugin for Fluentd
+# fluent-plugin-netflowipfix
+
+[Fluentd](https://fluentd.org/) input plugin that acts as Netflow v5/v9 and IPfix (v10) collector.
+
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-netflowipfix
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-netflowipfix"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+
+    <source>
+      type netflowipfix
+      tag netflow.event
+
+      # optional parameters
+      bind 192.168.0.1
+      port 2055
+      cache_ttl 6000
+      definitions /path/to/custom_fields.yaml
+    </source>
+
+**bind**
+
+IP address on which the plugin will accept Netflow.  
+(Default: '0.0.0.0')
+
+**port**
+
+UDP port number on which tpe plugin will accept Netflow.  
+(Default: 5140)
+
+**cache_ttl**
+
+Template cache TTL for Netflow v9 or IPfix v10 in seconds. Templates not refreshed from the Netflow v9 exporter within the TTL are expired at the plugin.  
+(Default: 4000)
+
+**switched_times_from_uptime**
+
+When set to true, the plugin stores system uptime for ```first_switched``` and ```last_switched``` instead of ISO8601-formatted absolute time.  
+(Defaults: false)
+TODO: This is currently disabled
+
+**definitions**
+
+YAML file containing Netflow field definitions to overfide pre-defined templates. Example is like below
+
+    ---
+    4:          # field value
+    - :uint8    # field length
+    - :protocol # field type
+
+## Pending
+
+* Tests
+* A few TODOs in the code
+
+## Copyright
+
+* Copyright(c) 2018- Yves Desharnais
+* License
+  * Apache License, Version 2.0
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-netflowipfix.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-netflowipfix"
+  spec.version = "1.0.0"
+  spec.authors = ["Yves Desharnaus"]
+  spec.email   = ["yvesbd@gmail.com"]
+
+  spec.summary       = %q{Fluentd Netflow (v5, v9) and IpFix (v10) Input plugin.}
+  spec.description   = %q{Created to replace and add missing functionality to the fluent-plugin-netflow fluentd plugin.}
+  spec.homepage      = "https://github.com/yvesbd/fluent-plugin-netflowipfix"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+#  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+  spec.add_runtime_dependency "bindata", "~> 2.1"
+end

data/lib/fluent/plugin/in_netflowipfix.rb

@@ -0,0 +1,161 @@
+#
+# Copyright 2018 Yves Desharnais
+#
+# 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.
+
+require "fluent/plugin/input"
+require 'cool.io'
+require 'fluent/plugin/socket_util'
+# require_relative 'parser_netflowipfix'
+require_relative 'parser_netflow_v5'
+require_relative 'parser_netflow_v9'
+require_relative 'netflowipfix_records'
+require_relative 'vash'
+
+module Fluent
+	module Plugin
+		class NetflowipfixInput < Fluent::Plugin::Input
+			Fluent::Plugin.register_input("netflowipfix", self)
+
+      config_param :cache_ttl, :integer, default: 4000
+      config_param :definitions, :string, default: nil
+
+			config_param :debug, :bool, default: false
+			config_param :port, :integer, default: 5140
+			config_param :bind, :string, default: '0.0.0.0'
+			config_param :tag, :string
+			config_param :protocol_type, default: :udp do |val|
+				case val.downcase
+				when 'udp'
+					:udp
+				else
+					raise ConfigError, "netflow input protocol type should be 'udp'"
+				end
+			end # config_param :protocol_type
+
+			def configure(conf)
+				super
+				@nbpackets = 0
+				@parser_v5 = ParserNetflowv5.new
+				@parser_v9 = ParserNetflowv9.new
+				@parser_v9.configure(@cache_ttl, @definitions)
+				@parser_v10 = ParserIPfixv10.new
+				@parser_v10.configure(@cache_ttl, @definitions)
+			end # def configure
+
+			def start
+				@loop = Coolio::Loop.new
+				@handler = listen(method(:receive_data))
+				@loop.attach(@handler)
+				@thread = Thread.new(&method(:run))
+			end # def start
+
+			def shutdown
+				@loop.watchers.each { |w| w.detach }
+				@loop.stop
+				@handler.close
+				@thread.join
+			end # def shutdown
+
+			def run
+				@loop.run
+				rescue => e
+					log.error "unexpected error", error_class: e.class, error: e.message
+					log.error_backtrace
+			end # def run
+
+			protected
+
+			def receive_data(host, data)
+				# if (@debug) 
+#				log.on_debug { log.debug "received logs", :host => host, :data => data }
+				call(data, host) { |time, record|
+				unless time && record
+					log.warn "pattern not match: #{data.inspect}"
+					return
+				end
+
+#			if (@debug) log.info "ready to emit ", time:time, tag:@tag
+
+				record['host'] = host
+				router.emit(@tag, EventTime.new(time), record)
+				} # call
+				rescue => e
+				log.warn "unexpected error on parsing", data: data.dump, error_class: e.class, error: e.message
+				log.warn_backtrace
+			end # def receive_data
+
+			private
+
+			def listen(callback)
+				log.info "listening netflow socket on #{@bind}:#{@port} with #{@protocol_type}"
+				if @protocol_type == :udp
+					@usock = SocketUtil.create_udp_socket(@bind)
+					@usock.bind(@bind, @port)
+					UdpHandler.new(@usock, callback)
+				else
+					Coolio::TCPServer.new(@bind, @port, TcpHandler, log, callback)
+				end
+			end # def listen
+    
+			def call(payload, host=nil, &block)
+				version,_ = payload[0,2].unpack('n')
+				@nbpackets += 1
+				#	nb = @nbpackets
+				if (@debug) 
+					log.debug "Packet #{@nbpackets} with version #{version}"
+				end
+				case version
+					when 5          
+						packet = Netflow5Packet.read(payload)
+						@parser_v5.handle_v5(host, packet, block)
+					when 9
+						packet = Netflow9Packet.read(payload)
+						@parser_v9.handle_v9(host, packet, block)
+					when 10
+						packet = Netflow10Packet.read(payload)
+						@parser_v10.handle_v10(host, packet, block)
+					else
+						$log.warn "Unsupported Netflow version v#{version}: #{version.class}"
+				end # case
+			end # def call
+
+		end # class NetflowipfixInput
+
+		class UdpHandler < Coolio::IO
+			def initialize(io, callback)
+				super(io)
+				@io = io
+				@callback = callback
+			end # def initialize
+
+			def on_readable
+				msg, addr = @io.recvfrom_nonblock(4096)
+				@callback.call(addr[3], msg)
+				rescue => e
+					log.error "unexpected error on reading from socket", error_class: e.class, error: e.message
+				log.error_backtrace
+			end # def on_readable
+		end # class UdpHandler
+
+
+	end # module Plugin
+end # module Fluent
+
+
+
+    
+
+
+=begin
+=end