refactor: move $authenticatorHeader and $unusedTokenLifetime to Config\AuthToken

Author: kenjis

src/Authentication/Authenticators/AccessTokens.php

@@ -124,7 +124,7 @@ public function check(array $credentials): Result
         if (! array_key_exists('token', $credentials) || empty($credentials['token'])) {
             return new Result([
                 'success' => false,
-                'reason'  => lang('Auth.noToken', [config('Auth')->authenticatorHeader['tokens']]),
+                'reason'  => lang('Auth.noToken', [config('AuthToken')->authenticatorHeader['tokens']]),
             ]);
         }
 
@@ -149,7 +149,9 @@ public function check(array $credentials): Result
         // Hasn't been used in a long time
         if (
             $token->last_used_at
-            && $token->last_used_at->isBefore(Time::now()->subSeconds(config('Auth')->unusedTokenLifetime))
+            && $token->last_used_at->isBefore(
+                Time::now()->subSeconds(config('AuthToken')->unusedTokenLifetime)
+            )
         ) {
             return new Result([
                 'success' => false,
@@ -188,7 +190,7 @@ public function loggedIn(): bool
         $request = service('request');
 
         return $this->attempt([
-            'token' => $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']),
+            'token' => $request->getHeaderLine(config('AuthToken')->authenticatorHeader['tokens']),
         ])->isOK();
     }
 
@@ -246,7 +248,7 @@ public function getBearerToken(): ?string
         /** @var IncomingRequest $request */
         $request = service('request');
 
-        $header = $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']);
+        $header = $request->getHeaderLine(config('AuthToken')->authenticatorHeader['tokens']);
 
         if (empty($header)) {
             return null;

src/Authentication/Authenticators/HmacSha256.php

@@ -124,7 +124,7 @@ public function check(array $credentials): Result
         if (! array_key_exists('token', $credentials) || $credentials['token'] === '') {
             return new Result([
                 'success' => false,
-                'reason'  => lang('Auth.noToken', [config('Auth')->authenticatorHeader['hmac']]),
+                'reason'  => lang('Auth.noToken', [config('AuthToken')->authenticatorHeader['hmac']]),
             ]);
         }
 
@@ -161,7 +161,9 @@ public function check(array $credentials): Result
         // Hasn't been used in a long time
         if (
             isset($token->last_used_at)
-            && $token->last_used_at->isBefore(Time::now()->subSeconds(config('Auth')->unusedTokenLifetime))
+            && $token->last_used_at->isBefore(
+                Time::now()->subSeconds(config('AuthToken')->unusedTokenLifetime)
+            )
         ) {
             return new Result([
                 'success' => false,
@@ -200,7 +202,7 @@ public function loggedIn(): bool
         $request = service('request');
 
         return $this->attempt([
-            'token' => $request->getHeaderLine(config('Auth')->authenticatorHeader['hmac']),
+            'token' => $request->getHeaderLine(config('AuthToken')->authenticatorHeader['hmac']),
         ])->isOK();
     }
 
@@ -260,7 +262,7 @@ public function getFullHmacToken(): ?string
         /** @var IncomingRequest $request */
         $request = service('request');
 
-        $header = $request->getHeaderLine(config('Auth')->authenticatorHeader['hmac']);
+        $header = $request->getHeaderLine(config('AuthToken')->authenticatorHeader['hmac']);
 
         if ($header === '') {
             return null;

src/Config/Auth.php

@@ -146,6 +146,8 @@ class Auth extends BaseConfig
      * The name of Header that the Authorization token should be found.
      * According to the specs, this should be `Authorization`, but rare
      * circumstances might need a different header.
+     *
+     * @deprecated Moved to AuthToken. No longer used.
      */
     public array $authenticatorHeader = [
         'tokens' => 'Authorization',
@@ -158,6 +160,8 @@ class Auth extends BaseConfig
      * --------------------------------------------------------------------
      * Determines the amount of time, in seconds, that an unused
      * access token can be used.
+     *
+     * @deprecated Moved to AuthToken. No longer used.
      */
     public int $unusedTokenLifetime = YEAR;
 

src/Config/AuthToken.php

@@ -24,6 +24,28 @@ class AuthToken extends BaseConfig
      */
     public int $recordLoginAttempt = Auth::RECORD_LOGIN_ATTEMPT_FAILURE;
 
+    /**
+     * --------------------------------------------------------------------
+     * Name of Authenticator Header
+     * --------------------------------------------------------------------
+     * The name of Header that the Authorization token should be found.
+     * According to the specs, this should be `Authorization`, but rare
+     * circumstances might need a different header.
+     */
+    public array $authenticatorHeader = [
+        'tokens' => 'Authorization',
+        'hmac'   => 'Authorization',
+    ];
+
+    /**
+     * --------------------------------------------------------------------
+     * Unused Token Lifetime
+     * --------------------------------------------------------------------
+     * Determines the amount of time, in seconds, that an unused token can
+     * be used.
+     */
+    public int $unusedTokenLifetime = YEAR;
+
     /**
      * --------------------------------------------------------------------
      * HMAC secret key byte size

tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php

@@ -110,7 +110,7 @@ public function testCheckNoToken(): void
         $result = $this->auth->check([]);
 
         $this->assertFalse($result->isOK());
-        $this->assertSame(lang('Auth.noToken', [config('Auth')->authenticatorHeader['tokens']]), $result->reason());
+        $this->assertSame(lang('Auth.noToken', [config('AuthToken')->authenticatorHeader['tokens']]), $result->reason());
     }
 
     public function testCheckBadToken(): void

tests/Authentication/Authenticators/HmacAuthenticatorTest.php

@@ -131,7 +131,7 @@ public function testCheckNoToken(): void
         $result = $this->auth->check([]);
 
         $this->assertFalse($result->isOK());
-        $this->assertSame(lang('Auth.noToken', [config('Auth')->authenticatorHeader['hmac']]), $result->reason());
+        $this->assertSame(lang('Auth.noToken', [config('AuthToken')->authenticatorHeader['hmac']]), $result->reason());
     }
 
     public function testCheckBadSignature(): void