Enforce permissions for Websocket API (#18719)

* Handle unauth exceptions in websocket

* Enforce permissions in websocket API
This commit is contained in:
Paulus Schoutsen 2018-11-27 10:12:31 +01:00 committed by GitHub
parent 7248c9cb0e
commit 9d7b1fc3a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 81 additions and 17 deletions

View file

@ -3,6 +3,7 @@ import voluptuous as vol
from homeassistant.const import MATCH_ALL, EVENT_TIME_CHANGED
from homeassistant.core import callback, DOMAIN as HASS_DOMAIN
from homeassistant.exceptions import Unauthorized
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.service import async_get_all_descriptions
@ -98,6 +99,9 @@ def handle_subscribe_events(hass, connection, msg):
Async friendly.
"""
if not connection.user.is_admin:
raise Unauthorized
async def forward_events(event):
"""Forward events to websocket."""
if event.event_type == EVENT_TIME_CHANGED:
@ -149,8 +153,14 @@ def handle_get_states(hass, connection, msg):
Async friendly.
"""
entity_perm = connection.user.permissions.check_entity
states = [
state for state in hass.states.async_all()
if entity_perm(state.entity_id, 'read')
]
connection.send_message(messages.result_message(
msg['id'], hass.states.async_all()))
msg['id'], states))
@decorators.async_response

View file

@ -2,6 +2,7 @@
import voluptuous as vol
from homeassistant.core import callback, Context
from homeassistant.exceptions import Unauthorized
from . import const, messages
@ -63,11 +64,8 @@ class ActiveConnection:
try:
handler(self.hass, self, schema(msg))
except Exception: # pylint: disable=broad-except
self.logger.exception('Error handling message: %s', msg)
self.send_message(messages.error_message(
cur_id, const.ERR_UNKNOWN_ERROR,
'Unknown error.'))
except Exception as err: # pylint: disable=broad-except
self.async_handle_exception(msg, err)
self.last_id = cur_id
@ -76,3 +74,20 @@ class ActiveConnection:
"""Close down connection."""
for unsub in self.event_listeners.values():
unsub()
@callback
def async_handle_exception(self, msg, err):
"""Handle an exception while processing a handler."""
if isinstance(err, Unauthorized):
code = const.ERR_UNAUTHORIZED
err_message = 'Unauthorized'
elif isinstance(err, vol.Invalid):
code = const.ERR_INVALID_FORMAT
err_message = 'Invalid format'
else:
self.logger.exception('Error handling message: %s', msg)
code = const.ERR_UNKNOWN_ERROR
err_message = 'Unknown error'
self.send_message(
messages.error_message(msg['id'], code, err_message))

View file

@ -6,11 +6,12 @@ DOMAIN = 'websocket_api'
URL = '/api/websocket'
MAX_PENDING_MSG = 512
ERR_ID_REUSE = 1
ERR_INVALID_FORMAT = 2
ERR_NOT_FOUND = 3
ERR_UNKNOWN_COMMAND = 4
ERR_UNKNOWN_ERROR = 5
ERR_ID_REUSE = 'id_reuse'
ERR_INVALID_FORMAT = 'invalid_format'
ERR_NOT_FOUND = 'not_found'
ERR_UNKNOWN_COMMAND = 'unknown_command'
ERR_UNKNOWN_ERROR = 'unknown_error'
ERR_UNAUTHORIZED = 'unauthorized'
TYPE_RESULT = 'result'

View file

@ -14,10 +14,8 @@ async def _handle_async_response(func, hass, connection, msg):
"""Create a response and handle exception."""
try:
await func(hass, connection, msg)
except Exception: # pylint: disable=broad-except
_LOGGER.exception("Unexpected exception")
connection.send_message(messages.error_message(
msg['id'], 'unknown', 'Unexpected error occurred'))
except Exception as err: # pylint: disable=broad-except
connection.async_handle_exception(msg, err)
def async_response(func):