aiowamp.AuthMethodABC¶

class aiowamp.AuthMethodABC[source]¶

Abstract auth method.

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`	Initialize self.
`authenticate`(challenge)	Generate an authenticate message for the challenge.
`check_welcome`(welcome)	Check the welcome message sent by the router.

Attributes

`auth_extra`	Additional auth extras that need to be passed along.
`requires_auth_id`	Whether the auth method requires auth_id to be set.

__str__()[source]¶

Return str(self).

Return type:	`str`

requires_auth_id¶

Whether the auth method requires auth_id to be set.

Return type:	`bool`

auth_extra¶

Additional auth extras that need to be passed along.

None indicates that no extras need to be passed.

Return type:	`Optional`[`Dict`[`str`, `ForwardRef`]]

authenticate(challenge)[source]¶

Generate an authenticate message for the challenge.

Parameters:	challenge (`Challenge`) – Challenge message to respond to.
Return type:	`Union`[`Authenticate`, `Abort`]
Returns:	Either an authenticate message to send to the router or an abort message to indicate that the attempt should be aborted.
Raises:	`Exception` – When something goes wrong during authentication. Should be interpreted the same as an abort message.

check_welcome(welcome)[source]¶

Check the welcome message sent by the router.

Used to perform mutual authentication.

Parameters:	welcome (`Welcome`) – Welcome message sent by the router.
Raises:	`aiowamp.AuthError`
Return type:	`None`

aiowamp