集成

概述

弃用的通知

从Xray 3.0开始，以下第三方集成将被弃用，包括Black Duck、White Source和Aqua。JFrog不保证这些集成在升级后还能正常工作。自2019年2月起，JFrog被包括在内苏格兰皇家银行VulnDB作为其开箱即用的解决方案的一部分，取代了对第三方集成的需求。

JFrog Xray是开放的，可以与任何数量的问题和漏洞提供者集成，并预先配置了许多开箱即用的提供者。此外，如果您拥有相应提供商的帐户，则可以连接到其他问题和漏洞提要。的集成界面中的管理模块显示已配置和连接的集成。

要添加新的集成，请单击“添加集成”。如果系统中当前可用的所有集成都已配置，则该按钮将被禁用。

页面内容

的添加集成对话框显示您可以连接到的所有可用集成，并提供到的选项添加自定义集成．从显示的图标列表中选择要连接的提供商，或单击加号添加自定义集成。

要连接到提供程序，请设置启用复选框，输入以下参数:

的API密匙你从提供商那里收到的
的测试网址您可以使用“”来测试提供者的API密钥。测试”按钮。
的URLx射线用来检查它正在扫描的组件是否已向提供商注册。

阿卡

水的安全为容器化环境提供全面的安全解决方案。如果您有Aqua帐户，您可以启用此提要，输入您的Aqua API密钥，您的预置Aqua安装的URL和测试URL。

WhiteSource

WhiteSource为您的开源组件提供安全和许可证管理解决方案。如果您有WhiteSource帐户，您可以启用此提要并输入您的WhiteSource API密钥、URL和测试URL。

黑鸭子

黑鸭子提供企业级解决方案，自动化保护、管理和确保应用程序和容器中开源软件的许可证遵从性的过程。如果您是Black Duck的客户，您可以通过购买带有安全模块的标准Hub版本来启用此提要，输入提供的Black Duck API密钥、Black Duck安装的URL和测试URL来开始在Xray中使用Black Duck数据。

添加自定义集成

我n除了包括开箱即用的集成，Xray还允许您创建自定义集成。这使您有机会添加来自您可能拥有帐户的不同提供者的分析，甚至创建自己的提供者并显示信息，例如性能问题、已知缺陷或提供者提供的任何其他信息。

要启用此功能，您需要构建以下两个REST端点，并在Xray集成页面中配置它们。

构建集成端点

为了启用自定义集成，您需要构建并运行两个REST端点。

1.检查身份验证

请求指示提供的api键是否有效。这个API应该由提要提供者公开。

请求头
apiKey:“some-api-key-which-is-unique-for-a-specific-customer”

获得/ api / checkauth

有效API密钥响应示例(状态码:200)

{"valid": true， "error": ""}

无效的API密钥响应示例(状态代码:401)

{"valid": false， "error": "User api key无效"}

2.请求组件信息

这个API将允许Xray从提要提供者请求有关一个或多个组件的信息，每个组件都由唯一的组件id标识。API将由提要提供者实现。

请求

请求有效负载将包含Xray想要获取的组件的唯一标识符。
此外，Xray将为请求提供一个上下文，这可以是一个项目id或其他标识符。如果第三方服务允许其用户为每个项目定义策略，这将允许在这些策略的上下文中回答请求。例如，如果第三方服务允许为每个项目创建符合OSS许可证的策略，那么如果查询的组件违反了策略，Xray可能会得到带有许可证漏洞的响应。

请求头

apiKey:“some-api-key-which-is-unique-for-a-specific-customer”

请求负载

{"components": [{"component_id": "gav://ant:ant:1.6.5"， "blobs": ["97282a3b066de4ee4c9409979737f3911f95ceab"]}]， "context": "project_id"}

响应

响应将包含安全漏洞或其他问题的列表

{" components": [{"component_id": "gav://ant:ant:1.6.5"， "licenses": ["Apache 2.0"]， "provider": "提要提供者"，"漏洞":[{" cve": "cve -2012-2098"， "type": "security"， "source_id": "报告问题的唯一id"， "summary": "算法复杂度漏洞"，"description": " bzip2压缩流中排序算法中的算法复杂度漏洞"，"cvss_v2": "7.9"， "url": "http://more.info"， "publish_date":"2015-11-03T07:30:51.991+00:00"， "references": ["http://archives.neohapsis.com/archives/bugtraq/2012-05/0130.html"]}]}]}

配置集成端点

要配置端点，请转到集成页面并单击自定义集成。

自定义服务提供方程序

要添加并连接到自定义提供程序，请设置启用复选框，输入以下参数:

的供应商的名字
的API密匙你从提供商那里收到的
的URLx射线用来检查它正在扫描的组件是否已向提供商注册。
URL应该指向请求组件信息REST端点
的测试网址您可以使用“”来测试提供者的API密钥。测试”按钮。
测试URL应该指向检查身份验证REST端点
的指向图标的URL您可以选择为供应商显示
一个描述对于供应商