认证与授权

Blink 提供了一套轻量级的认证授权框架,通过这套框架我们可以更加方便的在我们的应用中实现认证与授权的系列功能。

在 Blink 中,认证特性是由 auth 服务组件来完成的,我们可以通过 auth() 辅助函数来获取该服务的实例。为了让auth 服务知道如何查找一个 用户并验证其密码的正确性,我们首先需要定义一个 User Identity 类来告诉 auth 服务这些信息:

定义 User Identity

为了定义一个 User Identity 类,我们需要实现 blink\auth\Authenticatable 接口,下面的例子展示了如何利用静态用户数据定义 User Identiry:

  1. namespace app;
  2. class User extends Object implements Authenticatable
  3. {
  4. public static $users = [
  5. ['id' => 1, 'name' => 'user1', 'password' => 'user1'],
  6. ['id' => 2, 'name' => 'user2', 'password' => 'user2']
  7. ];
  8. public $id;
  9. public $name;
  10. public $password;
  11. /**
  12. * 通过用户的唯一标志查找用户,例如 主键、邮箱
  13. */
  14. public static function findIdentity($id)
  15. {
  16. if (is_numeric($id)) {
  17. $key = 'id';
  18. $value = $id;
  19. } else if (is_array($id) && isset($id['name'])) {
  20. $key = 'name';
  21. $value = $id['name'];
  22. } else {
  23. throw new InvalidParamException("The param: id is invalid");
  24. }
  25. foreach (static::$users as $user) {
  26. if ($user[$key] == $value) {
  27. return new static($user);
  28. }
  29. }
  30. }
  31. /**
  32. * 返回该用户的 Auth ID,用于存储到 Session 中唯一标志这个用户
  33. */
  34. public function getAuthId()
  35. {
  36. return $this->id;
  37. }
  38. /**
  39. * 检查用户的密码是否与用户输入相匹配
  40. */
  41. public function validatePassword($password)
  42. {
  43. return $this->password === $password;
  44. }
  45. }

User Identity 定义好之后,我们需要配置 auth 服务,设置 model 属性告诉 auth 服务 User Identity 是怎样定义的:

  1. 'auth' => [
  2. 'class' => 'blink\auth\Auth',
  3. 'model' => 'app\User',
  4. ],

用户认证

只要 User Identity 定义并且配置好,我们就可以通过用户输入的用户名和密码来认证用户了,下面是例子:

  1. $creditials = ['email' => 'foo@bar.com', 'password' => 123];
  2. // 通过给定的用户名和密码进行用户认证
  3. $user = auth()->attempt($creditials);
  4. // 进行用户认证但是不启用 Session
  5. $user = auth()->once($creditials);

如果采用 auth()->attempt() 来认证用户,auth 服务会利用 session 服务来为认证的用户存储必要的 Session 数据,所以我们需要配置好 session 服务以获取期望的结果。

用户授权

授权是检查一个用户具有足够权限做某事的过程,Blink 中,该功能由 blink\http\Request 类实现,下面是一个简单的例子:

  1. use blink\core\Object;
  2. use blink\http\Request;
  3. class Controller extends Object
  4. {
  5. public function actionFoo(Request $request)
  6. {
  7. if (!$requst->guest()) {
  8. $user = $requst->user(); // 获取当前授权成功的用户
  9. }
  10. }
  11. }

目前,Blink 默认采用 X-Session-Id Http 头来传输 Session Id。当然,这也是可以配置的,我们可以通过设置blink\http\RequestsessionKey 属性来改变这个行为,关于如何设置该属性,请查看对应类实现的注释。