自定义检查规则集

创建自定义检查规则集

1. 进入代码检查页面，单击“规则集”页签，默认进入规则集列表页面。
2. 单击“新建规则集”，在弹出的“新建规则集”窗口设置规则集名称、描述以及检查语言。

   您也可以单击“复制于”下拉框选择复制于已有的规则集。（可选）

3. 单击“确定”。
4. 根据需要勾选规则名称、设置规则级别，单击右上角“保存”。

   如果系统预置的规则不满足用户的使用要求，可自定义规则使用。

   以Java规则集的代码安全检查增强包为例：

   

5. 进入“代码检查详情”页面选择“设置 > 规则集”，单击“已包含语言”所在行重新获取代码仓语言，打开目标语言的开关，并选中您已配置好的自定义规则集。具体请参见设置规则集。
6. 单击“开始检查”，即可按照自定义规则集执行检查。

删除自定义检查规则集

单击规则集所在行的，选择“删除”即可删除检查规则集。

• 只有创建者可以删除自定义规则集。
• 系统规则集和已被使用的自定义规则集无法删除。
• 如果需要删除已被使用的规则集，需将关联使用该规则集的代码检查任务删除或将代码检查任务关联到其它规则集。

修改自定义检查规则集

1. 单击规则集名称，进入规则集详情页面。
2. 单击“修改基本信息”。
3. 修改规则集名称或描述信息后，单击“确定”。
   

   • “检查语言”不支持修改。
   • 系统预置规则集无法修改。
   • 只有创建者可以修改自定义规则集。

自定义规则

1. 单击“规则”页签。
2. 单击“新建规则”，参考表1配置参数。

   表1 自定义规则参数配置说明

   参数	说明
   规则名称	创建的规则名称，可自定义。
   工具规则名称	默认填充为规则源码文件名，不可手动修改。
   检查工具	该检查规则使用的检查工具，当前仅支持SecBrella。
   语言	该规则检查的编译语言，当前仅支持Java。
   规则源码	该规则的源码文件。 由用户创建“.kirin”文件编写dsl规则，然后通过运行本地插件在“OutputReport”目录下生成“.json”的源码文件，上传json文件即可。
   严重级别	该规则检查出的代码问题的严重级别，分为致命、严重、一般和提示。
   标签	为该规则设置标签，便于使用时区分该规则使用场景。非必填。 说明： 添加多个标签时，需使用英文逗号分隔。
   描述	对该规则的使用描述。如果描述的内容需要粘贴代码，代码内容支持MarkDown格式，字符数限制为0~10000。
   正确示例	该规则对应的正确代码示例。代码内容支持使用MarkDown格式呈现，字符数限制为0~10000。非必填。
   错误示例	不满足该规则的错误代码示例。代码内容支持使用MarkDown格式呈现，字符数限制为0~10000。非必填。
   修复建议	对于该规则检查出的问题修改建议。如果修复建议中需要粘贴代码，代码内容支持MarkDown格式，字符数限制为0~10000。非必填。

3. 单击“新建规则”，完成创建。