Allow custom report templates via CLI

jeremylong · Sep 1, 2022 · f48cac4 · f48cac4
1 parent d3ebaaa
commit f48cac4
Showing 1 changed file with 38 additions and 10 deletions.
diff --git a/cli/src/main/java/org/owasp/dependencycheck/CliParser.java b/cli/src/main/java/org/owasp/dependencycheck/CliParser.java
@@ -136,7 +136,6 @@ private void validateArgs() throws FileNotFoundException, ParseException {
                     throw new ParseException("Invalid Setting: cveStartYear must be a number greater than or equal to 2002.");
                 }
             }
-
         }
         if (isRunScan()) {
             validatePathExists(getScanFiles(), ARGUMENT.SCAN);
@@ -146,16 +145,13 @@ private void validateArgs() throws FileNotFoundException, ParseException {
                 validatePathExists(pathToCore, ARGUMENT.PATH_TO_CORE);
             }
             if (line.hasOption(ARGUMENT.OUTPUT_FORMAT)) {
-                String validating = null;
-                try {
-                    for (String format : getReportFormat()) {
-                        validating = format;
-                        Format.valueOf(format);
+                for (String validating : getReportFormat()) {
+                    if (!isValidFormat(validating)
+                        && !isValidFilePath(validating, "format")) {
+                        final String msg = String.format("An invalid 'format' of '%s' was specified. "
+                                                         + "Supported output formats are %s, and custom template files.", validating, SUPPORTED_FORMATS);
+                        throw new ParseException(msg);
                     }
-                } catch (IllegalArgumentException ex) {
-                    final String msg = String.format("An invalid 'format' of '%s' was specified. "
-                            + "Supported output formats are " + SUPPORTED_FORMATS, validating);
-                    throw new ParseException(msg);
                 }
             }
             final String base = getStringArgument(ARGUMENT.CVE_BASE_URL);
@@ -177,6 +173,38 @@ private void validateArgs() throws FileNotFoundException, ParseException {
         }
     }
 
+    /**
+     * Validates the format to be one of the known Formats.
+     *
+     * @param format the format to validate
+     * @return true, if format is known in Format; false otherwise
+     * @see Format
+     */
+    private boolean isValidFormat(String format) {
+        try {
+            Format.valueOf(format);
+            return true;
+        } catch (IllegalArgumentException ex) {
+            return false;
+        }
+    }
+
+    /**
+     * Validates the path to point at an existing file.
+     *
+     * @param path the path to validate if it exists
+     * @param argumentName the argument being validated (e.g. scan, out, etc.)
+     * @return true, if path exists; false otherwise
+     */
+    private boolean isValidFilePath(String path, String argumentName) {
+        try {
+            validatePathExists(path, argumentName);
+            return true;
+        } catch (FileNotFoundException ex) {
+            return false;
+        }
+    }
+
     /**
      * Validates whether or not the path(s) points at a file that exists; if the
      * path(s) does not point to an existing file a FileNotFoundException is