org.models.tan

Module Contents

Classes

TAN	A single use TAN for temporarily elevating access through e.g.
_GeneratedTAN	A single use TAN for temporarily elevating access through e.g.
TANCollection	Abstract base class for generic types.
TANAccess	This exists to keep track of which protected URLs have been accesed
TANAccessCollection	Abstract base class for generic types.

Functions

generate_tan(→ str)

Attributes

ALPHABET
DEFAULT_EXPIRES_AFTER
DEFAULT_ACCESS_WINDOW

org.models.tan.ALPHABET = 'ABCDEFGHIJKLMNPQRSTUVWXYZ123456789'

org.models.tan.DEFAULT_EXPIRES_AFTER

org.models.tan.DEFAULT_ACCESS_WINDOW

org.models.tan.generate_tan() → str

class org.models.tan.TAN

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin, onegov.core.orm.mixins.ContentMixin

A single use TAN for temporarily elevating access through e.g. a mobile phone number.

__tablename__ = 'tans'

__table_args__ = ()

id: Column[uuid.UUID]

hashed_tan: Column[str]

client: Column[str]

expired: Column[datetime | None]

is_active(expires_after: datetime.timedelta | None = DEFAULT_EXPIRES_AFTER) → bool

is_active(expires_after: datetime.timedelta | None = DEFAULT_EXPIRES_AFTER) → ColumnElement[bool]

expire() → None

class org.models.tan._GeneratedTAN

Bases: TAN

A single use TAN for temporarily elevating access through e.g. a mobile phone number.

tan: str

class org.models.tan.TANCollection(session: sqlalchemy.orm.Session, expires_after: datetime.timedelta = DEFAULT_EXPIRES_AFTER)

Bases: onegov.core.collection.GenericCollection[TAN]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

property model_class: type[TAN]

query() → Query[TAN]

hash_tan(tan: str) → str

add(*, client: str, created: datetime | None = None, **meta: Any) → _GeneratedTAN

by_client(client: str) → Query[TAN]

by_tan(tan: str) → TAN | None

class org.models.tan.TANAccess

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin

This exists to keep track of which protected URLs have been accesed by any given TAN session.

This allows us to throttle requests to protected resources.

__tablename__ = 'tan_accesses'

__table_args__ = ()

id: Column[uuid.UUID]

session_id: Column[str]

url: Column[str]

class org.models.tan.TANAccessCollection(session: sqlalchemy.orm.Session, session_id: str, access_window: datetime.timedelta = DEFAULT_ACCESS_WINDOW)

Bases: onegov.core.collection.GenericCollection[TANAccess]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

property model_class: type[TANAccess]

query() → Query[TANAccess]

add(*, url: str) → TANAccess

by_url(url: str) → TANAccess | None

count() → int