mirror of
https://github.com/python-kasa/python-kasa.git
synced 2026-10-08 13:53:53 +00:00
53823ea9a5
A `credentials_hash` is specific to the transport that produced it, but nothing checked that the hash a transport was handed was its own. This matters because a device can change its encryption type without the credentials changing. For example, toggling **Third-Party Compatibility** in the Tapo app moves a plug or strip between TPAP and KLAP, and firmware updates are known to introduce new transports. This introduces a per-transport check that the hash has the shape that transport produces, and treats a foreign hash as absent rather than as a bad password. This makes the failure honest but still ends in a reauth. This also changes how credentials are read back out when the hash is one of the plaintext forms and lets the transport derive its own, so the change of encryption type needs no reauth in all cases.
78 lines
2.4 KiB
Python
78 lines
2.4 KiB
Python
"""Base class for all transport implementations.
|
|
|
|
All transport classes must derive from this to implement the common interface.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import TYPE_CHECKING
|
|
|
|
from kasa.credentials import Credentials
|
|
|
|
if TYPE_CHECKING:
|
|
from kasa import DeviceConfig
|
|
|
|
|
|
class BaseTransport(ABC):
|
|
"""Base class for all TP-Link protocol transports."""
|
|
|
|
DEFAULT_TIMEOUT = 5
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
config: DeviceConfig,
|
|
) -> None:
|
|
"""Create a protocol object."""
|
|
self._config = config
|
|
self._host = config.host
|
|
self._port = config.port_override or self.default_port
|
|
self._credentials = config.credentials
|
|
self._credentials_hash = config.credentials_hash
|
|
if self._credentials_hash and not self.is_transport_credentials_hash(
|
|
self._credentials_hash
|
|
):
|
|
# A hash another transport produced is not a bad password, so drop
|
|
# it, recovering the credentials from it first if it holds them.
|
|
if not self._credentials:
|
|
self._credentials = Credentials._from_plaintext_hash(
|
|
self._credentials_hash
|
|
)
|
|
self._credentials_hash = None
|
|
if not config.timeout:
|
|
config.timeout = self.DEFAULT_TIMEOUT
|
|
self._timeout = config.timeout
|
|
|
|
@property
|
|
@abstractmethod
|
|
def default_port(self) -> int:
|
|
"""The default port for the transport."""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def credentials_hash(self) -> str | None:
|
|
"""The hashed credentials used by the transport."""
|
|
|
|
@classmethod
|
|
def is_transport_credentials_hash(cls, credentials_hash: str) -> bool:
|
|
"""Whether the hash has the shape this transport produces.
|
|
|
|
A device can change its encryption type without the credentials
|
|
changing, so a stored hash may be one that another transport wrote.
|
|
Transports that can recognise their own hashes override this.
|
|
"""
|
|
return True
|
|
|
|
@abstractmethod
|
|
async def send(self, request: str) -> dict:
|
|
"""Send a message to the device and return a response."""
|
|
|
|
@abstractmethod
|
|
async def close(self) -> None:
|
|
"""Close the transport. Abstract method to be overriden."""
|
|
|
|
@abstractmethod
|
|
async def reset(self) -> None:
|
|
"""Reset internal state."""
|