检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
不上传代码到云服务的情况下使用代码检查服务 应用场景 部分用户的代码有严格的保密机制,不允许将代码上传到外部网络,用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案,在不上传代码到云服务的情况下使用代码检查服务检查代码问题。
问题现象 TypeScript任务检查失败,日志显示404。 处理方法 请检查上传的项目文件中是否包含“package-lock.json”文件。 如果包含,则删除“package-lock.json”文件,重新Push代码进行检查。 如果不包含,则联系技术支持工程师。 父主题: 技术类问题
or directory。 原因分析 代码检查中用到自己封装的组件,未将组件上传到私有依赖库。 已经将组件上传到私有依赖库,但用户账号没有此私有依赖库的授权,导致从私有依赖库中下载组件失败。 处理方法 将组件上传到私有依赖库。 使用拥有私有依赖仓库管理员权限的账号进入私有依赖库的“独
任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 设置媒体类型和编码格式
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。
查的文件路径。设置完成后,执行代码检查任务,将按照设置排除选中的文件路径执行检查。 勾选的忽略文件对需要编译的文件和不需要编译的文件均生效。 不需要编译的文件:勾选忽略文件后,被忽略的文件不参与检查。 需要编译的文件:例如A文件与B文件互为依赖,即使把A文件忽略,但A文件依然会参
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
续费 续费概述 手动续费 自动续费
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
默认起始时间为当前任务第一次扫描成功的时间,起始时间之后扫描出的所有问题都将被划分为新问题。 配置源文件编码 设置文件的编码方式,源文件编码会影响系统识别的源码内容的完整性,系统默认编码为UTF-8。 在“源文件编码”区域,单击下拉框选择源文件编码。 完成后,提示修改成功。 配置问题责任人精准匹配 您可根据实际
提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。 当前代码安全检查增强包一共有284条规则,涵盖Java语言61个, C++ 语言199个, Go语言8个, Python语言16个。
代码。 工具规则名称 默认填充为规则源码文件名,不可手动修改。 检查工具 该检查规则使用的检查工具,当前仅支持SecBrella。 语言 该规则检查的编译语言,当前仅支持Java。 规则源码 该规则的源码文件。上传创建规则文件中生成的文件。 严重级别 该规则检查出的代码问题的严重
如何调用API 构造请求 认证鉴权 返回结果
件在“OutputReport”目录下生成“SecH_自定义规则名.json”的源码文件,上传json文件即可。使用插件生成规则文件可参考插件使用指南。 是 严重级别 该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。 是 标签 为该规则设置标签,便于使用时区分该规则使用场景。
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定义:Java语言连续10行重复,其它语言10行中连续100个字符重复算一个重复块);重复率=重复行/代码总行数(不包含空行与注释)。 规则
执行代码检查任务 查看代码检查详情 02 入门 从0到1,快速学习代码检查服务。 快速入门 代码检查基本流程 04 API 通过代码检查开放的API和调用示例,您可以对任务、缺陷、规则等进行管理。 API文档 使用前必读 API概览 如何调用API 附录 常见问题 了解更多常见问题、案例和解决方案
non_hfile_duplication_total 重复源文件数。 统计C语言重复文件中后缀名为源文件的文件个数。其他语言没有头文件,所有文件都是源文件。 non_hfile_duplication_ratio 源文件重复率。 源文件重复率=重复源文件数/文件总数*100(单位:百分比%) code_duplication_total