检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 开源治理服务(CodeArts Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析、恶意代码检测等能力,从合法合规、网络安全、供应安全等维度消减开源软件使用风险,助力企业更加安全、更加高效地使用开源软件。
如何调用API 构造请求 认证鉴权 返回结果
开源知识库 开源知识库提供已治理的开源软件数据资产信息,包含元数据信息、漏洞信息、依赖信息等内容。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源知识库”。 单击“开源知识库”页面搜索框左侧,在下拉框中选择“软件”或“组件”,在搜索框中输入对应名称,支持模糊搜索,单
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
调用说明 开源治理服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API Explorer会
获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
按需套餐包 适用场景 按需套餐包适用于短期使用的场景。 适用计费项 表1 二进制成分分析按需套餐包适用计费项 计费项 说明 扫描成功的次数 二进制成分分析为每个华为云账号提供5次免费试用的机会,可以免费试用5次任务。免费试用扫描对象文件大小限制300MB,可体验所有检查项功能。
CodeArts Governance最佳实践汇总 本文汇总了基于开源治理服务(CodeArts Governance)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户了解CodeArts Governance的使用方法。 表1 CodeArts Governance最佳实践一览表
二进制成分分析 添加二进制成分分析任务 管理二进制成分分析任务 查看二进制成分分析扫描详情 下载二进制成分分析扫描报告 相关术语说明
计费模式概述 开源治理服务提供按需套餐包和包年/包月计费模式,以满足您的不同用户需求。 按需套餐包,一种预付费模式,即先付费再使用,按照扫描成功的次数结算。 包年/包月,一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买时长不同优惠力度不同。 表1 二进制成分分析计费模式说明
二进制成分分析 创建上传分片文件任务 上传分片文件 结束上传分片文件任务 创建二进制成分分析扫描任务 获取任务状态 停止任务 删除任务 获取开源漏洞分析报告 获取开源漏洞分析统计数据 获取密钥和信息泄露统计数据 获取安全编译选项统计数据 获取安全配置统计数据 创建报告PDF 查看报告PDF状态
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity
二进制成分分析类 成分分析的扫描对象是什么? 成分分析的主要扫描规格有哪些? 成分分析的扫描原理是什么,主要识别哪些风险? 成分分析的开源软件风险如何分析? 成分分析的安全编译选项类问题如何分析? 成分分析的安全配置类问题如何分析? 成分分析的信息泄露问题如何分析? 组件版本为什么没有被识别出来或识别错误?
相关术语说明 开源(open source) 即开放一类技术或一种产品的源代码,源数据,源资产,可以是各行业的技术或产品,其范畴涵盖文化、产业、法律、技术等多个社会维度。 开源软件(open source software) 允许用户直接访问源代码,通过开源许可协议将其复制、修改、再发布的权利向公众开放的计算机软件。
管理源码成分分析任务 操作场景 该任务指导用户通过开源治理服务查找、删除或停止源码成分分析任务。 前提条件 已获取管理控制台的登录账号与密码。 已添加任务。 查看任务 登录开源治理服务控制台。 在左侧导航栏,单击“软件成分分析 > 源码成分分析”。 在“源码成分分析”页面,查看成
添加源码成分分析任务 提供对源码的全面分析功能,通过解压获取源码包中所有待分析源码文件,基于源码特征识别技术,获得相关被测对象的开源软件清单和潜在风险清单,并输出一份专业的分析报告。 用户只需要上传代码文件或关联代码仓库提交扫描任务,服务即可输出详尽专业的测试报告。 前提条件 已获取管理控制台的登录账号与密码。
停止任务 功能介绍 根据任务ID停止任务 URI POST /v1/{project_id}/sbc/task/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数