基于Laravel Auth自定义接口API用户认证的实现方法

基于 laravel 默认的 auth 实现 api 认证

现在微服务越来越流行了. 很多东西都拆分成独立的系统,各个系统之间没有直接的关系. 这样我们如果做用户认证肯定是统一的做一个独立的 用户认证 系统,而不是每个业务系统都要重新去写一遍用户认证相关的东西. 但是又遇到一个问题了. laravel 默认的auth 认证 是基于数据库做的,如果要微服务架构可怎么做呢?

实现代码如下:

UserProvider 接口:

// 通过唯一标示符获取认证模型
public function retrieveById($identifier);
// 通过唯一标示符和 remember token 获取模型
public function retrieveByToken($identifier, $token);
// 通过给定的认证模型更新 remember token
public function updateRememberToken(Authenticatable $user, $token);
// 通过给定的凭证获取用户,比如 email 或用户名等等
public function retrieveByCredentials(array $credentials);
// 认证给定的用户和给定的凭证是否符合
public function validateCredentials(Authenticatable $user, array $credentials);

Laravel 中默认有两个 user provider : DatabaseUserProvider & EloquentUserProvider.

DatabaseUserProvider

Illuminate\Auth\DatabaseUserProvider

直接通过数据库表来获取认证模型.

EloquentUserProvider

Illuminate\Auth\EloquentUserProvider

通过 eloquent 模型来获取认证模型

根据上面的知识,可以知道要自定义一个认证很简单。

自定义 Provider

创建一个自定义的认证模型,实现 Authenticatable 接口;

App\Auth\UserProvider.php

<?php

namespace App\Auth;

use App\Models\User;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\UserProvider as Provider;

class UserProvider implements Provider
{

 /**
 * Retrieve a user by their unique identifier.
 * @param mixed $identifier
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */
 public function retrieveById($identifier)
 {
 return app(User::class)::getUserByGuId($identifier);
 }

 /**
 * Retrieve a user by their unique identifier and "remember me" token.
 * @param mixed $identifier
 * @param string $token
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */
 public function retrieveByToken($identifier, $token)
 {
 return null;
 }

 /**
 * Update the "remember me" token for the given user in storage.
 * @param \Illuminate\Contracts\Auth\Authenticatable $user
 * @param string   $token
 * @return bool
 */
 public function updateRememberToken(Authenticatable $user, $token)
 {
 return true;
 }

 /**
 * Retrieve a user by the given credentials.
 * @param array $credentials
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */
 public function retrieveByCredentials(array $credentials)
 {
 if ( !isset($credentials['api_token'])) {
 return null;
 }

 return app(User::class)::getUserByToken($credentials['api_token']);
 }

 /**
 * Rules a user against the given credentials.
 * @param \Illuminate\Contracts\Auth\Authenticatable $user
 * @param array   $credentials
 * @return bool
 */
 public function validateCredentials(Authenticatable $user, array $credentials)
 {
 if ( !isset($credentials['api_token'])) {
 return false;
 }

 return true;
 }
}

Authenticatable 接口:

Illuminate\Contracts\Auth\Authenticatable
Authenticatable 定义了一个可以被用来认证的模型或类需要实现的接口,也就是说,如果需要用一个自定义的类来做认证,需要实现这个接口定义的方法。

<?php
.
.
.
// 获取唯一标识的,可以用来认证的字段名,比如 id,uuid
public function getAuthIdentifierName();
// 获取该标示符对应的值
public function getAuthIdentifier();
// 获取认证的密码
public function getAuthPassword();
// 获取remember token
public function getRememberToken();
// 设置 remember token
public function setRememberToken($value);
// 获取 remember token 对应的字段名,比如默认的 'remember_token'
public function getRememberTokenName();
.
.
.

Laravel 中定义的 Authenticatable trait,也是 Laravel auth 默认的 User 模型使用的 trait,这个 trait 定义了 User 模型默认认证标示符为 'id',密码字段为password,remember token 对应的字段为 remember_token 等等。

通过重写 User 模型的这些方法可以修改一些设置。

实现自定义认证模型

App\Models\User.php

<?php

namespace App\Models;

use App\Exceptions\RestApiException;
use App\Models\Abstracts\RestApiModel;
use Illuminate\Contracts\Auth\Authenticatable;

class User extends RestApiModel implements Authenticatable
{

 protected $primaryKey = 'guid';

 public $incrementing = false;

 protected $keyType = 'string';

 /**
 * 获取唯一标识的,可以用来认证的字段名,比如 id,guid
 * @return string
 */
 public function getAuthIdentifierName()
 {
 return $this->primaryKey;
 }

 /**
 * 获取主键的值
 * @return mixed
 */
 public function getAuthIdentifier()
 {
 $id = $this->{$this->getAuthIdentifierName()};
 return $id;
 }

 public function getAuthPassword()
 {
 return '';
 }

 public function getRememberToken()
 {
 return '';
 }

 public function setRememberToken($value)
 {
 return true;
 }

 public function getRememberTokenName()
 {
 return '';
 }

 protected static function getBaseUri()
 {
 return config('api-host.user');
 }

 public static $apiMap = [
 'getUserByToken' => ['method' => 'GET', 'path' => 'login/user/token'],
 'getUserByGuId' => ['method' => 'GET', 'path' => 'user/guid/:guid'],
 ];

 /**
 * 获取用户信息 (by guid)
 * @param string $guid
 * @return User|null
 */
 public static function getUserByGuId(string $guid)
 {
 try {
 $response = self::getItem('getUserByGuId', [
 ':guid' => $guid
 ]);
 } catch (RestApiException $e) {
 return null;
 }

 return $response;
 }

 /**
 * 获取用户信息 (by token)
 * @param string $token
 * @return User|null
 */
 public static function getUserByToken(string $token)
 {
 try {
 $response = self::getItem('getUserByToken', [
 'Authorization' => $token
 ]);
 } catch (RestApiException $e) {
 return null;
 }

 return $response;
 }
}

上面 RestApiModel 是我们公司对 Guzzle 的封装,用于 php 项目各个系统之间 api 调用. 代码就不方便透漏了.

Guard 接口

Illuminate\Contracts\Auth\Guard

Guard 接口定义了某个实现了 Authenticatable (可认证的) 模型或类的认证方法以及一些常用的接口。

// 判断当前用户是否登录
public function check();
// 判断当前用户是否是游客(未登录)
public function guest();
// 获取当前认证的用户
public function user();
// 获取当前认证用户的 id,严格来说不一定是 id,应该是上个模型中定义的唯一的字段名
public function id();
// 根据提供的消息认证用户
public function validate(array $credentials = []);
// 设置当前用户
public function setUser(Authenticatable $user);

StatefulGuard 接口

Illuminate\Contracts\Auth\StatefulGuard

StatefulGuard 接口继承自 Guard 接口,除了 Guard 里面定义的一些基本接口外,还增加了更进一步、有状态的 Guard.
新添加的接口有这些:

// 尝试根据提供的凭证验证用户是否合法
public function attempt(array $credentials = [], $remember = false);
// 一次性登录,不记录session or cookie
public function once(array $credentials = []);
// 登录用户,通常在验证成功后记录 session 和 cookie
public function login(Authenticatable $user, $remember = false);
// 使用用户 id 登录
public function loginUsingId($id, $remember = false);
// 使用用户 ID 登录,但是不记录 session 和 cookie
public function onceUsingId($id);
// 通过 cookie 中的 remember token 自动登录
public function viaRemember();
// 登出
public function logout();

Laravel 中默认提供了 3 中 guard :RequestGuard,TokenGuard,SessionGuard.

RequestGuard

Illuminate\Auth\RequestGuard

RequestGuard 是一个非常简单的 guard. RequestGuard 是通过传入一个闭包来认证的。可以通过调用 Auth::viaRequest 添加一个自定义的 RequestGuard.

SessionGuard

Illuminate\Auth\SessionGuard

SessionGuard 是 Laravel web 认证默认的 guard.

TokenGuard

Illuminate\Auth\TokenGuard

TokenGuard 适用于无状态 api 认证,通过 token 认证.

实现自定义 Guard

App\Auth\UserGuard.php

<?php

namespace App\Auth;

use Illuminate\Http\Request;
use Illuminate\Auth\GuardHelpers;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;

class UserGuard implements Guard

{
 use GuardHelpers;

 protected $user = null;

 protected $request;

 protected $provider;

 /**
 * The name of the query string item from the request containing the API token.
 *
 * @var string
 */
 protected $inputKey;

 /**
 * The name of the token "column" in persistent storage.
 *
 * @var string
 */
 protected $storageKey;

 /**
 * The user we last attempted to retrieve
 * @var
 */
 protected $lastAttempted;

 /**
 * UserGuard constructor.
 * @param UserProvider $provider
 * @param Request $request
 * @return void
 */
 public function __construct(UserProvider $provider, Request $request = null)
 {
 $this->request = $request;
 $this->provider = $provider;
 $this->inputKey = 'Authorization';
 $this->storageKey = 'api_token';
 }

 /**
 * Get the currently authenticated user.
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */
 public function user()
 {
 if(!is_null($this->user)) {
  return $this->user;
 }

 $user = null;

 $token = $this->getTokenForRequest();

 if(!empty($token)) {
  $user = $this->provider->retrieveByCredentials(
  [$this->storageKey => $token]
  );
 }

 return $this->user = $user;
 }

 /**
 * Rules a user's credentials.
 * @param array $credentials
 * @return bool
 */
 public function validate(array $credentials = [])
 {
 if (empty($credentials[$this->inputKey])) {
  return false;
 }

 $credentials = [$this->storageKey => $credentials[$this->inputKey]];

 $this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);

 return $this->hasValidCredentials($user, $credentials);
 }

 /**
 * Determine if the user matches the credentials.
 * @param mixed $user
 * @param array $credentials
 * @return bool
 */
 protected function hasValidCredentials($user, $credentials)
 {
 return !is_null($user) && $this->provider->validateCredentials($user, $credentials);
 }

 /**
 * Get the token for the current request.
 * @return string
 */
 public function getTokenForRequest()
 {
 $token = $this->request->header($this->inputKey);

 return $token;
 }

 /**
 * Set the current request instance.
 *
 * @param \Illuminate\Http\Request $request
 * @return $this
 */
 public function setRequest(Request $request)
 {
 $this->request = $request;

 return $this;
 }
}

在 AppServiceProvider 的 boot 方法添加如下代码:

App\Providers\AuthServiceProvider.php

<?php
.
.
.
// auth:api -> token provider.
Auth::provider('token', function() {
 return app(UserProvider::class);
});

// auth:api -> token guard.
// @throw \Exception
Auth::extend('token', function($app, $name, array $config) {
 if($name === 'api') {
 return app()->make(UserGuard::class, [
 'provider' => Auth::createUserProvider($config['provider']),
 'request' => $app->request,
 ]);
 }
 throw new \Exception('This guard only serves "auth:api".');
});
.
.
.

在 config\auth.php的 guards 数组中添加自定义 guard,一个自定义 guard 包括两部分: driver 和 provider.

设置 config\auth.php 的 defaults.guard 为 api.

<?php

return [

 /*
 |--------------------------------------------------------------------------
 | Authentication Defaults
 |--------------------------------------------------------------------------
 |
 | This option controls the default authentication "guard" and password
 | reset options for your application. You may change these defaults
 | as required, but they're a perfect start for most applications.
 |
 */

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

 /*
 |--------------------------------------------------------------------------
 | Authentication Guards
 |--------------------------------------------------------------------------
 |
 | Next, you may define every authentication guard for your application.
 | Of course, a great default configuration has been defined for you
 | here which uses session storage and the Eloquent user provider.
 |
 | All authentication drivers have a user provider. This defines how the
 | users are actually retrieved out of your database or other storage
 | mechanisms used by this application to persist your user's data.
 |
 | Supported: "session", "token"
 |
 */

 'guards' => [
 'web' => [
  'driver' => 'session',
  'provider' => 'users',
 ],

 'api' => [
  'driver' => 'token',
  'provider' => 'token',
 ],
 ],

 /*
 |--------------------------------------------------------------------------
 | User Providers
 |--------------------------------------------------------------------------
 |
 | All authentication drivers have a user provider. This defines how the
 | users are actually retrieved out of your database or other storage
 | mechanisms used by this application to persist your user's data.
 |
 | If you have multiple user tables or models you may configure multiple
 | sources which represent each model / table. These sources may then
 | be assigned to any extra authentication guards you have defined.
 |
 | Supported: "database", "eloquent"
 |
 */

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

 'token' => [
  'driver' => 'token',
  'model' => App\Models\User::class,
 ],
 ],

 /*
 |--------------------------------------------------------------------------
 | Resetting Passwords
 |--------------------------------------------------------------------------
 |
 | You may specify multiple password reset configurations if you have more
 | than one user table or model in the application and you want to have
 | separate password reset settings based on the specific user types.
 |
 | The expire time is the number of minutes that the reset token should be
 | considered valid. This security feature keeps tokens short-lived so
 | they have less time to be guessed. You may change this as needed.
 |
 */

 'passwords' => [
 'users' => [
  'provider' => 'users',
  'table' => 'password_resets',
  'expire' => 60,
 ],
 ],

];

使用 方式:

参考文章:地址

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对我们的支持。

(0)

相关推荐

  • Laravel实现ApiToken认证请求

    1.打开 database/migrations/2014_10_12_000000_create_users_table.php 这个 migration 文件, 我们需要更改 user 表的结构 2.我们需要为 user 表添加 api_token 字段, 也就是说我们的 token 是保存在数据库中的, 在合适的位置, 添加一行 $table->string('api_token', 60)->unique(); 3.配置好数据库, 通过 php artisan migrate 命令生成

  • 详解laravel安装使用Passport(Api认证)

    Laravel通过传统的登录表单已经让用户认证变得很简单,但是API怎么办?API通常使用token进行认证并且在请求之间不维护session状态.Laravel使用Laravel Passport让API认证变得轻而易举,Passport基于Alex Bilbie维护的League OAuth2 server,可以在数分钟内为Laravel应用提供完整的OAuth2服务器实现. 中文文档 http://laravelacademy.org/post/6813.html 安装 composer

  • Laravel的Auth验证Token验证使用自定义Redis的例子

    背景 项目用户量逐渐增大,接口调用次数越来越多,所以决定使用Redis存token,缓解数据库压力 调研 在config/auth.php文件中发现用户的驱动使用的是EloquentUserProvider服务提供器,然后查找EloquentUserProvider.php 然后发现在vendor/laravel/framework/src/Illuminate/Auth文件下存在该文件 <?php namespace Illuminate\Auth; use Illuminate\Suppor

  • 基于Laravel Auth自定义接口API用户认证的实现方法

    基于 laravel 默认的 auth 实现 api 认证 现在微服务越来越流行了. 很多东西都拆分成独立的系统,各个系统之间没有直接的关系. 这样我们如果做用户认证肯定是统一的做一个独立的 用户认证 系统,而不是每个业务系统都要重新去写一遍用户认证相关的东西. 但是又遇到一个问题了. laravel 默认的auth 认证 是基于数据库做的,如果要微服务架构可怎么做呢? 实现代码如下: UserProvider 接口: // 通过唯一标示符获取认证模型 public function retri

  • Laravel 5框架学习之用户认证

    Laravel 出厂已经带有了用户认证系统,我们来看一下 routes.php,如果删除了,添加上: Route::controllers([ 'auth' => 'Auth\AuthController', 'password' => 'Auth\PasswordController' ]); 可以使用 php artisan route:list 查看一下.浏览器中访问 /auth/login,可以看到登陆界面,最好把系统默认的 app.blade.php 中关于 google 的东西注释

  • 基于laravel制作APP接口(API)

    前期准备 前言,为什么做以及要做个啥 本人姓小名白,不折不扣编程届小白一名,但是自从大一那会儿接触到编程这件奇妙的事情,就完完全全的陷入的程序的世界. 这不,最近又开始折腾APP了,话说现在开发一款APP真是容易,只用JavaScript和一点点HTML+css技术就可以完成.但是做APP的后台就不一样了.开发了APP,想让读点数据进去,那我们就要去开发个后台了. laravel框架,是我最喜欢的PHP框架了,没有之一.去年就曾经用laravel写了我的个人网站但粗糙程度让我十分脸红,好了不扯了

  • django基于存储在前端的token用户认证解析

    一.前提 首先是这个代码基于前后端分离的API,我们用了django的framework模块,帮助我们快速的编写restful规则的接口 前端token原理: 把(token=加密后的字符串,key=name)在登入后发到客户端,以后客户端再发请求,会携带过来服务端截取(token=加密后的字符串,key=name),我们再利用解密方法,将token和key进行解码,然后进行比对,成功就是登入过的认证,失败就是没有登入过的 还有一种方式,把{name:maple,id:1} 用我自己知道的加密方

  • Laravel5.4简单实现app接口Api Token认证方法

    我是小白,今天写这篇文章主要是给新手学习看的,大佬就不用看了,有很多不足望大家指出,共同进步. 在开发中许多 API 通常在返回响应之前都需要某种形式的认证,有些时候,一个认证的请求和一个未认证的请求,响应可能不同. 在web项目中,实现认证比较轻松,那么前后端分离的项目中,我们要怎么实现认证,今天这篇文章就以 API token 认证机制,使用Token可以解决laravel API的无状态认证. 一.给用户表users增加api_token字段 php artisan make:migrat

  • 基于ubuntu中使用mysql实现opensips用户认证的解决方法

    1 MySQL支持 1.1 MySQL模块支持 默认安装时,不包含MySQL模块. opensipsctlrc文件中包含了数据库配置的信息,要想让opensips支持mysql数据库,在编译安装的时候 就要支持mysql模块.方法如下: (1)修改opensips中的Makefile.conf,在exclude_modules中去掉db_mysql,在include_modules中 添加db_mysql,然后重新编译安装.要添加支持的模块都可以这样操作. (2)编译时指定,make inclu

  • Django自带用户认证系统使用方法解析

    Django自带用户认证系统,这个系统支持访问控制.注册用户.关联创建者和内容等:在开发用户认证功能时的时候,可以使用django中的django.contrib.auth 中封裝了注册.认证,登录登出方法,可以直接使用: 相关表 在使用"python manage.py makemigrationss"和"python manage.py migrate"迁移完成数据库之后 根据配置文件settings.py中的数据库段生成的数据表中已经包含了6张进行认证的数据表

  • JSP自定义标签获取用户IP地址的方法

    1.编写一个实现tag接口的标签处理器类 复制代码 代码如下: package cn.itcast.web.tag; import java.io.IOException; import javax.servlet.http.HttpServletRequest;import javax.servlet.jsp.JspException;import javax.servlet.jsp.JspWriter;import javax.servlet.jsp.PageContext;import j

  • Django 用户认证Auth组件的使用

    Django 用户认证(Auth)组件 Django 用户认证(Auth)组件一般用在用户的登录注册上,用于判断当前的用户是否合法,并跳转到登陆成功或失败页面. Django 用户认证(Auth)组件需要导入 auth 模块: # 认证模块 from django.contrib import auth # 对应数据库 from django.contrib.auth.models import User 返回值是用户对象. 创建用户对象的三种方法: create():创建一个普通用户,密码是明

  • 通过修改Laravel Auth使用salt和password进行认证用户详解

    前言 本文主要给大家介绍了通过修改Laravel Auth用salt和password进行认证用户的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍: Laraval自带的用户认证系统Auth非常强大易用,不过在Laravel的用户认证系统中用户注册.登录.找回密码这些模块中用到密码加密和认证算法时使用的都是bcrypt,而很多之前做的项目用户表里都是采用存储salt + password加密字符串的方式来记录用户的密码的,这就给使用Laravel框架来重构之前的项目带来了

随机推荐