By default to use access_token if hass.auth.active (#15212)
* Force to use access_token if hass.auth.active * Not allow Basic auth with api_password if hass.auth.active * Block websocket api_password auth when hass.auth.active * Add legacy_api_password auth provider * lint * lint
This commit is contained in:
1 parent
3da4642194
commit
f874efb224
8 files changed
+468
-83
No files matched your search
@@ -1,20 +1,23 @@
|
||||
"""The tests for the Home Assistant HTTP component."""
|
||||
# pylint: disable=protected-access
|
||||
from ipaddress import ip_network
|
||||
from unittest.mock import patch
|
||||
from unittest.mock import patch, Mock
|
||||
|
||||
import pytest
|
||||
from aiohttp import BasicAuth, web
|
||||
from aiohttp.web_exceptions import HTTPUnauthorized
|
||||
import pytest
|
||||
|
||||
from homeassistant.auth import AccessToken, RefreshToken
|
||||
from homeassistant.components.http.auth import setup_auth
|
||||
from homeassistant.components.http.const import KEY_AUTHENTICATED
|
||||
from homeassistant.components.http.real_ip import setup_real_ip
|
||||
from homeassistant.const import HTTP_HEADER_HA_AUTH
|
||||
from homeassistant.setup import async_setup_component
|
||||
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
|
||||
|
||||
|
||||
ACCESS_TOKEN = 'tk.1234'
|
||||
|
||||
API_PASSWORD = 'test1234'
|
||||
|
||||
# Don't add 127.0.0.1/::1 as trusted, as it may interfere with other test cases
|
||||
@@ -36,15 +39,37 @@ async def mock_handler(request):
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
def mock_async_get_access_token(token):
|
||||
"""Return if token is valid."""
|
||||
if token == ACCESS_TOKEN:
|
||||
return Mock(spec=AccessToken,
|
||||
token=ACCESS_TOKEN,
|
||||
refresh_token=Mock(spec=RefreshToken))
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def app():
|
||||
"""Fixture to setup a web.Application."""
|
||||
app = web.Application()
|
||||
mock_auth = Mock(async_get_access_token=mock_async_get_access_token)
|
||||
app['hass'] = Mock(auth=mock_auth)
|
||||
app.router.add_get('/', mock_handler)
|
||||
setup_real_ip(app, False, [])
|
||||
return app
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def app2():
|
||||
"""Fixture to setup a web.Application without real_ip middleware."""
|
||||
app = web.Application()
|
||||
mock_auth = Mock(async_get_access_token=mock_async_get_access_token)
|
||||
app['hass'] = Mock(auth=mock_auth)
|
||||
app.router.add_get('/', mock_handler)
|
||||
return app
|
||||
|
||||
|
||||
async 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:
|
||||
@@ -57,7 +82,7 @@ async def test_auth_middleware_loaded_by_default(hass):
|
||||
|
||||
async def test_access_without_password(app, aiohttp_client):
|
||||
"""Test access without password."""
|
||||
setup_auth(app, [], None)
|
||||
setup_auth(app, [], False, api_password=None)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
resp = await client.get('/')
|
||||
@@ -65,8 +90,8 @@ async def test_access_without_password(app, aiohttp_client):
|
||||
|
||||
|
||||
async def test_access_with_password_in_header(app, aiohttp_client):
|
||||
"""Test access with password in URL."""
|
||||
setup_auth(app, [], API_PASSWORD)
|
||||
"""Test access with password in header."""
|
||||
setup_auth(app, [], False, api_password=API_PASSWORD)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
req = await client.get(
|
||||
@@ -79,8 +104,8 @@ async def test_access_with_password_in_header(app, aiohttp_client):
|
||||
|
||||
|
||||
async def test_access_with_password_in_query(app, aiohttp_client):
|
||||
"""Test access without password."""
|
||||
setup_auth(app, [], API_PASSWORD)
|
||||
"""Test access with password in URL."""
|
||||
setup_auth(app, [], False, api_password=API_PASSWORD)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
resp = await client.get('/', params={
|
||||
@@ -99,7 +124,7 @@ async def test_access_with_password_in_query(app, aiohttp_client):
|
||||
|
||||
async def test_basic_auth_works(app, aiohttp_client):
|
||||
"""Test access with basic authentication."""
|
||||
setup_auth(app, [], API_PASSWORD)
|
||||
setup_auth(app, [], False, api_password=API_PASSWORD)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
req = await client.get(
|
||||
@@ -125,15 +150,12 @@ async def test_basic_auth_works(app, aiohttp_client):
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
async def test_access_with_trusted_ip(aiohttp_client):
|
||||
async def test_access_with_trusted_ip(app2, aiohttp_client):
|
||||
"""Test access with an untrusted ip address."""
|
||||
app = web.Application()
|
||||
app.router.add_get('/', mock_handler)
|
||||
setup_auth(app2, TRUSTED_NETWORKS, False, api_password='some-pass')
|
||||
|
||||
setup_auth(app, TRUSTED_NETWORKS, 'some-pass')
|
||||
|
||||
set_mock_ip = mock_real_ip(app)
|
||||
client = await aiohttp_client(app)
|
||||
set_mock_ip = mock_real_ip(app2)
|
||||
client = await aiohttp_client(app2)
|
||||
|
||||
for remote_addr in UNTRUSTED_ADDRESSES:
|
||||
set_mock_ip(remote_addr)
|
||||
@@ -146,3 +168,94 @@ async def test_access_with_trusted_ip(aiohttp_client):
|
||||
resp = await client.get('/')
|
||||
assert resp.status == 200, \
|
||||
"{} should be trusted".format(remote_addr)
|
||||
|
||||
|
||||
async def test_auth_active_access_with_access_token_in_header(
|
||||
app, aiohttp_client):
|
||||
"""Test access with access token in header."""
|
||||
setup_auth(app, [], True, api_password=None)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={'Authorization': 'Bearer {}'.format(ACCESS_TOKEN)})
|
||||
assert req.status == 200
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={'AUTHORIZATION': 'Bearer {}'.format(ACCESS_TOKEN)})
|
||||
assert req.status == 200
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={'authorization': 'Bearer {}'.format(ACCESS_TOKEN)})
|
||||
assert req.status == 200
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={'Authorization': ACCESS_TOKEN})
|
||||
assert req.status == 401
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={'Authorization': 'BEARER {}'.format(ACCESS_TOKEN)})
|
||||
assert req.status == 401
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={'Authorization': 'Bearer wrong-pass'})
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
async def test_auth_active_access_with_trusted_ip(app2, aiohttp_client):
|
||||
"""Test access with an untrusted ip address."""
|
||||
setup_auth(app2, TRUSTED_NETWORKS, True, api_password=None)
|
||||
|
||||
set_mock_ip = mock_real_ip(app2)
|
||||
client = await aiohttp_client(app2)
|
||||
|
||||
for remote_addr in UNTRUSTED_ADDRESSES:
|
||||
set_mock_ip(remote_addr)
|
||||
resp = await 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 = await client.get('/')
|
||||
assert resp.status == 200, \
|
||||
"{} should be trusted".format(remote_addr)
|
||||
|
||||
|
||||
async def test_auth_active_blocked_api_password_access(app, aiohttp_client):
|
||||
"""Test access using api_password should be blocked when auth.active."""
|
||||
setup_auth(app, [], True, api_password=API_PASSWORD)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={HTTP_HEADER_HA_AUTH: API_PASSWORD})
|
||||
assert req.status == 401
|
||||
|
||||
resp = await client.get('/', params={
|
||||
'api_password': API_PASSWORD
|
||||
})
|
||||
assert resp.status == 401
|
||||
|
||||
req = await client.get(
|
||||
'/',
|
||||
auth=BasicAuth('homeassistant', API_PASSWORD))
|
||||
assert req.status == 401
|
||||
|
||||
|
||||
async def test_auth_legacy_support_api_password_access(app, aiohttp_client):
|
||||
"""Test access using api_password if auth.support_legacy."""
|
||||
setup_auth(app, [], True, support_legacy=True, api_password=API_PASSWORD)
|
||||
client = await aiohttp_client(app)
|
||||
|
||||
req = await client.get(
|
||||
'/', headers={HTTP_HEADER_HA_AUTH: API_PASSWORD})
|
||||
assert req.status == 200
|
||||
|
||||
resp = await client.get('/', params={
|
||||
'api_password': API_PASSWORD
|
||||
})
|
||||
assert resp.status == 200
|
||||
|
||||
req = await client.get(
|
||||
'/',
|
||||
auth=BasicAuth('homeassistant', API_PASSWORD))
|
||||
assert req.status == 200
|
||||
Reference in new issue
Block a user