Skip to content
Back to top
View this page

# XEP-0300: Use of Cryptographic Hash Functions in XMPP

XEP-0300 on xmpp.org

class slixmpp.plugins.xep_0300.XEP_0300(xmpp, config)

  XEP-0300: Use of Cryptographic Hash Functions in XMPP

  compute_hash(filename=None, function=None, *, data=None, file=None)
    Overloads:

      - self, filename (str | Path), function (str | None), data (None), file (None) → Hash

      - self, filename (None), function (str | None), data (bytes), file (None) → Hash

      - self, filename (None), function (str | None), data (None), file (IO[bytes]) → Hash

    Compute the hash of a file, and return the relevant hash XML element.

    Parameters:

      - filename (`str` | `Path` | `None`) – Path of the file to hash.

      - function (`str` | `None`) – Name of the hash function to use. If left empty, the preferred function set in `self.preferred` will be used.

    Returns:

      A Hash element.

  default_config: ClassVar[dict] = {'block_size': 1048576, 'enable_BLAKE2b256': True, 'enable_BLAKE2b512': True, 'enable_sha-1': False, 'enable_sha-256': True, 'enable_sha-512': True, 'enable_sha3-256': True, 'enable_sha3-512': True, 'preferred': 'sha-256'}

    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_0300.stanza.Hash(xml=None, parent=None)

  Hash element, contains the name of the hash algorithm and the matching digest.

      <hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>2XarmwTlNxDAMkvymloX3S5+VbylNrJt/l5QyPa+YoU=</hash>

  allowed_algos = ['sha-1', 'sha-256', 'sha-512', 'sha3-256', 'sha3-512', 'BLAKE2b256', 'BLAKE2b512']
  del_value()
  get_value()
  interfaces: ClassVar[set[str]] = {'algo', 'value'}

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

    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:hashes:2'

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

    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_algo(value)
  set_value(value)