Skip to content
Back to top
View this page

# XEP-0257: Client Certificate Management for SASL EXTERNAL

XEP-0257 on xmpp.org

class slixmpp.plugins.xep_0257.XEP_0257(xmpp, config=None)
  add_cert(name, cert, allow_management=True, ifrom=None, timeout=None)

    Register a cert with the server.

    Parameters:

      - name (`str`) – Name of the cert.

      - cert (`str`) – Base64 of the cert’s DER.

      - allow_management (`bool`) – Allow management of this cert by a client logged in with it.

      - ifrom (`JID` | `None`) – JID to send the stanza from (for components).

      - timeout (`float` | `None`) – Timeeout of the query (in seconds).

    Return type:

      `Awaitable`[`Iq`]

  disable_cert(name, ifrom=None, timeout=None)

    Disable a cert. Clients using this cert are not immediately disconnected.

    Parameters:

      - name (`str`) – Name of the cert.

      - ifrom (`JID` | `None`) – JID to send the stanza from (for components).

      - timeout (`float` | `None`) – Timeeout of the query (in seconds).

    Return type:

      `Awaitable`[`Iq`]

  async get_certs(ifrom=None, timeout=None)

    Return the list of cert items.

    Parameters:

      - ifrom (`JID` | `None`) – JID to send the stanza from (for components).

      - timeout (`float` | `None`) – Timeout of the query (in seconds)

    Return type:

      `set`[`tuple`[`str`, `str`, `tuple`[`str`, `...`]]]

    Returns:

      A list of certificate items as tuple of (name, cert, active users).

    Raises:

      - IqTimeout – When the query timeouts

      - IqError – If the server encounters an error while processing the query.

  revoke_cert(name, ifrom=None, timeout=None)

    Revoke a cert. Clients using this cert are immediately disconnected.

    Parameters:

      - name (`str`) – Name of the cert.

      - ifrom (`JID` | `None`) – JID to send the stanza from (for components).

      - timeout (`float` | `None`) – Timeeout of the query (in seconds).

    Return type:

      `Awaitable`[`Iq`]

## Stanza elements

class slixmpp.plugins.xep_0257.stanza.AppendCert(xml=None, parent=None)

  Element used for adding a cert.

      <append xmlns='urn:xmpp:saslcert:1'>
          <name>Simple Bot</name>
          <no-cert-management/>
          <x509cert>
            ...
          </x509cert>
      </append>

  del_cert_management()
    Return type:

      `None`

  get_cert_management()
    Return type:

      `bool`

  interfaces: ClassVar[set[str]] = {'cert_management', 'name', 'x509cert'}

    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] = 'append'

    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 = 'urn:xmpp:saslcert:1'

    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] = 'sasl_cert_append'

    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']

  set_cert_management(value)
    Return type:

      `None`

  sub_interfaces: ClassVar[set[str]] = {'name', 'x509cert'}

    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.

class slixmpp.plugins.xep_0257.stanza.CertItem(xml=None, parent=None)

  A single cert item.

  Contains the X.509 base64 DER representation, its name, as well as a list of users currently logged in with it.

      <item xmlns='urn:xmpp:saslcert:1'>
        <name>Mobile Client</name>
        <x509cert>
          ...
        </x509cert>
        <users>
          <resource>Phone</resource>
        </users>
      </item>

  del_users()
    Return type:

      `None`

  get_users()

    Return the resources currently using this cert.

    Return type:

      `set`[`str`]

  interfaces: ClassVar[set[str]] = {'name', 'users', 'x509cert'}

    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] = 'item'

    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 = 'urn:xmpp:saslcert:1'

    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] = 'item'

    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_multi_attrib: ClassVar[str] = 'items'

    For `ElementBase` subclasses that are intended to be an iterable group of items, the `plugin_multi_attrib` value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:

        # Given stanza class Foo, with plugin_multi_attrib = 'foos'
        parent['foos']
        filter(isinstance(item, Foo), parent['substanzas'])

  set_users(values)
    Return type:

      `None`

  sub_interfaces: ClassVar[set[str]] = {'name', 'x509cert'}

    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.

class slixmpp.plugins.xep_0257.stanza.Certs(xml=None, parent=None)

  List of certs returned by the server. This element is only useful for accessing the certs inside.

        <items xmlns='urn:xmpp:saslcert:1'>
          <item>
            <name>Mobile Client</name>
            <x509cert>
              ...
            </x509cert>
            <users>
              <resource>Phone</resource>
            </users>
          </item>
          <item>
            <name>Laptop</name>
            <x509cert>
              ...
            </x509cert>
          </item>
        </items>
      </iq>

  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] = 'items'

    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 = 'urn:xmpp:saslcert:1'

    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] = 'sasl_certs'

    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']

class slixmpp.plugins.xep_0257.stanza.DisableCert(xml=None, parent=None)

  Element used for disabling a cert.

      <disable xmlns='urn:xmpp:saslcert:1'>
          <name>Mobile Client</name>
      </disable>

  interfaces: ClassVar[set[str]] = {'name'}

    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] = 'disable'

    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 = 'urn:xmpp:saslcert:1'

    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] = 'sasl_cert_disable'

    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']

  sub_interfaces: ClassVar[set[str]] = {'name'}

    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.

class slixmpp.plugins.xep_0257.stanza.RevokeCert(xml=None, parent=None)

  Element used for revoking a cert.

      <revoke xmlns='urn:xmpp:saslcert:1'>
          <name>Mobile Client</name>
      </revoke>

  interfaces: ClassVar[set[str]] = {'name'}

    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] = 'revoke'

    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 = 'urn:xmpp:saslcert:1'

    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] = 'sasl_cert_revoke'

    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']

  sub_interfaces: ClassVar[set[str]] = {'name'}

    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.

slixmpp.plugins.xep_0257.stanza.register_plugins()