rack-indicium 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2c76d792fe805b3a669ecb042fa8842707e9ca7
+  data.tar.gz: 1012a5a357b0c0d8bb8b37b3df7760a75caddc99
+SHA512:
+  metadata.gz: d9b41b6559bf5e2466f233fed93bfaaafa72ded1b8e7f54587ffc6dbdda69f8c422509013241f0d3b56cfd50d43becfbf530706917b256b3d10a702f6c8fa52c
+  data.tar.gz: d2716be198f797d4c30e3e8adfc0a666511669da1a2d8be5ccb964dfea2a3ab4a198e4f59a383f535592ce555c3dd58027af9f056e1b6c07626b4d7e0ca08a81

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-indicium.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Twingly AB
+
+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,71 @@
+# Rack::Indicium
+
+[![Build Status](https://magnum.travis-ci.com/twingly/rack-indicium.svg?token=ADz8fWxRD3uP4KZPPZQS&branch=master)](https://magnum.travis-ci.com/twingly/rack-indicium)
+
+If a [JSON Web Token (JWT)](http://jwt.io/) is sent in the header, it will be decoded and available in the `jwt.payload` and `jwt.header` rack `env` variables.
+
+Optional integration with [Sentry Raven] for jwt-context to exceptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-indicium'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-indicium
+
+## Usage
+
+```Ruby
+require "rack/indicium"
+require "rack/indicium/sentry" # Optional to add jwt context to Sentry
+use Rack::Indicium, ENV.fetch("JWT_SECRET")
+use Rack::Indicium::Sentry # Add after use Raven::Rack
+run App
+```
+
+Once the middleware is included you get access to `jwt.header` and `jwt.payload` in the `env` object.
+
+```Ruby
+# It will only be set if there's a valid JWT that is verified with the jwt secret
+payload = env.fetch("jwt.payload") { nil }
+```
+
+This could then be used for authorization
+
+```Ruby
+# Only allow requests from our clients
+def authorized?
+  payload = env.fetch("jwt.payload") { {} }
+  payload["aud"] == ENV.fetch("CLIENT_ID")
+end
+```
+
+If you need custom options to decode JWT, override the decoder:
+
+```Ruby
+require "rack/indicium"
+
+unsafe_decoder = lambda { |jwt, secret| JWT.decode(jwt, secret, true, verify_expiration: false) }
+
+use Rack::Indicium, ENV.fetch("JWT_SECRET"), unsafe_decoder
+run App
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/twingly/rack-indicium/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[Sentry Raven]: https://github.com/getsentry/raven-ruby

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+task(default: :spec)

data/lib/rack/indicium.rb

@@ -0,0 +1,44 @@
+require "rack/indicium/version"
+require "jwt"
+
+module Rack
+  class Indicium
+
+    HTTP_AUTHORIZATION = "HTTP_AUTHORIZATION".freeze
+    BEARER_REGEXP = /\ABearer /i
+
+    def initialize(app, secret, decoder = nil)
+      @app = app
+
+      @secret = secret
+      @decoder = decoder || lambda { |jwt, secret| JWT.decode(jwt, secret) }
+    end
+
+    def call(env)
+      look_for_authorization_header(env)
+
+      @app.call(env)
+    end
+
+    def look_for_authorization_header(env)
+      authorization_header = env[HTTP_AUTHORIZATION]
+      return unless authorization_header
+
+      _, jwt = authorization_header.split(BEARER_REGEXP)
+      return unless jwt
+
+      jwt_payload, jwt_header = decode(jwt)
+
+      return unless jwt_payload
+      return unless jwt_header
+
+      env["jwt.payload"] = jwt_payload
+      env["jwt.header"]  = jwt_header
+    end
+
+    def decode(jwt)
+      @decoder.call(jwt, @secret)
+    rescue
+    end
+  end
+end

data/lib/rack/indicium/sentry.rb

@@ -0,0 +1,38 @@
+require "rack/indicium/version"
+
+module Rack
+  class Indicium
+    class Sentry
+      def initialize(app)
+        @app = app
+
+        if defined?(Raven)
+          @sentry_client = Raven
+        else
+          warn "%s: Raven not definied, can't send JWT headers to Sentry." % self.class.to_s
+        end
+      end
+
+      def call(env)
+        check_for_jwt(env) if enabled?
+        @app.call(env)
+      end
+
+      def check_for_jwt(env)
+        context = {
+          "jwt.header" => env["jwt.header"],
+          "jwt.payload" => env["jwt.payload"],
+        }
+        client.extra_context(context)
+      end
+
+      def client
+        @sentry_client
+      end
+
+      def enabled?
+        !!@sentry_client
+      end
+    end
+  end
+end

data/lib/rack/indicium/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Indicium
+    VERSION = "1.0.0"
+  end
+end

data/rack-indicium.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/indicium/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-indicium"
+  spec.version       = Rack::Indicium::VERSION
+  spec.authors       = ["Twingly AB"]
+  spec.email         = ["support@twingly.com"]
+
+  spec.summary       = %q{Rack JWT helpers}
+  spec.description   = "Rack middleware to decode JWT and append it to the rack environment"
+  spec.homepage      = "https://github.com/twingly/rack-indicium"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jwt", "~> 1.4"
+  spec.add_dependency  "rack", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+  spec.add_development_dependency "grape", "~> 0.11"
+  spec.add_development_dependency "json", "~> 1.7"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rack-indicium
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Twingly AB
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Rack middleware to decode JWT and append it to the rack environment
+email:
+- support@twingly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/indicium.rb
+- lib/rack/indicium/sentry.rb
+- lib/rack/indicium/version.rb
+- rack-indicium.gemspec
+homepage: https://github.com/twingly/rack-indicium
+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.5
+signing_key: 
+specification_version: 4
+summary: Rack JWT helpers
+test_files: []