mobilus-client 0.1.0__tar.gz

mobilus_client-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+__pycache__
+tmp
+.coverage
+.tool-versions

mobilus_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zbigniew Pieślak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mobilus_client-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.3
+Name: mobilus-client
+Version: 0.1.0
+Summary: Python client for Mobilus Cosmo GTW
+Project-URL: homepage, https://github.com/zpieslak/mobilus-client
+Project-URL: issues, https://github.com/zpieslak/mobilus-client/issues
+Author-email: Zbigniew Pieślak <zpieslak@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Zbigniew Pieślak
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: cryptography~=43.0
+Requires-Dist: paho-mqtt~=1.6.0
+Requires-Dist: protobuf==5.28.1
+Provides-Extra: test
+Requires-Dist: coverage~=7.0; extra == 'test'
+Requires-Dist: factory-boy~=2.0; extra == 'test'
+Requires-Dist: flake8~=7.0; extra == 'test'
+Requires-Dist: mypy-protobuf~=3.0; extra == 'test'
+Requires-Dist: mypy~=1.0; extra == 'test'
+Requires-Dist: types-paho-mqtt~=1.0; extra == 'test'
+Requires-Dist: types-protobuf~=5.28.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+## Mobilus Cosmo GTW Client
+
+![test workflow](https://github.com/zpieslak/mobilus-client/actions/workflows/test.yml/badge.svg)
+
+This code provides a native Python client for the Mobilus Cosmo GTW. It connects directly to the gateway's MQTT broker and sends message commands to control the associated devices. The connection is established locally, so the client must be run on the same network as the gateway. Currently, the only tested and supported devices are radio shutters (Mobilus COSMO 2WAY).
+
+In order to use the client, configuration and setup need to be done on the Mobilus Cosmo GTW side. This includes creating a user and pairing the devices with the gateway.
+
+More information can be found on [blog post](https://codegyver.com/2024/09/22/mobilus-cosmo-gtw-reverse-engineering-a-radio-shutter-device/).
+
+## Installation
+
+Install the module with pip:
+
+    pip install mobilus-client
+
+## Usage
+
+For convenience, the client can be run as a module:
+
+    python -m mobilus_client --host=GATEWAY_HOST --login=USER_LOGIN --password=USER_PASSWORD COMMANDS
+
+Where:
+
+* `GATEWAY_HOST` is the IP address of the gateway.
+* `USER_LOGIN` and `USER_PASSWORD` are the user credentials to access the gateway.
+* `COMMANDS` is a list of commands to be sent to the gateway.
+
+Currently, the following commands are supported:
+
+* `current_state` - Get the current state of the devices. Please note that in the case of shutters, this doesn't return any meaningful data.
+
+* `devices_list` - List all devices that are paired with the gateway.
+
+* `call_events:device_id=DEVICE_ID,value=VALUE` - Send a command to the device. This can be used for actual control of the device (shutter).
+
+    * `DEVICE_ID` - The ID of the device as returned from devices_list.
+    * `VALUE` - The value to be sent to the device, currently one of "UP", "DOWN", "STOP", or a percentage value like "85%".
+
+Multiple commands can be sent at once, separated by spaces:
+
+    python -m mobilus_client --host=192.168.2.1 --login=admin --password=my_password devices_list call_events:device_id=0,value=100% call_events:device_id=1,value=80%
+
+Output is printed to the console in JSON format, and therefore the client command can be easily chained with `jq` for prettier output. For example:
+
+    python -m mobilus_client --host=192.168.2.1 --login=admin --password=my_password current_state | jq
+
+Verbose mode can be enabled with the `--verbose` flag:
+
+    python -m mobilus_client --host=192.168.2.1 --login=admin --password=my_password --verbose current_state
+
+## Caveats
+
+The client is tested with Mobilus Cosmo GTW with shutter devices only (COSMO 2WAY). It is possible that it will work with other devices, but it is not guaranteed. The purpose of the client is to provide a simple way to control the devices without the need to use the official Mobilus Cosmo GTW web interface or app, and to integrate it with open-source systems like Home Assistant. I am not affiliated with Mobilus, and the client is provided as is.
+
+## Development
+
+Clone the repository and navigate to the project directory.
+Install the package in editable mode with the following command:
+
+    pip install -e .[test]
+
+Check mypy and flake8 with the following commands:
+
+    mypy .
+    flake8 .
+
+The tests can be run with the following command:
+
+    python -m unittest -v
+
+To generate a coverage report:
+
+    coverage run -m unittest discover
+    coverage report

mobilus_client-0.1.0/README.md

@@ -0,0 +1,75 @@
+## Mobilus Cosmo GTW Client
+
+![test workflow](https://github.com/zpieslak/mobilus-client/actions/workflows/test.yml/badge.svg)
+
+This code provides a native Python client for the Mobilus Cosmo GTW. It connects directly to the gateway's MQTT broker and sends message commands to control the associated devices. The connection is established locally, so the client must be run on the same network as the gateway. Currently, the only tested and supported devices are radio shutters (Mobilus COSMO 2WAY).
+
+In order to use the client, configuration and setup need to be done on the Mobilus Cosmo GTW side. This includes creating a user and pairing the devices with the gateway.
+
+More information can be found on [blog post](https://codegyver.com/2024/09/22/mobilus-cosmo-gtw-reverse-engineering-a-radio-shutter-device/).
+
+## Installation
+
+Install the module with pip:
+
+    pip install mobilus-client
+
+## Usage
+
+For convenience, the client can be run as a module:
+
+    python -m mobilus_client --host=GATEWAY_HOST --login=USER_LOGIN --password=USER_PASSWORD COMMANDS
+
+Where:
+
+* `GATEWAY_HOST` is the IP address of the gateway.
+* `USER_LOGIN` and `USER_PASSWORD` are the user credentials to access the gateway.
+* `COMMANDS` is a list of commands to be sent to the gateway.
+
+Currently, the following commands are supported:
+
+* `current_state` - Get the current state of the devices. Please note that in the case of shutters, this doesn't return any meaningful data.
+
+* `devices_list` - List all devices that are paired with the gateway.
+
+* `call_events:device_id=DEVICE_ID,value=VALUE` - Send a command to the device. This can be used for actual control of the device (shutter).
+
+    * `DEVICE_ID` - The ID of the device as returned from devices_list.
+    * `VALUE` - The value to be sent to the device, currently one of "UP", "DOWN", "STOP", or a percentage value like "85%".
+
+Multiple commands can be sent at once, separated by spaces:
+
+    python -m mobilus_client --host=192.168.2.1 --login=admin --password=my_password devices_list call_events:device_id=0,value=100% call_events:device_id=1,value=80%
+
+Output is printed to the console in JSON format, and therefore the client command can be easily chained with `jq` for prettier output. For example:
+
+    python -m mobilus_client --host=192.168.2.1 --login=admin --password=my_password current_state | jq
+
+Verbose mode can be enabled with the `--verbose` flag:
+
+    python -m mobilus_client --host=192.168.2.1 --login=admin --password=my_password --verbose current_state
+
+## Caveats
+
+The client is tested with Mobilus Cosmo GTW with shutter devices only (COSMO 2WAY). It is possible that it will work with other devices, but it is not guaranteed. The purpose of the client is to provide a simple way to control the devices without the need to use the official Mobilus Cosmo GTW web interface or app, and to integrate it with open-source systems like Home Assistant. I am not affiliated with Mobilus, and the client is provided as is.
+
+## Development
+
+Clone the repository and navigate to the project directory.
+Install the package in editable mode with the following command:
+
+    pip install -e .[test]
+
+Check mypy and flake8 with the following commands:
+
+    mypy .
+    flake8 .
+
+The tests can be run with the following command:
+
+    python -m unittest -v
+
+To generate a coverage report:
+
+    coverage run -m unittest discover
+    coverage report

mobilus_client-0.1.0/mobilus_client/__main__.py

@@ -0,0 +1,60 @@
+import argparse
+import logging
+import sys
+from typing import Tuple, Dict
+from mobilus_client.config import Config
+from mobilus_client.app import App
+
+logger = logging.getLogger(__name__)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        description="Run Mobilus Client with specific commands and parameters."
+    )
+    parser.add_argument('--host', required=True, help="Cosmo GTW address")
+    parser.add_argument('--login', required=True, help="User login")
+    parser.add_argument('--password', required=True, help="User password")
+    parser.add_argument('--verbose', action='store_true', help="Enable verbose logging")
+    parser.add_argument('commands', nargs='+', help="Commands to run")
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    # Create a config object
+    config = Config(
+        gateway_host=args.host,
+        user_login=args.login,
+        user_password=args.password,
+    )
+
+    # Set up logging
+    logging.basicConfig(
+        stream=sys.stdout,
+        level=logging.DEBUG if args.verbose else logging.WARNING,
+        format='{"name": "[%(name)s]", "levelname": "%(levelname)s", "message": "%(message)s"}'
+    )
+
+    commands = []
+    for command_str in args.commands:
+        command, params = _parse_command(command_str)
+        commands.append((command, params))
+
+    app = App(config)
+    responses = app.call(commands)
+    print(responses)
+
+
+def _parse_command(command_str: str) -> Tuple[str, Dict[str, str]]:
+    """
+    " Parse a command string into a command and a dictionary of parameters. "
+    " Example: 'command:param1=value1,param2=value2' "
+    " Returns: ('command', {'param1': 'value1', 'param2': 'value2'}) "
+    """
+    command, *params = command_str.split(':', 1)
+    params_dict = dict(param.split('=') for param in params[0].split(',')) if params else {}
+    return command, params_dict
+
+
+if __name__ == '__main__':
+    main()

mobilus_client-0.1.0/mobilus_client/app.py

@@ -0,0 +1,63 @@
+import logging
+import socket
+from typing import Dict, List, Tuple
+from mobilus_client.config import Config
+from mobilus_client.messages.serializer import MessageSerializer
+from mobilus_client.mqtt_client import MqttClient
+from mobilus_client.registries.message import MessageRegistry
+from mobilus_client.registries.key import KeyRegistry
+
+logger = logging.getLogger(__name__)
+
+
+class App:
+    def __init__(self, config: Config) -> None:
+        self.config = config
+        self.message_registry = MessageRegistry()
+        self.key_registry = KeyRegistry(config.user_key)
+        self.client = MqttClient(
+            client_id=config.client_id,
+            transport=config.gateway_protocol,
+            userdata={
+                "config": config,
+                "key_registry": self.key_registry,
+                "message_registry": self.message_registry,
+            }
+        )
+
+    def call(self, commands: List[Tuple[str, Dict[str, str]]]) -> str:
+        if not commands:
+            return self._empty_response()
+
+        try:
+            # Connect to the MQTT broker and start the loop
+            self.client.connect(self.config.gateway_host, self.config.gateway_port, 60)
+            self.client.loop_start()
+
+            # Wait for the client to authenticate
+            self.client.authenticated_event.wait(timeout=self.config.auth_timeout_period)
+
+            if not self.client.authenticated_event.is_set():
+                logger.error("Failed to authenticate with the gateway host")
+                return self._empty_response()
+
+            # Execute the provided commands
+            for command, params in commands:
+                self.client.send_request(command, **params)
+
+            # Wait for the completion event to be triggered
+            self.client.completed_event.wait(timeout=self.config.timeout_period)
+        except socket.gaierror:
+            logger.error("Failed to connect to the gateway host")
+        except TimeoutError:
+            logger.error("Timeout occurred")
+        finally:
+            self.client.disconnect()
+
+        # Return serialized responses from the message registry
+        return MessageSerializer.serialize_list_to_json(
+            self.message_registry.get_responses()
+        )
+
+    def _empty_response(self) -> str:
+        return MessageSerializer.serialize_list_to_json([])

mobilus_client-0.1.0/mobilus_client/config.py

@@ -0,0 +1,20 @@
+import random
+from dataclasses import dataclass
+from mobilus_client.utils.encryption import create_key
+
+
+@dataclass
+class Config:
+    gateway_host: str
+    user_login: str
+    user_password: str
+
+    auth_timeout_period: float = 30
+    client_id: str = ''.join(random.choice('0123456789ABCDEF') for _ in range(12))
+    gateway_port: int = 8884
+    gateway_protocol: str = "websockets"
+    timeout_period: float = 30
+    user_key: bytes = b''
+
+    def __post_init__(self) -> None:
+        self.user_key = create_key(self.user_password)

mobilus_client-0.1.0/mobilus_client/messages/encryptor.py

@@ -0,0 +1,88 @@
+import struct
+import time
+from google.protobuf.message import DecodeError
+from typing import cast, Optional
+from mobilus_client.registries.key import KeyRegistry
+from mobilus_client.proto import (
+    CallEventsRequest,
+    CurrentStateRequest,
+    CurrentStateResponse,
+    DevicesListRequest,
+    DevicesListResponse,
+    LoginRequest,
+    LoginResponse
+)
+from mobilus_client.utils.encryption import create_iv, decrypt_body, encrypt_body
+from mobilus_client.utils.types import MessageRequest, MessageResponse
+
+
+class MessageEncryptor:
+    CATEGORY_MAP = {
+        1: LoginRequest,
+        2: LoginResponse,
+        3: DevicesListRequest,
+        4: DevicesListResponse,
+        13: CallEventsRequest,
+        26: CurrentStateRequest,
+        27: CurrentStateResponse,
+    }
+    CLASS_TO_CATEGORY_MAP = {v: k for k, v in CATEGORY_MAP.items()}
+
+    @staticmethod
+    def encrypt(message: MessageRequest, client_id: str, key_registry: KeyRegistry) -> bytes:
+        category = MessageEncryptor.CLASS_TO_CATEGORY_MAP.get(type(message))
+        body = message.SerializeToString()
+        timestamp = int(time.time())
+        length = 13
+
+        private_key = key_registry.get_encryption_key(type(message))
+
+        if private_key is None:
+            encrypted_body = body
+        else:
+            iv = create_iv(timestamp)
+            encrypted_body = encrypt_body(private_key, iv, body)
+
+        return (
+            struct.pack('>IBI', length, category, timestamp) +
+            bytes.fromhex(client_id) +
+            struct.pack('>2B', 4, 0) +
+            encrypted_body
+        )
+
+    @staticmethod
+    def decrypt(encrypted_message: bytes, key_registry: KeyRegistry) -> Optional[MessageResponse]:
+        # Define header format and calculate size
+        header_format = '>IBI6sBB'
+        header_size = struct.calcsize(header_format)
+
+        # Do early return if message is too short
+        if len(encrypted_message) < header_size:
+            return None
+
+        # Unpack header
+        length, category, timestamp, user_id, platform, response_code = struct.unpack(
+            header_format, encrypted_message[:header_size])
+
+        # Extract encrypted body
+        encrypted_body = encrypted_message[header_size:]
+
+        # Choose proper klass
+        message_klass = MessageEncryptor.CATEGORY_MAP.get(category)
+        if message_klass is None:
+            return None
+
+        # Choose proper decryption key
+        key = key_registry.get_decryption_key(message_klass)
+
+        # Decrypt body
+        iv = create_iv(timestamp)
+        body = decrypt_body(key, iv, encrypted_body)
+
+        try:
+            message = cast(MessageResponse, message_klass())
+            message.ParseFromString(body)
+        except DecodeError:
+            return None
+
+        return message

mobilus_client-0.1.0/mobilus_client/messages/factory.py

@@ -0,0 +1,66 @@
+from abc import ABC, abstractmethod
+from typing import Any, Optional
+from mobilus_client.proto import (
+    CallEvent,
+    CallEventsRequest,
+    CurrentStateRequest,
+    DevicesListRequest,
+    LoginRequest,
+)
+from mobilus_client.utils.types import MessageRequest
+
+
+class MessageBuilder(ABC):
+    @abstractmethod
+    def build(self, **kwargs: Any) -> Optional[MessageRequest]:
+        pass
+
+
+class LoginMessageBuilder(MessageBuilder):
+    def build(self, **kwargs: Any) -> Optional[LoginRequest]:
+        if 'login' not in kwargs or 'password' not in kwargs:
+            return None
+
+        request = LoginRequest()
+        request.login = str(kwargs['login'])
+        request.password = bytes(kwargs['password'])
+        return request
+
+
+class DevicesListMessageBuilder(MessageBuilder):
+    def build(self, **kwargs: Any) -> DevicesListRequest:
+        return DevicesListRequest()
+
+
+class CurrentStateMessageBuilder(MessageBuilder):
+    def build(self, **kwargs: Any) -> CurrentStateRequest:
+        return CurrentStateRequest()
+
+
+class CallEventsMessageBuilder(MessageBuilder):
+    def build(self, **kwargs: Any) -> Optional[CallEventsRequest]:
+        if 'device_id' not in kwargs or 'value' not in kwargs:
+            return None
+
+        event = CallEvent()
+        event.event_number = int(kwargs.get('event_number', 6))
+        event.device_id = int(kwargs['device_id'])
+        event.value = str(kwargs['value'])
+
+        request = CallEventsRequest()
+        request.events.append(event)
+        return request
+
+
+class MessageFactory:
+    _builders = {
+        "call_events": CallEventsMessageBuilder(),
+        "current_state": CurrentStateMessageBuilder(),
+        "devices_list": DevicesListMessageBuilder(),
+        "login": LoginMessageBuilder(),
+    }
+
+    @staticmethod
+    def create_message(message_name: str, **kwargs: Any) -> Optional[MessageRequest]:
+        builder = MessageFactory._builders.get(message_name)
+        return builder.build(**kwargs) if builder else None

mobilus_client-0.1.0/mobilus_client/messages/serializer.py

@@ -0,0 +1,20 @@
+import json
+from google.protobuf.json_format import MessageToJson
+from mobilus_client.utils.types import MessageResponse
+
+
+class MessageSerializer:
+    @staticmethod
+    def serialize_to_json(message: MessageResponse) -> str:
+        return MessageToJson(message)
+
+    @staticmethod
+    def serialize_list_to_json(messages: list[MessageResponse]) -> str:
+        return json.dumps(
+            [
+                json.loads(
+                    MessageSerializer.serialize_to_json(message)
+                )
+                for message in messages
+            ]
+        )

mobilus_client-0.1.0/mobilus_client/messages/status.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class MessageStatus(Enum):
+    SUCCESS = 0
+    AUTHENTICATION_ERROR = 1
+    UNKNOWN_MESSAGE = 2

mobilus_client-0.1.0/mobilus_client/messages/validator.py

@@ -0,0 +1,16 @@
+from typing import Optional, Union
+from mobilus_client.messages.status import MessageStatus
+from mobilus_client.proto import LoginResponse
+from mobilus_client.utils.types import MessageRequest, MessageResponse
+
+
+class MessageValidator():
+    @staticmethod
+    def validate(message: Optional[Union[MessageRequest, MessageResponse]]) -> MessageStatus:
+        if message is None:
+            return MessageStatus.UNKNOWN_MESSAGE
+
+        if isinstance(message, LoginResponse) and message.login_status == 1:
+            return MessageStatus.AUTHENTICATION_ERROR
+
+        return MessageStatus.SUCCESS

mobilus_client-0.1.0/mobilus_client/mqtt_client.py

@@ -0,0 +1,87 @@
+import logging
+import paho.mqtt.client as mqtt
+import threading
+from typing import Any, Dict, cast
+from mobilus_client.messages.encryptor import MessageEncryptor
+from mobilus_client.messages.factory import MessageFactory
+from mobilus_client.messages.status import MessageStatus
+from mobilus_client.messages.validator import MessageValidator
+from mobilus_client.proto import (LoginRequest, LoginResponse)
+from mobilus_client.utils.types import MessageRequest
+
+
+logger = logging.getLogger(__name__)
+
+
+class MqttClient(mqtt.Client):
+    _userdata: Dict[str, Any]
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.authenticated_event = threading.Event()
+        self.completed_event = threading.Event()
+        self.enable_logger(logger)
+
+    def send_request(self, command: str, **params: Any) -> None:
+        if not self.is_connected():
+            logger.error(f"Sending request - {command} failed. Client is not connected.")
+            return
+
+        message = MessageFactory.create_message(command, **params)
+        status = MessageValidator.validate(message)
+
+        if status != MessageStatus.SUCCESS:
+            logger.error(f"Command - {command} returned an error - {status.name}")
+            self.disconnect()
+            return
+
+        if not isinstance(message, LoginRequest):
+            self._userdata['message_registry'].register_request(message)
+
+        encrypted_message = MessageEncryptor.encrypt(
+            cast(MessageRequest, message),
+            self._userdata["config"].client_id,
+            self._userdata['key_registry']
+        )
+
+        self.publish("module", encrypted_message)
+
+    def on_disconnect(self, client: mqtt.Client, userdata: Any, reason_code: Any) -> None:  # type: ignore
+        logger.info(f"Disconnected with result code - {reason_code}")
+
+    def on_connect(self, client: mqtt.Client, userdata: Any, flags: Any, reason_code: Any) -> None:  # type: ignore
+        client.subscribe([
+            (userdata["config"].client_id, 0),
+            ("clients", 0)
+        ])
+
+    def on_subscribe(self, client: mqtt.Client, userdata: Any, mid: Any, granted_qos: Any) -> None:  # type: ignore
+        self.send_request(
+            "login",
+            login=userdata["config"].user_login,
+            password=userdata["config"].user_key
+        )
+
+    def on_message(self, client: mqtt.Client, userdata: Any, message: Any) -> None:  # type: ignore
+        logger.info(f"Received message on topic - {message.topic}")
+
+        message = MessageEncryptor.decrypt(message.payload, userdata["key_registry"])
+        logger.info(f"Decrypted message - {type(message).__name__}")
+
+        status = MessageValidator.validate(message)
+
+        if status != MessageStatus.SUCCESS:
+            logger.error(f"Message - {type(message).__name__} returned an error - {status.name}")
+            self.disconnect()
+            return
+
+        logger.info(f"Message - {type(message).__name__} validated successfully")
+
+        if isinstance(message, LoginResponse):
+            userdata["key_registry"].register_keys(message)
+            self.authenticated_event.set()
+        else:
+            userdata["message_registry"].register_response(message)
+
+            if userdata["message_registry"].all_responses_received():
+                self.completed_event.set()