crossbar.router.auth

Submodules

• crossbar.router.auth.anonymous
• crossbar.router.auth.cryptosign
• crossbar.router.auth.pending
• crossbar.router.auth.scram
• crossbar.router.auth.ticket
• crossbar.router.auth.tls
• crossbar.router.auth.wampcra

Attributes

AUTHMETHODS
AUTHMETHOD_MAP
HAS_CRYPTOSIGN

Classes

PendingAuth	Base class for pending WAMP authentications.
PendingAuthScram	Pending SCRAM authentication.
PendingAuthTLS	Pending WAMP-TLS authentication.
PendingAuthTicket	Pending authentication information for WAMP-Ticket authentication.
PendingAuthWampCra	Pending WAMP-CRA authentication.

Package Contents

AUTHMETHODS

AUTHMETHOD_MAP: Dict[str, Type[pending.PendingAuth]]

HAS_CRYPTOSIGN = True

class PendingAuth(pending_session_id: int, transport_details: autobahn.wamp.types.TransportDetails, realm_container: crossbar.interfaces.IRealmContainer, config: Dict[str, Any])

Base class for pending WAMP authentications.

After creating a pending authentication first call open() and then verify() (each should be called exactly once, and in this order).

AUTHMETHOD = 'abstract'

_accept()

_assign_principal(principal)

_authenticator: str | None = None

_authenticator_realm: str | None = None

_authenticator_session: autobahn.wamp.interfaces.ISession | None = None

_authextra: Dict[str, Any] | None = None

_authid: str | None = None

_authmethod: str = 'abstract'

_authprovider: str | None = None

_authrole: str | None = None

_config: Dict[str, Any]

_init_dynamic_authenticator()

_init_function_authenticator()

_marshal_dynamic_authenticator_error(err)

_realm: str | None = None

_realm_container: crossbar.interfaces.IRealmContainer

_session_details

abstractmethod authenticate(signature: str) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny

The client has answered with a WAMP AUTHENTICATE message. Verify the message and accept or deny.

Parameters:

signature – Signature over the challenge as received from the authenticating session.

Returns:

Either accept or deny the session.

abstractmethod hello(realm: str, details: autobahn.wamp.types.HelloDetails) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny | autobahn.wamp.types.Challenge

When a HELLO message is received, this gets called to open the pending authentication.

Parameters:

• realm – The realm to client wishes to join (if the client did announce a realm).

• details – The details of the client provided for HELLO.

Returns:

Either return a challenge, or immediately accept or deny session.

log

class PendingAuthScram(pending_session_id: int, transport_details: autobahn.wamp.types.TransportDetails, realm_container: crossbar.interfaces.IRealmContainer, config: Dict[str, Any])

Bases: crossbar.router.auth.pending.PendingAuth

Pending SCRAM authentication.

AUTHMETHOD = 'scram'

_channel_id

_compute_challenge()

authenticate(signature: str) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny

Verify the signed message sent by the client.

Parameters:

signature – the base64-encoded result “ClientProof” from the SCRAM protocol

hello(realm: str, details: autobahn.wamp.types.HelloDetails) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny | autobahn.wamp.types.Challenge

When a HELLO message is received, this gets called to open the pending authentication.

Parameters:

• realm – The realm to client wishes to join (if the client did announce a realm).

• details – The details of the client provided for HELLO.

Returns:

Either return a challenge, or immediately accept or deny session.

log

class PendingAuthTLS(pending_session_id: int, transport_details: autobahn.wamp.types.TransportDetails, realm_container: crossbar.interfaces.IRealmContainer, config: Dict[str, Any])

Bases: crossbar.router.auth.pending.PendingAuth

Pending WAMP-TLS authentication.

AUTHMETHOD = 'tls'

_cert_sha1_to_principal = None

_channel_id

_peer_cert

authenticate(signature)

The client has answered with a WAMP AUTHENTICATE message. Verify the message and accept or deny.

Parameters:

signature – Signature over the challenge as received from the authenticating session.

Returns:

Either accept or deny the session.

hello(realm, details)

When a HELLO message is received, this gets called to open the pending authentication.

Parameters:

• realm – The realm to client wishes to join (if the client did announce a realm).

• details – The details of the client provided for HELLO.

Returns:

Either return a challenge, or immediately accept or deny session.

log

class PendingAuthTicket(pending_session_id: int, transport_details: autobahn.wamp.types.TransportDetails, realm_container: crossbar.interfaces.IRealmContainer, config: Dict[str, Any])

Bases: crossbar.router.auth.pending.PendingAuth

Pending authentication information for WAMP-Ticket authentication.

AUTHMETHOD = 'ticket'

_signature = None

authenticate(signature: str) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny

The client has answered with a WAMP AUTHENTICATE message. Verify the message and accept or deny.

Parameters:

signature – Signature over the challenge as received from the authenticating session.

Returns:

Either accept or deny the session.

hello(realm: str, details: autobahn.wamp.types.HelloDetails) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny | autobahn.wamp.types.Challenge

When a HELLO message is received, this gets called to open the pending authentication.

Parameters:

• realm – The realm to client wishes to join (if the client did announce a realm).

• details – The details of the client provided for HELLO.

Returns:

Either return a challenge, or immediately accept or deny session.

log

class PendingAuthWampCra(pending_session_id: int, transport_details: autobahn.wamp.types.TransportDetails, realm_container: crossbar.interfaces.IRealmContainer, config: Dict[str, Any])

Bases: crossbar.router.auth.pending.PendingAuth

Pending WAMP-CRA authentication.

AUTHMETHOD = 'wampcra'

_authid = None

_compute_challenge(user)

Returns: challenge, signature

_realm = None

_signature = None

authenticate(signature: str) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny

The client has answered with a WAMP AUTHENTICATE message. Verify the message and accept or deny.

Parameters:

signature – Signature over the challenge as received from the authenticating session.

Returns:

Either accept or deny the session.

hello(realm: str, details: autobahn.wamp.types.HelloDetails) → autobahn.wamp.types.Accept | autobahn.wamp.types.Deny | autobahn.wamp.types.Challenge

When a HELLO message is received, this gets called to open the pending authentication.

Parameters:

• realm – The realm to client wishes to join (if the client did announce a realm).

• details – The details of the client provided for HELLO.

Returns:

Either return a challenge, or immediately accept or deny session.

log