Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

24.4 KB
Raw Blame
"""Unit tests for the framework-neutral Web authentication application service."""

from dataclasses import dataclass, field
from datetime import datetime

import pytest

from enums import WebAppAccessMode
from machinery.context import RequestContext
from services.entities.account_entities import AccountAuthenticationSnapshot, AccountPasswordDigest, AccountSnapshot
from services.entities.auth_audit_entities import LoginFailureReason
from services.entities.authentication_entities import StoredAuthenticationToken
from services.web_authentication_service import (
    WebAccountBannedError,
    WebAuthenticationFailedError,
    WebAuthenticationService,
    WebEmailSendIPLimitedError,
    WebInvalidCodeError,
    WebInvalidEmailError,
    WebInvalidTokenError,
    WebPasswordMismatchError,
    WebPasswordResetVerificationLimitedError,
)
from services.webapp_access_query_service import WebAppAccessAppNotFoundError


@dataclass
class AccountRepositoryFake:
    accounts: dict[str, AccountAuthenticationSnapshot]
    updated: tuple[str, AccountPasswordDigest] | None = None
    update_succeeds: bool = True

    def find_for_authentication(self, email: str) -> AccountAuthenticationSnapshot | None:
        return self.accounts.get(email) or self.accounts.get(email.lower())

    def update_password(self, account_id: str, password: AccountPasswordDigest) -> AccountSnapshot | None:
        self.updated = (account_id, password)
        if not self.update_succeeds:
            return None
        account = next((account for account in self.accounts.values() if account.id == account_id), None)
        if account is None:
            return None
        return AccountSnapshot(
            id=account.id,
            name="Account",
            email=account.email,
            avatar=None,
            is_password_set=True,
            interface_language="en-US",
            interface_theme="light",
            timezone="UTC",
            last_login_at=None,
            last_login_ip=None,
            status=account.status,
            initialized_at=None,
            created_at=datetime(2026, 1, 1),
        )


class PasswordHasherFake:
    def verify(self, password: str, *, password_hash: str, password_salt: str) -> bool:
        return (password, password_hash, password_salt) == ("Valid1234", "hash", "salt")

    def hash(self, password: str) -> AccountPasswordDigest:
        return AccountPasswordDigest(password_hash=f"hashed:{password}", password_salt="new-salt")


@dataclass
class TokenGatewayFake:
    email_login_token: StoredAuthenticationToken | None = None
    reset_token: StoredAuthenticationToken | None = None
    revoked: list[tuple[str, str]] = field(default_factory=list)

    def issue_access_token(self, *, account_id: str, email: str) -> str:
        return f"access:{account_id}:{email}"

    def verify_access_token(self, token: str | None) -> bool:
        return token == "valid-access"

    def send_email_login_code(self, *, account_id: str, email: str, language: str) -> str:
        return f"email:{account_id}:{email}:{language}"

    def get_email_login_token(self, token: str) -> StoredAuthenticationToken | None:
        del token
        return self.email_login_token

    def revoke_email_login_token(self, token: str) -> None:
        self.revoked.append(("email", token))

    def send_reset_password_code(self, *, account_id: str, email: str, language: str) -> str:
        return f"reset:{account_id}:{email}:{language}"

    def get_reset_password_token(self, token: str) -> StoredAuthenticationToken | None:
        del token
        return self.reset_token

    def replace_reset_password_token(self, *, email: str, code: str) -> str:
        return f"replacement:{email}:{code}"

    def revoke_reset_password_token(self, token: str) -> None:
        self.revoked.append(("reset", token))


@dataclass
class SecurityGatewayFake:
    ip_limited: bool = False
    reset_limited: bool = False
    reset_failures: list[str] = field(default_factory=list)
    reset_cleared: list[str] = field(default_factory=list)
    login_cleared: list[str] = field(default_factory=list)

    def is_email_send_ip_limited(self, ip_address: str) -> bool:
        del ip_address
        return self.ip_limited

    def is_password_reset_verification_limited(self, email: str) -> bool:
        del email
        return self.reset_limited

    def record_password_reset_verification_failure(self, email: str) -> None:
        self.reset_failures.append(email)

    def reset_password_reset_verification_failures(self, email: str) -> None:
        self.reset_cleared.append(email)

    def reset_login_failures(self, email: str) -> None:
        self.login_cleared.append(email)


@dataclass
class AppAccessGatewayFake:
    permission_required: bool = True

    def find_app_id_by_code(self, app_code: str) -> str | None:
        return "app-1" if app_code == "site-code" else None

    def requires_permission_check(self, app_id: str) -> bool:
        del app_id
        return self.permission_required

    def get_access_mode(self, *, app_id: str | None, app_code: str | None) -> WebAppAccessMode:
        raise AssertionError(f"unused in authentication service: {app_id}, {app_code}")

    def is_user_allowed(self, *, user_id: str, app_id: str) -> bool:
        del user_id, app_id
        return True


@dataclass
class AppSessionGatewayFake:
    valid: bool = False

    def verify(self, *, token: str | None, app_code: str, user_id: str | None) -> bool:
        del app_code, user_id
        return self.valid and token == "valid-passport"


@dataclass
class AuditGatewayFake:
    failures: list[tuple[str, LoginFailureReason, str]] = field(default_factory=list)

    def login_failed(self, *, email: str, reason: LoginFailureReason, ip_address: str) -> None:
        self.failures.append((email, reason, ip_address))


@dataclass
class ServiceFixture:
    service: WebAuthenticationService
    accounts: AccountRepositoryFake
    tokens: TokenGatewayFake
    security: SecurityGatewayFake
    app_access: AppAccessGatewayFake
    app_sessions: AppSessionGatewayFake
    audit: AuditGatewayFake


@pytest.fixture
def service_fixture() -> ServiceFixture:
    account = AccountAuthenticationSnapshot(
        id="account-1",
        email="[email protected]",
        status="active",
        password_hash="hash",
        password_salt="salt",
    )
    accounts = AccountRepositoryFake({"[email protected]": account})
    tokens = TokenGatewayFake()
    security = SecurityGatewayFake()
    app_access = AppAccessGatewayFake()
    app_sessions = AppSessionGatewayFake()
    audit = AuditGatewayFake()
    service = WebAuthenticationService(
        accounts=accounts,
        passwords=PasswordHasherFake(),
        tokens=tokens,
        security=security,
        app_access=app_access,
        app_sessions=app_sessions,
        audit=audit,
        private_app_access_enabled=True,
    )
    return ServiceFixture(service, accounts, tokens, security, app_access, app_sessions, audit)


def request_context() -> RequestContext:
    return RequestContext("request-1", "trace-1", "", "", "127.0.0.1")


def test_password_login_authenticates_and_issues_token(service_fixture: ServiceFixture) -> None:
    token = service_fixture.service.login_with_password(
        request_context(),
        email="[email protected]",
        password="Valid1234",
    )

    assert token == "access:account-1:[email protected]"
    assert service_fixture.audit.failures == []


@pytest.mark.parametrize(
    ("email", "password", "reason"),
    [
        pytest.param("[email protected]", "Valid1234", LoginFailureReason.ACCOUNT_NOT_FOUND, id="missing"),
        pytest.param("[email protected]", "wrong", LoginFailureReason.INVALID_CREDENTIALS, id="password"),
    ],
)
def test_password_login_audits_rejected_credentials(
    service_fixture: ServiceFixture,
    email: str,
    password: str,
    reason: LoginFailureReason,
) -> None:
    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.login_with_password(request_context(), email=email, password=password)

    assert service_fixture.audit.failures == [(email, reason, "127.0.0.1")]


def test_password_login_rejects_banned_account(service_fixture: ServiceFixture) -> None:
    account = service_fixture.accounts.accounts["[email protected]"]
    service_fixture.accounts.accounts["[email protected]"] = AccountAuthenticationSnapshot(
        id=account.id,
        email=account.email,
        status="banned",
        password_hash=account.password_hash,
        password_salt=account.password_salt,
    )

    with pytest.raises(WebAccountBannedError):
        service_fixture.service.login_with_password(
            request_context(),
            email="[email protected]",
            password="Valid1234",
        )

    assert service_fixture.audit.failures[0][1] == LoginFailureReason.ACCOUNT_BANNED


def test_email_code_login_verifies_reissues_and_clears_failures(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.email_login_token = StoredAuthenticationToken(
        email="[email protected]",
        code="123456",
    )

    token = service_fixture.service.login_with_email_code(
        request_context(),
        email="[email protected]",
        code="123456",
        token="challenge",
    )

    assert token == "access:account-1:[email protected]"
    assert service_fixture.tokens.revoked == [("email", "challenge")]
    assert service_fixture.security.login_cleared == ["[email protected]"]


def test_email_code_login_audits_invalid_code(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.email_login_token = StoredAuthenticationToken(email="[email protected]", code="123456")

    with pytest.raises(WebInvalidCodeError):
        service_fixture.service.login_with_email_code(
            request_context(),
            email="[email protected]",
            code="wrong",
            token="challenge",
        )

    assert service_fixture.audit.failures[0][1] == LoginFailureReason.INVALID_EMAIL_CODE


def test_forgot_password_send_applies_ip_limit(service_fixture: ServiceFixture) -> None:
    service_fixture.security.ip_limited = True

    with pytest.raises(WebEmailSendIPLimitedError):
        service_fixture.service.send_reset_password_email(
            request_context(),
            email="[email protected]",
            language=None,
        )


def test_reset_verification_rotates_token_and_clears_failures(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(email="[email protected]", code="1234")

    token = service_fixture.service.verify_reset_password_code(
        email="[email protected]",
        code="1234",
        token="verification-token",
    )

    assert token == "replacement:[email protected]:1234"
    assert service_fixture.tokens.revoked == [("reset", "verification-token")]
    assert service_fixture.security.reset_cleared == ["[email protected]"]


def test_password_reset_updates_through_repository(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(
        email="[email protected]",
        code="1234",
        phase="reset",
    )

    service_fixture.service.reset_password(
        token="reset-token",
        new_password="NewValid123!",
        password_confirmation="NewValid123!",
    )

    assert service_fixture.tokens.revoked == [("reset", "reset-token")]
    assert service_fixture.accounts.updated == (
        "account-1",
        AccountPasswordDigest(password_hash="hashed:NewValid123!", password_salt="new-salt"),
    )


def test_password_reset_rejects_mismatch_before_reading_token(service_fixture: ServiceFixture) -> None:
    with pytest.raises(WebPasswordMismatchError):
        service_fixture.service.reset_password(
            token="reset-token",
            new_password="one",
            password_confirmation="two",
        )


def test_login_status_uses_access_and_app_session_gateways(service_fixture: ServiceFixture) -> None:
    service_fixture.app_sessions.valid = True

    status = service_fixture.service.get_login_status(
        app_code="site-code",
        user_id="session-1",
        access_token="valid-access",
        app_session_token="valid-passport",
    )

    assert status.logged_in is True
    assert status.app_logged_in is True


def test_login_status_without_app_code_uses_token_presence_check(
    service_fixture: ServiceFixture,
) -> None:
    status = service_fixture.service.get_login_status(
        app_code=None,
        user_id=None,
        access_token="not-verified-here",
        app_session_token=None,
    )

    assert status.logged_in is True
    assert status.app_logged_in is False


def test_reset_rejects_token_outside_reset_phase(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(email="[email protected]", code="1234")

    with pytest.raises(WebInvalidTokenError):
        service_fixture.service.reset_password(
            token="verification-token",
            new_password="NewValid123!",
            password_confirmation="NewValid123!",
        )


@pytest.mark.parametrize(
    ("password_hash", "password_salt"),
    [
        pytest.param(None, "salt", id="missing-hash"),
        pytest.param("hash", None, id="missing-salt"),
    ],
)
def test_password_login_rejects_account_without_complete_password_digest(
    service_fixture: ServiceFixture,
    password_hash: str | None,
    password_salt: str | None,
) -> None:
    service_fixture.accounts.accounts["[email protected]"] = AccountAuthenticationSnapshot(
        id="account-1",
        email="[email protected]",
        status="active",
        password_hash=password_hash,
        password_salt=password_salt,
    )

    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.login_with_password(
            request_context(),
            email="[email protected]",
            password="Valid1234",
        )

    assert service_fixture.audit.failures == [("[email protected]", LoginFailureReason.INVALID_CREDENTIALS, "127.0.0.1")]


def test_login_status_rejects_unknown_app_code(service_fixture: ServiceFixture) -> None:
    with pytest.raises(WebAppAccessAppNotFoundError, match="App with code missing-code not found"):
        service_fixture.service.get_login_status(
            app_code="missing-code",
            user_id=None,
            access_token=None,
            app_session_token=None,
        )


@pytest.mark.parametrize(
    ("private_access_enabled", "permission_required", "expected_logged_in"),
    [
        pytest.param(False, True, True, id="private-access-disabled"),
        pytest.param(True, False, True, id="permission-not-required"),
        pytest.param(True, True, False, id="private-and-no-token"),
    ],
)
def test_login_status_applies_public_access_policy(
    service_fixture: ServiceFixture,
    private_access_enabled: bool,
    permission_required: bool,
    expected_logged_in: bool,
) -> None:
    service_fixture.app_access.permission_required = permission_required
    service = WebAuthenticationService(
        accounts=service_fixture.accounts,
        passwords=PasswordHasherFake(),
        tokens=service_fixture.tokens,
        security=service_fixture.security,
        app_access=service_fixture.app_access,
        app_sessions=service_fixture.app_sessions,
        audit=service_fixture.audit,
        private_app_access_enabled=private_access_enabled,
    )

    status = service.get_login_status(
        app_code="site-code",
        user_id=None,
        access_token=None,
        app_session_token=None,
    )

    assert status.logged_in is expected_logged_in
    assert status.app_logged_in is False


@pytest.mark.parametrize(
    ("language", "expected_language"),
    [
        pytest.param(None, "en-US", id="default"),
        pytest.param("zh-Hans", "zh-Hans", id="simplified-chinese"),
    ],
)
def test_send_email_login_code_uses_supported_language(
    service_fixture: ServiceFixture,
    language: str | None,
    expected_language: str,
) -> None:
    token = service_fixture.service.send_email_login_code(email="[email protected]", language=language)

    assert token == f"email:account-1:[email protected]:{expected_language}"


@pytest.mark.parametrize(
    ("account_status", "error"),
    [
        pytest.param(None, WebAuthenticationFailedError, id="missing-account"),
        pytest.param("banned", WebAccountBannedError, id="banned-account"),
    ],
)
def test_send_email_login_code_rejects_ineligible_account(
    service_fixture: ServiceFixture,
    account_status: str | None,
    error: type[Exception],
) -> None:
    if account_status is None:
        service_fixture.accounts.accounts.clear()
    else:
        service_fixture.accounts.accounts["[email protected]"] = AccountAuthenticationSnapshot(
            id="account-1",
            email="[email protected]",
            status=account_status,
            password_hash="hash",
            password_salt="salt",
        )

    with pytest.raises(error):
        service_fixture.service.send_email_login_code(email="[email protected]", language=None)


@pytest.mark.parametrize(
    ("token_data", "error", "reason"),
    [
        pytest.param(
            None,
            WebInvalidTokenError,
            LoginFailureReason.INVALID_EMAIL_CODE_TOKEN,
            id="missing-token",
        ),
        pytest.param(
            StoredAuthenticationToken(email=None, code="123456"),
            WebInvalidEmailError,
            LoginFailureReason.EMAIL_CODE_EMAIL_MISMATCH,
            id="missing-email",
        ),
        pytest.param(
            StoredAuthenticationToken(email="[email protected]", code="123456"),
            WebInvalidEmailError,
            LoginFailureReason.EMAIL_CODE_EMAIL_MISMATCH,
            id="different-email",
        ),
    ],
)
def test_email_code_login_rejects_invalid_token_identity(
    service_fixture: ServiceFixture,
    token_data: StoredAuthenticationToken | None,
    error: type[Exception],
    reason: LoginFailureReason,
) -> None:
    service_fixture.tokens.email_login_token = token_data

    with pytest.raises(error):
        service_fixture.service.login_with_email_code(
            request_context(),
            email="[email protected]",
            code="123456",
            token="challenge",
        )

    assert service_fixture.audit.failures == [("[email protected]", reason, "127.0.0.1")]
    assert service_fixture.tokens.revoked == []


def test_email_code_login_audits_account_removed_after_challenge_was_issued(
    service_fixture: ServiceFixture,
) -> None:
    service_fixture.tokens.email_login_token = StoredAuthenticationToken(
        email="[email protected]",
        code="123456",
    )

    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.login_with_email_code(
            request_context(),
            email="[email protected]",
            code="123456",
            token="challenge",
        )

    assert service_fixture.tokens.revoked == [("email", "challenge")]
    assert service_fixture.audit.failures == [
        ("[email protected]", LoginFailureReason.ACCOUNT_NOT_FOUND, "127.0.0.1")
    ]


def test_email_code_login_rejects_account_banned_after_challenge_was_issued(
    service_fixture: ServiceFixture,
) -> None:
    account = service_fixture.accounts.accounts["[email protected]"]
    service_fixture.accounts.accounts["[email protected]"] = AccountAuthenticationSnapshot(
        id=account.id,
        email=account.email,
        status="banned",
        password_hash=account.password_hash,
        password_salt=account.password_salt,
    )
    service_fixture.tokens.email_login_token = StoredAuthenticationToken(email=account.email, code="123456")

    with pytest.raises(WebAccountBannedError):
        service_fixture.service.login_with_email_code(
            request_context(),
            email=account.email,
            code="123456",
            token="challenge",
        )

    assert service_fixture.tokens.revoked == [("email", "challenge")]
    assert service_fixture.audit.failures[0][1] == LoginFailureReason.ACCOUNT_BANNED


def test_send_reset_password_email_issues_challenge_with_default_language(
    service_fixture: ServiceFixture,
) -> None:
    token = service_fixture.service.send_reset_password_email(
        request_context(),
        email="[email protected]",
        language=None,
    )

    assert token == "reset:account-1:[email protected]:en-US"


def test_send_reset_password_email_rejects_missing_account(service_fixture: ServiceFixture) -> None:
    service_fixture.accounts.accounts.clear()

    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.send_reset_password_email(
            request_context(),
            email="[email protected]",
            language=None,
        )


def test_reset_verification_rejects_rate_limited_email(service_fixture: ServiceFixture) -> None:
    service_fixture.security.reset_limited = True

    with pytest.raises(WebPasswordResetVerificationLimitedError):
        service_fixture.service.verify_reset_password_code(
            email="[email protected]",
            code="123456",
            token="challenge",
        )


def test_reset_verification_rejects_missing_token(service_fixture: ServiceFixture) -> None:
    with pytest.raises(WebInvalidTokenError):
        service_fixture.service.verify_reset_password_code(
            email="[email protected]",
            code="123456",
            token="missing",
        )


@pytest.mark.parametrize(
    "token_email",
    [
        pytest.param(None, id="missing-email"),
        pytest.param("[email protected]", id="different-email"),
    ],
)
def test_reset_verification_rejects_token_for_another_email(
    service_fixture: ServiceFixture,
    token_email: str | None,
) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(email=token_email, code="123456")

    with pytest.raises(WebInvalidEmailError):
        service_fixture.service.verify_reset_password_code(
            email="[email protected]",
            code="123456",
            token="challenge",
        )


def test_reset_verification_records_incorrect_code(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(email="[email protected]", code="123456")

    with pytest.raises(WebInvalidCodeError):
        service_fixture.service.verify_reset_password_code(
            email="[email protected]",
            code="wrong",
            token="challenge",
        )

    assert service_fixture.security.reset_failures == ["[email protected]"]
    assert service_fixture.tokens.revoked == []


def test_password_reset_rejects_missing_token(service_fixture: ServiceFixture) -> None:
    with pytest.raises(WebInvalidTokenError):
        service_fixture.service.reset_password(
            token="missing",
            new_password="NewValid123!",
            password_confirmation="NewValid123!",
        )


def test_password_reset_rejects_token_without_email_after_revocation(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(email=None, code="123456", phase="reset")

    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.reset_password(
            token="challenge",
            new_password="NewValid123!",
            password_confirmation="NewValid123!",
        )

    assert service_fixture.tokens.revoked == [("reset", "challenge")]


def test_password_reset_rejects_account_removed_after_verification(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(
        email="[email protected]",
        code="123456",
        phase="reset",
    )

    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.reset_password(
            token="challenge",
            new_password="NewValid123!",
            password_confirmation="NewValid123!",
        )

    assert service_fixture.tokens.revoked == [("reset", "challenge")]


def test_password_reset_rejects_failed_repository_update(service_fixture: ServiceFixture) -> None:
    service_fixture.tokens.reset_token = StoredAuthenticationToken(
        email="[email protected]",
        code="123456",
        phase="reset",
    )
    service_fixture.accounts.update_succeeds = False

    with pytest.raises(WebAuthenticationFailedError):
        service_fixture.service.reset_password(
            token="challenge",
            new_password="NewValid123!",
            password_confirmation="NewValid123!",
        )

    assert service_fixture.accounts.updated == (
        "account-1",
        AccountPasswordDigest(password_hash="hashed:NewValid123!", password_salt="new-salt"),
    )