soar_auditing_provider 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53407adc397a6858ed206df36077ef5fa5049fa5
-  data.tar.gz: 5572b48e960f687b0824a701178db1f84fb31604
+  metadata.gz: 51aeace65e2c7f7dc23b59e86945e6cfc38661ea
+  data.tar.gz: 3bcb28702ec81a06d14be9df2d3bc744ff5627bc
 SHA512:
-  metadata.gz: 2a85739dc74bdcc333065c46d93549465b31db7cfe5c9847dbfcdae01c8307db450667b9e4d6d9d2f39a020741c61bc58a6042e73cf5c001a0297086a9becbd8
-  data.tar.gz: 00fd05b9c531e8fff25d17fb4e5c40c4a0c9e84b9fdf11b0f1198e9c769d2593d474073f224fc1d6a7809f28f3e47aaf8f007137358024337f5df646e0cbf661
+  metadata.gz: e65d77b5f0cd4be88846748551d9742743eb52ef31f500b4c8364daf764e4603edaf8ba2fc612029cfa8565fafbc0e9a5c82396e38edec5c2df9695fb1a7b5a9
+  data.tar.gz: 9f3b52451cce445c0dbb1697c4d79d61a53ec3e97fdd81aa81d7cc8ab48a4ddc8d9ecbe8f141031a079e950bcd77e7cbe489b45b5fc1da134a31194e3dd4a785

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 .byebug_history
 *.gem
 /sanity/soar_sc.log

data/lib/soar_auditing_provider/auditing_provider.rb

@@ -1,23 +1,13 @@
-require 'soar_auditing_provider_api'
 require 'soar_auditing_format'
+require 'soar_json_auditing_format'
 require 'soar_configured_factory'
 require 'soar_flow'
 require 'time'
 require 'securerandom'
 
 module SoarAuditingProvider
-  class AuditingProvider < SoarAuditingProviderAPI::AuditingProviderAPI
-    private
-
-    #Aliases for bypassing overridden methods when accessing underlying super class api
-    alias :super_debug :debug
-    alias :super_info  :info
-    alias :super_warn  :warn
-    alias :super_error :error
-    alias :super_fatal :fatal
-
-    public
-
+  class AuditingProvider
+    DEFAULT_NFRS = {} unless defined? DEFAULT_NFRS; DEFAULT_NFRS.freeze
     DEFAULT_FLOW_ID_GENERATOR = -> { SoarFlow::ID::generate_flow_id } unless defined?(DEFAULT_FLOW_ID_GENERATOR)
     DEFAULT_LEVEL = :info unless defined?(DEFAULT_LEVEL)
     DEFAULT_QUEUE_WORKER_CONFIG = {
@@ -33,7 +23,11 @@ module SoarAuditingProvider
 
     def initialize(configuration)
       @configuration = configuration
-      super(create_auditors(configuration))
+
+      @auditors = create_auditors(configuration)
+      raise ArgumentError.new("Invalid auditors provided") if not @auditors.is_a?(Hash)
+      raise ArgumentError.new("No auditors provided") if @auditors.nil? or @auditors.empty?
+
       select_auditor(configuration['default_nfrs'])
       @flow_id_generator = @configuration["flow_id_generator"] || DEFAULT_FLOW_ID_GENERATOR
       create_auditing_worker
@@ -100,12 +94,39 @@ module SoarAuditingProvider
       send(level,exception_message,flow_id)
     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
+
     private
 
     def prepend_caller_information(data)
       if 'true' == @configuration['add_caller_source_location']
-        caller_key_value_pair = SoarAuditingFormatter::Formatter.optional_field_format("caller_source_location","#{caller_locations(2,1)[0]}")
-        data = "#{caller_key_value_pair} #{data}"
+        if data is_a?(Hash)
+          data['caller_source_location'] = "#{caller_locations(2,1)[0]}"
+        else
+          caller_key_value_pair = SoarAuditingFormatter::Formatter.optional_field_format("caller_source_location","#{caller_locations(2,1)[0]}")
+          data = "#{caller_key_value_pair} #{data}"
+        end
       end
       data
     end
@@ -134,7 +155,7 @@ module SoarAuditingProvider
       if @worker
         enqueue(level, data)
       else
-        super_class_caller(level, data)
+        auditor_caller(level, data)
       end
     end
 
@@ -151,22 +172,26 @@ module SoarAuditingProvider
     end
 
     def format(level, data, flow_identifier)
-      SoarAuditingFormatter::Formatter.format(level,@service_identifier,flow_identifier,Time.now.utc.iso8601(3),data)
+      if "json" == output_format
+        SoarJsonAuditingFormatter::Formatter.format(level,@service_identifier,flow_identifier,Time.now.utc.iso8601(3),data)
+      else
+        SoarAuditingFormatter::Formatter.format(level,@service_identifier,flow_identifier,Time.now.utc.iso8601(3),data)
+      end
     end
 
     def create_auditing_worker
       if !direct_auditor_call?
         config =  @configuration['queue_worker'] || DEFAULT_QUEUE_WORKER_CONFIG
         @worker = AuditingWorker.instance
-        @worker.configure(queue_worker_configuration: config, auditor_audit_method: method(:super_class_caller))
+        @worker.configure(queue_worker_configuration: config, auditor_audit_method: method(:auditor_caller))
         @worker.start
       else
         @worker = nil
       end
     end
 
-    def super_class_caller(level, data)
-      send("super_#{level}",data)
+    def auditor_caller(level, data)
+      @auditor.send(level,data)
     end
 
     def create_auditors(configuration)
@@ -195,6 +220,10 @@ module SoarAuditingProvider
         (configuration['direct_auditor_call'].nil? and @auditor.prefer_direct_call?)
     end
 
+    def output_format
+      @configuration['output_format'] || 'string'
+    end
+
     def initialize_metrics
       @startup_timestamp     = Time.now.utc.iso8601(3)
       @enqueued_audit_events = 0

data/lib/soar_auditing_provider/nfr_match_error.rb

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

data/lib/soar_auditing_provider/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingProvider
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/sanity/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'soar_auditing_provider', :path => "../"
-gem "log4r_auditor", "~> 1.0.0"
+gem "log4r_auditor", "~> 1.1.0"
+gem "logstash_auditor", "~> 1.1.0"
 gem "soar_flow", "~> 0.1.1"
+gem 'configuration_service-provider-vault', '~> 3.3', '>= 3.3.1'

data/sanity/sanity_testing_production_config.rb

@@ -0,0 +1,81 @@
+require 'soar_auditing_provider'
+require 'log4r_auditor'
+require 'logstash_auditor'
+require 'soar_flow'
+require 'configuration_service'
+
+class Main
+
+  def get_config_from_config_service
+    #where to get the token
+    #https://configuration-service.auto-h.net/#authorize
+
+    #docs where this code comes from
+    #http://www.rubydoc.info/gems/configuration_service-provider-vault
+    require 'bundler'
+    Bundler.require(:default)
+    ENV['CFGSRV_IDENTIFIER']="auditing_for_production"
+    ENV['CFGSRV_TOKEN']="43f8f6f5-6f9c-87fb-e71e-0cea7fe58c07" #TODO fill this in
+    ENV['CFGSRV_PROVIDER']="vault"
+    ENV['CFGSRV_PROVIDER_ADDRESS']="https://vault.auto-h.net"
+    config_service = ConfigurationService::Factory.create_client
+    config = config_service.request_configuration
+    config.data
+  end
+
+  def test_sanity
+
+    config = get_config_from_config_service
+
+    #OVERRIDE TO JSON if required
+    #config['output_format'] = 'json'
+
+    #OVERRIDE TO LOCAL ELK STACK if required
+    config['auditors']['logstash']["host_url"] = "https://logstash-staging1.jnb1.host-h.net:8080"
+    #config['auditors']['logstash']["certificate"]  = File.read("../../logstash_auditor/spec/support/certificates/selfsigned/selfsigned_registered.cert.pem")
+    #config['auditors']['logstash']["private_key"] = File.read( "../../logstash_auditor/spec/support/certificates/selfsigned/selfsigned_registered.private.nopass.pem")
+
+    $stderr.puts config
+
+    #config = load_yaml_file('production_config.yml')
+
+    #create and configure auditing instance
+    myauditing = SoarAuditingProvider::AuditingProvider.new( config )
+    myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
+    myauditing.service_identifier = 'my-test-service.com'
+
+    #associate a set of auditing entries with a flow by generating a flow identifiers
+    flow_id = SoarFlow::ID::generate_flow_id
+
+    #generate audit events
+    some_debug_object = 123
+
+    debug_hash = { "info" => "bla" }
+
+    myauditing.info(debug_hash,flow_id)
+
+
+    # myauditing.debug(some_debug_object,flow_id)
+    # dropped = 95
+    # myauditing.warn("Statistics show that dropped packets have increased to #{dropped}%",flow_id)
+    # myauditing.error("Could not resend some dropped packets. They have been lost. All is still OK, I could compensate",flow_id)
+    # myauditing.fatal("Unable to perform action, too many dropped packets. Functional degradation.",flow_id)
+    # myauditing << 'Rack::CommonLogger requires this'
+
+    sleep 3
+  end
+
+  def load_yaml_file(file_name)
+    require 'yaml'
+    if File.exist?(file_name)
+      YAML.load_file(file_name)
+    else
+      {}
+    end
+  rescue IOError, SystemCallError, Psych::Exception => ex
+    raise LoadError.new("Failed to load yaml file #{file_name} : #{ex}")
+  end
+end
+
+main = Main.new
+main.test_sanity

data/soar_auditing_provider.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'log4r_auditor', '~> 1.1'
   spec.add_development_dependency 'soar_xt', '~> 0.0.3'
 
-  spec.add_dependency 'soar_auditing_provider_api', '~> 0.9.0'
   spec.add_dependency 'soar_auditor_api', '~> 1.0'
   spec.add_dependency 'soar_auditing_format', '~> 0.0.5'
+  spec.add_dependency 'soar_json_auditing_format', '~> 0.0.2'
   spec.add_dependency 'soar_flow', '~> 0.1.1'
   spec.add_dependency 'soar_thread_worker', '~> 0.2.0'
   spec.add_dependency 'soar_configured_factory', '~> 0.1.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ernst van Graan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,47 +96,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.3
 - !ruby/object:Gem::Dependency
-  name: soar_auditing_provider_api
+  name: soar_auditor_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: soar_auditor_api
+  name: soar_auditing_format
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
-  name: soar_auditing_format
+  name: soar_json_auditing_format
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: soar_flow
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ files:
 - lib/soar_auditing_provider/auditing_overflow_error.rb
 - lib/soar_auditing_provider/auditing_provider.rb
 - lib/soar_auditing_provider/auditing_worker.rb
+- lib/soar_auditing_provider/nfr_match_error.rb
 - lib/soar_auditing_provider/version.rb
 - sanity/.gitignore
 - sanity/.ruby-gemset
@@ -211,6 +212,7 @@ files:
 - sanity/Gemfile
 - sanity/sanity.rb
 - sanity/sanity_benchmark.rb
+- sanity/sanity_testing_production_config.rb
 - soar_auditing_provider.gemspec
 homepage: 
 licenses:
@@ -237,4 +239,3 @@ signing_key:
 specification_version: 4
 summary: SOAR architecture auditing provider
 test_files: []
-has_rdoc: