authentication_identifier_transposer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c71709f3bc73521b8a9bd81f60c4328f23d4985a
+  data.tar.gz: 3c848e086b4cf5cc43c9877df03e1d7c5194d682
+SHA512:
+  metadata.gz: 94c3b281371b97c732d830e70d8ef6ce4ea6fffa91c97f7bec6fd1f660bb5a7647b30b2b4729e8c2b06aa8fc66cc28ab73d92ef2bb2df6447d808cd7f74471cf
+  data.tar.gz: 42350ec80f937679a7a61438a37ed6df849e7648cfa9a5a10684bb7104aedaae1b1a82dcc523bec1260300637eb0abdea00ac185a2f1388f4064ac68f500ec8f

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+*.gem
+.byebug_history
+coverage

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+authentication_identifier_transposer

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

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,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# AuthenticationIdentifierTransposer
+
+This gem provides Rack Middleware transposing the authenticated identifier for Soar SC
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'authentication_identifier_transposer'
+```
+
+And then execute:
+```bash
+bundle
+```
+
+Or install it yourself as:
+```bash
+gem install authentication_identifier_transposer
+```
+
+## 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 tests
+docker-compose down
+```
+
+## Usage
+
+### RackMiddleware
+
+```ruby
+  use AuthenticationIdentifierTransposer::RackMiddleware
+```
+
+This middleware will perform the simple action of looking for the authenticated identifier in the HTTP header 'X-GATEWAY-AUTHENTICATED-IDENTIFIER' and copy that to the request.session['user'] and request.env['REMOTE_USER'] request variables where SoarAuthentication can pick it up from.
+
+## 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)
+
+
+## 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"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)

data/authentication_identifier_transposer.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authentication_identifier_transposer/version'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "authentication_identifier_transposer"
+  spec.version       = AuthenticationIdentifierTransposer::VERSION
+  spec.authors       = ["Barney de Villiers"]
+  spec.email         = ["barney.de.villiers@hetzner.co.za"]
+  spec.description   = %q{Rack Middleware transposing the authenticated identifier for Soar SC}
+  spec.summary       = %q{Rack Middleware transposing the authenticated identifier into something that is Soar SC friendly, this is to be used only when a Soar SC component is behind a gateway handling authentication.}
+  spec.homepage      = "https://gitlab.host-h.net/hetznerZA/authentication-identifier-transposer-rack-middleware"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", '>= 1.6.4', '< 3.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency "capybara", '~> 2.1', '>= 2.1.0'
+  spec.add_development_dependency "simplecov", '~> 0'
+  spec.add_development_dependency "simplecov-rcov", '~> 0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "authentication_identifier_transposer"
+
+# 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/keypair-generator

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'authentication_identifier_transposer'
+require 'yaml'
+require 'json'
+
+class Main
+
+  def generate_keypair
+    #create and configure auditing instance
+    keypair_generator = AuthenticationIdentifierTransposer::KeypairGenerator.new
+    private_key, public_key = keypair_generator.generate
+    configuration = {
+      'private_key' => private_key,
+      'public_key' => public_key
+    }
+    puts "------------"
+    puts "YAML Format:"
+    puts "------------"
+    print configuration.to_yaml
+    puts ""
+    puts "------------"
+    puts "JSON Format:"
+    puts "------------"
+    print configuration.to_json
+    puts ""
+    puts ""
+    puts "------------"
+
+  end
+end
+
+main = Main.new
+main.generate_keypair

data/bin/rotate-configs

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'authentication_identifier_transposer'
+require 'thor'
+
+class RotateConfigCLI < Thor
+  desc "rotate [OPTIONS]", "rotate configurations"
+  option :generator_config_file,  :aliases => '-g',  :desc => 'Configuration file of the generator'
+  option :validator_config_file,  :aliases => '-v',  :desc => 'Configuration file of the validator'
+  def rotate
+    raise 'generator_config_file must be specified' unless options['generator_config_file']
+
+    rotator = AuthenticationIdentifierTransposer::ConfigRotator.new
+    rotator.rotate_json_config_files(generator_file_name: options['generator_config_file'],
+                                     validator_file_name: options['validator_config_file'])
+  end
+  default_task :rotate
+end
+
+RotateConfigCLI.start(ARGV)

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,9 @@
+version: '2.0'
+services:
+  tests:
+    command: /bin/bash -c 'bundle exec rspec -cfd ./spec/'
+    user: $UID:$UID
+    build: .
+    image: tests
+    volumes:
+      - .:/usr/local/src/

data/lib/authentication_identifier_transposer.rb

@@ -0,0 +1,5 @@
+module AuthenticationIdentifierTransposer
+end
+
+require 'authentication_identifier_transposer/rack_middleware'
+require 'authentication_identifier_transposer/version'

data/lib/authentication_identifier_transposer/rack_middleware.rb

@@ -0,0 +1,19 @@
+require 'rack'
+
+module AuthenticationIdentifierTransposer
+  class RackMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new env
+      authenticated_identifier = request.env['HTTP_X_GATEWAY_AUTHENTICATED_IDENTIFIER']
+      if authenticated_identifier
+        request.session['user']    = authenticated_identifier
+        request.env['REMOTE_USER'] = authenticated_identifier
+      end
+      return @app.call env
+    end
+  end
+end

data/lib/authentication_identifier_transposer/version.rb

@@ -0,0 +1,3 @@
+module AuthenticationIdentifierTransposer
+  VERSION = '1.0.0'
+end

data/spec/rack_middleware_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'rack'
+require 'rack/test'
+
+describe AuthenticationIdentifierTransposer::RackMiddleware do
+  include Rack::Test::Methods
+
+  before :each do
+    @test_app = lambda do |env|
+      request = Rack::Request.new env
+      session = request.session
+      test_app_response_data = {
+        'message' => "tested",
+        'session_user' => request.session['user'],
+        'remote_user' => request.env['REMOTE_USER']
+      }
+      [200, {"Content-Type" => "application/json"}, test_app_response_data ]
+    end
+    @iut = AuthenticationIdentifierTransposer::RackMiddleware.new(@test_app)
+  end
+
+  context "when initialized" do
+    it 'remembers the app provided' do
+      expect(@iut.instance_variable_get("@app")).to eq(@test_app)
+    end
+  end
+
+  context "when called with a request environment" do
+    context 'with X-GATEWAY-AUTHENTICATED-IDENTIFIER header' do
+      it "pass requests to the application" do
+        opts = { 'X-GATEWAY-AUTHENTICATED-IDENTIFIER' => 'test_uuid' }
+        code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
+        expect([code, env, body['message']]).to eq([200, {"Content-Type"=>"application/json"}, "tested"])
+      end
+
+      it "set the user key in the request session" do
+        opts = { 'X-GATEWAY-AUTHENTICATED-IDENTIFIER' => 'test_uuid' }
+        code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
+        expect(body['session_user']).to eq 'test_uuid'
+      end
+
+      it "set the remote user in the request environment" do
+        opts = { 'X-GATEWAY-AUTHENTICATED-IDENTIFIER' => 'test_uuid' }
+        code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
+        expect(body['remote_user']).to eq 'test_uuid'
+      end
+    end
+
+    context 'without X-GATEWAY-AUTHENTICATED-IDENTIFIER header' do
+      it "pass requests to the application" do
+        opts = { }
+        code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
+        expect([code, env, body['message'], body['session_user'], body['remote_user']]).to eq([200, {"Content-Type"=>"application/json"}, "tested", nil, nil])
+      end
+
+      it "does not modify the user key in the request session" do
+        opts = { }
+        code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
+        expect(body['session_user']).to eq nil
+      end
+
+      it "does not modify the remote user in the request environment" do
+        opts = { }
+        code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
+        expect(body['remote_user']).to eq nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../spec/support', __FILE__)
+
+require 'authentication_identifier_transposer'

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: authentication_identifier_transposer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Barney de Villiers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-12 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-rcov
+  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: Rack Middleware transposing the authenticated identifier for Soar SC
+email:
+- barney.de.villiers@hetzner.co.za
+executables:
+- console
+- keypair-generator
+- rotate-configs
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- authentication_identifier_transposer.gemspec
+- bin/console
+- bin/keypair-generator
+- bin/rotate-configs
+- bin/setup
+- docker-compose.yml
+- lib/authentication_identifier_transposer.rb
+- lib/authentication_identifier_transposer/rack_middleware.rb
+- lib/authentication_identifier_transposer/version.rb
+- spec/rack_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://gitlab.host-h.net/hetznerZA/authentication-identifier-transposer-rack-middleware
+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 Middleware transposing the authenticated identifier into something that
+  is Soar SC friendly, this is to be used only when a Soar SC component is behind
+  a gateway handling authentication.
+test_files:
+- spec/rack_middleware_spec.rb
+- spec/spec_helper.rb