warden-jwt_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94613bf0dc1c95f06be0cf8c4bc38b0a0f67b45f
+  data.tar.gz: 7872eb474f7ca7b3c4b2c015c3d442aadd16df46
+SHA512:
+  metadata.gz: 8ece658df524ab614cd752b0c0b317221aeffe32600a3a40e5c419ffaf89c510afb7d38fac056264ba96482a78a50369d7e6a163aed697a5db49588188209b7c
+  data.tar.gz: cd03343d7e9f303e3021ddf17601408b92fae71ae0b622ef5b60e0b959c2b132ded512429596ab516c4f3ffd7622d93471d31fc6d26634a95881d1542647894e

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  reek:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+  - spec/

data/.gitignore

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

data/.overcommit.yml

@@ -0,0 +1,53 @@
+#
+# Select version of overcommit and the other tools from Gemfile
+#
+gemfile: .overcommit_gems.rb
+
+#
+# Hooks that are run against every commit message after a user has written it.
+#
+CommitMsg:
+  ALL:
+    required: true
+    exclude: &default_excludes
+      - Gemfile
+      - warden-jwt_auth.gemspec
+      - README.md
+
+  HardTabs:
+    enabled: true
+
+  SingleLineSubject:
+    enabled: true
+
+#
+# Hooks that are run after `git commit` is executed, before the commit message
+# editor is displayed.
+#
+PreCommit:
+  ALL:
+    required: true
+    exclude: *default_excludes
+
+  BundleAudit:
+    enabled: true
+
+  BundleCheck:
+    enabled: true
+
+  LocalPathsInGemfile:
+    enabled: true
+
+  ExecutePermissions:
+    enabled: true
+    exclude:
+      - bin/*
+
+  Reek:
+    enabled: true
+
+  RuboCop:
+    enabled: true
+
+  TrailingWhitespace:
+    enabled: true

data/.overcommit_gems.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'overcommit', '~> 0.36'
+
+# Patch-level verification for Bundled apps
+gem 'bundler-audit', '~> 0.5'
+
+# Ruby code smell reporter
+gem 'reek', '~> 4.5'
+
+# Ruby code style checking
+gem 'rubocop', '~> 0.43'
+gem 'rubocop-rspec', '~> 1.7'

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.3
+RSpec/NestedGroups:
+  Max: 3
+RSpec/MessageSpies:
+  EnforcedStyle: 'receive'
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+before_install:
+  - gem update --system --no-doc
+  - bundle install --gemfile=.overcommit_gems.rb
+before_script:
+  - git config --global user.email 'travis@travis.ci'
+  - git config --global user.name 'Travis CI'
+script:
+  - bundle exec rspec
+  - bundle exec codeclimate-test-reporter
+  - overcommit --sign
+  - overcommit --run
+addons:
+  code_climate:
+    repo_token:
+      secure: neJ5LVLV6vgeCnerSQjUpLuQDvxEH87iW8swCSWl2hTtPcD/GuwYSeSXnhH72HVHi/9basHHhaYPcE2YeBwBCr39PhiHMNwS5GGGk/RGjKpU/Gt1KXV8KXTbNGT4v+ZMM3cdsdDfe8OnzGguNVsdxseHa3KE2pyuvo2a0swXwKa7BU9VB/3ZoZvvfI3Xr9im4eklWam5yCwVR0FOF7epzmNTKMXcUga2BOc9PV5aVELzLILLCHCJSCupe5Rx8mfcsRoRmZXKduF8Ke3eq8eULvLEo4EGfC107najOqrKt7x8uDVIsuGrP4LUQ4ainmNEb2jIvpjuqAxpusMjhpjCINF1Tn0OXK93OXAp4QKeIYoYEqKtzRxX0TWFNWHB8ombF9HTMF2DmloDZyFRiI40JSMImU0hc4MDxRgiTW5MDWGbohDaJ+9VV6+rIqtlEfLhgj1grFBAroaJce9BB7RQEmfsZPzhC2VXwGxHw/YkJgzBNGq1/9E1DoTY9RPSNTQfSRodhI3XW8LSQSHTBeXZvymVcjeOyYgjzJYviLHR8QS4cXpUALtlFXyaMkPHUBLUn8XsBa5Azfh5y3qPMGiJq1/qaHA4mKj5ls+ngFbzOq82sYGAKgQHj/ZDb+FZMQQanp4jyWADKcpXcmINb9jEQwkU0bjpuhUYtghASxH1Kl8=

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 marc@lamarciana.com. 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/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.3.1
+ENV APP_HOME /app/
+ENV LIB_DIR lib/warden/jwt_auth/
+RUN mkdir -p $APP_HOME/$LIB_DIR
+WORKDIR $APP_HOME
+COPY Gemfile *gemspec $APP_HOME
+COPY $LIB_DIR/version.rb $APP_HOME/$LIB_DIR
+RUN bundle install

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in warden-jwt_auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marc Busqué
+
+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,187 @@
+# Warden::JWTAuth
+
+[![Build Status](https://travis-ci.org/waiting-for-dev/warden-jwt_auth.svg?branch=master)](https://travis-ci.org/waiting-for-dev/warden-jwt_auth)
+[![Code Climate](https://codeclimate.com/github/waiting-for-dev/warden-jwt_auth/badges/gpa.svg)](https://codeclimate.com/github/waiting-for-dev/warden-jwt_auth)
+[![Test Coverage](https://codeclimate.com/github/waiting-for-dev/warden-jwt_auth/badges/coverage.svg)](https://codeclimate.com/github/waiting-for-dev/warden-jwt_auth/coverage)
+
+`warden-jwt_auth` is a [warden](https://github.com/hassox/warden) extension which uses [JWT](https://jwt.io/) tokens for user authentication. It follows [secure by default](https://en.wikipedia.org/wiki/Secure_by_default) principle.
+
+You can read about which security concerns this library takes into account and about JWT generic secure usage in the following series of posts:
+
+- [Stand Up for JWT Revocation](http://waiting-for-dev.github.io/blog/2017/01/23/stand_up_for_jwt_revocation/)
+- [JWT Recovation Strategies](http://waiting-for-dev.github.io/blog/2017/01/24/jwt_revocation_strategies/)
+- [JWT Secure Usage](http://waiting-for-dev.github.io/blog/2017/01/25/jwt_secure_usage/)
+- [A secure JWT authentication implementation for Rack and Rails](http://waiting-for-dev.github.io/blog/2017/01/26/a_secure_jwt_authentication_for_rack_and_rails)
+
+If what you need is a JWT authentication library for [devise](https://github.com/plataformatec/devise), better look at [devise-jwt](https://github.com/waiting-for-dev/devise-jwt), which is just a thin layer on top of this gem.
+
+## Installation
+
+```ruby
+gem 'warden-jwt_auth', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install warden-jwt_auth
+
+## Usage
+
+At its core, this library consists of:
+
+- A Warden strategy that authenticates a user if a valid JWT token is present in the request headers.
+- A rack middleware which adds a JWT token to the response headers in configured requests.
+- A rack middleware which revokes JWT tokens in configured requests.
+
+As you see, JWT revocation is supported. I wrote [why I think JWT tokens revocation is useful and needed](http://waiting-for-dev.github.io/blog/2017/01/23/stand_up_for_jwt_revocation/).
+
+### Secret key configuration
+
+First of all, you have to configure the secret key that will be used to sign generated tokens.
+
+```ruby
+Warden::JWTAuth.configure do |config|
+  config.secret = ENV['WARDEN_JWT_SECRET_KEY']
+end
+```
+
+**Important:** You are encouraged to use a dedicated secret key, different than others in use in your application. If several components share the same secret key, chances that a vulnerability in one of them has a wider impact increase. Also, never share your secrets pushing it to a remote repository, you are better off using an environment variable like in the example.
+
+Currently, HS256 algorithm is the one in use.
+
+### Warden scopes configuration
+
+You have to map the warden scopes that will be authenticatable through JWT, with the user repositories from where these scope user records can be fetched.
+
+For instance:
+
+```ruby
+config.mappings = { user: UserRepository }
+```
+
+For this example, `UserRepository` must implement a method `find_for_jwt_authentication` that takes as argument the `sub` claim in the JWT payload. This method should return a user record from `:user` scope:
+
+```ruby
+module UserRepository
+  # @returns User
+  def self.find_for_jwt_authentication(sub)
+    Repo.find_user_by_id(sub)
+  end
+end
+```
+
+User records must implement a `jwt_subject` method returning what should be encoded in the `sub` claim on dispatch time.
+
+```ruby
+User = Struct.new(:id, :name)
+  def jwt_subject
+    id
+  end
+end
+```
+
+User records may also implement a `jwt_payload` method, which gives it a chance to add something to the JWT payload:
+
+```ruby
+def jwt_payload
+  { 'foo' => 'bar' }
+end
+```
+
+### Middlewares addition
+
+You need to add `Warden::JWTAuth::Middleware` to your rack middlewares stack. Actually, it is just a wrapper which adds two middlewares that do the actual job: dispatching tokens and revoking tokens.
+
+### Token dispatch configuration
+
+You need to tell which requests will dispatch tokens for the user that has been previously authenticated (usually through some other warden strategy, such as one requiring username and email parameters).
+
+To configure it, you must provide a bidimensional array, each item being an array of two elements: the request method and a regular expression that must match the request path.
+
+For example:
+
+```ruby
+config.dispatch_requests = [
+                             ['POST', %r{^/sign_in$}]
+                           ]
+```
+
+**Important**: You are encouraged to delimit your regular expression with `^` and `$` to avoid unintentional matches.
+
+Tokens will be returned in the `Authorization` response header, with format `Bearer #{token}`.
+
+### Requests authentication
+
+Once you have a valid token, you can authenticate following requests providing the token in the `Authorization` request header, with format `Bearer #{token}`.
+
+### Revocation configuration
+
+You need to tell which requests will revoke incoming JWT tokens.
+
+To configure it, you must provide a bidimensional array, each item being an array of two elements: the request method and a regular expression that must match the request path.
+
+For example:
+
+```ruby
+config.revocation_requests = [
+                               ['DELETE', %r{^/sign_out$}]
+                             ]
+```
+
+**Important**: You are encouraged to delimit your regular expression with `^` and `$` to avoid unintentional matches.
+
+Besides, you need to configure which revocation strategy will be used for each scope.
+
+```ruby
+config.revocation_strategies = { user: RevocationStrategy }
+```
+
+The implementation of the revocation strategy is also on your side. They just need to implement two methods: `jwt_revoked?` and `revoke_jwt`, both of them accepting as parameters the JWT payload and the user record, in this order.
+
+You can read about which [JWT recovation strategies](http://waiting-for-dev.github.io/blog/2017/01/24/jwt_revocation_strategies/) can be implement with their pros and cons.
+
+```ruby
+module RevocationStrategy
+  def self.jwt_revoked?(payload, user)
+    # Does something to check whether the JWT token is revoked for given user
+  end
+  
+  def self.revoke_jwt(payload, user)
+    # Does something to revoke the JWT token for given user
+  end
+end
+```
+
+## Development
+
+There are docker and docker-compose files configured to create a development environment for this gem. So, if you use Docker you only need to run:
+
+`docker-compose up -d`
+
+An then, for example:
+
+`docker-compose exec app rspec`
+
+This gem uses [overcommit](https://github.com/brigade/overcommit) to execute some code review engines. If you submit a pull request, it will be executed in the CI process. In order to set it up, you need to do:
+
+```ruby
+bundle install --gemfile=.overcommit_gems.rb
+overcommit --sign
+overcommit --run # To test if it works
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/waiting-for-dev/warden-jwt_auth. 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.
+
+## Release Policy
+
+`warden-jwt_auth` follows the principles of [semantic versioning](http://semver.org/).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# !/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'warden/jwt_auth'
+
+# 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