XML Debugger Plugin Readme

Overview

The XML debugger plugin records XMPP traffic which can be useful for debugging purposes. The plugin can log raw XML as it is received and sent by the server over different connection types, as well as interpreted/parsed XML. Note that server to server, BOSH and WebSocket traffic can only be logged as interpreted XML.

Installation

Copy xmldebugger.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 xmldebugger.jar file over the existing file.

Configuration

This plugin can be configured under Server/Server Settings/XML Debugger Properties.

If "Log to STDOUT" is selected, then the selected traffic will be printed to stdout.

If "Log to file" is selected, then the selected traffic will be saved in logs/xmldebugger.log.

A page under Sessions/Tools/Raw XMPP sender allows an administrator to compose and send XMPP data. When the data that is sent is an IQ request, then any answer will be shown on screen.

Warning

The traffic recorded by this plugin is not obfuscated in any way. Depending on the authentication mechanism is use, it may be trivial to determine user passwords or other sensitive information from the logs produced.