harnest.auth

All Python modules · Import and compatibility guidance

Exports

Name	Kind
`ANONYMOUS_USER_ID`	Value or type alias
`AnonymousAuthenticator`	Class
`AuthPrincipal`	Class
`AuthenticationError`	Class
`Authenticator`	Class
`ConnectionContext`	Class
`install_authentication`	Function
`principal_for`	Function

ANONYMOUS_USER_ID

ANONYMOUS_USER_ID = '_harnest_neutral'

Example

from harnest.auth import ANONYMOUS_USER_ID

AnonymousAuthenticator

Development default that preserves the local single-user behavior.

AnonymousAuthenticator()

Example

from harnest.auth import AnonymousAuthenticator

authenticator = AnonymousAuthenticator()

AnonymousAuthenticator.authenticate

async AnonymousAuthenticator.authenticate(connection: Any) -> AuthPrincipal

Return the built-in anonymous principal for every connection.

Parameters and example

Parameter	Type	Default
`connection`	`Any`	Required

from harnest.auth import AnonymousAuthenticator

authenticator: AnonymousAuthenticator
principal = await authenticator.authenticate(connection=...)

AuthPrincipal

A verified tenant/user identity supplied by a deployment authenticator.

AuthPrincipal(
    user_id: str,
    claims: Mapping[str, Any] = ...,
    credentials: Mapping[str, Credential] = ...,
) -> None

Fields (— means no declared default):

Field	Type	Default
`user_id`	`str`	`—`
`claims`	`Mapping[str, Any]`	`<lambda>()`
`credentials`	`Mapping[str, Credential]`	`<lambda>()`

Parameters and example

Parameter	Type	Default
`user_id`	`str`	Required
`claims`	`Mapping[str, Any]`	`...`
`credentials`	`Mapping[str, Credential]`	`...`

from harnest.auth import AuthPrincipal

principal = AuthPrincipal(user_id=...)

AuthenticationError

A request did not satisfy the deployment authentication policy.

AuthenticationError(detail: str = 'Authentication required', *, status_code: int = 401) -> None

Example

from harnest.auth import AuthenticationError

try:
    ...
except AuthenticationError as error:
    ...

Authenticator

Resolve one HTTP or WebSocket connection to a verified principal.

Authenticator(*args, **kwargs)

Example

from harnest.auth import Authenticator

class MyAuthenticator(Authenticator):
    ...

Authenticator.authenticate

async Authenticator.authenticate(connection: Any) -> AuthPrincipal

Return the authenticated principal for one incoming connection.

Parameters and example

Parameter	Type	Default
`connection`	`Any`	Required

from harnest.auth import Authenticator

authenticator: Authenticator
principal = await authenticator.authenticate(connection=...)

ConnectionContext

Framework-independent, read-only connection data for authentication.

ConnectionContext(
    transport: str,
    method: str | None,
    path: str,
    headers: Mapping[str, str],
    cookies: Mapping[str, str],
    query: Mapping[str, str],
) -> None

Fields (— means no declared default):

Field	Type	Default
`transport`	`str`	`—`
`method`	`str \| None`	`—`
`path`	`str`	`—`
`headers`	`Mapping[str, str]`	`—`
`cookies`	`Mapping[str, str]`	`—`
`query`	`Mapping[str, str]`	`—`

Parameters and example

Parameter	Type	Default
`transport`	`str`	Required
`method`	`str \| None`	Required
`path`	`str`	Required
`headers`	`Mapping[str, str]`	Required
`cookies`	`Mapping[str, str]`	Required
`query`	`Mapping[str, str]`	Required

from harnest.auth import ConnectionContext

context = ConnectionContext(
    transport=...,
    method=...,
    path=...,
    headers=...,
    cookies=...,
    query=...,
)

install_authentication

Protect execution/session routes while leaving discovery public.

install_authentication(app: Any, authenticator: Authenticator | None) -> None

Parameters and example

Parameter	Type	Default
`app`	`Any`	Required
`authenticator`	`Authenticator \| None`	Required

from harnest.auth import install_authentication

install_authentication(app=..., authenticator=...)

principal_for

Read the principal installed before a protected route executes.

principal_for(connection: Any) -> AuthPrincipal

Parameters and example

Parameter	Type	Default
`connection`	`Any`	Required

from harnest.auth import principal_for

principal = principal_for(connection=...)

Overview

Get started

Harnest Studio

Guides

API reference

harnest.auth

Exports

ANONYMOUS_USER_ID

AnonymousAuthenticator

AnonymousAuthenticator.authenticate

AuthPrincipal

AuthenticationError

Authenticator

Authenticator.authenticate

ConnectionContext

install_authentication

principal_for

​Exports

​ANONYMOUS_USER_ID

​AnonymousAuthenticator

​AnonymousAuthenticator.authenticate

​AuthPrincipal

​AuthenticationError

​Authenticator

​Authenticator.authenticate

​ConnectionContext

​install_authentication

​principal_for

Exports

ANONYMOUS_USER_ID

AnonymousAuthenticator

AnonymousAuthenticator.authenticate

AuthPrincipal

AuthenticationError

Authenticator

Authenticator.authenticate

ConnectionContext

install_authentication

principal_for