logstash_auditor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dd294589825e39ca26e59a6204bb9431b9d9fbb
+  data.tar.gz: 98defbe2db36aec15e75cc2dad37befe9368487e
+SHA512:
+  metadata.gz: dfcb70d7dd0684918804948477e1902f219fdeb1cfef70130191e8348659eaf8ed9b1a25dd1fb2db2673c2758b36245e79e46b9ffb8b4e564087cd5834814672
+  data.tar.gz: 64c9352f29edb6c57d17426c22f1d4048082e7413acbfaef551a172f2f032a4fc7ebb20b6f7e66e4e0d5e190b20152d28af17e79d1f0eee98f545fbc0c3df743

data/.gitignore

@@ -0,0 +1,49 @@
+.byebug_history
+*tgz
+left
+test_tfa.sh
+test_production.sh
+iut-list
+juddi-distro-*
+*.swo
+*.zip
+*.tar.gz
+*.swp
+*.gem
+*.rbc
+/Gemfile.lock
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+logstash_auditor

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logstash_auditor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Barney de Villiers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# LogstashAuditor
+
+This gem provides the logstash auditor that can be plugged into the SOAR architecture.
+
+## State of the API
+
+This auditor is to be extended with NFR support pending behavioural specifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logstash_auditor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logstash_auditor
+
+## Testing
+
+Behavioural driven testing can be performed by testing against an ELK docker image:
+
+    $ sudo docker run -d -v $(pwd)/spec/support/logstash_conf.d:/etc/logstash/conf.d -p 9300:9300 -p 9200:9200 -p 5000:5000 -p 5044:5044 -p 5601:5601 -p 8080:8080 sebp/elk
+
+Wait about 30 seconds for image to fire up. Then perform the tests:
+
+    $ bundle exec rspec -cfd spec/*
+
+Note that in order to ensure that the processing has occurred on Elastic Search
+there is a 2 second delay between each event submission request and the search request
+
+Afterwards destroy the running docker image as follows:
+    $ sudo docker ps
+    $ sudo docker stop <CONTAINER_ID>
+
+Debugging the docker image:
+    $ sudo docker exec -it <CONTAINER_ID> bash
+
+## Usage
+
+
+#TODO complete this section
+#TODO Extend the LogstashAuditor::AuditingProviderAPI to create an auditing provider:
+
+```
+class MyAuditingProvider < LogstashAuditor::AuditingProviderAPI
+end
+```
+
+Provide the required inversion of control method to configure (an) injected auditor(s):
+
+```
+def configure_auditor(configuration = nil)
+  @auditor.configure(configuration)
+end
+```
+
+Initialize the provider so:
+
+```
+auditor = MyAuditor.new
+auditor_configuration = { 'some' => 'configuration' }
+@iut = MyAuditingProvider.new(auditor, auditor_configuration)
+```
+
+Audit using the API methods, e.g.:
+
+```
+@iut.info("This is info")
+@iut.debug(some_debug_object)
+@iut.warn("Statistics show that dropped packets have increased to #{dropped}%")
+@iut.error("Could not resend some dropped packets. They have been lost. All is still OK, I could compensate")
+@iut.fatal("Unable to perform action, too many dropped packets. Functional degradation.")
+@iut << 'Rack::CommonLogger requires this'
+```
+
+The API also supports appending as below, enabling support, e.g. for Rack::CommonLogger, etc.:
+
+```
+<<
+```
+
+## Detailed example
+
+```
+require 'log4r'
+require 'logstash_auditor'
+
+class Log4rAuditingProvider < LogstashAuditor::AuditingProviderAPI
+  def configure_auditor(configuration = nil)
+    @auditor.outputters = configuration['outputter']
+  end
+end
+
+class Main
+  include Log4r
+
+  def test_sanity
+    auditor = Logger.new 'sanity'
+    auditor_configuration = { 'outputter' => Outputter.stdout }
+    @iut = Log4rAuditingProvider.new(auditor, auditor_configuration)
+
+    some_debug_object = 123
+    @iut.info("This is info")
+    @iut.debug(some_debug_object)
+    dropped = 95
+    @iut.warn("Statistics show that dropped packets have increased to #{dropped}%")
+    @iut.error("Could not resend some dropped packets. They have been lost. All is still OK, I could compensate")
+    @iut.fatal("Unable to perform action, too many dropped packets. Functional degradation.")
+  end
+end
+
+main = Main.new
+main.test_sanity
+```
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to barney dot de dot villiers at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+## Notes
+
+Though out of scope for the provider, auditors should take into account encoding, serialization, and other NFRs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require "bundler/setup"
+require 'logstash_auditor'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logstash_auditor/auditor.rb

@@ -0,0 +1,82 @@
+require 'json'
+require "net/http"
+require "uri"
+
+module LogstashAuditor
+  class LogstashAuditor
+    attr_reader :has_been_configured
+    attr_reader :configuration
+
+    def initialize
+      @has_been_configured = false
+    end
+
+    def configure(configuration = nil)
+      raise ArgumentError, "No configuration provided" if configuration == nil
+      raise ArgumentError, "Invalid configuration provided" unless configuration_is_good(configuration)
+
+      @configuration = configuration
+      @has_been_configured = true
+    end
+
+    def event(flow_id, message)
+      raise ArgumentError, "No flow id provided" if flow_id == nil
+      data = { "flow_id" => flow_id, "message" => message }
+      send_event( data )
+    end
+
+    private
+
+    def send_event(data)
+      uri = URI.parse(@configuration["host_url"])
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = @configuration["timeout"]
+      http.open_timeout = @configuration["timeout"]
+
+      if @configuration["use_ssl"]
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' =>'application/json'})
+      request.basic_auth(@configuration["username"], @configuration["password"])
+      request.body = data.to_json
+
+      response = http.request(request)
+
+      case response.code
+      when "200"
+        return :success
+      when "401"
+        puts "Authorization failure contacting to logstash"
+      else
+        puts "Failure " + response.code + " communicating with logstash"
+      end
+      return :failure
+    end
+
+    def configuration_is_good(configuration)
+      unless configuration.include?("host_url")
+        puts "Parameter host_url not provided in configuration"
+        return false
+      end
+      unless configuration.include?("use_ssl")
+        puts "Parameter use_ssl not provided in configuration"
+        return false
+      end
+      unless configuration.include?("username")
+        puts "Parameter username not provided in configuration"
+        return false
+      end
+      unless configuration.include?("password")
+        puts "Parameter password not provided in configuration"
+        return false
+      end
+      unless configuration.include?("timeout")
+        puts "Parameter timeout not provided in configuration"
+        return false
+      end
+      return true
+    end
+  end
+end

data/lib/logstash_auditor/version.rb

@@ -0,0 +1,3 @@
+module LogstashAuditor
+  VERSION = "0.0.2"
+end

data/lib/logstash_auditor.rb

@@ -0,0 +1,5 @@
+require 'logstash_auditor/version'
+require 'logstash_auditor/auditor'
+
+module LogstashAuditor
+end

data/logstash_auditor.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logstash_auditor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logstash_auditor"
+  spec.version       = LogstashAuditor::VERSION
+  spec.authors       = ["Barney de Villiers"]
+  spec.email         = ["barney.de.villiers@hetzner.co.za"]
+
+  spec.summary       = %q{Logstash implementation of SOAR architecture auditing}
+  spec.description   = %q{Logstash implementation of SOAR architecture auditing allowing easy publishing of events to a centralized logstash collection engine}
+  spec.homepage      = "https://github.hetzner.co.za/hetznerZA/logstash_auditor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9"
+  spec.add_development_dependency "elasticsearch", "~> 1"
+
+  spec.add_dependency "http", "~> 2"
+  
+end

data/sanity/.ruby-gemset

@@ -0,0 +1 @@
+sanity

data/sanity/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/sanity/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'byebug'
+gem 'logstash_auditor', "~> 0.0.1"
+
+gem 'http'
+gem 'net'

data/sanity/sanity.rb

@@ -0,0 +1,24 @@
+require 'logstash_auditor'
+require 'digest'
+
+
+class Main
+  def create_flow_id
+    return Digest::SHA256.hexdigest("#{Time.now.to_i}#{rand(4000000)}")
+  end
+
+  def test_sanity
+    @iut = LogstashAuditor::LogstashAuditor.new
+    @valid_logstash_configuration =
+    { "host_url" => "http://localhost:8080",
+      "use_ssl"  => false,
+      "username" => "something",
+      "password" => "something",
+      "timeout"  => 3}
+    @iut.configure(@valid_logstash_configuration)
+    @iut.event(create_flow_id, "This is a test event")
+  end
+end
+
+main = Main.new
+main.test_sanity

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: logstash_auditor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Barney de Villiers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Logstash implementation of SOAR architecture auditing allowing easy publishing
+  of events to a centralized logstash collection engine
+email:
+- barney.de.villiers@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logstash_auditor.rb
+- lib/logstash_auditor/auditor.rb
+- lib/logstash_auditor/version.rb
+- logstash_auditor.gemspec
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
+homepage: https://github.hetzner.co.za/hetznerZA/logstash_auditor
+licenses:
+- MIT
+metadata: {}
+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: Logstash implementation of SOAR architecture auditing
+test_files: []