zaikio-jwt_auth 0.2.5 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c12ee3b69a3ce0152c39d0af1a5af71bc79ac24651b622e7cfa411c851c8d35f
-  data.tar.gz: 48e86c7cf283611de01b8754b5125f16545107c576a544c0c91c9d78be8ebac7
+  metadata.gz: e7fc3c22cfc4c1f3664674815aa450cea8d3607bfc75c9e0fded0849ac199763
+  data.tar.gz: e3452768d900d0f992165e60df3d32743a763da97969a2ddf7b331a60d253f6f
 SHA512:
-  metadata.gz: 22cbcb8445e7c8a7bc56aff7516a4dbce5f5763b41a37599fd123957950883af076f5138d40ceef37ee9a0d8d121e36adb924ac1d9d06aaf4f1df4e762cede4d
-  data.tar.gz: 1d2d5d926d21a79eb734b6ddfd1b4c03f8b7b17b4fc8261bc11dba58722adea46340cb2901c24ac0588553a5d78048145d4ded1e84333246db4e9dfa023b8ca3
+  metadata.gz: fde1af79e8a59aabfbe96d3f020f3180881d220a69ce209e4e4b8d82048e91d9d754c39d97d8604dccbde3aa9c02ef5aa526bb7b444d94b98f53c632efed8932
+  data.tar.gz: 538fb9c7471206bee6c72725720869d2545ded691ae9901f09c0966d42d1d77eb94dfecf9ebd31935ad982c93512584a99b17a095bd16c7eb237ad084a4c3d7c

data/README.md

@@ -49,7 +49,7 @@ end
 
 ### 4. Update Revoked Access Tokens by Webhook
 
-This gem automatically registers a webhook, if you have properly setup [Zaikio::Webhooks](https://github.com/crispymtn/zaikio-webhooks).
+This gem automatically registers a webhook, if you have properly setup [Zaikio::Webhooks](https://github.com/zaikio/zaikio-webhooks).
 
 
 ### 5. Add more restrictions to your resources:
@@ -63,6 +63,26 @@ end
 
 By convention, `authorize_by_jwt_scopes` automatically maps all CRUD actions in a controller. Requests for `show` and `index` with a read or read_write scope are allowed. All other actions like `create`, `update` and `destroy` are accepted if the scope is a write or read_write scope. Therefore it is strongly recommended to always create standard Rails resources. If a custom action is required, you will need to authorize yourself using the `after_jwt_auth`.
 
+#### Modifying required scopes
+If you nonetheless want to change the required scopes for CRUD routes, you can use the `type` option which accepts the following values: `:read`, `:write`, `:read_write`
+
+```rb
+class API::ResourcesController < API::ApplicationController
+  # Require a write or read_write scope on the index route
+  authorize_by_jwt_scopes 'resources', only: :index, type: :write
+end
+```
+
+#### Using custom actions
+You can also specify authorization for custom actions. When doing so the `type` option is required.
+
+```rb
+class API::ResourcesController < API::ApplicationController
+  # Require the index use to have a write or read_write scope
+  authorize_by_jwt_scopes 'resources', only: :my_custom_route, type: :write
+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.
@@ -118,3 +138,32 @@ class API::ResourcesController < API::ApplicationController
   authorize_by_jwt_scopes 'resources', unless: -> { params[:skip] == '1' }
 end
 ```
+
+### Usage outside a Rails controller
+
+If you need to access a JWT outside the normal Rails controllers (e.g. in a Rack
+middleware), there's a static helper method `.extract` which you can use:
+
+```ruby
+class MyRackMiddleware < Rack::Middleware
+  def call(env)
+    token = Zaikio::JWTAuth.extract(env["HTTP_AUTHORIZATION"])
+    puts token.subject_type #=> "Organization"
+    ...
+```
+
+This function expects to receive the string in the format `"Bearer $token"`.
+
+## Contributing
+
+**Make sure you have the dummy app running locally to validate your changes.**
+
+- Make your changes and submit a pull request for them
+- Make sure to update `CHANGELOG.md`
+
+To release a new version of the gem:
+- Update the version in `lib/zaikio/jwt_auth/version.rb`
+- Update `CHANGELOG.md` to include the new version and its release date
+- Commit and push your changes
+- Create a [new release on GitHub](https://github.com/zaikio/zaikio-jwt_auth/releases/new)
+- CircleCI will build the Gem package and push it Rubygems for you

data/app/jobs/zaikio/jwt_auth/revoke_access_token_job.rb

@@ -2,8 +2,8 @@ module Zaikio
   module JWTAuth
     class RevokeAccessTokenJob < ApplicationJob
       def perform(event)
-        DirectoryCache.update("api/v1/blacklisted_access_tokens.json", expires_after: 60.minutes) do |data|
-          data["blacklisted_token_ids"] << event.payload["access_token_id"]
+        DirectoryCache.update("api/v1/revoked_access_tokens.json", expires_after: 60.minutes) do |data|
+          data["revoked_token_ids"] << event.payload["access_token_id"]
           data
         end
       end

data/lib/zaikio/jwt_auth.rb

@@ -1,5 +1,6 @@
 require "jwt"
 require "oj"
+require "active_support/core_ext/integer/time"
 require "zaikio/jwt_auth/railtie"
 require "zaikio/jwt_auth/configuration"
 require "zaikio/jwt_auth/directory_cache"
@@ -26,16 +27,16 @@ module Zaikio
     end
 
     def self.revoked_jwt?(jti)
-      blacklisted_token_ids.include?(jti)
+      revoked_token_ids.include?(jti)
     end
 
-    def self.blacklisted_token_ids
+    def self.revoked_token_ids
       return [] if mocked_jwt_payload
 
-      configuration.blacklisted_token_ids || DirectoryCache.fetch(
-        "api/v1/blacklisted_access_tokens.json",
+      configuration.revoked_token_ids || DirectoryCache.fetch(
+        "api/v1/revoked_access_tokens.json",
         expires_after: 60.minutes
-      )["blacklisted_token_ids"]
+      )["revoked_token_ids"]
     end
 
     def self.included(base)
@@ -51,6 +52,20 @@ module Zaikio
       @mocked_jwt_payload = payload
     end
 
+    HEADER_FORMAT = /\ABearer (.+)\z/.freeze
+
+    def self.extract(authorization_header_string)
+      return TokenData.new(Zaikio::JWTAuth.mocked_jwt_payload) if Zaikio::JWTAuth.mocked_jwt_payload
+
+      return if authorization_header_string.blank?
+
+      return unless (token = authorization_header_string[HEADER_FORMAT, 1])
+
+      payload, = JWT.decode(token, nil, true, algorithms: ["RS256"], jwks: JWK.loader)
+
+      TokenData.new(payload)
+    end
+
     module ClassMethods
       def authorize_by_jwt_subject_type(type = nil)
         @authorize_by_jwt_subject_type ||= type
@@ -67,11 +82,10 @@ module Zaikio
 
     module InstanceMethods
       def authenticate_by_jwt
-        render_error("no_jwt_passed", status: :unauthorized) && return unless jwt_from_auth_header
-
-        token_data = TokenData.new(jwt_payload)
+        token_data = Zaikio::JWTAuth.extract(request.headers["Authorization"])
+        return render_error("no_jwt_passed", status: :unauthorized) unless token_data
 
-        return if show_error_if_token_is_blacklisted(token_data)
+        return if show_error_if_token_is_revoked(token_data)
 
         return if show_error_if_authorize_by_jwt_subject_type_fails(token_data)
 
@@ -84,11 +98,11 @@ module Zaikio
         render_error("invalid_jwt") && (return)
       end
 
-      def update_blacklisted_access_tokens_by_webhook
+      def update_revoked_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]
+        DirectoryCache.update("api/v1/revoked_access_tokens.json", expires_after: 60.minutes) do |data|
+          data["revoked_token_ids"] << params[:payload][:access_token_id]
           data
         end
 
@@ -97,21 +111,6 @@ module Zaikio
 
       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)
         return if token_data.scope_by_configurations?(
           self.class.authorize_by_jwt_scopes,
@@ -131,7 +130,7 @@ module Zaikio
         render_error("unpermitted_subject")
       end
 
-      def show_error_if_token_is_blacklisted(token_data)
+      def show_error_if_token_is_revoked(token_data)
         return unless Zaikio::JWTAuth.revoked_jwt?(token_data.jti)
 
         render_error("invalid_jwt")

data/lib/zaikio/jwt_auth/configuration.rb

@@ -4,25 +4,25 @@ module Zaikio
   module JWTAuth
     class Configuration
       HOSTS = {
-        development: "http://directory.zaikio.test",
-        test: "http://directory.zaikio.test",
-        staging: "https://directory.staging.zaikio.com",
-        sandbox: "https://directory.sandbox.zaikio.com",
-        production: "https://directory.zaikio.com"
+        development: "http://hub.zaikio.test",
+        test: "http://hub.zaikio.test",
+        staging: "https://hub.staging.zaikio.com",
+        sandbox: "https://hub.sandbox.zaikio.com",
+        production: "https://hub.zaikio.com"
       }.freeze
 
-      attr_accessor :app_name
-      attr_accessor :redis, :host
+      attr_accessor :app_name, :redis, :host
       attr_reader :environment
-      attr_writer :logger, :blacklisted_token_ids, :keys
+      attr_writer :logger, :revoked_token_ids, :keys
 
       def initialize
         @environment = :sandbox
-        @blacklisted_token_ids = nil
+        @revoked_token_ids = nil
+        @keys = nil
       end
 
       def logger
-        @logger ||= Logger.new(STDOUT)
+        @logger ||= Logger.new($stdout)
       end
 
       def environment=(env)
@@ -31,11 +31,11 @@ module Zaikio
       end
 
       def keys
-        defined?(@keys) && @keys.is_a?(Proc) ? @keys.call : @keys
+        @keys.is_a?(Proc) ? @keys.call : @keys
       end
 
-      def blacklisted_token_ids
-        @blacklisted_token_ids.is_a?(Proc) ? @blacklisted_token_ids.call : @blacklisted_token_ids
+      def revoked_token_ids
+        @revoked_token_ids.is_a?(Proc) ? @revoked_token_ids.call : @revoked_token_ids
       end
 
       private

data/lib/zaikio/jwt_auth/test_helper.rb

@@ -14,7 +14,7 @@ module Zaikio
           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",
+          jku: "http://hub.zaikio.test/api/v1/jwt_public_keys.json",
           scope: []
         }.merge(extra_payload).stringify_keys
       end

data/lib/zaikio/jwt_auth/token_data.rb

@@ -2,7 +2,7 @@ module Zaikio
   module JWTAuth
     class TokenData
       def self.subject_format
-        %r{^((\w+)/((\w|-)+)\>)?(\w+)/((\w|-)+)$}
+        %r{^((\w+)/((\w|-)+)>)?(\w+)/((\w|-)+)$}
       end
 
       def self.actions_by_permission
@@ -13,6 +13,14 @@ module Zaikio
         }.freeze
       end
 
+      def self.permissions_by_type
+        {
+          read: %w[r rw],
+          write: %w[rw w],
+          read_write: %w[r rw w]
+        }
+      end
+
       def initialize(payload)
         @payload = payload
       end
@@ -33,9 +41,13 @@ module Zaikio
         @payload["jti"]
       end
 
+      def expires_at
+        Time.zone.at(@payload["exp"]).to_datetime
+      end
+
       # scope_options is an array of objects with:
-      # scope, app_name (optional), except/only (array, optional)
-      def scope_by_configurations?(scope_configurations, action_name, context)
+      # scope, app_name (optional), except/only (array, optional), type (read, write, readwrite)
+      def scope_by_configurations?(scope_configurations, action_name, context) # rubocop:disable Metrics/AbcSize
         configuration = scope_configurations.find do |scope_configuration|
           action_matches = action_matches_config?(scope_configuration, action_name)
 
@@ -50,7 +62,7 @@ module Zaikio
 
         return true unless configuration
 
-        scope?(configuration[:scopes], action_name, configuration[:app_name])
+        scope?(configuration[:scopes], action_name, app_name: configuration[:app_name], type: configuration[:type])
       end
 
       def action_matches_config?(scope_configuration, action_name)
@@ -63,14 +75,14 @@ module Zaikio
         end
       end
 
-      def scope?(allowed_scopes, action_name, app_name = nil)
+      def scope?(allowed_scopes, action_name, app_name: nil, type: 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] == app_name &&
               parts[1] == allowed_scope &&
-              action_in_permission?(action_name, parts[2])
+              action_permitted?(action_name, parts[2], type: type)
           end
         end
       end
@@ -97,8 +109,14 @@ module Zaikio
 
       private
 
-      def action_in_permission?(action_name, permission)
-        self.class.actions_by_permission[permission].include?(action_name)
+      def action_permitted?(action_name, permission, type: nil)
+        if type
+          return false unless self.class.permissions_by_type.key?(type)
+
+          self.class.permissions_by_type[type].include?(permission)
+        else
+          self.class.actions_by_permission[permission].include?(action_name)
+        end
       end
     end
   end

data/lib/zaikio/jwt_auth/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module JWTAuth
-    VERSION = "0.2.5".freeze
+    VERSION = "0.4.2".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-jwt_auth
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.4.2
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -78,10 +78,12 @@ files:
 - 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/
+homepage: https://github.com/zaikio/zaikio-jwt_auth
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-jwt_auth/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/zaikio/zaikio-jwt_auth
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: JWT-Based authentication and authorization with zaikio