1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
|
"""WsRpc for Shelly."""
from __future__ import annotations
import asyncio
import contextlib
import hashlib
import logging
import socket
import time
from asyncio import Task, tasks
from collections.abc import Callable, Coroutine
from dataclasses import dataclass
from http import HTTPStatus
from typing import TYPE_CHECKING, Any, cast
from aiohttp import (
ClientSession,
ClientWebSocketResponse,
WSMessage,
WSMsgType,
client_exceptions,
)
from aiohttp.web import (
Application,
AppRunner,
BaseRequest,
TCPSite,
WebSocketResponse,
get,
)
from yarl import URL
from ..const import DEFAULT_HTTP_PORT, NOTIFY_WS_CLOSED, WS_API_URL, WS_HEARTBEAT
from ..exceptions import (
ConnectionClosed,
DeviceConnectionError,
InvalidAuthError,
InvalidMessage,
RpcCallError,
)
from ..json import json_dumps, json_loads
_LOGGER = logging.getLogger(__name__)
BUFFER_SIZE = 1024 * 64
def _receive_json_or_raise(msg: WSMessage) -> dict[str, Any]:
"""Receive json or raise."""
if msg.type is WSMsgType.TEXT:
try:
data: dict[str, Any] = msg.json(loads=json_loads)
except ValueError as err:
raise InvalidMessage(f"Received invalid JSON: {msg.data}") from err
return data
if msg.type in (WSMsgType.CLOSE, WSMsgType.CLOSED, WSMsgType.CLOSING):
raise ConnectionClosed("Connection was closed.")
if msg.type is WSMsgType.ERROR:
raise InvalidMessage("Received message error")
raise InvalidMessage(f"Received non-Text message: {msg.type}")
def hex_hash(message: str) -> str:
"""Get hex representation of sha256 hash of string."""
return hashlib.sha256(message.encode("utf-8")).hexdigest()
HA2 = hex_hash("dummy_method:dummy_uri")
@dataclass
class AuthData:
"""RPC Auth data class."""
realm: str
username: str
password: str
def __post_init__(self) -> None:
"""Call after initialization."""
self.ha1 = hex_hash(f"{self.username}:{self.realm}:{self.password}")
def get_auth(self, nonce: int | None = None, n_c: int = 1) -> dict[str, Any]:
"""Get auth for RPC calls."""
cnonce = int(time.time())
if nonce is None:
nonce = cnonce - 1800
# https://shelly-api-docs.shelly.cloud/gen2/Overview/CommonDeviceTraits/#authentication-over-websocket
hashed = hex_hash(f"{self.ha1}:{nonce}:{n_c}:{cnonce}:auth:{HA2}")
return {
"realm": self.realm,
"username": self.username,
"nonce": nonce,
"cnonce": cnonce,
"response": hashed,
"algorithm": "SHA-256",
}
@dataclass
class SessionData:
"""SessionData (src/dst/auth) class."""
src: str | None
dst: str | None
auth: dict[str, Any] | None
class RPCCall:
"""RPCCall class."""
__slots__ = ("auth", "call_id", "params", "method", "src", "dst", "resolve")
def __init__(
self,
call_id: int,
method: str,
params: dict[str, Any] | None,
session: SessionData,
resolve: asyncio.Future[dict[str, Any]],
) -> None:
"""Initialize RPC class."""
self.auth = session.auth
self.call_id = call_id
self.params = params
self.method = method
self.src = session.src
self.dst = session.dst
self.resolve = resolve
@property
def request_frame(self) -> dict[str, Any]:
"""Request frame."""
msg = {
"id": self.call_id,
"method": self.method,
"src": self.src,
}
for obj in ("params", "dst", "auth"):
if getattr(self, obj) is not None:
msg[obj] = getattr(self, obj)
return msg
class WsRPC:
"""WsRPC class."""
def __init__(
self, ip_address: str, on_notification: Callable, port: int = DEFAULT_HTTP_PORT
) -> None:
"""Initialize WsRPC class."""
self._auth_data: AuthData | None = None
self._ip_address = ip_address
self._port = port
self._on_notification = on_notification
self._rx_task: tasks.Task[None] | None = None
self._client: ClientWebSocketResponse | None = None
self._calls: dict[int, RPCCall] = {}
self._call_id = 0
self._session = SessionData(f"aios-{id(self)}", None, None)
self._loop = asyncio.get_running_loop()
self._background_tasks: set[Task] = set()
@property
def _next_id(self) -> int:
self._call_id += 1
return self._call_id
async def connect(self, aiohttp_session: ClientSession) -> None:
"""Connect to device."""
if self.connected:
raise RuntimeError("Already connected")
_LOGGER.debug("Trying to connect to device at %s", self._ip_address)
try:
self._client = await aiohttp_session.ws_connect(
URL.build(
scheme="http", host=self._ip_address, port=self._port, path="/rpc"
),
heartbeat=WS_HEARTBEAT,
)
except (
client_exceptions.WSServerHandshakeError,
client_exceptions.ClientError,
) as err:
raise DeviceConnectionError(err) from err
# Try to reduce the pressure on shelly device as it measures
# ram in bytes and we measure ram in megabytes.
sock: socket.socket = self._client.get_extra_info("socket")
try:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, BUFFER_SIZE)
except OSError as err:
_LOGGER.warning(
"%s:%s: Failed to set socket receive buffer size: %s",
self._ip_address,
self._port,
err,
)
self._rx_task = asyncio.create_task(self._rx_msgs())
_LOGGER.info("Connected to %s", self._ip_address)
async def disconnect(self) -> None:
"""Disconnect all sessions."""
if self._rx_task is not None:
self._rx_task.cancel()
with contextlib.suppress(asyncio.CancelledError):
await self._rx_task
self._rx_task = None
if self._client is None:
return
await self._client.close()
def set_auth_data(self, realm: str, username: str, password: str) -> None:
"""Set authentication data and generate session auth."""
self._auth_data = AuthData(realm, username, password)
self._session.auth = self._auth_data.get_auth()
async def _handle_call(self, frame_id: str) -> None:
if TYPE_CHECKING:
assert self._client
await self._send_json(
{
"id": frame_id,
"src": self._session.src,
"error": {"code": 500, "message": "Not Implemented"},
}
)
def handle_frame(self, frame: dict[str, Any]) -> None:
"""Handle RPC frame."""
if peer_src := frame.get("src"):
if self._session.dst is not None and peer_src != self._session.dst:
_LOGGER.warning(
"Remote src changed: %s -> %s", self._session.dst, peer_src
)
self._session.dst = peer_src
frame_id = frame.get("id")
if method := frame.get("method"):
# peer is invoking a method
params = frame.get("params")
if frame_id:
# and expects a response
_LOGGER.debug("handle call for frame_id: %s", frame_id)
self._create_and_track_task(self._handle_call(frame_id))
else:
# this is a notification
_LOGGER.debug("Notification: %s %s", method, params)
self._on_notification(method, params)
elif frame_id:
# looks like a response
if frame_id not in self._calls:
_LOGGER.warning("Response for an unknown request id: %s", frame_id)
return
call = self._calls.pop(frame_id)
if not call.resolve.cancelled():
call.resolve.set_result(frame)
else:
_LOGGER.warning("Invalid frame: %s", frame)
async def _rx_msgs(self) -> None:
if TYPE_CHECKING:
assert self._client
try:
while not self._client.closed:
try:
msg = await self._client.receive()
frame = _receive_json_or_raise(msg)
_LOGGER.debug(
"recv(%s:%s): %s", self._ip_address, self._port, frame
)
except InvalidMessage as err:
_LOGGER.error(
"Invalid Message from host %s:%s: %s",
self._ip_address,
self._port,
err,
)
except ConnectionClosed:
break
except Exception:
_LOGGER.exception("Unexpected error while receiving message")
raise
if not self._client.closed:
self.handle_frame(frame)
finally:
_LOGGER.debug(
"Websocket client connection from %s:%s closed",
self._ip_address,
self._port,
)
for call_item in self._calls.values():
if not call_item.resolve.done():
call_item.resolve.set_exception(DeviceConnectionError(call_item))
self._calls.clear()
client = self._client
self._client = None
self._on_notification(NOTIFY_WS_CLOSED)
# Close last since the await can yield
# to the event loop and we want to minimize
# race conditions
if not client.closed:
await client.close()
@property
def connected(self) -> bool:
"""Return if we're currently connected."""
return self._client is not None and not self._client.closed
async def call(
self,
method: str,
params: dict[str, Any] | None = None,
timeout: int = 10,
handle_auth: bool = True,
) -> dict[str, Any]:
"""Websocket RPC call."""
# Try request with initial/last call auth data
resp = await self._rpc_call(method, params, timeout)
if "result" in resp:
return cast(dict, resp["result"])
try:
code, msg = resp["error"]["code"], resp["error"]["message"]
except KeyError as err:
raise RpcCallError(0, f"bad response: {resp}") from err
if code != HTTPStatus.UNAUTHORIZED.value:
raise RpcCallError(code, msg)
if not handle_auth or self._auth_data is None:
raise InvalidAuthError(msg)
# Update auth from response and try with new auth data
auth = json_loads(msg)
self._session.auth = self._auth_data.get_auth(auth["nonce"], auth.get("nc", 1))
return await self.call(method, params, timeout, handle_auth=False)
async def _rpc_call(
self, method: str, params: dict[str, Any] | None, timeout: int
) -> dict[str, Any]:
"""Websocket RPC call."""
if self._client is None:
raise RuntimeError("Not connected")
future: asyncio.Future[dict[str, Any]] = self._loop.create_future()
call = RPCCall(self._next_id, method, params, self._session, future)
self._calls[call.call_id] = call
try:
async with asyncio.timeout(timeout):
await self._send_json(call.request_frame)
resp = await future
except TimeoutError as exc:
with contextlib.suppress(asyncio.CancelledError):
future.cancel()
await future
raise DeviceConnectionError(call) from exc
_LOGGER.debug("%s(%s) -> %s", call.method, call.params, resp)
return resp
async def _send_json(self, data: dict[str, Any]) -> None:
"""Send json frame to device."""
_LOGGER.debug("send(%s:%s): %s", self._ip_address, self._port, data)
if TYPE_CHECKING:
assert self._client
await self._client.send_json(data, dumps=json_dumps)
def _create_and_track_task(self, func: Coroutine) -> None:
"""Create and and hold strong reference to the task."""
task = asyncio.create_task(func)
self._background_tasks.add(task)
task.add_done_callback(self._background_tasks.discard)
class WsServer:
"""WsServer class."""
def __init__(self) -> None:
"""Initialize WsServer class."""
self._runner: AppRunner | None = None
self.subscriptions: dict[str, Callable] = {}
async def initialize(self, port: int, api_url: str = WS_API_URL) -> None:
"""Initialize the websocket server, used only in standalone mode."""
app = Application()
app.add_routes([get(api_url, self.websocket_handler)])
self._runner = AppRunner(app)
await self._runner.setup()
site = TCPSite(self._runner, port=port)
await site.start()
def close(self) -> None:
"""Stop the websocket server."""
if self._runner is not None:
loop = asyncio.get_running_loop()
loop.create_task(self._runner.cleanup()) # noqa: RUF006
async def websocket_handler(self, request: BaseRequest) -> WebSocketResponse:
"""Handle connections from sleeping devices."""
ip = request.remote
_LOGGER.debug("Websocket server connection from %s starting", ip)
ws_res = WebSocketResponse(protocols=["json-rpc"])
await ws_res.prepare(request)
_LOGGER.debug("Websocket server connection from %s ready", ip)
async for msg in ws_res:
try:
frame = _receive_json_or_raise(msg)
_LOGGER.debug("recv(%s): %s", ip, frame)
except ConnectionClosed:
await ws_res.close()
except InvalidMessage as err:
_LOGGER.debug("Invalid Message from host %s: %s", ip, err)
else:
try:
device_id = frame["src"].split("-")[1].upper()
except (KeyError, IndexError) as err:
_LOGGER.debug("Invalid device id from host %s: %s", ip, err)
continue
if device_id in self.subscriptions:
_LOGGER.debug(
"Calling WsRPC message update for device id %s", device_id
)
self.subscriptions[device_id](frame)
continue
if ip in self.subscriptions:
_LOGGER.debug("Calling WsRPC message update for host %s", ip)
self.subscriptions[ip](frame)
_LOGGER.debug("Websocket server connection from %s closed", ip)
return ws_res
def subscribe_updates(self, ip: str, message_received: Callable) -> Callable:
"""Subscribe to received updates."""
_LOGGER.debug("Adding device %s to WsServer message subscriptions", ip)
self.subscriptions[ip] = message_received
return lambda: self.subscriptions.pop(ip)
|