Skip to content

身份验证(Authentication) ​

菜单:开发 → 身份验证
深链:/_Admin/development/authentication?SiteId={站点GUID}

为站点前台请求配置 访问控制规则:按 URL / HTTP 方法匹配请求,再执行 JWT 校验 或 自定义 KScript,未通过时可返回 HTTP 状态码或重定向。规则在站点页面/API 等已绑定路由的请求进入渲染前执行。

权限

菜单权限:authentication(查看)。创建、编辑规则需 authentication·edit;列表多选 删除 需 authentication·delete。

与站点账号登录的区别

本页控制的是 访客请求是否允许继续渲染(网关式规则),不是 Kooboo 后台账号登录,也不是 k.account 的站点账号登录流程。JWT 校验使用 k.security.jwt 解码请求中的令牌。

如何打开 ​

  1. 在 编辑菜单 中勾选 开发 → 身份验证。
  2. 左侧 开发 → 身份验证。
身份验证列表总览

规则列表 ​

工具栏 ​

按钮权限说明
创建authentication·edit打开 新建/编辑规则弹窗
身份验证工具栏

列表表格 ​

列说明
名称规则唯一标识(新建后不可在此列表改名称,仅编辑弹窗内配置)
匹配器None / Any / Condition;为 Condition 时显示条件摘要(如 url = '/api')
操作None / JwtAuth / CustomCode
失败操作None / ResultCode / Redirect;操作为 CustomCode 时列显示 CustomCode
参数失败时相关参数:自定义代码名称、httpCode、重定向 url 等
最后修改保存时间
操作设置 图标进入 编辑

支持多选 删除(authentication·delete)。

身份验证列表

新建与编辑规则弹窗 ​

点击 创建 或行末 设置 打开。新建需填写 名称(1~50 字符,字母或数字开头、唯一);编辑已有规则时名称不可改。

身份验证规则编辑弹窗

匹配器(Matcher) ​

值说明
None不参与匹配(通常用于占位,实际不会命中请求)
Any匹配所有进入规则链的请求
Condition按下方条件匹配;多条条件为 且(&&) 关系,须全部满足

Condition 时每行包含:

字段可选值说明
左侧url、method分别为请求相对路径、HTTP 方法
运算符=、!=、contains、notcontains、startwith、notstartwith比较时不区分大小写
右侧文本与左侧字段比较的值

可 添加 / 删除 条件行;至少保留一条有效条件,否则无法保存。

Condition 匹配器与条件行

操作(Action) ​

值说明
None匹配后放行,不做校验
JwtAuth使用 JWT 解码校验;失败时执行下方 失败操作
CustomCode执行内联 TypeScript/KScript(Monaco 编辑器);失败时由脚本设置响应状态

选择 CustomCode 时显示代码编辑器,默认含示例:检查 Authorization 头并调用 k.response.unauthorized()。保存的是内联 customCode 正文(亦可与站点 代码 资源关联,列表加载时可能回填 customCodeName 对应正文)。

选择 JwtAuth 时显示 失败操作 区块(见下)。

失败操作(FailedAction) ​

仅在 操作 为 JwtAuth 时出现(CustomCode 由脚本自行处理响应)。

值说明
NoneJWT 校验失败时,将解码结果中的 value 写入响应正文
ResultCode返回指定 HTTP 状态码(如 401)
Redirect302 重定向到填写的 URL;自动附带 returnurl 查询参数(当前请求路径)
附加字段何时显示说明
HTTP 状态码ResultCode必填,合法 HTTP 状态码
URLRedirect必填,重定向目标(输入时自动去除空格)

规则如何生效 ​

  • 仅对 已绑定站点路由 的请求生效(有 Route.objectId 的页面、API 等);纯静态或未匹配路由的请求不经过此列表。
  • 系统按站点内规则 列表顺序 依次尝试匹配;第一条 匹配成功的规则被执行,后续规则不再检查。多条规则并存时请把更具体的 Condition 排在前面,或避免重叠的 Any。
  • JwtAuth:解码成功且结果 code !== 1 时放行,并将 value 放入请求上下文 jwt_payload;code === 1 视为失败,按 失败操作 处理。
  • CustomCode:执行脚本后若响应状态码 小于 300 则放行,否则请求终止(中间件可能返回 403)。
  • 校验未通过且未写入完整响应时,可能返回 403。

自定义代码中常用 API:k.request、k.response(如 unauthorized())、k.security.jwt。

相关 ​

文档说明
开发概述开发分组索引
代码CodeBlock,可与 CustomCode 配合
k.security.jwtJWT 编解码
k.responseunauthorized()、重定向等
认证与授权(API)k.account 会员登录(非本页规则)