Reorg auth (#15443)
This commit is contained in:
1 parent
23f1b49e55
commit
b6ca03ce47
23 files changed
+698
-652
No files matched your search
@@ -0,0 +1 @@
|
||||
"""Tests for the Home Assistant auth module."""
|
||||
@@ -0,0 +1 @@
|
||||
"""Tests for the auth providers."""
|
||||
@@ -0,0 +1,101 @@
|
||||
"""Test the Home Assistant local auth provider."""
|
||||
import pytest
|
||||
|
||||
from homeassistant import data_entry_flow
|
||||
from homeassistant.auth.providers import homeassistant as hass_auth
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def data(hass):
|
||||
"""Create a loaded data class."""
|
||||
data = hass_auth.Data(hass)
|
||||
hass.loop.run_until_complete(data.async_load())
|
||||
return data
|
||||
|
||||
|
||||
async def test_adding_user(data, hass):
|
||||
"""Test adding a user."""
|
||||
data.add_user('test-user', 'test-pass')
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
|
||||
|
||||
async def test_adding_user_duplicate_username(data, hass):
|
||||
"""Test adding a user."""
|
||||
data.add_user('test-user', 'test-pass')
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.add_user('test-user', 'other-pass')
|
||||
|
||||
|
||||
async def test_validating_password_invalid_user(data, hass):
|
||||
"""Test validating an invalid user."""
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('non-existing', 'pw')
|
||||
|
||||
|
||||
async def test_validating_password_invalid_password(data, hass):
|
||||
"""Test validating an invalid user."""
|
||||
data.add_user('test-user', 'test-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('test-user', 'invalid-pass')
|
||||
|
||||
|
||||
async def test_changing_password(data, hass):
|
||||
"""Test adding a user."""
|
||||
user = 'test-user'
|
||||
data.add_user(user, 'test-pass')
|
||||
data.change_password(user, 'new-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login(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')
|
||||
|
||||
|
||||
async def test_login_flow_validates(data, hass):
|
||||
"""Test login flow."""
|
||||
data.add_user('test-user', 'test-pass')
|
||||
await data.async_save()
|
||||
|
||||
provider = hass_auth.HassAuthProvider(hass, None, {})
|
||||
flow = hass_auth.LoginFlow(provider)
|
||||
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',
|
||||
})
|
||||
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
|
||||
|
||||
|
||||
async def test_saving_loading(data, hass):
|
||||
"""Test saving and loading JSON."""
|
||||
data.add_user('test-user', 'test-pass')
|
||||
data.add_user('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')
|
||||
@@ -0,0 +1,85 @@
|
||||
"""Tests for the insecure example auth provider."""
|
||||
from unittest.mock import Mock
|
||||
import uuid
|
||||
|
||||
import pytest
|
||||
|
||||
from homeassistant.auth import auth_store, models as auth_models
|
||||
from homeassistant.auth.providers import insecure_example
|
||||
|
||||
from tests.common import mock_coro
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def store(hass):
|
||||
"""Mock store."""
|
||||
return auth_store.AuthStore(hass)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def provider(hass, store):
|
||||
"""Mock provider."""
|
||||
return insecure_example.ExampleAuthProvider(hass, store, {
|
||||
'type': 'insecure_example',
|
||||
'users': [
|
||||
{
|
||||
'username': 'user-test',
|
||||
'password': 'password-test',
|
||||
},
|
||||
{
|
||||
'username': '🎉',
|
||||
'password': '😎',
|
||||
}
|
||||
]
|
||||
})
|
||||
|
||||
|
||||
async def test_create_new_credential(provider):
|
||||
"""Test that we create a new credential."""
|
||||
credentials = await provider.async_get_or_create_credentials({
|
||||
'username': 'user-test',
|
||||
'password': 'password-test',
|
||||
})
|
||||
assert credentials.is_new is True
|
||||
|
||||
|
||||
async def test_match_existing_credentials(store, provider):
|
||||
"""See if we match existing users."""
|
||||
existing = auth_models.Credentials(
|
||||
id=uuid.uuid4(),
|
||||
auth_provider_type='insecure_example',
|
||||
auth_provider_id=None,
|
||||
data={
|
||||
'username': 'user-test'
|
||||
},
|
||||
is_new=False,
|
||||
)
|
||||
provider.async_credentials = Mock(return_value=mock_coro([existing]))
|
||||
credentials = await provider.async_get_or_create_credentials({
|
||||
'username': 'user-test',
|
||||
'password': 'password-test',
|
||||
})
|
||||
assert credentials is existing
|
||||
|
||||
|
||||
async def test_verify_username(provider):
|
||||
"""Test we raise if incorrect user specified."""
|
||||
with pytest.raises(insecure_example.InvalidAuthError):
|
||||
await provider.async_validate_login(
|
||||
'non-existing-user', 'password-test')
|
||||
|
||||
|
||||
async def test_verify_password(provider):
|
||||
"""Test we raise if incorrect user specified."""
|
||||
with pytest.raises(insecure_example.InvalidAuthError):
|
||||
await provider.async_validate_login(
|
||||
'user-test', 'incorrect-password')
|
||||
|
||||
|
||||
async def test_utf_8_username_password(provider):
|
||||
"""Test that we create a new credential."""
|
||||
credentials = await provider.async_get_or_create_credentials({
|
||||
'username': '🎉',
|
||||
'password': '😎',
|
||||
})
|
||||
assert credentials.is_new is True
|
||||
@@ -0,0 +1,76 @@
|
||||
"""Tests for the legacy_api_password auth provider."""
|
||||
from unittest.mock import Mock
|
||||
|
||||
import pytest
|
||||
|
||||
from homeassistant import auth
|
||||
from homeassistant.auth import auth_store
|
||||
from homeassistant.auth.providers import legacy_api_password
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def store(hass):
|
||||
"""Mock store."""
|
||||
return auth_store.AuthStore(hass)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def provider(hass, store):
|
||||
"""Mock provider."""
|
||||
return legacy_api_password.LegacyApiPasswordAuthProvider(hass, store, {
|
||||
'type': 'legacy_api_password',
|
||||
})
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def manager(hass, store, provider):
|
||||
"""Mock manager."""
|
||||
return auth.AuthManager(hass, store, {
|
||||
(provider.type, provider.id): provider
|
||||
})
|
||||
|
||||
|
||||
async def test_create_new_credential(provider):
|
||||
"""Test that we create a new credential."""
|
||||
credentials = await provider.async_get_or_create_credentials({})
|
||||
assert credentials.data["username"] is legacy_api_password.LEGACY_USER
|
||||
assert credentials.is_new is True
|
||||
|
||||
|
||||
async def test_only_one_credentials(manager, provider):
|
||||
"""Call create twice will return same credential."""
|
||||
credentials = await provider.async_get_or_create_credentials({})
|
||||
await manager.async_get_or_create_user(credentials)
|
||||
credentials2 = await provider.async_get_or_create_credentials({})
|
||||
assert credentials2.data["username"] == legacy_api_password.LEGACY_USER
|
||||
assert credentials2.id == credentials.id
|
||||
assert credentials2.is_new is False
|
||||
|
||||
|
||||
async def test_verify_not_load(hass, provider):
|
||||
"""Test we raise if http module not load."""
|
||||
with pytest.raises(ValueError):
|
||||
provider.async_validate_login('test-password')
|
||||
hass.http = Mock(api_password=None)
|
||||
with pytest.raises(ValueError):
|
||||
provider.async_validate_login('test-password')
|
||||
hass.http = Mock(api_password='test-password')
|
||||
provider.async_validate_login('test-password')
|
||||
|
||||
|
||||
async def test_verify_login(hass, provider):
|
||||
"""Test we raise if http module not load."""
|
||||
hass.http = Mock(api_password='test-password')
|
||||
provider.async_validate_login('test-password')
|
||||
hass.http = Mock(api_password='test-password')
|
||||
with pytest.raises(legacy_api_password.InvalidAuthError):
|
||||
provider.async_validate_login('invalid-password')
|
||||
|
||||
|
||||
async def test_utf_8_username_password(provider):
|
||||
"""Test that we create a new credential."""
|
||||
credentials = await provider.async_get_or_create_credentials({
|
||||
'username': '🎉',
|
||||
'password': '😎',
|
||||
})
|
||||
assert credentials.is_new is True
|
||||
@@ -0,0 +1,293 @@
|
||||
"""Tests for the Home Assistant auth module."""
|
||||
from datetime import timedelta
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from homeassistant import auth, data_entry_flow
|
||||
from homeassistant.auth import (
|
||||
models as auth_models, auth_store, const as auth_const)
|
||||
from homeassistant.util import dt as dt_util
|
||||
from tests.common import (
|
||||
MockUser, ensure_auth_manager_loaded, flush_store, CLIENT_ID)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_hass(loop):
|
||||
"""Hass mock with minimum amount of data set to make it work with auth."""
|
||||
hass = Mock()
|
||||
hass.config.skip_pip = True
|
||||
return hass
|
||||
|
||||
|
||||
async def test_auth_manager_from_config_validates_config_and_id(mock_hass):
|
||||
"""Test get auth providers."""
|
||||
manager = await auth.auth_manager_from_config(mock_hass, [{
|
||||
'name': 'Test Name',
|
||||
'type': 'insecure_example',
|
||||
'users': [],
|
||||
}, {
|
||||
'name': 'Invalid config because no users',
|
||||
'type': 'insecure_example',
|
||||
'id': 'invalid_config',
|
||||
}, {
|
||||
'name': 'Test Name 2',
|
||||
'type': 'insecure_example',
|
||||
'id': 'another',
|
||||
'users': [],
|
||||
}, {
|
||||
'name': 'Wrong because duplicate ID',
|
||||
'type': 'insecure_example',
|
||||
'id': 'another',
|
||||
'users': [],
|
||||
}])
|
||||
|
||||
providers = [{
|
||||
'name': provider.name,
|
||||
'id': provider.id,
|
||||
'type': provider.type,
|
||||
} for provider in manager.async_auth_providers]
|
||||
assert providers == [{
|
||||
'name': 'Test Name',
|
||||
'type': 'insecure_example',
|
||||
'id': None,
|
||||
}, {
|
||||
'name': 'Test Name 2',
|
||||
'type': 'insecure_example',
|
||||
'id': 'another',
|
||||
}]
|
||||
|
||||
|
||||
async def test_create_new_user(hass, hass_storage):
|
||||
"""Test creating new user."""
|
||||
manager = await auth.auth_manager_from_config(hass, [{
|
||||
'type': 'insecure_example',
|
||||
'users': [{
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
'name': 'Test Name'
|
||||
}]
|
||||
}])
|
||||
|
||||
step = await manager.login_flow.async_init(('insecure_example', None))
|
||||
assert step['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
|
||||
step = await manager.login_flow.async_configure(step['flow_id'], {
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
assert step['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
credentials = step['result']
|
||||
user = await manager.async_get_or_create_user(credentials)
|
||||
assert user is not None
|
||||
assert user.is_owner is True
|
||||
assert user.name == 'Test Name'
|
||||
|
||||
|
||||
async def test_login_as_existing_user(mock_hass):
|
||||
"""Test login as existing user."""
|
||||
manager = await auth.auth_manager_from_config(mock_hass, [{
|
||||
'type': 'insecure_example',
|
||||
'users': [{
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
'name': 'Test Name'
|
||||
}]
|
||||
}])
|
||||
ensure_auth_manager_loaded(manager)
|
||||
|
||||
# Add a fake user that we're not going to log in with
|
||||
user = MockUser(
|
||||
id='mock-user2',
|
||||
is_owner=False,
|
||||
is_active=False,
|
||||
name='Not user',
|
||||
).add_to_auth_manager(manager)
|
||||
user.credentials.append(auth_models.Credentials(
|
||||
id='mock-id2',
|
||||
auth_provider_type='insecure_example',
|
||||
auth_provider_id=None,
|
||||
data={'username': 'other-user'},
|
||||
is_new=False,
|
||||
))
|
||||
|
||||
# Add fake user with credentials for example auth provider.
|
||||
user = MockUser(
|
||||
id='mock-user',
|
||||
is_owner=False,
|
||||
is_active=False,
|
||||
name='Paulus',
|
||||
).add_to_auth_manager(manager)
|
||||
user.credentials.append(auth_models.Credentials(
|
||||
id='mock-id',
|
||||
auth_provider_type='insecure_example',
|
||||
auth_provider_id=None,
|
||||
data={'username': 'test-user'},
|
||||
is_new=False,
|
||||
))
|
||||
|
||||
step = await manager.login_flow.async_init(('insecure_example', None))
|
||||
assert step['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
|
||||
step = await manager.login_flow.async_configure(step['flow_id'], {
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
assert step['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
credentials = step['result']
|
||||
|
||||
user = await manager.async_get_or_create_user(credentials)
|
||||
assert user is not None
|
||||
assert user.id == 'mock-user'
|
||||
assert user.is_owner is False
|
||||
assert user.is_active is False
|
||||
assert user.name == 'Paulus'
|
||||
|
||||
|
||||
async def test_linking_user_to_two_auth_providers(hass, hass_storage):
|
||||
"""Test linking user to two auth providers."""
|
||||
manager = await auth.auth_manager_from_config(hass, [{
|
||||
'type': 'insecure_example',
|
||||
'users': [{
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
}]
|
||||
}, {
|
||||
'type': 'insecure_example',
|
||||
'id': 'another-provider',
|
||||
'users': [{
|
||||
'username': 'another-user',
|
||||
'password': 'another-password',
|
||||
}]
|
||||
}])
|
||||
|
||||
step = await manager.login_flow.async_init(('insecure_example', None))
|
||||
step = await manager.login_flow.async_configure(step['flow_id'], {
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
user = await manager.async_get_or_create_user(step['result'])
|
||||
assert user is not None
|
||||
|
||||
step = await manager.login_flow.async_init(('insecure_example',
|
||||
'another-provider'))
|
||||
step = await manager.login_flow.async_configure(step['flow_id'], {
|
||||
'username': 'another-user',
|
||||
'password': 'another-password',
|
||||
})
|
||||
await manager.async_link_user(user, step['result'])
|
||||
assert len(user.credentials) == 2
|
||||
|
||||
|
||||
async def test_saving_loading(hass, hass_storage):
|
||||
"""Test storing and saving data.
|
||||
|
||||
Creates one of each type that we store to test we restore correctly.
|
||||
"""
|
||||
manager = await auth.auth_manager_from_config(hass, [{
|
||||
'type': 'insecure_example',
|
||||
'users': [{
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
}]
|
||||
}])
|
||||
|
||||
step = await manager.login_flow.async_init(('insecure_example', None))
|
||||
step = await manager.login_flow.async_configure(step['flow_id'], {
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
user = await manager.async_get_or_create_user(step['result'])
|
||||
|
||||
refresh_token = await manager.async_create_refresh_token(user, CLIENT_ID)
|
||||
|
||||
manager.async_create_access_token(refresh_token)
|
||||
|
||||
await flush_store(manager._store._store)
|
||||
|
||||
store2 = auth_store.AuthStore(hass)
|
||||
users = await store2.async_get_users()
|
||||
assert len(users) == 1
|
||||
assert users[0] == user
|
||||
|
||||
|
||||
def test_access_token_expired():
|
||||
"""Test that the expired property on access tokens work."""
|
||||
refresh_token = auth_models.RefreshToken(
|
||||
user=None,
|
||||
client_id='bla'
|
||||
)
|
||||
|
||||
access_token = auth_models.AccessToken(
|
||||
refresh_token=refresh_token
|
||||
)
|
||||
|
||||
assert access_token.expired is False
|
||||
|
||||
with patch('homeassistant.util.dt.utcnow',
|
||||
return_value=dt_util.utcnow() +
|
||||
auth_const.ACCESS_TOKEN_EXPIRATION):
|
||||
assert access_token.expired is True
|
||||
|
||||
almost_exp = \
|
||||
dt_util.utcnow() + auth_const.ACCESS_TOKEN_EXPIRATION - timedelta(1)
|
||||
with patch('homeassistant.util.dt.utcnow', return_value=almost_exp):
|
||||
assert access_token.expired is False
|
||||
|
||||
|
||||
async def test_cannot_retrieve_expired_access_token(hass):
|
||||
"""Test that we cannot retrieve expired access tokens."""
|
||||
manager = await auth.auth_manager_from_config(hass, [])
|
||||
user = MockUser().add_to_auth_manager(manager)
|
||||
refresh_token = await manager.async_create_refresh_token(user, CLIENT_ID)
|
||||
assert refresh_token.user.id is user.id
|
||||
assert refresh_token.client_id == CLIENT_ID
|
||||
|
||||
access_token = manager.async_create_access_token(refresh_token)
|
||||
assert manager.async_get_access_token(access_token.token) is access_token
|
||||
|
||||
with patch('homeassistant.util.dt.utcnow',
|
||||
return_value=dt_util.utcnow() +
|
||||
auth_const.ACCESS_TOKEN_EXPIRATION):
|
||||
assert manager.async_get_access_token(access_token.token) is None
|
||||
|
||||
# Even with unpatched time, it should have been removed from manager
|
||||
assert manager.async_get_access_token(access_token.token) is None
|
||||
|
||||
|
||||
async def test_generating_system_user(hass):
|
||||
"""Test that we can add a system user."""
|
||||
manager = await auth.auth_manager_from_config(hass, [])
|
||||
user = await manager.async_create_system_user('Hass.io')
|
||||
token = await manager.async_create_refresh_token(user)
|
||||
assert user.system_generated
|
||||
assert token is not None
|
||||
assert token.client_id is None
|
||||
|
||||
|
||||
async def test_refresh_token_requires_client_for_user(hass):
|
||||
"""Test that we can add a system user."""
|
||||
manager = await auth.auth_manager_from_config(hass, [])
|
||||
user = MockUser().add_to_auth_manager(manager)
|
||||
assert user.system_generated is False
|
||||
|
||||
with pytest.raises(ValueError):
|
||||
await manager.async_create_refresh_token(user)
|
||||
|
||||
token = await manager.async_create_refresh_token(user, CLIENT_ID)
|
||||
assert token is not None
|
||||
assert token.client_id == CLIENT_ID
|
||||
|
||||
|
||||
async def test_refresh_token_not_requires_client_for_system_user(hass):
|
||||
"""Test that we can add a system user."""
|
||||
manager = await auth.auth_manager_from_config(hass, [])
|
||||
user = await manager.async_create_system_user('Hass.io')
|
||||
assert user.system_generated is True
|
||||
|
||||
with pytest.raises(ValueError):
|
||||
await manager.async_create_refresh_token(user, CLIENT_ID)
|
||||
|
||||
token = await manager.async_create_refresh_token(user)
|
||||
assert token is not None
|
||||
assert token.client_id is None
|
||||
Reference in new issue
Block a user