error_handler.py

# Copyright (C) 2021 Intel Corporation
# SPDX-License-Identifier: GPL-3.0-or-later

from __future__ import annotations

import sys
from enum import Enum
from logging import Logger

from rich.console import Console
from rich.traceback import Traceback

CONSOLE = Console(file=sys.stderr)


class InsufficientArgs(Exception):
    """Insufficient command line arguments"""


class EmptyTxtError(Exception):
    """Given txt File is empty"""


class InvalidListError(Exception):
    """Given File is an invalid package list"""


class InvalidCsvError(Exception):
    """Given File is an Invalid CSV"""


class InvalidCheckerError(Exception):
    """Raised when data provided to Checker is not correct"""


class MissingFieldsError(Exception):
    """Missing needed fields"""


class InvalidJsonError(Exception):
    """Given File is an Invalid JSON"""


class InvalidIntermediateJsonError(Exception):
    """Given Intermediate File is not in valid Format"""


class EmptyCache(Exception):
    """
    Raised when NVD is opened when verify=False and there are no files in the
    cache.
    """


class CVEDataForYearNotInCache(Exception):
    """
    Raised when the CVE data for a year is not present in the cache.
    """


class CVEDataForCurlVersionNotInCache(Exception):
    """
    Raised when the CVE data for a curl version is not present in the cache.
    """


class CVEDataMissing(Exception):
    """
    Raised when no CVE data is present in the database.
    """


class AttemptedToWriteOutsideCachedir(Exception):
    """
    Raised if we attempted to write to a file that would have been outside the
    cachedir.
    """


class NVDRateLimit(Exception):
    """
    Raised if you have been ratelimited by NVD.
    """


class NVDServiceError(Exception):
    """
    Raised if the NVD API returns a 503 error.
    """


class NVDKeyError(Exception):
    """
    Raised if the NVD API key is invalid.
    """


class SHAMismatch(Exception):
    """
    Raised if the sha of a file in the cache was not what it should be.
    """


class ExtractionFailed(ValueError):
    """Extraction fail"""


class ExtractionToolNotFound(Exception):
    """No tool found to extract files"""


class UnknownArchiveType(ValueError):
    """Unknown archive type"""


class UnknownConfigType(Exception):
    """Unknown configuration file type"""


class CVEDBError(Exception):
    """Something unrecoverable went wrong with our database connection"""


class MirrorError(Exception):
    """Internet issue or invalid metadata when cloning json data from mirror"""


class CVEDBNotExist(Exception):
    """Database does not exist"""


class CVEDBOutdatedSchema(Exception):
    """Database does not have the latest schema"""


class InvalidExtensionError(Exception):
    """Given Extension format is Invalid"""


class SigningError(Exception):
    """Error while signing or verifing the sign"""


class NetworkConnectionError(Exception):
    """Raised when issue occurred with internet connection"""


class PDFOutputUnavailable(Exception):
    """Raised when reportlab is not installed and PDF output is unavailable"""


class VEXError(Exception):
    """Raised when VEX file provided is invalid"""


class ErrorMode(Enum):
    Ignore = 0
    NoTrace = 1
    TruncTrace = 2
    FullTrace = 3


def excepthook(exc_type, exc_val, exc_tb):
    trace = Traceback.from_exception(exc_type, exc_val, exc_tb)
    CONSOLE.print(trace)
    if isinstance(exc_val, SystemExit):
        sys.exit(exc_val.code)
    elif ERROR_CODES.get(exc_type):
        sys.exit(ERROR_CODES[exc_type])


class ErrorHandler:
    """Error handler context manager.

    Supports Different modes like ignore error, print full trace, truncated trace and no trace.
    Log messages if logger specified.

    Args:
        mode (ErrorMode): Can take any valid ErrorMode as an arg and change output according to that.
        logger (Logger): logs error message specified while raising Exception if logger is passed
                         while class initialization.
                         Ex: raise ValueError("file required") will log 'ValueError: file required'.
    Attributes:
        exit_code (int): Stores exit code for raised Exception, set -1 for generic Exception and 0
                         if code executes without Exception.
        exc_val (Union[BaseException, None]): Stores exception instance if Exception raises otherwise None.
    """

    exit_code: int
    exc_val: BaseException | None

    def __init__(
        self, logger: Logger | None = None, mode: ErrorMode = ErrorMode.TruncTrace
    ):
        self.mode = mode
        self.logger = logger
        self.exit_code = 0
        self.exc_val = None

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        if isinstance(exc_val, SystemExit):
            self.exit_code = exc_val.code
            self.exc_val = exc_val
        elif isinstance(exc_val, BaseException):
            self.exit_code = ERROR_CODES.get(exc_type, -1)
            self.exc_val = exc_val
        if self.mode == ErrorMode.Ignore:
            return True
        if exc_type:
            if self.logger and exc_val:
                self.logger.error(f"{exc_type.__name__}: {exc_val}")
            if self.mode == ErrorMode.NoTrace:
                sys.exit(self.exit_code)
            if self.mode == ErrorMode.TruncTrace:
                CONSOLE.print_exception()
                sys.exit(self.exit_code)
            return False


# Exit codes for Exception.
# Error code 1 is reserved to mean that cves were found
# Error code 2 is reserved for argparse errors (default argparse behaviour)
# Error code 3 is reserved for "we found negative cves" (should be impossible)
# Error code 4-20 are reserved just in case
ERROR_CODES = {
    FileNotFoundError: 21,
    InvalidCsvError: 22,
    InvalidJsonError: 22,
    EmptyTxtError: 22,
    InvalidListError: 22,
    MissingFieldsError: 23,
    InsufficientArgs: 24,
    EmptyCache: 25,
    CVEDataForYearNotInCache: 26,
    CVEDataForCurlVersionNotInCache: 27,
    AttemptedToWriteOutsideCachedir: 28,
    SHAMismatch: 29,
    ExtractionFailed: 30,
    ExtractionToolNotFound: 30,
    UnknownArchiveType: 31,
    UnknownConfigType: 32,
    CVEDataMissing: 33,
    InvalidCheckerError: 34,
    NVDRateLimit: 35,
    InvalidIntermediateJsonError: 36,
    NVDServiceError: 37,
    CVEDBError: 38,
    MirrorError: 39,
    CVEDBNotExist: 40,
    CVEDBOutdatedSchema: 41,
    InvalidExtensionError: 42,
    SigningError: 43,
    NetworkConnectionError: 44,
    PDFOutputUnavailable: 45,
    VEXError: 46,
}