rack-micro_service-signed_request 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9345159dec6b0133d73adb70efb48f806590a1d9
+  data.tar.gz: dfa7e9e0694d10fdeeb5def35adc0ad4735ab689
+SHA512:
+  metadata.gz: 788c806a6d3d7b706f288bad991ffb64cac08bfd5263d76f2673a8010dd4336f79035e333b58b4d19fb343c6074b5cf9e3ea9ebaa11b21fd1e94c12f7d593496
+  data.tar.gz: 49d087f9e11fddcd331ca62b2412cebe5d0fcae3e41212a8ad500c92ea2c396126d063c05528910bbb21cce2d473dbfe561d7763d2def11e52c6e522f44223b7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :test do
+	gem 'json', '>= 1.8.1', :platforms => [:jruby, :ruby_18, :ruby_19]
+	gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
+	gem 'rack-test'
+end
+
+# Specify your gem's dependencies in rack-jive-signed_request.gemspec
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+[![Gem Version](https://badge.fury.io/rb/rack-micro_service-signed_request.svg)](http://badge.fury.io/rb/rack-micro_service-signed_request)
+[![Build Status](https://travis-ci.org/butchmarshall/rack-micro_service-signed_request.svg?branch=master)](https://travis-ci.org/butchmarshall/rack-micro_service-signed_request)
+
+# MicroService Signed Request Middleware
+
+`Rack::MicroService::SignedRequest` provides support for handling `MicroService` signed requests in Rack compatible applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-micro_service-signed_request', :require => 'rack-micro_service-signed_request'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-micro_service-signed_request
+
+# Configuration
+
+## Rack
+
+In the `config.ru`
+
+```ruby
+use Rack::MicroService::SignedRequest
+	# Your app might support multiple MicroService instances
+	# This block allows you to determine what secret to use based on the Authorization header
+	secret do |auth_header_params|
+		"this_should_be_the_app_secret_for_authentication_header_params"
+	end
+end
+```
+
+## Rails
+
+In `config/application.rb`
+```ruby
+module ExampleApp
+	class Application < Rails::Application
+		config.middleware.use "Rack::MicroService::SignedRequest" do
+			# Your app might support multiple MicroService instances
+			# This block allows you to determine what secret to use based on the Authorization header
+			secret do |auth_header_params|
+				"this_should_be_the_app_secret_for_authentication_header_params"
+			end
+		end
+	end
+end
+```
+
+# Usage
+
+`request.env['micro_service.user_id']` will be populated with the authenticated users MicroService ID
+
+`request.env['micro_service.email']` will be populated with the authenticated users MicroService Email
+
+`request.env['micro_service.tenant_id']` will be populated with add-ons tenant_id
+
+`request.env['micro_service.client_id']` will be populated with add-ons client_id
+
+`request.env['micro_service.errors.signed_request']` will be populated if there was an error authenticating the signed request
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-micro_service-signed_request.
+
+
+## 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 "rack/micro_service/signed_request"
+
+# 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/rack/micro_service/signed_request.rb

@@ -0,0 +1,59 @@
+require "rack"
+require "rack/request"
+require "rack/micro_service/signed_request/version"
+
+require "micro_service/signed_request/utils"
+
+module Rack
+	module MicroService
+		class SignedRequest
+			def initialize(app, opts={}, &block)
+				@app = app
+
+				if block_given?
+					if block.arity == 1
+						block.call(self)
+					else
+						instance_eval(&block)
+					end
+				end
+			end
+
+			def call(env)
+				request = Request.new(env)
+
+				# Prefix to look for in Authorization header
+				header_prefix = (!@prefix.nil?) ? @prefix.call() : "MicroService"
+
+				# Only bother authenticating if the request is identifying itself as signed
+				if env["HTTP_X_SHINDIG_AUTHTYPE"] === "signed" || env["HTTP_AUTHORIZATION"].to_s.match(/^#{header_prefix}/)
+					auth_header_params = ::CGI.parse env["HTTP_AUTHORIZATION"].gsub(/^#{header_prefix}\s/,'')
+
+					begin
+						secret = @secret.call(auth_header_params)
+						if ::MicroService::SignedRequest::Utils.validate(env["HTTP_AUTHORIZATION"], secret, header_prefix)
+							env["micro_service.client_id"] = auth_header_params["client_id"].first
+						else
+							env["micro_service.errors.signed_request"] = "AUTHENTICATION_ERROR"
+						end
+					rescue ArgumentError => $e
+						env["micro_service.errors.signed_request"] = $e.message
+					end
+				end
+
+				@app.call(env)
+			end
+
+			def secret(&block)
+				@secret = block
+			end
+
+			def prefix(&block)
+				@prefix = block
+			end
+		end
+
+		class Request < ::Rack::Request
+		end
+	end
+end

data/lib/rack/micro_service/signed_request/version.rb

@@ -0,0 +1,7 @@
+module Rack
+	module MicroService
+		class SignedRequest
+			VERSION = "0.0.1"
+		end
+	end
+end

data/rack-micro_service-signed_request.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/micro_service/signed_request/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "rack-micro_service-signed_request"
+	spec.version       = Rack::MicroService::SignedRequest::VERSION
+	spec.authors       = ["Butch Marshall"]
+	spec.email         = ["butch.a.marshall@gmail.com"]
+	
+	spec.summary       = %q{Rack middleware for MicroService signed requests.}
+	spec.description   = %q{Authenticates signed server requests from a MicroService and resolves the MicroService.}
+	spec.homepage      = "https://github.com/butchmarshall/rack-micro_service-signed_request"
+	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_dependency "micro_service-signed_request-utils"
+
+	spec.add_development_dependency "bundler", "~> 1.10"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec"
+
+	spec.add_runtime_dependency "rack", ">= 1.1"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rack-micro_service-signed_request
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Butch Marshall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: micro_service-signed_request-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Authenticates signed server requests from a MicroService and resolves
+  the MicroService.
+email:
+- butch.a.marshall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/micro_service/signed_request.rb
+- lib/rack/micro_service/signed_request/version.rb
+- rack-micro_service-signed_request.gemspec
+homepage: https://github.com/butchmarshall/rack-micro_service-signed_request
+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.6
+signing_key: 
+specification_version: 4
+summary: Rack middleware for MicroService signed requests.
+test_files: []