README

包含AuthComponent的authenticate类的插件，用于使用JSON Web Tokens进行身份验证。您可以在这里详细了解JSON Web Token规范。

安装

composer require kongka/cakephp-3-jwt-auth

使用方法

在您的应用配置文件config/bootstrap.php中添加

// In config/bootstrap.php
Plugin::load('kongka/JwtAuth');

或者使用cake的控制台

./bin/cake plugin load kongka/JwtAuth

配置

设置AuthComponent

    // In your controller, for e.g. src/Api/AppController.php
    public function initialize()
    {
        parent::initialize();

        $this->loadComponent('Auth', [
            'storage' => 'Memory',
            'authenticate' => [
                'kongka/JwtAuth.Jwt' => [
                    'userModel' => 'Users',
                    'fields' => [
                        'username' => 'id'
                    ],

                    'parameter' => 'token',

                    // Boolean indicating whether the "sub" claim of JWT payload
                    // should be used to query the Users model and get user info.
                    // If set to `false` JWT's payload is directly returned.
                    'queryDatasource' => true,
                ]
            ],

            'unauthorizedRedirect' => false,
            'checkAuthIn' => 'Controller.initialize',

            // If you don't have a login action in your application set
            // 'loginAction' to false to prevent getting a MissingRouteException.
            'loginAction' => false
        ]);
    }

工作

身份验证类在两个位置检查令牌

• HTTP_AUTHORIZATION环境变量

  它首先检查是否通过Authorization请求头传递了令牌。其值应为Bearer <token>的形式。可以使用选项header和prefix分别自定义Authorization头名称和令牌前缀。

• 使用parameter配置指定的查询字符串变量

  接下来，它检查令牌是否存在于查询字符串中。默认变量名为token，可以使用上面的parameter配置进行自定义。

已知问题

某些服务器在设置Authorization头时不会填充$_SERVER['HTTP_AUTHORIZATION']。因此，您需要确保设置$_SERVER['HTTP_AUTHORIZATION']或$_ENV['HTTP_AUTHORIZATION']。

例如，对于Apache，您可以使用以下方法

RewriteEngine On
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]

或者

SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1

令牌生成

您可以使用此插件依赖的firebase/php-jwt库中的\Firebase\JWT\JWT::encode()来生成令牌。

负载应包含“sub”（主题）声明，其值用于查询Users模型并找到匹配“id”字段的记录。

可以将queryDatasource选项设置为false，以直接返回令牌的有效负载作为用户信息，而无需查询数据源以匹配用户记录。

进一步阅读

有关端到端使用示例，请参阅Bravo Kernel的这篇博客文章：如何将JWT身份验证添加到CakePHP 3 REST API中。