CakePHP JWT 认证插件使用教程

CakePHP JWT 认证插件使用教程

cakephp-jwt-authA CakePHP plugin for authenticating using JSON Web Tokens项目地址:https://gitcode.com/gh_mirrors/ca/cakephp-jwt-auth

项目介绍

cakephp-jwt-auth 是一个用于 CakePHP 框架的插件，旨在通过 JSON Web Tokens (JWT) 实现用户认证。该插件支持多种签名算法，包括 HMAC (HS256 或 HS512) 和 RSA (RS256 或 RS512)，并且使用 JSON Web Keys 进行安全认证。

项目快速启动

安装插件

首先，使用 Composer 安装 cakephp-jwt-auth 插件：

composer require admad/cakephp-jwt-auth

加载插件

在 config/bootstrap.php 文件中加载插件：

Plugin::load('ADmad/JwtAuth');

配置 JWT 认证

在 config/app.php 文件中添加 JWT 认证配置：

'Auth' => [
    'authenticate' => [
        'ADmad/JwtAuth.Jwt' => [
            'userModel' => 'Users',
            'fields' => [
                'username' => 'id'
            ],
            'parameter' => 'token',
            'queryDatasource' => true,
        ]
    ],
    'unauthorizedRedirect' => false,
    'storage' => 'Memory',
    'checkAuthIn' => 'Controller.initialize',
]

创建登录控制器

创建一个登录控制器来生成 JWT 令牌：

namespace App\Controller;

use Cake\Event\Event;
use Cake\Utility\Security;
use Firebase\JWT\JWT;

class UsersController extends AppController
{
    public function login()
    {
        $user = $this->Auth->identify();
        if ($user) {
            $payload = [
                'sub' => $user['id'],
                'exp' => time() + 60*60*24
            ];
            $jwt = JWT::encode($payload, Security::getSalt());
            $this->set('jwt', $jwt);
            $this->set('_serialize', ['jwt']);
        } else {
            throw new UnauthorizedException('Invalid username or password');
        }
    }
}

应用案例和最佳实践

应用案例

cakephp-jwt-auth 插件适用于需要通过 API 进行用户认证的 Web 应用。例如，一个移动应用可以通过 JWT 令牌与后端 CakePHP 应用进行安全通信。

最佳实践

1. 安全密钥管理：确保 JWT 的密钥安全存储，避免泄露。
2. 令牌过期时间：合理设置 JWT 令牌的过期时间，平衡安全性和用户体验。
3. HTTPS 使用：始终在 HTTPS 环境下使用 JWT，防止令牌被拦截。

典型生态项目

CakePHP 生态

cakephp-jwt-auth 插件是 CakePHP 生态系统中的一部分，与以下项目协同工作：

1. CakePHP：核心框架，提供基础的 MVC 架构。
2. CakeDC/Users：用户管理插件，简化用户注册、登录和权限管理。
3. MixerAPI：用于构建 RESTful API 的插件，与 cakephp-jwt-auth 结合使用，提供完整的 API 解决方案。

通过这些项目的结合使用，可以构建一个功能完善、安全可靠的 Web 应用。

cakephp-jwt-authA CakePHP plugin for authenticating using JSON Web Tokens项目地址:https://gitcode.com/gh_mirrors/ca/cakephp-jwt-auth