CLI for JFrog Curation

Overview

JFrog Curation defends your software supply chain, enabling early blocking of malicious or risky open-source packages before they even enter. Seamlessly identify harmful, vulnerable, or risky packages, ensuring increased security, compliance, and developer productivity.

For more information see: https://jfrog.com/curation/

"The 'curation-audit' is a JFrog CLI command designed for developers to scan their projects and identify third-party dependencies that violate the restrictions set by the Curation service. This command provides detailed insights into the specific package policies that are being violated, leading to their blockage by the Curation service. Additionally, when feasible, 'curation-audit' may suggest alternative versions of the packages that comply with the Curation policies."

Supported package managers & build systems

For a full list of the package managers and build systems supported by the curation-audit command and the required Artifactory and Xray versions to use it please see: https://jfrog.com/help/r/jfrog-curation/curation-support-matrix

curation-audit command supported package managers and build systems:

• Npm (npm)

• Maven (mvn) - Requires xray 3.92 and above, and Artifactory 7.82 and above

• Pip (pip) - Requires xray 3.92 and above, and Artifactory 7.82 and above

---

Commands

Audit your Project with JFrog CLI curation-audit command

Setup:

Prerequisites:

Make sure your JFrog Artifactory admin configured the curated remote repository you are using during your build process. For more information refer your Artifactory admin to: https://jfrog.com/help/r/jfrog-curation/configure-curation-pass-through

1. Connect JFrog CLI to JFrog Platform

   Connect the JFrog CLI to your JFrog Platform instance by running the following command:

   jf c add

   • When prompted for the access token, use the token generated from Artifactory. For more details, refer to the adding and editing configured servers documentation.

   jf c show

   • It should present Artifactory server just added (with default true)

2. Configure JFrog CLI for Project Ensure your project is configured in the JFrog CLI with the repository you would like to resolve dependencies from. Here are details for each package manager:

   • NPM:

     • Set the resolved repository using the jf npmc command inside the project directory.

   • MAVEN:

     • Set the resolved repository using the jf mvnc command inside the project directory.

   • PIP:

     • Set the resolved repository using the jf pipc command inside the project directory (The only package installer supported for now by Python is "pip").

Commands Params

Command name	curation-audit
Abbreviation	ca
Command options
--format	[Default: table] Defines the output format of the command. Acceptable values are: table and json.
--working-dirs	[Optional] A comma separated list of relative working directories, to determine the audit targets locations.
--threads	[Default: 10] The number of parallel threads used to determine the curation status for each package in the project tree.
--requirements-file	[Optional] [Pip] Defines pip requirements file name. For example: 'requirements.txt'

Example 1

Curation-Audit the project in the current directory. Displays all known packages that were blocked by Curation Policies.

jf curation-audit

Example 2

Curation-Audit the projects according to the specific paths defined in the "working-dirs" option. Displays all known packages that were blocked by Curation Policies for all projects. The data is displayed in separate tables.

jf curation-audit --working-dirs="/path/to/project/npm_project1,/path/to/project/npm_project2"

Example 3

Curation-Audit the project in the current directory using 5 threads to check the packages Curation status in parallel. Displays all known packages blocked by Curation Policies.

jf curation-audit --threads=5