logstash-input-centrifyidplatform 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe10692c16ca44f5994687387030b1e5d86d3d71
+  data.tar.gz: bda9546b17d99d5027eb0b3971e79445a9df074e
+SHA512:
+  metadata.gz: 8f1c60ffb65bdf23012f3f941094057417a3b2455d6bf471d9f34e157ea1474428107a3941cef4b9576d28dcc3d8daaac41cc845c659f4b5799dae108e35dc1a
+  data.tar.gz: 83cd60f040754239d739319dceaae5b960ad0b4e695f02fc37c5d2d1c3ef8428918b910559aaa6ab80d3cd794137de88c3c69b3b7aae454079f9b8c87833608b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0
+
+- Plugin created with the logstash plugin generator

data/Gemfile

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

data/INSTRUCTIONS.md

@@ -0,0 +1,70 @@
+# Instructions
+
+This document aims to provide more detail on how to implement the logstash-input-centrifyidplatform plugin.
+
+## Installation
+
+There are two methods of installing this plugin.
+
+1. The plugin is published on rubygems.org (https://rubygems.org/gems/logstash-input-centrifyidplatform) so it can be easily installed via Logstash by using the following command:
+
+`logstash-plugin install logstash-input-centrifyidplatform`
+
+2. You can build and install the gem file locally by using the `Makefile` on your system. However, you will need to ensure Ruby requirements for building gem files are met. Use the following commands:
+
+`make build`
+
+This command will build and install the gem file. You will need to ensure the `logstash-plugin` command is in your PATH.
+
+## Configuration
+
+Refer to the example configuration file [here](logstash-input-centrifyidplatform.conf). The example file contains comments to explain each configuration option. This file assumes you will import the data into Elasticsearch using the logstash-output-elasticsearch plugin. However, you can certainly use any output plugin you like.
+
+## Quick Start - Running the ELK stack locally
+
+This section is optional. If you want to run a local ELK stack to run or test this plugin with, below are 
+basic instructions for installing ELK on Mac OS. These instructions use Homebrew to install all packages.
+You can find lots of ELK documentation online, this section is just intended to be a helpful quick overivew/guide.
+you can also refer to Elasticsearch's getting started page: https://www.elastic.co/start
+
+1. The first requirement is Java 8, run:
+
+```shell
+brew update
+brew tap caskroom/versions
+brew cask install java8
+```
+
+Reference https://stackoverflow.com/questions/24342886/how-to-install-java-8-on-mac
+
+2. Next install Elasticsearch, Logstash, and Kibana, run:
+
+```shell
+brew install elasticsearch
+brew install logstash
+brew install kibana
+```
+
+With brew you can start/stop these services by running:
+
+```shell
+brew services start elasticsearch
+brew services start logstash
+brew services start kibana
+
+brew services stop elasticsearch
+brew services stop logstash
+brew services stop kibana
+```
+
+## Quick Start - Developing logstash plugins
+
+This section references to help you get started with logstash plugin development.
+
+1. The article [So, You Want to Make a Logstash Plugin...](https://dzone.com/articles/so-you-want-to-make-a-logstash-plugin) is a great first step. It outlines installing Ruby requirements and setting up the Ruby environment. With this setup you can start developing on the logstash-input-centrifyidplatform plugin, or any other plugin.
+
+If you want to create a new plugin, see:
+
+1. Plugin generator https://www.elastic.co/guide/en/logstash/current/plugins-inputs-generator.html, usage: https://github.com/elastic/logstash/blob/master/docs/static/plugin-generator.asciidoc
+
+2. Submitting your plugin to [RubyGems.org and the Logstash-plugin repository](https://www.elastic.co/guide/en/logstash/current/submitting-plugin.html).

data/LICENSE

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

data/README.md

@@ -0,0 +1,88 @@
+# Logstash Input Plugin for Centrify Identity Platform
+
+For more detail on using the Centrify Identity Platform logstash plugin, see [instructions](INSTRUCTIONS.md).
+
+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. 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
+bin/logstash-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
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- 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/centrifyidplatform.rb

@@ -0,0 +1,234 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+require "json"
+require "date"
+require "base64"
+
+# Fetch Centrify Identity Platform request data.
+#
+
+class LogStash::Inputs::Centrifyidplatform < LogStash::Inputs::Base
+  config_name "centrifyidplatform"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "json"
+
+  #query = 'Select * from Event where WhenOccurred >= start_time_string  and WhenOccurred < end_time_string ORDER BY WhenOccurred ASC'
+
+  # Configurable variables
+  # Centrify PAS OAuth2 account username.
+  config :username, :validate => :string, :default => ""
+  # Centrify OAuth2 password.
+  config :password, :validate => :string, :default => ""
+  # Centrify Tenant.
+  config :tenant, :validate => :string, :default => "not_provided"
+  # Centrify OAuth2 client path
+  config :oauthclient, :validate => :string, :default => "not_provided"
+  config :debug, :validate => :boolean, :default => false
+  # Scope defined within Oauthclient
+  config :scope, :validate => :string, :default => "siem"
+  # Previous timeframe to query from in hours integer
+  config :historyhrs, :validate => :number, :default => 24
+  # Search previoushrs true or false
+  config :historysearch, :validate => :boolean, :default => false
+
+  public
+  def register
+    @host = Socket.gethostname.force_encoding(Encoding::UTF_8)
+    
+    @logger.info("Registering Centrify Identify Platform Input", :tenant => @tenant, :username => @username, :password => @password, :oauthclient => @oauthclient, :scope => @scope,  :historyhrs => @historyhrs, :historysearch => @historysearch )
+    @http = Net::HTTP.new(@tenant, 443)
+    @http.use_ssl = true
+    @http.set_debug_output($stdout) if @debug
+    # set version for UA string
+    @version = "1.0.0"
+    @token_endpoint = "/oauth2/token/#{@oauthclient}/"
+    @query_endpoint = "/Redrock/query"
+    # set interval to value of from @from minus five minutes
+    @interval = 300
+    if historysearch
+      @from = @historyhrs * 3600
+    else
+      @from = 300
+    end
+    t = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%zZ")
+    dt = DateTime.parse(t)
+    ts_until = Time.at(dt.to_time.to_i - 300) # now - 5 minutes
+    ts_from = Time.at(ts_until - @from) # @until - @from
+    @timestamp_until = ts_until.strftime("%Y-%m-%d %H:%M:%S%z")
+    @timestamp_from = ts_from.strftime("%Y-%m-%d %H:%M:%S%z")
+    @eventquery = "select * from Event where WhenOccurred between datefunc('#{@timestamp_from}') and datefunc('#{@timestamp_until}') ORDER BY WhenOccurred ASC"
+  end
+
+  public
+  def run(queue)
+    while !stop?
+      if fetch(queue)
+        @logger.debug("Centrify Identity Platform requests feed retreived successfully.")
+      else
+        @logger.warn("Centrify Identity Platform problem retreiving request!")
+      end
+      @logger.debug("Centrify Identity Platform Sleep: #{@interval}")
+      @timestamp_from = @timestamp_until
+      Stud.stoppable_sleep(@interval) { stop? }
+      t = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%zZ")
+      dt = DateTime.parse(t)
+      ts_until = Time.at(dt.to_time.to_i - 300) # now - 5 minutes
+      @timestamp_until = ts_until.strftime("%Y-%m-%d %H:%M:%S%z")
+      @eventquery = "select * from Event where WhenOccurred between datefunc('#{@timestamp_from}') and datefunc('#{@timestamp_until}') ORDER BY WhenOccurred ASC"
+      end #end loop
+  end
+
+  def fetch(queue)
+    @logger.debug("Centrify Identity Platform tenant: #{@name}")
+    @logger.debug("Centrify Identity Platform OAuth endpoint: #{@oauthclient}")
+    bearer_token = setup_auth_requests!
+    request = post_request(queue, bearer_token)
+    response = @http.request(request)
+    if response.code == "200"
+      body = response.body
+      if body && body.size > 0
+        json = JSON.load(body)
+        if json.has_key? "success"
+          _success = json['success']
+          @logger.debug("Centrify Identity Platform Query success: #{_success}")
+          if _success == 'false'
+            _message = json['message']
+            _exception = json['exception']
+            @logger.warn("Centrify Identity Platform exception: #{_exception} message: #{_message}")
+            return
+          end
+          _events = json['Result']['Results']
+          _events.each do |child|
+            if child.is_a?(Hash)
+              temp = {}
+              _row = child['Row']
+              temp = _row.delete_if { |k, v| v.nil? }
+              _row = temp
+              _whenlogged = date_fix!(_row['WhenLogged'])
+              @logger.debug("Centrify Identity Platform Query whenlogged date fix: #{_whenlogged}")
+              _row['WhenLogged'] = _whenlogged
+              _whenoccurred = date_fix!(_row['WhenOccurred'])
+              @logger.debug("Centrify Identity Platform Query whenlogged date fix: #{_whenoccurred}") 
+              _row['WhenOccurred'] = _whenoccurred
+
+              @logger.debug("Centrify Identity Platform Query JSON dump Row: #{_row}")
+              process_payload!(_row, queue)
+            end
+          end
+        end
+      end
+      #handle_success!(queue, event_results)
+    else
+      @logger.warn("Centrify Identity Platform post exception: #{response.code}")
+      check_response_code!(response.code, "Post Exception")
+    end
+  end
+
+  private
+  def post_request(queue, bearer_token)
+    post = Net::HTTP::Post.new("#{@query_endpoint}")
+    post["Authorization"] = "Bearer #{bearer_token}"
+    post.body = JSON.generate({:Script => @eventquery})
+    post['User-Agent'] = "logstash-centrifyidplatform/#{@version}"
+    @logger.debug("Requesting query data: #{JSON.generate({:Script => @eventquery})}")
+    return post
+  end
+
+  private
+  def handle_success!(queue, event_results)
+    event_results['Row'].each do |payload|
+      @logger.debug("event_result: #{payload}")
+      process_payload!(payload, queue)
+    end
+  end
+
+  private
+  def setup_auth_requests!
+    login = Net::HTTP::Post.new(@token_endpoint)
+    login['User-Agent'] = "logstash-centrifyidplatform/#{@version}"
+    login['Content-Type'] = "application/x-www-form-urlencoded"
+    credentials = Base64.strict_encode64 ("#{@username}:#{@password}")
+    @logger.debug("Centrify Identity Platform login credentials: Basic #{credentials}")
+    login["Authorization"] = "Basic #{credentials}"
+    login.body = "grant_type=client_credentials&scope=#{@scope}"
+
+    begin
+      loginresponse = @http.request(login)
+      @logger.debug("Centrify Identity Platform login response: #{loginresponse.code}")
+    rescue
+      @logger.warn("Centrify Identity Platform could not reach API endpoint to login!")
+      return false
+    end
+    if loginresponse.code != "200"
+      return check_response_code!(loginresponse.code, "Auth")
+    end
+    json = JSON.parse(loginresponse.body)
+    if json.has_key? "message"
+      # failed to login
+      @logger.warn("Centrify Identity Platform login failed: #{json['message']}")
+      return false
+    end
+    bearer_token = json['access_token']
+    @logger.debug("Centrify Identity Platform Bearer Token: #{bearer_token}")
+    return bearer_token
+  end
+
+  private
+  def check_response_code!(res_code, message)
+    if res_code == "524"
+      @logger.warn("524 - Origin Timeout!")
+      @logger.info("Another attempt will be made later. #{message}")
+      return false
+    end
+    if res_code == "429"
+      @logger.warn("429 - Too Many Requests!")
+      @logger.info("API request throttling as been triggered, another attempt will be made later. Contact support if this error continues. #{message}")
+      return false
+    end
+    if res_code == "404"
+      @logger.warn("404 - Not Found! #{message}")
+      return false
+    end
+    if res_code == "401"
+      @logger.warn("401 - Unauthorized! #{message}")
+      return false
+    end
+    @logger.warn("Non-200 return enable debug to troubleshoot: #{res_code} #{message}")
+    return false
+  end
+
+  private 
+  def date_fix!(when_str)
+    prefix = '/Date('
+    suffix = ')/'
+    when_str = when_str.delete_prefix(prefix)
+    when_str = when_str.delete_suffix(suffix).to_f
+    when_str = when_str / 1000.0
+    when_str = Time.at(when_str).utc
+    when_str = when_str.strftime("%Y-%m-%dT%H:%M:%S.%3NZ")
+    return when_str
+  end
+
+  private
+  def process_payload!(payload, queue)
+    temp = {}
+    payload['logstash_host.name'] = @host
+
+    event = LogStash::Event.new('message' => payload.to_json, 'host' => @host, '@timestamp' => payload['WhenOccurred'])
+    event.tag('centrifyidplatform')
+    decorate(event)
+    queue << event
+  end
+#
+#  def stop
+#    # nothing to do in this case so it is not necessary to define stop
+#    # examples of common "stop" tasks:
+#    #  * close sockets (unblocking blocking reads/accepts)
+#    #  * cleanup temporary files
+#    #  * terminate spawned threads
+#  end
+end # class LogStash::Inputs::Centrifyidplatform

data/logstash-input-centrifyidplatform.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-centrifyidplatform'
+  s.version       = '1.0.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash input plugin for Centrify Identity Platform.'
+  s.description   = 'Logstash input plugin for the Centrify Identity Platform RedRock/query feed endpoint https://developer.centrify.com/reference'
+  s.homepage      = 'https://github.com/r32rtb'
+  s.authors       = ['r32rtb']
+  s.email         = 'r32rtb@users.noreply.github.com'
+  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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'stud', '~> 0.0', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils', '~> 0.0', '>= 0.0.16'
+end

data/spec/inputs/centrifyidplatform_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/centrifyidplatform"
+
+describe LogStash::Inputs::centrifyidplatform do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 600 } }
+  end
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-centrifyidplatform
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- r32rtb
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+description: Logstash input plugin for the Centrify Identity Platform RedRock/query
+  feed endpoint https://developer.centrify.com/reference
+email: r32rtb@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- INSTRUCTIONS.md
+- LICENSE
+- README.md
+- lib/logstash/inputs/centrifyidplatform.rb
+- logstash-input-centrifyidplatform.gemspec
+- spec/inputs/centrifyidplatform_spec.rb
+homepage: https://github.com/r32rtb
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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.6.14.1
+signing_key:
+specification_version: 4
+summary: Logstash input plugin for Centrify Identity Platform.
+test_files:
+- spec/inputs/centrifyidplatform_spec.rb