aiolos/lumen-passport-oauth

使Laravel Passport与Lumen协同工作

0.0.1 2020-02-27 11:41 UTC

This package is auto-updated.

Last update: 2024-09-27 22:02:33 UTC


README

使Laravel Passport与Lumen协同工作并带有个人token过期时间

一个简单的服务提供者,使Laravel Passport能在Lumen中工作

依赖关系

  • PHP >= 5.6.3
  • Lumen >= 5.3

通过Composer安装

如果你还没有Lumen,请先安装Lumen

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

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

$ cd lumen-app
$ composer require aiolos/lumen-passport-oauth

或者,如果你更喜欢,可以手动编辑composer.json

{
    "require": {
        "aiolos/lumen-passport-oauth": "^0.0.1"
    }
}

修改引导流程(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(Aiolos\LumenPassport\PassportServiceProvider::class);

迁移并安装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方法(您的服务提供者之一)。此方法将注册颁发访问令牌和吊销访问令牌、客户端和个人访问令牌所必需的路由

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

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

\Aiolos\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中不存在的高级功能

允许每个客户端多个token

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

use Aiolos\LumenPassport\LumenPassport;

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

不同密码客户端的不同TTLs

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

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

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

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

用于清除过期token的控制台命令

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

使用Apache httpd运行

如果您正在使用Apache网络服务器,它可能会清除Authorization头,从而破坏Passport。

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

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

许可

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

特此授予任何获得此软件及其相关文档副本(“软件”)的人免费使用该软件的权利,不受任何限制,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利,并允许向获得该软件的人提供此权利,前提是遵守以下条件

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

本软件按“原样”提供,不提供任何形式的保证,无论是明示的、暗示的,还是关于适销性、特定用途适用性或非侵权的保证。在任何情况下,作者或版权所有者不应对任何索赔、损害或其他责任负责,无论该责任是基于合同行为、侵权或其他行为,也不论该责任源于、产生于或与该软件或该软件的使用或其他处置有关。