Add LinkieTransportV2 and basic IOT.IPCAMERA support #1270
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| """Module for cameras.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
| from datetime import datetime, tzinfo | ||
|
|
||
| from ..device_type import DeviceType | ||
| from ..deviceconfig import DeviceConfig | ||
| from ..protocols import BaseProtocol | ||
| from .iotdevice import IotDevice | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class IotCamera(IotDevice): | ||
| """Representation of a TP-Link Camera.""" | ||
|
|
||
| def __init__( | ||
| self, | ||
| host: str, | ||
| *, | ||
| config: DeviceConfig | None = None, | ||
| protocol: BaseProtocol | None = None, | ||
| ) -> None: | ||
| super().__init__(host=host, config=config, protocol=protocol) | ||
| self._device_type = DeviceType.Camera | ||
|
|
||
| @property | ||
| def time(self) -> datetime: | ||
| """Get the camera's time.""" | ||
| return datetime.fromtimestamp(self.sys_info["system_time"]) | ||
|
|
||
| @property | ||
| def timezone(self) -> tzinfo: | ||
| """Get the camera's timezone.""" | ||
| return None # type: ignore | ||
|
|
||
| @property # type: ignore | ||
| def is_on(self) -> bool: | ||
| """Return whether device is on.""" | ||
| return True | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| """Implementation of the linkie kasa camera transport.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import asyncio | ||
| import base64 | ||
| import logging | ||
| import ssl | ||
| from typing import TYPE_CHECKING, cast | ||
| from urllib.parse import quote | ||
|
|
||
| from yarl import URL | ||
|
|
||
| from kasa.credentials import DEFAULT_CREDENTIALS, get_default_credentials | ||
| from kasa.deviceconfig import DeviceConfig | ||
| from kasa.exceptions import KasaException, _RetryableError | ||
| from kasa.httpclient import HttpClient | ||
| from kasa.json import loads as json_loads | ||
| from kasa.transports.xortransport import XorEncryption | ||
|
|
||
| from .basetransport import BaseTransport | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class LinkieTransportV2(BaseTransport): | ||
| """Implementation of the Linkie encryption protocol. | ||
|
|
||
| Linkie is used as the endpoint for TP-Link's camera encryption | ||
| protocol, used by newer firmware versions. | ||
| """ | ||
|
|
||
| DEFAULT_PORT: int = 10443 | ||
| CIPHERS = ":".join( | ||
| [ | ||
| "AES256-GCM-SHA384", | ||
| "AES256-SHA256", | ||
| "AES128-GCM-SHA256", | ||
| "AES128-SHA256", | ||
| "AES256-SHA", | ||
| ] | ||
| ) | ||
|
|
||
| def __init__(self, *, config: DeviceConfig) -> None: | ||
| super().__init__(config=config) | ||
| self._http_client = HttpClient(config) | ||
| self._ssl_context: ssl.SSLContext | None = None | ||
| self._app_url = URL(f"https://{self._host}:{self._port}/data/LINKIE2.json") | ||
|
|
||
| self._headers = { | ||
| "Authorization": f"Basic {self.credentials_hash}", | ||
| "Content-Type": "application/x-www-form-urlencoded", | ||
| } | ||
|
|
||
| @property | ||
| def default_port(self) -> int: | ||
| """Default port for the transport.""" | ||
| return self.DEFAULT_PORT | ||
|
|
||
| @property | ||
| def credentials_hash(self) -> str | None: | ||
| """The hashed credentials used by the transport.""" | ||
| creds = get_default_credentials(DEFAULT_CREDENTIALS["KASACAMERA"]) | ||
| creds_combined = f"{creds.username}:{creds.password}" | ||
| return base64.b64encode(creds_combined.encode()).decode() | ||
Puxtril marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| async def _execute_send(self, request: str) -> dict: | ||
| """Execute a query on the device and wait for the response.""" | ||
| _LOGGER.debug("%s >> %s", self._host, request) | ||
|
|
||
| encrypted_cmd = XorEncryption.encrypt(request)[4:] | ||
| b64_cmd = base64.b64encode(encrypted_cmd).decode() | ||
| url_safe_cmd = quote(b64_cmd, safe="!~*'()") | ||
|
|
||
| status_code, response = await self._http_client.post( | ||
| self._app_url, | ||
| headers=self._headers, | ||
| data=f"content={url_safe_cmd}".encode(), | ||
| ssl=await self._get_ssl_context(), | ||
| ) | ||
|
|
||
| if TYPE_CHECKING: | ||
| response = cast(bytes, response) | ||
|
|
||
| if status_code != 200: | ||
| raise KasaException( | ||
| f"{self._host} responded with an unexpected " | ||
| + f"status code {status_code} to passthrough" | ||
| ) | ||
|
|
||
| # Expected response | ||
| try: | ||
| json_payload: dict = json_loads( | ||
| XorEncryption.decrypt(base64.b64decode(response)) | ||
| ) | ||
| _LOGGER.debug("%s << %s", self._host, json_payload) | ||
| return json_payload | ||
| except Exception: # noqa: S110 | ||
| pass | ||
|
|
||
| # Device returned error as json plaintext | ||
| to_raise: KasaException | None = None | ||
| try: | ||
| error_payload: dict = json_loads(response) | ||
| to_raise = KasaException(f"Device {self._host} send error: {error_payload}") | ||
| except Exception as ex: | ||
| raise KasaException("Unable to read response") from ex | ||
| raise to_raise | ||
|
|
||
| async def close(self) -> None: | ||
| """Close the http client and reset internal state.""" | ||
| await self._http_client.close() | ||
|
|
||
| async def reset(self) -> None: | ||
| """Reset the transport. | ||
|
|
||
| NOOP for this transport. | ||
| """ | ||
|
|
||
| async def send(self, request: str) -> dict: | ||
| """Send a message to the device and return a response.""" | ||
| try: | ||
| return await self._execute_send(request) | ||
| except Exception as ex: | ||
| await self.reset() | ||
| raise _RetryableError( | ||
| f"Unable to query the device {self._host}:{self._port}: {ex}" | ||
| ) from ex | ||
|
|
||
| async def _get_ssl_context(self) -> ssl.SSLContext: | ||
| if not self._ssl_context: | ||
| loop = asyncio.get_running_loop() | ||
| self._ssl_context = await loop.run_in_executor( | ||
| None, self._create_ssl_context | ||
| ) | ||
| return self._ssl_context | ||
|
|
||
| def _create_ssl_context(self) -> ssl.SSLContext: | ||
| context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) | ||
| context.set_ciphers(self.CIPHERS) | ||
| context.check_hostname = False | ||
| context.verify_mode = ssl.CERT_NONE | ||
| return context | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just realized this changes the permission bits (removing the execute bit), I added a TODO that we will fix this also for other files at some point.