soar_smaak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37ab95cb119f68e830f45587aa09c336ac5f11b2
+  data.tar.gz: 731e14a0d878053d7b71ddee74dc69be3213469a
+SHA512:
+  metadata.gz: dd6abe2f923047b0ebe092c26cea8c01e364629b36fc91a5f24adbe0949865f3f34c6521f0a6f0af9bbd9450eaeb6e12b43d80a2fb22f23c44be0a71c12aab11
+  data.tar.gz: 18f28528d0518a32fe936868f23091705bf76047522fed6b3b02327770001bbb6dbdec65a7f874bcf59060bfb0f69fa8f340ea87721b73633363af3170e07086

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+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 soar_smaak.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,88 @@
+# SoarSmaak
+
+This library offers Rack middle-ware for SMAAK communication. SoarSmaak::Router will refuse request in case of any failure with a 500. Requests are examined to determine whether the route the request is destined for requires message signing, or whether the request itself is a SMAAK request. If either are true, the SMAAK message is interpreted and verified. The message is decrypted if it was encrypted, and passed to the rack application stack unencrypted, only if the signature is verified. After processing by the application stack, responses are signed into SMAAK responses, and encrypted if the authorization message indicated it should be. Non-SMAAK messages are passed through to the application stack without interpretation or verification.
+
+## Dependencies
+
+### configuration
+
+A dictionary including a SMAAK public and private key identifying the service component in question, as well as an optional associations dictionary with the identity and public key and pre-shared key of associations that the SMAAK middleware should verify. An example follows:
+
+```
+public_key: |
+  -----BEGIN RSA PRIVATE KEY-----
+  MIICIdfsAKCAgEAsfB2D/ZZKyDB7YuZBzD1JghlkjglfdgloskzseFs1qiVLXks3
+  ...
+  -----END RSA PUBLIC KEY-----
+private_key: |
+  -----BEGIN RSA PRIVATE KEY-----
+  MIIJKgIBAAKCAgEAsfB2D/ZZKyDB7YuZBzD1Jgh5kiWqOLjtpBkzseFs1qiVLX/S
+  ...
+  -----END RSA PRIVATE KEY-----
+associations:
+  i-can.identify-this.server:
+    public_key: |
+      -----BEGIN RSA PUBLIC KEY-----
+      MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAyt2nPgdfE/Osc2HQ8ZT0
+      -----END RSA PUBLIC KEY-----
+    psk: 655U0Rw6Rk12
+```
+
+### signed_routes
+
+A dictionary of paths and an indication whether the route is signed, e.g.
+
+```
+  { "/secure-service" => true,
+    "/another-service" => false }
+```
+
+### auditing
+
+An auditing provider that adheres to the API specified here: https://rubygems.org/gems/soar_auditor_api. If an auditing provider is not present, $stderr will be used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_smaak'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_smaak
+
+## Usage
+
+In your application builder, set SOAR aspects that SoarSmaak depend on:
+
+```
+SoarAspects::config = @config
+SoarAspects::signed_routes = @signed_routes
+SoarAspects::auditing = @auditing
+use SoarAspects
+```
+
+Then add the SMAAK middleware router:
+
+```
+use SoarSmaak::Router
+```
+
+## Contributing
+
+Please send feedback and comments to the author at:
+
+Ernst van Graan <ernst.van.graan@hetzner.co.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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar_smaak"
+
+# 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_smaak/interpreter.rb

@@ -0,0 +1,10 @@
+require 'smaak'
+
+module SoarSmaak
+  class Interpreter
+    def self.smaak_request?(request)
+      auth_header = ::Smaak::RackAdaptor.new(request).header("authorization")
+      (not (auth_header.nil?)) and (auth_header.include?("x-smaak"))
+    end  
+  end
+end

data/lib/soar_smaak/router.rb

@@ -0,0 +1,59 @@
+module SoarSmaak
+  class Router
+    attr_reader :configuration
+
+    def initialize(app)
+      @app = app
+    end
+
+    def smaak(request)
+      @auditing.debug("Smaak: verifying request")
+      auth_message, body = @server.verify_signed_request(request)
+      @auditing.debug("Smaak: auth_message: #{auth_message}")
+      return auth_message, body
+    end
+
+    def call(env)
+      @configuration = env['config']
+      @auditing = env['auditing']
+      @signed_routes = env['signed_routes']
+      SoarSmaak::SecureService::auditing = @auditing
+      secure_service = SoarSmaak::SecureService.get_instance(@configuration)
+      @server = secure_service.smaak_server
+      @auditing.debug("Smaak: signed routes are: #{@signed_routes}")
+      request = Rack::Request.new(env)
+      if SoarSmaak::Interpreter::smaak_request?(request) or @signed_routes[request.path]
+        @auditing.debug("Smaak: routing smaak request")
+        auth_message, body = smaak(request)
+        return [403, {}, [" 403 - Not authorized"]] if not auth_message.identifier
+        @auditing.debug("Smaak: request authorized for #{auth_message.identifier}")
+        env["rack.input"] = body
+      else
+        @auditing.debug("routing non-smaak request")
+      end
+
+      http_code, content_type, body = @app.call(env)
+
+      if SoarSmaak::Interpreter::smaak_request?(request) or @signed_routes[request.path]
+        @auditing.debug("Smaak: request authorized for #{auth_message.identifier}")
+        return [http_code, content_type, [@server.compile_response(auth_message, body[0])]] if auth_message.encrypt
+        return [http_code, content_type, @server.compile_response(auth_message, body)]
+      else
+        return http_code, content_type, body
+      end
+    rescue => ex
+      puts ex
+      [500, {"Content-Type" => "text/html"}, ['Unable to route request on SMAAK route. Was your request a SMAAK request?']]
+    end
+
+    private
+
+    def debug(message)
+      if @auditing
+        @auditing.debug(message)
+      else
+        $stderr.puts(message)
+      end
+    end
+  end
+end

data/lib/soar_smaak/secure_service.rb

@@ -0,0 +1,62 @@
+module SoarSmaak
+  class SecureService < ::Smaak::SmaakService
+    attr_reader :dynamic
+    attr_reader :trust_store
+    @@auditing
+
+    def self.auditing=(auditing)
+      @@auditing = auditing
+    end
+
+    def self.smaak_configured?(configuration)
+      (not configuration['public_key'].nil?) and
+      (not configuration['private_key'].nil?) and
+      (not configuration['associations'].nil?)
+    end
+
+    def self.smaak_dynamic?(configuration)
+      configuration['smaak'] and (configuration['smaak'].downcase.strip == 'dynamic')
+    end
+
+    def configure_services(configuration)
+      if (not SoarSmaak::SecureService::smaak_configured?(configuration) and
+          SoarSmaak::SecureService::smaak_dynamic?(configuration))
+        seed_dynamic_smaak
+      elsif (SoarSmaak::SecureService::smaak_configured?(configuration))
+        configure_smaak(configuration)
+      else
+        @@auditing.debug "SMAAK is neither dynamic nor configured. SMAAK support disabled"
+      end
+    end
+
+    def seed_dynamic_smaak
+      @@auditing.debug "SMAAK credentials not provided."
+      load_smaak_trust_store
+      randomize_smaak
+    end
+
+    def randomize_smaak
+      @dynamic = @trust_store.associations.keys[rand(@trust_store.associations.keys.size) + 1]
+      @@auditing.debug "Seeding random key-pair and identifier"
+      @smaak_server.set_public_key(@trust_store.associations[@dynamic]['public_key'])
+      @smaak_server.set_private_key(@trust_store.associations[@dynamic]['private_key'])
+      @smaak_server.verify_recipient = false
+    end
+
+    def load_smaak_trust_store
+      @trust_store = SoarSmaak::SmaakTrustStore.new
+      @trust_store.associations.each do |identifier, config|
+        @smaak_server.add_association(identifier, config['public_key'], config['psk'], config['encrypt'])
+      end
+    end
+
+    def configure_smaak(configuration)
+      @smaak_server.set_public_key(configuration['public_key'])
+      @smaak_server.set_private_key(configuration['private_key'])
+      configuration['associations'].each do |identifier, config|
+        @smaak_server.add_association(identifier, config['public_key'], config['psk'], config['encrypt'])
+      end
+      @@auditing.debug "SMAAK credentials provided. SMAAK configured"
+    end
+  end
+end

data/lib/soar_smaak/smaak_trust_store.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+
+module SoarSmaak
+  class SmaakTrustStore
+    attr_reader :associations
+
+    def initialize
+      @errors = []
+      @associations = YAML.load_file('config/smaak_trust_store')['associations']
+
+    rescue => e
+      message = "Could not load SMAAK trust store. Is it YAML?"
+      @errors << message
+      @errors << e.message
+      raise ArgumentError.new(message)
+    end
+  end
+end

data/lib/soar_smaak/version.rb

@@ -0,0 +1,3 @@
+module SoarSmaak
+  VERSION = "0.1.0"
+end

data/lib/soar_smaak.rb

@@ -0,0 +1,15 @@
+require 'openssl'
+require 'base64'
+require 'digest'
+require 'rack'
+require 'smaak'
+require 'smaak/smaak_service'
+require "soar_smaak/version"
+require "soar_smaak/interpreter"
+require "soar_smaak/smaak_trust_store"
+require "soar_smaak/router"
+require "soar_smaak/secure_service"
+
+module SoarSmaak
+
+end

data/soar_smaak.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_smaak/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_smaak"
+  spec.version       = SoarSmaak::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{Rack middle-ware for supporting SMAAK communication}
+  spec.description   = %q{Rack middle-ware for supporting SMAAK communication}
+  spec.homepage      = "https://github.com/hetznerZA/soar_smaak"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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_dependency "rack", "~> 1.6.4"
+  spec.add_dependency "smaak", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: soar_smaak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: smaak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !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: 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'
+- !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'
+description: Rack middle-ware for supporting SMAAK communication
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_smaak.rb
+- lib/soar_smaak/interpreter.rb
+- lib/soar_smaak/router.rb
+- lib/soar_smaak/secure_service.rb
+- lib/soar_smaak/smaak_trust_store.rb
+- lib/soar_smaak/version.rb
+- soar_smaak.gemspec
+homepage: https://github.com/hetznerZA/soar_smaak
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middle-ware for supporting SMAAK communication
+test_files: []