使用Laravel Passport做Api认证(一)——安装和基本使用

!!!!转载请注明作者和本文链接!!!!

前言

随着公司业务的发展,需要把各个业务后台通用的功能,抽出来做成单独的项目,并后台接口,供各个业务后台使用,所以要研究一下怎么使用Api认证。看了一下资料,Laravel官方给的Passport扩展包,提供了整个OAuth2.0的功能,所以就准备用Passport实现Api认证

介绍Passport的文档一大堆,从安装到是有都有非常详细的步骤,会告诉你每一步执行什么命令,去什么文件加什么代码
比如:
Passport OAuth 认证
Laravel Passport 多表用户认证踩坑
Laravel Passport API 认证使用小结
但是很少有一步步展开来讲每一步是为了解决什么问题,设置为什么那么做,代码为什么要那么写。当然,这里并不是说上面两篇文章不好,文档和文章写得挺好的。只是个人觉得从学习的角度去看,很多时候遇到问题,不是说单纯的复制粘贴代码解决项目问题就完事了,更多的是要多问几个为什么,最后才能灵活掌握和运用这个知识,自己的能力才能得到增长。

废话不多说了,进入正题,这篇先讲一下Passport的安装和基本使用。(以下需要laravel使用和OAuth2.0的基本知识,小白可以先去学习一下)

1.passport安装

以安装4.0为例

composer require laravel/passport:~4.0

如果遇到paragonie/random_compat版本不兼容的问题安装命令,可以先执行以下命令让paragonie/random_compat版本回退,再用上面的命令安装passport

composer require paragonie/random_compat:^2.0

2.做passport的数据迁移

passport会使用到一些数据库表,执行这个迁移,就会在数据库中生成这些表,其中XXXXX为环境名(现在公司使用一般都是多环境,如果单一环境就不用加--env参数了)

php artisan migrate  --env=XXXXX 

3.创建生成安全访问令牌(token)所需的加密键

php artisan passport:keys

执行完这个以后,在项目的storage文件夹下就会生成oauth-private.key和oauth-public.key。请注意,这两个文件是机器相关的,所以不应该提交到源代码控制(比如SVN,GIT等)中,应该在第一次部署的时候让机器生成。

4.注册路由

Passport::routes()给我们提供了passport使用的路由,我们要先去注册一下(我用的是laravel5.5,后面的要不要注册,我就不知道了,大家可以去查一下具体的文档)

app/Providers/AuthServiceProvider.php

use Carbon\Carbon;
use Laravel\Passport\Passport;
.
.
.
public function boot()
{
    $this->registerPolicies();

    // Passport的路由,这句是一定要加上
    Passport::routes();
    //下面是设置token的过期时间,默认是永久,如果要永久就不用写下面两行代码了
    //设置 access_token 15天过期
    Passport::tokensExpireIn(Carbon::now()->addDays(15));
    //设置 refreshTokens 30天过期
    Passport::refreshTokensExpireIn(Carbon::now()->addDays(30));
}
.
.
.

5.生成客户端

(1)命令行生成
如果用的是密码模式,可以使用下面的命令生成一个密钥,XXX可以指定名字,你可以根据项目需要起名字

php artisan passport:client --password --name='XXX'

然后命令行会给出clientID和client secret,保存下来

这里需要说明一点:
php artisan passport:keys和php artisan passport:install的区别

passport:install 用来创建生成安全访问令牌时所需的加密密钥,同时,这条命令也会创建用于生成访问令牌的「个人访问」客户端和「密码授权」客户端
(详见 Passport OAuth 认证)

所以,如果前面用了install后面就不需要再执行生成客户端这一步了。如果你只想要密钥+密码授权客户端,你就拆开来做

(2)接口生成

接口:POST /oauth/clients
因为我项目中是机器对机器的认证,就用的client模式


image.png

6.更改Guard和Provider

app/Providers/AuthServiceProvider.php

        'api' => [
            'driver' => 'passport',  //api认证,这里需要改成passport
            'provider' => 'users',  //这里填的是下面providers里面提供
        ],

     'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\User::class, //你可以根据项目需要,改成项目里其他的model,但是这个model必需要extend Authenticatable
        ],
    ],

7.给Api加上认证

(1)授权码模式

Route::post('/a/b','XXController@getResult')->middleware('auth:api');

(2)client模式
先去注册中间件
app/Http/kernel.php

use Laravel\Passport\Http\Middleware\CheckClientCredentials;
    protected $routeMiddleware = [
        ...
        'client' => CheckClientCredentials::class,
    ];

然后加上验证

Route::post('/a/b','XXController@getResult')->middleware('client');

8.调试

我们直接在postman中给/a/b发送请求,不带token


image.png

接下来,我们带着token给接口发送请求


image.png

可以正常访问了!

后续的篇章会继续写如何自定义Passport的配置以及返回等等

!!!!转载请注明作者和本文链接!!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,454评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,553评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,921评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,648评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,770评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,950评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,090评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,817评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,275评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,592评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,724评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,409评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,052评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,815评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,043评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,503评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,627评论 2 350

推荐阅读更多精彩内容