jam.ext.flask

flask

Flask integration.

Flask docs: https://flask.palletsprojects.com

Modules:

Name	Description
extensions
objects

Classes:

Name	Description
JWTExtension	JWT extension for Flask.
OAuth2Extension	OAuth2 extension for Flask.
PASETOExtension	PASETO extension for Flask.
SessionExtension	Session extension for Flask.
Token	Data for Authresult.

JWTExtension

JWTExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    use_list: bool = False,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseAuthExtension

JWT extension for Flask.

Parameters:

Name	Type	Description	Default
app	Flask | None	Flask application instance	None
config	dict[str, Any] | str | None	Jam config as path/to/file or dict.	None
pointer	str	Config pointer	GENERIC_POINTER
cookie_name	str | None	Cookie name to read token	None
header_name	str | None	Header name to read token	None
use_list	bool	Use a list for token	False
bearer	bool	Strip "Bearer " prefix from header	True
**kwargs	Any	Configuration arguments if config=None	{}

OAuth2Extension

OAuth2Extension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    **kwargs: Any,
)

Bases: BaseExtension

OAuth2 extension for Flask.

Parameters:

Name	Type	Description	Default
app	Flask | None	Flask application instance	None
config	dict[str, Any] | str | None	Jam config as path/to/file or dict.	None
pointer	str	Config pointer	GENERIC_POINTER
**kwargs	Any	Configuration arguments if config=None	{}

PASETOExtension

PASETOExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseAuthExtension

PASETO extension for Flask.

SessionExtension

SessionExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseAuthExtension

Session extension for Flask.

Token dataclass

Token(token: str | None)

Data for Authresult.