fb-jwt-auth 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3e7406a923af4e7374f7855ddce3de5bbe9e46267b63a2d06c92a74f3ec13a
-  data.tar.gz: 1a0db0196134bed15fec85fb83006f0254f5dc0b2e96f02644b4d452499a121c
+  metadata.gz: f86d88c60d096a604b4c0e3bd40acb9e6869c99011f91f14eb9488b7e9d4f4ae
+  data.tar.gz: f79a60753d8fee05024b3303a6d03d1fb28d13db6d788a3b3ca24e2c16a8707f
 SHA512:
-  metadata.gz: 9ef0173a6261f0b8f8377f1987ab3d8c16b7364f25209ab10094240a096e2b9ef24f35944f12ad81a06a85357da1e48c76899285dcd40f8210254993da44a81b
-  data.tar.gz: aee6abbd74914c5ba92158c5e6eb3ba3b62bd55e36bd5fa57d2877fb76a5ebd806317072a5ee8d6fd91b7318af788ec89da4bf15ad421d66426a908636b8d1c0
+  metadata.gz: 52b523c492ba637761d84f15c0d374e1920d1c0e7210cf8fbbfefee2df9efcee10abaf75a6f9942266794c509616717da55cadb38916c48d31372cb0c7b92c6f
+  data.tar.gz: 9870d7e4d6854fb21cc07fc8903661fca1fac308ce716866bd2d9bbee95fdfafe32deb47c3f54fbb14112ae88b25e2262fbec35ebe34a5d0ddd95de8f40c20ee

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/Changelog.md

@@ -0,0 +1,9 @@
+# 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,29 @@ 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
+```
+
+### 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

@@ -6,13 +6,7 @@ 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
+      cattr_accessor :service_token_cache_root_url, :service_token_cache_api_version
 
       def self.configure(&block)
         yield self
@@ -29,9 +23,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
@@ -41,15 +41,11 @@ module Fb
       def verify!
         raise TokenNotPresentError if token.nil?
 
+        application_details = find_application_info
+
         begin
-          hmac_secret = public_key(key)
-          payload, _header = JWT.decode(
-            token,
-            hmac_secret,
-            true,
-            exp_leeway: leeway,
-            algorithm: 'RS256'
-          )
+          hmac_secret = public_key(application_details)
+          payload, _header = decode(hmac_secret: hmac_secret)
         rescue StandardError => e
           error_message = "Couldn't parse that token - error #{e}"
           logger.debug(error_message)
@@ -71,8 +67,33 @@ module Fb
         payload
       end
 
-      def public_key
-        OpenSSL::PKey::RSA.new(ServiceTokenClient.new(key).public_key)
+      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 unless application
+        raise NamespaceNotPresentError 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_token_client.rb

@@ -5,11 +5,18 @@ 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)
+    @application = application
+    @namespace = namespace
     @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
@@ -32,6 +39,14 @@ class Fb::Jwt::Auth::ServiceTokenClient
   private
 
   def public_key_uri
-    URI.join(@root_url, '/service/v2/', key)
+    URI.join(root_url, version_url)
+  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.2.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.2.0
 platform: ruby
 authors:
 - Form builder developers
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-10-23 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"
@@ -81,7 +82,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 +98,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: []