Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/qbhy/hyperf-auth

hyperf 的 auth 组件
https://github.com/qbhy/hyperf-auth

Last synced: 8 days ago
JSON representation

hyperf 的 auth 组件

Host: GitHub
URL: https://github.com/qbhy/hyperf-auth
Owner: qbhy
License: mit
Created: 2020-05-22T11:13:50.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-01-11T06:30:31.000Z (5 months ago)
Last Synced: 2024-05-11T14:22:12.829Z (about 1 month ago)
Language: PHP
Size: 91.8 KB
Stars: 174
Watchers: 1
Forks: 28
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-swoole - 96qbhy/hyperf-auth - An authentication component for Hyperf. It supports JWT and session-based authentications. You can also create your own authentication drivers if needed. :globe_with_meridians: (Frameworks)

README

        # qbhy/hyperf-auth

hyperf 的 auth 组件，目前支持 jwt、session、sso 驱动。用户可以自行扩展。  

本组件参考了 laravel 的 auth 组件设计，使用体验大体和 laravel 的 auth 差不多。

[![Latest Stable Version](https://poser.pugx.org/96qbhy/hyperf-auth/v/stable)](https://packagist.org/packages/96qbhy/hyperf-auth)

[![Total Downloads](https://poser.pugx.org/96qbhy/hyperf-auth/downloads)](https://packagist.org/packages/96qbhy/hyperf-auth)

[![Latest Unstable Version](https://poser.pugx.org/96qbhy/hyperf-auth/v/unstable)](https://packagist.org/packages/96qbhy/hyperf-auth)

[![License](https://poser.pugx.org/96qbhy/hyperf-auth/license)](https://packagist.org/packages/96qbhy/hyperf-auth)

[![Monthly Downloads](https://poser.pugx.org/96qbhy/hyperf-auth/d/monthly)](https://packagist.org/packages/96qbhy/hyperf-auth)

[![Daily Downloads](https://poser.pugx.org/96qbhy/hyperf-auth/d/daily)](https://packagist.org/packages/96qbhy/hyperf-auth)

## 支持的验证方式

* session

* jwt

* sso （单点登录，继承自jwt，需要 hyperf/redis，支持多客户端）

> 任何问题请加QQ群提问：873213948

## 安装 - install

```bash

$ composer require 96qbhy/hyperf-auth

```

> hyperf 1.1 请使用 ^v1.0 版本

## 配置 - configuration

使用 `Qbhy\HyperfAuth\AuthExceptionHandler` ，此步骤可选，开发者可以自行捕捉 `AuthException`  和 `JWTException` 进行处理

```php

 [

        'http' => [

            \Qbhy\HyperfAuth\AuthExceptionHandler::class,

        ],    

    ],

];

```

发布配置 vendor:publish

```bash

php bin/hyperf.php vendor:publish 96qbhy/hyperf-auth

```

生成 `.env` 配置项 

```bash

php bin/hyperf.php gen:auth-env

```

修改 `config/autoload/auth.php`

> 如不需要自定义 guard、model 和 user provider，则可以不修改

```php

 [

        'guard'=> 'jwt',

        'provider'=> 'users',

    ] ,

    'guards' => [ // 开发者可以在这里添加自己的 guard ，guard Qbhy\HyperfAuth\AuthGuard 接口

        'sso'=> [

            // 支持的设备，env配置时用英文逗号隔开

            'clients' => explode(',', env('AUTH_SSO_CLIENTS', 'pc')),

            // hyperf/redis 实例

            'redis' => function () {

                return make(\Hyperf\Redis\Redis::class);

            },

            // 自定义 redis key，必须包含 {uid}，{uid} 会被替换成用户ID

            'redis_key' => 'u:token:{uid}',

            'driver' => Qbhy\HyperfAuth\Guard\SsoGuard::class,

            // ...$jwtConfig, // 其他配置和 jwt guard的配置一样

        ],

        'jwt' => [

            'driver' => Qbhy\HyperfAuth\Guard\JwtGuard::class,

            'provider' => 'users',

            // 以下是 simple-jwt 所需的参数，具体配置文档可以看 config/autoload/auth.php

            'secret' =>env('JWT_SECRET', 'qbhy/hyperf-auth'),

            'ttl' => 60 * 60, // 单位秒

            'default' => PasswordHashEncrypter::class,

            'encoder' => new Base64UrlSafeEncoder(),

//            'cache' => new FilesystemCache(sys_get_temp_dir()), // 如果需要分布式部署，请选择 redis 或者其他支持分布式的缓存驱动

            'cache' => function() {

                return make(Qbhy\HyperfAuth\HyperfRedisCache::class);

            }, 

        ],

        'session' => [

            'driver' => Qbhy\HyperfAuth\Guard\SessionGuard::class,

            'provider' => 'users',

        ],

    ],

    'providers' => [

        'users' => [

            'driver' => \Qbhy\HyperfAuth\Provider\EloquentProvider::class, // user provider 需要实现 Qbhy\HyperfAuth\UserProvider 接口

            'model' => App\Model\User::class, //  需要实现 Qbhy\HyperfAuth\Authenticatable 接口

        ],

    ],

];

```

## 使用 - usage

> 以下是伪代码，仅供参考。Auth 注解可以用于类或者方法。

```php

firstOrCreate(['name' => 'test', 'avatar' => 'avatar']);

      return [

          'status' => $this->auth->guard('session')->login($user),

      ];

  }

  

  /**

   * @GetMapping(path="/sso/login")

   * @return array

   */

  public function ssoLogin()

  {

      /** @var User $user */

      $user = User::query()->firstOrCreate(['name' => 'test', 'avatar' => 'avatar']);

      return [

          'token' => $this->auth->guard('sso')->login($user, [],  'pc'), // sso 方法支持第二个参数，传定义好的客户端

      ];

  }

  /**

   * @Auth("session")

   * @GetMapping(path="/logout")

   */

  public function logout()

  {

      $this->auth->guard('session')->logout();

      return 'logout ok';

  }

  /**

   * 使用 Auth 注解可以保证该方法必须通过某个 guard 的授权，支持同时传多个 guard，不传参数使用默认 guard

   * @Auth("session")

   * @GetMapping(path="/user")

   * @return string

   */

  public function user()

  {

      $user = $this->auth->guard('session')->user();

      return 'hello '.$user->name;

  }

}

```

除了上面的 Auth 注解用法，还支持中间件用法

```php

auth->guard()->user();

      return 'hello '.$user->name;

  }

}

```

由于 hyperf 还不支持中间件传参，所以 `Qbhy\HyperfAuth\AuthMiddleware` 中间件只支持默认guard校验  

但是开发者可以继承该中间自行扩展。或者直接使用 Auth 注解进行自定义 guard 校验，与中间件的效果是一致的。

```php

login($user); // 默认使用 jwt 驱动，该方法将返回 token 字符串

$auth->logout(); // 退出登录

$auth->check(); // 检查是否登录

$auth->id(); // 获取当前登录用户的id，无需查数据库

$auth->guest(); // 是否游客/是否未登录

$auth->user(); // 若登录返回当前登录用户，否则返回null

/** @var \Qbhy\HyperfAuth\Guard\JwtGuard $jwtGuard */

$jwtGuard = $auth->guard('jwt');

$jwtGuard->user('your token or null'); // jwt 驱动支持手动传入 token，如不传或者传null则从 request 中解析

$jwtGuard->check('your token or null');

$jwtGuard->id('your token or null'); // 无需查数据库

$jwtGuard->guest('your token or null');

$jwtGuard->refresh('your token or null'); // 该方法返回新的 token 或者 null

$jwtGuard->login($user, ['sub' => 'qbhy0715','iss' => 'hyperf-auth',]); // 自定义payload

$jwtGuard->getPayload('your token or null'); // 获取自定义 payload

$auth->guard()->login($user); // guard 方法不传参数或者传null都将使用默认值

// 使用 session 驱动需要安装 hyperf/session 并启用 session

$auth->guard('session')->login($user); // guard 方法不传参数或者传null都会获取默认值

```

> 注意事项：使用 jwt 驱动且令牌异常的情况下调用 user 方法，会抛出相应的异常，需要自行捕捉处理，不想抛异常，可以调用 check 进行判断。

## 扩展 - extension

由于本组件参考了 laravel auth 的设计，所以 guard 和 user provider 的扩展也和 laravel 类似。只需要实现对应接口即可。

* guard ===> Qbhy\HyperfAuth\AuthGuard

* user provider ===> Qbhy\HyperfAuth\UserProvider

> 扩展教程请移步 [hyperf教程之hyperf-auth高级用法](https://mp.weixin.qq.com/s/jlbbN6zhWEVteimpi0mLjg)

https://github.com/qbhy/hyperf-auth  

[email protected]