Skip to content

Extended Functionality

Victor Dudochkin edited this page Jul 9, 2018 · 1 revision

Extended Subscriber Black/White Listing

Wampire extends WAMP's subscriber black/white listing functionality to support filtering on any attribute in the subscriber session details.

WAMP allows blacklisting authid and authrole using exclude_authid and exclude_authrole, and allows whitelisting these attributes using eligible_authid and eligible_authrole.
Wampire recognizes the publish options exclude_xxx and eligible_xxx, accompanied with a list of string values to match against, where xxx is he name of any attribute in the session details.

As an example, to allow sessions with org_id=ycorp or org_id=zcorp, a PUBLISH message specifies the following option:

eligible_org_id: ["ycorp", "zcorp"]

Note: Wampire includes all attributes from the HELLO message in the session details.

Extended Session Meta API

Wampire extends the session meta API to provide additional information.

Normally, the wamp.session.on_join meta event message and the response to a wamp.session.get meta procedure includes the attributes specified by the WAMP specification (session, authid, authrole, authmethod, authprovider, transport).
Wampire not only includes these attributes, but includes all attributes from the session HELLO message.
This allows clients to provide more information about themselves, via HELLO, that may then be used by other sessions to make decisions about who to send messages to.