rack-jwt-decode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98b92491ce03d394d60c1fb08e47be75ea8e27e049c9a7804c7204aecf0715e4
+  data.tar.gz: 96ab74597d9e3bda5dcb6e499a99301d6e7e96597781e43cd3c3db9f770eebb5
+SHA512:
+  metadata.gz: a7143dc5f0ddc1e70e6ab86f127a8db1505a58ba4499d223be25c6519266ce065927e71c0f52d6257d4d64f7e8367f4bd25d4698e55b69dc45edbed65653a882
+  data.tar.gz: 1ba6bb4f43006c3034bb4995138aeb6ca73767f15321633a9d7cf1eb030f963d5a78a8db1fa98a1a6f69fba0220917a0f9be9ee4400b3a8d0cb45afa6e84bbed

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-jwt-decode.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    rack-jwt-decode (0.1.0)
+      jwt
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    jwt (2.2.2)
+    rack (2.2.3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-jwt-decode!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paul Barry
+
+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,49 @@
+# Rack JWT Decode
+
+This is a Rack middleware that will look for a [JSON Web Token (JWT)](https://jwt.io) in the Authorization Bearer header and if it is present, decode it and add the values from the payload to the Rack env, with the Rack env key prefixed with `"jwt."`.
+
+For example, say your application generated a JWT like this:
+
+    >> token = JWT.encode({ sub: 1234, iat: Time.now.utc.to_i }, ENV["APPLICATION_SECRET"])
+    => "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEyMzQsImlhdCI6MTU5ODg5ODc3Mn0.MOaM22JkvCi2Bg-vUXAPuYXA9NtsApGNDplRdYMYerw"
+
+Now say that clients pass that token back in an HTTP Header like this:
+
+    curl -v -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEyMzQsImlhdCI6MTU5ODg5ODc3Mn0.MOaM22JkvCi2Bg-vUXAPuYXA9NtsApGNDplRdYMYerw' 'http://localhost:9292'
+
+This middleware would then result in the following additions to the Rack env:
+
+    env["jwt.sub"] # => 1234
+    env["jwt.iat"] # => 1598898472
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rack-jwt-decode"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rack-jwt-decode
+
+## Usage
+
+Configure your Rack application to use this middleware in your Rackup file like this:
+
+    use RackJWTDecode, ENV["APPLICATION_SECRET"]
+
+The second argument is the secret key that you used to encode the JWT token.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pjb3/rack-jwt-decode.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/config.ru

@@ -0,0 +1,12 @@
+require_relative "lib/rack_jwt_decode"
+
+app = lambda do |env|
+  [
+    200,
+    { "Content-Type" => "application/json" },
+    [JSON.generate(env.reject{|k, _| ["rack.input", "rack.errors"].include?(k) })]
+  ]
+end
+
+use RackJWTDecode, "secret"
+run app

data/lib/rack-jwt-decode.rb

@@ -0,0 +1 @@
+require_relative "rack_jwt_decode"

data/lib/rack_jwt_decode.rb

@@ -0,0 +1,29 @@
+require "jwt"
+
+class RackJWTDecode
+  HTTP_AUTHORIZATION = "HTTP_AUTHORIZATION".freeze
+  BEARER_REGEXP = /\ABearer /i.freeze
+
+  def initialize(app, application_secret)
+    @app = app
+    @application_secret = application_secret
+  end
+
+  def call(env)
+    add_jwt_payload_to_env(env)
+    @app.call(env)
+  end
+
+  private
+
+  def add_jwt_payload_to_env(env)
+    return unless @application_secret
+    return unless auth = env[HTTP_AUTHORIZATION]
+    return unless token = auth.split(BEARER_REGEXP)&.last
+    return unless payload = JWT.decode(token, @application_secret)&.first
+
+    payload&.each do |k, v|
+      env["jwt.#{k}"] = v
+    end
+  end
+end

data/rack-jwt-decode.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rack-jwt-decode"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Paul Barry"]
+  spec.email         = ["pauljbarry3@gmail.com"]
+
+  spec.summary       = "Rack middleware to decode the JWT token and add the payload to the Rack env"
+  spec.description   = "Rack middleware to decode the JWT token and add the payload to the Rack env"
+  spec.homepage      = "https://github.com/pjb3/rack-jwt-decode"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) 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.add_runtime_dependency "jwt"
+  spec.add_runtime_dependency "rack"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rack-jwt-decode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Barry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  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: 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'
+description: Rack middleware to decode the JWT token and add the payload to the Rack
+  env
+email:
+- pauljbarry3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- lib/rack-jwt-decode.rb
+- lib/rack_jwt_decode.rb
+- rack-jwt-decode.gemspec
+homepage: https://github.com/pjb3/rack-jwt-decode
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pjb3/rack-jwt-decode
+  source_code_uri: https://github.com/pjb3/rack-jwt-decode
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+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 to decode the JWT token and add the payload to the Rack env
+test_files: []