github-starred/sendmailanalyzer
2
0
Fork 0
mirror of https://github.com/darold/sendmailanalyzer.git synced 2026-05-15 14:15:56 -06:00
Code Issues 3 Projects Packages Wiki Activity Actions
sendmailanalyzer/Makefile.PL

538 lines
20 KiB
Perl
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

use ExtUtils::MakeMaker qw(prompt WriteMakefile);
my @ALLOWED_ARGS = ('LOGFILE','BINDIR','CONFDIR','PIDDIR','BASEDIR','HTMLDIR','MANDIR','DOCDIR','DESTDIR','QUIET','INSTALLDIRS');
# Parse command line arguments and store them as environment variables
while ($_ = shift) {
my ($k,$v) = split(/=/, $_, 2);
if (grep(/^$k$/, @ALLOWED_ARGS)) {
$ENV{$k} = $v;
}
}
$ENV{DESTDIR} =~ s/\/$//;
# Default install path
my $LOGFILE = $ENV{LOGFILE} || '/var/log/maillog';
my $BINDIR = $ENV{BINDIR} || '/usr/local/sendmailanalyzer';
my $CONFDIR = $ENV{CONFDIR} || '/usr/local/sendmailanalyzer';
my $PIDDIR = $ENV{PIDDIR} || '/var/run';
my $BASEDIR = $ENV{BASEDIR} || '/usr/local/sendmailanalyzer/data';
my $HTMLDIR = $ENV{HTMLDIR} || '/usr/local/sendmailanalyzer/www';
my $MANDIR = $ENV{MANDIR} || '/usr/local/sendmailanalyzer/doc';
my $DOCDIR = $ENV{DOCDIR} || '/usr/local/sendmailanalyzer/doc';
my $DESTDIR = $ENV{DESTDIR} || '';
$ENV{INSTALLDIRS} ||= 'vendor';
# Try to find all binary used by SysUsage
my $tail = `which tail`;
chomp($tail);
if (!$tail) {
die "NOTICE: This tool requires system command: tail, can't find it in your path\n";
}
my $grep = `which grep`;
chomp($grep);
if (!$grep) {
die "NOTICE: This tool requires the sysstat package, can't find grep in your path\n";
}
my $zcat = `which zcat`;
chomp($zcat);
# Setup ok. generating sendmailanalyzer.conf config file
unless(open(OUTCFG, ">sendmailanalyzer.conf")) {
print "\nError: can't write config file sendmailanalyzer.conf, $!\n";
exit 0;
}
print OUTCFG qq{
# Path to the maillog file to analyse.
# Can be overwritten with --log or -l
LOG_FILE $LOGFILE
# journalctl command to use instead of log file entry. For postfix
# it migth be set to the following. When enabled, the LOG_FILE
# configuration directive above is just ommitted. Note that in daemon
# mode sendmailanalyzer will automatically add the -f option to the
# command. The additional option: --output="short-iso" is also always
# used to format timestamp. Can be overwritten with --journalctl or
# -j options.
#JOURNALCTL_CMD journalctl -u postfix
# Path to store the pid file (sendmailanalyzer.pid).
PID_DIR $PIDDIR
# Path to the system tail command.
# Can be overwritten with --tail or -t
TAIL_PROG $tail
# tail system command argument to pass.
# Can be overwritten with --args or -a
TAIL_ARGS -n 0 -F
# zcat system command used to parse compressed log file
ZCAT_PROG $zcat
# Output directory for data storage.
# Can be overwritten with --output or -o
OUT_DIR $BASEDIR
# Turn on/off debug mode.
# Can be overwritten with --debug or -d
DEBUG 0
# Parse maillog from begining before running tail program. Default
# is to read LAST_PARSED file to start from last collected event.
# Can be overwritten with --full or -f
FULL 0
# Parse maillog from begining before running tail program but
# force sendmailanalyzer to never use the LAST_PARSED file.
# Can be overwritten with --force or -F
FORCE 0
# Do not run tail program and exit after a full parsing of the log file
# Can be overwritten with --break or -b
BREAK 0
# Delay in second to flush to disk collected data.
# Can be overwritten with --write-delay or -w
DELAY 5
# Syslog name of the MTA. Syslog write it to maillog with the pid as follow:
# ... sendmail[1234] ... This is required to only parse relevant logged lines
# Can be overwritten with --sendmail or -s
# You can set multiple Syslog name as a list separated by a pipe '|'
MTA_NAME sm-mta|sendmail|postfix|spampd|postscreen
# Exclude all lines matching a regexp from being parsed, for example to
# exclude log line reported by the randomizer script, skip line with the
# following regex. Character # in the regex need to be escaped with a backslash.
# Use it to prevent unwanted line to be reported in Rejection reports.
#EXCLUDE_LINE postfix/randomizer
# Syslog name of MailScanner. Syslog write it to maillog with the pid as follow:
# ... MailScanner[1234] ... This is required to only parse relevant logged lines
# Can be overwritten with --mailscanner or -m
MAILSCAN_NAME MailScanner
# Number of object displayed in the top statistics
TOP 25
# Number of object displayed in the top mailbox statistics
TOP_MBOX 25
# Space separated list of ip addresses of the mail hubs (where email are redirected
# if this host is a gateway or a hub)
MAIL_HUB
# Space separated list of ip addresses of the MTA gateway (where external mail
# comes from if this host is a hub or a delivery system)
MAIL_GW
# Default domain or hostname to add to an email address if there's just the
# username. When the host is a delivery system it is possible that the user
# email address do not have the domain part (ex: \@domain.com). By default
# SendmailAnalyzer will add the '\@localhost' domain but you may want to change
# this domain, so use this directive
DEFAULT_DOMAIN \@localhost
# Max number of recipient per message to report sender
MAX_RCPT 25
# Max size per message to report sender in byte
MAX_SIZE 10000000
# Select sa_cache freeing space method:
# - delete: remove all daily data files before the current month
# - archive: make a gzipped tarbal of all data files before the current month
# - none: don't do anything. Need lot of space disk.
# Default is delete.
FREE_SPACE archive
# Force sa_cache to free space each week instead of monthly by default.
WEEKLY_FREE_SPACE 0
# Compute statistics and cache for a list of domain and display a link in the
# front page for a per domain access. See DOMAIN_USER if you want to grant
# special access on these pages. You can have multiple DOMAIN_REPORT lines
# for better reading.
# If you are running rsyslog with multiple host use DOMAIN_HOST_REPORT instead.
# See DOMAIN_USER if you want to grant special access on these pages.
#DOMAIN_REPORT domain1.com,domain2.com
# Same as above but with host distinction for use with rsyslog.
# You can have multiple LOCAL_HOST_DOMAIN lines, ie: one per host.
#DOMAIN_HOST_REPORT sysloghost1 domain1.com,domain2.com
#DOMAIN_HOST_REPORT sysloghost2 domain3.com,domain4.com
# Path to the language translation file (relative to the CGI directory).
# Default: lang/en_US
#LANG lang/fr_FR
# Size Unit to use, default is Bytes. Other values are KBytes and MBytes
SIZE_UNIT MBytes
# Max line to show in detail view. Default is 100
MAX_LINE 100
# List of admin users separated by comma
# They will have full access to all report
#ADMIN sa_admin
#List of per user domain access control. The first field is the username and
#the second field (separated by tabulation) is a comma separated list of domain
#name to be allowed to this user. You could add as many lines of DOMAIN_USER
#as you want in the configuration file.
#DOMAIN_USER user1 domain1.com,domain3.com
#DOMAIN_USER user2 domain2.com,...
# Path to the Sendmail.org logo. Default current directory
URL_LOGO salogo.png
# Path to the flotr2 javascript library. Default current directory
URL_JSCRIPT flotr2.js
# Path to the sortable javascript library. Default current directory
URL_SORTABLE sorttable.js
# Syslog name of Amavis. Syslog write it to maillog with the pid as follow:
# ... amavis[1234] ... This is required to only parse relevant logged lines
AMAVIS_NAME \\/usr\\/sbin\\/amavisd-new|amavis|maiad
# Path to SMTP error code file (relative to the CGI directory)
# Default: lang/ERROR_CODE
ERROR_CODE lang/ERROR_CODE
# Comma separated list of internal domain to be used when sendmailanalyzer is
# running on a mail host which received message from any side. SA can't know
# what message are internal or external in this case, so the only way to know
# if a mail come from Internet or Lan/Wan is to check the domain part of the
# relay sender address. You can have multiple LOCAL_DOMAIN lines for better
# reading. You can also give a file containing a list of domain, one per line.
# If you are running rsyslog with multiple host use LOCAL_HOST_DOMAIN instead.
# See VIRTUAL_DOMAIN_DB bellow if your virtual domains are stored in a database.
#LOCAL_DOMAIN domain1.com,domain2.com
# Same as above but with host distinction for use with rsyslog.
# You can have multiple LOCAL_HOST_DOMAIN lines, ie: one per host.
#LOCAL_HOST_DOMAIN sysloghost1 domain1.com,domain2.com
# If you're running a mailserver with virtual domains in a database this option
# will allow sendmailanalyzer to perform domain-lookups in the database to
# determine whether this domain is external or internal (like the LOCAL_DOMAIN
# option above. This will come with decent database load depending on how much
# traffic your mailserver experiences as every domain will be matched against
# your database.
# Leave this unconfigured if you don't have virtual domains in a database set up
# otherwise sendmailanalyzer will exit with an error.
#VIRTUAL_DOMAIN_DB DBI:mysql:database=mailserver:host=localhost
#VIRTUAL_DOMAIN_DB DBI:Pg:dbname=mailserver;host=localhost;port=5432
# Username for the database connection
#VIRTUAL_DOMAIN_DB_USER username
# Password for the database connection
#VIRTUAL_DOMAIN_DB_PASS secret
# Query to select the list of domain from the database. Sendmailanalyzer will
# load the list into the LOCAL_DOMAIN array. This list will be checked against
# sender or recipient relay to determine the email direction.
#VIRTUAL_DOMAIN_DB_QUERY SELECT name FROM virtual_domains
# Syslog name of MimeDefang. Syslog write it to maillog with the pid as follow:
# ... mimedefang.pl[1234] ... This is required to only parse relevant logged lines
# Based on parsing mimedefang log generated by method md_graphdefang_log()
MD_NAME mimedefang.pl
# Anonymize reports. This remove sender and recipient adresses from reports.
ANONYMIZE 0
# Replace some hostname in all relay information for anonymization
# You must used one REPLACE_HOST line per replacement.
REPLACE_HOST internal.relay.dom external.relay.dom
# Make report for Spam detail. Default is enable. This allow you to see score
# and complete detail of your favorite antispam.
SPAM_DETAIL 1
# Enable/Disable SMTP Auth view. Note that it is already disable in per domain
# views. Default show it: 1
SMTP_AUTH 1
# Enable/Disable Spam views. Default show it: 1
SPAM_VIEW 1
# Enable/Disable Virus views. Default show it: 1
VIRUS_VIEW 1
# Enable/Disable Notification views. Default show it: 1
DSN_VIEW 1
# Enable/Disable Postgrey usage views. Default show it: 1
POSTGREY_VIEW 1
# List of antispam name separated by a comma used for Spam details view. You may
# want to custom this list to just show menu link on available reports. Default
# list is: spamdmilter,jchkmail,dnsbl,spamassassin,amavis,mimedefang,dnsblmilter,spamd,policydweight
SPAM_TOOLS spamdmilter,jchkmail,dnsbl,spamassassin,amavis,mimedefang,dnsblmilter,spamd,policydweight
# Enable/Disable messaging/spam/virus/dsn direction statistics. Default is show.
# On some mailhost this could show wrong information if the direction could
# not be easily determined. So you can remove these views by setting it to 0.
SHOW_DIRECTION 1
# Use to combined mailhost report on a single report. This allow you to
# aggregate multiple mailhost that syslogs to a remote server throught
# rsyslog to have only one SendmailAnalyzer report. The value must only use
# alphanumeric character as it is used to create subdirectory.
#MERGING_HOST agghostname
# Syslog name of Clamd. When using Mailscanner with clamd if you want virus
# report you must configure clamd to log with syslog and use LOCAL_MAIL.
# ... clamd[1234] ...
# Can be overwritten with --clamd or -n
CLAMD_NAME clamd
# Syslog name of Clamsmtpd.
# ... clamsmtpd: ...
CLAMSMTPD_NAME clamsmtpd
# Syslog name of Postgrey. Syslog write it to maillog with the pid as follow:
# ... postgrey[1234] ... This is required to only parse relevant logged lines
# Can be overwritten with --postgrey or -g
POSTGREY_NAME postgrey|sqlgrey
# Syslog name of SPF and DKIM log entry. Syslog write it to maillog with the
# pid as follow: ... opendmarc[1234] ...
SPF_DKIM_NAME opendmarc|opendkim
# HTML charset to use. Default is iso-8859-1, but with cyrillics you may want
# to use utf-8 instead.
#HTML_CHARSET utf-8
# Use this to set the recipient relay used for local delivery if your message
# appears twice in details view and in messaging, sender and recipient counter.
# This is especially right with postfix configured to have local delivery
# via dovecot service. Default: dovecot, that mean that recipient log lines with
# relay=dovecot will instruct sendmailanalyzer to skip those messages. One
# other common value is 127.0.0.1
SKIP_RCPT_RELAY dovecot
# Syslog name of Spamd. Syslog write it to maillog with the pid as follow:
# ... spamd[1234] ... This is required to only parse relevant logged lines
# Can be overwritten with --spamd
SPAMD_NAME spamd
# Pipe separated list of destination email address that should be excluded
# from the report. They will not be reported into data files too. The value
# should be a valid regex, the addresses will be search in all destination
# adresses like \$TO =~ /^\$EXCLUDE_TO\$/
EXCLUDE_TO bcc-addr1\@domain1.com|bcc-addr2\@domain2.com
# Pipe separated list of sender email address that should be excluded
# from the report. They will not be reported into data files too. The value
# should be a valid regex, the addresses will be search in all senders
# adresses like \$FROM =~ /^\$EXCLUDE_FROM\$/
EXCLUDE_FROM addr1\@domain1.com|addr2\@domain2.com
# Pipe separated list of sender relay ip addresses that should be excluded
# from the report. They will not be reported into data files too. The value
# should be a valid regex, the addresses will be search in all senders relay
# ip adresses like \$RELAY =~ /^\$EXCLUDE_RELAY\$/
EXCLUDE_RELAY addr1\@domain1.com|addr2\@domain2.com
# When enabled it allow email subjects to be shown in detailed view. Of course
# The log file must contain this information.
SHOW_SUBJECT 0
# When activated, remove domain part of the syslog hostname. Some programme
# use FQDN instead of the single hostname. Set it to 1 if you have two report
# for the same hostname but one with the domain part.
NO_HOST_DOMAIN 0
# On some MTA, message delivery is done outside and only queuing is logged,
# this mean that messages are counted as incoming but not delivered. Enable
# this directive to force sendmailanalyzer to take them as sent.
NO_QUEUE_EXCLUSION 0
# When possible sendmailanalyzer extract the fqdn part of the sender or
# recipient relay. Enable this directive if you just want Ip addresses.
RELAY_IP_ONLY 0
# Threshold to detect case where postscreen reject an ip address. By
# default reject: RCPT from ... are not logged by postfix, we mark the
# message as DNSBL rejected when DNSBL rank value is upper or equal.
POSTSCREEN_DNSBL_THRESHOLD 3
# Use this directive to defined a custom regular expression that will be applied
# on status part of a Postfix milter-reject message. A Postfix milter-reject
# message is of the form: milter-reject: END-OF-MESSAGE from ... The default is
# to treat any message with status not containing string "Spam message rejected"
# as rejected. If you want to treat other messages as spam instead of rejected
# you can give a regexp that can catch them. For example
# MILTER_REJECT_REGEX Mailbox not found
# will treat all messages with a status including "Mailbox not found" as spam.
# The value must be a valid Perl regular expression.
MILTER_REJECT_REGEX
};
close(OUTCFG);
unless(open(INST, ">install_all.sh")) {
print "\nError: can't write post install file install_all.sh, $!\n";
exit 0;
}
print INST qq{#!/bin/sh
if [ ! -d "$DESTDIR$BINDIR" ]; then
mkdir -p $DESTDIR$BINDIR
fi
if [ ! -d "$DESTDIR$CONFDIR" ]; then
mkdir -p $DESTDIR$CONFDIR
fi
if [ ! -d "$DESTDIR$HTMLDIR" ]; then
mkdir -p $DESTDIR$HTMLDIR/lang
fi
if [ ! -d "$DESTDIR$BASEDIR" ]; then
mkdir -p $DESTDIR$BASEDIR
fi
if [ ! -d "$DESTDIR$MANDIR" ]; then
mkdir -p $DESTDIR$MANDIR
fi
if [ ! -d "$DESTDIR$DOCDIR" ]; then
mkdir -p $DESTDIR$DOCDIR
fi
if [ ! -d "$DESTDIR$PIDDIR" ]; then
mkdir -p $DESTDIR$PIDDIR
fi
install -m 644 sendmailanalyzer.conf $DESTDIR$DOCDIR/sendmailanalyzer.conf.sample
if [ ! -e "$DESTDIR$CONFDIR/sendmailanalyzer.conf" ]; then
install -m 644 sendmailanalyzer.conf $DESTDIR$CONFDIR/sendmailanalyzer.conf
fi
install -m 755 sendmailanalyzer $DESTDIR$BINDIR/
install -m 755 sa_cache $DESTDIR$BINDIR/
install -m 755 cgi-bin/sa_report.cgi $DESTDIR$HTMLDIR/
install -m 644 cgi-bin/lang/* $DESTDIR$HTMLDIR/lang/
install -m 644 salogo.png $DESTDIR$HTMLDIR/
install -m 644 flotr2.js $DESTDIR$HTMLDIR/
install -m 644 sorttable.js $DESTDIR$HTMLDIR/
pod2man doc/sendmailanalyzer.pod doc/sendmailanalyzer.3
pod2man doc/sa_cache.pod doc/sa_cache.3
install -m 644 doc/sendmailanalyzer.3 $DESTDIR$MANDIR/
install -m 644 doc/sa_cache.3 $DESTDIR$MANDIR/
install -m 644 README $DESTDIR$DOCDIR/
install -m 644 ChangeLog $DESTDIR$DOCDIR/
};
if (!$ENV{QUIET}) {
print INST qq{
echo "
-----------------------------------------------------------------------------
1. Start SendmailAnalyzer daemon with:
$BINDIR/sendmailanalyzer -f
or use one of the starters script provided in the start_scripts/ directory.
2. Modify your Apache2 configuration to allow access to CGI scripts like follow:
Alias /sareport $HTMLDIR
<Directory $HTMLDIR>
Options ExecCGI
AddHandler cgi-script .cgi
DirectoryIndex sa_report.cgi
#-- Some browser might need this line (Chrome, Safari)
Header always set X-Frame-Options "SAMEORIGIN"
#-- Apache 2.2
#Order deny,allow
#Deny from all
#Allow from 192.168.1.0/24
#-- Apache 2.4
Require all denied
Require ip 192.168.1.0/24
</Directory>
If necessary, give additional host access to SendmailAnalyzer.
To be able to use Header directive be sure that header module is enabled:
a2enmod headers
Restart and ensure that httpd is running.
3. Browse to http://mta.host.dom/sareport/ to ensure that things are working
properly.
4. Setup a cronjob to run sa_cache and restart SendmailAnalyzer daemon after
maillog logrotate as follow:
# SendmailAnalyzer log reporting daily cache
0 1 * * * $BINDIR/sa_cache > /dev/null 2>&1
# On huge MTA you may want to have five minutes caching
#*/5 * * * * $BINDIR/sa_cache -a > /dev/null 2>&1
5. Add an entry in /etc/logrotate.d/syslog to restart SendmailAnalyzer when
maillog is rotated or create a cron job.
For more information, see $DOCDIR/README file.
-----------------------------------------------------------------------------
" | more
};
}
close(INST);
`chmod 755 install_all.sh`;
`perl -p -i -e 's#my \\\$CONFIG_FILE .*#my \\\$CONFIG_FILE = "$CONFDIR/sendmailanalyzer.conf";#' sendmailanalyzer sa_cache`;
`perl -p -i -e 's#my \\\$CONFIG_FILE .*#my \\\$CONFIG_FILE = "$CONFDIR/sendmailanalyzer.conf";#' cgi-bin/*.cgi`;
`perl -p -i -e 's#SALYZER=.*#SALYZER=$BINDIR/sendmailanalyzer#' start_scripts/*`;
`perl -p -i -e 's#PIDFILE=.*#PIDFILE=$PIDDIR/sendmailanalyzer.pid#' start_scripts/*`;
WriteMakefile(
'NAME' => 'sendmailanalyzer',
'VERSION_FROM' => 'sendmailanalyzer',
'dist' => {
'COMPRESS'=>'gzip -9f', 'SUFFIX' => 'gz',
'ZIP'=>'/usr/bin/zip','ZIPFLAGS'=>'-rl'
},
'AUTHOR' => 'Gilles Darold (gilles@darold.net)',
'ABSTRACT' => 'Sendmail log analyzer',
'EXE_FILES' => [ qw(sendmailanalyzer sa_cache) ],
'MAN3PODS' => { 'doc/sendmailanalyzer.pod' => 'blib/man3/sendmailanalyzer.pod.3', 'doc/sa_cache.pod' => 'blib/man3/sa_cache.pod.3' },
'DESTDIR' => $ENV{DESTDIR},
'INSTALLDIRS' => $ENV{INSTALLDIRS},
'clean' => {FILES => "install_all.sh sendmailanalyzer.conf doc/sendmailanalyzer.3 doc/sa_cache.3"},
'META_MERGE' => {
resources => {
homepage => 'http://sendmailanalyzer.darold.net/',
repository => {
type => 'git',
git => 'git@github.com:darold/sendmailanalyzer.git',
web => 'https://github.com/darold/sendmailanalyzer',
},
},
}
);
sub MY::install {
my $self = shift;
my $string = $self->MM::install;
$string =~ s/(pure_install\s+)(.*)/$1 install_all $2/;
return $string;
}
sub MY::postamble {
my $postamble = <<'END';
install_all: install_all.sh
sh install_all.sh
END
return $postamble;
}
if (!$ENV{QUIET}) {
print "Done...\n\n";
print "Now type 'make && make install'\n\n";
}
Reference in a new issue View git blame Copy permalink