规则引擎 2.0 on DefectDojo Documentation

关于 Rules Engine 2.0

Mon, 01 Jan 0001 00:00:00 +0000

注意：Rules Engine 2.0 是 DefectDojo Pro 专属功能。

Rules Engine 2.0 是一个可视化自动化构建器。规则不再是“一个过滤器加一份扁平的动作列表”，而是一个图（graph）：一个决定规则何时被唤醒的触发器节点，以及任意数量相互连接的逻辑、发现项和出站（egress）节点，用来说明接下来会发生什么。

Rules Engine 2.0 只能通过 Pro UI 访问。

Mon, 01 Jan 0001 00:00:00 +0000

注意：Rules Engine 2.0 是 DefectDojo Pro 专属功能。

规则是在画布上构建的。您从调色板中拖出节点，将它们连接起来，并在侧边面板中配置每一个节点。本页介绍的是这一过程中不论使用哪些节点都相同的部分。节点本身的说明请见节点参考。

打开 Rules Engine 2.0 > All Rules，选择 New Rule，或打开一条已有规则进行编辑。

Mon, 01 Jan 0001 00:00:00 +0000

注意：Rules Engine 2.0 是 DefectDojo Pro 专属功能。

Rules Engine 2.0 内置了分为四大类的 25 个节点。本页对它们逐一进行说明。

除非另有说明，每个节点都接受一个输入，产生一个名为 out 的输出，并将其收到的每一项都传递给该输出。这一点在你串联多个节点时很重要：一个发现项节点会先修改该发现项，然后再将其向后传递，因此依次排列的多个此类节点都会依次生效。

每张图中都有且仅有一个触发器，也只有触发器才能启动一次运行。三种触发器都会产生发现项，并且都带有一个范围设置，用来限定它们产生哪些发现项。范围的具体工作方式参见构建规则。

Mon, 01 Jan 0001 00:00:00 +0000

注意：规则引擎 2.0 是 DefectDojo Pro 专属功能。

运行是一条规则的一次执行。无论成功还是失败，每次运行都会被记录，其中的每个节点也都会留下痕迹。规则引擎 2.0 > 运行页面会列出这些记录。

Field	Meaning
规则	执行该操作的规则。
触发方式	触发此次运行的事件，例如 `finding.created`、`schedule` 或 `manual`。
触发人	在有人手动触发时，指按下"运行"的人，或保存了引发此次运行的发现项的人。对于按计划触发，以及诸如导入或没有用户的 API 调用等无人在场的变更，此字段为空。这与规则的所有者不同，所有者指的是此次运行以谁的身份执行。
状态	`Running`、`Success` 或 `Error`。
开始时间与结束时间	运行发生的时间。只有在仍在运行时，结束时间才为空。
错误	若运行失败，导致其结束的错误。
统计信息	按节点统计的总数、级联事件以及延迟处理的工作。
深度	此次运行距离触发它的原始事件经过了多少次级联跳转。
源运行	对于级联触发的运行，指其所发出的事件触发了此次运行的那次运行。

在一次运行中，每个节点都会记录自己的一行数据：

Mon, 01 Jan 0001 00:00:00 +0000

注意：Rules Engine 2.0 是 DefectDojo Pro 专属功能。

规则产生的每一个对外副作用，都会在投递台账中生成一行记录。Rules Engine 2.0 > Deliveries 页面会列出这些记录。

该记录会在发生任何网络调用之前写入，其中保存的正是即将发送或已经发送的确切内容。正因如此，出站发送才是可审计的，而不是一条只能寄希望于有人保留下来的日志；这也是模拟并非另一条独立代码路径的原因：模拟发送使用的是同一条记录，只是跳过了实际派发步骤。

字段	含义
运行和节点	产生该记录的运行以及出站节点。
发现项	对于按发现项逐条发送的记录，指其对应的发现项；批量发送记录的则是该批次分组。
渠道	该发送的类型。
目标	解析后的目的地：JIRA 项目键、频道、URL 或地址。
标题	对该次发送的一行简要描述。
负载	即将发送或已发送的确切内容。
模式	`simulate` 或 `live`。
状态	该投递记录当前所处的阶段。
尝试次数	已尝试发送的次数，以及允许的最大次数。
最后错误	上一次尝试失败的原因，或该记录被跳过的原因。
响应	目标返回的内容。
外部引用和 URL	目标返回的工单编号、消息 ID 或文件路径，以及指向它的链接（如果有）。

状态	含义
`simulated`	该规则处于模拟模式。没有发送任何内容，以后也不会发送。
`skipped`	已有其他记录覆盖了此次发送，或该发送被门控逻辑拒绝。原因记录在“最后错误”字段中。
`pending`	已在正式模式下记录，正在等待其投递任务执行。
`dispatched`	已交给集成服务，正在等待确认。
`sent`	已确认送达。
`failed`	被永久性拒绝，例如收到 4xx 或供应商返回的错误。可以重放。
`dead`	重试次数已耗尽，或始终未收到确认。可以重放。

skipped 值得多说一句。跳过操作会被记录下来，而不是悄无声息地发生，因为“规则什么都没做”和“规则什么都没做，是因为该发现项已经有工单了”是两种不同的情况，其中只有一种才是问题。

Mon, 01 Jan 0001 00:00:00 +0000

注意：Rules Engine 2.0 是 DefectDojo Pro 专属功能。

两套引擎并行运行。启用 Rules Engine 2.0 不会改变您现有的 Rules Engine 规则中的任何内容，也没有必须迁移它们的截止时间。

当您确实想要迁移时，有一个转换器可以使用。它会将一条 Rules Engine 规则（一个过滤器加一份有序的动作列表）转换为一张等价的 Rules Engine 2.0 图。

Mon, 01 Jan 0001 00:00:00 +0000

注意：Rules Engine 2.0 是 DefectDojo Pro 专属功能。

Rules Engine 2.0 开箱即用。本页的设置面向那些需要调整吞吐量、保留期或出站网络策略的部署环境。所有这些设置的应用方式都与其他任何 DefectDojo 设置相同（参见配置）。

Rules Engine 2.0 与原有的 Rules Engine 分开配置。两套引擎不共享任何调优参数，因此 DD_RULES_ENGINE_* 设置不会影响 Rules Engine 2.0，DD_RULES_V2_* 设置也不会影响原有引擎。