CasperSecurity
from typing import List, Optional, Tuple
from uaclient import messages
class InPlaceUpgradeNotSupportedError(Exception):
pass
class IsProLicensePresentError(Exception):
pass
class CancelProLicensePolling(IsProLicensePresentError):
pass
class DelayProLicensePolling(IsProLicensePresentError):
pass
class ProcessExecutionError(IOError):
def __init__(
self,
cmd: str,
exit_code: Optional[int] = None,
stdout: str = "",
stderr: str = "",
) -> None:
self.stdout = stdout
self.stderr = stderr
self.exit_code = exit_code
if not exit_code:
message = messages.SUBP_INVALID_COMMAND.format(cmd=cmd)
else:
message = messages.SUBP_COMMAND_FAILED.format(
cmd=cmd, exit_code=exit_code, stderr=stderr
)
super().__init__(message)
class UbuntuProError(Exception):
"""
Base class for all of our custom errors.
All possible exceptions from our API should extend this class.
"""
_msg = None # type: messages.NamedMessage
_formatted_msg = None # type: messages.FormattedNamedMessage
exit_code = 1
def __init__(self, **kwargs) -> None:
if self._formatted_msg is not None:
self.named_msg = self._formatted_msg.format(
**kwargs
) # type: messages.NamedMessage
else:
self.named_msg = self._msg
self.additional_info = kwargs
for key, value in kwargs.items():
setattr(self, key, value)
@property
def msg(self):
return self.named_msg.msg
@property
def msg_code(self):
return self.named_msg.name
def __str__(self):
return self.named_msg.msg
# UserFacingError is the old name of our base exception class.
# Other systems may import and rely on this name.
# Leave this here for backwards compatibility.
UserFacingError = UbuntuProError
class AnonymousUbuntuProError(UbuntuProError):
"""
For cases where we have a NamedMessage of an Error already but it isn't in
exception form, and we need to raise it as an exception. This generally
should only be used in cli-only code.
"""
def __init__(self, named_msg: messages.NamedMessage, **kwargs):
super().__init__(**kwargs)
self.named_msg = named_msg
###############################################################################
# APT #
###############################################################################
class APTProcessConflictError(UbuntuProError):
_msg = messages.E_APT_PROCESS_CONFLICT
class APTInvalidRepoError(UbuntuProError):
_formatted_msg = messages.E_APT_UPDATE_INVALID_URL_CONFIG
class APTUpdateProcessConflictError(UbuntuProError):
_msg = messages.E_APT_UPDATE_PROCESS_CONFLICT
class APTUpdateInvalidRepoError(UbuntuProError):
_formatted_msg = messages.E_APT_UPDATE_INVALID_REPO
class APTUpdateFailed(UbuntuProError):
_formatted_msg = messages.E_APT_UPDATE_FAILED
class APTInstallProcessConflictError(UbuntuProError):
_msg = messages.E_APT_INSTALL_PROCESS_CONFLICT
class APTInstallInvalidRepoError(UbuntuProError):
_formatted_msg = messages.E_APT_INSTALL_INVALID_REPO
class APTInvalidCredentials(UbuntuProError):
_formatted_msg = messages.E_APT_INVALID_CREDENTIALS
class APTTimeout(UbuntuProError):
_formatted_msg = messages.E_APT_TIMEOUT
class APTUnexpectedError(UbuntuProError):
_formatted_msg = messages.E_APT_UNEXPECTED_ERROR
class APTCommandTimeout(UbuntuProError):
_formatted_msg = messages.E_APT_COMMAND_TIMEOUT
###############################################################################
# SNAP #
###############################################################################
class SnapNotInstalledError(UbuntuProError):
_formatted_msg = messages.E_SNAP_NOT_INSTALLED_ERROR
class UnexpectedSnapdAPIError(UbuntuProError):
_formatted_msg = messages.E_UNEXPECTED_SNAPD_API_ERROR
class SnapdAPIConnectionRefused(UbuntuProError):
_msg = messages.E_SNAPD_CONNECTION_REFUSED
class CannotInstallSnapdError(UbuntuProError):
_msg = messages.E_CANNOT_INSTALL_SNAPD
class ErrorInstallingLivepatch(UbuntuProError):
_formatted_msg = messages.E_ERROR_INSTALLING_LIVEPATCH
###############################################################################
# PROXY/NETWORK #
###############################################################################
class InvalidUrl(UbuntuProError):
_formatted_msg = messages.E_INVALID_URL
class ProxyNotWorkingError(UbuntuProError):
_formatted_msg = messages.E_NOT_SETTING_PROXY_NOT_WORKING
class ProxyInvalidUrl(UbuntuProError):
_formatted_msg = messages.E_NOT_SETTING_PROXY_INVALID_URL
class PycurlRequiredError(UbuntuProError):
_msg = messages.E_PYCURL_REQUIRED
class PycurlError(UbuntuProError):
_formatted_msg = messages.E_PYCURL_ERROR
class ProxyAuthenticationFailed(UbuntuProError):
_msg = messages.E_PROXY_AUTH_FAIL
class ExternalAPIError(UbuntuProError):
_formatted_msg = messages.E_EXTERNAL_API_ERROR
code = None # type: int
url = None # type: str
body = None # type: str
def __str__(self):
return "{}: [{}], {}".format(self.code, self.url, self.body)
class ContractAPIError(ExternalAPIError):
pass
class SecurityAPIError(ExternalAPIError):
pass
class PycurlCACertificatesError(UbuntuProError):
_msg = messages.E_PYCURL_CA_CERTIFICATES
def __init__(self, url, **kwargs) -> None:
super().__init__(**kwargs)
self.url = url
class ConnectivityError(UbuntuProError, IOError):
_formatted_msg = messages.E_CONNECTIVITY_ERROR
def __init__(
self,
cause: Exception,
url: str,
):
if getattr(cause, "reason", None):
cause_error = str(getattr(cause, "reason"))
else:
cause_error = str(cause)
IOError.__init__(self, cause_error)
UbuntuProError.__init__(self, cause_error=cause_error, url=url)
# Even though we already set those variable through UbuntuProError
# we need to set them again to avoid mypy warnings
self.cause_error = cause_error
self.url = url
# We are doing that just to keep backwards compatibility
# for our custom UrlError exception
UrlError = ConnectivityError
###############################################################################
# ATTACH/ENABLE #
###############################################################################
class ContractExpiredError(UbuntuProError):
_msg = messages.E_CONTRACT_EXPIRED
class InvalidServiceOpError(UbuntuProError):
_formatted_msg = messages.E_INVALID_SERVICE_OP_FAILURE
class AlreadyAttachedError(UbuntuProError):
"""An exception to be raised when a command needs an unattached system."""
exit_code = 2
_formatted_msg = messages.E_ALREADY_ATTACHED
class AttachError(UbuntuProError):
"""An exception to be raised when we detect a generic attach error."""
exit_code = 1
_msg = messages.E_ATTACH_FAILURE
class AttachInvalidConfigFileError(UbuntuProError):
_formatted_msg = messages.E_ATTACH_CONFIG_READ_ERROR
class AttachInvalidTokenError(UbuntuProError):
_msg = messages.E_ATTACH_INVALID_TOKEN
class AttachForbiddenExpired(UbuntuProError):
_formatted_msg = messages.E_ATTACH_FORBIDDEN_EXPIRED
class AttachForbiddenNotYet(UbuntuProError):
_formatted_msg = messages.E_ATTACH_FORBIDDEN_NOT_YET
class AttachForbiddenNever(UbuntuProError):
_formatted_msg = messages.E_ATTACH_FORBIDDEN_NEVER
class AttachExpiredToken(UbuntuProError):
_msg = messages.E_ATTACH_EXPIRED_TOKEN
class MagicAttachTokenAlreadyActivated(UbuntuProError):
_msg = messages.E_MAGIC_ATTACH_TOKEN_ALREADY_ACTIVATED
class MagicAttachTokenError(UbuntuProError):
_msg = messages.E_MAGIC_ATTACH_TOKEN_ERROR
class MagicAttachUnavailable(UbuntuProError):
_msg = messages.E_MAGIC_ATTACH_UNAVAILABLE
class MagicAttachInvalidParam(UbuntuProError):
_formatted_msg = messages.E_MAGIC_ATTACH_INVALID_PARAM
class MissingAptURLDirective(UbuntuProError):
"""An exception for when the contract server doesn't include aptURL"""
_formatted_msg = messages.E_MISSING_APT_URL_DIRECTIVE
class UnattachedError(UbuntuProError):
"""An exception to be raised when a machine needs to be attached."""
_msg = messages.E_UNATTACHED
class UnattachedValidServicesError(UbuntuProError):
_formatted_msg = messages.E_VALID_SERVICE_FAILURE_UNATTACHED
class UnattachedMixedServicesError(UbuntuProError):
_formatted_msg = messages.E_MIXED_SERVICES_FAILURE_UNATTACHED
class UnattachedInvalidServicesError(UbuntuProError):
_formatted_msg = messages.E_INVALID_SERVICE_OP_FAILURE
class EntitlementNotFoundError(UbuntuProError):
_formatted_msg = messages.E_ENTITLEMENT_NOT_FOUND
class EntitlementsNotEnabledError(UbuntuProError):
exit_code = 4
_msg = messages.E_ENTITLEMENTS_NOT_ENABLED_ERROR
def __init__(
self, failed_services: List[Tuple[str, messages.NamedMessage]]
):
info_dicts = [
{"name": f[0], "code": f[1].name, "title": f[1].msg}
for f in failed_services
]
super().__init__(
additional_info={"services": info_dicts},
)
class EntitlementNotEnabledError(UbuntuProError):
_formatted_msg = messages.E_ENTITLEMENT_NOT_ENABLED_ERROR
def __init__(self, service: str, reason: messages.NamedMessage):
super().__init__(
service=service,
additional_info={
"reason": {
"code": reason.name,
"title": reason.msg,
"additional_info": reason.additional_info,
}
},
)
class EntitlementNotDisabledError(UbuntuProError):
_formatted_msg = messages.E_ENTITLEMENT_NOT_DISABLED_ERROR
def __init__(self, service: str, reason: messages.NamedMessage):
super().__init__(
service=service,
additional_info={
"reason": {
"code": reason.name,
"title": reason.msg,
"additional_info": reason.additional_info,
}
},
)
class AttachFailureDefaultServices(EntitlementsNotEnabledError):
_msg = messages.E_ATTACH_FAILURE_DEFAULT_SERVICES
class AttachFailureUnknownError(EntitlementsNotEnabledError):
_msg = messages.E_ATTACH_FAILURE_UNEXPECTED
class AttachFailureRestrictedRelease(UbuntuProError):
_formatted_msg = messages.ATTACH_FAILURE_RESTRICTED_RELEASE
class RepoNoAptKey(UbuntuProError):
_formatted_msg = messages.E_REPO_NO_APT_KEY
class RepoNoSuites(UbuntuProError):
_formatted_msg = messages.E_REPO_NO_SUITES
class RepoPinFailNoOrigin(UbuntuProError):
_formatted_msg = messages.E_REPO_PIN_FAIL_NO_ORIGIN
class InvalidContractDeltasServiceType(UbuntuProError):
_formatted_msg = messages.E_INVALID_CONTRACT_DELTAS_SERVICE_TYPE
class EntitlementsAPTDirectivesAreNotUnique(UbuntuProError):
_formatted_msg = messages.E_ENTITLEMENTS_APT_DIRECTIVES_ARE_NOT_UNIQUE
class RequiredServiceStopsEnable(UbuntuProError):
_formatted_msg = messages.E_REQUIRED_SERVICE_STOPS_ENABLE
class IncompatibleServiceStopsEnable(UbuntuProError):
_formatted_msg = messages.E_INCOMPATIBLE_SERVICE_STOPS_ENABLE
class DependentServiceStopsDisable(UbuntuProError):
_formatted_msg = messages.E_DEPENDENT_SERVICE_STOPS_DISABLE
class LandscapeConfigFailed(UbuntuProError):
_msg = messages.E_LANDSCAPE_CONFIG_FAILED
class NonInteractiveKernelPurgeDisallowed(UbuntuProError):
_msg = messages.E_NON_INTERACTIVE_KERNEL_PURGE_DISALLOWED
###############################################################################
# CLOUD AUTO-ATTACH #
###############################################################################
class InvalidProImage(UbuntuProError):
_formatted_msg = messages.E_INVALID_PRO_IMAGE
error_msg = None # type: str
class CloudMetadataError(UbuntuProError):
_formatted_msg = messages.E_CLOUD_METADATA_ERROR
class GCPServiceAccountError(CloudMetadataError):
"""An exception raised when GCP service account is not enabled"""
_formatted_msg = messages.E_GCP_SERVICE_ACCT_NOT_ENABLED_ERROR
class AWSNoValidIMDS(UbuntuProError):
_formatted_msg = messages.E_AWS_NO_VALID_IMDS
class CloudFactoryError(UbuntuProError):
pass
class CloudFactoryNoCloudError(CloudFactoryError):
_msg = messages.E_UNABLE_TO_DETERMINE_CLOUD_TYPE
class CloudFactoryNonViableCloudError(CloudFactoryError):
_msg = messages.E_UNSUPPORTED_AUTO_ATTACH
class NonAutoAttachImageError(CloudFactoryError):
"""Raised when machine isn't running an auto-attach enabled image"""
exit_code = 0
_formatted_msg = messages.E_UNSUPPORTED_AUTO_ATTACH_CLOUD_TYPE
class LXDAutoAttachNotAvailable(UbuntuProError):
_msg = messages.E_LXD_AUTO_ATTACH_NOT_AVAILABLE
class LXDAutoAttachNotAllowed(UbuntuProError):
_msg = messages.E_LXD_AUTO_ATTACH_NOT_ALLOWED
###############################################################################
# FILES/FORMATS #
###############################################################################
class InvalidFileFormatError(UbuntuProError):
_formatted_msg = messages.E_INVALID_FILE_FORMAT
class InvalidFileEncodingError(UbuntuProError):
_formatted_msg = messages.E_INVALID_FILE_ENCODING
class ParsingErrorOnOSReleaseFile(UbuntuProError):
_formatted_msg = messages.E_ERROR_PARSING_VERSION_OS_RELEASE
class MissingSeriesOnOSReleaseFile(UbuntuProError):
_formatted_msg = messages.E_MISSING_SERIES_ON_OS_RELEASE
class InvalidLockFile(UbuntuProError):
_formatted_msg = messages.E_INVALID_LOCK_FILE
class InvalidJson(UbuntuProError):
_formatted_msg = messages.E_JSON_PARSER_ERROR
class InvalidBooleanConfigValue(UbuntuProError):
_formatted_msg = messages.E_INVALID_BOOLEAN_CONFIG_VALUE
class InvalidPosIntConfigValue(UbuntuProError):
_formatted_msg = messages.E_CLI_CONFIG_VALUE_MUST_BE_POS_INT
class InvalidURLConfigValue(UbuntuProError):
_formatted_msg = messages.E_CONFIG_INVALID_URL
class InvalidFeatureYamlConfigValue(UbuntuProError):
_formatted_msg = messages.E_CONFIG_NO_YAML_FILE
class InvalidProxyCombinationConfig(UbuntuProError):
_msg = messages.E_INVALID_PROXY_COMBINATION
class MissingDistroInfoFile(UbuntuProError):
_msg = messages.E_MISSING_DISTRO_INFO_FILE
class MissingSeriesInDistroInfoFile(UbuntuProError):
_formatted_msg = messages.E_MISSING_SERIES_IN_DISTRO_INFO_FILE
class UnsupportedManifestFile(UbuntuProError):
_formatted_msg = messages.E_UNSUPPORTED_MANIFEST_FILE
###############################################################################
# CLI #
###############################################################################
class InvalidOptionCombination(UbuntuProError):
_formatted_msg = messages.E_INVALID_OPTION_COMBINATION
class DepedentOptionError(UbuntuProError):
_formatted_msg = messages.E_DEPENDENT_OPTION
class NoHelpContent(UbuntuProError):
_formatted_msg = messages.E_CLI_NO_HELP
class InvalidSecurityIssueIdFormat(UbuntuProError):
_formatted_msg = messages.E_SECURITY_FIX_CLI_ISSUE_REGEX_FAIL
class InvalidArgChoice(UbuntuProError):
_formatted_msg = messages.E_CLI_VALID_CHOICES
class EmptyConfigValue(UbuntuProError):
_formatted_msg = messages.E_CLI_EMPTY_CONFIG_VALUE
class GenericInvalidFormat(UbuntuProError):
_formatted_msg = messages.E_CLI_EXPECTED_FORMAT
class RefreshConfigFailure(UbuntuProError):
_msg = messages.E_REFRESH_CONFIG_FAILURE
class RefreshContractFailure(UbuntuProError):
_msg = messages.E_REFRESH_CONTRACT_FAILURE
class RefreshMessagesFailure(UbuntuProError):
_msg = messages.E_REFRESH_MESSAGES_FAILURE
class CLIJSONFormatRequireAssumeYes(UbuntuProError):
_msg = messages.E_JSON_FORMAT_REQUIRE_ASSUME_YES
class CLIAttachTokenArgXORConfig(UbuntuProError):
_msg = messages.E_ATTACH_TOKEN_ARG_XOR_CONFIG
class CLIAPIOptionsXORData(UbuntuProError):
_msg = messages.E_API_ERROR_ARGS_AND_DATA_TOGETHER
class PromptDeniedError(UbuntuProError):
_msg = messages.E_PROMPT_DENIED
###############################################################################
# VULNERABILITIES #
###############################################################################
class VulnerabilityDataNotFound(UbuntuProError):
_msg = messages.E_VULNERABILITY_DATA_NOT_FOUND
###############################################################################
# MISCELLANEOUS #
###############################################################################
class LockHeldError(UbuntuProError):
"""An exception for when another pro operation is in progress
:param lock_request: String of the command requesting the lock
:param lock_holder: String of the command that currently holds the lock
:param pid: Integer of the process id of the lock_holder
"""
_formatted_msg = messages.E_LOCK_HELD_ERROR
pid = None # type: int
class NonRootUserError(UbuntuProError):
"""An exception to be raised when a user needs to be root."""
_msg = messages.E_NONROOT_USER
class SecurityAPIMetadataError(UbuntuProError):
"""An exception raised with Security API metadata returns invalid data."""
_formatted_msg = messages.E_SECURITY_API_INVALID_METADATA
class SecurityIssueNotFound(UbuntuProError):
_formatted_msg = messages.E_SECURITY_FIX_NOT_FOUND_ISSUE
class GPGKeyNotFound(UbuntuProError):
_formatted_msg = messages.E_GPG_KEY_NOT_FOUND
class UnknownProcessorType(UbuntuProError):
_formatted_msg = messages.E_UNKNOWN_PROCESSOR_TYPE
class FeatureNotSupportedOldTokenError(UbuntuProError):
_formatted_msg = messages.E_FEATURE_NOT_SUPPORTED_OLD_TOKEN
class ETagUnchanged(UbuntuProError):
_formatted_msg_ = messages.E_ETAG_UNCHANGED