Cleanup http (#12424)
* Clean up HTTP component * Clean up HTTP mock * Remove unused import * Fix test * Lint
This commit is contained in:
1 parent
ad8fe8a93a
commit
f32911d036
28 files changed
+811
-1014
No files matched your search
@@ -1 +1,38 @@
|
||||
"""Tests for the HTTP component."""
|
||||
import asyncio
|
||||
from ipaddress import ip_address
|
||||
|
||||
from aiohttp import web
|
||||
|
||||
from homeassistant.components.http.const import KEY_REAL_IP
|
||||
|
||||
|
||||
def mock_real_ip(app):
|
||||
"""Inject middleware to mock real IP.
|
||||
|
||||
Returns a function to set the real IP.
|
||||
"""
|
||||
ip_to_mock = None
|
||||
|
||||
def set_ip_to_mock(value):
|
||||
nonlocal ip_to_mock
|
||||
ip_to_mock = value
|
||||
|
||||
@asyncio.coroutine
|
||||
@web.middleware
|
||||
def mock_real_ip(request, handler):
|
||||
"""Mock Real IP middleware."""
|
||||
nonlocal ip_to_mock
|
||||
|
||||
request[KEY_REAL_IP] = ip_address(ip_to_mock)
|
||||
|
||||
return (yield from handler(request))
|
||||
|
||||
@asyncio.coroutine
|
||||
def real_ip_startup(app):
|
||||
"""Startup of real ip."""
|
||||
app.middlewares.insert(0, mock_real_ip)
|
||||
|
||||
app.on_startup.append(real_ip_startup)
|
||||
|
||||
return set_ip_to_mock
|
||||
+113
-152
@@ -1,195 +1,156 @@
|
||||
"""The tests for the Home Assistant HTTP component."""
|
||||
# pylint: disable=protected-access
|
||||
import asyncio
|
||||
from ipaddress import ip_address, ip_network
|
||||
from ipaddress import ip_network
|
||||
from unittest.mock import patch
|
||||
|
||||
import aiohttp
|
||||
from aiohttp import BasicAuth, web
|
||||
from aiohttp.web_exceptions import HTTPUnauthorized
|
||||
import pytest
|
||||
|
||||
from homeassistant import const
|
||||
from homeassistant.const import HTTP_HEADER_HA_AUTH
|
||||
from homeassistant.setup import async_setup_component
|
||||
import homeassistant.components.http as http
|
||||
from homeassistant.components.http.const import (
|
||||
KEY_TRUSTED_NETWORKS, KEY_USE_X_FORWARDED_FOR, HTTP_HEADER_X_FORWARDED_FOR)
|
||||
from homeassistant.components.http.auth import setup_auth
|
||||
from homeassistant.components.http.real_ip import setup_real_ip
|
||||
from homeassistant.components.http.const import KEY_AUTHENTICATED
|
||||
|
||||
from . import mock_real_ip
|
||||
|
||||
API_PASSWORD = 'test1234'
|
||||
|
||||
# Don't add 127.0.0.1/::1 as trusted, as it may interfere with other test cases
|
||||
TRUSTED_NETWORKS = ['192.0.2.0/24', '2001:DB8:ABCD::/48', '100.64.0.1',
|
||||
'FD01:DB8::1']
|
||||
TRUSTED_NETWORKS = [
|
||||
ip_network('192.0.2.0/24'),
|
||||
ip_network('2001:DB8:ABCD::/48'),
|
||||
ip_network('100.64.0.1'),
|
||||
ip_network('FD01:DB8::1'),
|
||||
]
|
||||
TRUSTED_ADDRESSES = ['100.64.0.1', '192.0.2.100', 'FD01:DB8::1',
|
||||
'2001:DB8:ABCD::1']
|
||||
UNTRUSTED_ADDRESSES = ['198.51.100.1', '2001:DB8:FA1::1', '127.0.0.1', '::1']
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_api_client(hass, test_client):
|
||||
"""Start the Hass HTTP component."""
|
||||
hass.loop.run_until_complete(async_setup_component(hass, 'api', {
|
||||
'http': {
|
||||
http.CONF_API_PASSWORD: API_PASSWORD,
|
||||
}
|
||||
}))
|
||||
return hass.loop.run_until_complete(test_client(hass.http.app))
|
||||
@asyncio.coroutine
|
||||
def mock_handler(request):
|
||||
"""Return if request was authenticated."""
|
||||
if not request[KEY_AUTHENTICATED]:
|
||||
raise HTTPUnauthorized
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_trusted_networks(hass, mock_api_client):
|
||||
"""Mock trusted networks."""
|
||||
hass.http.app[KEY_TRUSTED_NETWORKS] = [
|
||||
ip_network(trusted_network)
|
||||
for trusted_network in TRUSTED_NETWORKS]
|
||||
def app():
|
||||
"""Fixture to setup a web.Application."""
|
||||
app = web.Application()
|
||||
app.router.add_get('/', mock_handler)
|
||||
setup_real_ip(app, False)
|
||||
return app
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_denied_without_password(mock_api_client):
|
||||
def test_auth_middleware_loaded_by_default(hass):
|
||||
"""Test accessing to server from banned IP when feature is off."""
|
||||
with patch('homeassistant.components.http.setup_auth') as mock_setup:
|
||||
yield from async_setup_component(hass, 'http', {
|
||||
'http': {}
|
||||
})
|
||||
|
||||
assert len(mock_setup.mock_calls) == 1
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_without_password(app, test_client):
|
||||
"""Test access without password."""
|
||||
resp = yield from mock_api_client.get(const.URL_API)
|
||||
setup_auth(app, [], None)
|
||||
client = yield from test_client(app)
|
||||
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 200
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_with_password_in_header(app, test_client):
|
||||
"""Test access with password in URL."""
|
||||
setup_auth(app, [], API_PASSWORD)
|
||||
client = yield from test_client(app)
|
||||
|
||||
req = yield from client.get(
|
||||
'/', headers={HTTP_HEADER_HA_AUTH: API_PASSWORD})
|
||||
assert req.status == 200
|
||||
|
||||
req = yield from client.get(
|
||||
'/', headers={HTTP_HEADER_HA_AUTH: 'wrong-pass'})
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_with_password_in_query(app, test_client):
|
||||
"""Test access without password."""
|
||||
setup_auth(app, [], API_PASSWORD)
|
||||
client = yield from test_client(app)
|
||||
|
||||
resp = yield from client.get('/', params={
|
||||
'api_password': API_PASSWORD
|
||||
})
|
||||
assert resp.status == 200
|
||||
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_denied_with_wrong_password_in_header(mock_api_client):
|
||||
"""Test access with wrong password."""
|
||||
resp = yield from mock_api_client.get(const.URL_API, headers={
|
||||
const.HTTP_HEADER_HA_AUTH: 'wrongpassword'
|
||||
resp = yield from client.get('/', params={
|
||||
'api_password': 'wrong-password'
|
||||
})
|
||||
assert resp.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_denied_with_x_forwarded_for(hass, mock_api_client,
|
||||
mock_trusted_networks):
|
||||
"""Test access denied through the X-Forwarded-For http header."""
|
||||
hass.http.use_x_forwarded_for = True
|
||||
for remote_addr in UNTRUSTED_ADDRESSES:
|
||||
resp = yield from mock_api_client.get(const.URL_API, headers={
|
||||
HTTP_HEADER_X_FORWARDED_FOR: remote_addr})
|
||||
|
||||
assert resp.status == 401, \
|
||||
"{} shouldn't be trusted".format(remote_addr)
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_denied_with_untrusted_ip(mock_api_client,
|
||||
mock_trusted_networks):
|
||||
"""Test access with an untrusted ip address."""
|
||||
for remote_addr in UNTRUSTED_ADDRESSES:
|
||||
with patch('homeassistant.components.http.'
|
||||
'util.get_real_ip',
|
||||
return_value=ip_address(remote_addr)):
|
||||
resp = yield from mock_api_client.get(
|
||||
const.URL_API, params={'api_password': ''})
|
||||
|
||||
assert resp.status == 401, \
|
||||
"{} shouldn't be trusted".format(remote_addr)
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_with_password_in_header(mock_api_client, caplog):
|
||||
"""Test access with password in URL."""
|
||||
# Hide logging from requests package that we use to test logging
|
||||
req = yield from mock_api_client.get(
|
||||
const.URL_API, headers={const.HTTP_HEADER_HA_AUTH: API_PASSWORD})
|
||||
|
||||
assert req.status == 200
|
||||
|
||||
logs = caplog.text
|
||||
|
||||
assert const.URL_API in logs
|
||||
assert API_PASSWORD not in logs
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_denied_with_wrong_password_in_url(mock_api_client):
|
||||
"""Test access with wrong password."""
|
||||
resp = yield from mock_api_client.get(
|
||||
const.URL_API, params={'api_password': 'wrongpassword'})
|
||||
|
||||
assert resp.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_with_password_in_url(mock_api_client, caplog):
|
||||
"""Test access with password in URL."""
|
||||
req = yield from mock_api_client.get(
|
||||
const.URL_API, params={'api_password': API_PASSWORD})
|
||||
|
||||
assert req.status == 200
|
||||
|
||||
logs = caplog.text
|
||||
|
||||
assert const.URL_API in logs
|
||||
assert API_PASSWORD not in logs
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_granted_with_x_forwarded_for(hass, mock_api_client, caplog,
|
||||
mock_trusted_networks):
|
||||
"""Test access denied through the X-Forwarded-For http header."""
|
||||
hass.http.app[KEY_USE_X_FORWARDED_FOR] = True
|
||||
for remote_addr in TRUSTED_ADDRESSES:
|
||||
resp = yield from mock_api_client.get(const.URL_API, headers={
|
||||
HTTP_HEADER_X_FORWARDED_FOR: remote_addr})
|
||||
|
||||
assert resp.status == 200, \
|
||||
"{} should be trusted".format(remote_addr)
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_granted_with_trusted_ip(mock_api_client, caplog,
|
||||
mock_trusted_networks):
|
||||
"""Test access with trusted addresses."""
|
||||
for remote_addr in TRUSTED_ADDRESSES:
|
||||
with patch('homeassistant.components.http.'
|
||||
'auth.get_real_ip',
|
||||
return_value=ip_address(remote_addr)):
|
||||
resp = yield from mock_api_client.get(
|
||||
const.URL_API, params={'api_password': ''})
|
||||
|
||||
assert resp.status == 200, \
|
||||
'{} should be trusted'.format(remote_addr)
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_basic_auth_works(mock_api_client, caplog):
|
||||
def test_basic_auth_works(app, test_client):
|
||||
"""Test access with basic authentication."""
|
||||
req = yield from mock_api_client.get(
|
||||
const.URL_API,
|
||||
auth=aiohttp.BasicAuth('homeassistant', API_PASSWORD))
|
||||
setup_auth(app, [], API_PASSWORD)
|
||||
client = yield from test_client(app)
|
||||
|
||||
req = yield from client.get(
|
||||
'/',
|
||||
auth=BasicAuth('homeassistant', API_PASSWORD))
|
||||
assert req.status == 200
|
||||
assert const.URL_API in caplog.text
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_basic_auth_username_homeassistant(mock_api_client, caplog):
|
||||
"""Test access with basic auth requires username homeassistant."""
|
||||
req = yield from mock_api_client.get(
|
||||
const.URL_API,
|
||||
auth=aiohttp.BasicAuth('wrong_username', API_PASSWORD))
|
||||
|
||||
req = yield from client.get(
|
||||
'/',
|
||||
auth=BasicAuth('wrong_username', API_PASSWORD))
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_basic_auth_wrong_password(mock_api_client, caplog):
|
||||
"""Test access with basic auth not allowed with wrong password."""
|
||||
req = yield from mock_api_client.get(
|
||||
const.URL_API,
|
||||
auth=aiohttp.BasicAuth('homeassistant', 'wrong password'))
|
||||
|
||||
req = yield from client.get(
|
||||
'/',
|
||||
auth=BasicAuth('homeassistant', 'wrong password'))
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_authorization_header_must_be_basic_type(mock_api_client, caplog):
|
||||
"""Test only basic authorization is allowed for auth header."""
|
||||
req = yield from mock_api_client.get(
|
||||
const.URL_API,
|
||||
req = yield from client.get(
|
||||
'/',
|
||||
headers={
|
||||
'authorization': 'NotBasic abcdefg'
|
||||
})
|
||||
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_with_trusted_ip(test_client):
|
||||
"""Test access with an untrusted ip address."""
|
||||
app = web.Application()
|
||||
app.router.add_get('/', mock_handler)
|
||||
|
||||
setup_auth(app, TRUSTED_NETWORKS, 'some-pass')
|
||||
|
||||
set_mock_ip = mock_real_ip(app)
|
||||
client = yield from test_client(app)
|
||||
|
||||
for remote_addr in UNTRUSTED_ADDRESSES:
|
||||
set_mock_ip(remote_addr)
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 401, \
|
||||
"{} shouldn't be trusted".format(remote_addr)
|
||||
|
||||
for remote_addr in TRUSTED_ADDRESSES:
|
||||
set_mock_ip(remote_addr)
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 200, \
|
||||
"{} should be trusted".format(remote_addr)
|
||||
@@ -1,91 +1,96 @@
|
||||
"""The tests for the Home Assistant HTTP component."""
|
||||
# pylint: disable=protected-access
|
||||
import asyncio
|
||||
from ipaddress import ip_address
|
||||
from unittest.mock import patch, mock_open
|
||||
|
||||
import pytest
|
||||
from aiohttp import web
|
||||
from aiohttp.web_exceptions import HTTPUnauthorized
|
||||
|
||||
from homeassistant import const
|
||||
from homeassistant.setup import async_setup_component
|
||||
import homeassistant.components.http as http
|
||||
from homeassistant.components.http.const import (
|
||||
KEY_BANS_ENABLED, KEY_LOGIN_THRESHOLD, KEY_BANNED_IPS)
|
||||
from homeassistant.components.http.ban import IpBan, IP_BANS_FILE
|
||||
from homeassistant.components.http.ban import (
|
||||
IpBan, IP_BANS_FILE, setup_bans, KEY_BANNED_IPS)
|
||||
|
||||
from . import mock_real_ip
|
||||
|
||||
API_PASSWORD = 'test1234'
|
||||
BANNED_IPS = ['200.201.202.203', '100.64.0.2']
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_api_client(hass, test_client):
|
||||
"""Start the Hass HTTP component."""
|
||||
hass.loop.run_until_complete(async_setup_component(hass, 'api', {
|
||||
'http': {
|
||||
http.CONF_API_PASSWORD: API_PASSWORD,
|
||||
}
|
||||
}))
|
||||
hass.http.app[KEY_BANNED_IPS] = [IpBan(banned_ip) for banned_ip
|
||||
in BANNED_IPS]
|
||||
return hass.loop.run_until_complete(test_client(hass.http.app))
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_from_banned_ip(hass, mock_api_client):
|
||||
def test_access_from_banned_ip(hass, test_client):
|
||||
"""Test accessing to server from banned IP. Both trusted and not."""
|
||||
hass.http.app[KEY_BANS_ENABLED] = True
|
||||
app = web.Application()
|
||||
setup_bans(hass, app, 5)
|
||||
set_real_ip = mock_real_ip(app)
|
||||
|
||||
with patch('homeassistant.components.http.ban.load_ip_bans_config',
|
||||
return_value=[IpBan(banned_ip) for banned_ip
|
||||
in BANNED_IPS]):
|
||||
client = yield from test_client(app)
|
||||
|
||||
for remote_addr in BANNED_IPS:
|
||||
with patch('homeassistant.components.http.'
|
||||
'ban.get_real_ip',
|
||||
return_value=ip_address(remote_addr)):
|
||||
resp = yield from mock_api_client.get(
|
||||
const.URL_API)
|
||||
assert resp.status == 403
|
||||
set_real_ip(remote_addr)
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 403
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_access_from_banned_ip_when_ban_is_off(hass, mock_api_client):
|
||||
def test_ban_middleware_not_loaded_by_config(hass):
|
||||
"""Test accessing to server from banned IP when feature is off."""
|
||||
hass.http.app[KEY_BANS_ENABLED] = False
|
||||
for remote_addr in BANNED_IPS:
|
||||
with patch('homeassistant.components.http.'
|
||||
'ban.get_real_ip',
|
||||
return_value=ip_address(remote_addr)):
|
||||
resp = yield from mock_api_client.get(
|
||||
const.URL_API,
|
||||
headers={const.HTTP_HEADER_HA_AUTH: API_PASSWORD})
|
||||
assert resp.status == 200
|
||||
with patch('homeassistant.components.http.setup_bans') as mock_setup:
|
||||
yield from async_setup_component(hass, 'http', {
|
||||
'http': {
|
||||
http.CONF_IP_BAN_ENABLED: False,
|
||||
}
|
||||
})
|
||||
|
||||
assert len(mock_setup.mock_calls) == 0
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_ip_bans_file_creation(hass, mock_api_client):
|
||||
def test_ban_middleware_loaded_by_default(hass):
|
||||
"""Test accessing to server from banned IP when feature is off."""
|
||||
with patch('homeassistant.components.http.setup_bans') as mock_setup:
|
||||
yield from async_setup_component(hass, 'http', {
|
||||
'http': {}
|
||||
})
|
||||
|
||||
assert len(mock_setup.mock_calls) == 1
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_ip_bans_file_creation(hass, test_client):
|
||||
"""Testing if banned IP file created."""
|
||||
hass.http.app[KEY_BANS_ENABLED] = True
|
||||
hass.http.app[KEY_LOGIN_THRESHOLD] = 1
|
||||
app = web.Application()
|
||||
app['hass'] = hass
|
||||
|
||||
@asyncio.coroutine
|
||||
def unauth_handler(request):
|
||||
"""Return a mock web response."""
|
||||
raise HTTPUnauthorized
|
||||
|
||||
app.router.add_get('/', unauth_handler)
|
||||
setup_bans(hass, app, 1)
|
||||
mock_real_ip(app)("200.201.202.204")
|
||||
|
||||
with patch('homeassistant.components.http.ban.load_ip_bans_config',
|
||||
return_value=[IpBan(banned_ip) for banned_ip
|
||||
in BANNED_IPS]):
|
||||
client = yield from test_client(app)
|
||||
|
||||
m = mock_open()
|
||||
|
||||
@asyncio.coroutine
|
||||
def call_server():
|
||||
with patch('homeassistant.components.http.'
|
||||
'ban.get_real_ip',
|
||||
return_value=ip_address("200.201.202.204")):
|
||||
resp = yield from mock_api_client.get(
|
||||
const.URL_API,
|
||||
headers={const.HTTP_HEADER_HA_AUTH: 'Wrong password'})
|
||||
return resp
|
||||
|
||||
with patch('homeassistant.components.http.ban.open', m, create=True):
|
||||
resp = yield from call_server()
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 401
|
||||
assert len(hass.http.app[KEY_BANNED_IPS]) == len(BANNED_IPS)
|
||||
assert len(app[KEY_BANNED_IPS]) == len(BANNED_IPS)
|
||||
assert m.call_count == 0
|
||||
|
||||
resp = yield from call_server()
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 401
|
||||
assert len(hass.http.app[KEY_BANNED_IPS]) == len(BANNED_IPS) + 1
|
||||
assert len(app[KEY_BANNED_IPS]) == len(BANNED_IPS) + 1
|
||||
m.assert_called_once_with(hass.config.path(IP_BANS_FILE), 'a')
|
||||
|
||||
resp = yield from call_server()
|
||||
resp = yield from client.get('/')
|
||||
assert resp.status == 403
|
||||
assert m.call_count == 1
|
||||
@@ -0,0 +1,104 @@
|
||||
"""Test cors for the HTTP component."""
|
||||
import asyncio
|
||||
from unittest.mock import patch
|
||||
|
||||
from aiohttp import web
|
||||
from aiohttp.hdrs import (
|
||||
ACCESS_CONTROL_ALLOW_ORIGIN,
|
||||
ACCESS_CONTROL_ALLOW_HEADERS,
|
||||
ACCESS_CONTROL_REQUEST_HEADERS,
|
||||
ACCESS_CONTROL_REQUEST_METHOD,
|
||||
ORIGIN
|
||||
)
|
||||
import pytest
|
||||
|
||||
from homeassistant.const import HTTP_HEADER_HA_AUTH
|
||||
from homeassistant.setup import async_setup_component
|
||||
from homeassistant.components.http.cors import setup_cors
|
||||
|
||||
|
||||
TRUSTED_ORIGIN = 'https://home-assistant.io'
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_cors_middleware_not_loaded_by_default(hass):
|
||||
"""Test accessing to server from banned IP when feature is off."""
|
||||
with patch('homeassistant.components.http.setup_cors') as mock_setup:
|
||||
yield from async_setup_component(hass, 'http', {
|
||||
'http': {}
|
||||
})
|
||||
|
||||
assert len(mock_setup.mock_calls) == 0
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_cors_middleware_loaded_from_config(hass):
|
||||
"""Test accessing to server from banned IP when feature is off."""
|
||||
with patch('homeassistant.components.http.setup_cors') as mock_setup:
|
||||
yield from async_setup_component(hass, 'http', {
|
||||
'http': {
|
||||
'cors_allowed_origins': ['http://home-assistant.io']
|
||||
}
|
||||
})
|
||||
|
||||
assert len(mock_setup.mock_calls) == 1
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def mock_handler(request):
|
||||
"""Return if request was authenticated."""
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def client(loop, test_client):
|
||||
"""Fixture to setup a web.Application."""
|
||||
app = web.Application()
|
||||
app.router.add_get('/', mock_handler)
|
||||
setup_cors(app, [TRUSTED_ORIGIN])
|
||||
return loop.run_until_complete(test_client(app))
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_cors_requests(client):
|
||||
"""Test cross origin requests."""
|
||||
req = yield from client.get('/', headers={
|
||||
ORIGIN: TRUSTED_ORIGIN
|
||||
})
|
||||
assert req.status == 200
|
||||
assert req.headers[ACCESS_CONTROL_ALLOW_ORIGIN] == \
|
||||
TRUSTED_ORIGIN
|
||||
|
||||
# With password in URL
|
||||
req = yield from client.get('/', params={
|
||||
'api_password': 'some-pass'
|
||||
}, headers={
|
||||
ORIGIN: TRUSTED_ORIGIN
|
||||
})
|
||||
assert req.status == 200
|
||||
assert req.headers[ACCESS_CONTROL_ALLOW_ORIGIN] == \
|
||||
TRUSTED_ORIGIN
|
||||
|
||||
# With password in headers
|
||||
req = yield from client.get('/', headers={
|
||||
HTTP_HEADER_HA_AUTH: 'some-pass',
|
||||
ORIGIN: TRUSTED_ORIGIN
|
||||
})
|
||||
assert req.status == 200
|
||||
assert req.headers[ACCESS_CONTROL_ALLOW_ORIGIN] == \
|
||||
TRUSTED_ORIGIN
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_cors_preflight_allowed(client):
|
||||
"""Test cross origin resource sharing preflight (OPTIONS) request."""
|
||||
req = yield from client.options('/', headers={
|
||||
ORIGIN: TRUSTED_ORIGIN,
|
||||
ACCESS_CONTROL_REQUEST_METHOD: 'GET',
|
||||
ACCESS_CONTROL_REQUEST_HEADERS: 'x-ha-access'
|
||||
})
|
||||
|
||||
assert req.status == 200
|
||||
assert req.headers[ACCESS_CONTROL_ALLOW_ORIGIN] == TRUSTED_ORIGIN
|
||||
assert req.headers[ACCESS_CONTROL_ALLOW_HEADERS] == \
|
||||
HTTP_HEADER_HA_AUTH.upper()
|
||||
@@ -1,124 +1,10 @@
|
||||
"""The tests for the Home Assistant HTTP component."""
|
||||
import asyncio
|
||||
|
||||
from aiohttp.hdrs import (
|
||||
ORIGIN, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_ALLOW_HEADERS,
|
||||
ACCESS_CONTROL_REQUEST_METHOD, ACCESS_CONTROL_REQUEST_HEADERS,
|
||||
CONTENT_TYPE)
|
||||
import requests
|
||||
from tests.common import get_test_instance_port, get_test_home_assistant
|
||||
from homeassistant.setup import async_setup_component
|
||||
|
||||
from homeassistant import const, setup
|
||||
import homeassistant.components.http as http
|
||||
|
||||
API_PASSWORD = 'test1234'
|
||||
SERVER_PORT = get_test_instance_port()
|
||||
HTTP_BASE = '127.0.0.1:{}'.format(SERVER_PORT)
|
||||
HTTP_BASE_URL = 'http://{}'.format(HTTP_BASE)
|
||||
HA_HEADERS = {
|
||||
const.HTTP_HEADER_HA_AUTH: API_PASSWORD,
|
||||
CONTENT_TYPE: const.CONTENT_TYPE_JSON,
|
||||
}
|
||||
CORS_ORIGINS = [HTTP_BASE_URL, HTTP_BASE]
|
||||
|
||||
hass = None
|
||||
|
||||
|
||||
def _url(path=''):
|
||||
"""Helper method to generate URLs."""
|
||||
return HTTP_BASE_URL + path
|
||||
|
||||
|
||||
# pylint: disable=invalid-name
|
||||
def setUpModule():
|
||||
"""Initialize a Home Assistant server."""
|
||||
global hass
|
||||
|
||||
hass = get_test_home_assistant()
|
||||
|
||||
setup.setup_component(
|
||||
hass, http.DOMAIN, {
|
||||
http.DOMAIN: {
|
||||
http.CONF_API_PASSWORD: API_PASSWORD,
|
||||
http.CONF_SERVER_PORT: SERVER_PORT,
|
||||
http.CONF_CORS_ORIGINS: CORS_ORIGINS,
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
setup.setup_component(hass, 'api')
|
||||
|
||||
# Registering static path as it caused CORS to blow up
|
||||
hass.http.register_static_path(
|
||||
'/custom_components', hass.config.path('custom_components'))
|
||||
|
||||
hass.start()
|
||||
|
||||
|
||||
# pylint: disable=invalid-name
|
||||
def tearDownModule():
|
||||
"""Stop the Home Assistant server."""
|
||||
hass.stop()
|
||||
|
||||
|
||||
class TestCors:
|
||||
"""Test HTTP component."""
|
||||
|
||||
def test_cors_allowed_with_password_in_url(self):
|
||||
"""Test cross origin resource sharing with password in url."""
|
||||
req = requests.get(_url(const.URL_API),
|
||||
params={'api_password': API_PASSWORD},
|
||||
headers={ORIGIN: HTTP_BASE_URL})
|
||||
|
||||
allow_origin = ACCESS_CONTROL_ALLOW_ORIGIN
|
||||
|
||||
assert req.status_code == 200
|
||||
assert req.headers.get(allow_origin) == HTTP_BASE_URL
|
||||
|
||||
def test_cors_allowed_with_password_in_header(self):
|
||||
"""Test cross origin resource sharing with password in header."""
|
||||
headers = {
|
||||
const.HTTP_HEADER_HA_AUTH: API_PASSWORD,
|
||||
ORIGIN: HTTP_BASE_URL
|
||||
}
|
||||
req = requests.get(_url(const.URL_API), headers=headers)
|
||||
|
||||
allow_origin = ACCESS_CONTROL_ALLOW_ORIGIN
|
||||
|
||||
assert req.status_code == 200
|
||||
assert req.headers.get(allow_origin) == HTTP_BASE_URL
|
||||
|
||||
def test_cors_denied_without_origin_header(self):
|
||||
"""Test cross origin resource sharing with password in header."""
|
||||
headers = {
|
||||
const.HTTP_HEADER_HA_AUTH: API_PASSWORD
|
||||
}
|
||||
req = requests.get(_url(const.URL_API), headers=headers)
|
||||
|
||||
allow_origin = ACCESS_CONTROL_ALLOW_ORIGIN
|
||||
allow_headers = ACCESS_CONTROL_ALLOW_HEADERS
|
||||
|
||||
assert req.status_code == 200
|
||||
assert allow_origin not in req.headers
|
||||
assert allow_headers not in req.headers
|
||||
|
||||
def test_cors_preflight_allowed(self):
|
||||
"""Test cross origin resource sharing preflight (OPTIONS) request."""
|
||||
headers = {
|
||||
ORIGIN: HTTP_BASE_URL,
|
||||
ACCESS_CONTROL_REQUEST_METHOD: 'GET',
|
||||
ACCESS_CONTROL_REQUEST_HEADERS: 'x-ha-access'
|
||||
}
|
||||
req = requests.options(_url(const.URL_API), headers=headers)
|
||||
|
||||
allow_origin = ACCESS_CONTROL_ALLOW_ORIGIN
|
||||
allow_headers = ACCESS_CONTROL_ALLOW_HEADERS
|
||||
|
||||
assert req.status_code == 200
|
||||
assert req.headers.get(allow_origin) == HTTP_BASE_URL
|
||||
assert req.headers.get(allow_headers) == \
|
||||
const.HTTP_HEADER_HA_AUTH.upper()
|
||||
|
||||
|
||||
class TestView(http.HomeAssistantView):
|
||||
"""Test the HTTP views."""
|
||||
@@ -133,12 +19,12 @@ class TestView(http.HomeAssistantView):
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_registering_view_while_running(hass, test_client):
|
||||
def test_registering_view_while_running(hass, test_client, unused_port):
|
||||
"""Test that we can register a view while the server is running."""
|
||||
yield from setup.async_setup_component(
|
||||
yield from async_setup_component(
|
||||
hass, http.DOMAIN, {
|
||||
http.DOMAIN: {
|
||||
http.CONF_SERVER_PORT: get_test_instance_port(),
|
||||
http.CONF_SERVER_PORT: unused_port(),
|
||||
}
|
||||
}
|
||||
)
|
||||
@@ -151,7 +37,7 @@ def test_registering_view_while_running(hass, test_client):
|
||||
@asyncio.coroutine
|
||||
def test_api_base_url_with_domain(hass):
|
||||
"""Test setting API URL."""
|
||||
result = yield from setup.async_setup_component(hass, 'http', {
|
||||
result = yield from async_setup_component(hass, 'http', {
|
||||
'http': {
|
||||
'base_url': 'example.com'
|
||||
}
|
||||
@@ -163,7 +49,7 @@ def test_api_base_url_with_domain(hass):
|
||||
@asyncio.coroutine
|
||||
def test_api_base_url_with_ip(hass):
|
||||
"""Test setting api url."""
|
||||
result = yield from setup.async_setup_component(hass, 'http', {
|
||||
result = yield from async_setup_component(hass, 'http', {
|
||||
'http': {
|
||||
'server_host': '1.1.1.1'
|
||||
}
|
||||
@@ -175,7 +61,7 @@ def test_api_base_url_with_ip(hass):
|
||||
@asyncio.coroutine
|
||||
def test_api_base_url_with_ip_port(hass):
|
||||
"""Test setting api url."""
|
||||
result = yield from setup.async_setup_component(hass, 'http', {
|
||||
result = yield from async_setup_component(hass, 'http', {
|
||||
'http': {
|
||||
'base_url': '1.1.1.1:8124'
|
||||
}
|
||||
@@ -187,9 +73,34 @@ def test_api_base_url_with_ip_port(hass):
|
||||
@asyncio.coroutine
|
||||
def test_api_no_base_url(hass):
|
||||
"""Test setting api url."""
|
||||
result = yield from setup.async_setup_component(hass, 'http', {
|
||||
result = yield from async_setup_component(hass, 'http', {
|
||||
'http': {
|
||||
}
|
||||
})
|
||||
assert result
|
||||
assert hass.config.api.base_url == 'http://127.0.0.1:8123'
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_not_log_password(hass, unused_port, test_client, caplog):
|
||||
"""Test access with password doesn't get logged."""
|
||||
result = yield from async_setup_component(hass, 'api', {
|
||||
'http': {
|
||||
http.CONF_SERVER_PORT: unused_port(),
|
||||
http.CONF_API_PASSWORD: 'some-pass'
|
||||
}
|
||||
})
|
||||
assert result
|
||||
|
||||
client = yield from test_client(hass.http.app)
|
||||
|
||||
resp = yield from client.get('/api/', params={
|
||||
'api_password': 'some-pass'
|
||||
})
|
||||
|
||||
assert resp.status == 200
|
||||
logs = caplog.text
|
||||
|
||||
# Ensure we don't log API passwords
|
||||
assert '/api/' in logs
|
||||
assert 'some-pass' not in logs
|
||||
@@ -0,0 +1,48 @@
|
||||
"""Test real IP middleware."""
|
||||
import asyncio
|
||||
|
||||
from aiohttp import web
|
||||
from aiohttp.hdrs import X_FORWARDED_FOR
|
||||
|
||||
from homeassistant.components.http.real_ip import setup_real_ip
|
||||
from homeassistant.components.http.const import KEY_REAL_IP
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def mock_handler(request):
|
||||
"""Handler that returns the real IP as text."""
|
||||
return web.Response(text=str(request[KEY_REAL_IP]))
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_ignore_x_forwarded_for(test_client):
|
||||
"""Test that we get the IP from the transport."""
|
||||
app = web.Application()
|
||||
app.router.add_get('/', mock_handler)
|
||||
setup_real_ip(app, False)
|
||||
|
||||
mock_api_client = yield from test_client(app)
|
||||
|
||||
resp = yield from mock_api_client.get('/', headers={
|
||||
X_FORWARDED_FOR: '255.255.255.255'
|
||||
})
|
||||
assert resp.status == 200
|
||||
text = yield from resp.text()
|
||||
assert text != '255.255.255.255'
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def test_use_x_forwarded_for(test_client):
|
||||
"""Test that we get the IP from the transport."""
|
||||
app = web.Application()
|
||||
app.router.add_get('/', mock_handler)
|
||||
setup_real_ip(app, True)
|
||||
|
||||
mock_api_client = yield from test_client(app)
|
||||
|
||||
resp = yield from mock_api_client.get('/', headers={
|
||||
X_FORWARDED_FOR: '255.255.255.255'
|
||||
})
|
||||
assert resp.status == 200
|
||||
text = yield from resp.text()
|
||||
assert text == '255.255.255.255'
|
||||
Reference in new issue
Block a user