gws.plugin.auth_method.web.core

Web authorisation method.

Source code: gws.plugin.auth_method.web.core

Module Contents

class gws.plugin.auth_method.web.core.Config

Web-based authorization options

cookieName: str = 'auth'

Name for the cookie.

cookiePath: str = '/'

Cookie path.

cookieSameSite: str = 'Lax'

Cookie SameSite attribute.

loginRedirect: LoginRedirectRule | None

Rule to redirect if a login is required.

class gws.plugin.auth_method.web.core.LoginRedirectRule(*args, **kwargs)

Login redirect rule.

pattern: gws.Regex | None

URL matching pattern for pages that must be redirected.

target: str

Target url.

class gws.plugin.auth_method.web.core.LoginRequest(*args, **kwargs)

Command request.

password: str

to: str | None

username: str

class gws.plugin.auth_method.web.core.LoginResponse(*args, **kwargs)

Command response.

mfaCanRestart: bool = False

mfaMessage: str = ''

mfaState: gws.AuthMultiFactorState | None

redirectTo: str = ''

user: gws.base.auth.user.Props | None

class gws.plugin.auth_method.web.core.LogoutResponse(*args, **kwargs)

Command response.

class gws.plugin.auth_method.web.core.MfaVerifyRequest(*args, **kwargs)

Command request.

payload: dict

to: str | None

class gws.plugin.auth_method.web.core.Object

cookieName: str

cookiePath: str

cookieSameSite: str

deletedSession: gws.base.auth.session.Object

loginRedirect: LoginRedirectRule | None

activate()

close_session(req, res)

configure()

exit_middleware(req, res)

handle_login(req: gws.WebRequester, p: LoginRequest) → LoginResponse

handle_logout(req: gws.WebRequester) → LogoutResponse

handle_mfa_restart(req: gws.WebRequester, p: gws.Request) → LoginResponse

handle_mfa_verify(req: gws.WebRequester, p: MfaVerifyRequest) → LoginResponse

open_session(req)

class gws.plugin.auth_method.web.core.UserResponse(*args, **kwargs)

Command response.

user: gws.base.auth.user.Props | None