代码检查 CODEARTS CHECK-配置代码检查任务自定义规则集:自定义规则

时间:2024-09-11 14:23:17

自定义规则

  • 最多支持创建10条自定义规则。
  • 使用自定义规则扫描代码最多支持扫描10万行。仅适用于使用的规则集中只包含自定义规则。
  • 使用自定义规则扫描10万行代码行最多时长1.5小时。仅适用于使用的规则集中只包含自定义规则。

如果需要支持扫描更多行数的代码或需要创建更多数量的规则,可咨询华为技术支持。

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

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

    参数名称

    参数说明

    是否必填

    规则名称

    创建的规则名称,可自定义。

    • 支持中英文,数字,点,下划线“_”和连接符“-”
    • 字符长度范围为1~128

    工具规则名称

    默认填充为规则源码文件名,不可手动修改。

    检查工具

    该检查规则使用的检查工具,当前仅支持SecBrella。

    语言

    该规则检查的编译语言,当前仅支持Java。

    规则源码

    该规则的源码文件。

    由用户创建“.kirin”文件编写dsl规则,然后通过运行本地插件在“OutputReport”目录下生成“SecH_自定义规则名.json”的源码文件,上传json文件即可。使用插件生成规则文件可参考插件使用指南

    严重级别

    该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。

    标签

    为该规则设置标签,便于使用时区分该规则使用场景。

    添加多个标签时,需使用英文逗号分隔。

    描述

    对该规则的使用描述。如果描述的内容需要粘贴代码,代码内容支持MarkDown格式。字符数限制为0~10000。

    正确示例

    该规则对应的正确代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。

    错误示例

    不满足该规则的错误代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。

    修复建议

    对于该规则检查出的问题修改建议。如果修复建议中需要粘贴代码,代码内容支持MarkDown格式。字符数限制为0~10000。

  3. 单击“新建规则”,完成创建。
support.huaweicloud.com/usermanual-codecheck/codecheck_01_0009.html