fb-jwt-auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff3e7406a923af4e7374f7855ddce3de5bbe9e46267b63a2d06c92a74f3ec13a
+  data.tar.gz: 1a0db0196134bed15fec85fb83006f0254f5dc0b2e96f02644b4d452499a121c
+SHA512:
+  metadata.gz: 9ef0173a6261f0b8f8377f1987ab3d8c16b7364f25209ab10094240a096e2b9ef24f35944f12ad81a06a85357da1e48c76899285dcd40f8210254993da44a81b
+  data.tar.gz: aee6abbd74914c5ba92158c5e6eb3ba3b62bd55e36bd5fa57d2877fb76a5ebd806317072a5ee8d6fd91b7318af788ec89da4bf15ad421d66426a908636b8d1c0

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fb-jwt-auth.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 matttei
+
+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,32 @@
+# Fb::Jwt::Auth
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fb-jwt-auth'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fb-jwt-auth
+
+## Usage
+
+```
+Fb::Jwt::Auth.configure do |config|
+  config.service_token_cache_root_url = ENV['SERVICE_TOKEN_CACHE_ROOT_URL']
+end
+
+Fb::Jwt::Auth.new(
+  access_token: request.headers['x-access-token-v2'],
+  key: 'fb-editor', # service name
+  leeway: ENV['MAX_IAT_SKEW_SECONDS'],
+  logger: Rails.logger
+).verify!
+```

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 "fb/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(__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/fb-jwt-auth.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/fb/jwt/auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fb-jwt-auth"
+  spec.version       = Fb::Jwt::Auth::VERSION
+  spec.authors       = ['Form builder developers']
+  spec.email         = ['form-builder-developers@digital.justice.gov.uk']
+
+  spec.summary       = %q{JWT authentication done in form builder team}
+  spec.description   = %q{JWT authentication done in all apps in form builder}
+  spec.homepage      = 'https://github.com/ministryofjustice/fb-jwt-auth'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ministryofjustice/fb-jwt-auth"
+  spec.metadata["changelog_uri"] = "https://github.com/ministryofjustice/fb-jwt-auth/blob/main/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.add_dependency 'jwt'
+  spec.add_dependency 'json'
+  spec.add_dependency 'activesupport'
+end

data/lib/fb/jwt/auth.rb

@@ -0,0 +1,79 @@
+require 'fb/jwt/auth/version'
+require 'openssl'
+require 'jwt'
+require 'active_support/core_ext'
+
+module Fb
+  module Jwt
+    class Auth
+      def self.service_token_cache_root_url=(value)
+        @@service_token_cache_root_url = value
+      end
+
+      def self.service_token_cache_root_url
+        @@service_token_cache_root_url
+      end
+
+      def self.configure(&block)
+        yield self
+      end
+
+      autoload :ServiceTokenClient, 'fb/jwt/auth/service_token_client'
+
+      class TokenNotPresentError < StandardError
+      end
+
+      class TokenNotValidError < StandardError
+      end
+
+      class TokenExpiredError < StandardError
+      end
+
+      attr_accessor :token, :key, :leeway, :logger
+
+      def initialize(token:, key:, leeway:, logger:)
+        @token = token
+        @key = key
+        @leeway = leeway
+        @logger = logger
+      end
+
+      def verify!
+        raise TokenNotPresentError if token.nil?
+
+        begin
+          hmac_secret = public_key(key)
+          payload, _header = JWT.decode(
+            token,
+            hmac_secret,
+            true,
+            exp_leeway: leeway,
+            algorithm: 'RS256'
+          )
+        rescue StandardError => e
+          error_message = "Couldn't parse that token - error #{e}"
+          logger.debug(error_message)
+          raise TokenNotValidError.new(error_message)
+        end
+
+        # NOTE: verify_iat used to be in the JWT gem, but was removed in v2.2
+        # so we have to do it manually
+        iat_skew = payload['iat'].to_i - Time.zone.now.to_i
+
+        if iat_skew.abs > leeway.to_i
+          error_message = "iat skew is #{iat_skew}, max is #{leeway} - INVALID"
+          logger.debug(error_message)
+
+          raise TokenExpiredError.new(error_message)
+        end
+
+        logger.debug 'token is valid'
+        payload
+      end
+
+      def public_key
+        OpenSSL::PKey::RSA.new(ServiceTokenClient.new(key).public_key)
+      end
+    end
+  end
+end

data/lib/fb/jwt/auth/service_token_client.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'json'
+require 'base64'
+
+class Fb::Jwt::Auth::ServiceTokenClient
+  class ServiceTokenCacheError < StandardError; end
+
+  attr_accessor :key, :root_url
+
+  def initialize(key)
+    @key = key
+    @root_url = Fb::Jwt::Auth.service_token_cache_root_url
+  end
+
+  def public_key
+    response = Net::HTTP.get_response(public_key_uri)
+
+    unless response.code.to_i == 200
+      raise ServiceTokenCacheError.new(
+        "Unexpected response code\n" \
+        "Response code: #{response.code} => Response body: #{response.body}"
+      )
+    end
+
+    Base64.strict_decode64(JSON.parse(response.body).fetch('token'))
+  rescue Errno::ECONNREFUSED => e
+    raise ServiceTokenCacheError.new(
+      "Unable to connect to the Service Token Cache\n#{e.message}"
+    )
+  end
+
+  private
+
+  def public_key_uri
+    URI.join(@root_url, '/service/v2/', key)
+  end
+end

data/lib/fb/jwt/auth/version.rb

@@ -0,0 +1,7 @@
+module Fb
+  module Jwt
+    class Auth
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: fb-jwt-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Form builder developers
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-21 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: json
+  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: activesupport
+  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: JWT authentication done in all apps in form builder
+email:
+- form-builder-developers@digital.justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fb-jwt-auth.gemspec
+- lib/fb/jwt/auth.rb
+- lib/fb/jwt/auth/service_token_client.rb
+- lib/fb/jwt/auth/version.rb
+homepage: https://github.com/ministryofjustice/fb-jwt-auth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ministryofjustice/fb-jwt-auth
+  source_code_uri: https://github.com/ministryofjustice/fb-jwt-auth
+  changelog_uri: https://github.com/ministryofjustice/fb-jwt-auth/blob/main/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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: JWT authentication done in form builder team
+test_files: []