Route::get('/user', function () {
    //
 })->middleware('auth:api');

$response = $client->request('GET', '/api/user', [
    'headers' => [  
          'Accept' => 'application/json',        
          'Authorization' => 'Bearer '.$accessToken,    
         ],
      ]);

{tip} 默认情况下，访问令牌是长期有效的。你可以根据需要 配置访问令牌的有效时间 。

请求所有作用域

使用密码授权机制时，可以通过请求 scope 参数 * 来授权应用程序支持的所有范围的令牌。如果你的请求中包含 scope 为 * 的参数，令牌实例上的 can 方法会始终返回 true。这种作用域的授权只能分配给使用 password 授权时发出的令牌：

use Laravel\Passport\Passport;
Passport::tokensCan([
    'place-orders' => 'Place orders',    
    'check-status' => 'Check order status',
  ]);

自定义用户名字段

当使用密码授权时，Passport 默认使用 email 作为「用户名」。但是，你可以通过在模型上定义一个 findForPassport 方法来自定义用户名字段:

use Laravel\Passport\Passport;Passport::setDefaultScope([
    'check-status',    
    'place-orders',
  ]);

隐式授权令牌

隐式授权类似于授权码授权，但是它只将令牌返回给客户端而不交换授权码。这种授权最常用于无法安全存储客户端凭据的 JavaScript 或移动应用程序。通过调用 AuthServiceProvider 中的 enableImplicitGrant 方法来启用这种授权：

Route::get('/redirect', function () {
    $query = http_build_query([  
          'client_id' => 'client-id',        
          'redirect_uri' => 'http://example.com/callback',        
          'response_type' => 'code',        
          'scope' => 'place-orders check-status',   
        ]);    
 return redirect('http://your-app.com/oauth/authorize?'.$query);});

调用上面方法开启授权后，开发者可以使用他们的客户端 ID 从应用程序请求访问令牌。接入的应用程序应该向你的应用程序的 /oauth/authorize 路由发出重定向请求，如下所示：

$token = $user->createToken('My Token', ['place-orders'])->accessToken;

{tip} 注意，/oauth/authorize 路由已经在 Passport::routes

'scopes' => \Laravel\Passport\Http\Middleware\CheckScopes::class,
'scope' => \Laravel\Passport\Http\Middleware\CheckForAnyScope::class,

{tip} Par défaut, le jeton d'accès Est efficace à long terme. Vous pouvez configurer la durée de validité du jeton d'accès selon vos besoins

.

🎜Demande de toutes les étendues🎜🎜Lorsque vous utilisez le mécanisme d'autorisation par mot de passe, vous pouvez demander une étendue par les paramètres * pour autoriser toutes les plages de tokens supportées par l'application. Si votre requête inclut des paramètres avec une portée *, la méthode can sur l'instance de jeton retournera toujours true. Les autorisations de cette portée ne peuvent être attribuées qu'aux jetons émis lors de l'utilisation de l'autorisation mot de passe : 🎜

Route::get('/orders', function () { 
   // Access token has both "check-status" and "place-orders" scopes...
   })->middleware('scopes:check-status,place-orders');

🎜🎜🎜

🎜🎜Champ de nom d'utilisateur personnalisé🎜🎜Lors de l'utilisation de l'autorisation par mot de passe, Passport utilise e-mail comme "nom d'utilisateur" par défaut. Cependant, vous pouvez personnaliser le champ du nom d'utilisateur en définissant une méthode findForPassport sur le modèle : 🎜

Route::get('/orders', function () {
    // 访问令牌具有 "check-status" 或 "place-orders" 作用域...
  })->middleware('scope:check-status,place-orders');

🎜🎜🎜

🎜

Jeton d'autorisation implicite

🎜L'autorisation implicite est similaire à l'autorisation par code d'autorisation, mais elle renvoie uniquement le jeton au client sans échanger le code d'autorisation. Cette autorisation est le plus souvent utilisée pour les applications JavaScript ou mobiles qui ne peuvent pas stocker les informations d'identification du client en toute sécurité. Activez cette autorisation en appelant la méthode enableImplicitGrant dans AuthServiceProvider : 🎜

use Illuminate\Http\Request;
Route::get('/orders', function (Request $request) {
    if ($request->user()->tokenCan('place-orders')) { 
           //    
         }
     });

🎜Après avoir appelé la méthode ci-dessus pour activer l'autorisation, les développeurs peuvent utiliser leur ID client pour demander au jeton d'accès de l'application . L'application connectée doit effectuer une demande de redirection vers la route /oauth/authorize de votre application, comme indiqué ci-dessous : 🎜

Laravel\Passport\Passport::scopeIds();

🎜{tip} Remarque, /oauth/ L'autorisation L'itinéraire a déjà été défini dans la méthode Passport::routes, il n'est donc pas nécessaire de définir à nouveau cet itinéraire manuellement. 🎜🎜🎜🎜🎜🎜🎜🎜

Client Credential Grant Token

Client Credential Grant Token convient à l'authentification de machine à machine. Par exemple, vous pouvez utiliser cette autorisation pour effectuer des tâches de maintenance via l'API.

Avant l'autorisation des informations d'identification client, vous devez créer un client d'autorisation des informations d'identification client. Vous pouvez utiliser le paramètre --client de la commande passport:client pour créer : passport:client 命令的 --client 参数来创建:

Laravel\Passport\Passport::scopes();

接下来，要使用这种授权，你首先需要在 app/Http/Kernel.php 的 $routeMiddleware 变量中添加新的中间件：

Laravel\Passport\Passport::scopesFor(['place-orders', 'check-status']);

然后，在路由上追加这个中间件：

Laravel\Passport\Passport::hasScope('place-orders');

若要将对路由的访问限制在某个作用域内，可在将 client 中间件附加到路由时提供以逗号分隔的所需作用域列表:

'web' => [ 
   // 其他中间件...
    \Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
   ],

获取令牌

通过向 oauth/token 接口发出请求来获取令牌:

axios.get('/api/user')
    .then(response => {
        console.log(response.data);    
     });

个人访问令牌

有时候，用户要在不经过传统的授权码重定向流程的情况下向自己发出访问令牌。允许用户通过应用程序用户界面对自己发出令牌，有助于用户体验你的 API，或者也可以将其作为一种更简单的发布访问令牌的方式。

{note} 个人访问令牌是永久有效的，就算使用了 tokensExpireIn 和 refreshTokensExpireIn 方法也不会修改它的生命周期。

创建个人访问客户端

在你的应用程序发布个人访问令牌之前，你需要在 passport:client 命令后带上 --personal 参数来创建对应的客户端。如果你已经运行了 passport:install 命令，则无需再运行此命令：

/**
 * 注册认证 / 授权服务
 *
 * @return void
 */
 public function boot(){
     $this->registerPolicies();    
     Passport::routes();    
     Passport::cookie('custom_name');
   }

如果你已经创建了个人访问客户端，你可以通过调用 AuthServiceProvider 中的 personalAccessClientId 方法来启用：

// In your application layout...
<meta name="csrf-token" content="{{ csrf_token() }}">
// Laravel's JavaScript scaffolding...
window.axios.defaults.headers.common = {
    'X-Requested-With': 'XMLHttpRequest',
   };

管理个人访问令牌

创建个人访问客户端后，你可以使用 User 模型实例上的 createToken 方法来为给定用户发布令牌。createToken

/**
 * 应用程序事件监听映射
 *
 * @var array
 */
 protected $listen = [
     'Laravel\Passport\Events\AccessTokenCreated' => [
             'App\Listeners\RevokeOldTokens', 
               ],    
      'Laravel\Passport\Events\RefreshTokenCreated' => [ 
             'App\Listeners\PruneOldTokens',   
             ],
         ];

. Ensuite, pour utiliser cette autorisation, vous devez d'abord ajouter un nouveau middleware dans la variable $routeMiddleware de app/Http/Kernel.php :

use App\User;
use Laravel\Passport\Passport;
public function testServerCreation(){
    Passport::actingAs(  
          factory(User::class)->create(),   
               ['create-servers']  
             );    
         $response = $this->post('/api/create-server');    
        $response->assertStatus(201);
     }

Ensuite, ajoutez ce middleware à la route :

rrreee

Pour limiter l'accès à la route à une certaine étendue, fournissez la liste des étendues requises séparées par des virgules : 🎜rrreee

🎜

Obtenez un token

🎜En faisant une demande à l'interface oauth/token Pour obtenir des tokens :🎜rrreee🎜🎜🎜

🎜🎜Jetons d'accès personnels🎜🎜Parfois, les utilisateurs souhaitent vous émettre un jeton d'accès sans passer par le processus traditionnel de redirection du code d'autorisation. Permettre aux utilisateurs de s'émettre des jetons via l'interface utilisateur de l'application peut aider les utilisateurs à découvrir votre API, ou cela peut être utilisé comme un moyen plus simple d'émettre des jetons d'accès. 🎜

🎜{note} Les jetons d'accès personnels sont valides en permanence, et leur cycle de vie ne sera pas modifié même si les méthodes tokensExpireIn et refreshTokensExpireIn sont utilisées. 🎜

🎜🎜🎜

🎜

Création d'un client d'accès personnel🎜Avant que votre application n'émette un jeton d'accès personnel, vous devez créer le client correspondant avec le paramètre --personal après la commande passport:client. Si vous avez déjà exécuté la commande passport:install, vous n'avez pas besoin de réexécuter cette commande : 🎜rrreee🎜Si vous avez déjà créé un client d'accès personnel, vous pouvez le faire en appelant le AuthServiceProvider La méthode personalAccessClientId pour activer : 🎜rrreee🎜🎜🎜

🎜

Gérer les jetons d'accès personnels

🎜Après avoir créé un client d'accès personnel, vous pouvez utiliser la méthode createToken sur l'instance de modèle Utilisateur pour émettre un jeton pour un utilisateur donné. La méthode createToken accepte le nom du token comme premier paramètre et un tableau 🎜scope🎜 optionnel comme deuxième paramètre : 🎜rrreee🎜🎜

API JSON

Passport dispose également d'une API JSON pour gérer les jetons d'accès personnels. Vous pouvez l'associer à votre propre frontal pour fournir aux utilisateurs un tableau de bord pour gérer les jetons d'accès personnels. Nous décrivons ci-dessous toutes les interfaces API permettant de gérer les jetons d'accès personnels. Pour plus de commodité, nous utilisons Axios pour démontrer l'envoi de requêtes HTTP à l'interface API.

L'API JSON est protégée par les middlewares web et auth ; elle ne peut donc être appelée que depuis votre propre application. Il ne peut pas être appelé à partir de sources externes. web 和 auth 中间件保护；因此，只能从您自己的应用程序中调用它。无法从外部源调用它。

{tip} 如果你不想实现自己的个人访问令牌管理的前端界面，可以根据  前端快速上手 在几分钟内组建功能齐全的前端界面。

GET /oauth/scopes

此路由会返回应用程序中定义的所有 作用域。你可以使用此路由列出用户可能分配给个人访问令牌的范围：

rrreee

GET /oauth/personal-access-tokens

此路由返回认证用户创建的所有个人访问令牌。这主要用于列出所有用户的令牌，以便他们可以编辑或删除它们：

rrreee

POST /oauth/personal-access-tokens

此路由用于创建新的个人访问令牌。它需要两个数据：令牌的 name 和 scpoe：

rrreee

DELETE /oauth/personal-access-tokens/{token-id}

此路由可用于删除个人访问令牌：

rrreee

路由保护

通过中间件

Passport 包含一个 验证保护机制 可以验证请求中传入的访问令牌。配置 api 的看守器使用 passport 驱动程序后，只需要在需要有效访问令牌的任何路由上指定 auth:api 中间件：

rrreee

传递访问令牌

当调用 Passport 保护下的路由时，接入的 API 应用需要将访问令牌作为 Bearer 令牌放在请求头 Authorization

{tip} Si vous ne souhaitez pas implémenter votre propre interface frontale pour la gestion des jetons d'accès personnels, vous pouvez créer une interface frontale entièrement fonctionnelle en quelques minutes selon Démarrage rapide du front-end

.

GET /oauth/scopes

Cette route renverra tous les Portées🎜. Vous pouvez utiliser cette route pour répertorier les étendues auxquelles un utilisateur peut être attribué aux jetons d'accès personnels : 🎜rrreee

🎜🎜GET /oauth/personal-access- tokens< /code>🎜🎜Cette route renvoie tous les jetons d'accès personnels créés par l'utilisateur authentifié. Ceci est principalement utilisé pour répertorier tous les jetons des utilisateurs afin qu'ils puissent les modifier ou les supprimer : 🎜rrreee

🎜🎜POST /oauth/personal-access-tokens< /code>🎜🎜Cette route est utilisée pour créer de nouveaux jetons d'accès personnels. Il nécessite deux éléments de données : le name et le scpoe du jeton : 🎜rrreee

🎜🎜DELETE /oauth/personal-access-tokens/{token-id}🎜🎜Cette route peut être utilisée pour supprimer des jetons d'accès personnels : 🎜rrreee🎜🎜🎜

🎜

Protection des routes

🎜🎜🎜

🎜 < h3>Via middleware

🎜Passport inclut un mécanisme de protection par authentification qui permet de vérifier le jeton d'accès transmis dans la requête. Après avoir configuré l'observateur de api pour utiliser le pilote passport, il vous suffit de spécifier le middleware auth:api sur toute route nécessitant un identifiant valide. jeton d'accès : 🎜rrreee🎜🎜🎜

🎜

Passer le jeton d'accès

🎜 Lors de l'appel Lors du routage sous protection Passport, l'application API accédée doit placer le jeton d'accès en tant que jeton Bearer dans l'en-tête de la demande Autorisation. Par exemple, lorsque vous utilisez la bibliothèque HTTP Guzzle : 🎜rrreee🎜🎜🎜🎜🎜🎜

Token Scope

Scope permet aux clients API de demander des autorisations spécifiques lors de la demande d'autorisation de compte. Par exemple, si vous créez une application de commerce électronique, toutes les applications API qui s'y connectent n'auront pas besoin de pouvoir passer des commandes. Vous pouvez autoriser les applications API connectées à accéder uniquement au statut d'expédition des commandes. En d’autres termes, la portée permet aux utilisateurs d’une application de limiter les actions que les applications tierces peuvent effectuer.

Définissez la portée

Vous pouvez utiliser la méthode Passport::tokensCan dans la méthode boot de AuthServiceProvider pour définissez-le La portée de l'API. La méthode tokensCan accepte un tableau contenant le nom de la portée et la description comme paramètres. La description de la portée sera affichée directement à l'utilisateur sur la page de confirmation d'autorisation. Vous pouvez la définir comme tout ce dont vous avez besoin : AuthServiceProvider 的 boot 方法中使用 Passport::tokensCan 方法来定义 API 的作用域。tokensCan 方法接受一个包含作用域名称和描述的数组作为参数。作用域描述将会在授权确认页中直接展示给用户，你可以将其定义为任何你需要的内容：

rrreee

默认作用域

如果客户端没有请求任何特定的范围，你可以在 AuthServiceProvider 的 boot 方法中使用 Passport::setDefaultScope 方法来定义默认的作用域。

rrreee

给令牌分配作用域

请求授权码

使用授权码请求访问令牌时，接入的应用需为 scope 参数指定所需作用域。 scope 参数包含多个作用域时，名称之间使用空格分割：

rrreee

分发个人访问令牌

使用 User 模型的 createToken 方法发放个人访问令牌时，可以将所需作用域的数组作为第二个参数传给此方法：

rrreee

检查作用域

Passport 包含两个中间件，可用于验证传入的请求是否包含访问指定作用域的令牌。 使用之前，需要将下面的中间件添加到 app/Http/Kernel.php 文件的 $routeMiddleware 属性中：

rrreee

检查所有作用域

路由可以使用 scopes 中间件来检查当前请求是否拥有指定的 所有 作用域：

rrreee

检查任意作用域

路由可以使用 scoperrreee

Portée par défaut🎜🎜Si le client ne demande aucune portée spécifique, vous pouvez utiliser dans la méthode boot de AuthServiceProvider Passport : méthode setDefaultScope pour définir la portée par défaut. 🎜rrreee🎜🎜🎜

🎜🎜Attribution de portées aux jetons🎜

🎜

Demander un code d'autorisation

🎜Lorsque vous utilisez le code d'autorisation pour demander un jeton d'accès, l'application connectée doit spécifier la portée requise pour le paramètre scope. Lorsque le paramètre scope contient plusieurs scopes, utilisez des espaces pour séparer les noms : 🎜rrreee

🎜

Distribuer les jetons d'accès personnels< /h4 >🎜Lorsque vous utilisez la méthode createToken du modèle User pour émettre un jeton d'accès personnel, vous pouvez transmettre le tableau de la portée requise comme deuxième paramètre à cette méthode : 🎜 rrreee🎜🎜🎜

🎜🎜Vérification des étendues🎜🎜Passport contient deux middlewares qui peuvent être utilisés pour valider les demandes entrantes S'il faut inclure un jeton pour accéder à la portée spécifiée. Avant utilisation, vous devez ajouter le middleware suivant à l'attribut $routeMiddleware du fichier app/Http/Kernel.php : 🎜rrreee

🎜

Vérifier toutes les étendues

🎜Les routes peuvent utiliser le middleware scopes pour vérifier si la requête actuelle a les 🎜toutes🎜 étendues spécifiées : 🎜rrreee

🎜

Vérifier n'importe quelle portée

🎜La route peut utiliser le middleware scope pour vérifier si la requête actuelle a la 🎜any spécifiée 🎜 Portée : 🎜rrreee🎜🎜

Vérifiez la portée sur l'instance de jeton

Même si la requête contenant la vérification du jeton d'accès a été authentifiée par l'application, vous pouvez toujours utiliser le tokenCanUtilisateur actuellement autorisé. instance > Méthode pour vérifier si le jeton a la portée spécifiée : User 实例上的 tokenCan 方法来验证令牌是否拥有指定的作用域：

rrreee

附加作用域方法

scopeIds 方法将返回所有已定义 ID / 名称的数组：

rrreee

scopes 方法将返回一个 包含所有已定义作用域数组的 LaravelPassportScope 实例：

rrreee

scopesFor 方法将返回与给定 ID / 名称匹配的 LaravelPassportScope 实例数组：

rrreee

你可以使用 hasScope 方法确定是否已定义给定作用域：

rrreee

使用 JavaScript 接入 API

在构建 API 时， 如果能通过 JavaScript 应用接入自己的 API 将会给开发过程带来极大的便利。这种 API 开发方法允许你使用自己的应用程序的 API 和别人共享的 API 。你的 Web 应用程序、移动应用程序、第三方应用程序以及可能在各种软件包管理器上发布的任何 SDK 都可能会使用相同的 API 。

通常，如果要在 JavaScript 应用程序中使用 API ，需要手动向应用程序发送访问令牌，并将其传递给应用程序。但是， Passport 有一个可以处理这个问题的中间件。将 CreateFreshApiToken 中间件添加到 app/Http/Kernel.php 文件中的 web 中间件组就可以了：

rrreee

{note} 你应该确保在您的中间件堆栈中 CreateFreshApiToken 中间件之前列出了 EncryptCookies 中间件。

这个 Passport 中间件将在你所有的对外请求中添加一个 laravel_token cookie 。该 cookie 将包含一个加密后的 JWT ， Passport 将用来验证来自 JavaScript 应用程序的 API 请求。至此，你可以在不明确传递访问令牌的情况下向应用程序的 API 发出请求：

rrreee

自定义 Cookie 名称

如果需要，你可以在 AuthServiceProvider 的 boot 方法中使用 Passport::cookie 方法来自定义 laravel_token cookie 的名称。

rrreee

CSRF 保护

当使用这种授权方法时，默认的 Laravel JavaScript 脚手架会让 Axios 发送 X-CSRF-TOKEN 和 X-Requested-Withrrreee

Méthode de portée supplémentairescopeIds renverra tous les tableaux des ID/noms définis :

rrreee

scopes La méthode renverra une instance de LaravelPassportScope contenant un tableau de toutes les étendues définies :

rrreee🎜scopesFor renverra un tableau d'instances LaravelPassportScope qui correspondent à l'ID/nom donné : 🎜rrreee🎜Vous pouvez utiliser la méthode hasScope pour déterminer si une portée donnée est définie : 🎜rrreee 🎜🎜🎜

🎜

Utilisez JavaScript pour accéder à l'API

🎜Construire une API, si vous pouvez accéder à votre propre API via des applications JavaScript, cela apportera une grande commodité au processus de développement. Cette méthode de développement d'API vous permet d'utiliser l'API de votre propre application et les API partagées par d'autres. Votre application Web, votre application mobile, vos applications tierces et tous les SDK que vous pourriez publier sur différents gestionnaires de packages utiliseront probablement la même API. 🎜🎜Normalement, si vous souhaitez utiliser l'API dans une application JavaScript, vous devez envoyer manuellement le jeton d'accès et le transmettre à l'application. Cependant, Passport dispose d'un middleware qui gère ce problème. Ajoutez simplement le middleware CreateFreshApiToken au groupe de middlewares web dans le fichier app/Http/Kernel.php : 🎜rrreee

🎜{note } Vous devez vous assurer que le middleware EncryptCookies est répertorié avant le middleware CreateFreshApiToken dans votre pile de middleware. 🎜

🎜Ce middleware Passport ajoutera un cookie laravel_token à toutes vos demandes sortantes. Ce cookie contiendra un JWT crypté que Passport utilisera pour authentifier les requêtes API des applications JavaScript. À ce stade, vous pouvez faire des requêtes à l'API de votre application sans transmettre explicitement le jeton d'accès : 🎜rrreee

🎜🎜Nom du cookie personnalisé🎜🎜Si nécessaire, vous pouvez utiliser le Méthode Passport::cookie dans la méthode boot de AuthServiceProvider pour personnaliser le nom du cookie laravel_token. 🎜rrreee

🎜🎜Protection CSRF🎜🎜Lors de l'utilisation de cette méthode d'autorisation, l'échafaudage JavaScript Laravel par défaut amènera Axios à envoyer le code X-CSRF-TOKEN et les en-têtes de requête X-Requested-With. De plus, vous devez vous assurer que le jeton CSRF est inclus dans la balise méta HTML : 🎜rrreee🎜🎜🎜🎜🎜🎜

Événements

Passport déclenche des événements lorsque des jetons d'accès et des jetons d'actualisation sont émis. Vous pouvez ajouter des écouteurs pour ces événements dans le EventServiceProvider de votre application et révoquer ou modifier d'autres jetons dans l'écouteur : EventServiceProvider 中为这些事件追加监听器，并在监听器中撤销或修改其他令牌：

rrreee

测试

Passport 的 actingAs 方法可以指定当前已认证用户及其作用域。actingAsrrreee

Test

🎜La méthode actingAs de Passport peut spécifier l'utilisateur actuellement authentifié et sa portée. Le premier paramètre de la méthode actingAs est l'instance de l'utilisateur, et le deuxième paramètre est le tableau de portée du jeton utilisateur : 🎜rrreee🎜Cet article a été publié pour la première fois sur le site Web 🎜LearnKu.com🎜. 🎜🎜

← Outil de gestion des files d'attente Horizon

Recherche en texte intégral Scout →

soumettre

Site Web PHP chinois

MaisonCoursArticleQuestions et réponsesDictionnaireManuelTéléchargerrecherche APPTélécharger