Strip login username in backend (#20150)
* Add modern mode to HA auth provider that strips usernames * Add tests for async_get_or_create_credentials * Fix test
This commit is contained in:
1 parent
9bb7e40ee3
commit
84a2e5d8fb
3 files changed
+245
-61
No files matched your search
@@ -1,5 +1,5 @@
|
||||
"""Test the Home Assistant local auth provider."""
|
||||
from unittest.mock import Mock
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
import voluptuous as vol
|
||||
@@ -9,6 +9,8 @@ from homeassistant.auth import auth_manager_from_config, auth_store
|
||||
from homeassistant.auth.providers import (
|
||||
auth_provider_from_config, homeassistant as hass_auth)
|
||||
|
||||
from tests.common import mock_coro
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def data(hass):
|
||||
@@ -18,17 +20,13 @@ def data(hass):
|
||||
return data
|
||||
|
||||
|
||||
async def test_adding_user(data, hass):
|
||||
"""Test adding a user."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
|
||||
|
||||
async def test_adding_user_duplicate_username(data, hass):
|
||||
"""Test adding a user with duplicate username."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.add_auth('test-user', 'other-pass')
|
||||
@pytest.fixture
|
||||
def legacy_data(hass):
|
||||
"""Create a loaded legacy data class."""
|
||||
data = hass_auth.Data(hass)
|
||||
hass.loop.run_until_complete(data.async_load())
|
||||
data.is_legacy = True
|
||||
return data
|
||||
|
||||
|
||||
async def test_validating_password_invalid_user(data, hass):
|
||||
@@ -37,30 +35,72 @@ async def test_validating_password_invalid_user(data, hass):
|
||||
data.validate_login('non-existing', 'pw')
|
||||
|
||||
|
||||
async def test_not_allow_set_id():
|
||||
"""Test we are not allowed to set an ID in config."""
|
||||
hass = Mock()
|
||||
with pytest.raises(vol.Invalid):
|
||||
await auth_provider_from_config(hass, None, {
|
||||
'type': 'homeassistant',
|
||||
'id': 'invalid',
|
||||
})
|
||||
|
||||
|
||||
async def test_new_users_populate_values(hass, data):
|
||||
"""Test that we populate data for new users."""
|
||||
data.add_auth('hello', 'test-pass')
|
||||
await data.async_save()
|
||||
|
||||
manager = await auth_manager_from_config(hass, [{
|
||||
'type': 'homeassistant'
|
||||
}], [])
|
||||
provider = manager.auth_providers[0]
|
||||
credentials = await provider.async_get_or_create_credentials({
|
||||
'username': 'hello'
|
||||
})
|
||||
user = await manager.async_get_or_create_user(credentials)
|
||||
assert user.name == 'hello'
|
||||
assert user.is_active
|
||||
|
||||
|
||||
async def test_changing_password_raises_invalid_user(data, hass):
|
||||
"""Test that changing password raises invalid user."""
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.change_password('non-existing', 'pw')
|
||||
|
||||
|
||||
# Modern mode
|
||||
|
||||
async def test_adding_user(data, hass):
|
||||
"""Test adding a user."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
data.validate_login(' test-user ', 'test-pass')
|
||||
|
||||
|
||||
async def test_adding_user_duplicate_username(data, hass):
|
||||
"""Test adding a user with duplicate username."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.add_auth('test-user ', 'other-pass')
|
||||
|
||||
|
||||
async def test_validating_password_invalid_password(data, hass):
|
||||
"""Test validating an invalid password."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('test-user', 'invalid-pass')
|
||||
data.validate_login(' test-user ', 'invalid-pass')
|
||||
|
||||
|
||||
async def test_changing_password(data, hass):
|
||||
"""Test adding a user."""
|
||||
user = 'test-user'
|
||||
data.add_auth(user, 'test-pass')
|
||||
data.change_password(user, 'new-pass')
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
data.change_password('test-user ', 'new-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login(user, 'test-pass')
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
|
||||
data.validate_login(user, 'new-pass')
|
||||
|
||||
|
||||
async def test_changing_password_raises_invalid_user(data, hass):
|
||||
"""Test that we initialize an empty config."""
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.change_password('non-existing', 'pw')
|
||||
data.validate_login('test-user', 'new-pass')
|
||||
|
||||
|
||||
async def test_login_flow_validates(data, hass):
|
||||
@@ -81,6 +121,110 @@ async def test_login_flow_validates(data, hass):
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result['errors']['base'] == 'invalid_auth'
|
||||
|
||||
result = await flow.async_step_init({
|
||||
'username': 'test-user ',
|
||||
'password': 'incorrect-pass',
|
||||
})
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result['errors']['base'] == 'invalid_auth'
|
||||
|
||||
result = await flow.async_step_init({
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
assert result['data']['username'] == 'test-user'
|
||||
|
||||
|
||||
async def test_saving_loading(data, hass):
|
||||
"""Test saving and loading JSON."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
data.add_auth('second-user', 'second-pass')
|
||||
await data.async_save()
|
||||
|
||||
data = hass_auth.Data(hass)
|
||||
await data.async_load()
|
||||
data.validate_login('test-user ', 'test-pass')
|
||||
data.validate_login('second-user ', 'second-pass')
|
||||
|
||||
|
||||
async def test_get_or_create_credentials(hass, data):
|
||||
"""Test that we can get or create credentials."""
|
||||
manager = await auth_manager_from_config(hass, [{
|
||||
'type': 'homeassistant'
|
||||
}], [])
|
||||
provider = manager.auth_providers[0]
|
||||
provider.data = data
|
||||
credentials1 = await provider.async_get_or_create_credentials({
|
||||
'username': 'hello'
|
||||
})
|
||||
with patch.object(provider, 'async_credentials',
|
||||
return_value=mock_coro([credentials1])):
|
||||
credentials2 = await provider.async_get_or_create_credentials({
|
||||
'username': 'hello '
|
||||
})
|
||||
assert credentials1 is credentials2
|
||||
|
||||
|
||||
# Legacy mode
|
||||
|
||||
async def test_legacy_adding_user(legacy_data, hass):
|
||||
"""Test in legacy mode adding a user."""
|
||||
legacy_data.add_auth('test-user', 'test-pass')
|
||||
legacy_data.validate_login('test-user', 'test-pass')
|
||||
|
||||
|
||||
async def test_legacy_adding_user_duplicate_username(legacy_data, hass):
|
||||
"""Test in legacy mode adding a user with duplicate username."""
|
||||
legacy_data.add_auth('test-user', 'test-pass')
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
legacy_data.add_auth('test-user', 'other-pass')
|
||||
|
||||
|
||||
async def test_legacy_validating_password_invalid_password(legacy_data, hass):
|
||||
"""Test in legacy mode validating an invalid password."""
|
||||
legacy_data.add_auth('test-user', 'test-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
legacy_data.validate_login('test-user', 'invalid-pass')
|
||||
|
||||
|
||||
async def test_legacy_changing_password(legacy_data, hass):
|
||||
"""Test in legacy mode adding a user."""
|
||||
user = 'test-user'
|
||||
legacy_data.add_auth(user, 'test-pass')
|
||||
legacy_data.change_password(user, 'new-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
legacy_data.validate_login(user, 'test-pass')
|
||||
|
||||
legacy_data.validate_login(user, 'new-pass')
|
||||
|
||||
|
||||
async def test_legacy_changing_password_raises_invalid_user(legacy_data, hass):
|
||||
"""Test in legacy mode that we initialize an empty config."""
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
legacy_data.change_password('non-existing', 'pw')
|
||||
|
||||
|
||||
async def test_legacy_login_flow_validates(legacy_data, hass):
|
||||
"""Test in legacy mode login flow."""
|
||||
legacy_data.add_auth('test-user', 'test-pass')
|
||||
await legacy_data.async_save()
|
||||
|
||||
provider = hass_auth.HassAuthProvider(hass, auth_store.AuthStore(hass),
|
||||
{'type': 'homeassistant'})
|
||||
flow = await provider.async_login_flow({})
|
||||
result = await flow.async_step_init()
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
|
||||
result = await flow.async_step_init({
|
||||
'username': 'incorrect-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result['errors']['base'] == 'invalid_auth'
|
||||
|
||||
result = await flow.async_step_init({
|
||||
'username': 'test-user',
|
||||
'password': 'incorrect-pass',
|
||||
@@ -96,40 +240,43 @@ async def test_login_flow_validates(data, hass):
|
||||
assert result['data']['username'] == 'test-user'
|
||||
|
||||
|
||||
async def test_saving_loading(data, hass):
|
||||
"""Test saving and loading JSON."""
|
||||
data.add_auth('test-user', 'test-pass')
|
||||
data.add_auth('second-user', 'second-pass')
|
||||
await data.async_save()
|
||||
async def test_legacy_saving_loading(legacy_data, hass):
|
||||
"""Test in legacy mode saving and loading JSON."""
|
||||
legacy_data.add_auth('test-user', 'test-pass')
|
||||
legacy_data.add_auth('second-user', 'second-pass')
|
||||
await legacy_data.async_save()
|
||||
|
||||
data = hass_auth.Data(hass)
|
||||
await data.async_load()
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
data.validate_login('second-user', 'second-pass')
|
||||
legacy_data = hass_auth.Data(hass)
|
||||
await legacy_data.async_load()
|
||||
legacy_data.is_legacy = True
|
||||
legacy_data.validate_login('test-user', 'test-pass')
|
||||
legacy_data.validate_login('second-user', 'second-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
legacy_data.validate_login('test-user ', 'test-pass')
|
||||
|
||||
|
||||
async def test_not_allow_set_id():
|
||||
"""Test we are not allowed to set an ID in config."""
|
||||
hass = Mock()
|
||||
with pytest.raises(vol.Invalid):
|
||||
await auth_provider_from_config(hass, None, {
|
||||
'type': 'homeassistant',
|
||||
'id': 'invalid',
|
||||
})
|
||||
|
||||
|
||||
async def test_new_users_populate_values(hass, data):
|
||||
"""Test that we populate data for new users."""
|
||||
data.add_auth('hello', 'test-pass')
|
||||
await data.async_save()
|
||||
|
||||
async def test_legacy_get_or_create_credentials(hass, legacy_data):
|
||||
"""Test in legacy mode that we can get or create credentials."""
|
||||
manager = await auth_manager_from_config(hass, [{
|
||||
'type': 'homeassistant'
|
||||
}], [])
|
||||
provider = manager.auth_providers[0]
|
||||
credentials = await provider.async_get_or_create_credentials({
|
||||
provider.data = legacy_data
|
||||
credentials1 = await provider.async_get_or_create_credentials({
|
||||
'username': 'hello'
|
||||
})
|
||||
user = await manager.async_get_or_create_user(credentials)
|
||||
assert user.name == 'hello'
|
||||
assert user.is_active
|
||||
|
||||
with patch.object(provider, 'async_credentials',
|
||||
return_value=mock_coro([credentials1])):
|
||||
credentials2 = await provider.async_get_or_create_credentials({
|
||||
'username': 'hello'
|
||||
})
|
||||
assert credentials1 is credentials2
|
||||
|
||||
with patch.object(provider, 'async_credentials',
|
||||
return_value=mock_coro([credentials1])):
|
||||
credentials3 = await provider.async_get_or_create_credentials({
|
||||
'username': 'hello '
|
||||
})
|
||||
assert credentials1 is not credentials3
|
||||
Reference in new issue
Block a user