fb-jwt-auth 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3e7406a923af4e7374f7855ddce3de5bbe9e46267b63a2d06c92a74f3ec13a
-  data.tar.gz: 1a0db0196134bed15fec85fb83006f0254f5dc0b2e96f02644b4d452499a121c
+  metadata.gz: 45ebbebff675bd2afe201e48c9d3d711ae255619511e00318f6cd39aef8094c0
+  data.tar.gz: e1d51f15d8b8a4a55be59228edce5aa3723b74bd312d0b87f868e81ecd3bcdb3
 SHA512:
-  metadata.gz: 9ef0173a6261f0b8f8377f1987ab3d8c16b7364f25209ab10094240a096e2b9ef24f35944f12ad81a06a85357da1e48c76899285dcd40f8210254993da44a81b
-  data.tar.gz: aee6abbd74914c5ba92158c5e6eb3ba3b62bd55e36bd5fa57d2877fb76a5ebd806317072a5ee8d6fd91b7318af788ec89da4bf15ad421d66426a908636b8d1c0
+  metadata.gz: 56e7552bcdede5d4ce45200ab5160a790128e80ee0a6f276d0e4d7f9f4515de14db7a9efab79554df31593ee801e9a983d1af413327427b1c88e184a80e88042
+  data.tar.gz: 395d1d6f094db54c9411bc20d6804c94ea56f7a52e60a64e4496f6ed75d2bb5bd52817ada3fbc7058a404fa47db4b48b850df16ccb9a4ae96236b4591a13d2c6

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+version: 2.1
+orbs:
+  slack: circleci/slack@3.4.2
+
+jobs:
+  test:
+    docker:
+      - image: cimg/ruby:2.7.2
+    steps:
+      - checkout
+      - run:
+          name: Install
+          command: bundle install
+      - run:
+          name: Test
+          command: bundle exec rspec
+      - slack/status: &slack_status
+          fail_only: true
+          only_for_branches: main
+          failure_message: ":facepalm:  Failed job $CIRCLE_JOB  :homer-disappear:"
+          include_job_number_field: false
+  publish:
+    docker:
+      - image: cimg/ruby:2.7.2
+    steps:
+      - checkout
+      - run:
+          name: Install
+          command: bundle install
+      - run:
+          name: Setup Rubygems
+          command: |
+            mkdir ~/.gem
+            echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+            chmod 0600 /home/circleci/.gem/credentials
+      - run:
+          name: Publish to Rubygems
+          command: |
+            set -e
+
+            VERSION=$(ruby -e "require './lib/fb/jwt/auth/version.rb'; puts Fb::Jwt::Auth::VERSION")
+            PUBLISHED_VERSION=$(curl https://rubygems.org/api/v1/versions/fb-jwt-auth/latest.json | sed -e 's/[{}]/''/g' | sed s/\"//g | awk -v RS=',' -F: '$1=="version"{print $2}')
+
+            if [ "$VERSION" != "$PUBLISHED_VERSION" ]
+            then
+              bundle exec gem build fb-jwt-auth.gemspec
+              bundle exec gem push fb-jwt-auth-*.gem
+              curl -X POST -H 'Content-type: application/json' --data "{\"text\":\":woohoo:  Successfully published ${CIRCLE_PROJECT_REPONAME} ${VERSION}  :ship_it_parrot:\"}" "$SLACK_WEBHOOK"
+            fi
+      - slack/status: *slack_status
+
+workflows:
+  commit-workflow:
+    jobs:
+      - test
+      - publish:
+          requires:
+            - test
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              only: main

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 Gemfile.lock
 .byebug_history
+*.gem

data/Changelog.md

@@ -0,0 +1,18 @@
+# 0.3.0
+* Request non cached version of public key if first validition fails
+
+# v0.2.2
+* Add token not present exception when token is empty
+
+# v0.2.1
+* Add better error messages
+
+# v0.2.0
+
+* Add service token cache v3 implementation
+* All necessary information (iat, sub and application, namespace) should be on
+  the access token
+
+# v0.1.0
+
+* Add service token cache v2 implementation

data/README.md

@@ -18,11 +18,39 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 Fb::Jwt::Auth.configure do |config|
+  # Service token cache domain
+  #
   config.service_token_cache_root_url = ENV['SERVICE_TOKEN_CACHE_ROOT_URL']
 end
+```
+In order to generate the service access token we need to use `Fb::Jwt::Auth::ServiceAccessToken.new.generate` or if you require a subject, `Fb::Jwt::Auth::ServiceAccessToken.new(subject: subject).generate`
+
+In the case you need to configure the service access token as a client
+```ruby
+Fb::Jwt::Auth.configure do |config|
+  config.issuer = 'fb-editor'
+  config.namespace = 'formbuilder-saas-test'
+  config.encoded_private_key = 'base64 encoded private key'
+end
+```
+
+### Using other endpoint versions
+
+Service token cache can have different versions of authenticating a service.
+
+You can configure the version:
+
+```ruby
+Fb::Jwt::Auth.configure do |config|
+  config.service_token_cache_api_version = :v3
+end
+```
 
+### Verifying the token
+
+```ruby
 Fb::Jwt::Auth.new(
   access_token: request.headers['x-access-token-v2'],
   key: 'fb-editor', # service name

data/lib/fb/jwt/auth.rb

@@ -1,24 +1,23 @@
 require 'fb/jwt/auth/version'
 require 'openssl'
 require 'jwt'
-require 'active_support/core_ext'
+require 'active_support/all'
 
 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
+      cattr_accessor :service_token_cache_root_url,
+                     :service_token_cache_api_version,
+                     :encoded_private_key,
+                     :issuer,
+                     :namespace
 
       def self.configure(&block)
         yield self
       end
 
       autoload :ServiceTokenClient, 'fb/jwt/auth/service_token_client'
+      autoload :ServiceAccessToken, 'fb/jwt/auth/service_access_token'
 
       class TokenNotPresentError < StandardError
       end
@@ -29,9 +28,15 @@ module Fb
       class TokenExpiredError < StandardError
       end
 
+      class IssuerNotPresentError < StandardError
+      end
+
+      class NamespaceNotPresentError < StandardError
+      end
+
       attr_accessor :token, :key, :leeway, :logger
 
-      def initialize(token:, key:, leeway:, logger:)
+      def initialize(token:, key: nil, leeway:, logger:)
         @token = token
         @key = key
         @leeway = leeway
@@ -39,19 +44,14 @@ module Fb
       end
 
       def verify!
-        raise TokenNotPresentError if token.nil?
+        raise TokenNotPresentError.new('Token is not present') if token.blank?
+
+        application_details = find_application_info
 
         begin
-          hmac_secret = public_key(key)
-          payload, _header = JWT.decode(
-            token,
-            hmac_secret,
-            true,
-            exp_leeway: leeway,
-            algorithm: 'RS256'
-          )
+          payload, _header = retrieve_and_decode_public_key(application_details)
         rescue StandardError => e
-          error_message = "Couldn't parse that token - error #{e}"
+          error_message = "Token is not valid: error #{e}"
           logger.debug(error_message)
           raise TokenNotValidError.new(error_message)
         end
@@ -61,7 +61,7 @@ module Fb
         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"
+          error_message = "Token has expired: iat skew is #{iat_skew}, max is #{leeway}"
           logger.debug(error_message)
 
           raise TokenExpiredError.new(error_message)
@@ -71,8 +71,42 @@ module Fb
         payload
       end
 
-      def public_key
-        OpenSSL::PKey::RSA.new(ServiceTokenClient.new(key).public_key)
+      def retrieve_and_decode_public_key(application_details)
+        hmac_secret = public_key(application_details)
+        decode(hmac_secret: hmac_secret)
+      rescue JWT::VerificationError
+        logger.debug('First validation failed. Requesting non cached public key')
+        hmac_secret = public_key(application_details.merge(ignore_cache: true))
+        decode(hmac_secret: hmac_secret)
+      end
+
+      def decode(verify: true, hmac_secret: nil)
+        JWT.decode(
+          token,
+          hmac_secret,
+          verify,
+          exp_leeway: leeway,
+          algorithm: 'RS256'
+        )
+      end
+
+      def find_application_info
+        return { application: key } if key
+
+        payload, _header = decode(verify: false)
+        application = payload['iss']
+        namespace = payload['namespace']
+
+        raise IssuerNotPresentError.new('Issuer is not present in the token') unless application
+        raise NamespaceNotPresentError.new('Namespace is not present in the token') unless namespace
+
+        { application: application, namespace: namespace}
+      end
+
+      def public_key(attributes)
+        OpenSSL::PKey::RSA.new(
+          ServiceTokenClient.new(attributes).public_key
+        )
       end
     end
   end

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

@@ -0,0 +1,45 @@
+module Fb
+  module Jwt
+    class Auth
+      class ServiceAccessToken
+        attr_reader :encoded_private_key,
+                    :issuer,
+                    :subject,
+                    :namespace
+
+        def initialize(subject: nil)
+          @subject = subject
+          @encoded_private_key = Fb::Jwt::Auth.encoded_private_key
+          @namespace = Fb::Jwt::Auth.namespace
+          @issuer = Fb::Jwt::Auth.issuer
+        end
+
+        def generate
+          return '' if encoded_private_key.blank?
+
+          private_key = OpenSSL::PKey::RSA.new(
+            Base64.strict_decode64(encoded_private_key.chomp)
+          )
+
+          JWT.encode(
+            token,
+            private_key,
+            'RS256'
+          )
+        end
+
+        private
+
+        def token
+          payload = {
+            iss: issuer,
+            iat: Time.current.to_i
+          }
+          payload[:sub] = subject if subject.present?
+          payload[:namespace] = namespace if namespace.present?
+          payload
+        end
+      end
+    end
+  end
+end

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

@@ -5,11 +5,19 @@ require 'base64'
 class Fb::Jwt::Auth::ServiceTokenClient
   class ServiceTokenCacheError < StandardError; end
 
-  attr_accessor :key, :root_url
+  ENDPOINTS = {
+    v2: '/service/v2/%{application}',
+    v3: '/v3/applications/%{application}/namespaces/%{namespace}'
+  }
 
-  def initialize(key)
-    @key = key
+  attr_accessor :application, :namespace, :root_url, :api_version
+
+  def initialize(application:, namespace: nil, ignore_cache: false)
+    @application = application
+    @namespace = namespace
+    @ignore_cache = ignore_cache
     @root_url = Fb::Jwt::Auth.service_token_cache_root_url
+    @api_version = Fb::Jwt::Auth.service_token_cache_api_version || :v2
   end
 
   def public_key
@@ -31,7 +39,21 @@ class Fb::Jwt::Auth::ServiceTokenClient
 
   private
 
+  attr_reader :ignore_cache
+
   def public_key_uri
-    URI.join(@root_url, '/service/v2/', key)
+    URI.join(root_url, "#{version_url}#{query_param}")
+  end
+
+  def query_param
+    ignore_cache ? '?ignore_cache=true' : ''
+  end
+
+  def version_url
+    if api_version == :v3
+      ENDPOINTS[api_version] % { application: application, namespace: namespace }
+    else
+      ENDPOINTS[api_version] % { application: application }
+    end
   end
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fb-jwt-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Form builder developers
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -72,6 +73,7 @@ files:
 - bin/setup
 - fb-jwt-auth.gemspec
 - lib/fb/jwt/auth.rb
+- lib/fb/jwt/auth/service_access_token.rb
 - lib/fb/jwt/auth/service_token_client.rb
 - lib/fb/jwt/auth/version.rb
 homepage: https://github.com/ministryofjustice/fb-jwt-auth
@@ -81,7 +83,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -97,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: JWT authentication done in form builder team
 test_files: []