检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析、恶意代码检测等能力,从合法合规、网络安全、供应安全等维度消减开源软件使用风险,助力企业更加安全、更加高效地使用开源软件。 您可以使用本文档提供的API对开源治理服务
用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。
可以查看开源许可证的信息和自定义开源许可证的风险等级。 支持区域:华北-北京四 开源许可证 查询审计日志 云审计服务是安全解决方案中专业的日志审计服务,记录了CodeArts Governance的相关操作事件,方便您日后的查询、审计和回溯。 支持区域:华北-北京四 支持审计日志的操作
提供软件包/固件全面分析功能,基于各类检测规则,获得相关被测对象的开源软件、信息泄露、安全配置、安全编译选项等存在的潜在风险。 用户只需上传产品软件包或固件文件提交扫描任务,服务即可输出详尽专业的测试报告。 前提条件 已获取管理控制台的登录账号与密码。 本地已准备好待扫描的二进制软件包。 操作步骤 登录开源治理服务控制台。
有待分析文件,基于组件特征识别技术、静态检测技术以及各种风险检测规则,获得相关被测对象的组件BOM清单和潜在风险清单,并输出一份专业的分析报告。 源码成分分析 对用户提供的源码进行全面分析,通过解压获取源码包中所有待分析源码文件,基于源码特征识别技术,获得相关被测对象的开源软件清
成分分析的任务扫描失败怎么办? 任务扫描失败可能由多种原因造成,需要针对具体情况进行分析,常见的失败原因如下: 表1 常见失败原因分析 失败原因 解决方案 文件解析异常 文件本身存在不完整、结构异常等问题,导致服务无法正常解析。提供通用的压缩、固件、包格式文件重新创建扫描任务即可。
通过分析软件包含的一些信息和特征来实现对该软件的识别、管理、追踪的技术。 PE(Portable Executable) 是Windows系统下的可执行文件的标准格式。 ELF(Executable and Linkable Format) 是一种Unix或Linux系统下的可执行文件
显示扫描任务中每个组件的组件名称、组件版本、开源许可证、包含文件数以及存在漏洞数。 组件名称、组件版本和文件数可按升降序查看。 可按组件名称、开源许可证对组件列表进行筛选查看。 开源许可证 显示开源软件的许可证检测结果,包括许可证使用的集成风险和许可证间的兼容性风险。 许可证信息:二进制文件包许可证检测结果,包含许
提供代码片段级别的代码克隆(TYPE1、TYPE2)检测分析服务,发现潜在的开源软件使用合规风险。 漏洞风险检测 提供已知漏洞安全检测分析服务,发现潜在的开源软件安全风险。 许可证合规检测 提供开源软件许可证风险等级评估体系,发现潜在的开源软件兼容性以及篡改等风险。
与其他服务的关系 与代码检查服务的关系 开源治理服务中的代码检查功能由独立的代码检查(CodeArts Check)云服务提供,用户可以通过超链接跳转至代码检查的页面进行使用。当前代码检查是CodeArts云服务下的子服务,用户需开通CodeArts服务方可使用。 与漏洞管理服务的关系
是否必选 参数类型 描述 file_path 否 String 文件路径 最小长度:1 最大长度:128 file_name 否 String 文件名称 最小长度:0 最大长度:128 file_size 否 Integer 文件名称 最小值:0 最大值:5368709120 响应参数 状态码:
二进制成分分析按需套餐包按扫描成功的次数结算,配额包扣费有延时,当前使用的次数会在1小时后从配额包中扣除。 套餐包规格如下: 20次:包含20次单文件扫描。 1次:包含1次单文件扫描。 假设您计划购买开源治理服务二进制成分分析按需套餐包,在购买页面底部,您将看到所需的配置费用。 图1 二进制成分分析按需套餐包配置费用示例
约束与限制 介绍开源治理服务的使用限制。 控制台使用限制 表1 控制台使用限制说明 指标类别 指标项 限制说明 浏览器 类型 目前适配的主流浏览器类型包括: Chrome浏览器:支持最新的3个稳定版本。 Firefox浏览器:支持最新的3个稳定版本。 Microsoft Edge
扫描对象 被扫描的软件包/固件,单击可进入本次任务的扫描详情。 文件大小 被扫描的文件的大小。 开始时间 开始扫描的时间。 扫描耗时 扫描耗费的时长。 任务状态 任务扫描状态,包括:等待中、进行中、已完成、已停止、已失败。 检测结果风险统计 显示各检查项的检测项目风险文件总数。 安全漏洞风险项
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
单击组件名称进入组件详情页面,显示该组件包含的文件对象和已知漏洞信息。 开源许可证 显示开源软件的许可证检测结果,包括许可证使用的风险等级和许可证间的兼容性风险。 许可证信息:源码文件包许可证检测结果,包含许可证名称、集成风险、涉及组件和许可证描述和风险分析。 许可证兼容性:源码文件包中各目录的许可证间兼容性风险检测。
您可以在API Explorer中调用API,查看API请求和返回结果。此外,API Explorer会自动生成相应API调用示例,帮助您使用API。 父主题: 使用前必读
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity
API概览 表1 流水线接口说明 分类 接口 二进制成分分析 包括创建上传分片文件任务、上传分片文件、结束上传分片文件任务等接口。