fix: use central parsing in extractimagedetails

Author: d3vco

lib/analyzer/image-inspector.ts

@@ -5,6 +5,7 @@ import * as path from "path";
 
 import { Docker, DockerOptions } from "../docker";
 import { ImageName } from "../extractor/image";
+import { parseImageReference } from "../image-reference";
 
 import type { DockerPullResult } from "@snyk/snyk-docker-pull";
 import type {
@@ -265,99 +266,15 @@ async function getImageArchive(
   }
 }
 
-function isImagePartOfURL(targetImage): boolean {
-  // Based on the Docker spec, if the image contains a hostname, then the hostname should contain
-  // a `.` or `:` before the first instance of a `/`. ref: https://stackoverflow.com/a/37867949
-  if (!targetImage.includes("/")) {
-    return false;
-  }
-
-  const partBeforeFirstForwardSlash = targetImage.split("/")[0];
-
-  return (
-    partBeforeFirstForwardSlash.includes(".") ||
-    partBeforeFirstForwardSlash.includes(":") ||
-    partBeforeFirstForwardSlash === "localhost"
-  );
-}
-
-function extractHostnameFromTargetImage(targetImage: string): {
-  hostname: string;
-  remainder: string;
-} {
-  // We need to detect if the `targetImage` is part of a URL. If not, the default hostname will be
-  // used (registry-1.docker.io). ref: https://stackoverflow.com/a/37867949
-  const defaultHostname = "registry-1.docker.io";
-
-  if (!isImagePartOfURL(targetImage)) {
-    return { hostname: defaultHostname, remainder: targetImage };
-  }
-
-  const dockerFriendlyRegistryHostname = "docker.io/";
-  if (targetImage.startsWith(dockerFriendlyRegistryHostname)) {
-    return {
-      hostname: defaultHostname,
-      remainder: targetImage.substring(dockerFriendlyRegistryHostname.length),
-    };
-  }
-
-  const i = targetImage.indexOf("/");
-  return {
-    hostname: targetImage.substring(0, i),
-    remainder: targetImage.substring(i + 1),
-  };
-}
-
-function extractImageNameAndTag(
-  remainder: string,
-  targetImage: string,
-): { imageName: string; tag: string } {
-  const defaultTag = "latest";
-
-  if (!remainder.includes("@")) {
-    const [imageName, tag] = remainder.split(":");
-
-    return {
-      imageName: appendDefaultRepoPrefixIfRequired(imageName, targetImage),
-      tag: tag || defaultTag,
-    };
-  }
-
-  const [imageName, tag] = remainder.split("@");
-
-  return {
-    imageName: appendDefaultRepoPrefixIfRequired(
-      dropTagIfSHAIsPresent(imageName),
-      targetImage,
-    ),
-    tag: tag || defaultTag,
-  };
-}
-
-function appendDefaultRepoPrefixIfRequired(
-  imageName: string,
-  targetImage: string,
-): string {
-  const defaultRepoPrefix = "library/";
-
-  if (isImagePartOfURL(targetImage) || imageName.includes("/")) {
-    return imageName;
-  }
-
-  return defaultRepoPrefix + imageName;
-}
-
-function dropTagIfSHAIsPresent(imageName: string): string {
-  if (!imageName.includes(":")) {
-    return imageName;
-  }
-
-  return imageName.split(":")[0];
-}
-
 function extractImageDetails(targetImage: string): ImageDetails {
-  const { hostname, remainder } = extractHostnameFromTargetImage(targetImage);
-  const { imageName, tag } = extractImageNameAndTag(remainder, targetImage);
+  const parsed = parseImageReference(targetImage);
+  const hostname = parsed.registryForPull;
+  const isDockerHub = hostname === "registry-1.docker.io";
+  const imageName =
+    isDockerHub && !parsed.repository.includes("/")
+      ? "library/" + parsed.repository
+      : parsed.repository;
+  const tag = parsed.tailReferenceForPull;
   return { hostname, imageName, tag };
 }
 

lib/image-reference.ts

@@ -59,7 +59,10 @@ export class ParsedImageReference {
    * If the registry is not set, use Docker Hub.
    */
   get registryForPull(): string {
-    return this.registry ?? "registry-1.docker.io";
+    if (this.registry === "docker.io" || this.registry === undefined) {
+      return "registry-1.docker.io";
+    }
+    return this.registry;
   }
 
   /**

lib/scan.ts

@@ -12,7 +12,7 @@ import { getArchivePath, getImageType } from "./image-type";
 import { isNumber, isTrue } from "./option-utils";
 import * as staticModule from "./static";
 import { ImageType, PluginOptions, PluginResponse } from "./types";
-import { isValidDockerImageReference } from "./utils";
+import { isValidImageReference } from "./image-reference";
 
 // Registry credentials may also be provided by env vars. When both are set, flags take precedence.
 export function mergeEnvVarsIntoCredentials(
@@ -178,7 +178,7 @@ async function imageIdentifierAnalysis(
   // Validate Docker image reference format to catch malformed references early. We implement initial validation here
   // in lieu of simply sending to the docker daemon since some invalid references can result in unknown or invalid API
   // paths to the Docker daemon, sometimes producing confusing error results (like redirects) instead of the not found response.
-  if (!isValidDockerImageReference(targetImage)) {
+  if (!isValidImageReference(targetImage)) {
     throw new Error(`invalid image reference format: ${targetImage}`);
   }