配置代码检查任务模型集

约束与限制

• 模型集为受限功能，仅购买代码检查安全增强包后才可使用该功能。
• 当前仅支持“华北-北京四”。
• 每个租户最多可创建100个模型集和20条模型。
• 模型集当前仅支持C/C++语言和secbrella引擎。
• 新建模型时，上传的文件仅支持json后缀的文件。

查看模型集

用户可提前查看模型集详情，根据实际需要选择对应的模型集。

1. 访问CodeArts Check服务首页。
2. 单击“模型集”页签，进入模型集列表页面。
3. 单击模型集名称，进入该模型集详情页面，可查看模型集中的模型使用详情。

配置代码检查任务使用模型集

1. 进入代码检查页面，在任务列表中，单击任务名称。
2. 进入“代码检查详情”页面，选择“设置 > 模型集”。
3. 在右侧区域选择使用的模型集。
4. 单击页面右上角“管理模型集”，可跳转至模型集列表页。

新建模型

1. 单击新建的模型集名称，进入模型集详情页面，单击“新建模型”。
2. 在新建模型页面，参考表2配置模型参数。

   表2 新建模型

   参数	说明
   模型文件	在本地创建的模型文件，操作可参考创建模型文件。
   模型名称	上传模型文件后自动生成，无需手动填写。
   检查语言	当前仅支持C/C++语言。
   执行工具	当前仅支持secbrella引擎。
   标签	对当前模型的标签，用于识别当前模型的分类，字符长度范围为0~256。
   描述	对当前模型的描述，字符长度范围为0~256。

3. 单击“确定”。
4. 新建完成后，在模型集下可以对模型进行如下操作。
   • 单击模型所在行，可在弹框中重新上传模型文件和修改用户标签以及描述。
   • 单击模型所在行，可下载模型文件。
   • 单击模型所在行，可删除模型。

创建模型文件

代码示例如下：

{
  "RulePackage": {
    "Language": "C++" # 必填，C或者C++
  },
  "Rules": {
    "TaintSourceRule": [ # 污点源配置
      {
        "Function": { # 污点源函数配置1
          "Namespace": {
            "Value":"TestSpace" # 命令空间，如果没有可以不写
          },
          "Class": {
            "Value": "TestClass" # 类名，如果没有可以不写
          },
          "Function": {
            "Value": "TaintCase1" # 函数名，必填
          }
        },
        "Source": { # 污点源函数参数配置
          "InArgs": "0,2-3", # InArgs配置函数形参位置（参数具体配置看基本概念）
          "TaintFlags": "UntrustedSource" # 污点标识，固定值
        } 
      },
      {
        "Function": { # 污点源函数配置2
          "Namespace": {
            "Value":"TestSpace" # 命令空间，如果没有可以不写
          },
          "Class": {
            "Value": "TestClass" # 类名，如果没有可以不写
          },
          "Function": {
            "Value": "TaintCase2" # 函数名，必填
          }
        },
        "Source": { # 污点源函数参数配置
          "OutArgs": "return,2-3", # OutArgs在配置函数实参位置或者配置函数返回值
          "TaintFlags": "UntrustedSource" # 污点标识，固定值
        }
      },
      {
        "GlobalVariable": { # 污点源全局变量配置
          "Name": {
            "Value": "g_xxxx" # 全局变量名，必填
          }
        },
        "Source": {
          "TaintFlags": "UntrustedSource" # 污点标识，固定值
        }
      },
      {
        "TaintVariable": {  # 污点源局部变量配置
          "Name": {
            "Value": "local_var" # 局部变量名，必填
          }
        },
        "Source": {
          "TaintFlags": "UntrustedSource" # 污点标识，固定值
        }
      }
    ],
    "TaintSinkRule": [ # 污点爆发配置
      {
        "Function": { # 污点爆发函数配置
          "Namespace": {
            "Value":"TestSpace" # 命令空间，如果没有可以不写
          },
          "Class": {
            "Value": "TestClass" # 类名，如果没有可以不写
          },
          "Function": {
            "Value": "TaintSink" # 函数名，必填
          }
        },
        "Sink": {
          "InArgs": "0", # InArgs配置函数爆发参数位置，TaintSinkRule配置只有InArgs
          "TaintFlags": "UntrustedSink" # 污点标识，固定值
        }
      }
    ],
    "TaintPassthroughRule": [ # 污点传播配置
      {
        "Function": { # 污点传播函数配置1
          "Namespace": {
            "Value":"TestSpace" # 命令空间，如果没有可以不写
          },
          "Class": {
            "Value": "TestClass" # 类名，如果没有可以不写
          },
          "Function": {
            "Value": "TaintPass" # 函数名，必填
          }
        },
        "Passthrough": {
          "InArgs": "0", # 配置位置在InArgs的污点参数传播到位置是OutArgs的参数或者返回值
          "OutArgs": "1" 
        }
      },
      {
        "Function": { # 污点传播函数配置2
          "Function": {
            "Value": "TaintPass2" # 函数名，必填
          }
        },
        "Passthrough": {
          "InArgs": "0", # 配置位置在InArgs的污点参数传播到位置是OutArgs的参数或者返回值
          "OutArgs": "return"
        }
      }
    ],
    "TaintCleanseRule": [ # 污点净化配置
      {
        "Function": { # 污点净化函数配置
          "Namespace": {
            "Value":"TestSpace" # 命令空间，如果没有可以不写
          },
          "Class": {
            "Value": "TestClass" # 类名，如果没有可以不写
          },
          "Function": {
            "Value": "Sanitize"  # 函数名，必填
          }
        },
        "Cleanse": {
          "InArgs": "0" # InArgs配置函数净化参数位置，TaintCleanseRule配置只有InArgs
        }
      }
    ],
    "TaintAnnotations": { # 内存申请释放，空指针类配置
      "SpaceA::ClassA::test_malloc": [ # 函数名，必填, 格式： 命令空间::(没有就不写)类名::(没有就不写)函数名
        ["AllocSource::1", "InitNull"], # 第一个[], 代表返回值，没有配置就为空[],这里配置了"AllocSource::1"代表返回值有返回内存，且1代表id，该内存只能用相同id的释放函数释放;还配置了"InitNull"代表可能返回空指针
        [],   # 第二个[], 如果是类函数，代表this指针，没有配置就为空[]
        []    # 第三个[], 如果是类函数，代表第一个参数
      ],
      "malloc": [ # 函数名
        ["AllocSource::1", "InitNull"], # 第一个[], 代表返回值，没有配置就为空[],这里配置了"AllocSource::1"代表返回值有返回内存，且1代表id，该内存只能用相同id的释放函数释放;还配置了"InitNull"代表可能返回空指针
        [   # 第二个[], 如果是普通函数，代表第一个参数，没有配置就为空[]，这里配置了"AllocSize"代表该参数是申请内存的长度
          "AllocSize"
        ]
      ],
      "free": [ # 函数名
        [], # 第一个[], 代表返回值，没有配置就为空[]
        [   # 第二个[], 如果是普通函数，代表第一个参数，没有配置就为空[]，这里配置了"FreeSink::1"代表该参数有释放行为，且1代表id，只有用于释放来自相同id的申请内存函数的内存,如果希望该释放函数不需要用于指定的申请函数，那么可以配置"FreeSink"
          "FreeSink::1"
        ]
      ]
    }
  }
}