介绍

Csrf令牌常用操作，依赖\x\Csrf组件。

默认配置

默认配置存储在/config/jwt.php文件中：

return [
    // +-----------------------------
    // | Csrf
    // +-----------------------------

    // CSRF Session名称
    'csrf_session_name' => '_csrf_token',
    // CSRF Session过期时间（s）
    'csrf_outtime' => 1800,
    // CSRF 表单或Ajax字段名称
    'csrf_form_name' => 'csrf_token',
];

也可以在生成命令时手动传入，框架会自动与默认配置项进行合并处理。

生成令牌

用途：用于生成Csrf令牌。
依赖类：\x\Csrf
方法名：create_token()

参数：

• array $payload

  • 功能：配置项，参考/config/jwt.php
  • 值单位：数组
  • 默认值：[]

返回值：string

使用示例：

$Csrf = new \x\Csrf();
$Csrf->create_token();

校验令牌

用途：校验Csrf令牌合法性。
依赖类：\x\Csrf
方法名：is_token()

参数：

• string $token

  • 功能：令牌值
  • 值单位：字符串
  • 默认值：无

返回值：bool

使用示例：

$Csrf = new \x\Csrf();
$Csrf->is_token(令牌值);

清除令牌

用途：立刻清除令牌。
依赖类：\x\Csrf
方法名：clean_token()

参数：无

返回值：bool

使用示例：

$Csrf = new \x\Csrf();
$Csrf->clean_token();