This article mainly introduces the implementation details of the Laravel user authentication system, which has certain reference value. Now I share it with you. Friends in need can refer to it
In the previous section, we introduced the basic knowledge of the Laravel Auth system and talked about its core components. In this section, we will focus on the implementation details of the Laravel Auth system, mainly focusing on Auth That is, AuthManager is how to load the authentication guard (Guard) and user provider (UserProvider) as well as the implementation details of default user registration and login. By sorting out these implementation details, we can also know how to do it. Customize Auth authentication to meet the needs of user authentication in our own projects.
AuthManager uses many methods to load the watcher and user provider, and the description in words is not clear. We use annotations in this process method to see the specific implementation details.
namespace Illuminate\Auth;
class AuthManager implements FactoryContract
{
/**
* 尝试从$guards属性中获取指定的Guard
*
* @param string $name
* @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard
*/
public function guard($name = null)
{
$name = $name ?: $this->getDefaultDriver();
return isset($this->guards[$name])
? $this->guards[$name]
: $this->guards[$name] = $this->resolve($name);
}
/**
* 解析出给定name的Guard
*
* @param string $name
* @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard
*
* @throws \InvalidArgumentException
*/
protected function resolve($name)
{
//获取Guard的配置
//$config = ['driver' => 'session', 'provider' => 'users']
$config = $this->getConfig($name);
if (is_null($config)) {
throw new InvalidArgumentException("Auth guard [{$name}] is not defined.");
}
//如果通过extend方法为guard定义了驱动器，这里去调用自定义的Guard驱动器
if (isset($this->customCreators[$config['driver']])) {
return $this->callCustomCreator($name, $config);
}
//Laravel auth默认的配置这里是执行createSessionDriver
$driverMethod = 'create'.ucfirst($config['driver']).'Driver';
if (method_exists($this, $driverMethod)) {
return $this->{$driverMethod}($name, $config);
}
throw new InvalidArgumentException("Auth guard driver [{$name}] is not defined.");
}
/**
* 从config/auth.php中获取给定名称的Guard的配置
*
* @param string $name
* @return array
*/
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'token',
'provider' => 'users',
],
],
protected function getConfig($name)
{
//'guards' => [
// 'web' => [
// 'driver' => 'session',
// 'provider' => 'users',
// ],
// 'api' => [
// 'driver' => 'token',
// 'provider' => 'users',
// ],
//],
// 根据Laravel默认的auth配置， 这个方法会获取key "web"对应的数组
return $this->app['config']["auth.guards.{$name}"];
}
/**
* 调用自定义的Guard驱动器
*
* @param string $name
* @param array $config
* @return mixed
*/
protected function callCustomCreator($name, array $config)
{
return $this->customCreators[$config['driver']]($this->app, $name, $config);
}
/**
* 注册一个自定义的闭包Guard 驱动器 到customCreators属性中
*
* @param string $driver
* @param \Closure $callback
* @return $this
*/
public function extend($driver, Closure $callback)
{
$this->customCreators[$driver] = $callback;
return $this;
}
/**
* 注册一个自定义的用户提供器创建器到 customProviderCreators属性中
*
* @param string $name
* @param \Closure $callback
* @return $this
*/
public function provider($name, Closure $callback)
{
$this->customProviderCreators[$name] = $callback;
return $this;
}
/**
* 创建基于session的认证看守器 SessionGuard
*
* @param string $name
* @param array $config
* @return \Illuminate\Auth\SessionGuard
*/
public function createSessionDriver($name, $config)
{
//$config['provider'] == 'users'
$provider = $this->createUserProvider($config['provider'] ?? null);
$guard = new SessionGuard($name, $provider, $this->app['session.store']);
if (method_exists($guard, 'setCookieJar')) {
$guard->setCookieJar($this->app['cookie']);
}
if (method_exists($guard, 'setDispatcher')) {
$guard->setDispatcher($this->app['events']);
}
if (method_exists($guard, 'setRequest')) {
$guard->setRequest($this->app->refresh('request', $guard, 'setRequest'));
}
return $guard;
}
//创建Guard驱动依赖的用户提供器对象
public function createUserProvider($provider = null)
{
if (is_null($config = $this->getProviderConfiguration($provider))) {
return;
}
//如果通过Auth::provider方法注册了自定义的用户提供器creator闭包则去调用闭包获取用户提供器对象
if (isset($this->customProviderCreators[$driver = ($config['driver'] ?? null)])) {
return call_user_func(
$this->customProviderCreators[$driver], $this->app, $config
);
}
switch ($driver) {
case 'database':
return $this->createDatabaseProvider($config);
case 'eloquent':
//通过默认的auth配置这里会返回EloquentUserProvider对象,它实现了Illuminate\Contracts\Auth 接口
return $this->createEloquentProvider($config);
default:
throw new InvalidArgumentException(
"Authentication user provider [{$driver}] is not defined."
);
}
}
/**
* 会通过__call去动态地调用AuthManager代理的Guard的用户认证相关方法
* 根据默认配置，这里__call会去调用SessionGuard里的方法
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
return $this->guard()->{$method}(...$parameters);
}
}The default registration route in the Laravel Auth system is as follows:
$this->post('register', 'Auth\RegisterController@register');
So the logic of user registration is completed by the register method of RegisterController
class RegisterController extends Controller
{
//方法定义在Illuminate\Foundation\Auth\RegisterUsers中
public function register(Request $request)
{
$this->validator($request->all())->validate();
event(new Registered($user = $this->create($request->all())));
$this->guard()->login($user);
return $this->registered($request, $user)
}
protected function validator(array $data)
{
return Validator::make($data, [
'name' => 'required|string|max:255',
'email' => 'required|string|email|max:255|unique:users',
'password' => 'required|string|min:6|confirmed',
]);
}
protected function create(array $data)
{
return User::create([
'name' => $data['name'],
'email' => $data['email'],
'password' => bcrypt($data['password']),
]);
}
}The registration process is very simple. It is to verify that the data entered by the user is correct and then write the data to the database to generate the user. The password encryption uses the bcrypt algorithm. If you need to change it to the commonly used salt to add plain text to the password for hashing. The password encryption method can change this part of the logic in the create method. After registering the user, the login method of SessionGuard will be called to load the user data into the application. Note that this login method does not have login authentication, but only loads the authenticated user into In the application, we can obtain user data through Auth::user() anywhere in the application.
The login route of the Laravel Auth system is as follows
$this->post('login', 'Auth\LoginController@login');
Let’s take a look at the login logic in LoginController
class LoginController extends Controller
{
/**
* 处理登录请求
*/
public function login(Request $request)
{
//验证登录字段
$this->validateLogin($request);
//防止恶意的多次登录尝试
if ($this->hasTooManyLoginAttempts($request)) {
$this->fireLockoutEvent($request);
return $this->sendLockoutResponse($request);
}
//进行登录认证
if ($this->attemptLogin($request)) {
return $this->sendLoginResponse($request);
}
$this->incrementLoginAttempts($request);
return $this->sendFailedLoginResponse($request);
}
//尝试进行登录认证
protected function attemptLogin(Request $request)
{
return $this->guard()->attempt(
$this->credentials($request), $request->filled('remember')
);
}
//获取登录用的字段值
protected function credentials(Request $request)
{
return $request->only($this->username(), 'password');
}
}As you can see, login authentication The logic is implemented through the attempt method of SessionGuard, which is actually Auth::attempt(). Let’s take a look at attemptThe logic in the method:
class SessionGuard implements StatefulGuard, SupportsBasicAuth
{
public function attempt(array $credentials = [], $remember = false)
{
$this->fireAttemptEvent($credentials, $remember);
$this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);
//如果登录认证通过，通过login方法将用户对象装载到应用里去
if ($this->hasValidCredentials($user, $credentials)) {
$this->login($user, $remember);
return true;
}
//登录失败的话，可以触发事件通知用户有可疑的登录尝试(需要自己定义listener来实现)
$this->fireFailedEvent($user, $credentials);
return false;
}
protected function hasValidCredentials($user, $credentials)
{
return ! is_null($user) && $this->provider->validateCredentials($user, $credentials);
}
}SessionGuard’s attempt method first passes the user provider’s retriveBycredentials method from the user table through the user name Querying out user data and authenticating user information is implemented through validateCredentials of the user provider. All user provider implementation classes will implement the methods defined in the UserProvider contract (interface). Through the above analysis, we know The default user provider is EloquentUserProvider
class EloquentUserProvider implements UserProvider
{
从数据库中取出用户实例
public function retrieveByCredentials(array $credentials)
{
if (empty($credentials) ||
(count($credentials) === 1 &&
array_key_exists('password', $credentials))) {
return;
}
$query = $this->createModel()->newQuery();
foreach ($credentials as $key => $value) {
if (! Str::contains($key, 'password')) {
$query->where($key, $value);
}
}
return $query->first();
}
//通过给定用户认证数据来验证用户
public function validateCredentials(UserContract $user, array $credentials)
{
$plain = $credentials['password'];
return $this->hasher->check($plain, $user->getAuthPassword());
}
}
class BcryptHasher implements HasherContract
{
//通过bcrypt算法计算给定value的散列值
public function make($value, array $options = [])
{
$hash = password_hash($value, PASSWORD_BCRYPT, [
'cost' => $this->cost($options),
]);
if ($hash === false) {
throw new RuntimeException('Bcrypt hashing not supported.');
}
return $hash;
}
//验证散列值是否给定明文值通过bcrypt算法计算得到的
public function check($value, $hashedValue, array $options = [])
{
if (strlen($hashedValue) === 0) {
return false;
}
return password_verify($value, $hashedValue);
}
} Verification of user passwords is done through the EloquentUserProvider dependent hasher hasher, Laravel By default, the authentication system uses the bcrypt algorithm to encrypt the plaintext password provided by the user and then stores it in the user table. During verification, the haser hasher's check method will pass the PHP built-in method password_verifyTo verify whether the plaintext password is the original value of the stored ciphertext password.
After sorting out the main details of the user authentication system, we will know how to define our own guard (Guard) or user provider (UserProvider). First, they must implement the methods in the contract that they each comply with. Seamlessly connect to Laravel's Auth system, and then you need to register your own defined Guard or Provider through the Auth::extend, Auth::provider method to return the Guard or Provider instance The closure is put into Laravel. The customization of Guard and UserProvider does not have to be a complete set. We can customize Guard separately and still use the default EloquentUserProvider, or let the default SessionGuard use a customized UserProvider.
In the next section, I will give a case used in our previous project development to better explain how to expand the Laravel Auth system.
The above is the entire content of this article. I hope it will be helpful to everyone's study. For more related content, please pay attention to the PHP Chinese website!
Related recommendations:
Laravel WeChat applet obtains user details and analysis of applet code expansion with parameters
Advantages of using Laravel service container
The above is the detailed content of Implementation details of Laravel user authentication system. For more information, please follow other related articles on the PHP Chinese website!
![[Web front-end] Node.js quick start](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
