Mercurial > prosody-modules

comparison mod_firewall/README.markdown @ 5235:d0d251abf595

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_firewall: Add 'REPORT TO' to report (XEP-0377) a stanza to a specified JID
author Matthew Wild <mwild1@gmail.com>
date Sat, 11 Mar 2023 18:41:49 +0000
parents f6c71d9d6dc0
children e8f46195b292
comparison
equal deleted inserted replaced
5234:f6c71d9d6dc0 5235:d0d251abf595
624 ### Replying and forwarding 624 ### Replying and forwarding
625 625
626 These actions cause a new stanza to be generated and sent somewhere. 626 These actions cause a new stanza to be generated and sent somewhere.
627 Processing of the original stanza will continue beyond these actions. 627 Processing of the original stanza will continue beyond these actions.
628 628
629 Action Description 629 Action Description
630 ----------------------- --------------------------------------------------------------------------------------------------------------------------------------------------------- 630 ------------------------ ---------------------------------------------------------------------------------------------------------------------------------------------------------
631 `REPLY=text` Reply to the stanza (assumed to be a message) with the given text. 631 `REPLY=text` Reply to the stanza (assumed to be a message) with the given text.
632 `COPY=jid` Make a copy of the stanza and send the copy to the specified JID. The copied stanza flows through Prosody's routing code, and as such is affected by firewall rules. Be careful to avoid loops. 632 `COPY=jid` Make a copy of the stanza and send the copy to the specified JID. The copied stanza flows through Prosody's routing code, and as such is affected by firewall rules. Be careful to avoid loops.
633 `FORWARD=jid` Forward a copy of the stanza to the given JID (using XEP-0297). The stanza will be sent from the current host's JID. 633 `FORWARD=jid` Forward a copy of the stanza to the given JID (using XEP-0297). The stanza will be sent from the current host's JID.
634
635 ### Reporting
636
637 Action Description
638 ------------------------ ---------------------------------------------------------------------------------------------------------------------------------------------------------
639 `REPORT=jid reason text` Forwards the full stanza to `jid` with a XEP-0377 abuse report attached.
640
641 Only the `jid` is mandatory. The `reason` parameter should be either `abuse`, `spam` or a custom URI. If not specified, it defaults to `abuse`.
642 After the reason, some human-readable text may be included to explain the report.
643
644 Example:
645
646 ```
647 KIND: message
648 TO: honeypot@example.com
649 REPORT TO=antispam.example.com spam Caught by the honeypot!
650 DROP.
651 ```
634 652
635 ### Stanza modification 653 ### Stanza modification
636 654
637 These actions make it possible to modify the content and structure of a 655 These actions make it possible to modify the content and structure of a
638 stanza. 656 stanza.