检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第六次正式发布,本次变更说明如下: 错误码更新。 2024-03-13 第五次正式发布,本次变更说明如下: 下线移动应用安全接口。 上线二进制成分分析接口。 2024
控制台总览 开源治理服务(CodeArts Governance)是覆盖软件研发阶段的安全、合规检测产品集合,提供一站式的原子化的安全服务和专家咨询服务的入口,满足企业客户、检测机构针对于研发阶段安全和漏洞检测的需求。 本节为您介绍开源治理服务控制台登录方式及菜单页。 登录开源治理服务控制台
源码成分分析 添加源码成分分析任务 管理源码成分分析任务 查看源码成分分析扫描详情
概述 开源治理服务(CodeArts Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析、恶意代码检测等能力,从合法合规、网络安全、供应安全等维度消减开源软件使用风险,助力企业更加安全、更加高效地使用开源软件
如何调用API 构造请求 认证鉴权 返回结果
开源知识库 开源知识库提供已治理的开源软件数据资产信息,包含元数据信息、漏洞信息、依赖信息等内容。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源知识库”。 单击“开源知识库”页面搜索框左侧,在下拉框中选择“软件”或“组件”,在搜索框中输入对应名称,支持模糊搜索,单击
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
调用说明 开源治理服务提供了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。 父主题: 附录
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题
应用场景 二进制成分分析 二进制成分分析主要用于以下场景。 开源软件使用风险评估 二进制成分分析服务提供开放API,并与CI/CD融合,完善DevSecOps安全能力。 开源/第三方软件引入评估 二进制成分分析服务提供页面和开放API,提供风险快速评估能力。 源码成分分析 源码成分分析主要用于以下场景
开源许可证 操作场景 用户可以查看开源许可证的信息和自定义开源许可证的风险等级。 前提条件 已获取管理控制台的登录账号与密码。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源许可证”。 在“开源许可证”页面,可看到许可证列表,内容包含许可证名称、集成风险、许可证描述和风险分析以及重置操作
基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
CodeArts Governance最佳实践汇总 本文汇总了基于开源治理服务(CodeArts Governance)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户了解CodeArts Governance的使用方法。 表1 CodeArts Governance
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity.cn-north
二进制成分分析 添加二进制成分分析任务 管理二进制成分分析任务 查看二进制成分分析扫描详情 下载二进制成分分析扫描报告 相关术语说明
管理源码成分分析任务 操作场景 该任务指导用户通过开源治理服务查找、删除或停止源码成分分析任务。 前提条件 已获取管理控制台的登录账号与密码。 已添加任务。 查看任务 登录开源治理服务控制台。 在左侧导航栏,单击“软件成分分析 > 源码成分分析”。 在“源码成分分析”页面,查看成分分析任务列表