DMAO-WardenJWT 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0968f9f144a37bb4db7bda7ff8ddce80a9fcee3b
+  data.tar.gz: ea6a42261e86932bd62c3a8439bebff478796cde
+SHA512:
+  metadata.gz: 51182564008f72aa5b7569b0f4f3f8d7723cc8db5b1383cfe677b3afc11057b52fc77ec7f572ae7c0c71254428a4ed4a9705d96b47bb73068d4ce87f2ea50796
+  data.tar.gz: 8602006bf45eabb12fc725a5728fd3bcbdac991f297bcc6f926d7c4de50a1eef359e4348bd1c8198cf6ea818b58aae402c02c91d222766346438c391dbebc7be

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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,41 @@
+# WardenJWT
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/WardenJWT`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'WardenJWT'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install WardenJWT
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/WardenJWT.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/WardenJWT.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'DMAO/WardenJWT/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "DMAO-WardenJWT"
+  spec.version       = DMAO::WardenJWT::VERSION
+  spec.authors       = ["Stephen Robinson", "LULibrary", "Digitial Innovation, Lancaster University Library"]
+  spec.email         = ["stephen@stephen-robinson.co.uk"]
+
+  spec.summary       = %q{Warden Strategy for DMA Online JWT Auth}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/lulibrary/DMAO-WardenJWT"
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "warden", "~> 1.2"
+  spec.add_dependency "jwt", "~> 1.5"
+
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "WardenJWT"
+
+# 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/DMAO/WardenJWT.rb

@@ -0,0 +1,7 @@
+require "DMAO/WardenJWT/version"
+
+module DMAO
+  module WardenJWT
+    # Your code goes here...
+  end
+end

data/lib/DMAO/WardenJWT/strategy.rb

@@ -0,0 +1,105 @@
+require 'DMAO/WardenJWT/user'
+require 'warden'
+require 'jwt'
+require 'logger'
+
+module DMAO
+  module WardenJWT
+    class Strategy < ::Warden::Strategies::Base
+
+      def valid?
+        !jwt.nil? && !jwt.empty?
+      end
+
+      def authenticate!
+
+        valid_jwt? ? success!(User.from_jwt_claims(jwt_claims)) : fail!(:invalid_jwt)
+
+      end
+
+      def store?
+        false
+      end
+
+      def bearer_token
+        pattern = /^Bearer /
+        header  = request.get_header('HTTP_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
+
+        logger = ::Logger.new(STDOUT)
+
+        verify_iat = ENV['JWT_VERIFY_IAT']
+        verify_aud = ENV['JWT_VERIFY_AUD']
+        verify_iss = ENV['JWT_VERIFY_ISS']
+        jwt_secret = ENV['JWT_SECRET']
+        jwt_issuer = ENV['JWT_ISSUER']
+        jwt_audience = ENV['JWT_AUDIENCE']
+
+        begin
+          decoded_token = JWT.decode jwt, jwt_secret, true, { :verify_iat => verify_iat, :iss => jwt_issuer, :verify_iss => verify_iss, :aud => jwt_audience, :verify_aud => verify_aud, :algorithm => 'HS256'}
+        rescue JWT::ExpiredSignature
+          logger.info('JWT - Expired Signature')
+          return nil
+        rescue JWT::InvalidIssuerError
+          logger.info('JWT - Invalid Issuer')
+          return nil
+        rescue JWT::InvalidAudError
+          logger.info('JWT - Invalid Audience')
+          return nil
+        rescue JWT::InvalidIatError
+          logger.info('JWT - Invalid Issued At Timestamp')
+          return nil
+        rescue JWT::VerificationError
+          logger.info('JWT - Signature Verification Failed')
+          return nil
+        rescue JWT::DecodeError
+          logger.info('JWT - Error decoding JWT')
+          return nil
+        end
+
+        decoded_token
+
+      end
+
+      def valid_jwt?
+
+        if decode_jwt.nil?
+          return nil
+        end
+
+        true
+
+      end
+
+    end
+  end
+end

data/lib/DMAO/WardenJWT/user.rb

@@ -0,0 +1,41 @@
+module DMAO
+  module WardenJWT
+    class User
+
+      attr_reader(:id, :subject_id, :institution_id, :roles)
+
+      def initialize(attributes)
+
+        @id = attributes[:uid] || nil
+        @subject_id = attributes[:subject_id] || nil
+        @institution_id = attributes[:institution_id] || nil
+        @roles = attributes[:roles] || []
+
+      end
+
+      def self.from_jwt_claims jwt_claims
+
+        custom_claims = ENV['JWT_CUSTOM_CLAIMS_ATTRIBUTE']
+
+        uid = jwt_claims[custom_claims]["uid"].nil? ? jwt_claims["sub"] : jwt_claims[custom_claims]["uid"]
+
+        attributes = {
+            uid: uid,
+            subject_id: jwt_claims["sub"],
+            institution_id: jwt_claims[custom_claims]["institution_id"],
+            roles: jwt_claims[custom_claims]["roles"]
+        }
+
+        new(attributes)
+
+      end
+
+      def has_role? role
+
+        @roles.include? role.to_s
+
+      end
+
+    end
+  end
+end

data/lib/DMAO/WardenJWT/version.rb

@@ -0,0 +1,5 @@
+module DMAO
+  module WardenJWT
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: DMAO-WardenJWT
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Robinson
+- LULibrary
+- Digitial Innovation, Lancaster University Library
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ''
+email:
+- stephen@stephen-robinson.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- WardenJWT.gemspec
+- bin/console
+- bin/setup
+- lib/DMAO/WardenJWT.rb
+- lib/DMAO/WardenJWT/strategy.rb
+- lib/DMAO/WardenJWT/user.rb
+- lib/DMAO/WardenJWT/version.rb
+homepage: https://github.com/lulibrary/DMAO-WardenJWT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Warden Strategy for DMA Online JWT Auth
+test_files: []