需要其他JFrog产品的帮助吗?hth华体会最新官方网站

JFrog平台
JFrog Artifactory
JFrog x光
JFrog任务控制
JFrog分布
(JFrog管道)
JFrog访问


页面树
跳到元数据的末尾
转到元数据开始

概述

介绍如何在JFrog Xray中使用JFrog CLI。

阅读更多关于JFrog CLI的信息在这里

身份验证

当与Xray一起使用时,JFrog CLI提供了几种认证方式:JFrog CLI不支持不认证的访问Xray。

使用用户名和密码进行认证

要使用Xray登录凭据进行身份验证,可以使用jfrog c添加命令或者为每个命令提供以下选项。

命令选项 描述
url—— JFrog Xray API端点URL。它通常以/xray结束
——用户 JFrog用户名
——密码 JFrog密码

使用访问令牌进行身份验证

要使用Xray访问令牌对自己进行身份验证,可以使用jfrog c添加命令或者为每个命令提供以下选项。

命令选项 描述
url—— JFrog Xray API端点URL。它通常以/xray结束
——访问令牌 JFrog访问令牌

页面内容


将军的命令

运行cUrl

使用配置的x射线详细信息执行cUrl命令。该命令期望cUrl客户端包含在PATH中。

命令名

xr旋度

缩写
xr cl
命令选项


——服务器id

(可选)

配置的服务器IDjfrog c添加命令。如果不指定,则使用默认配置的服务器。

命令参数

cUrl参数和标志

传递给cUrl的参数和标志的相同列表,除了以下更改:

  1. 不应该传递完整的Xray URL。相反,应该发送REST端点URI。
  2. 不应传递登录凭据。相反,应该使用——server id。

例子

示例1

执行cUrl客户端,向默认配置的Xray服务器的/api/system/version端点发送一个GET请求。

jf xr curl -XGET /api/v1/system/version

示例2

执行cUrl客户端,向/api/v1/system/version端点发送一个GET请求到配置的my-xr-server服务器ID。

jf rt curl -XGET /api/v1/system/version——server-id my-xr-server . zip


下载Xray数据库的更新

offline-update命令将更新下载到for Xray的漏洞数据库。Xray UI允许为您构建命令结构。

命令名

xr offline-update

缩写
xr欧
命令选项


——license-id

(强制)

x光授权ID。

——从

(可选)

从更新日期开始,YYYY-MM-DD格式。

——以

(可选)

以YYYY-MM-DD格式更新日期。

——版本

(可选)

x光API版本。

——目标

(默认值:. /)

下载更新文件的路径。

——dbsyncv3

(默认值:false)

设置为true时使用Xray DBSync V3。

——定期

(默认值:false)

设置为true将获取Xray DBSync V3周期包(与dbsyncv3标志一起使用)。

命令参数
该命令不接受参数。

随需应变的二进制扫描

随需应变的二进制扫描使您能够指向本地文件系统中的二进制文件,并在将二进制文件或构建上传到Artifactory之前接收包含该二进制文件的漏洞、许可证和策略违反列表的报告。

扫描本地文件系统中的文件

这个jf扫描命令用x射线扫描本地文件系统上的文件。

这个命令需要:

  • 版本3.29.0或以上的Xray
  • JFrog CLI版本2.1.0或以上
命令名

扫描

缩写

年代

命令选项

——服务器id

(可选)

配置的服务器IDjfrog c添加命令。如果不指定,则使用默认配置的服务器。

——规范

(可选)

指定要扫描的文件的文件路径。如果向命令提供了pattern参数,则不应提供此选项。

——项目

(可选)

JFrog项目密钥,使Xray能够相应地确定安全违规。只有在没有提供——repo-path和——watches选项时,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞。

——repo-path

(可选)

Artifactory存储库路径的形式为<存储库>/存储库>中的<路径,以使Xray能够相应地确定违规。只有在没有提供——project和——watches选项的情况下,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞。

——手表

(可选)

用逗号分隔x射线表的列表,使x射线能够相应地确定违规行为。只有在没有提供——project和——repo-path选项时,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞。

——许可证

(默认值:false)

如果还需要显示许可证列表,请设置。

——= json格式

(可选)

生成一个包含扫描结果的JSON文件。

命令参数

模式

指定要扫描工件的本地文件系统路径。可以使用通配符指定多个文件。

输出示例

例子

示例1

使用Xray中定义的watch1表扫描位于路径/ti/files/ file-system目录下的所有文件。

“路径/到/文件/”——查看“watch1”


示例2
方法扫描路径/ti/files/文件系统目录下的所有文件watch1而且watch2手表定义在x射线。

“路径/到/文件/”——手表“watch1,watch2”


示例3

方法扫描位于路径/ti/files/文件系统目录下的所有zip文件watch1而且watch2手表定义在x射线。

“路径/到/文件/*.zip”——查看“watch1,watch2”


示例4

使用为project-1定义的策略扫描位于路径/ti/files/ file-system目录下的所有tgz文件。

摩根富林明/ /文件/ * s”路径。tgz" --project "project-1"


示例5
对象中的所有tgz文件
当前的目录中使用为libs-local release-artifacts /在Artifactory路径。

摩根富林明年代“* . tgz”——repo-path"libs-local/release-artifacts/"


例子6
对象上的所有tgz文件当前目录。显示所有已知的漏洞,而不考虑Xray中定义的策略。

摩根富林明年代“* . tgz”

扫描本地文件系统上的Docker容器

这个jf码头工人扫描命令扫描位于本地文件系统上的docker容器码头工人的客户而且JFrog x光.在扫描容器之前,不需要将容器部署到Artifactory或任何其他容器注册中心。

这个命令需要:

  • 版本3.40.0或以上的Xray
  • JFrog CLI版本2.11.0或以上
命令名

码头工人扫描

缩写


命令选项

——服务器id

(可选)

配置的服务器IDjfrog c添加命令。如果不指定,则使用默认配置的服务器。

——项目

(可选)

JFrog项目密钥,使Xray能够相应地确定安全违规。只有在没有提供——repo-path和——watches选项时,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞。

——repo-path

(可选)

Artifactory存储库路径的形式为<存储库>/存储库>中的<路径,以使Xray能够相应地确定违规。只有在没有提供——project和——watches选项的情况下,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞。

——手表

(可选)

用逗号分隔x射线表的列表,使x射线能够相应地确定违规行为。只有在没有提供——repo-path和——repo-path选项时,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞。

——许可证

(默认值:false)

如果还需要显示许可证列表,请设置。

——= json格式

(可选)

生成一个包含扫描结果的JSON文件。

命令参数

模式

指定要扫描工件的本地文件系统路径。可以使用通配符指定多个文件。


输出示例

例子

示例1

扫描本地reg1 / repo1 / img1:1.0.0容器,并显示所有已知的漏洞,而不管在Xray中定义的策略是什么。

$ $ jf docker scan reg1/repo1/img1 1.0.0 6446ea57df7b 19 months ago 5.57MB $ $ jf docker scan reg1/repo1/img1:1.0.0


示例2

扫描本地reg1 / repo1 / img1:1.0.0容器,并根据关联的策略显示所有违规行为我的项目JFrog项目。

$ $ jf docker scan reg1/repo1/img1 1.0.0 6446ea57df7b 19 months ago 5.57MB $ $ jf docker scan reg1/repo1/img1:1.0.0——project my-project


示例3

扫描本地reg1 / repo1 / img1:1.0.0容器,并根据关联的策略显示所有违规行为我的手表x光的手表。

$ $ jf docker scan reg1/repo1/img1 1.0.0 6446ea57df7b 19 months ago 5.57MB $ $ jf docker scan reg1/repo1/img1:1.0.0——watches my-watch


示例4

扫描本地reg1 / repo1 / img1:1.0.0容器,并根据关联的策略显示所有违规行为releases-local / app1 /在Artifactpry路径。

$ $ jf docker scan reg1/repo1/img1 1.0.0 6446ea57df7b 19 months ago 5.57MB $ $ jf docker scan reg1/repo1/img1:1.0.0——repo-path releases-local/app1/


扫描项目依赖项

摩根富林明审计命令允许扫描您的源代码依赖项,以找到安全漏洞和许可证违规,并能够扫描您的Xray策略。该命令为您的项目构建一个深度依赖关系图,用Xray扫描它,并显示结果。它使用项目使用的包管理器来构建依赖关系图。目前支持以下包管理器。

  • Maven (mvn)——支持Maven的3.1.0或更高版本。
  • Gradle(它)
  • Npm (Npm)
  • 纱2(纱)
  • 皮普(Pip)
  • Pipenv (Pipenv)
  • 模块(去)
  • NuGet (NuGet)
  • .NET核心命令行(dotnet)

该命令将自动检测项目使用的包管理器。需要Xray版本3.29.0或以上,JFrog CLI版本2.13.0或以上。

命令名

审计

缩写

澳元

命令选项

——服务器id

(可选)

配置的服务器IDjfrog c添加命令。如果不指定,则使用默认配置的服务器。

——项目

(可选)

JFrog项目密钥,使Xray能够相应地确定安全违规。只有在没有提供——repo-path和——watches选项时,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞

——repo-path

(可选)

Artifactory存储库路径的形式为<存储库>/存储库>中的<路径,以使Xray能够相应地确定违规。只有在没有提供——project和——watches选项的情况下,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞

——手表

(可选)

用逗号分隔x射线表的列表,使x射线能够相应地确定违规行为。只有在没有提供——repo-path和——repo-path选项时,该命令才接受此选项。如果这三个选项都没有提供,该命令将显示所有已知的漏洞

——许可证

(默认值:false)

如果还希望显示许可证列表,请进行设置。

- - -格式

(默认:表)

定义命令的输出格式。可接受的值是:table和json。

——失败

(默认值:真实)

如果您不希望命令返回退出代码3,则设置为false,即使“失败构建”规则被Xray匹配。

——使用包装

(默认值:false)

如果你想使用Gradle包装器,请设置为true。

——dep-type

(默认值:所有)

定义npm依赖类型。取值为all、devOnly、prodOnly

——exclude-test-deps

(默认值:false)

如果你想从x射线扫描中排除Gradle测试依赖项,则设置为true。

——去

(默认值:false)

设置为true为Go项目请求审计。

——gradle

(默认值:false)

设置为true为Gradle项目请求审计。

——mvn

(默认值:false)

设置为true可为Maven项目请求审计。

——npm

(默认值:false)

设置为true为npm项目请求审计。

——nuge

(默认值:false)

设置为true为. net项目请求审计。

——脉冲

(默认值:false)

设置为true为Pip项目请求审计。

——pipenv

(默认值:false)

设置为true可为Pipenv项目请求审计。

——纱

(默认值:false)

设置为true为Yarn 2+项目请求审计。

命令参数

该命令不接受参数

输出示例

例子

示例1

在当前目录下审计项目。显示所有已知的漏洞,而不考虑Xray中定义的策略。

jfrog审计

示例2

在当前目录下审计项目。显示所有已知的漏洞,而不考虑Xray中定义的策略。只显示maven和npm漏洞

Jfrog审计—mvn—npm

示例3

使用名为watch1x射线定义的手表。

Jf审计—监视“watch1”

示例4

在当前目录下审计项目watch1而且watch2在x光中定义。

Jf审计—监视“watch1,watch2”

示例5

使用为项目-1定义的策略在当前目录下审计项目。

Jf审计—项目“project-1”

例子6

对象定义的策略对当前目录中的项目进行审计libs-local release-artifacts /在Artifactory路径。

Jf审计-repo-path "lib -local/release-artifacts/"

扫描发布构建

JFrog CLI集成了JFrog Xray和JFrog Artifactory,允许您扫描构建工件和依赖项的漏洞和许可证违规。该命令允许扫描已经发布到Artifactory的构建构建发布命令

命令名

build-scan

缩写
废话
命令选项


——服务器id

(可选)

配置的服务器IDjfrog c添加命令。如果不指定,则使用默认配置的服务器。

——vuln

(可选)

如果您想接收所有漏洞,则设置该值,而不管在Xray中配置的策略是什么。

——失败

(默认值:真实)

设置后,如果x射线匹配了“失败构建”规则,该命令返回退出代码3。
如果不希望命令在这种情况下返回退出代码3,则设置为false,并且将返回退出代码0。

- - -格式

(默认:表)

定义命令的输出格式。公认的值是:表格而且json

——项目

(可选)

JFrog项目关键

——重新扫描

(默认值:false)

在扫描已经成功扫描的构建时设置为true,例如在添加忽略规则后。

命令参数
该命令接受两个参数。
构建的名字 构建要扫描的名称。
建立数 要扫描的版本号。
例子
Jf bs my-build-name 18



  • 没有标签