log4r_auditor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c0a79bb1ba22f167caa468f325846f1978cd3c
-  data.tar.gz: 9c99481477f8882ac86af39fcb86fb39de537fd2
+  metadata.gz: 01b2fe25ed35f22bca22b87f5169c56dc2178108
+  data.tar.gz: 02dba7094bc207e69ca895b3596c5c20364fd863
 SHA512:
-  metadata.gz: a2f7447537d680b3a9fd58b1ba73c7b15ecde9695a444ccd50c8dff4b674d29064e3e9206a61ed7aa661496d177093036f6f88857013a3db46c552f003019fa6
-  data.tar.gz: 28fae3bcf2fd1a68b9b43c4b1e01e2ff36dfb4dbdac89d3ebae827ed289ec502c9026a31bee65c6609400b0d4c36e3d1ffcf38ce65c24481f7cd8a859602f148
+  metadata.gz: 7ca673e9587602c3fe34c7880cb9d8353ec52ba0b96fbe3e75a9f066823c36d186c4506aeb5e7aa1080cef74977852f63f60a546aa2d34cd912c3f0ee069cb86
+  data.tar.gz: 36fe2ef5226178a4395ff5fbc9134d0f75f2479fc84e858dfe5e334075aaabe80a6047459fc070fec640ad7f219da0c26621fbbdab34d5afdd3ffb485cb74a43

data/.gitignore

@@ -0,0 +1,50 @@
+.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
+logfile
+
+## 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 @@
+log4r_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 log4r_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,76 @@
+# Log4rAuditor
+
+This gem provides the log4r auditor that can be plugged into the SOAR architecture.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log4r_auditor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log4r_auditor
+
+## Testing
+
+Behavioural driven testing can be performed by testing so:
+
+    $ bundle exec rspec -cfd spec/*
+
+## Usage
+
+Initialize and configure the auditor so:
+
+```ruby
+@iut = Log4rAuditor::Log4rAuditor.new
+@log4r_configuration = { 'file_name' => 'logfile',
+                         'standard_stream' => 'stdout' }
+@iut.configure(@log4r_configuration)
+```
+
+Audit using the API methods inherited from SoarAuditorApi::AuditorAPI, e.g.:
+
+```ruby
+@iut.warn("This is a test event")
+```
+
+## Detailed example
+
+```ruby
+require 'log4r_auditor'
+require 'soar_auditing_format'
+require 'time'
+require 'securerandom'
+
+class Main
+  def test_sanity
+    @iut = Log4rAuditor::Log4rAuditor.new
+    @log4r_configuration =
+    { }
+    @iut.configure(@log4r_configuration)
+    @iut.set_audit_level(:debug)
+
+    my_optional_operation_field = SoarAuditingFormatter::Formatter.optional_field_format("operation", "Http.Get")
+    my_optional_method_name_field = SoarAuditingFormatter::Formatter.optional_field_format("method", "#{self.class}::#{__method__}::#{__LINE__}")
+    @iut.debug(SoarAuditingFormatter::Formatter.format(:debug,'my-sanity-service-id',SecureRandom.hex(32),Time.now.iso8601(3),"#{my_optional_method_name_field}#{my_optional_operation_field} test message with optional fields"))
+  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)
+
+## 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 'log4r_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/log4r_auditor/auditor.rb

@@ -0,0 +1,51 @@
+require 'soar_auditor_api'
+require 'log4r'
+
+module Log4rAuditor
+  class Log4rAuditor < SoarAuditorApi::AuditorAPI
+    #Override of AuditorAPI configure method in order to perform post configuration setup
+    def configure(configuration)
+      super(configuration)
+      post_configuration_setup
+    end
+
+    #inversion of control method required by the AuditorAPI to validate the configuration
+    def configuration_is_valid?(configuration)
+      required_parameters = ['file_name', 'standard_stream']
+      required_parameters.each { |parameter| return false unless configuration.include?(parameter) }
+      return false if configuration['file_name'].empty?
+      return false unless ['stdout', 'stderr'].include?(configuration['standard_stream'])
+      return true
+    end
+
+    #inversion of control method required by the AuditorAPI to send the audit event to the auditor
+    def audit(audit_data)
+      @log4r.debug(audit_data)
+    end
+
+    private
+
+    def post_configuration_setup
+      @log4r = Log4r::Logger.new('soar_sc')
+      @log4r.outputters = create_log4r_file_output, create_log4r_standard_stream_output
+      @log4r
+    end
+
+    def create_log4r_file_output
+      logfile = Log4r::FileOutputter.new('fileOutputter', :filename => @configuration['file_name'],:trunc => false)
+      logfile.formatter = create_log4r_pattern
+      logfile
+    end
+
+    def create_log4r_standard_stream_output
+      logstdout = Log4r::Outputter.stdout if 'stdout' == @configuration['standard_stream']
+      logstdout = Log4r::Outputter.stderr if 'stderr' == @configuration['standard_stream']
+      logstdout.formatter = create_log4r_pattern
+      logstdout
+    end
+
+    def create_log4r_pattern
+      Log4r::PatternFormatter.new(:pattern => '%m')
+    end
+  end
+end

data/lib/log4r_auditor/version.rb

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

data/lib/log4r_auditor.rb

@@ -0,0 +1,5 @@
+require 'log4r_auditor/version'
+require 'log4r_auditor/auditor'
+
+module Log4rAuditor
+end

data/log4r_auditor.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log4r_auditor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log4r_auditor"
+  spec.version       = Log4rAuditor::VERSION
+  spec.authors       = ["Barney de Villiers"]
+  spec.email         = ["barney.de.villiers@hetzner.co.za"]
+
+  spec.summary       = %q{Log4r implementation of SOAR architecture auditing}
+  spec.description   = %q{Log4r implementation of SOAR architecture auditing allowing easy publishing of events to a stdout and local logfile}
+  spec.homepage      = "https://github.com/hetznerZA/log4r_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 "soar_auditing_format", "~> 0.0.5"
+
+  spec.add_dependency "log4r", "~> 1.1"
+  spec.add_dependency "soar_auditor_api", "~> 0.0.11"
+
+end

data/sanity/.ruby-gemset

@@ -0,0 +1 @@
+log4r_auditor_sanity

data/sanity/.ruby-version

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

data/sanity/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'log4r_auditor', "~> 0.0.2"
+gem "soar_auditing_format", "~> 0.0.5"

data/sanity/sanity.rb

@@ -0,0 +1,21 @@
+require 'soar_auditing_format'
+require 'time'
+require 'securerandom'
+require "log4r_auditor"
+
+class Main
+  def test_sanity
+    @iut = Log4rAuditor::Log4rAuditor.new
+    @log4r_configuration = { 'file_name' => 'logfile',
+                             'standard_stream' => 'stdout' }
+    @iut.configure(@log4r_configuration)
+    @iut.set_audit_level(:debug)
+
+    my_optional_operation_field = SoarAuditingFormatter::Formatter.optional_field_format("operation", "Http.Get")
+    my_optional_method_name_field = SoarAuditingFormatter::Formatter.optional_field_format("method", "#{self.class}::#{__method__}::#{__LINE__}")
+    @iut.debug(SoarAuditingFormatter::Formatter.format(:debug,'my-sanity-service-id',SecureRandom.hex(32),Time.now.iso8601(3),"#{my_optional_method_name_field}#{my_optional_operation_field} test message with optional fields"))
+  end
+end
+
+main = Main.new
+main.test_sanity

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log4r_auditor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Barney de Villiers
@@ -115,7 +115,26 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log4r_auditor.rb
+- lib/log4r_auditor/auditor.rb
+- lib/log4r_auditor/version.rb
+- log4r_auditor.gemspec
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
 homepage: https://github.com/hetznerZA/log4r_auditor
 licenses:
 - MIT