ejabberd-contrib/mod_logsession
Badlop 90a72ea9fd Use the regexp frontend module (EJAB-921) 2013-09-10 18:36:39 +02:00
..
ebin Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
src Use the regexp frontend module (EJAB-921) 2013-09-10 18:36:39 +02:00
COPYING Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
ChangeLog Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
Emakefile Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
README.txt Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
build.bat Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
build.sh Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00

README.txt

	mod_logsession - Log session connections to file

	Homepage: http://www.ejabberd.im/mod_logsession
	Author: Badlop
	Requirements: ejabberd trunk SVN 1635 or newer


	DESCRIPTION
	-----------

This module is intended to log in a text file the session connections.
Right now it only logs the forbidden connection attempts and the
failed authentication attempts.
Each vhost is logged in a different file.

Note: to log the failed authentication attempts, you need to patch ejabberd.


	INSTALL
	-------

1 Copy this file to ejabberd/src/mod_logsession.erl
2 Recompile ejabberd
3 Add to ejabberd.cfg, 'modules' section the basic configuration:
    {mod_logsession,     []},
4 With this configuration, the log files are:
    /tmp/ejabberd_logsession_@HOST@.log


	CONFIGURABLE PARAMETERS
	-----------------------

sessionlog: 
  Define the name of log files.
  The keyword @HOST@ will be substituted with the name of each vhost.
  Default value: "/tmp/ejabberd_logsession_@HOST@.log"


	EXAMPLE CONFIGURATION
	---------------------

{modules, [
  ...
  {mod_logsession, [
    {sessionlog, "/var/log/ejabberd/session_@HOST@.log"}
  ]},
  ...
]}.

With that configuration, if the server has three vhosts:
  "localhost", "example.org" and "example.net",
then the forbidden accesses will be logged in the files:
  /var/log/ejabberd/session_localhost.log
  /var/log/ejabberd/session_example.org.log
  /var/log/ejabberd/session_example.net.log


	FORMAT OF LOG
	-------------

The content of the file is the date and time of the attempted login
and the JID of the denied user.

For example:
2008-01-08 12:20:50 Forbidden session for tron@localhost/teeest
2008-01-08 12:36:01 Forbidden session for baduser@localhost/aaa22
2010-04-02 17:21:37 Failed legacy authentication for someuser@localhost from 127.0.0.1 port 58973
2010-04-02 17:25:20 Failed sasl_resp authentication for badlop@localhost from 127.0.0.1 port 45842


	REOPEN LOG FILES
	----------------

This module provides an ejabberd command to reopen the log file
of a host where the module is enabled.

Example usage:
  ejabberdctl reopen-seslog localhost
  ejabberdctl reopen-seslog jabber.example.org