logstash-codec-idmef 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad1c943dcf4ab893042f3a2f1422dfa0a65ab106f70ea36f5b64c7588d5200bf
+  data.tar.gz: eb60b7f7dbe4171f683a474f20ed3f11d0c694d63d5a195c03330c31ccae6810
+SHA512:
+  metadata.gz: f4f99f78a379d0feb60e3b05af8397eeb1fe7c840ac678c69a63edb7259cda2dce303825e33f75e5811506f39644a4db18986764fdb1b918db9302a9efc27f50
+  data.tar.gz: 005b837b9f15b6e09bb321884e63f018ab2270dd1a94d4c2498f4c06bff3a870b6b54f261b4cda22946e68d42bec2e605f4b10ce04ad3269b3312511ca9fba78

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.9.0
+ - Initial release

data/CONTRIBUTORS

@@ -0,0 +1,13 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Maintainers:
+* Prelude Team
+
+Contributors:
+* Prelude Team
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,3 @@
+# logstash-codec-idmef
+IDMEF codec plugin.
+RFC: https://tools.ietf.org/html/rfc4765

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.TXT

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

data/README.md

@@ -0,0 +1,102 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-codec-idmef.svg)](https://travis-ci.org/logstash-plugins/logstash-codec-idmef)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/docs/index.asciidoc

@@ -0,0 +1,138 @@
+:plugin: idmef
+:type: codec
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}s-{plugin}"]
+
+=== IDMEF codec plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Implementation of a Logstash codec for IDMEF based on RFC4765.
+https://tools.ietf.org/html/rfc4765
+
+[id="plugins-{type}s-{plugin}-options"]
+==== IDMEF Codec Configuration Options
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-paths>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-defaults>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-additionaldata>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-type>> |<<string,string>>|No
+|=======================================================================
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-paths"]
+===== `paths` 
+
+  * Value type is <<hash,hash>>
+  * The defautl value is an empty `hash`.
+
+This parameter let you add IDMEF paths to map from logstash event to IDMEF
+field.
+
+For example, if:
+* the name of your alert is in `event.get('message')`
+* the target host is in `event.get('host')`
+* the name of your analyzer is "ACME"
+
+you probably want to put this:
+
+    output {
+      tcp {
+        codec => idmef {
+          paths => {
+            "alert.classification.text" => "$message"
+            "alert.target(0).node.name" => "$host"
+            "alert.analyzer(0).name" => "ACME"
+          }
+        }
+        # ...
+      }
+    }
+
+The keys of the hash are IDMEF path as described here:
+https://redmine.secef.net/projects/secef/wiki/LibPrelude_IDMEF_path 
+
+The values of the hash are values to set in final IDMEF. If a value starts with
+a `$`, then the plugin try to retrieve the value from the event.
+
+[id="plugins-{type}s-{plugin}-defaults"]
+===== `defaults`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Try to use default paths mapping or not.
+
+Default paths are:
+* alert.classification.text: ["$rule_name", "$event", "$message"]
+* alert.detect_time: "$@timestamp"
+* alert.create_time: "$@timestamp"
+* alert.analyzer_time: "$@timestamp"
+* alert.analyzer(0).name: ["$product", "$devname"]
+* alert.analyzer(0).manufacturer: "$vendor"
+* alert.source(0).node.address(0).address: ["$srcip", "$src"]
+* alert.source(0).node.name: ["$shost", "$srchost", "$shostname", "$srchostname", "$sname", "$srcname"]
+* alert.source(0).service.port: ["$spt", "$sport", "$s_port"]
+* alert.source(0).service.name: ["$sservice", "$srcservice"]
+* alert.target(0).node.address(0).address: ["$hostip", "$dstip", "$dst", "$ip"]
+* alert.target(0).node.name: ["$host", "$hostname", "$shost", "$srchost", "$shostname", "$srchostname", "$sname", "$srcname"]
+* alert.target(0).service.port: ["$dpt", "$dport", "$d_port"]
+* alert.target(0).service.name: ["$service", "$service_id", "$dservice", "$dstservice",]
+* alert.target(0).user.user_id(0).name: ["$user", "$dstuser", "$duser"]
+* alert.target(0).user.user_id(0).number: ["$uid", "$dstuid", "$duid"]
+* alert.target(0).process.name: ["$proc", "$process"]
+* alert.target(0).process.pid: ["$dpid", "$pid"]
+* alert.assessment.impact.severity: ["$severity", "$level"]
+* alert.assessment.action.description: ["$action"]
+
+[id="plugins-{type}s-{plugin}-additionaldata"]
+===== `additionaldata` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+When an alert is transformed in IDMEF, the remaining fields of the initial
+event are translated into IDMEF's Additional Data. If you don't want to do this
+translation, set this setting to `false`.
+
+[id="plugins-{type}s-{plugin}-type"]
+===== `type` 
+
+  * Value type is <<string,string>>
+  * Default value is `"alert"`
+
+IDMEF can defined two types of message:
+* alert
+
+   RFC definition: Generally, every time an analyzer detects an event that it has
+   been configured to look for, it sends an Alert message to its manager(s).
+   Depending on the analyzer, an Alert message may correspond to a single detected
+   event or multiple detected events. Alerts occur asynchronously in response to
+   outside events.
+
+* heartbeat
+
+   RFC definition: Analyzers use Heartbeat messages to indicate their current
+   status to managers.  Heartbeats are intended to be sent in a regular period,
+   say, every ten minutes or every hour. The receipt of a Heartbeat message from
+   an analyzer indicates to the manager that the analyzer is up and running; lack
+   of a Heartbeat message (or more likely, lack of some number of consecutive
+   Heartbeat messages) indicates that the analyzer or its network connection has
+   failed.

data/lib/logstash/codecs/idmef.rb

@@ -0,0 +1,489 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+
+require 'nokogiri'
+require 'json'
+require 'date'
+
+# Implementation of a Logstash codec for IDMEF based on RFC4765.
+# https://tools.ietf.org/html/rfc4765
+class LogStash::Codecs::IDMEF < LogStash::Codecs::Base
+  config_name "idmef"
+
+  # This parameter let you add IDMEF paths to map from logstash event to IDMEF
+  # field.
+  # 
+  # For example, if:
+  # * the name of your alert is in `event.get('message')`
+  # * the target host is in `event.get('host')`
+  # * the name of your analyzer is "ACME"
+  # 
+  # you probably want to put this:
+  # 
+  #     output {
+  #       tcp {
+  #         codec => idmef {
+  #           paths => {
+  #             "alert.classification.text" => "$message"
+  #             "alert.target(0).node.name" => "$host"
+  #             "alert.analyzer(0).name" => "ACME"
+  #           }
+  #         }
+  #         # ...
+  #       }
+  #     }
+  # 
+  # The keys of the hash are IDMEF path as described here:
+  # https://redmine.secef.net/projects/secef/wiki/LibPrelude_IDMEF_path 
+  # 
+  # The values of the hash are values to set in final IDMEF. If a value starts with
+  # a `$`, then the plugin try to retrieve the value from the event.
+  config :paths, :validate => :array, :default => {}
+
+  # Try to use default paths mapping or not.
+  # 
+  # Default paths are:
+  # * alert.classification.text: ["$rule_name", "$event", "$message"]
+  # * alert.detect_time: "$@timestamp"
+  # * alert.create_time: "$@timestamp"
+  # * alert.analyzer_time: "$@timestamp"
+  # * alert.analyzer(0).name: ["$product", "$devname"]
+  # * alert.analyzer(0).manufacturer: "$vendor"
+  # * alert.source(0).node.address(0).address: ["$srcip", "$src"]
+  # * alert.source(0).node.name: ["$shost", "$srchost", "$shostname", "$srchostname", "$sname", "$srcname"]
+  # * alert.source(0).service.port: ["$spt", "$sport", "$s_port"]
+  # * alert.source(0).service.name: ["$sservice", "$srcservice"]
+  # * alert.target(0).node.address(0).address: ["$hostip", "$dstip", "$dst", "$ip"]
+  # * alert.target(0).node.name: ["$host", "$hostname", "$shost", "$srchost", "$shostname", "$srchostname", "$sname", "$srcname"]
+  # * alert.target(0).service.port: ["$dpt", "$dport", "$d_port"]
+  # * alert.target(0).service.name: ["$service", "$service_id", "$dservice", "$dstservice",]
+  # * alert.target(0).user.user_id(0).name: ["$user", "$dstuser", "$duser"]
+  # * alert.target(0).user.user_id(0).number: ["$uid", "$dstuid", "$duid"]
+  # * alert.target(0).process.name: ["$proc", "$process"]
+  # * alert.target(0).process.pid: ["$dpid", "$pid"]
+  # * alert.assessment.impact.severity: ["$severity", "$level"]
+  # * alert.assessment.action.description: ["$action"]
+  config :defaults, :validate => :boolean, :default => true
+
+  # When an alert is transformed in IDMEF, the remaining fields of the initial
+  # event are translated into IDMEF's Additional Data. If you don't want to do this
+  # translation, set this setting to `false`.
+  config :additionaldata, :validate => :boolean, :default => true
+
+  # IDMEF can defined two types of message:
+  # * alert
+  # 
+  #    RFC definition: Generally, every time an analyzer detects an event that it has
+  #    been configured to look for, it sends an Alert message to its manager(s).
+  #    Depending on the analyzer, an Alert message may correspond to a single detected
+  #    event or multiple detected events. Alerts occur asynchronously in response to
+  #    outside events.
+  # 
+  # * heartbeat
+  # 
+  #    RFC definition: Analyzers use Heartbeat messages to indicate their current
+  #    status to managers.  Heartbeats are intended to be sent in a regular period,
+  #    say, every ten minutes or every hour. The receipt of a Heartbeat message from
+  #    an analyzer indicates to the manager that the analyzer is up and running; lack
+  #    of a Heartbeat message (or more likely, lack of some number of consecutive
+  #    Heartbeat messages) indicates that the analyzer or its network connection has
+  #    failed.
+  config :type, :validate => :string, :default => "alert"
+
+  # RFC 4765: UserID Class
+  IDMEFUserId = { :type => :class,
+                  :name => "UserId",
+                  "name" => { :type => :list_value, :name => "name" },
+                  "type" => { :type => :attr, :name => "type", :default => "original-user" },
+                  "tty" => { :type => :attr, :name => "tty" },
+                  "number" => { :type => :list_value, :name => "number" }
+                }
+  
+  # RFC 4765: User Class
+  IDMEFUser = { :type => :class,
+                :name => "User",
+                "category" => { :type => :attr, :name => "category", :default => "unknown" },
+                "user_id" => { :type => :list_class, :class => IDMEFUserId }
+              }
+  
+  # RFC 4765: FileAccess Class
+  IDMEFFileAccess = { :type => :class,
+                      :name => "FileAccess",
+                      "user_id" => { :type => :list_class, :class => IDMEFUserId }
+                    }
+  
+  # RFC 4765: File Class
+  IDMEFFile = { :type => :class,
+                :name => "File",
+                "category" => { :type => :attr, :name => "category" },
+                "fstype" => { :type => :attr, :name => "fstype" },
+                "file-type" => { :type => :attr, :name => "file-type" },
+                "name" => { :type => :list_value, :name => "name" },
+                "path" => { :type => :list_value, :name => "path" },
+                "file_access" => { :type => :list_class, :class => IDMEFFileAccess }
+              }
+  
+  # RFC 4765: WebService Class
+  IDMEFWebService = { :type => :class,
+                      :name => "WebService",
+                      "url" => { :type => :list_value, :name => "url" }
+                    }
+  
+  # RFC 4765: SNMPService Class
+  IDMEFSNMPService = { :type => :class,
+                       :name => "SNMPService",
+                       "command" => { :type => :list_value, :name => "command" }
+                     }
+  
+  # RFC 4765: Service Class
+  IDMEFService = { :type => :class,
+                   :name => "Service",
+                   "ip_version" => { :type => :attr, :name => "ip_version" },
+                   "iana_protocol_number" => { :type => :attr, :name => "iana_protocol_number" },
+                   "iana_protocol_name" => { :type => :attr, :name => "iana_protocol_name" },
+                   "name" => { :type => :list_value, :name => "name" },
+                   "port" => { :type => :list_value, :name => "port" },
+                   "portlist" => { :type => :list_value, :name => "portlist" },
+                   "protocol" => { :type => :list_value, :name => "protocol" },
+                   "web_service" => { :type => :list_class, :class => IDMEFWebService },
+                   "snmp_service" => { :type => :list_class, :class => IDMEFSNMPService }
+                 }
+  
+  # RFC 4765: Address Class
+  IDMEFAddress = { :type => :class,
+                   :name => "Address",
+                   "category" => { :type => :attr, :name => "category", :default => "unknown" },
+                   "vlan-name" => { :type => :attr, :name => "vlan-name" },
+                   "vlan-num" => { :type => :attr, :name => "vlan-num" },
+                   "address" => { :type => :list_value, :name => "address" },
+                   "netmask" => { :type => :list_value, :name => "netmask" },
+                 }
+  
+  # RFC 4765: Node Class
+  IDMEFNode = { :type => :class,
+                :name => "Node",
+                "category" => { :type => :attr, :name => "category", :default => "unknown" },
+                "location" => { :type => :list_value, :name => "location" },
+                "name" => { :type => :list_value, :name => "name" },
+                "address" => { :type => :list_class, :class => IDMEFAddress },
+              }
+  
+  # RFC 4765: Process Class
+  IDMEFProcess = { :type => :class,
+                   :name => "Process",
+                   "name" => { :type => :list_value, :name => "name" },
+                   "pid" => { :type => :list_value, :name => "pid" },
+                   "path" => { :type => :list_value, :name => "path" },
+                   "arg" => { :type => :list_value, :name => "arg" },
+                   "env" => { :type => :list_value, :name => "env" },
+                 }
+  
+  # RFC 4765: Analyzer Class
+  IDMEFAnalyzer = { :type => :class,
+                    :name => "Analyzer",
+                    "analyzerid" => { :type => :attr, :name => "analyzerid" },
+                    "name" => { :type => :attr, :name => "name" },
+                    "manufacturer" => { :type => :attr, :name => "manufacturer" },
+                    "model" => { :type => :attr, :name => "model" },
+                    "version" => { :type => :attr, :name => "version" },
+                    "class" => { :type => :attr, :name => "class" },
+                    "ostype" => { :type => :attr, :name => "ostype" },
+                    "osversion" => { :type => :attr, :name => "osversion" },
+                    "node" => { :type => :list_class, :class => IDMEFNode },
+                    "process" => { :type => :list_class, :class => IDMEFProcess },
+                  }
+  IDMEFAnalyzer["analyzer"] = { :type => :list_class, :class => IDMEFAnalyzer }
+  
+  # RFC 4765: Source Class
+  IDMEFSource = { :type => :class,
+                  :name => "Source",
+                  "spoofed" => { :type => :attr, :name => "spoofed", :default => "unknown" },
+                  "interface" => { :type => :attr, :name => "interface" },
+                  "node" => { :type => :list_class, :class => IDMEFNode },
+                  "user" => { :type => :list_class, :class => IDMEFUser },
+                  "process" => { :type => :list_class, :class => IDMEFProcess },
+                  "service" => { :type => :list_class, :class => IDMEFService },
+                }
+  
+  # RFC 4765: Target Class
+  IDMEFTarget = { :type => :class,
+                  :name => "Target",
+                  "decoy" => { :type => :attr, :name => "decoy", :default => "unknown" },
+                  "interface" => { :type => :attr, :name => "interface" },
+                  "node" => { :type => :list_class, :class => IDMEFNode },
+                  "user" => { :type => :list_class, :class => IDMEFUser },
+                  "process" => { :type => :list_class, :class => IDMEFProcess },
+                  "service" => { :type => :list_class, :class => IDMEFService },
+                  "file" => { :type => :list_class, :class => IDMEFFile }
+                }
+  
+  # RFC 4765: Impact Class
+  IDMEFImpact = { :type => :class,
+                  :name => "Impact",
+                  "severity" => { :type => :attr, :name => "severity" },
+                  "completion" => { :type => :attr, :name => "completion" },
+                  "type" => { :type => :attr, :name => "type", :default => "other" },
+                }
+  
+  # RFC 4765: Action Class
+  IDMEFAction = { :type => :class,
+                  :name => "Action",
+                  "category" => { :type => :attr, :name => "category", :default => "other" },
+                  "description" => { :type => :value },
+                }
+  
+  # RFC 4765: Confidence Class
+  IDMEFConfidence = { :type => :class,
+                      :name => "Confidence",
+                      "rating" => { :type => :attr, :name => "rating", :default => "numeric" },
+                      "confidence" => { :type => :value },
+                    }
+  
+  # RFC 4765: Reference Class
+  IDMEFReference = { :type => :class,
+                     :name => "Reference",
+                     "origin" => { :type => :attr, :name => "origin", :default => "unknown" },
+                     "meaning" => { :type => :attr, :name => "meaning" },
+                     "name" => { :type => :list_value, :name => "name" },
+                     "url" => { :type => :list_value, :name => "url" }
+                   }
+  
+  # RFC 4765: AdditionalData Class
+  IDMEFAdditionalData = { :type => :class,
+                          :name => "AdditionalData",
+                          "meaning" => { :type => :attr, :name => "meaning" },
+                          "type" => { :type => :attr, :name => "type" },
+                          "data" => { :type => :value }
+                        }
+  # RFC 4765: CorrelationAlert Class
+  IDMEFCorrelationAlert = { :type => :class,
+                            :name => "CorrelationAlert",
+                            "name" => { :type => :list_value, :name => "name" },
+                            "alertident" => { :type => :list_value, :name => "alertident" }
+                          }
+  
+  # RFC 4765: Assessment Class
+  IDMEFAssessment = { :type => :class,
+                      :name => "Assessment",
+                      "impact" => { :type => :list_class, :class => IDMEFImpact },
+                      "action" => { :type => :list_class, :class => IDMEFAction },
+                      "confidence" => { :type => :list_class, :class => IDMEFConfidence }
+                    }
+  
+  # RFC 4765: Classification Class
+  IDMEFClassification = { :type => :class,
+                          :name => "Classification",
+                          "text" => { :type => :attr, :name => "text" },
+                          "reference" => { :type => :list_class, :class => IDMEFReference }
+                        }
+  
+  # RFC 4765: Alert Class
+  IDMEFAlert = { :type => :class,
+                 :name => "Alert",
+                 "messageid" => { :type => :attr, :name => "messageid" },
+                 "create_time" => { :type => :list_value, :name => "CreateTime", :format => :datetime},
+                 "detect_time" => { :type => :list_value, :name => "DetectTime", :format => :datetime },
+                 "analyzer_time" => { :type => :list_value, :name => "AnalyzerTime", :format => :datetime },
+                 "analyzer" => { :type => :list_class, :class => IDMEFAnalyzer },
+                 "classification" => { :type => :list_class, :class => IDMEFClassification },
+                 "source" => { :type => :list_class, :class => IDMEFSource },
+                 "target" => { :type => :list_class, :class => IDMEFTarget },
+                 "assessment" => { :type => :list_class, :class => IDMEFAssessment },
+                 "additional_data" => { :type => :list_class, :class => IDMEFAdditionalData },
+                 "correlation_alert" => { :type => :list_class, :class => IDMEFCorrelationAlert },
+               }
+  
+  # RFC 4765: Message Class
+  IDMEFMessage = { :type => :class,
+                   :name => "IDMEF-Message",
+                   "alert" => { :type => :list_class, :class => IDMEFAlert },
+                 }
+  private
+  def idmefpaths_to_xml(event, paths, doc = nil)
+      if doc.nil?
+          doc = Nokogiri::XML::Document.new
+          doc.root = Nokogiri::XML::Node.new('IDMEF-Message', doc)
+          doc.root.add_namespace_definition('idmef', 'http://iana.org/idmef')
+      end
+      event_to_remove = []
+      paths.each do |path, value|
+          if !value.kind_of?(Array)
+            value = [value]
+          end
+          value.each do |v|
+            if v.to_s.start_with?("$")
+                  c = ''
+                  f = true
+                  v[1..-1].split('.').each do |ppath|
+                    if !event.get(c + '[' + ppath + ']').nil?
+                      c = c + '[' + ppath + ']'
+                    else
+                      f = false
+                    end
+                  end
+                  if !f then next end
+                  value = event.get(c)
+                  event_to_remove << c
+              else
+                  value = v
+              end
+          end
+          if value.kind_of?(Array)
+              next
+          end
+          if value.kind_of?(String)
+              @utf8_charset.convert(value)
+          end
+          curr = doc.root
+          rfc = IDMEFMessage
+          path.split('.').each do |name|
+              ret = name.match(/^(.*)\((\d+)\)/)
+              if ret
+                 name = ret[1]
+                 v = (ret ? ret[2] : 0).to_i
+              end
+  
+              ne = rfc[name][:class]
+              ne_t = rfc[name][:type]
+              path_idmef = rfc[name][:type] == :list_class ? ne[:name] : nil
+  
+              if ret && ne_t == :list_class
+                 c = curr.xpath(path_idmef)
+                 if c.empty?
+                     no = Nokogiri::XML::Node.new(ne[:name], doc)
+                     curr << no
+                 elsif c.length <= v
+                     nod = c[-1]
+                     (c.length..v).each do |t|
+                         no = Nokogiri::XML::Node.new(ne[:name], doc)
+                         nod.after(no)
+                         nod = no
+                     end
+                 elsif c.length > v
+                     no = c[v]
+                 end
+                 curr = no
+                 rfc = ne
+              elsif !ret && ne_t == :list_class
+                 no = curr.xpath(path_idmef).first || Nokogiri::XML::Node.new(ne[:name], doc)
+                 curr << no
+                 curr = no
+                 rfc = ne
+              elsif ne_t == :list_value
+                 if rfc[name][:format] == :datetime
+                   value = DateTime.parse(value.to_s).strftime("%FT%T%:z")
+                 end
+                 no = Nokogiri::XML::Node.new(rfc[name][:name], doc)
+                 no.content = value.to_s
+                 curr << no
+                 curr = no
+              elsif ne_t == :attr
+                 if rfc[name][:format] == :datetime
+                   value = DateTime.parse(value.to_s).strftime("%FT%T%:z")
+                 end
+                 curr[rfc[name][:name]] = value.to_s
+              elsif ne_t == :value
+                 if rfc[name][:format] == :datetime
+                   value = DateTime.parse(value.to_s).strftime("%FT%T%:z")
+                 end
+                 curr.content = value.to_s
+              end
+              rfc.each do |kk, vv|
+                  if vv.respond_to?(:each_pair) && vv[:default] && vv[:type] == :attr && !curr[vv[:name]]
+                      curr[vv[:name]] = vv[:default]
+                  end
+              end
+          end
+      end
+      event_to_remove.each do |v|
+        event.remove(v)
+      end
+      return doc
+  end
+
+  private
+  def xml_to_string(doc)
+      doc.root.traverse { |node| 
+        if node.type != Nokogiri::XML::Node::TEXT_NODE
+          node.name = 'idmef:' + node.name
+        end
+      }
+      return doc.serialize(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML).sub("\n", "").strip
+  end
+
+  public
+  def initialize(params={})
+    super(params)
+    @utf8_charset = LogStash::Util::Charset.new('UTF-8')
+    @utf8_charset.logger = self.logger
+
+    @local_paths = {
+      "alert.classification.text" => ["$rule_name", "$event", "$message"],
+      "alert.detect_time" => "$@timestamp",
+      "alert.create_time" => "$@timestamp",
+      "alert.analyzer_time" => "$@timestamp",
+      "alert.analyzer(0).name" => ["$product", "$devname"],
+      "alert.analyzer(0).manufacturer" => "$vendor",
+      "alert.source(0).node.address(0).address" => ["$srcip", "$src"],
+      "alert.source(0).node.name" => ["$shost", "$srchost", "$shostname", "$srchostname", "$sname", "$srcname"],
+      "alert.source(0).service.port" => ["$spt", "$sport", "$s_port"],
+      "alert.source(0).service.name" => ["$sservice", "$srcservice"],
+      "alert.target(0).node.address(0).address" => ["$hostip", "$dstip", "$dst", "$ip"],
+      "alert.target(0).node.name" => ["$host", "$hostname", "$shost", "$srchost", "$shostname", "$srchostname", "$sname", "$srcname"],
+      "alert.target(0).service.port" => ["$dpt", "$dport", "$d_port"],
+      "alert.target(0).service.name" => ["$service", "$service_id", "$dservice", "$dstservice",],
+      "alert.target(0).user.user_id(0).name" => ["$user", "$dstuser", "$duser"],
+      "alert.target(0).user.user_id(0).number" => ["$uid", "$dstuid", "$duid"],
+      "alert.target(0).process.name" => ["$proc", "$process"],
+      "alert.target(0).process.pid" => ["$dpid", "$pid"],
+      "alert.assessment.impact.severity" => ["$severity", "$level"],
+      "alert.assessment.action.description" => ["$action"],
+    }
+    if @defaults
+      @allpaths = @local_paths.merge(@paths)
+    else
+      @allpaths = @paths
+    end
+  end
+
+  public
+  def encode(event)
+    # Reload configuration
+    @allpaths = @allpaths.merge(@paths)
+
+    # Copy event
+    e = event.clone
+
+    # Set paths
+    xml = idmefpaths_to_xml(e, @allpaths)
+
+    # Set messageid
+    if !@allpaths.key?("%s.messageid" % @type)
+      xml = idmefpaths_to_xml(e, {"%s.messageid" % @type => java.util.UUID.randomUUID.to_s}, xml)
+    end
+
+    # Set Additional data
+    if @additionaldata
+      idx = xml.xpath('/IDMEF-Message/Alert/AddionnalData').length
+      e.to_hash.each do |key, value|
+        if value.kind_of?(Integer)
+          t = "integer"
+        elsif value.kind_of?(Float)
+          t = "real"
+        else
+          t = "string"
+        end
+        p = { "alert.additional_data(%d).meaning" % idx => key,
+              "alert.additional_data(%d).data" % idx => value.to_s,
+              "alert.additional_data(%d).type" % idx => t,
+            }
+        xml = idmefpaths_to_xml(e, p , xml)
+        idx = idx + 1
+      end
+    end
+
+    # Create the XML
+    @on_event.call(event, xml_to_string(xml) + NL)
+  end
+
+end

data/logstash-codec-idmef.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-idmef'
+  s.version         = '0.9.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Create IDMEF in XML"
+  s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["Prelude Team"]
+  s.email           = 'support.prelude@c-s.fr'
+  s.homepage        = "https://www.prelude-siem.com"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "VERSION", "docs/**/*"]
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency 'nokogiri'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'insist'
+end

data/spec/codecs/idmef_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/codecs/idmef"
+require "logstash/util/charset"
+require 'insist'
+
+describe LogStash::Codecs::IDMEF do
+
+  context "encode IDMEF" do
+    subject(:codec) { LogStash::Codecs::IDMEF.new }
+
+    let(:expected_result)   { %Q(<?xml version="1.0"?><idmef:IDMEF-Message xmlns:idmef="http://iana.org/idmef"><idmef:Alert messageid="67a63ad4-11b9-4ee2-8aee-d1c032a13b35"><idmef:Classification text="Login attempt"/><idmef:DetectTime>2020-05-24T09:05:26+00:00</idmef:DetectTime><idmef:CreateTime>2020-05-24T09:05:26+00:00</idmef:CreateTime><idmef:AnalyzerTime>2020-05-24T09:05:26+00:00</idmef:AnalyzerTime><idmef:Target decoy="unknown"><idmef:Node category="unknown"><idmef:name category="unknown">localhost.localdomain</idmef:name></idmef:Node></idmef:Target><idmef:AdditionalData meaning="@version" type="string">1</idmef:AdditionalData></idmef:Alert></idmef:IDMEF-Message>\n) }
+    let(:results) { []}
+                      
+    it "should return proper IDMEF XML from event" do
+      codec.on_event{|data, newdata| results << newdata}
+      codec.paths = {"alert.messageid" => "67a63ad4-11b9-4ee2-8aee-d1c032a13b35" }
+      event = LogStash::Event.new("@timestamp" => DateTime.parse("2020-05-24T09:05:26.758Z").to_time, "host" => "localhost.localdomain", "message" => "Login attempt", "@version" => "1")
+      codec.encode(event)
+      insist {results.first} == expected_result
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-idmef
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Prelude Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: nokogiri
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: insist
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: support.prelude@c-s.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- docs/index.asciidoc
+- lib/logstash/codecs/idmef.rb
+- logstash-codec-idmef.gemspec
+- spec/codecs/idmef_spec.rb
+homepage: https://www.prelude-siem.com
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: codec
+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.7.10
+signing_key:
+specification_version: 4
+summary: Create IDMEF in XML
+test_files:
+- spec/codecs/idmef_spec.rb