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(*args, **kwargs)

Bases: gws.base.auth.method.Config

Web-based authorization options

cookieName: str = 'auth'

name for the cookie

cookiePath: str = '/'

cookie path

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

Bases: gws.base.auth.method.Object

Authentication Method.

cookieName: str
cookiePath: str
deletedSession: gws.base.auth.session.Object
configure()

Configuration hook.

activate()

Activation hook.

open_session(req)

Attempt to open a Session for a Requester.

Parameters:

req – Requester object.

Returns:

A Session or None.

close_session(req, res)

Close a previously opened Session.

Parameters:
  • req – Requester object.

  • res – Responder object.

Returns:

True if the Session was successfully closed.

handle_login(req: gws.WebRequester, credentials: gws.Data)
handle_logout(req: gws.WebRequester)