pyg90alarm 1.15.1__tar.gz → 1.15.2__tar.gz

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.15.1
+Version: 1.15.2
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/src/pyg90alarm/alarm.py

@@ -60,7 +60,8 @@ from .const import (
     G90Commands, REMOTE_PORT,
     REMOTE_TARGETED_DISCOVERY_PORT,
     LOCAL_TARGETED_DISCOVERY_PORT,
-    NOTIFICATIONS_PORT,
+    LOCAL_NOTIFICATIONS_HOST,
+    LOCAL_NOTIFICATIONS_PORT,
     G90ArmDisarmTypes,
 )
 from .base_cmd import (G90BaseCommand, G90BaseCommandData)
@@ -140,11 +141,14 @@ class G90Alarm(G90DeviceNotifications):
     # pylint: disable=too-many-instance-attributes,too-many-arguments
     def __init__(self, host: str, port: int = REMOTE_PORT,
                  reset_occupancy_interval: float = 3.0,
-                 notifications_host: str = '0.0.0.0',
-                 notifications_port: int = NOTIFICATIONS_PORT):
-        super().__init__(host=notifications_host, port=notifications_port)
-        self._host = host
-        self._port = port
+                 notifications_local_host: str = LOCAL_NOTIFICATIONS_HOST,
+                 notifications_local_port: int = LOCAL_NOTIFICATIONS_PORT):
+        super().__init__(
+            local_host=notifications_local_host,
+            local_port=notifications_local_port
+        )
+        self._host: str = host
+        self._port: int = port
         self._sensors: List[G90Sensor] = []
         self._devices: List[G90Device] = []
         self._notifications: Optional[G90DeviceNotifications] = None
@@ -336,7 +340,9 @@ class G90Alarm(G90DeviceNotifications):
         :return: Device information
         """
         res = await self.command(G90Commands.GETHOSTINFO)
-        return G90HostInfo(*res)
+        info = G90HostInfo(*res)
+        self.device_id = info.host_guid
+        return info
 
     @property
     async def host_status(self) -> G90HostStatus:
@@ -813,7 +819,7 @@ class G90Alarm(G90DeviceNotifications):
                         # code as alert, as if it came from the device and its
                         # notifications port
                         self._handle_alert(
-                            (self._host, self._notifications_port),
+                            (self._host, self._notifications_local_port),
                             item.as_device_alert()
                         )
 

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/src/pyg90alarm/const.py

@@ -28,7 +28,8 @@ from typing import Optional
 REMOTE_PORT = 12368
 REMOTE_TARGETED_DISCOVERY_PORT = 12900
 LOCAL_TARGETED_DISCOVERY_PORT = 12901
-NOTIFICATIONS_PORT = 12901
+LOCAL_NOTIFICATIONS_HOST = '0.0.0.0'
+LOCAL_NOTIFICATIONS_PORT = 12901
 
 CMD_PAGE_SIZE = 10
 

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/src/pyg90alarm/device_notifications.py

@@ -41,7 +41,6 @@ from .const import (
     G90AlertStates,
 )
 
-
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -107,12 +106,29 @@ class G90DeviceAlert:  # pylint: disable=too-many-instance-attributes
 class G90DeviceNotifications(DatagramProtocol):
     """
     Implements support for notifications/alerts sent by alarm panel.
+
+    There is a basic check to ensure only notifications/alerts from the correct
+    device are processed - the check uses the host and port of the device, and
+    the device ID (GUID) that is set by the ancestor class that implements the
+    commands (e.g. :class:`G90Alarm`). The latter to work correctly needs a
+    command to be performed first, one that fetches device GUID and then stores
+    it using :attr:`.device_id` (e.g. :meth:`G90Alarm.get_host_info`).
     """
-    def __init__(self, port: int, host: str):
+    def __init__(self, local_port: int, local_host: str):
         # pylint: disable=too-many-arguments
         self._notification_transport: Optional[BaseTransport] = None
-        self._notifications_host = host
-        self._notifications_port = port
+        self._notifications_local_host = local_host
+        self._notifications_local_port = local_port
+        # Host/port of the device is configured to communicating via commands.
+        # Inteded to validate if notifications/alert are received from the
+        # correct device.
+        self._host: Optional[str] = None
+        self._port: Optional[int] = None
+        # Same but for device ID (GUID) - the notifications logic uses it to
+        # perform validation, but doesn't set it from messages received (it
+        # will diminish the purpose of the validation, should be done by an
+        # ancestor class).
+        self._device_id: Optional[str] = None
 
     def _handle_notification(
         self, addr: Tuple[str, int], notification: G90Notification
@@ -145,6 +161,15 @@ class G90DeviceNotifications(DatagramProtocol):
     def _handle_alert(
         self, addr: Tuple[str, int], alert: G90DeviceAlert
     ) -> None:
+        # Stop processing when alert is received from the device with different
+        # GUID
+        if self.device_id and alert.device_id != self.device_id:
+            _LOGGER.error(
+                "Received alert from wrong device: expected '%s', got '%s'",
+                self.device_id, alert.device_id
+            )
+            return
+
         if alert.type == G90AlertTypes.DOOR_OPEN_CLOSE:
             if alert.state in (
                 G90AlertStates.DOOR_OPEN, G90AlertStates.DOOR_CLOSE
@@ -219,10 +244,17 @@ class G90DeviceNotifications(DatagramProtocol):
     def datagram_received(  # pylint:disable=R0911
         self, data: bytes, addr: Tuple[str, int]
     ) -> None:
-
         """
-        Invoked from datagram is received from the device.
+        Invoked when datagram is received from the device.
         """
+        if self._host and self._host != addr[0]:
+            _LOGGER.error(
+                "Received notification/alert from wrong host '%s',"
+                " expected from '%s'",
+                addr[0], self._host
+            )
+            return
+
         s_data = data.decode('utf-8')
         if not s_data.endswith('\0'):
             _LOGGER.error('Missing end marker in data')
@@ -304,13 +336,13 @@ class G90DeviceNotifications(DatagramProtocol):
             loop = asyncio.get_event_loop()
 
         _LOGGER.debug('Creating UDP endpoint for %s:%s',
-                      self._notifications_host,
-                      self._notifications_port)
+                      self._notifications_local_host,
+                      self._notifications_local_port)
         (self._notification_transport,
          _protocol) = await loop.create_datagram_endpoint(
             lambda: self,
             local_addr=(
-                self._notifications_host, self._notifications_port
+                self._notifications_local_host, self._notifications_local_port
             ))
 
     @property
@@ -328,3 +360,17 @@ class G90DeviceNotifications(DatagramProtocol):
             _LOGGER.debug('No longer listening for device notifications')
             self._notification_transport.close()
             self._notification_transport = None
+
+    @property
+    def device_id(self) -> Optional[str]:
+        """
+        The ID (GUID) of the panel being communicated with thru commands.
+
+        Available when any panel command receives it from the device
+        (:meth:`G90Alarm.get_host_info` currently).
+        """
+        return self._device_id
+
+    @device_id.setter
+    def device_id(self, device_id: str) -> None:
+        self._device_id = device_id

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/src/pyg90alarm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.15.1
+Version: 1.15.2
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/tests/test_alarm.py

@@ -308,8 +308,8 @@ async def test_sensor_event(mock_device: DeviceMock) -> None:
     reset_interval = 0.5
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
                    reset_occupancy_interval=reset_interval,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
 
     sensors = await g90.get_sensors()
     prop_sensors = await g90.sensors
@@ -352,8 +352,8 @@ async def test_sensor_low_battery_event(mock_device: DeviceMock) -> None:
     Tests for sensor low battery callback.
     """
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
 
     sensors = await g90.get_sensors()
     prop_sensors = await g90.sensors
@@ -401,8 +401,8 @@ async def test_armdisarm_callback(mock_device: DeviceMock) -> None:
     armdisarm_cb = MagicMock()
     armdisarm_cb.side_effect = lambda *args: future.set_result(True)
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
     g90.armdisarm_callback = armdisarm_cb
     await g90.listen_device_notifications()
     await mock_device.send_next_notification()
@@ -434,8 +434,8 @@ async def test_door_open_close_callback(mock_device: DeviceMock) -> None:
     door_open_close_cb.side_effect = lambda *args: future.set_result(True)
 
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
     g90.door_open_close_callback = door_open_close_cb
 
     # Simulate two device alerts - for opening (this one) and then closing the
@@ -492,8 +492,8 @@ async def test_alarm_callback(mock_device: DeviceMock) -> None:
     alarm_cb.side_effect = lambda *args: future.set_result(True)
 
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
     sensors = await g90.get_sensors()
     # Set extra data for the 1st sensor
     sensors[0].extra_data = 'Dummy extra data'
@@ -753,8 +753,8 @@ async def test_sms_alert_when_armed(mock_device: DeviceMock) -> None:
     armdisarm_cb = MagicMock()
     armdisarm_cb.side_effect = lambda *args: future.set_result(True)
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
     g90.armdisarm_callback = armdisarm_cb
     g90.sms_alert_when_armed = True
     await g90.listen_device_notifications()
@@ -787,8 +787,8 @@ async def test_sms_alert_when_disarmed(mock_device: DeviceMock) -> None:
     armdisarm_cb = MagicMock()
     armdisarm_cb.side_effect = lambda *args: future.set_result(True)
     g90 = G90Alarm(host=mock_device.host, port=mock_device.port,
-                   notifications_host=mock_device.notification_host,
-                   notifications_port=mock_device.notification_port)
+                   notifications_local_host=mock_device.notification_host,
+                   notifications_local_port=mock_device.notification_port)
     g90.armdisarm_callback = armdisarm_cb
     g90.sms_alert_when_armed = True
     await g90.listen_device_notifications()

{pyg90alarm-1.15.1 → pyg90alarm-1.15.2}/tests/test_notifications.py

@@ -10,6 +10,7 @@ from pytest import LogCaptureFixture
 from pyg90alarm.device_notifications import (
     G90DeviceNotifications,
 )
+from pyg90alarm.alarm import G90Alarm
 
 from .device_mock import DeviceMock
 
@@ -24,7 +25,8 @@ async def test_device_notification_missing_header(
     Verifies that missing header in device notification is handled correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     caplog.set_level('ERROR')
     await notifications.listen()
@@ -49,7 +51,8 @@ async def test_device_notification_malformed_message(
     correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     caplog.set_level('ERROR')
     await notifications.listen()
@@ -72,7 +75,8 @@ async def test_device_notification_missing_end_marker(
     correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     caplog.set_level('ERROR')
     await notifications.listen()
@@ -91,7 +95,8 @@ async def test_wrong_device_notification_format(
     Verifies that wrong device notification format is handled correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     caplog.set_level('ERROR')
     await notifications.listen()
@@ -114,7 +119,8 @@ async def test_wrong_device_alert_format(
     Verifies that wrong device alert format is handled correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
 
     caplog.set_level('ERROR')
@@ -140,7 +146,8 @@ async def test_unknown_device_notification(
     Verifies that unknown device notification is handled correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     caplog.set_level('WARNING')
     await notifications.listen()
@@ -164,7 +171,8 @@ async def test_unknown_device_alert(
     Verifies that unknown device alert is handled correctly.
     """
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     caplog.set_level('WARNING')
     await notifications.listen()
@@ -179,6 +187,79 @@ async def test_unknown_device_alert(
     notifications.close()
 
 
+@pytest.mark.g90device(notification_data=[
+    b'[208,[999,100,1,1,"Hall","DUMMYGUID",'
+    b'1631545189,0,[""]]]\0',
+])
+async def test_wrong_host(
+    mock_device: DeviceMock, caplog: LogCaptureFixture
+) -> None:
+    """
+    Verifies that unknown device alert is handled correctly.
+    """
+    g90 = G90Alarm(
+        host='1.2.3.4',
+        notifications_local_host=mock_device.notification_host,
+        notifications_local_port=mock_device.notification_port
+    )
+    # pylint: disable=protected-access
+    g90._handle_alert = (  # type: ignore[method-assign]
+        MagicMock()
+    )
+    # pylint: disable=protected-access
+    g90._handle_notification = (  # type: ignore[method-assign]
+        MagicMock()
+    )
+    caplog.set_level('WARNING')
+    await g90.listen()
+    await mock_device.send_next_notification()
+    assert ''.join(caplog.messages) == (
+        "Received notification/alert from wrong host '127.0.0.1'"
+        ", expected from '1.2.3.4'"
+    )
+    g90.close()
+    # pylint: disable=protected-access
+    g90._handle_alert.assert_not_called()
+    # pylint: disable=protected-access
+    g90._handle_notification.assert_not_called()
+
+
+@pytest.mark.g90device(
+    sent_data=[
+        b'ISTART[206,'
+        b'["DUMMYGUID","DUMMYPRODUCT",'
+        b'"1.2","1.1","206","206",3,3,0,2,"4242",50,100]]IEND\0',
+    ],
+    notification_data=[
+        b'[208,[2,4,0,0,"","DIFFERENTGUID",1630876128,0,[""]]]\0'
+    ],
+)
+async def test_wrong_device_guid(
+    mock_device: DeviceMock, caplog: LogCaptureFixture
+) -> None:
+    """
+    Verifies that alert from device with different GUID is ignored.
+    """
+    g90 = G90Alarm(
+        host=mock_device.host, port=mock_device.port,
+        notifications_local_host=mock_device.notification_host,
+        notifications_local_port=mock_device.notification_port
+    )
+    caplog.set_level('WARNING')
+    # The command will fetch the host info and store the GIUD
+    await g90.get_host_info()
+    g90.on_armdisarm = MagicMock()  # type: ignore[method-assign]
+    await g90.listen()
+    await mock_device.send_next_notification()
+    assert ''.join(caplog.messages) == (
+        "Received alert from wrong device: expected 'DUMMYGUID'"
+        ", got 'DIFFERENTGUID'"
+    )
+    g90.close()
+    # Verify the associated callback was not called
+    g90.on_armdisarm.assert_not_called()
+
+
 @pytest.mark.g90device(notification_data=[
     b'[170,[5,[100,"Hall"]]]\0',
 ])
@@ -188,8 +269,8 @@ async def test_sensor_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host,
-        port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port,
     )
 
     notifications.on_sensor_activity = (  # type: ignore[method-assign]
@@ -216,7 +297,8 @@ async def test_armdisarm_notification_callback(
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     notifications.on_armdisarm = MagicMock()  # type: ignore[method-assign]
     notifications.on_armdisarm.side_effect = (
@@ -238,7 +320,8 @@ async def test_armdisarm_alert_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     notifications.on_armdisarm = MagicMock()  # type: ignore[method-assign]
     notifications.on_armdisarm.side_effect = (
@@ -260,7 +343,8 @@ async def test_door_open_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
 
     notifications.on_door_open_close = (  # type: ignore[method-assign]
@@ -285,7 +369,8 @@ async def test_door_close_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
 
     notifications.on_door_open_close = (  # type: ignore[method-assign]
@@ -312,7 +397,8 @@ async def test_doorbell_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
 
     notifications.on_door_open_close = (  # type: ignore[method-assign]
@@ -339,7 +425,8 @@ async def test_alarm_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     notifications.on_alarm = MagicMock()  # type: ignore[method-assign]
     notifications.on_alarm.side_effect = (
@@ -361,7 +448,8 @@ async def test_low_battery_callback(mock_device: DeviceMock) -> None:
     """
     future = asyncio.get_running_loop().create_future()
     notifications = G90DeviceNotifications(
-        host=mock_device.notification_host, port=mock_device.notification_port,
+        local_host=mock_device.notification_host,
+        local_port=mock_device.notification_port
     )
     notifications.on_low_battery = MagicMock()  # type: ignore[method-assign]
     notifications.on_low_battery.side_effect = (