Merge pull request #442 from datamweb/fix-error-if-set-authenticatorHeader

datamweb · web-flow · commit a53c10684d16 · 2022-09-21T17:23:22.000+04:30
fix: correct display of the error in case of change `authenticatorHeader`
diff --git a/docs/guides/api_tokens.md b/docs/guides/api_tokens.md
@@ -2,6 +2,8 @@
 
 Access Tokens can be used to authenticate users for your own site, or when allowing third-party developers to access your API. When making requests using access tokens, the token should be included in the `Authorization` header as a `Bearer` token.
 
+> **Note**  By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change this value by setting the `$authenticatorHeader['tokens']` value in the `Auth.php` config file.
+
 Tokens are issued with the `generateAccessToken()` method on the user. This returns a `CodeIgniter\Shield\Entities\AccessToken` instance. Tokens are hashed using a SHA-256 algorithm before being saved to the database. The access token returned when you generate it will include a `raw_token` field that contains the plain-text, un-hashed, token. You should display this to your user at once so they have a chance to copy it somewhere safe, as this is the only time this will be available. After this request, there is no way to get the raw token.
 
 The `generateAccessToken()` method requires a name for the token. These are free strings and are often used to identify the user/device the token was generated from, like 'Johns MacBook Air'.
diff --git a/docs/guides/mobile_apps.md b/docs/guides/mobile_apps.md
@@ -58,3 +58,9 @@ class LoginController extends BaseController
 ```
 
 When making all future requests to the API, the mobile client should return the raw token in the `Authorization` header as a `Bearer` token.
+
+> **Note**
+>
+> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change the header name by setting the `$authenticatorHeader['tokens']` value in the `Auth.php` config file.
+>
+> e.g. if `$authenticatorHeader['tokens']` is set to `PersonalAccessCodes` then the mobile client should return the raw token in the `PersonalAccessCodes` header as a `Bearer` token.
diff --git a/src/Authentication/Authenticators/AccessTokens.php b/src/Authentication/Authenticators/AccessTokens.php
@@ -95,7 +95,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'),
+                'reason'  => lang('Auth.noToken', [config('Auth')->authenticatorHeader['tokens']]),
             ]);
         }
 
diff --git a/src/Language/de/Auth.php b/src/Language/de/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'Sie konnten nicht angemeldet werden. Bitte überprüfen Sie Ihre Anmeldedaten.',
     'noPassword'            => 'Kann einen Benutzer ohne Passwort nicht validieren.',
     'invalidPassword'       => 'Sie können nicht angemeldet werden. Bitte überprüfen Sie Ihr Passwort.',
-    'noToken'               => 'Jede Anfrage muss ein Überbringer-Token im Authorization-Header enthalten.',
+    'noToken'               => 'Jede Anfrage muss ein Überbringer-Token im {0}-Header enthalten.',
     'badToken'              => 'Das Zugriffstoken ist ungültig.',
     'oldToken'              => 'Das Zugriffstoken ist abgelaufen.',
     'noUserEntity'          => 'Die Benutzerentität muss für die Passwortüberprüfung angegeben werden.',
diff --git a/src/Language/en/Auth.php b/src/Language/en/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'Unable to log you in. Please check your credentials.',
     'noPassword'            => 'Cannot validate a user without a password.',
     'invalidPassword'       => 'Unable to log you in. Please check your password.',
-    'noToken'               => 'Every request must have a bearer token in the Authorization header.',
+    'noToken'               => 'Every request must have a bearer token in the {0} header.',
     'badToken'              => 'The access token is invalid.',
     'oldToken'              => 'The access token has expired.',
     'noUserEntity'          => 'User Entity must be provided for password validation.',
diff --git a/src/Language/es/Auth.php b/src/Language/es/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'No puedes entrar. Por favor, comprueba tus creenciales.',
     'noPassword'            => 'No se puede validar un usuario sin una contraseña.',
     'invalidPassword'       => 'No uedes entrar. Por favor, comprueba tu contraseña.',
-    'noToken'               => 'Cada petición debe tenerun token en la Authorización.',
+    'noToken'               => 'Cada petición debe tenerun token en la {0}.',
     'badToken'              => 'Token de acceso no válido.',
     'oldToken'              => 'El token de acceso ha caducado.',
     'noUserEntity'          => 'Se debe dar una Entidad de Usuario para validar la contraseña.',
diff --git a/src/Language/fa/Auth.php b/src/Language/fa/Auth.php
@@ -21,7 +21,7 @@
     'badAttempt'            => 'امکان ورود به سیستم نیست. لطفا اعتبارنامه خود را بررسی کنید.',
     'noPassword'            => 'تایید کاربر بدون رمز عبور ممکن نیست.',
     'invalidPassword'       => 'ناتوان در ورود به سیستم. لطفا رمز عبور خود را بررسی کنید.',
-    'noToken'               => 'هر درخواست باید دارای یک توکن bearer در هدر Authorization باشد.',
+    'noToken'               => 'هر درخواست باید دارای یک توکن bearer در هدر {0} باشد.',
     'badToken'              => 'توکن دسترسی معتبر نمی باشد.',
     'oldToken'              => 'توکن دسترسی منقضی شده است.',
     'noUserEntity'          => 'برای اعتبار سنجی هویت کاربر بایستی رمز عبور ارائه شود',
diff --git a/src/Language/fr/Auth.php b/src/Language/fr/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'Connexion impossible. Veuillez vérifier les informations saisies.',
     'noPassword'            => 'Impossible de valider un utilisateur sans mot de passe.',
     'invalidPassword'       => 'Connexion impossible. Veuillez vérifier votre mot de passe.',
-    'noToken'               => 'Chaque demande doit comporter un jeton d\'accès dans l\'en-tête d\'autorisation.',
+    'noToken'               => 'Chaque demande doit comporter un jeton d\'accès dans l\'en-tête d\'{0}.',
     'badToken'              => 'Le jeton d\'accès est invalide.',
     'oldToken'              => 'Le jeton d\'accès a expiré.',
     'noUserEntity'          => 'User Entity doit être fournie pour la validation du mot de passe.',
diff --git a/src/Language/id/Auth.php b/src/Language/id/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'Anda tidak dapat masuk. Harap periksa kredensial Anda.',
     'noPassword'            => 'Tidak dapat memvalidasi pengguna tanpa kata sandi.',
     'invalidPassword'       => 'Anda tidak dapat masuk. Harap periksa kata sandi Anda.',
-    'noToken'               => 'Setiap permintaan harus memiliki token pembawa di header Authorization.',
+    'noToken'               => 'Setiap permintaan harus memiliki token pembawa di header {0}.',
     'badToken'              => 'Akses token tidak sah.',
     'oldToken'              => 'Akses token sudah tidak berlaku.',
     'noUserEntity'          => 'Entitas Pengguna harus disediakan untuk validasi kata sandi.',
diff --git a/src/Language/ja/Auth.php b/src/Language/ja/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'ログインできません。認証情報を確認してください。', // 'Unable to log you in. Please check your credentials.',
     'noPassword'            => 'パスワードのないユーザーは認証できません。', // 'Cannot validate a user without a password.',
     'invalidPassword'       => 'ログインできません。パスワードを確認してください。', // 'Unable to log you in. Please check your password.',
-    'noToken'               => 'すべてのリクエストは、AuthorizationヘッダーにBearerトークンが必要です。', // 'Every request must have a bearer token in the Authorization header.',
+    'noToken'               => 'すべてのリクエストは、{0}ヘッダーにBearerトークンが必要です。', // 'Every request must have a bearer token in the Authorization header.',
     'badToken'              => 'アクセストークンが無効です。', // 'The access token is invalid.',
     'oldToken'              => 'アクセストークンの有効期限が切れています。', // 'The access token has expired.',
     'noUserEntity'          => 'パスワード検証のため、Userエンティティを指定する必要があります。', // 'User Entity must be provided for password validation.',
diff --git a/src/Language/sk/Auth.php b/src/Language/sk/Auth.php
@@ -12,7 +12,7 @@
     'badAttempt'            => 'Prihlásenie zlyhalo. Skontrolujte svoje prihlasovacie údaje.',
     'noPassword'            => 'Nie je možné overiť používateľa bez hesla.',
     'invalidPassword'       => 'Prihlásenie zlyhalo. Skontrolujte svoje heslo.',
-    'noToken'               => 'Každá požiadavka musí mať v hlavičke Autorizácia nosný token',
+    'noToken'               => 'Každá požiadavka musí mať v hlavičke {0} nosný token',
     'badToken'              => 'Prístupový token je neplatný.',
     'oldToken'              => 'Platnosť prístupového tokenu vypršala.',
     'noUserEntity'          => 'Na overenie hesla je potrebné zadať entitu používateľa.',
diff --git a/tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php b/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'), $result->reason());
+        $this->assertSame(lang('Auth.noToken', [config('Auth')->authenticatorHeader['tokens']]), $result->reason());
     }
 
     public function testCheckBadToken(): void

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public function check(array $credentials): Result`
`95`	`95`	`if (! array_key_exists('token', $credentials) \|\| empty($credentials['token'])) {`
`96`	`96`	`return new Result([`
`97`	`97`	`'success' => false,`
`98`		`- 'reason' => lang('Auth.noToken'),`
	`98`	`+ 'reason' => lang('Auth.noToken', [config('Auth')->authenticatorHeader['tokens']]),`
`99`	`99`	`]);`
`100`	`100`	`}`
`101`	`101`