Skip to content

Exceptions

Module: s2auth.common.exceptions

ErrorType = Union[PairingErrorType, ConnectionErrorType] module-attribute

PairingErrorType

Bases: str, Enum

Source code in src/s2auth/common/model/s2_connect_pairing.py 
19
20
21
22
23
24
25
26
27
28
class ErrorMessage(str, Enum):
    InvalidCombinationOfRoles = "InvalidCombinationOfRoles"
    IncompatibleS2MessageVersions = "IncompatibleS2MessageVersions"
    IncompatibleHmacHashingAlgorithms = "IncompatibleHmacHashingAlgorithms"
    IncompatibleCommunicationProtocols = "IncompatibleCommunicationProtocols"
    NodeNotFound = "NodeNotFound"
    NoNodeIdProvided = "NoNodeIdProvided"
    NoValidPairingTokenOnPairingServer = "NoValidPairingTokenOnPairingServer"
    ParsingError = "ParsingError"
    Other = "Other"

ConnectionErrorType

Bases: str, Enum

Source code in src/s2auth/common/model/s2_connect_session_init.py 
30
31
32
33
34
35
class ErrorMessage(str, Enum):
    IncompatibleS2MessageVersions = "IncompatibleS2MessageVersions"
    IncompatibleCommunicationProtocols = "IncompatibleCommunicationProtocols"
    NoLongerPaired = "NoLongerPaired"
    ParsingError = "ParsingError"
    Other = "Other"

S2ConnectError

Bases: Exception, ABC

Base exception for S2 Connect errors

Subclasses must define the error_type class attribute.

Source code in src/s2auth/common/exceptions.py 
12
13
14
15
16
17
18
19
20
21
22
class S2ConnectError(Exception, ABC):
    """Base exception for S2 Connect errors

    Subclasses must define the error_type class attribute.
    """

    error_type: ClassVar[ErrorType]

    def __init__(self, message: str):
        super().__init__(message)
        self.message = message

S2PairingError

Bases: S2ConnectError

Base exception for S2 pairing errors

Source code in src/s2auth/common/exceptions.py 
24
25
26
class S2PairingError(S2ConnectError):
    """Base exception for S2 pairing errors"""
    pass

S2ConnectErrorWithDetails

Bases: S2ConnectError, ABC

Base exception for S2 Connect errors

Subclasses must define the error_type class attribute.

Source code in src/s2auth/common/exceptions.py 
28
29
30
31
32
33
34
35
36
37
38
class S2ConnectErrorWithDetails(S2ConnectError, ABC):
    """Base exception for S2 Connect errors

    Subclasses must define the error_type class attribute.
    """

    additional_info: str

    def __init__(self, message: str, additional_info: str):
        super().__init__(message)
        self.additional_info = additional_info

IncompatibleHmacHashingAlgorithms

Bases: S2ConnectError

Raised when no common HMAC hashing algorithm is found

Source code in src/s2auth/common/exceptions.py 
41
42
43
44
class IncompatibleHmacHashingAlgorithms(S2ConnectError):
    """Raised when no common HMAC hashing algorithm is found"""

    error_type = PairingErrorType.IncompatibleHmacHashingAlgorithms

VerificationError

Bases: S2ConnectError

Digest verification failed

Source code in src/s2auth/common/exceptions.py 
47
48
49
50
class VerificationError(S2ConnectError):
    """Digest verification failed"""

    error_type = PairingErrorType.Other  # TODO should be something else.

AccessError

Bases: S2ConnectError

Permission is denied to the client. This generally results in an HTTP 401 error.

Source code in src/s2auth/common/exceptions.py 
53
54
55
56
class AccessError(S2ConnectError):
    """Permission is denied to the client. This generally results in an HTTP 401 error."""

    error_type = PairingErrorType.Other  # TODO should be something else.

PairingNotCompleteError

Bases: S2ConnectError

Pairing was not completed successfully before initiating a connection.

Source code in src/s2auth/common/exceptions.py 
59
60
61
62
class PairingNotCompleteError(S2ConnectError):
    """Pairing was not completed successfully before initiating a connection."""

    error_type = ConnectionErrorType.NoLongerPaired  # TODO should be something else.

InvalidAccessTokenError

Bases: AccessError

Invalid AccessToken when authenticating a new s2 connection.

Source code in src/s2auth/common/exceptions.py 
65
66
67
68
class InvalidAccessTokenError(AccessError):
    """Invalid AccessToken when authenticating a new s2 connection."""

    error_type = ConnectionErrorType.Other  # TODO should be something else

InvalidServerError

Bases: AccessError

Unknown serverNodeId was specified for this server.

Source code in src/s2auth/common/exceptions.py 
71
72
73
74
class InvalidServerError(AccessError):
    """Unknown serverNodeId was specified for this server."""

    error_type = ConnectionErrorType.Other  # TODO should be something else

NoCompatibleS2ConnectVersionError

Bases: S2ConnectErrorWithDetails

No compatible S2Connect versions are available between the client and server.

Source code in src/s2auth/common/exceptions.py 
77
78
79
80
class NoCompatibleS2ConnectVersionError(S2ConnectErrorWithDetails):
    """No compatible S2Connect versions are available between the client and server."""

    error_type = ConnectionErrorType.Other  # TODO should be something else

NoCompatibleS2VersionError

Bases: S2ConnectErrorWithDetails

No compatible S2 versions are available between the client and server.

Source code in src/s2auth/common/exceptions.py 
83
84
85
86
class NoCompatibleS2VersionError(S2ConnectErrorWithDetails):
    """No compatible S2 versions are available between the client and server."""

    error_type = ConnectionErrorType.IncompatibleS2MessageVersions

NoCompatibleCommunitcationProtocol

Bases: S2ConnectErrorWithDetails

No compatible communication protocols are available between the client and server.

Source code in src/s2auth/common/exceptions.py 
89
90
91
92
class NoCompatibleCommunitcationProtocol(S2ConnectErrorWithDetails):
    """No compatible communication protocols are available between the client and server."""

    error_type = ConnectionErrorType.IncompatibleCommunicationProtocols