美文网首页
使用Laravel Passport做Api认证(一)——安装和

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

作者: CodingLady | 来源:发表于2020-04-09 11:30 被阅读0次

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

    前言

    随着公司业务的发展,需要把各个业务后台通用的功能,抽出来做成单独的项目,并后台接口,供各个业务后台使用,所以要研究一下怎么使用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的配置以及返回等等

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

    相关文章

      网友评论

          本文标题:使用Laravel Passport做Api认证(一)——安装和

          本文链接:https://www.haomeiwen.com/subject/yfnhphtx.html