zaikio-jwt_auth 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6de8bcc2c7ef22d052c626bc463789dec9dba4c6d4e977ee543973736994440b
-  data.tar.gz: c3c1b661b388fdef157831bccd203616913456f594762c4d0513967ebde8c468
+  metadata.gz: '0559a98a2221978a8a5c35e6968d667d9c17287b1421500ae0062bad169c0ece'
+  data.tar.gz: be9a95f5684dd8329f1b5446400ad8704f46422a364de01675538f3001c0bf59
 SHA512:
-  metadata.gz: 694d2a013c3a8e41dc8b03a11b0817fadd8e636cd80809a4d66c04285b2ecfe1e2dcaaf919f7735556a001d6d6feb93c4541a1f61bce16689e117fbabe6bf55f
-  data.tar.gz: 44c62f3c08102efb72e0ca8951562d02481bf5882742cd75ff4a27f722d80713f939c17cf05271cd870ef8b5fae3c00ad534b756aa981c32399e634a366b674d
+  metadata.gz: d4f1a51bed19e09d9ca09eb873377639f6f197f289742d74e17a6d6fba3e130608547530ca65daa6ab40c3faad4a00a8b695582fee084d78b8e96e897165301f
+  data.tar.gz: bf0eab6e6761239b33ae00d565ffc0b884fd70ddea3d589a91a0a1c7b2bf124e955048e8a5eebfbc7e42d1b37ed41fd96b0d6139b5f19ce5b60358bf69525612

data/README.md

@@ -6,7 +6,7 @@ Gem for JWT-Based authentication and authorization with zaikio.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+1. Add this line to your application's Gemfile:
 
 ```ruby
 gem 'zaikio-jwt_auth'
@@ -22,7 +22,7 @@ Or install it yourself as:
 $ gem install zaikio-jwt_auth
 ```
 
-Configure the gem:
+2. Configure the gem:
 
 ```rb
 # config/initializers/zaikio_jwt_auth.rb
@@ -34,7 +34,7 @@ Zaikio::JWTAuth.configure do |config|
 end
 ```
 
-Extend your API application controller:
+3. Extend your API application controller:
 
 ```rb
 class API::ApplicationController < ActionController::Base
@@ -49,7 +49,42 @@ class API::ApplicationController < ActionController::Base
 end
 ```
 
-Add more restrictions to your resources:
+4. Update Revoked Access Tokens by Webhook
+
+```rb
+# ENV['ZAIKIO_SHARED_SECRET'] needs to be defined first, you can find it on your
+# app details page in zaikio. Fore more help read:
+# https://docs.zaikio.com/guide/loom/receiving-events.html
+class WebhooksController < ActionController::Base
+  include Zaikio::JWTAuth
+
+  before_action :verify_signature
+  before_action :update_blacklisted_access_tokens_by_webhook
+
+  def create
+    case params[:name]
+      # Manage other events
+    end
+
+    render json: { received: true }
+  end
+
+  private
+
+  def verify_signature
+    # Read More: https://docs.zaikio.com/guide/loom/receiving-events.html
+    unless ActiveSupport::SecurityUtils.secure_compare(
+      OpenSSL::HMAC.hexdigest("SHA256", "shared-secret", request.body.read),
+      request.headers["X-Loom-Signature"]
+    )
+      render json: { received: true }
+    end
+  end
+end
+```
+
+
+5. Add more restrictions to your resources:
 
 ```rb
 class API::ResourcesController < API::ApplicationController
@@ -57,3 +92,21 @@ class API::ResourcesController < API::ApplicationController
   authorize_by_jwt_scopes 'resources'
 end
 ```
+
+6. Optionally, if you are using SSO: Check revoked tokens
+
+Additionally, the API provides a method called `revoked_jwt?` which expects the `jti` of the JWT.
+
+```rb
+Zaikio::JWTAuth.revoked_jwt?('jti-of-token') # returns true if token was revoked
+```
+
+7. Optionally, use the test helper module to mock JWTs in your minitests
+
+```rb
+# in your test_helper.rb
+include Zaikio::JWTAuth::TestHelper
+
+# in your tests you can use:
+mock_jwt(sub: 'Organization/123', scope: ['directory.organization.r'])
+```

data/lib/zaikio/jwt_auth.rb

@@ -5,6 +5,7 @@ require "zaikio/jwt_auth/configuration"
 require "zaikio/jwt_auth/directory_cache"
 require "zaikio/jwt_auth/jwk"
 require "zaikio/jwt_auth/token_data"
+require "zaikio/jwt_auth/test_helper"
 
 module Zaikio
   module JWTAuth
@@ -17,26 +18,44 @@ module Zaikio
       yield(configuration)
     end
 
+    def self.revoked_jwt?(jti)
+      blacklisted_token_ids.include?(jti)
+    end
+
+    def self.blacklisted_token_ids
+      return [] if mocked_jwt_payload
+
+      return configuration.blacklisted_token_ids if configuration.blacklisted_token_ids
+
+      DirectoryCache.fetch("api/v1/blacklisted_access_tokens.json", expires_after: 60.minutes)["blacklisted_token_ids"]
+    end
+
     def self.included(base)
       base.send :include, InstanceMethods
       base.send :extend, ClassMethods
     end
 
+    def self.mocked_jwt_payload
+      @mocked_jwt_payload
+    end
+
+    def self.mocked_jwt_payload=(payload)
+      @mocked_jwt_payload = payload
+    end
+
     module ClassMethods
       def authorize_by_jwt_subject_type(type = nil)
         @authorize_by_jwt_subject_type ||= type
       end
 
-      def authorize_by_jwt_scopes(scopes = nil)
-        @authorize_by_jwt_scopes ||= scopes
+      def authorize_by_jwt_scopes(scopes = nil, options = {})
+        @authorize_by_jwt_scopes ||= options.merge(scopes: scopes)
       end
     end
 
     module InstanceMethods
       def authenticate_by_jwt
-        unless jwt_from_auth_header
-          render(status: :unauthorized, plain: "Please authenticate via Zaikio JWT") && return
-        end
+        render_error("no_jwt_passed", status: :unauthorized) && return unless jwt_from_auth_header
 
         token_data = TokenData.new(jwt_payload)
 
@@ -48,30 +67,44 @@ module Zaikio
 
         send(:after_jwt_auth, token_data) if respond_to?(:after_jwt_auth)
       rescue JWT::ExpiredSignature
-        render(status: :forbidden, plain: "JWT expired") && (return)
+        render_error("jwt_expired") && (return)
       rescue JWT::DecodeError
-        render(status: :forbidden, plain: "Invalid JWT") && (return)
+        render_error("invalid_jwt") && (return)
+      end
+
+      def update_blacklisted_access_tokens_by_webhook
+        return unless params[:name] == "directory.revoked_access_token"
+
+        DirectoryCache.update("api/v1/blacklisted_access_tokens.json", expires_after: 60.minutes) do |data|
+          data["blacklisted_token_ids"] << params[:payload][:access_token_id]
+          data
+        end
+
+        render json: { received: true }
       end
 
       private
 
       def jwt_from_auth_header
+        return true if Zaikio::JWTAuth.mocked_jwt_payload
+
         auth_header = request.headers["Authorization"]
         auth_header.split("Bearer ").last if /Bearer/.match?(auth_header)
       end
 
       def jwt_payload
+        return Zaikio::JWTAuth.mocked_jwt_payload if Zaikio::JWTAuth.mocked_jwt_payload
+
         payload, = JWT.decode(jwt_from_auth_header, nil, true, algorithms: ["RS256"], jwks: JWK.loader)
 
         payload
       end
 
       def show_error_if_authorize_by_jwt_scopes_fails(token_data)
-        if !self.class.authorize_by_jwt_scopes || token_data.scope?(self.class.authorize_by_jwt_scopes, action_name)
-          return
-        end
+        scope_data = self.class.authorize_by_jwt_scopes
+        return if !scope_data[:scopes] || token_data.scope?(scope_data[:scopes], action_name, scope_data[:app_name])
 
-        render(status: :forbidden, plain: "Invalid scope")
+        render_error("unpermitted_scope")
       end
 
       def show_error_if_authorize_by_jwt_subject_type_fails(token_data)
@@ -80,21 +113,17 @@ module Zaikio
           return
         end
 
-        render(status: :forbidden, plain: "Unallowed subject type")
+        render_error("unpermitted_subject")
       end
 
       def show_error_if_token_is_blacklisted(token_data)
-        return unless blacklisted_token_ids.include?(token_data.jti)
+        return unless Zaikio::JWTAuth.revoked_jwt?(token_data.jti)
 
-        render(status: :forbidden, plain: "Invalid token")
+        render_error("invalid_jwt")
       end
 
-      def blacklisted_token_ids
-        if Zaikio::JWTAuth.configuration.blacklisted_token_ids
-          return Zaikio::JWTAuth.configuration.blacklisted_token_ids
-        end
-
-        DirectoryCache.fetch("api/v1/blacklisted_token_ids.json", expires_after: 5.minutes)["blacklisted_token_ids"]
+      def render_error(error, status: :forbidden)
+        render(status: status, json: { "errors" => [error] })
       end
     end
   end

data/lib/zaikio/jwt_auth/directory_cache.rb

@@ -18,6 +18,19 @@ module Zaikio
           json["data"]
         end
 
+        def update(directory_path, options = {})
+          data = fetch(directory_path, options)
+          data = yield(data)
+          Zaikio::JWTAuth.configuration.redis.set("zaikio::jwt_auth::#{directory_path}", {
+            fetched_at: Time.now.to_i,
+            data: data
+          }.to_json)
+        end
+
+        def reset(directory_path)
+          Zaikio::JWTAuth.configuration.redis.del("zaikio::jwt_auth::#{directory_path}")
+        end
+
         private
 
         def cache_expired?(json, expires_after)

data/lib/zaikio/jwt_auth/test_helper.rb

@@ -0,0 +1,23 @@
+module Zaikio
+  module JWTAuth
+    module TestHelper
+      def after_setup
+        Zaikio::JWTAuth.mocked_jwt_payload = nil
+        super
+      end
+
+      def mock_jwt(extra_payload)
+        Zaikio::JWTAuth.mocked_jwt_payload = {
+          iss: "ZAI",
+          sub: nil,
+          aud: %w[test_app],
+          jti: "unique-access-token-id",
+          nbf: Time.now.to_i,
+          exp: 1.hour.from_now.to_i,
+          jku: "http://directory.zaikio.test/api/v1/jwt_public_keys.json",
+          scope: []
+        }.merge(extra_payload).stringify_keys
+      end
+    end
+  end
+end

data/lib/zaikio/jwt_auth/token_data.rb

@@ -17,6 +17,14 @@ module Zaikio
         @payload = payload
       end
 
+      def audience
+        audiences.first
+      end
+
+      def audiences
+        @payload["aud"] || []
+      end
+
       def scope
         @payload["scope"]
       end
@@ -25,11 +33,12 @@ module Zaikio
         @payload["jti"]
       end
 
-      def scope?(allowed_scopes, action_name)
+      def scope?(allowed_scopes, action_name, app_name = nil)
+        app_name ||= Zaikio::JWTAuth.configuration.app_name
         Array(allowed_scopes).map(&:to_s).any? do |allowed_scope|
           scope.any? do |s|
             parts = s.split(".")
-            parts[0] == Zaikio::JWTAuth.configuration.app_name &&
+            parts[0] == app_name &&
               parts[1] == allowed_scope &&
               action_in_permission?(action_name, parts[2])
           end

data/lib/zaikio/jwt_auth/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module JWTAuth
-    VERSION = "0.1.0".freeze
+    VERSION = "0.1.5".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-jwt_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Crispy Mountain GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -68,6 +68,7 @@ files:
 - lib/zaikio/jwt_auth/directory_cache.rb
 - lib/zaikio/jwt_auth/jwk.rb
 - lib/zaikio/jwt_auth/railtie.rb
+- lib/zaikio/jwt_auth/test_helper.rb
 - lib/zaikio/jwt_auth/token_data.rb
 - lib/zaikio/jwt_auth/version.rb
 homepage: https://www.zaikio.com/