Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix version distance policy being evaluated despite not being configured #2980

Merged
merged 2 commits into from
Sep 14, 2023
Merged

Fix version distance policy being evaluated despite not being configured #2980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8df7541
Fix version distance policy being evaluated despite not being configured
nscuro Aug 23, 2023
e60d344
Ensure that policy evaluators short-circuit when no applicable condit…
nscuro Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/main/java/org/dependencytrack/policy/ComponentAgePolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.dependencytrack.model.RepositoryMetaComponent;
import org.dependencytrack.model.RepositoryType;
import org.dependencytrack.persistence.QueryManager;

import java.time.LocalDate;
import java.time.Period;
import java.time.ZoneId;
Expand Down Expand Up @@ -62,6 +63,11 @@ public List<PolicyConditionViolation> evaluate(final Policy policy, final Compon
return violations;
}

final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}

final RepositoryType repoType = RepositoryType.resolve(component.getPurl());
if (RepositoryType.UNSUPPORTED == repoType) {
return violations;
Expand Down
25 changes: 15 additions & 10 deletions src/main/java/org/dependencytrack/policy/CwePolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@
*/
package org.dependencytrack.policy;

import alpine.common.logging.Logger;
import org.apache.commons.collections4.CollectionUtils;
import org.dependencytrack.model.Component;
import org.dependencytrack.model.Policy;
import org.dependencytrack.model.PolicyCondition;
import org.dependencytrack.model.Vulnerability;
import org.dependencytrack.parser.common.resolver.CweResolver;
import alpine.common.logging.Logger;
import org.apache.commons.collections4.CollectionUtils;
import org.dependencytrack.model.Component;
import org.dependencytrack.model.Policy;
import org.dependencytrack.model.PolicyCondition;
import org.dependencytrack.model.Vulnerability;
import org.dependencytrack.parser.common.resolver.CweResolver;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
* Evaluates the Common Weakness Enumeration of component vulnerabilities against a policy.
Expand All @@ -51,7 +51,12 @@ public PolicyCondition.Subject supportedSubject() {
@Override
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final List<PolicyConditionViolation> violations = new ArrayList<>();

final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}

for (final Vulnerability vulnerability : qm.getAllVulnerabilities(component, false)) {
for (final PolicyCondition condition: policyConditions) {
LOGGER.debug("Evaluating component (" + component.getUuid() + ") against policy condition (" + condition.getUuid() + ")");
Expand Down
8 changes: 7 additions & 1 deletion src/main/java/org/dependencytrack/policy/LicenseGroupPolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,15 @@ public PolicyCondition.Subject supportedSubject() {
@Override
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final List<PolicyConditionViolation> violations = new ArrayList<>();

final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}

final SpdxExpression expression = getSpdxExpressionFromComponent(component);

for (final PolicyCondition condition : super.extractSupportedConditions(policy)) {
for (final PolicyCondition condition : policyConditions) {
LOGGER.debug("Evaluating component (" + component.getUuid() + ") against policy condition ("
+ condition.getUuid() + ")");
final LicenseGroup lg = qm.getObjectByUuid(LicenseGroup.class, condition.getValue());
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/dependencytrack/policy/LicensePolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ public PolicyCondition.Subject supportedSubject() {
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final List<PolicyConditionViolation> violations = new ArrayList<>();

final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}

// use spdx expression checking logic from the license group policy evaluator
final SpdxExpression expression = LicenseGroupPolicyEvaluator.getSpdxExpressionFromComponent(component);

Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/dependencytrack/policy/SeverityPolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ public PolicyCondition.Subject supportedSubject() {
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final List<PolicyConditionViolation> violations = new ArrayList<>();
final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}
//final Component component = qm.getObjectById(Component.class, c.getId());
for (final Vulnerability vulnerability : qm.getAllVulnerabilities(component, false)) {
for (final PolicyCondition condition: policyConditions) {
Expand Down
28 changes: 21 additions & 7 deletions src/main/java/org/dependencytrack/policy/VersionDistancePolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@
*/
package org.dependencytrack.policy;

import java.util.ArrayList;
import java.util.List;

import alpine.common.logging.Logger;
import org.apache.commons.lang3.StringUtils;
import org.dependencytrack.model.Component;
import org.dependencytrack.model.Policy;
Expand All @@ -32,7 +30,8 @@
import org.dependencytrack.util.VersionDistance;
import org.json.JSONObject;

import alpine.common.logging.Logger;
import java.util.ArrayList;
import java.util.List;

/**
* Evaluates the {@link VersionDistance} between a {@link Component}'s current and it's latest
Expand Down Expand Up @@ -64,7 +63,13 @@ public PolicyCondition.Subject supportedSubject() {
@Override
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final var violations = new ArrayList<PolicyConditionViolation>();
if (component.getPurl() == null) {

if (component.getPurl() == null || component.getVersion() == null) {
return violations;
}

final List<PolicyCondition> conditions = super.extractSupportedConditions(policy);
if (conditions.isEmpty()) {
return violations;
}

Expand All @@ -83,9 +88,18 @@ public List<PolicyConditionViolation> evaluate(final Policy policy, final Compon
return violations;
}

final var versionDistance = VersionDistance.getVersionDistance(component.getVersion(),metaComponent.getLatestVersion());
final VersionDistance versionDistance;
try {
versionDistance = VersionDistance.getVersionDistance(component.getVersion(), metaComponent.getLatestVersion());
} catch (RuntimeException e) {
LOGGER.warn("""
Failed to compute version distance for component %s (UUID: %s), \
between component version %s and latest version %s; Skipping\
""".formatted(component, component.getUuid(), component.getVersion(), metaComponent.getLatestVersion()), e);
return violations;
}

for (final PolicyCondition condition : super.extractSupportedConditions(policy)) {
for (final PolicyCondition condition : conditions) {
if (isDirectDependency(component) && evaluate(condition, versionDistance)) {
violations.add(new PolicyConditionViolation(condition, component));
}
Expand Down
9 changes: 7 additions & 2 deletions src/main/java/org/dependencytrack/policy/VersionPolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,15 @@ public PolicyCondition.Subject supportedSubject() {

@Override
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final var componentVersion = new ComponentVersion(component.getVersion());

final List<PolicyConditionViolation> violations = new ArrayList<>();

final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}

final var componentVersion = new ComponentVersion(component.getVersion());

for (final PolicyCondition condition : super.extractSupportedConditions(policy)) {
LOGGER.debug("Evaluating component (" + component.getUuid() + ") against policy condition (" + condition.getUuid() + ")");

Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/dependencytrack/policy/VulnerabilityIdPolicyEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ public PolicyCondition.Subject supportedSubject() {
public List<PolicyConditionViolation> evaluate(final Policy policy, final Component component) {
final List<PolicyConditionViolation> violations = new ArrayList<>();
final List<PolicyCondition> policyConditions = super.extractSupportedConditions(policy);
if (policyConditions.isEmpty()) {
return violations;
}
for (final Vulnerability vulnerability : qm.getAllVulnerabilities(component, false)) {
for (final PolicyCondition condition: policyConditions) {
LOGGER.debug("Evaluating component (" + component.getUuid() + ") against policy condition (" + condition.getUuid() + ")");
Expand Down