soar_auditing_provider_api 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 129f7530981c838d82f5d4df7ec4bceec5f888e2
+  data.tar.gz: 8cd72a7b979eac9895936a3e3b9537a89e743476
+SHA512:
+  metadata.gz: f247e6185716ccd657f6205f7941a3a49f8aee55d01dcb1d2b53453d6b6c3c1da4f408d1dbaff70d31a6473398061d37957f95af50355e07b517ee92ed09452a
+  data.tar.gz: f425413a555d07ceb92b5348ac23fe5f84b195b2d44c60bd90be0cf0aeec85a8b7f49ba39819279c0b62d3e6b1c73d66f3e02c648527eb132e4eda61314a29c2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_auditing_provider_api

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 soar_auditing_provider.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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,127 @@
+# SoarAuditingProvider
+
+This gem provides the auditing API that audit providers for the SOAR architecture should adhere to.
+
+Providers are initialized with a list of auditors (already configured) and their configurations, which include the NFRs they support (key: 'nfrs'), and is responsible for selecting an auditor given a set of NFRs. Such selection is made by calling the select(nfrs) method. The auditing API as set out below then delegates auditing actions to the selected auditor.
+
+The API provides default delegation behaviour that calls the API methods verbatim on the auditor. NFRs can be anything you want. You can ask the auditing provider to select an auditor based on a set of NFRs. The default behaviour is that the first auditor which matches all NFRs exactly is returned. You can override this behaviour by overriding the select(nfrs) method.
+
+If you'd simply like the auditing provider to use the first (perhaps only?) auditor that it knows about, you can tell it to select DEFAULT so:
+
+auditor = auditing_provider.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_auditing_provider'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_auditing_provider
+
+## Testing
+
+Run the rspec test tests:
+
+    $ bundle exec rspec -cfd spec
+
+## Usage
+
+Extend the SoarAuditingProvider::AuditingProviderAPI to create a new auditing provider, or instantiate the API directly for an out-of-the-box auditing provider with default behaviour.
+
+```
+class MyAuditingProvider < SoarAuditingProvider::AuditingProviderAPI
+end
+```
+
+or
+
+```
+auditor_provider = SoarAuditingProvider::AuditingProviderAPI.new(auditors)
+```
+
+Initialize the provider so:
+
+```
+auditor = MyAuditor.new
+auditor_nfrs = { 'nfrs' => { 'accessibility' => 'local' }, 'privacy' => 'not encrypted' }
+@iut = MyAuditingProvider.new( { auditor => auditor_nfrs } )
+```
+
+Select an auditor and audit using the API methods. The auditing provider remembers your selection, e.g.:
+
+```
+@iut.select( {'accessibility' => 'local' })
+@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'
+```
+
+Alternatively, to use different auditors for different sets of NFRs in the same code, do as below. The auditing provider remembers the last auditor selected.
+
+```
+  auditor_A = @iut.select( {'my nfr 1' => 'criteria 1' })
+  auditor_B = @iut.select( {'my nfr 2' => 'criteria 2' })
+
+  auditor_A.debug('debug')
+  auditor_B.warn('warn')
+
+  @iut.error('error') # Uses auditor_B since it was selected last
+```
+
+The API also supports appending as below, enabling support, e.g. for Rack::CommonLogger, etc.:
+
+```
+<<
+```
+
+## Detailed example
+
+```
+require 'log4r'
+require 'soar_auditing_provider'
+
+class Main
+  include Log4r
+
+  def test_sanity
+    auditor = Logger.new 'sanity'
+    auditor.outputters = Outputter.stdout
+    @iut = SoarAuditingProvider::AuditingProviderAPI.new( { auditor => { 'nfrs' => {'accessibility' => 'local'} } } )
+    @iut.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
+    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.")
+    @iut << 'Rack::CommonLogger requires this'
+  end
+end
+
+main = Main.new
+main.test_sanity
+```
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to ernst dot van dot graan 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar_auditing_provider_api"
+
+# 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/soar_auditing_provider_api/auditing_provider_api.rb

@@ -0,0 +1,61 @@
+module SoarAuditingProvider
+  class AuditingProviderAPI
+    DEFAULT = {} unless defined? DEFAULT; DEFAULT.freeze
+
+    attr_accessor :auditors
+    attr_accessor :auditor
+
+    def initialize(auditors)
+      raise ArgumentError.new("Invalid auditors provided") if not auditors.is_a?(Hash)
+      raise ArgumentError.new("No auditors provided") if auditors.nil? or auditors.empty?
+      @auditors = auditors
+    end
+
+    def debug(data)
+      @auditor.debug(data)
+    end
+
+    def <<(data)
+      @auditor.info(data)
+    end
+
+    def info(data)
+      @auditor.info(data)
+    end
+
+    def error(data)
+      @auditor.error(data)
+    end
+
+    def warn(data)
+      @auditor.warn(data)
+    end
+
+    def fatal(data)
+      @auditor.fatal(data)
+    end
+
+    def select(nfrs = DEFAULT)
+      if nfrs.nil? or nfrs.empty?
+        auditor_selected = auditors.keys.first
+      else
+        auditor_selected = nil
+        auditors.each do |auditor, configuration|
+          auditor_nfrs = configuration['nfrs']
+          nfrs_matched = true
+          nfrs.each do |nfr, value|
+            nfrs_matched = false if not auditor_nfrs[nfr] or (auditor_nfrs[nfr] != value)
+          end
+          if nfrs_matched
+            auditor_selected = auditor
+            break
+          end
+        end
+        raise NFRMatchError.new("Could not match NFRs to an auditor") if auditor_selected.nil?
+      end
+      configuration = auditors[auditor_selected]
+      @auditor = auditor_selected
+      return @auditor, configuration
+    end
+  end
+end

data/lib/soar_auditing_provider_api/nfr_match_error.rb

@@ -0,0 +1,4 @@
+module SoarAuditingProvider
+  class NFRMatchError < StandardError
+  end
+end

data/lib/soar_auditing_provider_api/version.rb

@@ -0,0 +1,3 @@
+module SoarAuditingProvider
+  VERSION = "0.8.0"
+end

data/lib/soar_auditing_provider_api.rb

@@ -0,0 +1,6 @@
+require "soar_auditing_provider_api/version"
+require 'soar_auditing_provider_api/auditing_provider_api'
+require 'soar_auditing_provider_api/nfr_match_error'
+
+module SoarAuditingProvider
+end

data/sanity/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem

data/sanity/.ruby-gemset

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

data/sanity/.ruby-version

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

data/sanity/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'log4r'
+gem 'soar_auditing_provider_api', :path => "../"

data/sanity/sanity.rb

@@ -0,0 +1,24 @@
+require 'log4r'
+require 'soar_auditing_provider_api'
+
+class Main
+  include Log4r
+
+  def test_sanity
+    auditor = Logger.new 'sanity'
+    auditor.outputters = Outputter.stdout
+    @iut = SoarAuditingProvider::AuditingProviderAPI.new( { auditor => { 'nfrs' => {'accessibility' => 'local'} } } )
+    @iut.select(SoarAuditingProvider::AuditingProviderAPI::DEFAULT)
+    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.")
+    @iut << 'Rack::CommonLogger requires this'
+  end
+end
+
+main = Main.new
+main.test_sanity

data/soar_auditing_provider_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_auditing_provider_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_auditing_provider_api"
+  spec.version       = SoarAuditingProvider::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{API for SOAR architecture auditing}
+  spec.description   = %q{API for SOAR architecture auditing}
+  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"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: soar_auditing_provider_api
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-27 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API for SOAR architecture auditing
+email:
+- ernst.van.graan@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/soar_auditing_provider_api.rb
+- lib/soar_auditing_provider_api/auditing_provider_api.rb
+- lib/soar_auditing_provider_api/nfr_match_error.rb
+- lib/soar_auditing_provider_api/version.rb
+- sanity/.gitignore
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
+- soar_auditing_provider_api.gemspec
+homepage: 
+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: API for SOAR architecture auditing
+test_files: []