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.

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

Filter out the reactorprojects in the dependencies for the MSHARED-998 workaround attempting to resolve a dependency with a classifier #3736

Merged
merged 11 commits into from
Oct 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of dependency-check-maven.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright (c) 2017 Jeremy Long. All Rights Reserved.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.owasp.test</groupId>
<artifactId>3730-classifier-in-dependency-aggregate</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>3730-classifier-in-dependency-aggregate-childOne</artifactId>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>com.google.inject</groupId>
<artifactId>guice</artifactId>
<classifier>no_aop</classifier>
</dependency>
<dependency>
<groupId>org.owasp.test</groupId>
<artifactId>3730-classifier-in-dependency-aggregate-childTwo</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of dependency-check-maven.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright (c) 2017 Jeremy Long. All Rights Reserved.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.owasp.test</groupId>
<artifactId>3730-classifier-in-dependency-aggregate</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>3730-classifier-in-dependency-aggregate-childTwo</artifactId>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>com.google.inject</groupId>
<artifactId>guice</artifactId>
<classifier>classes</classifier>
</dependency>
</dependencies>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#
# This file is part of dependency-check-maven.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Copyright (c) 2014 Jeremy Long. All Rights Reserved.
#

invoker.goals = --no-transfer-progress --batch-mode -Danalyzer.ossindex.enabled=false -Danalyzer.central.enabled=false ${project.groupId}:${project.artifactId}:${project.version}:aggregate -Dformat=XML -Dcve.startyear=2018
47 changes: 47 additions & 0 deletions maven/src/it/3730-classifier-in-dependency-aggregate/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of dependency-check-maven.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright (c) 2017 Jeremy Long. All Rights Reserved.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.owasp.test</groupId>
<artifactId>3730-classifier-in-dependency-aggregate</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>childOne</module>
<module>childTwo</module>
</modules>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.inject</groupId>
<artifactId>guice</artifactId>
<version>4.2.2</version>
<classifier>no_aop</classifier>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.google.inject</groupId>
<artifactId>guice</artifactId>
<version>4.2.2</version>
<classifier>classes</classifier>
<scope>provided</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* This file is part of dependency-check-maven.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright (c) 2014 Jeremy Long. All Rights Reserved.
*/

import org.apache.commons.io.FileUtils;
import org.w3c.dom.NodeList;

import java.nio.charset.Charset;
import javax.xml.xpath.*
import javax.xml.parsers.DocumentBuilderFactory

// Check to see if jackson-databind-2.5.3.jar was identified with a known CVE - using CVE-2018-7489.

def countMatches(String xml, String xpathQuery) {
def xpath = XPathFactory.newInstance().newXPath()
def builder = DocumentBuilderFactory.newInstance().newDocumentBuilder()
def inputStream = new ByteArrayInputStream( xml.bytes )
def records = builder.parse(inputStream).documentElement
NodeList nodes = xpath.evaluate( xpathQuery, records, XPathConstants.NODESET ) as NodeList
nodes.getLength();
}

String log = FileUtils.readFileToString(new File(basedir, "target/dependency-check-report.xml"), Charset.defaultCharset().name());
int count = countMatches(log,"/analysis/dependencies/dependency[./fileName = 'guice-4.2.2-no_aop.jar']");
if (count != 1){
System.out.println(String.format("google guice no_aop was identified %s times, expected 1", count));
return false;
}
return true;
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,9 @@ protected ExceptionCollection scanDependencies(final Engine engine) throws MojoE
if (ex != null) {
if (exCol == null) {
exCol = ex;
} else {
exCol.getExceptions().addAll(ex.getExceptions());
}
exCol.getExceptions().addAll(ex.getExceptions());
if (ex.isFatal()) {
exCol.setFatal(true);
final String msg = String.format("Fatal exception(s) analyzing %s", childProject.getName());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,7 @@ private ExceptionCollection collectMavenDependencies(Engine engine, MavenProject
}
} else {
final Artifact dependencyArtifact = dependencyNode.getArtifact();
final Artifact result;
Artifact result;
if (dependencyArtifact.isResolved()) {
//All transitive dependencies, excluding reactor and dependencyManagement artifacts should
//have been resolved by Maven prior to invoking the plugin - resolving the dependencies
Expand All @@ -1336,14 +1336,23 @@ private ExceptionCollection collectMavenDependencies(Engine engine, MavenProject
final List<org.apache.maven.model.Dependency> dependencies = project.getDependencies();
final List<org.apache.maven.model.Dependency> managedDependencies
= project.getDependencyManagement() == null ? null : project.getDependencyManagement().getDependencies();
final ArtifactCoordinate theCoord = TransferUtils.toArtifactCoordinate(dependencyNode.getArtifact());
if (theCoord.getClassifier() != null) {
if (coordinate.getClassifier() != null) {
// This would trigger NPE when using the filter - MSHARED-998
getLog().debug("Expensive lookup as workaround for MSHARED-998 for " + theCoord);
final Iterable<ArtifactResult> allDeps
= dependencyResolver.resolveDependencies(buildingRequest, dependencies, managedDependencies,
null);
result = findClassifierArtifactInAllDeps(allDeps, theCoord);
getLog().debug("Expensive lookup as workaround for MSHARED-998 for " + coordinate);
try {
final Iterable<ArtifactResult> allDeps
= dependencyResolver.resolveDependencies(buildingRequest, dependencies, managedDependencies,
null);
result = findClassifierArtifactInAllDeps(allDeps, coordinate, project);
} catch (DependencyResolverException dre) {
result = Mshared998Util.findArtifactInAetherDREResult(dre, coordinate);
if (result == null) {
throw new DependencyNotFoundException(
String.format("Failed to resolve dependency %s with dependencyResolver for "
+ "project-artifact %s", coordinate, project.getArtifactId()),
dre);
}
}
} else {
final TransformableFilter filter = new PatternInclusionsFilter(
Collections.singletonList(
Expand All @@ -1357,7 +1366,7 @@ private ExceptionCollection collectMavenDependencies(Engine engine, MavenProject
result = first.getArtifact();
} else {
throw new DependencyNotFoundException(String.format("Failed to resolve dependency %s with "
+ "dependencyResolver", coordinate));
+ "dependencyResolver for project-artifact %s", coordinate, project.getArtifactId()));
}
}
} catch (DependencyNotFoundException | DependencyResolverException ex) {
Expand Down Expand Up @@ -1467,11 +1476,13 @@ && addSnapshotReactorDependency(engine, dependencyNode.getArtifact())) {
* dependencies
* @param theCoord The ArtifactCoordinate of the artifact-with-classifier we
* intended to resolve
* @param project The project in whose context resolution was attempted
* @return the resolved artifact matching with {@code theCoord}
* @throws DependencyNotFoundException Not expected to be thrown, but will
* be thrown if {@code theCoord} could not be found within {@code allDeps}
*/
private Artifact findClassifierArtifactInAllDeps(final Iterable<ArtifactResult> allDeps, final ArtifactCoordinate theCoord)
private Artifact findClassifierArtifactInAllDeps(final Iterable<ArtifactResult> allDeps, final ArtifactCoordinate theCoord,
final MavenProject project)
throws DependencyNotFoundException {
Artifact result = null;
for (final ArtifactResult res : allDeps) {
Expand All @@ -1482,7 +1493,7 @@ private Artifact findClassifierArtifactInAllDeps(final Iterable<ArtifactResult>
}
if (result == null) {
throw new DependencyNotFoundException(String.format("Expected dependency not found in resolved artifacts for "
+ "dependency %s", theCoord));
+ "dependency %s of project-artifact %s", theCoord, project.getArtifactId()));
}
return result;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/*
* This file is part of dependency-check-maven.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright (c) 2021 Jeremy Long. All Rights Reserved.
*/
package org.owasp.dependencycheck.maven;

import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.shared.transfer.artifact.ArtifactCoordinate;
import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException;
import org.eclipse.aether.resolution.ArtifactResult;
import org.eclipse.aether.resolution.DependencyResolutionException;
import org.eclipse.aether.resolution.DependencyResult;

import java.util.Objects;

public final class Mshared998Util {
/**
* Empty constructor to prevent instantiation of utility-class.
*/
private Mshared998Util() {
}

/**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reporter: Checkstyle
Rule: com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Severity: ERROR
File: maven/src/main/java/org/owasp/dependencycheck/maven/Mshared998Util.java L37

First sentence should end with a period.

* Find the artifact for the given coordinate among the available succesfull resolution attempts contained within the
* DependencyResolverException
* @param dre The DependencyResolverException that might have embedded successful resolution results
* @param coordinate The coordinates of the artifact we're interested in
* @return The resolved artifact matching {@code coordinate} or {@code null} if not found
*/
public static Artifact findArtifactInAetherDREResult(final DependencyResolverException dre,
final ArtifactCoordinate coordinate) {
Artifact result = null;
if (dre.getCause() instanceof DependencyResolutionException) {
final DependencyResolutionException adre = (DependencyResolutionException) dre.getCause();
final DependencyResult dependencyResult = adre.getResult();
if (dependencyResult != null) {
for (ArtifactResult artifactResult : dependencyResult.getArtifactResults()) {
if (matchesCoordinate(artifactResult, coordinate)) {
result = RepositoryUtils.toArtifact(artifactResult.getArtifact());
break;
}
}
}
}
return result;
}

/**
* Checks whether the given ArtifactResult contains an artifact that matches the coordinate
* @param artifactResult The ArtifactResult to inspect
* @param coordinate The coordinate to match with
* @return {@code true} when the artifactresult contains an artifact that matches the coordinate on GAV_C_E,
* false otherwise.
*/ private static boolean matchesCoordinate(final ArtifactResult artifactResult, final ArtifactCoordinate coordinate) {
if (artifactResult.getArtifact() == null) {
return false;
} else {
final org.eclipse.aether.artifact.Artifact artifact = artifactResult.getArtifact();
boolean result = Objects.equals(artifact.getGroupId(), coordinate.getGroupId());
result &= Objects.equals(artifact.getArtifactId(), coordinate.getArtifactId());
result &= Objects.equals(artifact.getVersion(), coordinate.getVersion());
result &= Objects.equals(artifact.getClassifier(), coordinate.getClassifier());
result &= Objects.equals(artifact.getExtension(), coordinate.getExtension());
return result;
}
}
}