logstash-output-fir 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 636de71feea1e34b4579a613463af11d26006f4e
+  data.tar.gz: e52e5056843d45177f5620748b84a8ffdde42a53
+SHA512:
+  metadata.gz: b179f2ffe18d37e7b0d1389002810610f80166007e379cb6c9dbc788a2db4b370f7f378bf2de4aebc98d6c08fa94ff18b33591d19d5f89a0f616408350444f66
+  data.tar.gz: f65f9e809db4ebb81d0c6fda09b8a0f7832cf464453388cb5fe3429e2a072ee4b4be2d67082d018525cc20d67f8d152832170bf00d7e4f7e3f871fa2ece2cbcf

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.9.0
+ - Plugins work on logstash 5.4
+

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+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,2 @@
+# logstash-output-fir
+* Lionel PRAT - lionel.prat9@gmail.com

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+#gem "logstash", :git => "https://github.com/elastic/logstash.git", :branch => "5.4"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+
+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,191 @@
+# Logstash Plugin
+
+Logstash plugin output for send alert to FIR (Incident platform of Cert SG - https://github.com/certsocietegenerale/FIR)
+** require manticore **
+
+Work on version 5.x and older.
+
+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.
+
+## Install
+```
+env GEM_HOME=/usr/share/logstash/vendor/bundle/jruby/1.9 /usr/share/logstash/vendor/jby/bin/jruby /usr/share/logstash/vendor/jruby/bin/gem build logstash-output-fir.gemspec
+usr/share/logstash/bin/logstash-plugin install logstash-output-fir-2.0.0.gem
+```
+
+## Main Configuration (logstash-output.conf)
+** Refresh DB : The plugin use some files configurations, you can change it during run. The plugin get change and apply all refresh time. You can use config/db file with git system... ** 
+When i create alert/event in FIR, it's possible to update whith news informations (news alert in relationship, ...), the plugin can update a event FIR for avoid remake near event...
+* url_api_fir [string]: The uri for send alert to FIR API (REST)
+  * Example: "https://127.0.0.1:8000/api/"
+* refresh_interval_remote [numeric]: Delay to refresh database by donwload incidentsDB in FIR (for re-syncronisation, when new event, is add in db_incident of logstash -- utility when you close event in FIR)
+  * Example: 3600
+  * If you have much incidents in DB, you take a long time for download DB...
+* refresh_interval [numeric]: Delay to refresh configuration FIR
+  * Example: 3600
+* headers [hash]: You give token API FIR
+  * Example: {"Authorization" => "Token 0000000000000000000000000000", "Content-Type" => "application/json"}
+* ssl_options [string]: If you change SSL configuration of manticore, by example disable verify cert.
+  * Example for disable verify: "{ :verify => :disable }"
+* template_new [path]: the path of erb file for make body/description of event in FIR when new alert
+  * Example "/etc/logstash/db/template_update.erb" (template example in folder: template_erb)
+* template_update [path]: the path of erb file for make body/description of event in FIR when update alert
+  * Example "/etc/logstash/db/template_new.erb" (template example in folder: template_erb)
+* subj_template_new [path]: the path of erb file for make subject of event in FIR when new alert
+  * Example "/etc/logstash/db/template_update.erb" (template example in folder: template_erb)
+* subj_template_update [path]: the path of erb file for make subject of event in FIR when update alert
+  * Example "/etc/logstash/db/template_new.erb" (template example in folder: template_erb)
+* confile [path]: configuration file for rules of create event in FIR (filter and filter near event)
+  * Example "/etc/logstash/db/conf_fir.json" (example in folder sample_conf)
+* subject_field [string]: The name of field "subject" in event FIR when you create event
+  * Example field by default: "subject"
+* body_field [string]: The name of field "description" in event FIR when you create event 
+  * Example field by default: "description"
+* severity_field [string]: The name of field "severity" in event FIR when you create event
+  * Example field by default: "severity"
+* status_field [string]: The name of field "status" in event FIR when you create event
+  * Example field by default: "status"
+  
+### conf_fir.json
+The file contains rules which give filter and filter near event, choice template for create event in FIR
+** This file is a Json format **
+```
+{ "rules": [
+  {
+   "filters": {"sig_detected_note": "3|4"},
+    "subject_filter": "src_ip",
+    "subject_filter_prefix": "-",
+    "subject_filter_sufix": "-", 
+    "body_filter": "fingerprint",
+    "body_filter_prefix": "",
+    "body_filter_sufix": " -> SCORE",
+    "count_filter": " Count: ",
+    "severity_add": "sig_detected_note", 
+    "fields_create": {"actor": 6, "category": 26,"confidentiality": 0,"detection": 36, "plan": 37,"is_starred": false,"is_major": false,"is_incident": false,"concerned_business_lines": []},
+    "template_new_sujet": "", 
+    "template_new_body": "", 
+    "template_up_sujet": "",
+    "template_up_body": "",
+  }
+] }
+```
+Json contains key "rules" which contains all rule in hash format.
+Each element of rule:
+* filters [hash]: filter rule by field value, you can use multi field filter => {"field1": "regexp", "field2": "regexp"}
+  * field_name [string]: name of field in event where you search regexp value
+  * value_search [regexp]: regexp value to search in event field selected
+* subject_filter [string]: When you match filter then you search if event is near. For apply, you search value of field event in subject of all incident FIR DB. If you find then event DB know server or client then you verify if same event for this client. Else you don't find value field event in incident DB, you create new event in FIR. The search use "subject == '*value_field_event*' "
+* subject_filter_prefix [string]: For avoid error when match subject_filter you can add prefix and change search by "subject == '*prefix+value_field_event*' "
+* subject_filter_sufix [string]: For avoid error when match subject_filter you can add sufix and change search by "subject == '*value_field_event+sufix*' "
+* body_filter [string]: When subject matched, then verify if description event contains same event. I use fingerprint field (Plugin logstash-filter-sig) for it. If it find then stop, is ok, else, update event FIR with new event for client/server subject. The search use "body == '*value_field_event*' " (body is field description in FIR)
+* body_filter_prefix [string]: For avoid error when match body_filter you can add prefix and change search by "body == '*prefix+value_field_event*' "
+* body_filter_sufix [string]: For avoid error when match body_filter you can add sufix and change search by "body == '*value_field_event+sufix*' "
+* count_filter [string]: For incriment count of number same alert receveive.
+* severity_add [string]: The name of field used for copy value in severity field of FIR event. If empty then set severity to 1
+* fields_create [hash]: contains information must need for create event in FIR
+  * actor [numeric]: 1
+  * category [numeric]: 2
+  * confidentiality [numeric]: 1
+  * detection [numeric]: 3
+  * plan [numeric]: 4
+  * is_starred [boolean]: false
+  * is_major [boolean]: false
+  * is_incident [boolean]: false
+  * concerned_business_lines [array]: []
+* template_new_sujet [path]: The path of file erb template for new subject
+* template_new_body [path]: The path of file erb template for new description/body
+* template_up_sujet [path]: The path of file erb template for update subject
+* template_up_body [path]: The path of file erb template for update description/body
+
+## 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. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- 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 the community 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/lib/logstash/outputs/fir.rb

@@ -0,0 +1,490 @@
+# encoding: utf-8
+# Output "FIR" send alert to FIR platform (CERT SG)
+# can be use with logstash-filter-sig
+# Contact: Lionel PRAT (lionel.prat9@gmail.com)
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "json"
+require "uri"
+require "manticore"
+require "time"
+require "erb"
+
+# An example output that does nothing.
+class LogStash::Outputs::Fir < LogStash::Outputs::Base
+  config_name "fir"
+  
+  # URL to use
+  config :url_api_fir, :validate => :string, :required => :true, :default => "https://127.0.0.1:8000/api/"
+  #refresh remote information FIR - get closed information & new ticket manual & artefacts db
+  config :refresh_interval_remote, :validate => :number, :default => 3600
+
+  # Custom headers to use
+  # format is `headers => ["X-My-Header", "%{host}"]`
+  #REPLACE 0000000000000000000000000000 by your token
+  config :headers, :validate => :hash, :required => :true, :default => {"Authorization" => "Token 0000000000000000000000000000", "Content-Type" => "application/json"}
+  #use insecure mode change by '{ verify: :disable }'
+  config :ssl_options, :validate => :string, :default => "{ :verify => :disable }"
+  
+  #template body & subject ERB
+  #template for new alert
+  config :template_new, :validate => :path, :default => "/etc/logstash/db/template_new.erb"
+  #template for update alert
+  config :template_update, :validate => :path, :default => "/etc/logstash/db/template_update.erb"
+  #template subject for new alert
+  config :subj_template_new, :validate => :path, :default => "/etc/logstash/db/subject_template_new.erb"
+  #template subject for update alert
+  config :subj_template_update, :validate => :path, :default => "/etc/logstash/db/subject_template_update.erb"
+  #MATCH CONFIGURATION:
+  config :conffile, :validate => :string, :default => "/etc/logstash/db/conf_fir.json"
+  #need: filter + first identification in sujet + second identification for alert exist in body + optionnal change template
+  #Configuration -- format HASH
+  #rules [
+  # {
+  #   filters: {},
+  #   subject_filter: 'name_field_in_event', # by example field src_ip
+  #   subject_filter_prefix: 'string must match.. before content of field subject filter' #optionnal
+  #   subject_filter_sufix: 'string must match.. after content of field subject filter' #optionnal
+  #   body_filter: 'name_field_in_event',   # by example field fingerprint
+  #   body_filter_prefix: 'string must match.. before content of field body filter' #optionnal
+  #   body_filter_sufix: 'string must match.. after content of field body filter' #optionnal
+  #   severity_add: 'name_field_in_event', # by example field sig_detected_note !!optionnal!!
+  #   count_filter: ' Count: '
+  #   fields_create: {'name' => value, '' => value} # !!!REQUIRE FOR CREATE: "actor" = 6 & "category" & "confidentiality" & "detection" & "plan" & "is_starred" & "is_major" & "is_incident" & "concerned_business_lines"
+  #   template_new_sujet: 'path', #optionnal
+  #   template_new_body: 'path', #optionnal
+  #   template_up_sujet: 'path', #optionnal
+  #   template_up_body: 'path', #optionnal
+  # }
+  #]
+  
+  # this setting will indicate how frequently
+  # (in seconds) logstash will check the db file for updates.
+  config :refresh_interval, :validate => :number, :default => 3600
+  
+  #choice in FIR for subject and body and severity -- API REST 
+  config :subject_field, :validate => :string, :default => "subject"
+  config :body_field, :validate => :string, :default => "description"
+  config :severity_field, :validate => :string, :default => "severity"
+  config :status_field, :validate => :string, :default => "status"
+  
+  concurrency :single
+  
+  public
+  def register
+    @fir_conf = []
+    @incidents_db = {}
+    @client = Manticore::Client.new(ssl: eval(@ssl_options))
+    @logger.info("FIR Configuration -- Loading...")
+    @hash_file = ""
+    @load_statut = false
+    load_db
+    @load_statut = true
+    @logger.info("finish")
+    #file load template
+    @logger.info("FIR templates -- Loading...")
+    @template_data_n = ""
+    @template_data_u = ""
+    @template_subj_n = ""
+    @template_subj_u = ""
+    if File.file?(@template_new) && File.file?(@template_update) && File.file?(@subj_template_new) && File.file?(@subj_template_update)
+      @template_data_n = File.read(@template_new)
+      @template_data_u = File.read(@template_update)
+      @template_subj_n = File.read(@subj_template_new)
+      @template_subj_u = File.read(@subj_template_update)
+    else
+      @logger.error("FIR templates not found!")
+      exit -1
+    end
+    if @template_subj_u.empty? or @template_subj_n.empty? or @template_data_u.empty? or @template_data_n.empty?
+      @logger.error("FIR templates is empty!!")
+      exit -1
+    end
+    @logger.info("finish")
+    @next_refresh = Time.now + @refresh_interval
+    @load_statut_r = false
+    @logger.info("FIR get incident DB -- Loading...could take a sometime...")
+    load_incidents
+    @logger.info("finish")
+    @load_statut_r = true
+    @next_refresh = Time.now + @refresh_interval
+    @next_refresh_remote = Time.now + @refresh_interval_remote
+    @token_create=true
+  end # def register
+
+  public
+  def multi_receive(events)
+    events.each {|event| receive(event)}
+  end
+
+  def receive(event)
+    tnow = Time.now
+    #refresh DB & conf
+    if @next_refresh < tnow
+      if @load_statut == true
+        @load_statut = false
+        load_db
+        if File.file?(@template_new) && File.file?(@template_update)
+          @template_data_n = File.read(@template_new)
+          @template_data_u = File.read(@template_update)
+        end
+        @next_refresh = tnow + @refresh_interval
+        @load_statut = true
+      end
+    end
+    if @next_refresh_remote < tnow
+      if @load_statut_r == true
+        @load_statut_r = false
+        @logger.info("FIR refresh incident DB -- could take a sometime...")
+        load_incidents
+        @next_refresh_remote = tnow + @refresh_interval_remote
+        @load_statut_r = true
+      end
+    end
+    sleep(1) until @load_statut_r
+    sleep(1) until @load_statut
+    #verify db & conf is OK!
+    if @fir_conf.is_a?(Array) and not @incidents_db.nil?
+      #check filter: {'field_name': [] or ""  -- if field event is numerci, the code change to string
+      #match one regexp on field event use string value "regexp" 
+      #match multi regexp (for array type) on field event use array type: [regex1,regexp2,...] for match ok all regexp must matched one time
+      # }
+      for rule in @fir_conf
+        #get key in rule: fields
+        eventK = event.to_hash.keys
+        inter = rule['filters'].keys & eventK
+        #check if fields rule present in event
+        if inter.length == rule['filters'].keys.length
+          #ok field present - check filter
+          #check field by field
+          sig_add = {}
+          check_sig=false
+          for kfield in inter
+            check_sig=false
+            # field X -- check type
+            if event.get(kfield).is_a?(Array)
+              #array type
+              # if rule value regexp is Array?
+              if rule['filters'][kfield].is_a?(Array)
+                for regexp in rule['filters'][kfield]
+                  check_sig=false
+                  for elem in event.get(kfield)
+                    match = Regexp.new(regexp, nil, 'n').match(elem.to_s)
+                    if not match.nil?
+                      check_sig=true
+                      break
+                    end
+                  end
+                  break unless check_sig
+                end
+              else
+                #rule not array
+                for elem in event.get(kfield)
+                  match = Regexp.new(rule['filters'][kfield], nil, 'n').match(elem.to_s)
+                  if not match.nil?
+                    check_sig=true
+                    break
+                  end
+                end
+              end
+            else
+              #other type
+              # if rule value regexp is Array?
+              if rule['filters'][kfield].is_a?(Array)
+                #array
+                for regexp in rule['filters'][kfield]
+                  match = Regexp.new(regexp, nil, 'n').match(event.get(kfield).to_s)
+                  if not match.nil?
+                    sig_add[kfield.to_s]="Regexp found #{match}"
+                    check_sig=true
+                    next
+                  end
+                  break unless check_sig
+                end
+              else
+                #other
+                match = Regexp.new(rule['filters'][kfield], nil, 'n').match(event.get(kfield).to_s)
+                if not match.nil?
+                  check_sig=true
+                  next
+                end
+              end
+            end
+            break unless check_sig
+          end
+          if check_sig
+            #filter matched
+            #stat of exist alert
+            check_if_create=true
+            #verify filter present subject_filter && body_filter
+            if not event.get(rule['subject_filter'].to_s).nil? and not event.get(rule['body_filter'].to_s).nil?
+              #ok
+              #not write in same time for avoid corruption db
+              #check in incident db if alert exist
+              for incident in @incidents_db["results"]
+                #verify if incident is Open or Close -- just check incident open
+                next if not incident[@status_field].to_s == "O"
+                #verify if filter subject present in incident DB
+                next if not incident[@subject_field].include?(rule['subject_filter_prefix'].to_s+event.get(rule['subject_filter'].to_s).to_s+rule['subject_filter_sufix'].to_s)
+                #verify if filter body present in incident DB
+                check_if_create=false
+                #if body match, break, is ok -> created and updated
+                if incident[@body_field].include?(rule['body_filter_prefix'].to_s+event.get(rule['body_filter'].to_s).to_s+rule['body_filter_sufix'].to_s)
+                  break if rule['count_filter'].nil? or rule['count_filter'].empty?
+                  #count ++ 
+                  #replace rule['body_filter_prefix'].to_s+event.get(rule['body_filter'].to_s).to_s+rule['body_filter_sufix'].to_s+".*COUNT:"
+                  num_al=incident[@body_field].scan(/#{Regexp.escape(rule['body_filter_prefix'].to_s+event.get(rule['body_filter'].to_s).to_s+rule['body_filter_sufix'].to_s)}.*#{Regexp.escape(rule['count_filter'].to_s)}(\d+)/).last
+                  if num_al.nil?
+                    break
+                  else
+                    if num_al.is_a?(Array) and not num_al.empty?
+                      num_al = num_al.first.to_i + 1
+                      incident[@body_field] = incident[@body_field].gsub(/(#{Regexp.escape(rule['body_filter_prefix'].to_s+event.get(rule['body_filter'].to_s).to_s+rule['body_filter_sufix'].to_s)}.*#{Regexp.escape(rule['count_filter'].to_s)})(\d+)/, '\1'+num_al.to_s)
+                    else
+                      break
+                    end
+                  end
+                  url = @url_api_fir + "incidents/" + incident["id"].to_s
+                  begin
+                    response = @client.patch(url, :body => incident.to_json, :headers => @headers)
+                    if response.code < 200 and response.code > 299
+                      log_failure(
+                        "Encountered non-200 HTTP code #{200}",
+                        :response_code => response.code,
+                        :url => url,
+                        :event => event)
+                    end
+                  rescue
+                    @logger.warn("ERROR SEND:", :string => body.to_json)
+                  end
+                  break
+                end
+                #if body no match, then update
+                #UPDATE
+                sleep(1) until @token_create
+                @token_create=false
+                #update incident
+                #change severity if option not empty
+                if rule['severity_add'] and (event.get(rule['severity_add'].to_s).is_a?(String) or event.get(rule['severity_add'].to_s).is_a?(Numeric))
+                  if incident["severity"] < event.get(rule['severity_add'].to_s).to_i
+                    incident[@severity_field] = event.get(rule['severity_add'].to_s).to_i
+                  end
+                end
+                if not rule['template_up_sujet'].nil? and not rule['template_up_sujet'].empty?
+                  incident[@subject_field] = ERB.new(rule['template_up_sujet']).result(binding)
+                else
+                  incident[@subject_field] = ERB.new(@template_subj_u).result(binding)
+                end
+                #keep old content
+                if not rule['template_up_body'].nil? and not rule['template_up_body'].empty?
+                  incident[@body_field] = ERB.new(rule['template_up_body']).result(binding) + incident[@body_field]
+                else
+                  incident[@body_field] = ERB.new(@template_data_u).result(binding) + incident[@body_field]
+                end
+                url = @url_api_fir + "incidents/" + incident["id"].to_s
+                begin
+                  response = @client.patch(url, :body => incident.to_json, :headers => @headers)
+                  if response.code < 200 and response.code > 299
+                    log_failure(
+                      "Encountered non-200 HTTP code #{200}",
+                      :response_code => response.code,
+                      :url => url,
+                      :event => event)
+                  else
+                    begin
+                      url = @url_api_fir+"files/"+incident["id"].to_s+"/upload"
+                      bodyfile={"files" => [{"content" => JSON.pretty_generate(event.to_hash),"description" => "Incident details","filename" => "incident_detail-"+tnow.strftime("%Y-%m-%dT%H:%M:%S:%L").to_s+".json"}]}
+                      response = @client.post(url, :body => bodyfile.to_json, :headers => @headers)
+                      @logger.info("Upload file content incident: ", :string => response.body)
+                    rescue
+                      @logger.warn("Upload file content incident: ERROR.", :string => response.body)
+                    end
+                  end
+                rescue
+                  @logger.warn("ERROR SEND:", :string => body.to_json)
+                end
+                #end - give token
+                @token_create=true
+                #break loop check_if_create is false, stop process => created and updated OK
+                break
+              end
+              if check_if_create and rule['fields_create'].is_a?(Hash)
+                #create
+                sleep(1) until @token_create
+                @token_create=false
+                body = {}
+                #create base JSON of fir incendent 
+                rule['fields_create'].each do |jkey,jval|
+                  body[jkey.to_s] = jval
+                end
+                body["date"] = tnow.strftime("%Y-%m-%dT%H:%M").to_s # format "2016-01-01T00:00" TODO!!! CHOICE GMT
+                if rule['severity_add'] and (event.get(rule['severity_add'].to_s).is_a?(String) or event.get(rule['severity_add'].to_s).is_a?(Numeric))
+                  if event.get(rule['severity_add'].to_s).to_i < 5
+                    body[@severity_field] = event.get(rule['severity_add'].to_s).to_i
+                  else
+                    body[@severity_field] = 1
+                  end
+                else
+                  body[@severity_field] = 1
+                end
+                body[@status_field] = "O"
+                if not rule['template_new_sujet'].nil? and not rule['template_new_sujet'].empty?
+                  body[@subject_field] = ERB.new(rule['template_new_sujet']).result(binding)
+                else
+                 body[@subject_field] = ERB.new(@template_subj_n).result(binding)
+                end
+                #keep old content
+                if not rule['template_new_body'].nil? and not rule['template_new_body'].empty?
+                  body[@body_field] = ERB.new(rule['template_new_body']).result(binding)
+                else
+                  body[@body_field] = ERB.new(@template_data_n).result(binding)
+                end
+                url = @url_api_fir+"incidents"
+                begin
+                  response = @client.post(url, :body => body.to_json, :headers => @headers)
+                  if response.code > 200 and response.code < 299
+                    #body
+                    begin
+                      add_inc = JSON.parse(response.body)
+                      (@incidents_db["results"] ||= []) << add_inc
+                      begin
+                        url = @url_api_fir+"files/"+add_inc["id"].to_s+"/upload"
+                        bodyfile={"files" => [{"content" => JSON.pretty_generate(event.to_hash),"description" => "Incident details","filename" => "incident_detail-"+tnow.strftime("%Y-%m-%dT%H:%M:%S:%L").to_s+".json"}]}
+                        response = @client.post(url, :body => bodyfile.to_json, :headers => @headers)
+                        @logger.info("Upload file content incident: ", :string => response.body)
+                      rescue
+                        @logger.warn("Upload file content incident: ERROR.", :string => response.body)
+                      end
+                    rescue
+                      @logger.warn("JSON CMD ERROR PARSE:", :string => response.body)
+                    end
+                  else
+                    log_failure(
+                      "Encountered non-200 HTTP code #{200}",
+                      :response_code => response.code,
+                      :url => url,
+                      :response => response,
+                      :body => body)
+                  end
+                rescue
+                  @logger.warn("ERROR SEND:", :string => body.to_json)
+                end
+                #end - give token
+                @token_create=true
+              else
+                break # exit of rules check & ok => stop
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  def close
+    @client.close
+  end
+  
+  private
+  def load_db
+    if !File.exists?(@conffile)
+      @logger.warn("Configuration file read failure, stop loading", :path => @conffile)
+      return
+    end
+    tmp_hash = Digest::SHA256.hexdigest File.read @conffile
+    if not tmp_hash == @hash_file
+      @hash_file = tmp_hash
+      begin
+        tmp_conf = JSON.parse( IO.read(@conffile, encoding:'utf-8') ) 
+        unless tmp_conf.nil?
+          if tmp_conf['rules'].is_a?(Array)
+            for rule in tmp_conf['rules']
+              if not rule['template_new_sujet'].nil? and not rule['template_new_sujet'].empty? and !File.exists?(rule['template_new_sujet'].to_s)
+                @logger.error("Template in configuration file not exist", :path => rule['template_new_sujet'].to_s)
+                return
+              elsif not rule['template_new_sujet'].nil? and not rule['template_new_sujet'].empty?
+                rule['template_new_sujet'] = File.read(rule['template_new_sujet'].to_s)
+              end
+              if not rule['template_new_body'].nil? and not rule['template_new_body'].empty? and !File.exists?(rule['template_new_body'].to_s)
+                @logger.error("Template in configuration file not exist", :path => rule['template_new_body'].to_s)
+                return
+              elsif not rule['template_new_body'].nil? and not rule['template_new_body'].empty?
+                rule['template_new_body'] = File.read(rule['template_new_body'].to_s)
+              end
+              if not rule['template_up_sujet'].nil? and not rule['template_up_sujet'].empty? and !File.exists?(rule['template_up_sujet'].to_s)
+                @logger.error("Template in configuration file not exist", :path => rule['template_up_sujet'].to_s)
+                return
+              elsif not rule['template_up_sujet'].nil? and not rule['template_up_sujet'].empty?
+                rule['template_up_sujet'] = File.read(rule['template_up_sujet'].to_s)
+              end
+              if not rule['template_up_body'].nil? and not rule['template_up_body'].empty? and !File.exists?(rule['template_up_body'].to_s)
+                @logger.error("Template in configuration file not exist", :path => rule['template_up_body'].to_s)
+                return
+              elsif not rule['template_up_body'].nil? and not rule['template_up_body'].empty?
+                rule['template_up_body'] = File.read(rule['template_up_body'].to_s)
+              end
+              if rule['subject_filter_prefix'].nil?
+                rule['subject_filter_prefix'] = ""
+              end
+              if rule['subject_filter_sufix'].nil?
+                rule['subject_filter_sufix'] = ""
+              end
+              if rule['body_filter_prefix'].nil?
+                rule['body_filter_prefix'] = ""
+              end
+              if rule['body_filter_sufix'].nil?
+                rule['body_filter_sufix'] = ""
+              end
+            end
+            @fir_conf = tmp_conf['rules']
+          end
+        end
+        @logger.info("refreshing DB FIR condition file")
+      rescue
+        @logger.error("JSON CONF FIR -- PARSE ERROR")
+      end
+    end
+  end
+  
+  # This is split into a separate method mostly to help testing
+  def log_failure(message, opts)
+    @logger.error("[HTTP Output Failure] #{message}", opts)
+  end
+
+  def load_incidents
+    # Send the request
+    stop_load = true
+    incidents_db_tmp = {}
+    first = true
+    error_load = false
+    url = @url_api_fir+"incidents?format=json"
+    while stop_load
+      response = @client.get(url, :headers => @headers)
+      #body
+      @logger.info("BODY: #{response.body}")
+      begin
+        field_next = ""
+        if first
+          incidents_db_tmp = JSON.parse(response.body)
+          field_next = incidents_db_tmp["next"]
+          first = false
+        else
+          tmp_db = JSON.parse(response.body)
+          incidents_db_tmp["results"] = incidents_db_tmp["results"] + tmp_db["results"]
+          field_next = tmp_db["next"]
+        end
+        if field_next != nil
+          url = field_next
+        else
+          stop_load = false
+        end
+      rescue
+        @logger.warn("JSON CMD ERROR PARSE:", :string => response.body)
+        stop_load = false
+        error_load = true
+      end
+    end
+    @incidents_db = incidents_db_tmp unless error_load
+    @logger.warn("INCIDENT DB LOADED") unless error_load
+  end
+end # class LogStash::Outputs::Example

data/logstash-output-fir.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-fir'
+  s.version         = "0.9.0"
+  s.licenses = ["Apache License (2.0)"]
+  s.summary = "This fir output send alert of sig filter to FIR (https://github.com/certsocietegenerale/FIR)."
+  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 fir. This gem is not a stand-alone program"
+  s.authors = ["Lionel PRAT"]
+  s.email = 'lionel.prat9@gmail.com'
+  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # 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" => "output" }
+
+  # Gem dependencies
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/outputs/fir_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/fir"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Fir do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Fir.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-fir
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Lionel PRAT
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-06-02 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-devutils
+  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 fir. This gem is not a stand-alone program
+email: lionel.prat9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/fir.rb
+- logstash-output-fir.gemspec
+- spec/outputs/fir_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+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.4.8
+signing_key:
+specification_version: 4
+summary: This fir output send alert of sig filter to FIR (https://github.com/certsocietegenerale/FIR).
+test_files:
+- spec/outputs/fir_spec.rb