Skip to content
Closed
4 changes: 2 additions & 2 deletions cli-v2.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ func main() {
}
}

// Check if command is init/update/version/help - these don't require configuration
// Check if command is init/update/version/help/container-scan - these don't require configuration
if len(os.Args) > 1 {
cmdName := os.Args[1]
if cmdName == "init" || cmdName == "update" || cmdName == "version" || cmdName == "help" {
if cmdName == "init" || cmdName == "update" || cmdName == "version" || cmdName == "help" || cmdName == "container-scan" {
cmd.Execute()
return
}
Expand Down
276 changes: 276 additions & 0 deletions cmd/container_scan.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
// Package cmd implements the CLI commands for the Codacy CLI tool.
package cmd

import (
"fmt"
"os"
"os/exec"
"regexp"
"strings"

"codacy/cli-v2/utils/logger"

"github.com/fatih/color"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
)

// validImageNamePattern validates Docker image references
// Allows: registry/namespace/image:tag or image@sha256:digest
// Based on Docker image reference specification
var validImageNamePattern = regexp.MustCompile(`^[a-zA-Z0-9][a-zA-Z0-9._\-/:@]*$`)
Comment on lines +24 to +25
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The regex pattern allows characters that may not be valid in Docker image references. Specifically, the underscore character is not typically allowed in Docker image repository names (though it's allowed in tags). The pattern ^[a-zA-Z0-9][a-zA-Z0-9._\-/:@]*$ would allow "my_invalid_repo:tag" which Docker would reject.

According to the Docker image specification, repository names should follow stricter rules. While the subsequent dangerous character checks provide some protection, having an inaccurate regex could cause confusing error messages where validation passes but Docker rejects the image name.

Suggested change
// Based on Docker image reference specification
var validImageNamePattern = regexp.MustCompile(`^[a-zA-Z0-9][a-zA-Z0-9._\-/:@]*$`)
// Based on Docker image reference specification (repository names are strict, tags more permissive)
var validImageNamePattern = regexp.MustCompile(`^(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))*)(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]|__|[-]*)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]|__|[-]*)[a-z0-9]+)*)*(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9]*:[0-9a-fA-F]{32,})?$`)

Copilot uses AI. Check for mistakes.

// lookPath is a variable to allow mocking exec.LookPath in tests
var lookPath = exec.LookPath

// exitFunc is a variable to allow mocking os.Exit in tests
var exitFunc = os.Exit

// CommandRunner interface for running external commands (allows mocking in tests)
type CommandRunner interface {
Run(name string, args []string) error
}

// ExecCommandRunner runs commands using exec.Command
type ExecCommandRunner struct{}

// Run executes a command and returns its exit error
func (r *ExecCommandRunner) Run(name string, args []string) error {
// #nosec G204 -- name comes from exec.LookPath("trivy") with a literal string,
// and args are validated by validateImageName() which checks for shell metacharacters.
// exec.Command passes arguments directly without shell interpretation.
Comment thread
franciscoovazevedo marked this conversation as resolved.
Outdated
cmd := exec.Command(name, args...)

Check failure on line 42 in cmd/container_scan.go

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

cmd/container_scan.go#L42

Detected non-static command inside Command.

Check failure on line 42 in cmd/container_scan.go

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

cmd/container_scan.go#L42

OS command injection is a critical vulnerability that can lead to a full system compromise as it may allow an adversary to pass in arbitrary commands or arguments to be executed.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
return cmd.Run()
}

// commandRunner is the default command runner, can be replaced in tests
var commandRunner CommandRunner = &ExecCommandRunner{}
Comment on lines +30 to +61
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The CommandRunner interface and ExecCommandRunner implementation are unnecessary abstractions. The existing codebase doesn't use this pattern - tools like eslintRunner.go (line 18), trivyRunner.go (line 12), and other runners directly use exec.Command without abstraction layers.

This adds complexity without clear benefit and deviates from established patterns in the codebase. Consider using exec.Command directly like other runners, which would simplify the code and make it more maintainable.

Copilot uses AI. Check for mistakes.

// ExitCoder interface for errors that have an exit code
type ExitCoder interface {
ExitCode() int
}

// getExitCode returns the exit code from an error if it implements ExitCoder
func getExitCode(err error) int {
if exitErr, ok := err.(ExitCoder); ok {
return exitErr.ExitCode()
}
return -1
}
Comment thread
franciscoovazevedo marked this conversation as resolved.

// Flag variables for container-scan command
var (
severityFlag string
pkgTypesFlag string
ignoreUnfixedFlag bool
)

func init() {
containerScanCmd.Flags().StringVar(&severityFlag, "severity", "", "Comma-separated list of severities to scan for (default: HIGH,CRITICAL)")
containerScanCmd.Flags().StringVar(&pkgTypesFlag, "pkg-types", "", "Comma-separated list of package types to scan (default: os)")
containerScanCmd.Flags().BoolVar(&ignoreUnfixedFlag, "ignore-unfixed", true, "Ignore unfixed vulnerabilities")
rootCmd.AddCommand(containerScanCmd)
}
Comment thread
franciscoovazevedo marked this conversation as resolved.

var containerScanCmd = &cobra.Command{
Use: "container-scan <IMAGE_NAME> [IMAGE_NAME...]",
Short: "Scan container images for vulnerabilities using Trivy",
Long: `Scan one or more container images for vulnerabilities using Trivy.

By default, scans for HIGH and CRITICAL vulnerabilities in OS packages,
ignoring unfixed issues. Use flags to override these defaults.

The --exit-code 1 flag is always applied (not user-configurable) to ensure
the command fails when vulnerabilities are found in any image.`,
Example: ` # Scan a single image
codacy-cli container-scan myapp:latest

# Scan multiple images
codacy-cli container-scan myapp:latest nginx:alpine redis:7

# Scan only for CRITICAL vulnerabilities across multiple images
codacy-cli container-scan --severity CRITICAL myapp:latest nginx:alpine

# Scan all severities and package types
codacy-cli container-scan --severity LOW,MEDIUM,HIGH,CRITICAL --pkg-types os,library myapp:latest

# Include unfixed vulnerabilities
codacy-cli container-scan --ignore-unfixed=false myapp:latest`,
Args: cobra.MinimumNArgs(1),
Run: runContainerScan,
}

// validateImageName checks if the image name is a valid Docker image reference
// and doesn't contain shell metacharacters that could be used for command injection
func validateImageName(imageName string) error {
if imageName == "" {
return fmt.Errorf("image name cannot be empty")
}

// Check for maximum length (Docker has a practical limit)
if len(imageName) > 256 {
return fmt.Errorf("image name is too long (max 256 characters)")
}

// Check for dangerous shell metacharacters first for specific error messages
dangerousChars := []string{";", "&", "|", "$", "`", "(", ")", "{", "}", "<", ">", "!", "\\", "\n", "\r", "'", "\""}
for _, char := range dangerousChars {
if strings.Contains(imageName, char) {
return fmt.Errorf("invalid image name: contains disallowed character '%s'", char)
}
}

// Validate against allowed pattern for any other invalid characters
if !validImageNamePattern.MatchString(imageName) {
return fmt.Errorf("invalid image name format: contains disallowed characters")
}
Comment on lines +136 to +138
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The validation logic at line 127 is unreachable. After checking for dangerous characters in the loop (lines 119-124), if the imageName contains any of them, the function returns an error. Therefore, the validImageNamePattern check on line 127 will never execute for strings containing those characters.

This means the regex check only catches characters that aren't in the dangerousChars list. Consider either removing the redundant check or restructuring to validate with the regex first, then provide more specific error messages for dangerous characters.

Copilot uses AI. Check for mistakes.

return nil
}
Comment thread
franciscoovazevedo marked this conversation as resolved.

// getTrivyPath returns the path to the Trivy binary and an error if not found
func getTrivyPath() (string, error) {
trivyPath, err := lookPath("trivy")
if err != nil {
return "", err
}
logger.Info("Found Trivy", logrus.Fields{"path": trivyPath})
return trivyPath, nil
}

// handleTrivyNotFound prints error message and exits with code 2
func handleTrivyNotFound(err error) {
logger.Error("Trivy not found", logrus.Fields{"error": err.Error()})
color.Red("❌ Error: Trivy is not installed or not found in PATH")
fmt.Println("Please install Trivy to use container scanning.")
fmt.Println("Visit: https://trivy.dev/latest/getting-started/installation/")
fmt.Println("exit-code 2")
exitFunc(2)
Comment on lines +173 to +178
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The handleTrivyNotFound function calls exitFunc(2) but then returns 2, which creates ambiguous control flow. After exitFunc(2) is called (which in production is os.Exit(2)), the function terminates the program, so the return statement is never reached. However, in tests where exitFunc is mocked, the return value is used.

This creates inconsistent behavior between production and tests. Consider either:

  1. Removing the return value since exitFunc terminates the program
  2. Or not calling exitFunc here and letting the caller handle the exit

Looking at the caller (executeContainerScan line 169-170), it calls handleTrivyNotFound and then returns 2 anyway, making the exit call redundant.

Suggested change
// handleTrivyNotFound prints error message and exits with code 2
func handleTrivyNotFound(err error) {
logger.Error("Trivy not found", logrus.Fields{"error": err.Error()})
color.Red("❌ Error: Trivy is not installed or not found in PATH")
fmt.Println("Please install Trivy to use container scanning.")
fmt.Println("Visit: https://trivy.dev/latest/getting-started/installation/")
fmt.Println("exit-code 2")
exitFunc(2)
// handleTrivyNotFound prints error message indicating Trivy is missing
func handleTrivyNotFound(err error) {
logger.Error("Trivy not found", logrus.Fields{"error": err.Error()})
color.Red("❌ Error: Trivy is not installed or not found in PATH")
fmt.Println("Please install Trivy to use container scanning.")
fmt.Println("Visit: https://trivy.dev/latest/getting-started/installation/")
fmt.Println("exit-code 2")

Copilot uses AI. Check for mistakes.
}

func runContainerScan(_ *cobra.Command, args []string) {
exitCode := executeContainerScan(args)
exitFunc(exitCode)
}

// executeContainerScan performs the container scan and returns an exit code
// Exit codes: 0 = success, 1 = vulnerabilities found, 2 = error
func executeContainerScan(imageNames []string) int {
if code := validateAllImages(imageNames); code != 0 {
return code
}
logger.Info("Starting container scan", logrus.Fields{"images": imageNames, "count": len(imageNames)})

trivyPath, err := getTrivyPath()
if err != nil {
handleTrivyNotFound(err)
return 2
Comment on lines +196 to +199
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The function signature of handleTrivyNotFound doesn't return a value, but in executeContainerScan at line 169, it's called and then explicitly returns 2. This is confusing because handleTrivyNotFound already calls exitFunc(2) which terminates the program in production.

The return 2 statement at line 170 only executes in tests where exitFunc is mocked. This creates a code smell where the control flow depends on whether exitFunc is mocked or not. Consider removing the exitFunc call from handleTrivyNotFound and having it return an int instead, letting the caller decide whether to exit.

Copilot uses AI. Check for mistakes.
}

hasVulnerabilities := scanAllImages(imageNames, trivyPath)
if hasVulnerabilities == -1 {
return 2
}
return printScanSummary(hasVulnerabilities == 1, imageNames)
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The runContainerScan function serves no purpose and adds unnecessary indirection. It just calls executeContainerScan and then exits. This pattern is inconsistent with how other commands in the codebase are structured.

Looking at commands like update.go and config.go, they perform their logic directly in the Run function and call os.Exit when needed. Consider moving the logic from executeContainerScan into runContainerScan and removing the extra layer.

Suggested change
exitCode := executeContainerScan(args)
exitFunc(exitCode)
}
// executeContainerScan performs the container scan and returns an exit code
// Exit codes: 0 = success, 1 = vulnerabilities found, 2 = error
func executeContainerScan(imageNames []string) int {
if code := validateAllImages(imageNames); code != 0 {
return code
}
logger.Info("Starting container scan", logrus.Fields{"images": imageNames, "count": len(imageNames)})
trivyPath, err := getTrivyPath()
if err != nil {
handleTrivyNotFound(err)
return 2
}
hasVulnerabilities := scanAllImages(imageNames, trivyPath)
if hasVulnerabilities == -1 {
return 2
}
return printScanSummary(hasVulnerabilities == 1, imageNames)
// Exit codes: 0 = success, 1 = vulnerabilities found, 2 = error
if code := validateAllImages(args); code != 0 {
exitFunc(code)
return
}
logger.Info("Starting container scan", logrus.Fields{"images": args, "count": len(args)})
trivyPath, err := getTrivyPath()
if err != nil {
handleTrivyNotFound(err)
return
}
hasVulnerabilities := scanAllImages(args, trivyPath)
if hasVulnerabilities == -1 {
exitFunc(2)
return
}
exitCode := printScanSummary(hasVulnerabilities == 1, args)
exitFunc(exitCode)

Copilot uses AI. Check for mistakes.
}

func validateAllImages(imageNames []string) int {
for _, imageName := range imageNames {
if err := validateImageName(imageName); err != nil {
logger.Error("Invalid image name", logrus.Fields{"image": imageName, "error": err.Error()})
color.Red("❌ Error: %v", err)
fmt.Println("exit-code 2")
return 2
}
}
return 0
}

// scanAllImages scans all images and returns: 0=no vulns, 1=vulns found, -1=error
func scanAllImages(imageNames []string, trivyPath string) int {
hasVulnerabilities := false
for i, imageName := range imageNames {
printScanHeader(imageNames, imageName, i)
args := buildTrivyArgs(imageName)
logger.Info("Running Trivy container scan", logrus.Fields{"command": fmt.Sprintf("%s %v", trivyPath, args)})

if err := commandRunner.Run(trivyPath, args); err != nil {
if getExitCode(err) == 1 {
logger.Warn("Vulnerabilities found in image", logrus.Fields{"image": imageName})
hasVulnerabilities = true
} else {
logger.Error("Failed to run Trivy", logrus.Fields{"error": err.Error(), "image": imageName})
color.Red("❌ Error: Failed to run Trivy for %s: %v", imageName, err)
fmt.Println("exit-code 2")
return -1
}
} else {
logger.Info("No vulnerabilities found in image", logrus.Fields{"image": imageName})
}
}
Comment thread
franciscoovazevedo marked this conversation as resolved.
Outdated
if hasVulnerabilities {
return 1
}
return 0
}

func printScanHeader(imageNames []string, imageName string, index int) {
if len(imageNames) > 1 {
fmt.Printf("\n📦 [%d/%d] Scanning image: %s\n", index+1, len(imageNames), imageName)
fmt.Println(strings.Repeat("-", 50))
} else {
fmt.Printf("🔍 Scanning container image: %s\n\n", imageName)
}
}

func printScanSummary(hasVulnerabilities bool, imageNames []string) int {
fmt.Println()
if hasVulnerabilities {
logger.Warn("Container scan completed with vulnerabilities", logrus.Fields{"images": imageNames})
color.Red("❌ Scanning failed: vulnerabilities found in one or more container images")
fmt.Println("exit-code 1")
return 1
}
logger.Info("Container scan completed successfully", logrus.Fields{"images": imageNames})
color.Green("✅ Success: No vulnerabilities found matching the specified criteria")
fmt.Println("exit-code 0")
return 0
}

// buildTrivyArgs constructs the Trivy command arguments based on flags
func buildTrivyArgs(imageName string) []string {
args := []string{
"image",
"--scanners", "vuln",
}

// Apply --ignore-unfixed if enabled (default: true)
if ignoreUnfixedFlag {
args = append(args, "--ignore-unfixed")
}

// Apply --severity (use default if not specified)
severity := severityFlag
if severity == "" {
severity = "HIGH,CRITICAL"
}
args = append(args, "--severity", severity)

// Apply --pkg-types (use default if not specified)
pkgTypes := pkgTypesFlag
if pkgTypes == "" {
pkgTypes = "os"
}
args = append(args, "--pkg-types", pkgTypes)

// Always apply --exit-code 1 (not user-configurable)
args = append(args, "--exit-code", "1")

// Add the image name as the last argument
args = append(args, imageName)

return args
}
Loading
Loading