Skip to content

Auth

auth

AuthDependencySpec

Bases: BaseModel

A value-less authentication dependency and its state source.

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class AuthDependencySpec(BaseModel):  # type: ignore[explicit-any]
    """A value-less authentication dependency and its state source."""

    model_config = ConfigDict(
        frozen=True,
        extra="forbid",
        arbitrary_types_allowed=True,
    )

    name: str
    login_command: str
    """Command a human runs to restore the authenticated session."""
    _source: AuthSource = PrivateAttr()

    def __init__(self, *, name: str, source: object, **data: object) -> None:
        if not isinstance(source, AuthSource):
            raise UnsupportedAuthDeclarationError(
                f"authentication dependency {name!r} has no valid AuthSource"
            )
        super().__init__(name=name, **data)
        self._source = source

    def status(self) -> AuthStatus:
        """Return the source's current tri-state authentication status."""
        return self._source.status()

    @model_validator(mode="after")
    def _require_login_command(self) -> Self:
        # A model validator (not a field validator) so that it still runs when
        # a subclass redeclares ``login_command``.
        if not self.login_command.strip():
            msg = (
                f"authentication dependency {self.name!r} must declare a "
                "non-empty login_command"
            )
            raise ValueError(msg)
        return self
login_command instance-attribute

Command a human runs to restore the authenticated session.

status()

Return the source's current tri-state authentication status.

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
59
60
61
def status(self) -> AuthStatus:
    """Return the source's current tri-state authentication status."""
    return self._source.status()

AuthSource

Bases: Protocol

Capability supplied by packages declaring an authentication dependency.

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
24
25
26
27
28
29
30
@runtime_checkable
class AuthSource(Protocol):
    """Capability supplied by packages declaring an authentication dependency."""

    def status(self) -> AuthStatus:
        """Observe the dependency without reading authentication material."""
        ...
status()

Observe the dependency without reading authentication material.

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
28
29
30
def status(self) -> AuthStatus:
    """Observe the dependency without reading authentication material."""
    ...

AuthStatus

Bases: StrEnum

Observed state of an authentication dependency.

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
16
17
18
19
20
21
class AuthStatus(StrEnum):
    """Observed state of an authentication dependency."""

    CONNECTED = "connected"
    DISCONNECTED = "disconnected"
    TOOL_ABSENT = "tool_absent"

UnsupportedAuthDeclarationError

Bases: RuntimeError

Raised when an authentication declarer does not implement AuthSource.

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
33
34
class UnsupportedAuthDeclarationError(RuntimeError):
    """Raised when an authentication declarer does not implement AuthSource."""