fluent-plugin-shodan 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5065dc8260c9015eebe3ab7e1095d050fdb64b3fa0d0168c414342e31f7960d
-  data.tar.gz: b26a7a5b53c56cc6469433eb5867749ec26c7298958294dcf7c6c5b2f8a335e0
+  metadata.gz: 2fe44cee9c9cd48566c10962f21e41a17e533e64922ab9310279e4e04c0cc8f8
+  data.tar.gz: 54775456dd2156f19b1f77944438302f9ec4bce33040478e4521aad3028c4d2f
 SHA512:
-  metadata.gz: 3244f0dd4e8c9d916a83220e2a534631f3c413a15b68ce985dc93a2632691a75b4147c838a2a871136a58c0e753b701304faf2cf86e6b18bd421302162836ac7
-  data.tar.gz: 14b471034818688f951fdb36d0102dccd63bd8f3a6437e6ee8e44de9d8a0d799190241250aaacd7aa631e5a4ab467f36d11ad4e59e2615cbfccfb33e92db174a
+  metadata.gz: 7a81fffe6a3a5266936f8372ca518ca8a67e36dc9d72290b0c6aea97ceb411d6d22eef7e4e67b4a45dfa1a5bf30e61db318ff0e056399fd0fde5c67884d038d2
+  data.tar.gz: c895e61fa305082e4b98c206bb9886352a8c23257a2fa58cb37326493dfa343094fd768dbb2fb492c8660977b793a50a34a683813842bcda46e8f90c101f57fa

data/README.md

@@ -1,6 +1,9 @@
 # fluent-plugin-shodan
 
-[![Unit tests](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/ruby.yml/badge.svg)](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/ruby.yml)[![Ruby Gem](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/rubygem-push.yml/badge.svg)](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/rubygem-push.yml)[![GPR](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/gpr-push.yml/badge.svg)](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/gpr-push.yml)
+[![Unit tests](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/ruby.yml/badge.svg)](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/ruby.yml)
+[![Ruby Gem](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/rubygem-push.yml/badge.svg)](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/rubygem-push.yml)
+[![GPR](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/gpr-push.yml/badge.svg)](https://github.com/srilumpa/fluent-plugin-shodan/actions/workflows/gpr-push.yml)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-shodan.svg)](https://badge.fury.io/rb/fluent-plugin-shodan)
 
 The [Shodan](https://www.shodan.io/) plugin offers [Fluentd](https://fluentd.org/) capacities to gather data from shodan and send them to whatever system you want (on the condition Fluentd has an [output plugin](https://docs.fluentd.org/output) fitting your needs).
 
@@ -8,13 +11,11 @@ The Shodan plugin can adress three ways of gathering data
 
 - by querying the [Search API](https://developer.shodan.io/api)
 - by consuming the [Stream API](https://developer.shodan.io/api/stream) (WIP)
-- or by consuming the [Alert API](https://developer.shodan.io/api/stream) (WIP)
+- or by consuming the [Alert API](https://developer.shodan.io/api/stream)
 
 The outputed "logs" follow the Shodan [Banner specification](https://datapedia.shodan.io/).
 
-A valid API key will be necessary for this plugin to work. The Shodan Search plugin will work with a _Free_ account with limited functionnalities, but the Shodans Stream and the Shodan Alert plugins will need a subscription plan to work.
-
-This plugin relies on the
+A valid API key will be necessary for this plugin to work. The Shodan Search plugin will work with a _Free_ account with limited functionnalities, but the Shodans Stream and the Shodan Alert plugins will need at least a membership to work.
 
 ## Installation
 
@@ -56,7 +57,7 @@ $ bundle
 
 When Fluentd is started with `in_shodan_search`, it will create a Shodan client and passes to it the API key. It will then query the Shodan API to get the account information to check if the API key is valid. If it is not, an error will be logged and the plugin will stop.
 
-Once the client is ready, a timer will be set to query the Shodan API a the interval set up in the configuration. One line of "log" will be generated per element contained in the `matches` array from the query result. An other query will be submitted to gather data fro mthe next page if
+Once the client is ready, a timer will be set to query the Shodan API a the interval set up in the configuration. One line of "log" will be generated per element contained in the `matches` array from the query result. An other query will be submitted to gather data from the next page if
 
 - the amount of read entries is lesser than the total available entries
 - the current read page is not greater than the `max_pages` parameter
@@ -98,7 +99,51 @@ WIP
 
 ## Shodan Alert
 
-WIP
+### Example configuration
+
+```
+<source>
+  @type shodan_search
+  interval 15m
+  alert_id GA3FRJ1HJNDPORHV
+  api_key 1234567890AZERTYUIOP
+</source>
+```
+
+### How it works
+
+When Fluentd is started with `in_shodan_alert`, it will create a Shodan client and passes to it the API key. It will then query the Shodan API to get the account information to check if the API key is valid. If it is not, an error will be logged and the plugin will stop.
+
+Once the client is ready, a timer will be set to query the Shodan Streaming API a the interval set up in the configuration. One line of log will be generated for each alert yield by the API.
+
+### Plugin helpers
+
+* [timer](https://docs.fluentd.org/v/1.0/plugin-helper-overview/api-plugin-helper-timer)
+* See also: [Input Plugin Overview](https://docs.fluentd.org/v/1.0/input#overview)
+
+### Configuration
+
+#### api_key (string) (required)
+
+The API key to connect to the Shodan API.
+
+#### interval (time) (optional)
+
+The interval time between running queries.
+
+Default value: `3600`.
+
+#### tag (string) (optional)
+
+The tag to apply to each shodan entries. If none are given, the alert name will be used to tag each associated emitted log.
+
+Default value: `nil`
+
+#### alert_id (string) (optional)
+
+The identifier of the alert to crawl. If none are given, all alerts are imported.
+
+Default value: `nil`
 
 ## Testing
 
@@ -118,6 +163,10 @@ On a system where fluentd is installed
 3. Install the built gem with `fluent-gem install fluent-plugin-shodan-<version>.gem`
 4. Follow the [debugging guide from FluentD](https://docs.fluentd.org/plugin-development#debugging-plugins)
 
+## Credits
+
+This plugin heavily relies on the [shodanz](https://github.com/picatz/shodanz) gem by [Kent 'picat' Gruber](https://picatz.github.io/) which makes it really easy to query the Shodan API.
+
 ## Copyright
 
 * Copyright(c) 2022 Marc-André Doll

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/fluent/plugin/in_shodan_alert.rb

@@ -0,0 +1,61 @@
+require 'fluent/plugin/input'
+require 'shodanz'
+
+module Fluent::Plugin
+  class ShodanAlert < Input
+    Fluent::Plugin.register_input('shodan_alert', self)
+
+    helpers :timer
+
+    desc "The API key to connect to the Shodan API."
+    config_param :api_key, :string, secret: true
+    desc "The tag to apply to each shodan entries. If not defined, the alert name will be used."
+    config_param :tag, :string, default: nil
+    desc "The Shodan alert ID to follow. If not defined, all alerts will be followed"
+    config_param :alert_id, :string, default: nil
+    desc "The interval time between running queries."
+    config_param :interval, :time, default: 300
+
+    def multi_workers_ready?
+      false
+    end
+
+    def configure(conf)
+      super
+
+      @client = Shodanz::Client.new(key: @api_key)
+      begin
+        log.info "Shodan client properly registered", client_info: @client.info
+      rescue RuntimeError => exception
+        raise Fluent::ConfigError.new "Invalid Shodan API key"
+      end
+    end
+
+    def start
+      super
+
+      timer_execute("shodan_#{self.class.name}#{@alert_id.nil? ? "_#{@alert_id}" : '' }".to_sym, @interval, repeat: true, &method(:run))
+    end
+
+    private
+
+    def run
+      log.debug "Start polling Shodan alerts", alert_id: @alert_id
+
+      if @alert_id.nil?
+        @client.streaming_api.alerts { |alert| process_alert(alert) }
+      else
+        @client.streaming_api.alert(@alert_id) { |alert| process_alert(alert) }
+      end
+    end
+
+    def process_alert(alert)
+      router.emit(
+        (@tag.nil? ? alert['shodan']['alert']['name'] : @tag),
+        Fluent::EventTime.parse(alert['timestamp']),
+        alert
+      )
+    end
+
+  end
+end

data/test/test_in_shodan_alert.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+require 'fluent/env'
+require 'fluent/test'
+require 'fluent/test/driver/input'
+require 'fluent/test/helpers'
+require "fluent/plugin/in_shodan_alert"
+
+class ShodanAlertInputTest < Test::Unit::TestCase
+  include Fluent::Test::Helpers
+
+  API_KEY = ENV['SHODAN_TEST_API_KEY']
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  sub_test_case 'Configuration' do
+    test 'is invalid without API key' do
+      assert_raise Fluent::ConfigError do
+        create_driver(%[])
+      end
+    end
+    test 'is invalid if the API key is invalid' do
+      assert_raise Fluent::ConfigError do
+        create_driver(%[
+          api_key 1234567890AZERTYUIOP
+        ])
+      end
+    end
+  end
+
+  sub_test_case 'Plugin emission' do
+  end
+
+  private
+
+  CONFIG = %[
+    api_key #{API_KEY}
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::ShodanAlert).configure(conf)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-shodan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - srilumpa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -110,7 +110,9 @@ files:
 - AUTHORS
 - README.md
 - VERSION
+- lib/fluent/plugin/in_shodan_alert.rb
 - lib/fluent/plugin/in_shodan_search.rb
+- test/test_in_shodan_alert.rb
 - test/test_in_shodan_search.rb
 homepage: https://github.com/srilumpa/fluent-plugin-shodan
 licenses:
@@ -136,4 +138,5 @@ signing_key:
 specification_version: 3
 summary: Fluentd plugin to extract data from Shodan
 test_files:
+- test/test_in_shodan_alert.rb
 - test/test_in_shodan_search.rb