jwt-rack 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bef98cd84654986f72aac0d1b8fc9a64f762bd0e784e39929e15893a3868c586
+  data.tar.gz: 8b70bf2c4dcd2ea7b92fed3c6121c834195eb9365a320acacbd7ff639ad20f2e
+SHA512:
+  metadata.gz: fe5702dd93cecb195a467a1f037c67a7d052ebabb67714d131ed118e34755b6c2155bec6b13853c4df8d0ad9c49a7c578efa2d2bc4de106b1919ee5e9a286eda
+  data.tar.gz: 28ec9ecb2e24e958cee55899054589ff55a35dc7bb86f9e80cb322e958747157de2f37e60b249878c792e454100d4b7c6608c066b1c319a5c51cc03f200d7328

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6.0
+
+# Use / or %r around regular expressions.
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  # slashes: Always use slashes.
+  # percent_r: Always use %r.
+  # mixed: Use slashes on single-line regexes, and %r on multi-line regexes.
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/LineLength:
+  Max: 99
+
+Metrics/AbcSize:
+  Max: 25

data/.travis.yml

@@ -0,0 +1,9 @@
+before_install:
+- sudo apt-get install -y libsodium18
+dist: xenial
+language: ruby
+rvm:
+- 2.3.8
+- 2.4.5
+- 2.5.3
+- 2.6.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yaroslav Savchuk
+
+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,123 @@
+# JWT::Rack
+
+[![Gem Version](https://badge.fury.io/rb/jwt-rack.svg)](http://badge.fury.io/rb/jwt-rack)
+[![Build Status](https://travis-ci.org/ysv/jwt-rack.svg)](https://travis-ci.org/ysv/jwt-rack)
+[![Code Climate](https://codeclimate.com/github/ysv/jwt-rack/badges/gpa.svg)](https://codeclimate.com/github/ysv/jwt-rack)
+
+## About
+
+This gem provides JSON Web Token (JWT) based authentication.
+
+## Requirements
+
+- Ruby 2.3.8 or greater
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'jwt-rack'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it directly with:
+
+```
+$ gem install jwt-rack
+```
+
+## Usage
+
+`JWT::Rack::Auth` accepts several configuration options. All options are passed in a single Ruby Hash:
+
+* `secret` : required : `String` || `OpenSSL::PKey::RSA` || `OpenSSL::PKey::EC` : A cryptographically secure String (for HMAC algorithms) or a public key object of an appropriate type for public key algorithms. Set to `nil` if you are using the `'none'` algorithm.
+
+* `verify` : optional : Boolean : Determines whether JWT will verify tokens keys for mismatch key types when decoded. Default is `true`. Set to `false` if you are using the `'none'` algorithm.
+
+* `options` : optional : Hash : A hash of options that are passed through to JWT to configure supported claims and algorithms. See the ruby-jwt docs for [more information of the algorithms and their requirements](https://github.com/jwt/ruby-jwt#algorithms-and-usage) as well as [more information on the supported claims](https://github.com/progrium/ruby-jwt#support-for-reserved-claim-names). These options are passed through without change to the underlying `ruby-jwt` gem. By default only expiration (exp) and Not Before (nbf) claims are verified. Pass in an algorithm choice like `{ algorithm: 'HS256' }`.
+
+* `exclude` : optional : Array : An Array of path strings representing paths that should not be checked for the presence of a valid JWT token. Excludes sub-paths as of specified paths as well (e.g. `%w(/docs)` excludes `/docs/some/thing.html` also). Each path should start with a `/`. If a path matches the current request path this entire middleware is skipped and no authentication or verification of tokens takes place.
+
+* `on_error` : optional : Callable : An object which responds to `call` method with single `error` parameter. `error` parameter is one of `JWT::Rack::Auth::ERRORS_TO_RESCUE`. `on_error` callable object will be called if one of `JWT::Rack::Auth::ERRORS_TO_RESCUE` raised. For default handler check `JWT::Rack::Auth#default_on_error`.
+
+## Example Server-Side Config
+
+Where `my_args` is a `Hash` containing valid keys. See `spec/example_spec.rb`
+for a more complete example of the valid arguments for creating and verifying
+tokens.
+
+### Sinatra
+
+```ruby
+use JWT::Rack::Auth, my_args
+```
+
+### Cuba
+
+```ruby
+Cuba.use JWT::Rack::Auth, my_args
+```
+
+### Rails
+
+```ruby
+Rails.application.config.middleware.use JWT::Rack::Auth, my_args
+```
+
+## Generating tokens
+You can generate JSON Web Tokens for your users using the
+`JWT::Rack::Token#encode` method which takes `payload`,
+`secret`, and `algorithm` params.
+
+The secret will be either a cryptographically strong random string, or the
+secret key component of a public/private keypair of an accepted type depending on
+the algorithm you choose. You can see examples of using the various key types at
+the [ruby-jwt gem repo](https://github.com/jwt/ruby-jwt/blob/master/README.md)
+
+The `algorithm` is an optional String and can be one of the following (default HMAC 'HS256'):
+
+```ruby
+%w(none HS256 HS384 HS512 RS256 RS384 RS512 ED25519 ES256 ES384 ES512)
+
+HS256 is the default
+```
+
+Note that `ED25519` support depends on the `rbnacl` which is _not_ already included by the
+`rack-jwt` gem. If you wish to use the `ED25519` algorith, you must also manually require
+`rbnacl` gem in addition to `rack-jwt`.
+
+Here is a sample payload with illustrative data. You don't have to use all,
+or even most, of these.
+
+```ruby
+secret = 'your_secret_token_or_key'
+
+my_payload = {
+  data: 'data',
+  exp: Time.now.to_i + 4 * 3600,
+  nbf: Time.now.to_i - 3600,
+  iss: 'https://my.awesome.website/',
+  aud: 'audience',
+  jti: Digest::MD5.hexdigest([hmac_secret, iat].join(':').to_s),
+  iat: Time.now.to_i,
+  sub: 'subject'
+}
+
+alg = 'HS256'
+
+JWT::Rack::Token.encode(my_payload, secret, alg)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ysv/jwt-rack/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

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 "jwt/rack"
+
+# 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(__FILE__)

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/jwt-rack.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jwt/rack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jwt-rack"
+  spec.version       = Jwt::Rack::VERSION
+  spec.authors       = ["Yaroslav Savchuk"]
+  spec.email         = ["savchukyarpolk@gmail.com"]
+
+  spec.summary       = %q{Rack middleware that provides authentication based on JSON Web Tokens.}
+  spec.description   = %q{Rack middleware that provides authentication based on JSON Web Tokens.}
+  spec.homepage      = "https://github.com/ysv/jwt-rack"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ysv/jwt-rack"
+  spec.metadata["changelog_uri"] = "https://github.com/ysv/jwt-rack/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.3.8'
+
+  spec.add_development_dependency 'bundler',   '>= 1.16.2'
+  spec.add_development_dependency 'rake',      '>= 12.0.0'
+  spec.add_development_dependency 'rack-test', '>= 1.0.0'
+  spec.add_development_dependency 'rspec',     '>= 3.8.0'
+  spec.add_development_dependency 'simplecov', '>= 0.16.0'
+  spec.add_development_dependency 'rbnacl',    '>= 6.0.1'
+
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'jwt',  '~> 2.1.0'
+end

data/lib/jwt/rack.rb

@@ -0,0 +1,8 @@
+require "jwt/rack/version"
+
+module Jwt
+  module Rack
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/jwt/rack/version.rb

@@ -0,0 +1,5 @@
+module Jwt
+  module Rack
+    VERSION = "0.0.0"
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: jwt-rack
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Yaroslav Savchuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Rack middleware that provides authentication based on JSON Web Tokens.
+email:
+- savchukyarpolk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jwt-rack.gemspec
+- lib/jwt/rack.rb
+- lib/jwt/rack/version.rb
+homepage: https://github.com/ysv/jwt-rack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ysv/jwt-rack
+  source_code_uri: https://github.com/ysv/jwt-rack
+  changelog_uri: https://github.com/ysv/jwt-rack/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware that provides authentication based on JSON Web Tokens.
+test_files: []