This feature is available with Artifactory version 7.10.5 and above.
This feature requires you to have the Manage Watches role. For more information, see Users and Groups.
Some of the feature enhancements introduced in Xray version 3.13.0 require Artifactory version 7.12.0 and above. For more information, see Xray Release Notes 3.13.0.
In some cases, when violations are detected, as security or legal personnel, you would like to accept or whitelist some of these violations. This could be for different reasons, such as:
Although the security vulnerability is real, you have ways to protect against it (such as a WAF configuration).
The conditions needed for this vulnerability to happen are not met in the specific case.
As an organization, you are aware of the violation, but you would still like to release the product.
The violation is not a showstopper, and you would like to deal with it in future versions.
The violation is a false positive.
The violation is valid, but you need more time to deal with it. Time based ignore enables you to silence the violation for a period of time. Once that period expires, the Ignore Rule will be deleted automatically, and if the violation occurs again it will not be ignored moving forward.
In such cases, the ignore violations feature, enables you to have granular control on the violations that should be ignored. Xray allows you to define the scope of the ignore rule on the vulnerability, component, artifact, watch level, and more. Thus, giving you the flexibility and control needed to apply the ignore rule.
The following procedures are supported when Ignoring violations:
Ignoring a Violation
Follow these steps to create an Ignore Rule for a violation. When creating an ignore rule, the ignore rule is applied to the specific violation and all future violations that meet the ignore rule criteria.
Select the required Watch and click the Violations tab.
You can also view violations for an Artifact, Build, or Release Bundle by selecting the Violations tab in a Package, or in the specific Artifact, Build, or Release Bundle. You can filter to see only ignored violations.
From the Violations list, hover over the required violation in the list and click Ignore Violation, located on the rightmost side of the line.
The Create Vulnerability Ignore Rule dialog box appears.
Choose a combination of the ignore criteria depending on your needs.
Based on the Vulnerability
Vulnerability ID selected
The rule will be applied to the specific security vulnerability only.
For any Vulnerability
The rule will be applied to all security vulnerabilities.
Based on the Component
Component name selected current version
The rule will be applied to the specific component for that specific version of the component only.
Component name selected any version
The rule will be applied to the specific component for all versions of that component.
For any component
The rule will be applied to all components that contain that violation.
Based on the Artifact
Note: Take note, if it's in a Build or Release Bundle, it will appear here as based on Build or Release Bundle.
Artifact name selected current version
The rule will be applied to the specific artifact for that specific version of the artifact only.
Artifact name selected any version
The rule will be applied to the specific artifact for all versions of that artifact.
For any Artifact
The rule will be applied to all artifacts that contain that violation.
Based on the Watch
The rule will be applied to the specific watch where the violation was found.
For any Watch
The rule will be applied to all watches.
The ignore rule will expire at
The rule will expire on the date you set here. This gives you the ability to keep the ignore rule for a violation for the period of time you set.
When the time expires, the ignore rule will be removed. Once a scan is triggered after the expiration date, violations will be created again.
When selecting the ignore criteria, take note of the combinations you choose. Some combinations such as selecting everything as Any is not allowed as it will ignore all future violations (in the watch or in the system).
The Ignore Rules REST API allows you to choose more scopes for the Ignore Rule as well as more options in each scope.
Ignoring Violations Examples
We provided you with some scenarios where an ignore violation is needed, and how to use the different options to achieve them.