Skip to content
Back to top
View this page

# XEP-0078: Non-SASL Authentication

XEP-0078 on xmpp.org

class slixmpp.plugins.xep_0078.XEP_0078(xmpp, config=None)

  XEP-0078 NON-SASL Authentication

  This XEP is OBSOLETE in favor of using SASL, so DO NOT use this plugin unless you are forced to use an old XMPP server implementation.

  default_config: ClassVar[dict[str, Any]] = {'order': 15}

    The basic, standard configuration for the plugin, which may be overridden when initializing the plugin. The configuration fields included here may be accessed directly as attributes of the plugin. For example, including the configuration field ‘foo’ would mean accessing plugin.foo returns the current value of plugin.config[‘foo’].

## Stanza elements

class slixmpp.plugins.xep_0078.stanza.AuthFeature(xml=None, parent=None)
  interfaces: ClassVar[set[str]] = {}

    The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the `plugin_attrib` value of any registered stanza plugins.

  name: ClassVar[str] = 'auth'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  namespace: str = 'http://jabber.org/features/iq-auth'

    The XML namespace for the element. Given `<foo xmlns="bar" />`, then `namespace = "bar"` should be used. The default namespace is `jabber:client` since this is being used in an XMPP library.

  plugin_attrib: ClassVar[str] = 'auth'

    For `ElementBase` subclasses which are intended to be used as plugins, the `plugin_attrib` value defines the plugin name. Plugins may be accessed by using the `plugin_attrib` value as the interface. An example using `plugin_attrib = 'foo'`:

        register_stanza_plugin(Message, FooPlugin)
        msg = Message()
        msg['foo']['an_interface_from_the_foo_plugin']

  plugin_attrib_map: ClassVar[dict[str, type[ElementBase]]] = {}

    A mapping of the `plugin_attrib` values of registered plugins to their respective classes.

  plugin_tag_map: ClassVar[dict[str, type[ElementBase]]] = {}

    A mapping of root element tag names (in `'{namespace}elementname'` format) to the plugin classes responsible for them.

class slixmpp.plugins.xep_0078.stanza.IqAuth(xml=None, parent=None)
  get_fields()
  interfaces: ClassVar[set[str]] = {'digest', 'fields', 'password', 'resource', 'username'}

    The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the `plugin_attrib` value of any registered stanza plugins.

  name: ClassVar[str] = 'query'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  namespace: str = 'jabber:iq:auth'

    The XML namespace for the element. Given `<foo xmlns="bar" />`, then `namespace = "bar"` should be used. The default namespace is `jabber:client` since this is being used in an XMPP library.

  plugin_attrib: ClassVar[str] = 'auth'

    For `ElementBase` subclasses which are intended to be used as plugins, the `plugin_attrib` value defines the plugin name. Plugins may be accessed by using the `plugin_attrib` value as the interface. An example using `plugin_attrib = 'foo'`:

        register_stanza_plugin(Message, FooPlugin)
        msg = Message()
        msg['foo']['an_interface_from_the_foo_plugin']

  plugin_attrib_map: ClassVar[dict[str, type[ElementBase]]] = {}

    A mapping of the `plugin_attrib` values of registered plugins to their respective classes.

  plugin_tag_map: ClassVar[dict[str, type[ElementBase]]] = {}

    A mapping of root element tag names (in `'{namespace}elementname'` format) to the plugin classes responsible for them.

  set_password(value)
  set_resource(value)
  sub_interfaces: ClassVar[set[str]] = {'digest', 'password', 'resource', 'username'}

    A subset of `interfaces` which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.