warden-jwt_auth 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 639d91603d4e369d3d94c0dadc24816c08019ebdfef3c093fc9b8cd79a5d6bd3
-  data.tar.gz: 39f9a053ed2af021eed742b94aa3e2360481c5120d8690085d40773470ec21e2
+  metadata.gz: 260c2b0490d54bd3d4c2b359774209e3f326429b41fc7cbceb310253e9d55b46
+  data.tar.gz: 6f43001c9de49f7cbd9c071a881344d50e0eb9c157552100407f0fa65c1ff3a5
 SHA512:
-  metadata.gz: 727924aa4f6c6a993548c397e108bdb43b281047928aeaf8dcbe0a291784aa4bc4e2f25804b36a7d5549cb858e3006ba7997b0ec6d3dc762196586fe282aeedb
-  data.tar.gz: 9152d951c19f477c23cde9e0e1b5437f8b33821e39825e355a1edfedf14ce3f7b14ea5798e0b1ae23ffb274892c58287dbdab1d06f38c49393f23a9007006f53
+  metadata.gz: 6c017145c06a747e5966e382940cf94b2dc247027a9c19b466a127a85ad5809db085d8e17483531a341c1f208b2fc25e8b007a994b387afc5fcf41c6d2256104
+  data.tar.gz: 5fee963870a4f3bf0ecb356d764610e146f6d4557817b21c0d9f53ef4ba304449b3ea35d12e548ffaa02a9b12060e8099af18a4b9f68a47b4878cc8755df2a47

data/CHANGELOG.md

@@ -4,7 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.8.0] - 2024-06-28
+## [0.10.0] - 2024-07-10
+- Add support for configurable token header ([55](https://github.com/waiting-for-dev/warden-jwt_auth/pull/55))
+
+## [0.9.0] - 2024-06-28
 - Add support for issue claim ([56](https://github.com/waiting-for-dev/warden-jwt_auth/pull/56))
 
 ## [0.8.0] - 2023-01-31

data/README.md

@@ -145,7 +145,7 @@ config.dispatch_requests = [
 
 **Important**: You are encouraged to delimit your regular expression with `^` and `$` to avoid unintentional matches.
 
-Tokens will be returned in the `Authorization` response header, with format `Bearer #{token}`.
+Tokens will be returned in the `Authorization` response header (configurable via `config.token_header`), with format `Bearer #{token}`.
 
 ### Requests authentication
 

data/lib/warden/jwt_auth/env_helper.rb

@@ -25,16 +25,17 @@ module Warden
         env['REQUEST_METHOD']
       end
 
-      # Returns HTTP_AUTHORIZATION environment variable
+      # Returns header configured through `token_header` option
       #
       # @param env [Hash] Rack env
       # @return [String]
       def self.authorization_header(env)
-        env['HTTP_AUTHORIZATION']
+        header_env_name = env_name(JWTAuth.config.token_header)
+        env[header_env_name]
       end
 
-      # Returns a copy of `env` with value added to the `HTTP_AUTHORIZATION`
-      # environment variable.
+      # Returns a copy of `env` with value added to the environment variable
+      # configured through `token_header` option
       #
       # Be aware than `env` is not modified in place and still an updated copy
       # is returned.
@@ -44,7 +45,8 @@ module Warden
       # @return [Hash] modified rack env
       def self.set_authorization_header(env, value)
         env = env.dup
-        env['HTTP_AUTHORIZATION'] = value
+        header_env_name = env_name(JWTAuth.config.token_header)
+        env[header_env_name] = value
         env
       end
 
@@ -53,8 +55,16 @@ module Warden
       # @param env [Hash] Rack env
       # @return [String]
       def self.aud_header(env)
-        env_name = ('HTTP_' + JWTAuth.config.aud_header.upcase).tr('-', '_')
-        env[env_name]
+        header_env_name = env_name(JWTAuth.config.aud_header)
+        env[header_env_name]
+      end
+
+      # Returns the ENV name for a given header
+      #
+      # @param header [String] Header name
+      # @return [String]
+      def self.env_name(header)
+        ('HTTP_' + header.upcase).tr('-', '_')
       end
     end
   end

data/lib/warden/jwt_auth/header_parser.rb

@@ -21,8 +21,8 @@ module Warden
         method == METHOD ? token : nil
       end
 
-      # Returns a copy of `env` with token added to the `HTTP_AUTHORIZATION`
-      # header. Be aware than `env` is not modified in place.
+      # Returns a copy of `env` with token added to the header configured through
+      # `token_header` option. Be aware than `env` is not modified in place.
       #
       # @param env [Hash] rack env hash
       # @param token [String] JWT token
@@ -39,7 +39,7 @@ module Warden
       # @return [Hash] response headers with the token added
       def self.to_headers(headers, token)
         headers = headers.dup
-        headers['Authorization'] = "#{METHOD} #{token}"
+        headers[JWTAuth.config.token_header] = "#{METHOD} #{token}"
         headers
       end
     end

data/lib/warden/jwt_auth/version.rb

@@ -2,6 +2,6 @@
 
 module Warden
   module JWTAuth
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   end
 end

data/lib/warden/jwt_auth.rb

@@ -53,6 +53,9 @@ module Warden
     # Expiration time for tokens
     setting :expiration_time, default: 3600
 
+    # Request header that will be used for receiving and returning the token.
+    setting :token_header, default: 'Authorization'
+
     # The issuer claims associated with the tokens
     #
     # Will be used to only apply the warden strategy when the issuer matches.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warden-jwt_auth
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Marc Busqué
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-auto_inject