feriva22/lumen-passport

让 Laravel Passport 与 Lumen 一起工作

0.3.4 2021-02-17 00:03 UTC

README

Build Status Code Climate Total Downloads Latest Stable Version Latest Unstable Version License

让 Laravel Passport 与 Lumen 一起工作

一个简单的服务提供者,使 Laravel Passport 能够与 Lumen 一起工作

依赖关系

  • PHP >= 5.6.3
  • Lumen >= 5.3

通过 Composer 安装

首先安装 Lumen,如果您还没有安装的话

$ composer create-project --prefer-dist laravel/lumen lumen-app

然后安装 Lumen Passport(它将获取 Laravel Passport)

$ cd lumen-app
$ composer require dusterio/lumen-passport

或者,如果您愿意,可以手动编辑 composer.json

{
    "require": {
        "dusterio/lumen-passport": "^0.3.0"
    }
}

修改引导流程(bootstrap/app.php 文件)

我们需要启用 Laravel Passport 提供者和 Lumen 特定提供者

// Enable Facades
$app->withFacades();

// Enable Eloquent
$app->withEloquent();

// Enable auth middleware (shipped with Lumen)
$app->routeMiddleware([
    'auth' => App\Http\Middleware\Authenticate::class,
]);

// Finally register two service providers - original one and Lumen adapter
$app->register(Laravel\Passport\PassportServiceProvider::class);
$app->register(Dusterio\LumenPassport\PassportServiceProvider::class);

与 Laravel Passport 7.3.2 及更高版本一起使用

Laravel Passport 7.3.2 进行了破坏性更改 - 在 Application 类中引入了新方法,该方法在 Laravel 中存在,但在 Lumen 中不存在。您可以选择锁定到旧版本,或者像以下这样在您的 bootstrap/app.php 文件顶部替换 Application 类

$app = new \Dusterio\LumenPassport\Lumen7Application(
    dirname(__DIR__)
);

如果查看此类 - 它所做的只是添加一个额外的方法 configurationIsCached(),该方法始终返回 false。

迁移并安装 Laravel Passport

# Create new tables for Passport
php artisan migrate

# Install encryption keys and other necessary stuff for Passport
php artisan passport:install

已安装的路由

在此调用 routes() 方法后,此包将挂载以下路由(请参阅下面的说明)

请注意,由于 Laravel Passport 的某些路由是 Web 相关的,并且依赖于会话(例如授权页面),因此必须“删除”一些路由。Lumen 是一个 API 框架,因此仅包含 API 相关的路由。

配置

编辑 config/auth.php 以满足您的需求。一个简单的例子

return [
    'defaults' => [
        'guard' => 'api',
        'passwords' => 'users',
    ],

    'guards' => [
        'api' => [
            'driver' => 'passport',
            'provider' => 'users',
        ],
    ],

    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => \App\User::class
        ]
    ]
];

bootstrap/app.php 中加载配置,因为 Lumen 不会自动加载配置文件

$app->configure('auth');

注册路由

接下来,您应该在应用程序的 boot 方法中调用 LumenPassport::routes 方法(您的服务提供者之一)。此方法将注册必要的路由以颁发访问令牌和吊销访问令牌、客户端和个人访问令牌

\Dusterio\LumenPassport\LumenPassport::routes($this->app);

您可以将此添加到现有的组中,或者像这样独立添加此路由注册器;

\Dusterio\LumenPassport\LumenPassport::routes($this->app, ['prefix' => 'v1/oauth']);

用户模型

请确保您的用户模型使用 Passport 的 HasApiTokens 特性,例如。

class User extends Model implements AuthenticatableContract, AuthorizableContract
{
    use HasApiTokens, Authenticatable, Authorizable;

    /* rest of the model */
}

额外功能

有几个 Laravel Passport 中没有的额外功能

允许每个客户端有多个令牌

有时允许每个密码授权客户端有多个访问令牌很有用。例如,用户可以从多个浏览器同时登录。目前 Laravel Passport 不允许这样做。

use Dusterio\LumenPassport\LumenPassport;

// Somewhere in your application service provider or bootstrap process
LumenPassport::allowMultipleTokens();

不同密码客户端的不同 TTL

Laravel Passport 允许为访问令牌设置一个全局 TTL,但有时为不同的客户端设置不同的 TTL(例如,移动用户比桌面用户有更多时间)可能很有用。

只需在您的服务提供者中执行以下操作

// Second parameter is the client Id
LumenPassport::tokensExpireIn(Carbon::now()->addYears(50), 2); 

如果您没有指定客户端 ID,它将简单地回退到 Laravel Passport 实现。

清除过期令牌的控制台命令

只需运行 php artisan passport:purge 以从数据库中删除过期的刷新令牌及其对应的访问令牌。

与 Apache httpd 一起运行

如果您正在使用 Apache 网络服务器,它可能会剥离授权头,从而破坏 Passport。

请将以下内容添加到您的配置中,或者添加到 .htaccess

RewriteEngine On
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]

视频教程

我刚刚开始了一个教育 YouTube 频道,该频道将涵盖软件开 发和 DevOps 的顶级 IT 趋势:config.sys

此外,我很高兴宣布我的最新工具 - GrammarCI,它是自动化的拼写和语法检查工具(作为 CI/CD 流程的一部分),以确保您的用户不会看到您的错别字 :)

许可证

MIT 许可证(MIT)版权所有 (c) 2016 Denis Mysenko

特此授予任何人无代价地获取本软件及其相关文档文件(以下简称“软件”)的副本的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利,并允许获得软件的个人进行此类操作,但须遵守以下条件:

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供,不提供任何形式的质量保证,无论是明示的还是隐含的,包括但不限于适销性、适用于特定目的和不侵犯他人权利的保证。在任何情况下,作者或版权持有人均不对任何索赔、损害或其他责任承担责任,无论是基于合同、侵权或其他法律行为,无论该索赔、损害或其他责任是否源于、源于或与软件或其使用或以其他方式有关。