from __future__ import annotations
import base64
from dataclasses import dataclass
from enum import Enum
from lxml import objectify # type: ignore
from q2_sdk.tools.utils import to_bool
from .base import BaseAuthRequest, BaseAuthResponse
[docs]
class SuccessLogonStatus(Enum):
Normal = "normal"
[docs]
class FailureLogonStatus(Enum):
Locked = "locked"
Disabled = "disabled"
[docs]
@dataclass
class Request(BaseAuthRequest):
"""
Shape that comes in from HQ before the CheckPassword step.
.. code-block:: xml
<HQ request="CheckStatus" messageID="{0}">
<LoginId>2</LoginId>{4}
<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="CheckStatus" messageID="messageID">
<Status>"Success"/"Error"</Status>
<Locked>true</Locked>
<HQErrorReturnCode>{0}</HQErrorReturnCode>
<StatusDescription>{0}</StatusDescription>
</Q2Bridge>
"""
[docs]
@classmethod
def get_success(cls):
resp = cls(cls._get_standard_auth_success_fields())
resp.add_response_field("logon_status", SuccessLogonStatus.Normal)
return resp
[docs]
@classmethod
def get_failure(cls, logon_status: FailureLogonStatus):
"""Failed Logon Statuses can either result in Locked or Disabled logons"""
resp = cls(cls._get_standard_auth_failure_fields())
resp.add_response_field("logon_status", logon_status)
return resp