stream_auditor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 894b6a9dbf40b4b66c3919484e8457c1e06c7235
+  data.tar.gz: dc994150516cdca9bd60b8efb77d8f7541c055dc
+SHA512:
+  metadata.gz: 64f66715dd0021f18f8085daa98de1e8d2a68ff4cd7d81f8ad3ddde63d1dd40fdeafb6849e173bd6766c6767ef26c50e8bd1664766ff03226c247096ae0a1565
+  data.tar.gz: c82e5dc68d6091015d7319be2004d677f0832c3d843dc140a2dfb77e61229edbc156411d126c3cb6ae851797c1e5fcb722dd562fbe9748608268b1325a5565c4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,123 @@
+# StreamAuditor
+
+This is an IO stream auditor for the [SOAR Auditing Provider](https://github.com/hetznerZA/soar_auditing_provider).
+
+It supports auditing to the standard error and output streams, to a file path (in append mode) or to an already open IO object.
+In all cases, the stream is flushed on every audit call.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stream_auditor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stream_auditor
+
+## Usage
+
+Configuration of the SOAR auditing provider is still chunky. The `queue_worker` config is not required for the stream auditor, but
+the auditing provider insists on it. So for now:
+
+```ruby
+# Log to stderr
+config = {
+  "auditing" => {
+    "provider" => "SoarAuditingProvider::AuditingProvider",
+    "level" => "debug",
+    "install_exit_handler" => "true",
+    "direct_auditor_call" => "true",
+    "queue_worker" => {
+      "queue_size" => 1,
+      "back_off_attempts" => 1
+    },
+    "auditors" => {
+      "local" => {
+        "adaptor" => "StreamAuditor"
+      }
+    }
+  }
+}
+SoarAuditingProvider::AuditingProvider.new(config["auditing"])
+
+# Log to stdout
+config = {
+  "auditing" => {
+    "provider" => "SoarAuditingProvider::AuditingProvider",
+    "level" => "debug",
+    "install_exit_handler" => "true",
+    "direct_auditor_call" => "true",
+    "queue_worker" => {
+      "queue_size" => 1,
+      "back_off_attempts" => 1
+    },
+    "auditors" => {
+      "local" => {
+        "adaptor" => "StreamAuditor",
+        "standard_stream" => "stdout"
+      }
+    }
+  }
+}
+SoarAuditingProvider::AuditingProvider.new(config["auditing"])
+
+# Log to file in append mode
+config = {
+  "auditing" => {
+    "provider" => "SoarAuditingProvider::AuditingProvider",
+    "level" => "debug",
+    "install_exit_handler" => "true",
+    "direct_auditor_call" => "true",
+    "queue_worker" => {
+      "queue_size" => 1,
+      "back_off_attempts" => 1
+    },
+    "auditors" => {
+      "local" => {
+        "adaptor" => "StreamAuditor",
+        "path" => "/var/log/application.log"
+      }
+    }
+  }
+}
+SoarAuditingProvider::AuditingProvider.new(config["auditing"])
+
+# Log to IO object
+config = {
+  "auditing" => {
+    "provider" => "SoarAuditingProvider::AuditingProvider",
+    "level" => "debug",
+    "install_exit_handler" => "true",
+    "direct_auditor_call" => "true",
+    "queue_worker" => {
+      "queue_size" => 1,
+      "back_off_attempts" => 1
+    },
+    "auditors" => {
+      "local" => {
+        "adaptor" => "StreamAuditor",
+        "io" => File.open("/var/log/application.log", "a")
+      }
+    }
+  }
+}
+SoarAuditingProvider::AuditingProvider.new(config["auditing"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/hetznerZA/stream_auditor).
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stream_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/stream_auditor/version.rb

@@ -0,0 +1,5 @@
+require "soar_auditor_api/auditor_api"
+
+class StreamAuditor < SoarAuditorApi::AuditorAPI
+  VERSION = "0.1.0"
+end

data/lib/stream_auditor.rb

@@ -0,0 +1,82 @@
+require "stream_auditor/version"
+require "soar_auditor_api/auditor_api"
+require "fileutils"
+
+class StreamAuditor < SoarAuditorApi::AuditorAPI
+
+  DEFAULT_CONFIGURATION = {
+    "standard_stream" => "stderr"
+  }
+
+  def initialize(configuration = nil)
+    configuration = cleanup_configuration(configuration)
+    super
+  end
+
+  def audit(data)
+    @stream << data.to_s.chomp + "\n"
+    @stream.flush
+  end
+
+  def configure(configuration = nil)
+    configuration = cleanup_configuration(configuration)
+    super
+    @stream = nil
+    @stream = configuration["io"] if configuration["io"]
+    @stream = standard_stream(configuration["standard_stream"]) if configuration["standard_stream"]
+    @stream = creative_open_file(configuration["path"]) if configuration["path"]
+  end
+
+  def configuration_is_valid?(configuration)
+    configuration = cleanup_configuration(configuration)
+    1 == configuration.keys.inject(0) { |count, key| count += 1 if ["standard_stream", "path", "io"].include?(key) } and
+      configuration["io"].nil? || configuration["io"].respond_to?(:<<) and
+      configuration["path"].nil? || (File.expand_path(configuration["path"]) rescue false) and
+      configuration["standard_stream"].nil? || ["stderr", "stdout"].include?(configuration["standard_stream"])
+  end
+
+  private
+
+  # XXX Fight the auditor API
+  #
+  # The auditor API:
+  #
+  # * doesn't run the configure method for nil configuration,
+  # * insists on validation non-nil configuration, and
+  # * received the "adaptor" configuration key from the SOAR auditing provider.
+  #
+  def cleanup_configuration(configuration)
+    configuration = (configuration || {}).reject { |k, v| k == "adaptor" }
+
+    if configuration.nil? or configuration.empty?
+      DEFAULT_CONFIGURATION
+    else
+      configuration
+    end
+  end
+
+  # XXX Fight rspec
+  #
+  # From the rspec-expectations documentation:
+  #
+  #     Note: to_stdout and to_stderr work by temporarily replacing $stdout or $stderr,
+  #     so they're not able to intercept stream output that explicitly uses STDOUT/STDERR
+  #     or that uses a reference to $stdout/$stderr that was stored before the matcher was used.
+  #
+  def standard_stream(stream_name)
+    case stream_name
+    when "stderr"
+      $stderr
+    when "stdout"
+      $stdout
+    else
+      raise ArgumentError, "unknown stream name #{stream_name.inspect}"
+    end
+  end
+
+  def creative_open_file(path)
+    FileUtils.mkdir_p(File.expand_path("..", path), mode: 0700)
+    File.open(path, "a")
+  end
+
+end

data/stream_auditor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stream_auditor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stream_auditor"
+  spec.version       = StreamAuditor::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{IO stream implementation of SOAR architecture auditing}
+  spec.description   = %q{IO stream implementation of SOAR architecture auditing allowing easy publishing of events to a standard IO stream, (e.g. stderr)}
+  spec.homepage      = "https://github.com/hetznerZA/stream_auditor"
+
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "soar_auditor_api", "~> 0.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: stream_auditor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: soar_auditor_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: IO stream implementation of SOAR architecture auditing allowing easy
+  publishing of events to a standard IO stream, (e.g. stderr)
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stream_auditor.rb
+- lib/stream_auditor/version.rb
+- stream_auditor.gemspec
+homepage: https://github.com/hetznerZA/stream_auditor
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: IO stream implementation of SOAR architecture auditing
+test_files: []
+has_rdoc: