NAME

Mail::Abuse::Processor::Radius - Match incidents to users using RADIUS detail files

SYNOPSIS

  use Mail::Abuse::Processor::Radius;

  use Mail::Abuse::Report;
  my $p = new Mail::Abuse::Processor::Radius;
  my $report = new Mail::Abuse::Report (processors => [ $p ]);

  # ... other pieces of code that configure the report ...

DESCRIPTION

This class attempts to find users associated with incidents by analyzing Radius detail files according to the specifications of the configuration file. Compressed detail files (ending in .gz) will be uncompressed and processed on the fly.

The following configuration keys control the behavior of this module.

debug radius

If set to a true value, causes this module to emit debugging info using warn().

radius detail type

The type or format of the RADIUS detail file to be expected. The values can be any of the following.

livingston

A standard format derived from the venerable Livingston Radius server, one of the earliest RADIUS server. Most Radius servers can produce output in this format, which is why this is the default.

Hopefully, other format will be added when needed.

radius detail location

The path of a file or directory where the accounting details are kept. If pointed to a directory, a recursive lookup will occur and all files found will be analyzed.

If pointed to a single file, only that particular file will be analyzed.

By default, the directory /var/raddb/details will be used if none is specified. This seems to be a quite common default.

Since the specified path will be traversed completely, it is a good idea to remove old detail files to keep the response times short. It is never a good idea to let this code loose in a hierarchy containing 5 years of detail records.

The following functions are implemented.

process($report)

Takes a Mail::Abuse::Report object as an argument and, for each Mail::Abuse::Incident collected, perform a lookup in the given detail files.

If the user is found, all the Radius detail entries are placed in the incident, so that other modules can use this information. New entries are to be accessed like in the following example:

    $incident->radius->{'User-Name'};
    $incident->radius->{'Caller-Id'};

Where each key is the actual entry in the detail record.

EXPORT

None by default.

HISTORY

0.01

Original version; created by h2xs 1.2 with options

  -ACOXcfkn
        Mail::Abuse
        -v
        0.01

LICENSE AND WARRANTY

This code and all accompanying software comes with NO WARRANTY. You use it at your own risk.

This code and all accompanying software can be used freely under the same terms as Perl itself.

AUTHOR

Luis E. Muñoz <luismunoz@cpan.org>

SEE ALSO

perl(1).