Improved detection for standalone jar files by using pom.properties file if available #724
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,8 @@ import { | |
| readFileSync, | ||
| rmSync, | ||
| unlinkSync, | ||
| writeFileSync, | ||
| readdirSync | ||
| } from "node:fs"; | ||
| import got from "got"; | ||
| import Arborist from "@npmcli/arborist"; | ||
|
|
@@ -6514,6 +6515,23 @@ export const parseJarManifest = function (jarMetadata) { | |
| return metadata; | ||
| }; | ||
|
|
||
| export const parsePomProperties = function (pomProperties) { | ||
| const properties = {}; | ||
| if (!pomProperties) { | ||
| return properties; | ||
| } | ||
| pomProperties.split("\n").forEach((l) => { | ||
| l = l.replace("\r", ""); | ||
| if (l.includes("=")) { | ||
| const tmpA = l.split("="); | ||
| if (tmpA && tmpA.length === 2) { | ||
| properties[tmpA[0]] = tmpA[1].replace("\r", ""); | ||
| } | ||
| } | ||
| }); | ||
| return properties; | ||
| }; | ||
|
|
||
| export const encodeForPurl = (s) => { | ||
| return s && !s.includes("%40") | ||
| ? encodeURIComponent(s).replace(/%3A/g, ":").replace(/%2F/g, "/") | ||
|
|
@@ -6601,13 +6619,14 @@ export const extractJarArchive = function ( | |
| } | ||
| const manifestDir = join(tempDir, "META-INF"); | ||
| const manifestFile = join(manifestDir, "MANIFEST.MF"); | ||
| const mavenDir = join(manifestDir, "maven"); | ||
| let jarResult = { | ||
| status: 1 | ||
| }; | ||
| if (existsSync(pomname)) { | ||
| jarResult = { status: 0 }; | ||
| } else { | ||
| jarResult = spawnSync("jar", ["-xf", jf, "META-INF"], { | ||
| encoding: "utf-8", | ||
| cwd: tempDir, | ||
| shell: isWin, | ||
|
|
@@ -6617,29 +6636,65 @@ export const extractJarArchive = function ( | |
| if (jarResult.status !== 0) { | ||
| console.error(jarResult.stdout, jarResult.stderr); | ||
| } else { | ||
| let group = "", | ||
| name = "", | ||
| version = "", | ||
| confidence = 1, | ||
| technique = "manifest-analysis"; | ||
| // When maven descriptor is available take group, name and version from pom.properties | ||
| // META-INF/maven/${groupId}/${artifactId}/pom.properties | ||
| // see https://maven.apache.org/shared/maven-archiver/index.html | ||
| if (existsSync(mavenDir)) { | ||
| let groupDir = readdirSync(mavenDir); | ||
| if (groupDir && groupDir.length) { | ||
| let artifactDir = readdirSync(join(mavenDir, groupDir[0])); | ||
|
There was a problem hiding this comment. @Nikemare, This line is failing while creating an SBOM for container images. Below change at 6649 helps There was a problem hiding this comment. @prabhu I can provide a fix in the evening (CET), or will you fix it on your own? There was a problem hiding this comment. The evening sounds good! Thank you so much! |
||
| if (artifactDir && artifactDir.length) { | ||
| let pomPropertiesFile = join( | ||
| mavenDir, | ||
| groupDir[0], | ||
| artifactDir[0], | ||
| "pom.properties" | ||
| ); | ||
| if (existsSync(pomPropertiesFile)) { | ||
| const pomProperties = parsePomProperties( | ||
| readFileSync(pomPropertiesFile, { | ||
| encoding: "utf-8" | ||
| }) | ||
| ); | ||
| group = pomProperties["groupId"]; | ||
| name = pomProperties["artifactId"]; | ||
| version = pomProperties["version"]; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| if ((!group || !name || !version) && existsSync(manifestFile)) { | ||
| confidence = 0.8; | ||
| const jarMetadata = parseJarManifest( | ||
| readFileSync(manifestFile, { | ||
| encoding: "utf-8" | ||
| }) | ||
| ); | ||
| group = | ||
| group || | ||
| jarMetadata["Extension-Name"] || | ||
| jarMetadata["Implementation-Vendor-Id"] || | ||
| jarMetadata["Bundle-SymbolicName"] || | ||
| jarMetadata["Bundle-Vendor"] || | ||
| jarMetadata["Automatic-Module-Name"] || | ||
| ""; | ||
| version = | ||
| version || | ||
| jarMetadata["Bundle-Version"] || | ||
| jarMetadata["Implementation-Version"] || | ||
| jarMetadata["Specification-Version"]; | ||
| if (version && version.includes(" ")) { | ||
| version = version.split(" ")[0]; | ||
| } | ||
| // Prefer jar filename to construct name and version | ||
| if (!name || !version || name === "" || version === "") { | ||
| confidence = 0.5; | ||
| technique = "filename"; | ||
| const tmpA = jarname.split("-"); | ||
| if (tmpA && tmpA.length > 1) { | ||
| const lastPart = tmpA[tmpA.length - 1]; | ||
|
|
@@ -6688,56 +6743,56 @@ export const extractJarArchive = function ( | |
| break; | ||
| } | ||
| } | ||
| // if group is empty use name as group | ||
| group = group === "." ? name : group || name; | ||
| } | ||
| if (name && version) { | ||
| let apkg = { | ||
| group: group ? encodeForPurl(group) : "", | ||
| name: name ? encodeForPurl(name) : "", | ||
| version, | ||
| purl: new PackageURL( | ||
| "maven", | ||
| group, | ||
| name, | ||
| version, | ||
| { type: "jar" }, | ||
| null | ||
| ).toString(), | ||
| evidence: { | ||
| identity: { | ||
| field: "purl", | ||
| confidence: confidence, | ||
| methods: [ | ||
| { | ||
| technique: technique, | ||
| confidence: confidence, | ||
| value: jarname | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| properties: [ | ||
| { | ||
| name: "SrcFile", | ||
| value: jarname | ||
| } | ||
| ] | ||
| }; | ||
| if ( | ||
| jarNSMapping && | ||
| jarNSMapping[apkg.purl] && | ||
| jarNSMapping[apkg.purl].namespaces | ||
| ) { | ||
| apkg.properties.push({ | ||
| name: "Namespaces", | ||
| value: jarNSMapping[apkg.purl].namespaces.join("\n") | ||
| }); | ||
| } | ||
| pkgList.push(apkg); | ||
| } else { | ||
| if (DEBUG_MODE) { | ||
| console.log(`Ignored jar ${jarname}`, name, version); | ||
| } | ||
| } | ||
| try { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well spotted!