Using the latest JFrog products?
JFrog Platform User Guide
JFrog Xray 2.x Documentation
To get the latest version, go to the JFrog Unified Platform
Creating and Editing a Policy
To create a new policy, click New Policy and complete the fields.
|A logical name for this Policy.|
The policy rule types to create.
Security: Lets you create a set of rules around security vulnerabilities. Choose how you want Xray to respond to each vulnerability severity.
License: Lets you create a set of rules around allowed/banned sets of licenses.
|A general description of the Policy.|
|The rules search filter.|
|The Rules priority. Drag and drop the rules to place them according to their priority.|
|The Rule(s) attached to this Policy.|
|The Rule criteria. If the criteria is met, then the automatic actions of this rule are executed and the policy is considered as processed (no further rules will be checked).|
|The actions to take if a criteria is met.|
Editing a Policy
Edit an existing Policy, from the Policy table, by hovering over it and clicking on the Edit icon on the right.
Edits made to a policy will automatically be applied to all watches the policy is assigned to. This will take affect only for newly scanned artifacts. You can manually apply the watch on existing artifacts.
A Security Rule allows you to create a set of rules around security vulnerabilities. There are two possible criteria:
- Minimal Severity (Minor, Major, Critical, All): The minimal security vulnerability severity as it is in the JFrog vulnerabilities database. If the artifact or build contains a vulnerability with the selected severity or higher, the rule will meet the criteria, the automatic actions will be executed, and the policy will stop processing.
- CVSS Score (1-10): The CVSS score range to apply to the rule. This is used for a fine-grained control, rather than using the predefined severities.
To create a new Security Rule, select "Security" from the Type drop down and click New Rule.
|A logical name for this Rule.|
The set of security conditions to examine when an scanned artifact is scanned.
Specifies the actions to take once a security policy violation has been triggered.
A licence Rule allows you to create a set of rules around license compliance. There are three possible criteria:
- Allowed Licenses: Specifies a whitelist of OSS licenses that may be attached to a component. If a component has an OSS license outside the specified whitelist, The rule will meet the criteria, a violation will be generated, automatic actions will be executed, and the policy will stop processing.
- Banned Licenses: Specifies a blacklist of OSS licenses that may not be attached to a component. If a component has any of the OSS licenses specified, The rule will meet the criteria, a violation will be generated, automatic actions will be executed, and the policy will stop processing.
- Disallow Unknown License: Specifies the wanted behavior for components whose license cannot be determined. A violation will be triggered if a component with unknown license is found.
To create a new License Rule, select "License" from the Type drop down and click New Rule.
|A logical name for this Rule.|
The set of license conditions to examine when an scanned artifact is scanned.
|Specifies the actions to take once a license policy violation has been triggered.|
An action determines the automatic response to a detected Policy violation. You can define one or more action within each Policy Rule. Actions include the following:
- Generate Violation (Minor, Major, Critical): The severity of the violations that is generated if the criteria is met.
- Notify Email: This action lets you specify email addresses to which Xray should send an email message about a violation when one is triggered. For this to work, you need to have a mail server configured in Xray.
- Notify Watch's Recipients: This action lets you send an email to all the watch recipients about a violation when triggered.
- Notify Deployer: This action lets you send an email to the user that deployed the component about a violation when triggered.
- Trigger Webhook: This action lets you specify webhooks you have configured in Xray that should be invoked when a violation is triggered (See payload below).
Block Download: This action lets you specify that artifacts should be blocked for download from Artifactory.
When set, Artifactory will block download of artifacts that meet the Artifact Filter and Severity Filter specifications for this watch.
When set, Artifactory will block download of artifacts that meet the Artifact Filter specifications for this watch, but have not been scanned yet
Fail Build: This action lets you specify that if a CI server requests a build to be scanned, and the Watch triggers a violation, Xray will respond with an indication that the build job should fail.
This action is only available if the Watch is defined with Builds as target type.
No Fail Build Job Actions defined?
If a request to scan a build is received by Xray, but there are no Watches with a Fail Build action defined, Xray will always respond with an indication that the build job should indeed fail, whether build artifacts or dependencies are found to have vulnerabilities or not.
The payload provided to any triggered webhook is a JSON object describing a list of Alerts with the following format:
The following shows an example payload for a webhook