555 lines
18 KiB
Python
555 lines
18 KiB
Python
"""HTML5 Push Messaging notification service."""
|
|
from __future__ import annotations
|
|
|
|
from contextlib import suppress
|
|
from datetime import datetime, timedelta
|
|
from functools import partial
|
|
from http import HTTPStatus
|
|
import json
|
|
import logging
|
|
import time
|
|
from urllib.parse import urlparse
|
|
import uuid
|
|
|
|
from aiohttp.hdrs import AUTHORIZATION
|
|
import jwt
|
|
from py_vapid import Vapid
|
|
from pywebpush import WebPusher
|
|
import voluptuous as vol
|
|
from voluptuous.humanize import humanize_error
|
|
|
|
from homeassistant.components import websocket_api
|
|
from homeassistant.components.http import HomeAssistantView
|
|
from homeassistant.components.notify import (
|
|
ATTR_DATA,
|
|
ATTR_TARGET,
|
|
ATTR_TITLE,
|
|
ATTR_TITLE_DEFAULT,
|
|
PLATFORM_SCHEMA,
|
|
BaseNotificationService,
|
|
)
|
|
from homeassistant.const import ATTR_NAME, URL_ROOT
|
|
from homeassistant.core import HomeAssistant, ServiceCall
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.helpers.json import save_json
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
from homeassistant.util import ensure_unique_string
|
|
from homeassistant.util.json import JsonObjectType, load_json_object
|
|
|
|
from .const import DOMAIN, SERVICE_DISMISS
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
REGISTRATIONS_FILE = "html5_push_registrations.conf"
|
|
|
|
ATTR_VAPID_PUB_KEY = "vapid_pub_key"
|
|
ATTR_VAPID_PRV_KEY = "vapid_prv_key"
|
|
ATTR_VAPID_EMAIL = "vapid_email"
|
|
|
|
|
|
def gcm_api_deprecated(value):
|
|
"""Warn user that GCM API config is deprecated."""
|
|
if value:
|
|
_LOGGER.warning(
|
|
"Configuring html5_push_notifications via the GCM api"
|
|
" has been deprecated and stopped working since May 29,"
|
|
" 2019. Use the VAPID configuration instead. For instructions,"
|
|
" see https://www.home-assistant.io/integrations/html5/"
|
|
)
|
|
return value
|
|
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Optional("gcm_sender_id"): vol.All(cv.string, gcm_api_deprecated),
|
|
vol.Optional("gcm_api_key"): cv.string,
|
|
vol.Required(ATTR_VAPID_PUB_KEY): cv.string,
|
|
vol.Required(ATTR_VAPID_PRV_KEY): cv.string,
|
|
vol.Required(ATTR_VAPID_EMAIL): cv.string,
|
|
}
|
|
)
|
|
|
|
ATTR_SUBSCRIPTION = "subscription"
|
|
ATTR_BROWSER = "browser"
|
|
|
|
ATTR_ENDPOINT = "endpoint"
|
|
ATTR_KEYS = "keys"
|
|
ATTR_AUTH = "auth"
|
|
ATTR_P256DH = "p256dh"
|
|
ATTR_EXPIRATIONTIME = "expirationTime"
|
|
|
|
ATTR_TAG = "tag"
|
|
ATTR_ACTION = "action"
|
|
ATTR_ACTIONS = "actions"
|
|
ATTR_TYPE = "type"
|
|
ATTR_URL = "url"
|
|
ATTR_DISMISS = "dismiss"
|
|
ATTR_PRIORITY = "priority"
|
|
DEFAULT_PRIORITY = "normal"
|
|
ATTR_TTL = "ttl"
|
|
DEFAULT_TTL = 86400
|
|
|
|
ATTR_JWT = "jwt"
|
|
|
|
WS_TYPE_APPKEY = "notify/html5/appkey"
|
|
SCHEMA_WS_APPKEY = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
|
{vol.Required("type"): WS_TYPE_APPKEY}
|
|
)
|
|
|
|
# The number of days after the moment a notification is sent that a JWT
|
|
# is valid.
|
|
JWT_VALID_DAYS = 7
|
|
VAPID_CLAIM_VALID_HOURS = 12
|
|
|
|
KEYS_SCHEMA = vol.All(
|
|
dict,
|
|
vol.Schema(
|
|
{vol.Required(ATTR_AUTH): cv.string, vol.Required(ATTR_P256DH): cv.string}
|
|
),
|
|
)
|
|
|
|
SUBSCRIPTION_SCHEMA = vol.All(
|
|
dict,
|
|
vol.Schema(
|
|
{
|
|
vol.Required(ATTR_ENDPOINT): vol.Url(),
|
|
vol.Required(ATTR_KEYS): KEYS_SCHEMA,
|
|
vol.Optional(ATTR_EXPIRATIONTIME): vol.Any(None, cv.positive_int),
|
|
}
|
|
),
|
|
)
|
|
|
|
DISMISS_SERVICE_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(ATTR_DATA): dict,
|
|
}
|
|
)
|
|
|
|
REGISTER_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(ATTR_SUBSCRIPTION): SUBSCRIPTION_SCHEMA,
|
|
vol.Required(ATTR_BROWSER): vol.In(["chrome", "firefox"]),
|
|
vol.Optional(ATTR_NAME): cv.string,
|
|
}
|
|
)
|
|
|
|
CALLBACK_EVENT_PAYLOAD_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(ATTR_TAG): cv.string,
|
|
vol.Required(ATTR_TYPE): vol.In(["received", "clicked", "closed"]),
|
|
vol.Required(ATTR_TARGET): cv.string,
|
|
vol.Optional(ATTR_ACTION): cv.string,
|
|
vol.Optional(ATTR_DATA): dict,
|
|
}
|
|
)
|
|
|
|
NOTIFY_CALLBACK_EVENT = "html5_notification"
|
|
|
|
# Badge and timestamp are Chrome specific (not in official spec)
|
|
HTML5_SHOWNOTIFICATION_PARAMETERS = (
|
|
"actions",
|
|
"badge",
|
|
"body",
|
|
"dir",
|
|
"icon",
|
|
"image",
|
|
"lang",
|
|
"renotify",
|
|
"requireInteraction",
|
|
"tag",
|
|
"timestamp",
|
|
"vibrate",
|
|
)
|
|
|
|
|
|
def get_service(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> HTML5NotificationService | None:
|
|
"""Get the HTML5 push notification service."""
|
|
json_path = hass.config.path(REGISTRATIONS_FILE)
|
|
|
|
registrations = _load_config(json_path)
|
|
|
|
vapid_pub_key = config[ATTR_VAPID_PUB_KEY]
|
|
vapid_prv_key = config[ATTR_VAPID_PRV_KEY]
|
|
vapid_email = config[ATTR_VAPID_EMAIL]
|
|
|
|
def websocket_appkey(hass, connection, msg):
|
|
connection.send_message(websocket_api.result_message(msg["id"], vapid_pub_key))
|
|
|
|
websocket_api.async_register_command(
|
|
hass, WS_TYPE_APPKEY, websocket_appkey, SCHEMA_WS_APPKEY
|
|
)
|
|
|
|
hass.http.register_view(HTML5PushRegistrationView(registrations, json_path))
|
|
hass.http.register_view(HTML5PushCallbackView(registrations))
|
|
|
|
return HTML5NotificationService(
|
|
hass, vapid_prv_key, vapid_email, registrations, json_path
|
|
)
|
|
|
|
|
|
def _load_config(filename: str) -> JsonObjectType:
|
|
"""Load configuration."""
|
|
with suppress(HomeAssistantError):
|
|
return load_json_object(filename)
|
|
return {}
|
|
|
|
|
|
class HTML5PushRegistrationView(HomeAssistantView):
|
|
"""Accepts push registrations from a browser."""
|
|
|
|
url = "/api/notify.html5"
|
|
name = "api:notify.html5"
|
|
|
|
def __init__(self, registrations, json_path):
|
|
"""Init HTML5PushRegistrationView."""
|
|
self.registrations = registrations
|
|
self.json_path = json_path
|
|
|
|
async def post(self, request):
|
|
"""Accept the POST request for push registrations from a browser."""
|
|
try:
|
|
data = await request.json()
|
|
except ValueError:
|
|
return self.json_message("Invalid JSON", HTTPStatus.BAD_REQUEST)
|
|
try:
|
|
data = REGISTER_SCHEMA(data)
|
|
except vol.Invalid as ex:
|
|
return self.json_message(humanize_error(data, ex), HTTPStatus.BAD_REQUEST)
|
|
|
|
devname = data.get(ATTR_NAME)
|
|
data.pop(ATTR_NAME, None)
|
|
|
|
name = self.find_registration_name(data, devname)
|
|
previous_registration = self.registrations.get(name)
|
|
|
|
self.registrations[name] = data
|
|
|
|
try:
|
|
hass = request.app["hass"]
|
|
|
|
await hass.async_add_executor_job(
|
|
save_json, self.json_path, self.registrations
|
|
)
|
|
return self.json_message("Push notification subscriber registered.")
|
|
except HomeAssistantError:
|
|
if previous_registration is not None:
|
|
self.registrations[name] = previous_registration
|
|
else:
|
|
self.registrations.pop(name)
|
|
|
|
return self.json_message(
|
|
"Error saving registration.", HTTPStatus.INTERNAL_SERVER_ERROR
|
|
)
|
|
|
|
def find_registration_name(self, data, suggested=None):
|
|
"""Find a registration name matching data or generate a unique one."""
|
|
endpoint = data.get(ATTR_SUBSCRIPTION).get(ATTR_ENDPOINT)
|
|
for key, registration in self.registrations.items():
|
|
subscription = registration.get(ATTR_SUBSCRIPTION)
|
|
if subscription.get(ATTR_ENDPOINT) == endpoint:
|
|
return key
|
|
return ensure_unique_string(suggested or "unnamed device", self.registrations)
|
|
|
|
async def delete(self, request):
|
|
"""Delete a registration."""
|
|
try:
|
|
data = await request.json()
|
|
except ValueError:
|
|
return self.json_message("Invalid JSON", HTTPStatus.BAD_REQUEST)
|
|
|
|
subscription = data.get(ATTR_SUBSCRIPTION)
|
|
|
|
found = None
|
|
|
|
for key, registration in self.registrations.items():
|
|
if registration.get(ATTR_SUBSCRIPTION) == subscription:
|
|
found = key
|
|
break
|
|
|
|
if not found:
|
|
# If not found, unregistering was already done. Return 200
|
|
return self.json_message("Registration not found.")
|
|
|
|
reg = self.registrations.pop(found)
|
|
|
|
try:
|
|
hass = request.app["hass"]
|
|
|
|
await hass.async_add_executor_job(
|
|
save_json, self.json_path, self.registrations
|
|
)
|
|
except HomeAssistantError:
|
|
self.registrations[found] = reg
|
|
return self.json_message(
|
|
"Error saving registration.", HTTPStatus.INTERNAL_SERVER_ERROR
|
|
)
|
|
|
|
return self.json_message("Push notification subscriber unregistered.")
|
|
|
|
|
|
class HTML5PushCallbackView(HomeAssistantView):
|
|
"""Accepts push registrations from a browser."""
|
|
|
|
requires_auth = False
|
|
url = "/api/notify.html5/callback"
|
|
name = "api:notify.html5/callback"
|
|
|
|
def __init__(self, registrations):
|
|
"""Init HTML5PushCallbackView."""
|
|
self.registrations = registrations
|
|
|
|
def decode_jwt(self, token):
|
|
"""Find the registration that signed this JWT and return it."""
|
|
|
|
# 1. Check claims w/o verifying to see if a target is in there.
|
|
# 2. If target in claims, attempt to verify against the given name.
|
|
# 2a. If decode is successful, return the payload.
|
|
# 2b. If decode is unsuccessful, return a 401.
|
|
|
|
target_check = jwt.decode(
|
|
token, algorithms=["ES256", "HS256"], options={"verify_signature": False}
|
|
)
|
|
if target_check.get(ATTR_TARGET) in self.registrations:
|
|
possible_target = self.registrations[target_check[ATTR_TARGET]]
|
|
key = possible_target[ATTR_SUBSCRIPTION][ATTR_KEYS][ATTR_AUTH]
|
|
with suppress(jwt.exceptions.DecodeError):
|
|
return jwt.decode(token, key, algorithms=["ES256", "HS256"])
|
|
|
|
return self.json_message(
|
|
"No target found in JWT", status_code=HTTPStatus.UNAUTHORIZED
|
|
)
|
|
|
|
# The following is based on code from Auth0
|
|
# https://auth0.com/docs/quickstart/backend/python
|
|
def check_authorization_header(self, request):
|
|
"""Check the authorization header."""
|
|
if not (auth := request.headers.get(AUTHORIZATION)):
|
|
return self.json_message(
|
|
"Authorization header is expected", status_code=HTTPStatus.UNAUTHORIZED
|
|
)
|
|
|
|
parts = auth.split()
|
|
|
|
if parts[0].lower() != "bearer":
|
|
return self.json_message(
|
|
"Authorization header must start with Bearer",
|
|
status_code=HTTPStatus.UNAUTHORIZED,
|
|
)
|
|
if len(parts) != 2:
|
|
return self.json_message(
|
|
"Authorization header must be Bearer token",
|
|
status_code=HTTPStatus.UNAUTHORIZED,
|
|
)
|
|
|
|
token = parts[1]
|
|
try:
|
|
payload = self.decode_jwt(token)
|
|
except jwt.exceptions.InvalidTokenError:
|
|
return self.json_message(
|
|
"token is invalid", status_code=HTTPStatus.UNAUTHORIZED
|
|
)
|
|
return payload
|
|
|
|
async def post(self, request):
|
|
"""Accept the POST request for push registrations event callback."""
|
|
auth_check = self.check_authorization_header(request)
|
|
if not isinstance(auth_check, dict):
|
|
return auth_check
|
|
|
|
try:
|
|
data = await request.json()
|
|
except ValueError:
|
|
return self.json_message("Invalid JSON", HTTPStatus.BAD_REQUEST)
|
|
|
|
event_payload = {
|
|
ATTR_TAG: data.get(ATTR_TAG),
|
|
ATTR_TYPE: data[ATTR_TYPE],
|
|
ATTR_TARGET: auth_check[ATTR_TARGET],
|
|
}
|
|
|
|
if data.get(ATTR_ACTION) is not None:
|
|
event_payload[ATTR_ACTION] = data.get(ATTR_ACTION)
|
|
|
|
if data.get(ATTR_DATA) is not None:
|
|
event_payload[ATTR_DATA] = data.get(ATTR_DATA)
|
|
|
|
try:
|
|
event_payload = CALLBACK_EVENT_PAYLOAD_SCHEMA(event_payload)
|
|
except vol.Invalid as ex:
|
|
_LOGGER.warning(
|
|
"Callback event payload is not valid: %s",
|
|
humanize_error(event_payload, ex),
|
|
)
|
|
|
|
event_name = f"{NOTIFY_CALLBACK_EVENT}.{event_payload[ATTR_TYPE]}"
|
|
request.app["hass"].bus.fire(event_name, event_payload)
|
|
return self.json({"status": "ok", "event": event_payload[ATTR_TYPE]})
|
|
|
|
|
|
class HTML5NotificationService(BaseNotificationService):
|
|
"""Implement the notification service for HTML5."""
|
|
|
|
def __init__(self, hass, vapid_prv, vapid_email, registrations, json_path):
|
|
"""Initialize the service."""
|
|
self._vapid_prv = vapid_prv
|
|
self._vapid_email = vapid_email
|
|
self.registrations = registrations
|
|
self.registrations_json_path = json_path
|
|
|
|
async def async_dismiss_message(service: ServiceCall) -> None:
|
|
"""Handle dismissing notification message service calls."""
|
|
kwargs = {}
|
|
|
|
if self.targets is not None:
|
|
kwargs[ATTR_TARGET] = self.targets
|
|
elif service.data.get(ATTR_TARGET) is not None:
|
|
kwargs[ATTR_TARGET] = service.data.get(ATTR_TARGET)
|
|
|
|
kwargs[ATTR_DATA] = service.data.get(ATTR_DATA)
|
|
|
|
await self.async_dismiss(**kwargs)
|
|
|
|
hass.services.async_register(
|
|
DOMAIN,
|
|
SERVICE_DISMISS,
|
|
async_dismiss_message,
|
|
schema=DISMISS_SERVICE_SCHEMA,
|
|
)
|
|
|
|
@property
|
|
def targets(self):
|
|
"""Return a dictionary of registered targets."""
|
|
targets = {}
|
|
for registration in self.registrations:
|
|
targets[registration] = registration
|
|
return targets
|
|
|
|
def dismiss(self, **kwargs):
|
|
"""Dismisses a notification."""
|
|
data = kwargs.get(ATTR_DATA)
|
|
tag = data.get(ATTR_TAG) if data else ""
|
|
payload = {ATTR_TAG: tag, ATTR_DISMISS: True, ATTR_DATA: {}}
|
|
|
|
self._push_message(payload, **kwargs)
|
|
|
|
async def async_dismiss(self, **kwargs):
|
|
"""Dismisses a notification.
|
|
|
|
This method must be run in the event loop.
|
|
"""
|
|
await self.hass.async_add_executor_job(partial(self.dismiss, **kwargs))
|
|
|
|
def send_message(self, message="", **kwargs):
|
|
"""Send a message to a user."""
|
|
tag = str(uuid.uuid4())
|
|
payload = {
|
|
"badge": "/static/images/notification-badge.png",
|
|
"body": message,
|
|
ATTR_DATA: {},
|
|
"icon": "/static/icons/favicon-192x192.png",
|
|
ATTR_TAG: tag,
|
|
ATTR_TITLE: kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT),
|
|
}
|
|
|
|
if data := kwargs.get(ATTR_DATA):
|
|
# Pick out fields that should go into the notification directly vs
|
|
# into the notification data dictionary.
|
|
|
|
data_tmp = {}
|
|
|
|
for key, val in data.items():
|
|
if key in HTML5_SHOWNOTIFICATION_PARAMETERS:
|
|
payload[key] = val
|
|
else:
|
|
data_tmp[key] = val
|
|
|
|
payload[ATTR_DATA] = data_tmp
|
|
|
|
if (
|
|
payload[ATTR_DATA].get(ATTR_URL) is None
|
|
and payload.get(ATTR_ACTIONS) is None
|
|
):
|
|
payload[ATTR_DATA][ATTR_URL] = URL_ROOT
|
|
|
|
self._push_message(payload, **kwargs)
|
|
|
|
def _push_message(self, payload, **kwargs):
|
|
"""Send the message."""
|
|
|
|
timestamp = int(time.time())
|
|
ttl = int(kwargs.get(ATTR_TTL, DEFAULT_TTL))
|
|
priority = kwargs.get(ATTR_PRIORITY, DEFAULT_PRIORITY)
|
|
if priority not in ["normal", "high"]:
|
|
priority = DEFAULT_PRIORITY
|
|
payload["timestamp"] = timestamp * 1000 # Javascript ms since epoch
|
|
|
|
if not (targets := kwargs.get(ATTR_TARGET)):
|
|
targets = self.registrations.keys()
|
|
|
|
for target in list(targets):
|
|
info = self.registrations.get(target)
|
|
try:
|
|
info = REGISTER_SCHEMA(info)
|
|
except vol.Invalid:
|
|
_LOGGER.error(
|
|
"%s is not a valid HTML5 push notification target", target
|
|
)
|
|
continue
|
|
subscription = info[ATTR_SUBSCRIPTION]
|
|
payload[ATTR_DATA][ATTR_JWT] = add_jwt(
|
|
timestamp,
|
|
target,
|
|
payload[ATTR_TAG],
|
|
subscription[ATTR_KEYS][ATTR_AUTH],
|
|
)
|
|
webpusher = WebPusher(info[ATTR_SUBSCRIPTION])
|
|
|
|
endpoint = urlparse(subscription[ATTR_ENDPOINT])
|
|
vapid_claims = {
|
|
"sub": f"mailto:{self._vapid_email}",
|
|
"aud": f"{endpoint.scheme}://{endpoint.netloc}",
|
|
"exp": timestamp + (VAPID_CLAIM_VALID_HOURS * 60 * 60),
|
|
}
|
|
vapid_headers = Vapid.from_string(self._vapid_prv).sign(vapid_claims)
|
|
vapid_headers.update({"urgency": priority, "priority": priority})
|
|
response = webpusher.send(
|
|
data=json.dumps(payload), headers=vapid_headers, ttl=ttl
|
|
)
|
|
|
|
if response.status_code == 410:
|
|
_LOGGER.info("Notification channel has expired")
|
|
reg = self.registrations.pop(target)
|
|
try:
|
|
save_json(self.registrations_json_path, self.registrations)
|
|
except HomeAssistantError:
|
|
self.registrations[target] = reg
|
|
_LOGGER.error("Error saving registration")
|
|
else:
|
|
_LOGGER.info("Configuration saved")
|
|
elif response.status_code > 399:
|
|
_LOGGER.error(
|
|
"There was an issue sending the notification %s: %s",
|
|
response.status,
|
|
response.text,
|
|
)
|
|
|
|
|
|
def add_jwt(timestamp, target, tag, jwt_secret):
|
|
"""Create JWT json to put into payload."""
|
|
|
|
jwt_exp = datetime.fromtimestamp(timestamp) + timedelta(days=JWT_VALID_DAYS)
|
|
jwt_claims = {
|
|
"exp": jwt_exp,
|
|
"nbf": timestamp,
|
|
"iat": timestamp,
|
|
ATTR_TARGET: target,
|
|
ATTR_TAG: tag,
|
|
}
|
|
return jwt.encode(jwt_claims, jwt_secret)
|