XEP-0065: SOCKS5 Bytestreams#

class slixmpp.plugins.xep_0065.XEP_0065(xmpp, config=None)[source]#

activate(proxy, sid, target, ifrom=None, timeout=None, callback=None)[source]#: Activate the socks5 session that has been negotiated.

close()[source]#: Closes all proxy sockets.

deactivate(sid)[source]#: Closes the proxy socket associated with this SID.

async discover_proxies(jid=None, ifrom=None, timeout=None)[source]#: Auto-discover the JIDs of SOCKS5 proxies on an XMPP server.

get_network_address(proxy, ifrom=None, timeout=None, callback=None)[source]#: Get the network information of a proxy.

get_socket(sid)[source]#: Returns the socket associated to the SID.

async handshake(to, ifrom=None, sid=None, timeout=None)[source]#: Starts the handshake to establish the socks5 bytestreams connection.

Internal API methods#

The internal API is used here to authorize or pre-authorize streams.

authorized_sid (0065 version)#

jid: JID receiving the stream initiation.
node: stream id
ifrom: who the stream is from.
args: Iq of the stream request.
returns: True if the stream should be accepted, False otherwise.

Check if the stream should be accepted. Uses the information setup by preauthorize_sid (0065 version) by default.

authorized (0065 version)#

jid: JID receiving the stream initiation.
node: stream id
ifrom: who the stream is from.
args: Iq of the stream request.
returns: True if the stream should be accepted, False otherwise.

A fallback handler (run after authorized_sid (0065 version)) to check if a stream should be accepted. Uses the auto_accept parameter by default.

preauthorize_sid (0065 version)#

jid: JID receiving the stream initiation.
node: stream id
ifrom: who the stream will be from.
args: Unused.

Stanza elements#

class slixmpp.plugins.xep_0065.stanza.Socks5(xml=None, parent=None)[source]#

add_streamhost(jid, host, port)[source]#

interfaces: ClassVar[Set[str]] = {'activate', 'sid'}#: 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.

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

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 = 'http://jabber.org/protocol/bytestreams'#: 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.

parent: Optional[ReferenceType[ElementBase]]#: A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'socks'#

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]]] = {'streamhost': <class 'slixmpp.plugins.xep_0065.stanza.StreamHost'>, 'streamhost_used': <class 'slixmpp.plugins.xep_0065.stanza.StreamHostUsed'>, 'streamhosts': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}#: A mapping of the plugin_attrib values of registered plugins to their respective classes.

plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {<class 'slixmpp.plugins.xep_0065.stanza.StreamHost'>}#

The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with iterable=True:

register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)

New in version 1.0-Beta5.

plugin_overrides: ClassVar[Dict[str, str]] = {}#

A map of interface operations to the overriding functions. For example, after overriding the set operation for the interface body, plugin_overrides would be:

{'set_body': <some function>}

plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {'{http://jabber.org/protocol/bytestreams}streamhost': <class 'slixmpp.plugins.xep_0065.stanza.StreamHost'>, '{http://jabber.org/protocol/bytestreams}streamhost-used': <class 'slixmpp.plugins.xep_0065.stanza.StreamHostUsed'>, '{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}#: A mapping of root element tag names (in '{namespace}elementname' format) to the plugin classes responsible for them.

plugins: Dict[Tuple[str, Optional[str]], ElementBase]#: An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

sub_interfaces: ClassVar[Set[str]] = {'activate'}#: 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.

tag: str#: The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element#: The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

class slixmpp.plugins.xep_0065.stanza.StreamHost(xml=None, parent=None)[source]#

get_jid()[source]#

interfaces: ClassVar[Set[str]] = {'host', 'jid', 'port'}#: 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.

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

name: ClassVar[str] = 'streamhost'#: 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/protocol/bytestreams'#: 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.

parent: Optional[ReferenceType[ElementBase]]#: A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'streamhost'#

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

plugin_multi_attrib: ClassVar[str] = 'streamhosts'#

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

plugins: Dict[Tuple[str, Optional[str]], ElementBase]#: An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

set_jid(value)[source]#

tag: str#: The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element#: The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

class slixmpp.plugins.xep_0065.stanza.StreamHostUsed(xml=None, parent=None)[source]#

get_jid()[source]#

interfaces: ClassVar[Set[str]] = {'jid'}#: 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.

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

name: ClassVar[str] = 'streamhost-used'#: 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/protocol/bytestreams'#: 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.

parent: Optional[ReferenceType[ElementBase]]#: A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'streamhost_used'#

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

plugins: Dict[Tuple[str, Optional[str]], ElementBase]#: An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

set_jid(value)[source]#

tag: str#: The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element#: The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.