logstash-input-akamai-siem 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0a73162f3e5baabd91f8c5872e03c4100709ed5ab866a2b01698fbeacb188cd
+  data.tar.gz: 5f0a86b79abbb9ce3dff9004888a9e99d97d29dcde97fd3b9103af66a2d985b2
+SHA512:
+  metadata.gz: 114ecb420b4ee1b9b116913abfb018ba893539d9ade654fe2a723c0bb91103959ecc92dc9a3b42dc4dbb4ba47f970cf1bba7395f380d182a7b4a2c3c0083ae32
+  data.tar.gz: 5425a3f5a36b0eb4f617377d5e7248456b7f12135dfaf92d6b0470aa9ba2f765510c38e0aa38f058c89e7aa1fe960454f89ae2dc924b337f46384696b0296c41

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 2.0.7
+  - Docs: Set the default_codec doc attribute.
+
+## 2.0.6
+ - Docs: Add documentation template
+## 2.0.4
+ - Add encoding: utf-8 line to spec file.  This can prevent issues with tests.
+## 2.0.1
+ - Simplify the shutdown implementation a bit for easier understanding
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-example
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,24 @@
+# ruby=jruby-9.4.8.0
+
+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
+gem 'rufus-scheduler', ENV['RUFUS_SCHEDULER_VERSION'] if ENV['RUFUS_SCHEDULER_VERSION']
+
+group :development, :test do
+  gem 'pry'
+  gem 'rake'
+
+  gem 'mocha'
+  %w[rspec rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
+    gem lib
+  end
+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,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-example.svg)](https://travis-ci.com/logstash-plugins/logstash-input-example)
+
+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 build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting config examples, you can use the asciidoc `[source,json]` 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/inputs/akamai_siem/base.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require "logstash/config/mixin"
+
+# This module makes it easy to add a very fully configured HTTP client to logstash
+# based on [Manticore](https://github.com/cheald/manticore).
+# For an example of its usage see https://github.com/logstash-plugins/logstash-input-http_poller
+module LogStash::Inputs::AkamaiSiem::Base
+  class InvalidHTTPConfigError < StandardError; end
+
+  def self.[](**a)
+    Adapter.new(**a)
+  end
+
+  def self.included(base)
+    # TODO: deprecate the act of including this mixin directly,
+    #       in a way that turns focus to plugin maintainers since
+    #       an end-user cannot act to resolve the issue.
+    base.include(Adapter.new(with_deprecated: true, with_akamai_siem: false))
+  end
+
+  class Adapter < Module
+    def initialize(with_deprecated: false, with_akamai_siem: false)
+      @include_dep = with_deprecated
+      @include_akamai_siem = with_akamai_siem
+    end
+
+    def included(base)
+      base.include(LogStash::PluginMixins::HttpClient::Implementation)
+      if @include_dep
+        require 'logstash/plugin_mixins/http_client/deprecated_ssl_config_support'
+        base.include(LogStash::PluginMixins::HttpClient::DeprecatedSslConfigSupport)
+      end
+      if @include_akamai_siem
+        require_relative 'edge_grid'
+        base.include(EdgeGrid)
+      end
+      nil
+    end
+  end
+  private_constant :Adapter
+end

data/lib/logstash/inputs/akamai_siem/edge_grid.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module LogStash::Inputs::AkamaiSiem::Base::EdgeGrid
+  def self.included(base)
+    fail ArgumentError unless base <= LogStash::PluginMixins::HttpClient::Implementation
+
+    require 'logstash/plugin_mixins/normalize_config_support'
+    base.include(LogStash::PluginMixins::NormalizeConfigSupport)
+
+    ###### settings for akamai edge grid ######
+    base.config :client_secret, validate: :string, require: true
+    base.config :base_url, validate: :string, require: true
+    base.config :access_token, validate: :string, require: true
+    base.config :client_token, validate: :string, require: true
+
+  end
+
+  # @return [Hash] unencoded HTTP header key/value pairs.
+  attr_reader :headers
+
+  KEY = 'Authorization'
+
+  def initialize(*a)
+    super
+    settings = a.first
+    @client_token = settings['client_token']
+    @client_secret = settings['client_secret']
+    @access_token = settings['access_token']
+    @headers = LogStash::Inputs::AkamaiSiem::Headers.new
+
+    raise LogStash::ConfigurationError, "Invalid URL #{base_url}" unless URI::DEFAULT_PARSER.regexp[:ABS_URI].match(URI(settings['base_url']))
+
+    @headers_to_sign ||= []
+    @max_body ||= 2048
+  end
+
+  # Creates a signing key based on the secret and timestamp
+  def make_signing_key(timestamp)
+    base64_hmac_sha256(timestamp, @client_secret)
+  end
+
+  # Returns the @headers_to_sign in normalized form
+  def canonicalize_headers(request)
+    @headers_to_sign.select do |header|
+      request.key?(header)
+    end.map do |header|
+      "#{header.downcase}:#{request[header].strip.gsub(/\s+/, ' ')}"
+    end.join("\t")
+  end
+
+  # Returns a hash of the HTTP POST body
+  def make_content_hash(request)
+    if (request.http_method == :post) && request.body && request.body.length.positive?
+      body = request.body
+      body = body[0..@max_body - 1] if body.length > @max_body
+
+      return base64_sha256(body)
+    end
+    ''
+  end
+
+  # Returns a string with all data that will be signed
+  def make_data_to_sign(request, auth_header)
+    url = request.url
+    [
+      request.http_method.to_s.upcase,
+      url.scheme,
+      url.host,
+      url.request_uri,
+      canonicalize_headers(request),
+      make_content_hash(request),
+      auth_header
+    ].join("\t")
+  end
+
+  # Returns a signature of the given request, timestamp and auth_header
+  def sign_request(request, timestamp, auth_header)
+    base64_hmac_sha256(
+      make_data_to_sign(request, auth_header),
+      make_signing_key(timestamp)
+    )
+  end
+
+  # returns the current time in the format understood by Edgegrid
+  def eg_timestamp
+    Time.now.utc.strftime('%Y%m%dT%H:%M:%S+0000')
+  end
+
+  # returns a new nonce (unique identifier)
+  def new_nonce
+    SecureRandom.uuid
+  end
+
+  # rubocop:disable Style/StringConcatenation
+  # Returns the computed Authorization header for the given request, timestamp and nonce
+  def make_auth_header(request, timestamp, nonce)
+    header = [
+      'client_token' => @client_token,
+      'access_token' => @access_token,
+      'timestamp' => timestamp,
+      'nonce' => nonce
+    ].map do |kvp|
+      kvp.keys.map { |k| "#{k}=#{kvp[k]}" }
+    end.join(';') + ';'
+
+    auth_header = "EG1-HMAC-SHA256 #{header}"
+
+    "#{auth_header}signature=#{sign_request(request, timestamp, auth_header)}"
+  end
+
+  # rubocop:enable Style/StringConcatenation
+
+  # rubocop:disable Naming/VariableNumber
+  def base64_hmac_sha256(data, key)
+    Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('SHA256'), key, data)).strip
+  end
+
+  def base64_sha256(data)
+    Base64.encode64(OpenSSL::Digest.new('SHA256').digest(data)).strip
+  end
+
+  # rubocop:enable Naming/VariableNumber
+end
+

data/lib/logstash/inputs/akamai_siem/exception.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class LogStash::Inputs::AkamaiSiem
+  Exception = Struct.new(:type, :title, :instance, :detail, :server_ip, :client_ip, :request_id, :request_time) do
+    extend MiddlewareRegistry
+
+    def self.create(body)
+      data = ::LogStash::Json.jruby_load(body)
+      exception = new(data['type'])
+      exception.type = data['type']
+      exception.title = data['title']
+      exception.instance = data['instance']
+      exception.detail = data['detail']
+      exception.server_ip = data['serverIp']
+      exception.client_ip = data['clientIp']
+      exception.request_id = data['requestId']
+      exception.request_time = data['requestTime']
+      exception
+    end
+
+    def to_s
+      self.detail
+    end
+
+    def backtrace
+      []
+    end
+
+    def marshal_dump
+      {
+        type: self.type,
+        title: self.title,
+        instance: self.instance,
+        detail: self.detail,
+        server_ip: self.server_ip,
+        client_ip: self.client_ip,
+        request_id: self.request_id,
+        request_time: self.request_time,
+      }
+    end
+
+    # Marshal serialization support.
+    # Restores the instance variables according to the +serialised+.
+    # @param serialised [Hash] the serialised object.
+    def marshal_load(serialised)
+      self.type = serialised[:type]
+      self.title = serialised[:title]
+      self.instance = serialised[:instance]
+      self.detail = serialised[:detail]
+      self.server_ip = serialised[:server_ip]
+      self.client_ip = serialised[:client_ip]
+      self.request_id = serialised[:request_id]
+      self.request_time = serialised[:request_time]
+    end
+  end
+end