Mercurial > prosody-modules
view mod_tcpproxy/README.markdown @ 4804:a7c0c70e64b6
mod_ping_muc: Yet another attempt to improve MUC reliability
This time by moving XEP-0410 to the server. Will this save the users
from the s2s timeouts? What horrifying unintentional side-effects will
this have? Tune in next week to find out!
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 02 Dec 2021 23:43:11 +0100 |
parents | 8de50be756e5 |
children | 3804332c204e |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'TCP-over-XMPP :)' ... Introduction ============ It happens occasionally that I would like to use the XMPP server as a generic proxy for connecting to another service. It is especially awkward in some environments, and impossible in (for example) Javascript inside a web browser. Details ======= Using mod\_tcpproxy an XMPP client (including those using BOSH) can initiate a pipe to a given TCP/IP address and port. This implementation uses the [In-Band Bytestreams](http://xmpp.org/extensions/xep-0047.html) XEP, simply extended with 2 new attributes in a new namespace, host and port. An example Javascript client can be found in the web/ directory of mod\_tcpproxy in the repository. Configuration ============= Just add tcpproxy as a component, for example: `Component "tcp.example.com" "tcpproxy"` Protocol ======== A new stream is opened like this: ``` {.xml} <iq type="set" id="newconn1" to="tcp.example.com"> <open xmlns='http://jabber.org/protocol/ibb' sid='connection1' stanza='message' xmlns:tcp='http://prosody.im/protocol/tcpproxy' tcp:host='example.com' tcp:port='80' /> </iq> ``` The stanza attribute (currently) MUST be 'message', and a block-size, if given, is (currently) ignored. In response to this stanza you will receive a result upon connection success, or an error if the connection failed. You can then send to the connection by sending message stanzas as described in the IBB XEP. Incoming data will likewise be delivered as messages. Compatibility ============= ----- -------------- 0.7 Works 0.6 Doesn't work ----- -------------- Todo ==== - ACLs (restrict to certain JIDs, and/or certain target hosts/ports) - Honour block-size (undecided) - Support iq stanzas for data transmission - Signal to start SSL/TLS on a connection