Skip to content

策略格式 ​

策略是一个 YAML 或 JSON 对象。任何一层出现不认识的字段都会被拒收。preworld-guard policy-schema 输出 JSON Schema,preworld-guard policy-validate <文件> 编译一份文件并打印它的摘要。规则怎样判定,见策略。

文档 ​

字段类型默认值说明
schema_versionguard.policy.v1 或 guard.policy.v2guard.policy.v1require_approval 和 degrade 需要 v2
policy_id字符串,1–120 个字符runtime-default
version整数,≥ 11发布时由控制面分配版本
name字符串最小权限 · 运行时防护
modeobserve、suggest 或 enforceobserve见模式
default_effectallow 或 denyallow没有规则命中时怎么办
source字符串manual策略的来源
finding_ids字符串列表[]这份策略对应的评测发现
expires_atISO 8601 时间,或 nullnull过了这个时间,所有动作一律拒绝。读不出来的值视为已过期
rules规则列表[]规则编号必须唯一

规则 ​

字段类型默认值说明
rule_id字符串,1–120 个字符在策略内唯一
effectallow、deny、require_approval 或 degrade后两种需要格式 v2
fallback_resource字符串degrade 必填,其他效果不能写
riskhigh 或 normalhigh建议模式下只有高风险的拒绝规则会拒绝
match对象匹配一切见 match
message字符串动作符合当前运行时策略。随判定一起显示

match ​

字段类型何时满足
action_type字符串相等,或 *(默认)
resource通配符通配符匹配,或 *(默认)
agent_id字符串相等
destination通配符动作的目标地址匹配;没有目标地址时永远不匹配
argument_keys字符串列表这些参数名都在
argument_equals映射:参数名 → 值每个参数等于对应的值;session.subject_id 表示可信主体
argument_in映射:参数名 → 字符串列表每个参数是其中一个值
argument_regex映射:参数名 → 正则表达式每个参数是字符串(≤ 4,096 个字符),并整体匹配这个表达式
argument_path_under映射:参数名 → 目录每个参数是路径,解析后位于这个目录之下
data_labels字符串列表动作带了这些标签

规则写的条件越多就越具体。格式 v2 里,非拒绝规则之间按具体程度决定谁胜出。

上限 ​

项目上限
单个正则表达式1,024 个字符
一份策略里所有正则表达式合计4,096 个字符
控制台编辑器里的策略源文64 KiB、16 层、5,000 个节点
携带整份策略的请求256 KiB

控制台编辑器还会拒收 YAML 锚点、别名、标签、合并键、重复的键和多文档。

示例 ​