garage-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2f84ca42c260e1f8b86567cab7ccf79e5c25358
+  data.tar.gz: 79637ad570d302e411fe5ea58f6a29df910211cb
+SHA512:
+  metadata.gz: d9489f57ec2759f93140a82e13e1da6e122d43e61be4d20aaa9ab239f42b7040833c479168eefab73a1152c1e7f3e3367eabba6f4ed1e63cb1a8d9b3b93dd54a
+  data.tar.gz: daac7867ea8900bd68d7f685ba4dcb9a55b09df1af5579ffabd5601a677bc947ca406ead6ac0976276faa751ce855aa919ef3dd12e01e58dd9ab656ee1414ba8

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log
+/spec/dummy/tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+addons:
+    code_climate:
+        repo_token: 4cbf96c5cce0c4405306632c7c53221e7b743d4562a97632419557eb7c61606a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at masayuki@izumin.info. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "kaminari"
+
+group :development, :test do
+  gem "database_rewinder"
+  gem "factory_girl_rails"
+  gem "sqlite3"
+  gem "rspec-rails"
+end
+
+group :test do
+  gem "rspec-its"
+  gem "rspec-parameterized"
+  gem "rspec-request_describer"
+  gem "timecop"
+  gem "ffaker"
+
+  gem "codeclimate-test-reporter", require: nil
+end
+
+ gem 'byebug', group: [:development, :test]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 izumin5210
+
+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,85 @@
+# Garage::Jwt
+[![Build Status](https://travis-ci.org/izumin5210/garage-jwt.svg?branch=master)](https://travis-ci.org/izumin5210/garage-jwt)
+[![Test Coverage](https://codeclimate.com/github/izumin5210/garage-jwt/badges/coverage.svg)](https://codeclimate.com/github/izumin5210/garage-jwt/coverage)
+[![Code Climate](https://codeclimate.com/github/izumin5210/garage-jwt/badges/gpa.svg)](https://codeclimate.com/github/izumin5210/garage-jwt)
+
+Garage extension to use JWT as authentication strategy.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'garage-jwt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install garage-jwt
+
+## Usage
+
+In `config/initializer/garage.rb`:
+
+```ruby
+Garage.configuration.strategy = Garage::Strategy::Jwt
+
+Garage::Jwt.configure do |c|
+  c.algorithm = Garage::Jwt::Algorithm.hs256
+  c.common_key = "secret key"
+
+  # c.private_key = OpenSSL::PKey::RSA.generate 2048
+  # c.public_key = c.private_key.public_key
+end
+```
+
+The following cryptographic signing algorithms are available:
+
+- NONE
+  - `Garage::Jwt::Algorithm.none`
+- HMAC
+  - `Garage::Jwt::Algorithm.hs256` - HMAC using SHA-256 hash algorithm
+  - `Garage::Jwt::Algorithm.hs384` - HMAC using SHA-384 hash algorithm
+  - `Garage::Jwt::Algorithm.hs512` - HMAC using SHA-512 hash algorithm
+- RSA
+  - `Garage::Jwt::Algorithm.rs256` - RSA using SHA-256 hash algorithm
+  - `Garage::Jwt::Algorithm.rs384` - RSA using SHA-384 hash algorithm
+  - `Garage::Jwt::Algorithm.rs512` - RSA using SHA-512 hash algorithm
+- ECDSA
+  - `Garage::Jwt::Algorithm.rs256` - ECDSA using SHA-256 hash algorithm
+  - `Garage::Jwt::Algorithm.rs384` - ECDSA using SHA-384 hash algorithm
+  - `Garage::Jwt::Algorithm.rs512` - ECDSA using SHA-512 hash algorithm
+
+
+### Generate token
+
+```ruby
+Garage::Jwt::Utils.encode(
+  resource_owner_id: user.di,
+  application_id: 128,
+  scope: "read write",
+  expired_at: Time.zone.now + 15.minutes
+)
+```
+
+
+## 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/izumin5210/garage-jwt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Garage::Jwt'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'bundler/gem_tasks'

data/bin/console

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

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'garage/jwt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "garage-jwt"
+  spec.version       = Garage::Jwt::VERSION
+  spec.authors       = ["izumin5210"]
+  spec.email         = ["masayuki@izumin.info"]
+
+  spec.summary       = %q{Garage extension to use JWT as authentication strategy.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/izumin5210/garage-jwt.git"
+  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_runtime_dependency "jwt", "~> 1.0"
+  spec.add_runtime_dependency "the_garage", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/garage/jwt.rb

@@ -0,0 +1,9 @@
+require "jwt"
+require "garage"
+
+require "garage/jwt/version"
+require "garage/jwt/algorithm"
+require "garage/jwt/config"
+require "garage/jwt/error"
+require "garage/jwt/utils"
+require "garage/strategy/jwt"

data/lib/garage/jwt/algorithm.rb

@@ -0,0 +1,61 @@
+module Garage
+  module Jwt
+    class Algorithm
+      # https://github.com/jwt/ruby-jwt#algorithms-and-usage
+      TYPES = {
+        # NONE
+        none: "none",
+
+        # HMAC
+        hs256: "HS256",
+        hs384: "HS384",
+        hs512: "HS512",
+
+        # RSA
+        rs256: "RS256",
+        rs384: "RS384",
+        rs512: "RS512",
+
+        # ECDSA
+        es256: "ES256",
+        es384: "ES384",
+        es512: "ES512",
+      }.freeze
+
+      class << self
+
+        TYPES.each do |key, _|
+          define_method key do
+            Algorithm.new(key)
+          end
+        end
+      end
+
+      def need_common_key?
+        %i(hs256 hs384 hs512).include?(@type_key)
+      end
+
+      def need_public_key?
+        %i(rs256 rs384 rs512 es256 es384 es512).include?(@type_key)
+      end
+ 
+      def need_private_key?
+        need_public_key?
+      end
+
+      def none?
+        @type_key == :none
+      end
+
+      def type
+        TYPES[@type_key]
+      end
+
+      private
+
+      def initialize(type_key)
+        @type_key = type_key
+      end
+    end
+  end
+end

data/lib/garage/jwt/config.rb

@@ -0,0 +1,40 @@
+module Garage
+  module Jwt
+    def self.configure(&block)
+      @config = Config::Builder.new(&block).build
+    end
+
+    def self.configuration
+      @config ||= configure {}
+    end
+
+    class Config
+      attr_accessor :common_key, :public_key, :private_key, :algorithm
+
+      class Builder
+        def initialize(&block)
+          @config = Config.new
+          block.call(@config)
+        end
+
+        def valid?
+          @config.algorithm.present? &&
+            @config.algorithm.is_a?(Garage::Jwt::Algorithm) &&
+            (
+              (!@config.algorithm.need_common_key? || @config.common_key.present?) &&
+              (!@config.algorithm.need_public_key? || @config.public_key.present?) &&
+              (!@config.algorithm.need_private_key? || @config.private_key.present?)
+            )
+        end
+
+        def build
+          if valid?
+            @config
+          else
+            fail Garage::Jwt::InitializeError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/garage/jwt/error.rb

@@ -0,0 +1,5 @@
+module Garage
+  module Jwt
+    class InitializeError < StandardError; end
+  end
+end

data/lib/garage/jwt/utils.rb

@@ -0,0 +1,61 @@
+module Garage
+  module Jwt
+    module Utils
+      class << self
+        def encode(resource_owner_id:, application_id:, expired_at:, scope:)
+          payload = {
+            sub: resource_owner_id,
+            aud: application_id,
+            exp: expired_at.to_i,
+            scope: (scope.is_a?(Array) ? scope.join(" ") : scope)
+          }
+          JWT.encode(payload, private_key, algorithm.type)
+        end
+
+        def decode(token, token_type)
+          payload, _ = JWT.decode(token, public_key, verify?, decoding_options)
+          { token: token,
+            token_type: token_type,
+            scope: payload["scope"],
+            application_id: payload["aud"],
+            resource_owner_id: payload["sub"],
+            expired_at: payload["exp"],
+            revoked_at: nil
+          }
+        rescue JWT::DecodeError => e
+          nil
+        end
+
+        private
+
+        def configuration
+          Garage::Jwt.configuration
+        end
+
+        def algorithm
+          configuration.algorithm
+        end
+
+        def public_key
+          algorithm.need_public_key? ? configuration.public_key : common_key
+        end
+
+        def private_key
+          algorithm.need_public_key? ? configuration.private_key : common_key
+        end
+
+        def common_key
+          algorithm.need_common_key? ? configuration.common_key : nil
+        end
+
+        def decoding_options
+          { algorithm: algorithm.type, verify_expiration: false }
+        end
+
+        def verify?
+          !algorithm.none?
+        end
+      end
+    end
+  end
+end

data/lib/garage/jwt/version.rb

@@ -0,0 +1,5 @@
+module Garage
+  module Jwt
+    VERSION = "0.1.0"
+  end
+end

data/lib/garage/strategy/jwt.rb

@@ -0,0 +1,29 @@
+module Garage
+  module Strategy
+    module Jwt
+      extend ActiveSupport::Concern
+      included do
+        before_action :verify_auth, if: -> (_) { verify_permission? }
+      end
+
+      def verify_permission?
+        true
+      end
+
+      def access_token
+        if defined?(@access_token)
+          @access_token
+        else
+          token_type, token = request.authorization.try { |h| h.split(/\s+/) }
+          decoded_token = Garage::Jwt::Utils.decode(token, token_type)
+          if decoded_token.present?
+            @access_token = Garage::Strategy::AccessToken.new(decoded_token)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: garage-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- izumin5210
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: the_garage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Garage extension to use JWT as authentication strategy.
+email:
+- masayuki@izumin.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- garage-jwt.gemspec
+- lib/garage/jwt.rb
+- lib/garage/jwt/algorithm.rb
+- lib/garage/jwt/config.rb
+- lib/garage/jwt/error.rb
+- lib/garage/jwt/utils.rb
+- lib/garage/jwt/version.rb
+- lib/garage/strategy/jwt.rb
+homepage: https://github.com/izumin5210/garage-jwt.git
+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: Garage extension to use JWT as authentication strategy.
+test_files: []