Spam Blacklist Plugin Readme

Overview

The spam blacklist plugin periodically retrieves a curated list of addresses that are known sources of spam, and blocks traffic sent from those addresses.

Installation

Copy blacklistSpam.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version, copy the new monitoring.jar file over the existing file.

Configuration

The list of addresses that are blocked is obtained using a HTTP call from an URL that is configured by the property blacklistspam.connection.request.url The default value for this property is https://igniterealtime.org/JabberSPAM/blacklist.txt The HTTP result is expected to contain a plain-text body, with JIDs (domains) separated by newlines (one JID per line).

The default behavior of the plugin is the verify stanzas that arrive from other XMPP domains. The plugin can also be configured to verify stanzas that are outbound. This behavior is configured by the blacklistspam.check.incoming and blacklistspam.check.outgoing properties, which require a boolean value.

To facilitate analysis of stanzas that are blocked, the plugin can be configured to write all blocked stanzas to disk. To enable this functionality, set the value for the blacklistspam.blockedlog.enabled property to true. When enabled, all blocked stanzas are logged in files in a folder named blacklist in the <OPENFIRE-HOME>/ folder.

Attribution

Icons made by Smashicons from www.flaticon.com is licensed by CC 3.0 BY