from __future__ import annotations
import base64
from dataclasses import dataclass
from enum import Enum
from lxml import objectify
from q2_sdk.tools.utils import to_bool
from .base import AuthorizationStatus, BaseAuthRequest, BaseAuthResponse
[docs]
class FailureReason(Enum):
LockLogin = "LockLogin"
DisableLogin = "DisableLogin"
LockUser = "LockUser"
[docs]
@dataclass
class Request(BaseAuthRequest):
"""
Shape that comes in from HQ after typing in a username and navigating away from the input box on login (onBlur).
.. code-block:: xml
<HQ request="PreLogon" messageID="{0}">
<LoginId>2</LoginId>
<UserPrimaryCIF>MDcyMTIwMTA=</UserPrimaryCIF>
<CustomerPrimaryCIF>MDcyMTIwMTA=</CustomerPrimaryCIF>
<isLogon>True</isLogon>
<IsPrelogonSession>False</IsPrelogonSession>
<SessionId>shb3cnukdl32c54nodvyxcsj</SessionId>
</HQ>
"""
raw: objectify.Element
login_id: int
user_primary_cif: str
customer_primary_cif: str
is_logon: bool
is_prelogon_session: bool
session_id: str
@staticmethod
def from_xml(xml: objectify.Element) -> Request:
login_id = int(xml.LoginId.text)
user_primary_cif = base64.b64decode(xml.UserPrimaryCIF.text).decode()
customer_primary_cif = base64.b64decode(xml.CustomerPrimaryCIF.text).decode()
is_logon = to_bool(xml.isLogon.text)
is_prelogon_session = to_bool(xml.IsPrelogonSession.text)
session_id = xml.SessionId.text
return Request(
xml,
login_id,
user_primary_cif,
customer_primary_cif,
is_logon,
is_prelogon_session,
session_id,
)
[docs]
@dataclass
class Response(BaseAuthResponse):
"""
.. code-block:: xml
<Q2Bridge request="PreLogon" messageID="messageID">
<Status>"Success"/"Error"</Status>
<AuthorizationStatus></AuthorizationStatus>
<EndUserMessage>{0}</EndUserMessage>
<StatusDescription>{0}</StatusDescription>
</Q2Bridge>
"""
[docs]
@classmethod
def get_success(cls):
resp = cls(cls._get_standard_auth_success_fields())
resp.add_response_field(
"authorization_status", AuthorizationStatus.PasswordIsGood
)
return resp
[docs]
@classmethod
def get_failure(cls, failure_reason: FailureReason):
"""Same as basic get_failure but can provide a reason for failure"""
resp = cls(cls._get_standard_auth_failure_fields())
match failure_reason:
case FailureReason.LockLogin:
resp.add_response_field(
"authorization_status", AuthorizationStatus.LockLogin
)
case FailureReason.LockUser:
resp.add_response_field(
"authorization_status", AuthorizationStatus.LockUser
)
case FailureReason.DisableLogin:
resp.add_response_field(
"authorization_status", AuthorizationStatus.DisableLogin
)
return resp