devise_lulibrary_jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ba06053aa2d59bd2cf574be161a11aefe869068
+  data.tar.gz: c35e30ee6925c99668a0050f67ee5c4c91fe359d
+SHA512:
+  metadata.gz: 64cbedc362dc044d446397f2b0f1a46405cbbe0950d0f147443c4884b3cbda04b40173895c5134cee264f0e361be5c18cafa46bb58175830c00e94f475762592
+  data.tar.gz: 2e3c8e4d06c246f2c0cb1eb36c9e4e3bd2192689b1e58193917e40eecca226f6b0a2df74cfeb58be3859178006c66a6890d1de3cf7e58791824c4f22b1ab3018

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+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 devise_lulibrary_jwt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stephen Robinson
+
+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,50 @@
+# Devise LULibrary JWT
+
+Provides a simple devise authentication strategy for authenticating by JSON Web Tokens (JWTs) passed either as a GET parameter or as an Authorization header.
+
+Designed to be used with our JWT Server package which provides a central server to authenticate users behind CoSign or similar service that provides a JWT to be used for authentication with other services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise_lulibrary_jwt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise_lulibrary_jwt
+
+## Usage
+
+After installing the gem add the following to the model you wish to use for authentication.
+
+`devise :jwt_authenticatable, :authentication_keys => [:username], :jwt_create_user => true`
+
+The options of `authentication_keys` and `jwt_create_user` allow for multiple models to be used with different configuration options, be this using different authentication keys or changed whether the strategy only looks up a user compared to creating the user if they don't exist.
+
+Within the global devise config the following options can be configured, the only required values are `jwt_secret`, `jwt_issuer` and `jwt_audience`.
+
+| Parameter | Description |
+| --- | --- |
+| jwt_secret | The secret used to verify the integrity of the JWT (required) |
+| jwt_issuer | The issuer of the JWT (required) |
+| jwt_audience | The audience for the JWT (required) |
+| verify_aud | Boolean for whether to verify the token audience (false allows for jwt_audience to be nil) |
+| verify_iss | Boolean for whether to verify the token issuer (false allows for jwt_issuer to be nil) |
+| verify_iat | Boolean for whether to verify the issued at timestamp of the token |
+| jwt_create_user | Boolean - Global option for whether to create a user if they don't exist (true) or to just find existing users (false). Can be overridden by setting :jwt_create_user on the devise config line of the model. |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lulibrary/devise_lulibrary_jwt.
+
+
+## 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 "devise_lulibrary_jwt"
+
+# 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/devise_lulibrary_jwt.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise_lulibrary_jwt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_lulibrary_jwt"
+  spec.version       = DeviseLulibraryJwt::VERSION
+  spec.authors       = ["Stephen Robinson", "LULibrary"]
+  spec.email         = ["library.dit@lancaster.ac.uk"]
+
+  spec.summary       = "Devise extension to allow authentication using JWT"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/lulibrary/Devise-JWT"
+  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'] = "https://rubygems.org"
+  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 "devise", ">= 4.2.0"
+  spec.add_dependency "jwt", ">= 1.5.4"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/devise_lulibrary_jwt/model.rb

@@ -0,0 +1,41 @@
+require 'devise_lulibrary_jwt/strategy'
+
+module Devise
+  module Models
+    module JwtAuthenticatable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        Devise::Models.config(self, :jwt_create_user)
+
+        def find_for_jwt_authentication jwt_claims
+
+          auth_params = {}
+
+          jwt_keymap.each_pair { |k,v| auth_params[v] = jwt_claims[k] }
+
+          auth_key = self.authentication_keys.first.to_s
+          auth_key_value = auth_params[auth_key]
+
+          return nil unless auth_key_value.present?
+
+          resource = where(auth_key => auth_key_value).first
+
+          if resource.blank?
+            resource = new(auth_params)
+          end
+
+          if self.jwt_create_user && resource.new_record?
+            resource.save!
+          end
+
+          resource
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/devise_lulibrary_jwt/strategy.rb

@@ -0,0 +1,113 @@
+require 'devise/strategies/authenticatable'
+require 'jwt'
+
+module Devise
+  module Strategies
+    class JwtAuthenticatable < Authenticatable
+
+      def valid?
+        !jwt.nil? && !jwt.empty?
+      end
+
+      def authenticate!
+
+        resource = mapping.to.new
+
+        if validate(resource) { valid_jwt? }
+          if decode_jwt.nil?
+            fail!(:invalid_jwt)
+          else
+
+            resource = mapping.to.find_for_jwt_authentication jwt_claims
+
+            if resource.nil?
+              return fail!(:invalid_user)
+            end
+
+            if resource.persisted?
+              return success!(resource)
+            end
+
+            fail!(:invalid_user)
+
+          end
+        end
+
+      end
+
+      private
+
+      def bearer_token
+        pattern = /^Bearer /
+        header  = request.headers["Authorization"] # <= env
+        header.gsub(pattern, '') if header && header.match(pattern)
+      end
+
+      def jwt
+
+        if params[:jwt]
+          return  params[:jwt]
+        end
+
+        if  !bearer_token.nil? && !bearer_token.empty?
+          return bearer_token
+        end
+
+        nil
+
+      end
+
+      def jwt_claims
+
+        jwt = decode_jwt
+
+        if jwt.nil?
+          nil
+        else
+          jwt[0]
+        end
+
+      end
+
+      def decode_jwt
+
+        secret = ::Devise.jwt_secret
+
+        begin
+          decoded_token = JWT.decode jwt, secret, true, { :verify_iat => ::Devise.verify_iat, :iss => ::Devise.jwt_issuer, :verify_iss => ::Devise.verify_iss, :aud => ::Devise.jwt_audience, :verify_aud => ::Devise.verify_aud, :algorithm => 'HS256'}
+        rescue JWT::ExpiredSignature
+          Rails.logger.info('Expired Signature')
+          return nil
+        rescue JWT::InvalidIssuerError
+          Rails.logger.info('Invalid Issuer Error')
+          return nil
+        rescue JWT::InvalidAudError
+          Rails.logger.info('Invalid Audience')
+          return nil
+        rescue JWT::InvalidIatError
+          Rails.logger.info('Invalid issued at')
+          return nil
+        rescue JWT::VerificationError
+          Rails.logger.info('Signature Verification error')
+          return nil
+        end
+
+        decoded_token
+
+      end
+
+      def valid_jwt?
+
+        if decode_jwt.nil?
+          return nil
+        end
+
+        true
+
+      end
+
+    end
+  end
+end
+
+Warden::Strategies.add(:jwt_authenticatable, Devise::Strategies::JwtAuthenticatable)

data/lib/devise_lulibrary_jwt/version.rb

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

data/lib/devise_lulibrary_jwt.rb

@@ -0,0 +1,32 @@
+require 'devise'
+
+require "devise_lulibrary_jwt/version"
+require 'devise_lulibrary_jwt/strategy'
+require 'devise_lulibrary_jwt/model'
+
+module Devise
+
+  mattr_accessor :jwt_secret
+  @@jwt_secret = nil
+
+  mattr_accessor :jwt_issuer
+  @@jwt_issuer = nil
+
+  mattr_accessor :jwt_audience
+  @@jwt_audience = nil
+
+  mattr_accessor :verify_aud
+  @@verify_aud = true
+
+  mattr_accessor :verify_iss
+  @@verify_iss = true
+
+  mattr_accessor :verify_iat
+  @@verify_iat = true
+
+  mattr_accessor :jwt_create_user
+  @@jwt_create_user = true
+
+end
+
+Devise.add_module(:jwt_authenticatable, strategy: true, model: 'devise_lulibrary_jwt/model')

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: devise_lulibrary_jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Robinson
+- LULibrary
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !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: 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: Devise extension to allow authentication using JWT
+email:
+- library.dit@lancaster.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- devise_lulibrary_jwt.gemspec
+- lib/devise_lulibrary_jwt.rb
+- lib/devise_lulibrary_jwt/model.rb
+- lib/devise_lulibrary_jwt/strategy.rb
+- lib/devise_lulibrary_jwt/version.rb
+homepage: https://github.com/lulibrary/Devise-JWT
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1
+signing_key: 
+specification_version: 4
+summary: Devise extension to allow authentication using JWT
+test_files: []