gws.plugin.auth_method.token

HTTP Token authorisation method.

The token authorization works by passing a token in an HTTP header. For example, with this configuration:

auth.methods+ {
    type "token"
    header "X-My-Auth"
    prefix "Bearer"

}

the application would expect a header like X-My-Auth: Bearer <token>, extract the token value and pass it along to authorization providers.

Source code: gws.plugin.auth_method.token

Package Contents

class gws.plugin.auth_method.token.Config(*args, **kwargs)

Bases: gws.base.auth.method.Config

HTTP-token authorization options

header: str

HTTP header name

prefix: str = ''

token prefix

class gws.plugin.auth_method.token.Object

Bases: gws.base.auth.method.Object

Authentication Method.

header: str

prefix: str

configure()

Configuration hook.

enter_middleware(req)

Begin middleware processing.

Parameters:

req – Requester object.

Returns:

A Responder object or None.

exit_middleware(req, res)

Finish middleware processing.

Parameters:

• req – Requester object.

• res – Current responder object.

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.