soar_json_auditing_format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbc77dd43c8bf34e66e772fe89c857e93f52cf02
+  data.tar.gz: a95fff53840670f27c0e9fb6eb4e33fe2b8904f0
+SHA512:
+  metadata.gz: 49d04478b8f0fba152886dad58e2e481f25644994ad3d210806057a345bbc4f088bbd80ed4552becbbb616050af01e61e9e7f8029aeafb04a9ab688b71f0d227
+  data.tar.gz: 7ab143427537d1c246d4f590c93ef046483c75160683ff4bad95a14492e1276b557cdc90afbddcf7ef386f3febca226c13d63f32b83776cf5ae4ed89a0ce5fbd

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 @@
+soar_json_auditing_format

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/.travis.yml

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

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.3.0
+
+WORKDIR /usr/local/src/
+
+ADD . /usr/local/src/
+RUN cd /usr/local/src/
+RUN gem install bundler
+RUN bundle install
+
+CMD bundle exec rspec -cfd spec/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar_json_auditing_format.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,81 @@
+# SoarJsonAuditingFormatter
+
+This gem provides the formatting of audit entries for auditing purposes.
+
+## Installation
+
+Add this line to your auditor Gemfile:
+
+```ruby
+gem 'soar_json_auditing_format'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_json_auditing_format
+
+## Testing
+
+Run the rspec test tests using docker compose:
+
+```bash
+export UID
+docker-compose build --force-rm --no-cache
+docker-compose down
+docker-compose run --rm soar-json-auditing-format
+docker-compose down
+```
+
+## Usage
+
+When formatting an auditing entry call the formatter as follow:
+
+```ruby
+SoarJsonAuditingFormatter::Formatter.format(:error,SecureRandom.hex(32),Time.now,"message")
+```
+
+When formatting an optional field call the formatter as follow:
+
+```ruby
+SoarJsonAuditingFormatter::Formatter.optional_field_format("somekey", "somevalue")
+```
+
+## Detailed example
+
+```ruby
+require 'soar_json_auditing_format'
+require 'byebug'
+require 'securerandom'
+
+class Main
+  def test_sanity
+    my_optional_field = SoarJsonAuditingFormatter::Formatter.optional_field_format("somekey", "somevalue")
+    puts SoarJsonAuditingFormatter::Formatter.format(:error,SecureRandom.hex(32),Time.now.utc.iso8601(3),"#{my_optional_field} message")
+  end
+end
+
+main = Main.new
+main.test_sanity
+```
+
+The formatted output of the example above will be something like this:
+
+``` bash
+error,9241cee6f0368942202d4d0e22ac09cde6c88446137c8c48e4eb053a703855f8,2016-05-27T08:40:27.087Z,[somekey:somevalue] message
+```
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar_json_auditing_format"
+
+# 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/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '2.0'
+services:
+  soar-json-auditing-format:
+    user: $UID:$UID
+    build: .
+    image: soar-json-auditing-format
+    volumes:
+      - .:/usr/local/src/

data/lib/soar_json_auditing_format.rb

@@ -0,0 +1,5 @@
+require 'soar_json_auditing_format/version'
+require 'soar_json_auditing_format/formatter'
+
+module SoarJsonAuditingFormatter
+end

data/lib/soar_json_auditing_format/formatter.rb

@@ -0,0 +1,25 @@
+require 'time'
+require 'json'
+
+module SoarJsonAuditingFormatter
+  class Formatter
+    def self.format(level, service_id, flow_id, timestamp, message)
+      audit = message
+      if audit.is_a? Hash
+        audit['timestamp']  = Time.parse(timestamp.to_s).utc.iso8601(3)
+        audit['level']      = level
+        audit['service_id'] = service_id
+        audit['flow_id']    = flow_id unless audit['flow_id']
+      else
+        audit = {
+          'timestamp' => Time.parse(timestamp.to_s).utc.iso8601(3),
+          'level' => level,
+          'service_id' => service_id,
+          'flow_id' => flow_id,
+          'message' => message
+        }
+      end
+      audit.to_json
+    end
+  end
+end

data/lib/soar_json_auditing_format/version.rb

@@ -0,0 +1,3 @@
+module SoarJsonAuditingFormatter
+  VERSION = "0.0.1"
+end

data/retry.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Retries a command on failure.
+# $1 - the max number of attempts
+# $2... - the command to run
+retry() {
+    local -r -i max_attempts="$1"; shift
+    local -r cmd="$@"
+    local -i attempt_num=1
+    local -i cmd_exit_code=0
+    until $cmd
+    do
+        cmd_exit_code=$?
+        if (( attempt_num == max_attempts ))
+        then
+            echo "Attempt $attempt_num failed with code $cmd_exit_code and there are no more attempts left!"
+            exit $cmd_exit_code
+        else
+            echo "Attempt $attempt_num failed with code $cmd_exit_code! Trying again in $attempt_num seconds..."
+            sleep $(( attempt_num++ ))
+        fi
+    done
+}

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 'byebug'
+gem 'soar_json_auditing_format', "~> 0.0.5"

data/sanity/sanity.rb

@@ -0,0 +1,13 @@
+require 'soar_json_auditing_format'
+require 'byebug'
+require 'securerandom'
+
+class Main
+  def test_sanity
+    my_optional_field = SoarJsonAuditingFormatter::Formatter.optional_field_format("somekey", "somevalue")
+    puts SoarJsonAuditingFormatter::Formatter.format(:error,'my-service-identifier',SecureRandom.hex(32),Time.now.utc.iso8601(3),"#{my_optional_field} message")
+  end
+end
+
+main = Main.new
+main.test_sanity

data/soar_json_auditing_format.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_json_auditing_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_json_auditing_format"
+  spec.version       = SoarJsonAuditingFormatter::VERSION
+  spec.authors       = ["Barney de Villiers"]
+  spec.email         = ["barney.de.villiers@hetzner.co.za"]
+
+  spec.summary       = %q{SOAR JSON auditing format}
+  spec.description   = %q{SOAR JSON auditing format that will define auditing event entries}
+  spec.homepage      = "https://github.com/hetznerZA/soar_json_auditing_format"
+  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"
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: soar_json_auditing_format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Barney de Villiers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-10 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'
+description: SOAR JSON auditing format that will define auditing event entries
+email:
+- barney.de.villiers@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/soar_json_auditing_format.rb
+- lib/soar_json_auditing_format/formatter.rb
+- lib/soar_json_auditing_format/version.rb
+- retry.sh
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
+- soar_json_auditing_format.gemspec
+homepage: https://github.com/hetznerZA/soar_json_auditing_format
+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: SOAR JSON auditing format
+test_files: []