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
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
    _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()
status()

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

Source code in packages/axm-vault/src/axm_vault/auth.py
Python
57
58
59
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."""