burble.dn42/emailrelay
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

v2.2

Browse Source
This commit is contained in:
Graeme Walker 2021-02-16 12:00:00 +00:00
parent b0a0cb1b42
commit 4ef1c64564
583 changed files with 35968 additions and 21190 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
ChangeLog
View File

@ -1,6 +1,22 @@
E-MailRelay Change Log
======================
2.1 -> 2.2
----------
* Connections from IPv4 'private use' addresses are allowed by default (see "--remote-clients").
* Interface names can be used with "--interface" (eg. "--interface=eth0").
* New "--server-tls-connection" option for server-side implicit TLS.
* New "--forward-to-some" option to permit some message recipients to be rejected.
* New "--log-address" option to aid adaptive firewalling.
* Dynamic log file rolling when using "--log-file=%d".
* Choice of syslog 'facility' on Linux with "--syslog=local0" etc.
* Pipelined SMTP QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable "--filter" scripts.
* Optional epoll event loop on Linux ("configure --enable-epoll").
* Some internationalisation support (see NEWS file).
* Support for Windows XP restored when built with mingw-w64.
* C++ 2011 compiler is required.
2.0.1 -> 2.1
------------
* Backwards compatibility features for 1.9-to-2.0 transition removed.

60
Makefile.am
View File

@ -1,28 +1,49 @@
#
## Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
# Makefile.am
#
# Top-level makefile
#
# Additional pseudo-targets for packaging:
# Additional pseudo-targets:
# * rpm - builds an rpm package using rpmbuild
# * deb - builds a deb package using debhelper
# * cmake - generates simplistic cmake files under ./build/
# * tidy - runs cmake-tidy
# * format - runs cmake-format
#
# When running "make distcheck" consider doing this to avoid
# a lengthy testing stage:
# Eg:
# $ dnf install g++ make automake openssl-devel pam-devel rpm-build # rpm
# $ ./bootstrap
# $ ./configure.sh
# $ make
# $ sudo make rpm
#
# or:
# $ apt install g++ make automake libssl-dev libpam0g-dev debhelper # deb
# $ ./bootstrap
# $ ./configure.sh
# $ make
# $ sudo make deb
#
# and possibly:
# $ make cmake ; cd build ; make
# $ make tidy TIDY=clang-tidy-10
# $ make format FORMAT=clang-format-10
# $ make distcheck DISTCHECK_CONFIGURE_FLAGS=--disable-testing
#
@ -38,11 +59,9 @@ EXTRA_DIST = \
autogen.sh \
winbuild.bat \
winbuild.pl \
winbuild.pm \
winbuild-parser.pm \
runperl.bat
SUBDIRS = bin src etc doc debian test m4 bsd
SUBDIRS = bin src etc doc debian test m4 bsd po
# work-round PKG_CHECK_MODULES if no pkg-config
ACLOCAL_AMFLAGS = -I m4
@ -50,7 +69,7 @@ ACLOCAL_AMFLAGS = -I m4
e_doc_DATA = COPYING AUTHORS INSTALL NEWS README ChangeLog
uninstall-local:
-for try in 1 2 3 4 ; do echo "$(e_pamdir)" "$(e_initdir)" "$(e_sysconfdir)" "$(e_examplesdir)" "$(e_libexecdir)" "$(e_spooldir)" "$(e_docdir)" "$(pkgdatadir)" | tr ' ' '\n' | grep "emailrelay$" | while read d ; do rmdir "$(DESTDIR)/$$d" 2>/dev/null ; done ; done
-for try in 1 2 3 4 ; do echo "$(e_pamdir)/" "$(e_initdir)/" "$(e_sysconfdir)/" "$(e_examplesdir)/" "$(e_libexecdir)/" "$(e_spooldir)/" "$(e_docdir)/" "$(pkgdatadir)/" | tr ' ' '\n' | grep "/emailrelay/" | while read d ; do rmdir "$(DESTDIR)/$$d" 2>/dev/null ; done ; done
RPM_ROOT ?= ${HOME}/rpmbuild
#ARCH ?= $(shell arch)
@ -59,6 +78,10 @@ RPM=$(RPM_ROOT)/RPMS/$(ARCH)/emailrelay-$(VERSION)-1.$(ARCH).rpm
TAR=emailrelay-$(VERSION).tar.gz
DEB=emailrelay_$(VERSION)_$(ARCH).deb
.PHONY: strip
strip:
$(MAKE) -C src/main strip
.PHONY: rpm
rpm: $(RPM)
@ -91,3 +114,18 @@ deb-src: dist
echo 1.0 > emailrelay-$(VERSION)/debian/source/format
dpkg-source --build emailrelay-$(VERSION)
.PHONY: tidy
tidy:
$(MAKE) -C src tidy
.PHONY: format
format:
$(MAKE) -C src format
.PHONY: cmake
cmake:
@chmod +x bin/make2cmake || true
bin/make2cmake
mkdir build || true
cd build && cmake -DCMAKE_MAKE_PROGRAM:FILEPATH=/usr/bin/make -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..

53
Makefile.in
View File

@ -17,14 +17,35 @@
#
#
#
# Makefile.am
#
# Top-level makefile
#
# Additional pseudo-targets for packaging:
# Additional pseudo-targets:
# * rpm - builds an rpm package using rpmbuild
# * deb - builds a deb package using debhelper
# * cmake - generates simplistic cmake files under ./build/
# * tidy - runs cmake-tidy
# * format - runs cmake-format
#
# When running "make distcheck" consider doing this to avoid
# a lengthy testing stage:
# Eg:
# $ dnf install g++ make automake openssl-devel pam-devel rpm-build # rpm
# $ ./bootstrap
# $ ./configure.sh
# $ make
# $ sudo make rpm
#
# or:
# $ apt install g++ make automake libssl-dev libpam0g-dev debhelper # deb
# $ ./bootstrap
# $ ./configure.sh
# $ make
# $ sudo make deb
#
# and possibly:
# $ make cmake ; cd build ; make
# $ make tidy TIDY=clang-tidy-10
# $ make format FORMAT=clang-format-10
# $ make distcheck DISTCHECK_CONFIGURE_FLAGS=--disable-testing
#
@ -344,6 +365,7 @@ e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
e_sysconfdir = @e_sysconfdir@
e_systemddir = @e_systemddir@
exec_prefix = @exec_prefix@
host_alias = @host_alias@
htmldir = @htmldir@
@ -382,11 +404,9 @@ EXTRA_DIST = \
autogen.sh \
winbuild.bat \
winbuild.pl \
winbuild.pm \
winbuild-parser.pm \
runperl.bat
SUBDIRS = bin src etc doc debian test m4 bsd
SUBDIRS = bin src etc doc debian test m4 bsd po
# work-round PKG_CHECK_MODULES if no pkg-config
ACLOCAL_AMFLAGS = -I m4
@ -892,12 +912,16 @@ uninstall-am: uninstall-e_docDATA uninstall-local
uninstall-local:
-for try in 1 2 3 4 ; do echo "$(e_pamdir)" "$(e_initdir)" "$(e_sysconfdir)" "$(e_examplesdir)" "$(e_libexecdir)" "$(e_spooldir)" "$(e_docdir)" "$(pkgdatadir)" | tr ' ' '\n' | grep "emailrelay$" | while read d ; do rmdir "$(DESTDIR)/$$d" 2>/dev/null ; done ; done
-for try in 1 2 3 4 ; do echo "$(e_pamdir)/" "$(e_initdir)/" "$(e_sysconfdir)/" "$(e_examplesdir)/" "$(e_libexecdir)/" "$(e_spooldir)/" "$(e_docdir)/" "$(pkgdatadir)/" | tr ' ' '\n' | grep "/emailrelay/" | while read d ; do rmdir "$(DESTDIR)/$$d" 2>/dev/null ; done ; done
RPM_ROOT ?= ${HOME}/rpmbuild
#ARCH ?= $(shell arch)
ARCH ?= x86_64
.PHONY: strip
strip:
$(MAKE) -C src/main strip
.PHONY: rpm
rpm: $(RPM)
@ -930,6 +954,21 @@ deb-src: dist
echo 1.0 > emailrelay-$(VERSION)/debian/source/format
dpkg-source --build emailrelay-$(VERSION)
.PHONY: tidy
tidy:
$(MAKE) -C src tidy
.PHONY: format
format:
$(MAKE) -C src format
.PHONY: cmake
cmake:
@chmod +x bin/make2cmake || true
bin/make2cmake
mkdir build || true
cd build && cmake -DCMAKE_MAKE_PROGRAM:FILEPATH=/usr/bin/make -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:

31
NEWS
View File

@ -1,15 +1,24 @@
News
----
E-MailRelay 2.1 removes the backwards-compatibility features that were put in
to make the migration from 1.9 to 2.0 smoother. Refer to the NEWS file from
the 2.0 release for the details.
E-MailRelay 2.2 is now fully C++11, so older compilers will not work unless
they have a "-std=c++11" option or similar, and this also means that
"uclibc++" is no longer supported.
The creation of ".local" files for local-mailbox recipients has changed slightly
in this release in that normal message files are not created if the message only
has local-mailbox recipients. This will affect users of the "--address-verifier"
option where the verifier script returns zero.
The behaviour with respect to the "--remote-clients" command-line option is
changed in this release: previously IPv4 connections were allowed only from
the host's local address, as determined by a DNS lookup, unless using
"--remote-clients". The new implementation allows connections from any
loopback or 'private use' address, defined in RFC-1918 and RFC-5735. This
brings the IPv4 behaviour in line with IPv6, and it still honours the intent
of the "--remote-clients" option in protecting the naive user against
accidental exposore to the public internet.
The 2.1 release continues the migration from C++1998 to C++2011. It is still
possible to use C++1998, but in addition to loosing multithreading you might
also loose the installation/configuration GUI since Qt has dropped support for
C++1998.
Some internationalisation support has been added, using gettext() for the
main program and Qt's tr() for the GUI. See "doc/developer.txt".
A systemd unit file has been added, although by default it is only installed
as an "examples" file. Use "e_systemddir=/usr/lib/systemd/system" on the
"./configure" command-line to have it installed by "make install".
This release has a new "make tidy" option that runs "clang-tidy" over the
code and also "make cmake" to generate simple cmake files for a unix build.

2
README
View File

@ -64,7 +64,7 @@ To run E-MailRelay as a POP server without SMTP use "--pop" and "--no-smtp":
The "emailrelay-submit" utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the "--remote-clients" option, but please
check your firewall settings to make sure this cannot be exploited by spammers.

2
README.md
View File

@ -70,7 +70,7 @@ To run E-MailRelay as a [POP][] server without SMTP use `--pop` and `--no-smtp`:
The `emailrelay-submit` utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the `--remote-clients` option, but please
check your firewall settings to make sure this cannot be exploited by spammers.

2
README.rst
View File

@ -89,7 +89,7 @@ To run E-MailRelay as a POP_ server without SMTP use *--pop* and *--no-smtp*:
The *emailrelay-submit* utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the *--remote-clients* option, but please
check your firewall settings to make sure this cannot be exploited by spammers.

2
VERSION
View File

@ -1 +1 @@
2.1
2.2

133
winbuild-parser.pm → bin/AutoMakeParser.pm
View File

@ -1,31 +1,34 @@
#!/usr/bin/perl
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# AutoMakeParser.pm
#
# Parser package (AutoMakeParser) for parsing automake makefiles,
# with full variable expansion and support for conditional sections.
# Parser package for parsing automake makefiles, with full variable
# expansion and support for conditional sections.
#
# Synopsis:
#
# use AutoMakeParser ;
# $AutoMakeParser::debug = 0 ;
# my @makefiles = AutoMakeParser::readall( "." , { FOO => 1 , BAR => 0 } , { A => 'aaa' , B => 'bbb' } ) ;
# my $makefile = new AutoMakeParser( "Makefile.am" , { FOO => 1 , BAR => 0 } , { A => 'aaa' , B => 'bbb' } ) ;
# $makefile->path() ;
# $makefile->keys() ;
# $makefile->keys_() ;
# $makefile->value("some_VAR") ;
# $makefile->subdirs() ;
# $makefile->programs() ;
@ -39,19 +42,19 @@
use strict ;
use FileHandle ;
use Cwd ;
use Carp ;
use File::Basename ;
use File::Find ;
use File::Path ;
package AutoMakeParser ;
our $verbose = 0 ;
our $debug = 0 ;
sub new
{
my ( $classname , $path , $switches , $ro_vars ) = @_ ;
my %me = (
m_path => simplepath($path) ,
m_depth => undef , # from readall()
m_lines => [] ,
m_vars => {} ,
m_switches => $switches ,
@ -66,15 +69,48 @@ sub new
sub path
{
return $_[0]->{m_path}
return $_[0]->{m_path} ;
}
sub readall
{
my ( $base_dir , $switches , $vars , $verbose ) = @_ ;
my @makefiles = () ;
_readall_imp( \@makefiles , 0 , $base_dir , $switches , $vars , $verbose ) ; # recursive
return @makefiles ;
}
sub _readall_imp
{
my ( $makefiles , $depth , $dir , $switches , $vars , $verbose ) = @_ ;
my $m = new AutoMakeParser( "$dir/Makefile.am" , $switches , $vars ) ;
$m->{m_depth} = $depth ;
print "makefile=[" , $m->path() , "] ($depth)\n" if $verbose ;
push @$makefiles , $m ;
for my $subdir ( $m->value("SUBDIRS") )
{
_readall_imp( $makefiles , $depth+1 , "$dir/$subdir" , $switches , $vars , $verbose ) ;
}
}
sub depth
{
# Returns the readall() recursion depth.
#
my ( $this ) = @_ ;
return $this->{m_depth} ;
}
sub top
{
# Returns the relative path up to the first readall()
# makefile, which might be different from $(top_srcdir).
# The returned value will be something like "../../../".
#
my ( $this ) = @_ ;
my $depth = scalar(split("/",$this->{m_path})) - 1 ;
die if $depth < 0 ;
return simplepath( "../" x $depth ) ;
my $depth = $this->{m_depth} ;
Carp::confess("bad depth") if ( !defined($depth) || $depth < 0 ) ;
return $depth == 0 ? "." : ( "../" x $depth ) ;
}
sub value
@ -84,7 +120,7 @@ sub value
return wantarray ? split(' ',$v) : $v ;
}
sub keys
sub keys_
{
my ( $this ) = @_ ;
my @k = sort keys %{$this->{m_vars}} ;
@ -94,13 +130,13 @@ sub keys
sub programs
{
my ( $this ) = @_ ;
return map { $this->value($_) } grep { m/_PROGRAMS$/ } $this->keys() ;
return map { $this->value($_) } grep { m/_PROGRAMS$/ } $this->keys_() ;
}
sub libraries
{
my ( $this ) = @_ ;
return map { $this->value($_) } grep { m/_LIBRARIES$/ } $this->keys() ;
return map { $this->value($_) } grep { m/_LIBRARIES$/ } $this->keys_() ;
}
sub subdirs
@ -140,9 +176,9 @@ sub sources
sub definitions
{
my ( $this , $var ) = @_ ;
$var ||= "AM_CPPFLAGS" ;
my $s = protect_quoted_spaces( simple_spaces( $this->{m_vars}->{$var} ) ) ;
my ( $this , $am_cppflags ) = @_ ;
$am_cppflags ||= "AM_CPPFLAGS" ;
my $s = protect_quoted_spaces( simple_spaces( $this->{m_vars}->{$am_cppflags} ) ) ;
$s =~ s/-D /-D/g ;
return
map { s/\t/ /g ; $_ }
@ -153,14 +189,34 @@ sub definitions
sub includes
{
my ( $this , $top , $var ) = @_ ;
# Returns a list of include directories, so for example
# "-I$(top_srcdir)/one/two -I$(top_srcdir)/three"
# with the 'top_srcdir' variable defined as "." gives
# ("./one/two","./three").
#
# However, since the 'top_srcdir' expansion is fixed, and the
# relative include paths need to vary through the source
# tree, a prefix parameter ('top') can be passed in here.
# So then "-I$(top_srcdir)/one/two" becomes "<top>/./one/two".
#
# The 'top' parameter can be from top() as long as readall()
# started at the 'top_srcdir' directory and the 'top_srcdir'
# variable is defined as ".". Otherwise, a simple approach
# is to still use top() for the 'top' parameter but define
# the 'top_srcdir' variable as the difference between the
# readall() base and the actual 'top_srcdir' directory.
#
my ( $this , $top , $am_cppflags , $extra_includes , $full_paths ) = @_ ;
$top ||= "" ;
$var ||= "AM_CPPFLAGS" ;
my $s = protect_quoted_spaces( simple_spaces( $this->{m_vars}->{$var} ) ) ;
$am_cppflags ||= "AM_CPPFLAGS" ;
$extra_includes ||= "" ;
my $cppflags = join( " " , $extra_includes , $this->{m_vars}->{$am_cppflags} ) ;
my $s = protect_quoted_spaces( simple_spaces( $cppflags ) ) ;
$s =~ s/-I /-I/g ;
return
map { $full_paths?$this->fullpath($_):$_ }
map { simplepath($_) }
map { join("/",$top,$_) }
map { $top?join("/",$top,$_):$_ }
map { s/\t/ /g ; $_ }
map { s:-I:: ; $_ } grep { m/-I\S+/ }
split( " " , $s ) ;
@ -175,8 +231,29 @@ sub vars
sub simplepath
{
my ( @parts ) = @_ ;
return join( "/" , grep { $_ ne "" && $_ ne "." } split("/",join("/",@parts)) ) ;
my ( $path ) = @_ ;
my $first = ( $path =~ m;^/; ) ? "/" : "" ;
my @out = () ;
my @split = split( "/" , $path ) ;
for my $x ( @split )
{
next if( $x eq "" || $x eq "." ) ;
if( $x eq ".." && scalar(@out) && @out[-1] ne ".." )
{
pop @out ;
}
else
{
push @out , $x ;
}
}
return $first . join( "/" , @out ) ;
}
sub fullpath
{
my ( $this , $relpath ) = @_ ;
return simplepath( join("/",File::Basename::dirname(Cwd::realpath($this->path())),$relpath) ) ;
}
sub simple_spaces
@ -392,7 +469,7 @@ sub do_assign_more
sub debug_
{
print @_ , "\n" if $verbose ;
print @_ , "\n" if $debug ;
}
1 ;

143
bin/CompilationDatabase.pm Normal file
View File

@ -0,0 +1,143 @@
#!/usr/bin/perl
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# CompilationDatabase.pm
#
# Parses automake files throughout a source tree using AutoMakeParser
# and generates a "compilation database" file, "compile_commands.json".
#
# See also: https://clang.llvm.org/docs/JSONCompilationDatabase.html
#
# Synopsis:
#
# use CompilationDatabase ;
# my $cdb = new CompilationDatabase( $src_dir ,
# ["-DFOO=BAR",...] , ["-I_TOP_"] , ["-Wall"] , {WINDOWS=>0,...} , {top_srcdir=>'..'} ) ;
# my @files = $cdb->list() ;
# my @stanzas = $cdb->stanzas() ;
# $cdb->print() ;
#
use strict ;
use File::Basename ;
use AutoMakeParser ;
package CompilationDatabase ;
our $debug = 0 ;
sub new
{
my ( $classname , $base_makefile_dir , $dflags , $iflags , $cxxflags , $switches , $ro_vars ) = @_ ;
$AutoMakeParser::debug = 1 if $debug > 1 ;
my %me = (
m_base_dir => $base_makefile_dir ,
m_dflags => $dflags ,
m_iflags => $iflags ,
m_cxxflags => $cxxflags ,
m_switches => $switches ,
m_ro_vars => $ro_vars ,
m_full_paths => 0 ,
) ;
return bless \%me , $classname ;
}
sub list
{
my ( $this ) = @_ ;
my @list = () ;
my $verbose = $debug ;
my @makefiles = AutoMakeParser::readall( $this->{m_base_dir} , $this->{m_switches} , $this->{m_ro_vars} , $verbose ) ;
for my $m ( @makefiles )
{
my $sub_dir = File::Basename::dirname( $m->path() ) ;
for my $library ( $m->libraries() )
{
push @list , map { "$sub_dir/$_" } $m->sources($library) ;
}
for my $program ( $m->programs() )
{
push @list , map { "$sub_dir/$_" } $m->sources($program) ;
}
}
return @list ;
}
sub print
{
my ( $this ) = @_ ;
print "[\n" ;
print join( ",\n" , $this->stanzas() ) ;
print "]\n" ;
}
sub stanzas
{
my ( $this ) = @_ ;
my @makefiles = AutoMakeParser::readall( $this->{m_base_dir} , $this->{m_switches} , $this->{m_ro_vars} ) ;
my @output = () ;
for my $m ( @makefiles )
{
my $dir = File::Basename::dirname( $m->path() ) ;
my @includes = map { "-I$_" } $m->includes( $m->top() , undef , join(" ",@{$this->{m_iflags}}) , $this->{m_full_paths} ) ;
my @definitions = map { "-D$_" } $m->definitions() ;
push @definitions , @{$this->{m_dflags}} ;
if( $debug )
{
print "cdb: makefile=" , $m->path() , "\n" ;
print "cdb: AM_CPPFLAGS=[",join("|",$m->value("AM_CPPFLAGS")),"]\n" ;
print "cdb: top=",$m->top(),"\n" ;
print "cdb: \@includes=" , join("|",@includes) , "\n" ;
print "cdb: \@definitions=" , join("|",@definitions) , "\n" ;
}
for my $library ( $m->libraries() )
{
map { push @output , $this->_stanza($dir,$_,\@includes,\@definitions) } $m->sources($library) ;
}
for my $program ( $m->programs() )
{
map { push @output , $this->_stanza($dir,$_,\@includes,\@definitions) } $m->sources($program) ;
}
}
return @output ;
}
sub _stanza
{
my ( $this , $dir , $source , $includes , $definitions ) = @_ ;
my @all_flags = ( @{$this->{m_cxxflags}} , @$definitions , @$includes ) ;
my $directory = Cwd::realpath( $dir ) ;
$source = join("/",$directory,$source) if $this->{m_full_paths} ;
my $command = "/usr/bin/c++ @all_flags -c $source" ;
$command =~ s/"/\\"/g ;
return
"{\n" .
" \"directory\" : \"$directory\" ,\n" .
" \"command\" : \"$command\",\n" .
" \"file\" : \"$source\" ,\n" .
"}" ;
}
1 ;

36
bin/Makefile.am
View File

@ -1,22 +1,23 @@
#
## Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
#
example_scripts = \
example_scripts_static = \
emailrelay-bcc-check.pl \
emailrelay-ldap-verify.py \
emailrelay-multicast.sh \
emailrelay-rot13.pl \
emailrelay-sendmail.pl \
@ -27,8 +28,7 @@ example_scripts_in = \
emailrelay-deliver.sh.in \
emailrelay-notify.sh.in \
emailrelay-resubmit.sh.in \
emailrelay-submit.sh.in \
emailrelay.sh.in
emailrelay-submit.sh.in
example_scripts_out = \
emailrelay-deliver.sh \
@ -37,13 +37,22 @@ example_scripts_out = \
emailrelay-submit.sh \
emailrelay
init_scripts = \
init_script_in = \
emailrelay.sh.in
init_script_out = \
emailrelay
work_scripts = \
doxygen.sh \
make-manifest.sh \
make-setup.sh
make-setup.sh \
make-format \
make2cmake \
make2cdb \
AutoMakeParser.pm \
CompilationDatabase.pm \
winbuild.pm
js_scripts = \
emailrelay-edit-content.js \
@ -52,8 +61,9 @@ js_scripts = \
emailrelay-service-install.js
EXTRA_DIST = \
$(example_scripts) \
$(example_scripts_static) \
$(example_scripts_in) \
$(init_script_in) \
$(work_scripts) \
$(js_scripts)
@ -62,18 +72,18 @@ noinst_SCRIPTS = \
$(js_scripts)
e_examples_DATA = \
$(example_scripts)
$(example_scripts_static)
e_examples_SCRIPTS = \
$(example_scripts_out)
e_init_SCRIPTS = \
$(init_scripts)
$(init_script_out)
CLEANFILES = \
$(example_scripts_out)
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIBEXEC_DIR__%${e_libexecdir}%g" -e "s%__RUNDIR__%${e_rundir}%g"
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIBEXEC_DIR__%${e_libexecdir}%g" -e "s%__RUN_DIR__%${e_rundir}%g"
emailrelay-deliver.sh: emailrelay-deliver.sh.in
$(do_sed) < $(srcdir)/emailrelay-deliver.sh.in > emailrelay-deliver.sh

29
bin/Makefile.in
View File

@ -253,6 +253,7 @@ e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
e_sysconfdir = @e_sysconfdir@
e_systemddir = @e_systemddir@
exec_prefix = @exec_prefix@
host_alias = @host_alias@
htmldir = @htmldir@
@ -279,8 +280,9 @@ target_alias = @target_alias@
top_build_prefix = @top_build_prefix@
top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
example_scripts = \
example_scripts_static = \
emailrelay-bcc-check.pl \
emailrelay-ldap-verify.py \
emailrelay-multicast.sh \
emailrelay-rot13.pl \
emailrelay-sendmail.pl \
@ -291,8 +293,7 @@ example_scripts_in = \
emailrelay-deliver.sh.in \
emailrelay-notify.sh.in \
emailrelay-resubmit.sh.in \
emailrelay-submit.sh.in \
emailrelay.sh.in
emailrelay-submit.sh.in
example_scripts_out = \
emailrelay-deliver.sh \
@ -301,13 +302,22 @@ example_scripts_out = \
emailrelay-submit.sh \
emailrelay
init_scripts = \
init_script_in = \
emailrelay.sh.in
init_script_out = \
emailrelay
work_scripts = \
doxygen.sh \
make-manifest.sh \
make-setup.sh
make-setup.sh \
make-format \
make2cmake \
make2cdb \
AutoMakeParser.pm \
CompilationDatabase.pm \
winbuild.pm
js_scripts = \
emailrelay-edit-content.js \
@ -316,8 +326,9 @@ js_scripts = \
emailrelay-service-install.js
EXTRA_DIST = \
$(example_scripts) \
$(example_scripts_static) \
$(example_scripts_in) \
$(init_script_in) \
$(work_scripts) \
$(js_scripts)
@ -326,18 +337,18 @@ noinst_SCRIPTS = \
$(js_scripts)
e_examples_DATA = \
$(example_scripts)
$(example_scripts_static)
e_examples_SCRIPTS = \
$(example_scripts_out)
e_init_SCRIPTS = \
$(init_scripts)
$(init_script_out)
CLEANFILES = \
$(example_scripts_out)
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIBEXEC_DIR__%${e_libexecdir}%g" -e "s%__RUNDIR__%${e_rundir}%g"
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIBEXEC_DIR__%${e_libexecdir}%g" -e "s%__RUN_DIR__%${e_rundir}%g"
all: all-am
.SUFFIXES:

8
bin/doxygen.sh
View File

@ -1,17 +1,17 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===

20
bin/emailrelay-bcc-check.pl
View File

@ -1,19 +1,11 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-bcc-check.pl

20
bin/emailrelay-deliver.sh.in
View File

@ -1,19 +1,11 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-deliver.sh

20
bin/emailrelay-edit-content.js
View File

@ -1,18 +1,10 @@
//
// Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright
// notice and this notice are preserved. This file is offered as-is,
// without any warranty.
// ===
//
// emailrelay-edit-content.js

20
bin/emailrelay-edit-envelope.js
View File

@ -1,18 +1,10 @@
//
// Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright
// notice and this notice are preserved. This file is offered as-is,
// without any warranty.
// ===
//
// emailrelay-edit-envelope.js

87
bin/emailrelay-ldap-verify.py Executable file
View File

@ -0,0 +1,87 @@
#!/usr/bin/env python3
#
# Copyright (C) 2020-2021 <richardwvm@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-ldap-verify.py
#
# Example address verifier script using LDAP.
#
import sys
import ldap
try:
Arg1 = sys.argv[1]
except:
print("error")
print("Usage: emailrelay-ldap-verify.py [--emailrelay-version | <email-address>]")
sys.exit(3)
if Arg1 == "--emailrelay-version":
print("2.0")
sys.exit(0)
AtChar = Arg1.find("@")
if AtChar == -1:
print("invalid mailbox")
print("malformed e-mail address (no at sign)")
sys.exit(2)
LocalDomain = "@domain.co.uk"
if Arg1[AtChar:] != LocalDomain:
print("invalid mailbox")
print("invalid mailbox: %s" % Arg1)
sys.exit(2)
LDAPSServer = "ldaps-server.domain.com"
LDAPSPort = "636"
LDAPSUsername = "DOMAIN\\username"
LDAPSPassword = "password"
UserSearchPath = "CN=Users,DC=domain,DC=com"
PublicFolderSearchPath = "CN=Microsoft Exchange System Objects,DC=domain,DC=com"
ErrorLevel = 1
try:
connect = ldap.initialize("ldaps://" + LDAPSServer + ":" + LDAPSPort)
connect.set_option(ldap.OPT_NETWORK_TIMEOUT, 3)
connect.set_option(ldap.OPT_REFERRALS, 0)
connect.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
connect.set_option(ldap.OPT_X_TLS_NEWCTX, 0)
connect.simple_bind_s(LDAPSUsername, LDAPSPassword)
result = connect.search_s(UserSearchPath,
ldap.SCOPE_SUBTREE,
"(&(objectCategory=person)(objectclass=user)(!(userAccountControl:1.2.840.113556.1.4.803:=2))(proxyAddresses=SMTP:%s))" % (sys.argv[1]),
["mail"])
if len(result) != 1:
result = connect.search_s(PublicFolderSearchPath,
ldap.SCOPE_SUBTREE,
"(&(objectclass=publicFolder)(proxyAddresses=SMTP:%s))" % (sys.argv[1]),
["mail"])
if len(result) != 1:
print("invalid mailbox")
print("invalid mailbox: %s" % (sys.argv[1]))
ErrorLevel = 2
else:
print()
print(sys.argv[1])
else:
print()
print(sys.argv[1])
except ldap.LDAPError as e:
print("temporary error")
print("ldap error: %s" % str(e))
ErrorLevel = 3
except:
print("temporary error")
print("exception")
ErrorLevel = 3
sys.exit(ErrorLevel)

20
bin/emailrelay-multicast.sh
View File

@ -1,19 +1,11 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-multicast.sh

20
bin/emailrelay-notify.sh.in
View File

@ -1,19 +1,11 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-notify.sh

20
bin/emailrelay-resubmit.js
View File

@ -1,18 +1,10 @@
//
// Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright
// notice and this notice are preserved. This file is offered as-is,
// without any warranty.
// ===
//
// emailrelay-resubmit.js

20
bin/emailrelay-resubmit.sh.in
View File

@ -1,19 +1,11 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-resubmit.sh

20
bin/emailrelay-rot13.pl
View File

@ -1,19 +1,11 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-rot13.pl

27
bin/emailrelay-sendmail.pl
View File

@ -1,19 +1,11 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-sendmail.pl
@ -21,14 +13,17 @@
# A sendmail/emailrelay shim. Typically installed as /usr/sbin/sendmail or
# /usr/lib/sendmail.
#
use strict ;
use Getopt::Std ;
my $usage = "usage: emailrelay-sendmail [-intUv] [-BbCdFhNOopqRrVX <arg>] [-f <from>]" ;
# parse and mostly ignore sendmail command-line options
my $usage = "usage: emailrelay-sendmail [-intUv] [-BbCdFhNOopqRrVX <arg>] [-f <from>] <to> [<to> ...]" ;
my %opt = () ;
getopts( 'B:b:C:d:F:f:h:iN:nO:o:p:q:R:r:tUV:vX:' , \%opt ) or die "$usage\n" ;
# submit into the emailrelay spool directory
my $from = defined($opt{f}) ? $opt{f} : $ENV{USER} ;
my @args = ( "-f" , $from ) ;
my $exe = "/usr/sbin/emailrelay-submit" ;
my @args = ( $exe , "-f" , $from , @ARGV ) ; # also consider using "--copy" and "--content-date"
exec { $exe } @args ;

56
bin/emailrelay-service-install.js
View File

@ -1,16 +1,16 @@
//
// Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// ===
@ -20,24 +20,34 @@
// Runs "emailrelay-service --install" and then opens the Windows service
// control panel.
//
// Note that the installation process creates a config file
// "emailrelay-service.cfg" in the same directory as the service wrapper
// and this points to the directory containing the startup batch file.
//
try
{
var title = "E-MailRelay Service Install" ;
var shell = WScript.CreateObject( "WScript.Shell" ) ;
var fs = WScript.CreateObject( "Scripting.FileSystemObject" ) ;
var this_dir = fs.GetParentFolderName(WScript.ScriptFullName) ;
var this_dir = fs.GetParentFolderName( WScript.ScriptFullName ) ;
// find the installation program's configuration file
var config_file_1 = this_dir + "\\emailrelay-service.cfg" ;
var config_file_2 = fs.GetParentFolderName(this_dir) + "\\emailrelay-service.cfg" ;
// find the installation program's configuration file in "." or ".."
var config_filename = "emailrelay-service.cfg" ;
var config_file_1 = this_dir + "\\" + config_filename ;
var config_file_2 = fs.GetParentFolderName(this_dir) + "\\" + config_filename ;
var config_file = fs.FileExists(config_file_1) ? config_file_1 : config_file_2 ;
if( !fs.FileExists(config_file) )
throw "No installation config file [" + config_file_1 + "] or [" + config_file_2 + "]" ;
var dir_install = fs.GetParentFolderName( config_file ) ;
var config_file_exists = fs.FileExists(config_file) ;
// require this script to be run after installation, otherwise the
// service will be pointing at an ephemeral executable and a bogus
// startup batch file
if( !config_file_exists )
throw "No service configuration file found [" + config_filename + "]. Please run after successful E-MailRelay installation." ;
// read and parse the config file
var dir_config = "" ;
if( config_file_exists )
{
var f = fs.OpenTextFile( config_file ) ;
var config_text = f.ReadAll() ;
@ -50,9 +60,16 @@ try
dir_config = RegExp.lastParen ;
dir_config.match( re_dequote ) ;
dir_config = RegExp.lastParen ;
if( !dir_config )
throw "Cannot parse the config file [" + config_file + "]" ;
}
if( !dir_config )
throw "Cannot parse the config file [" + config_file + "]" ;
// the dir-config value should normally be an absolute path, but
// the service wrapper also allows for a special value of "@app"
// meaning the service-wrapper's directory, so expand it here
if( dir_config === "@app" )
dir_config = this_dir ;
// check for the startup batch file containing the server configuration
var startup_batch_file = dir_config + "\\emailrelay-start.bat" ;
@ -60,11 +77,12 @@ try
throw "No startup batch file [" + startup_batch_file + "]" ;
// check for the service wrapper
var dir_install = fs.GetParentFolderName( config_file ) ;
var service_wrapper = dir_install + "\\emailrelay-service.exe" ;
if( !fs.FileExists(startup_batch_file) )
throw "No service wrapper [" + service_wrapper + "]" ;
var ok = shell.Popup( "About to run [" + service_wrapper + " --install]" , 0 , title , 1 ) ;
var ok = shell.Popup( "About to run [" + service_wrapper + " --install] ..." , 0 , title , 1 ) ;
if( ok === 1 )
{
// do the service wrapper installation
@ -79,10 +97,12 @@ try
var stdout_text = exec.StdOut.ReadAll() ;
var stderr_text = exec.StdErr.ReadAll() ;
var success = !stderr_text && ( exec.ExitCode === 0 ) ;
var text = (success?"Service installed":"Service installation failed") + ": " +
"exit " + exec.ExitCode + "\n" +
stdout_text + "\n" +
stderr_text ;
var text = "Service installed" ;
if( !success )
{
text = "Service installation failed: exit " + exec.ExitCode + "\n" +
stdout_text + "\n" + stderr_text ;
}
var topmost = 262144 ;
var foreground = 65536 ;
var icon_info = 0 ;

22
bin/emailrelay-set-from.js
View File

@ -1,18 +1,10 @@
//
// Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright
// notice and this notice are preserved. This file is offered as-is,
// without any warranty.
// ===
//
// emailrelay-set-from.js
@ -20,7 +12,7 @@
// An example "--filter" script that edits the content originator fields
// (ie. From, Sender and Reply-To) to a fixed value.
//
// See also: RFC-2822
// See also: emailrelay-set-from.pl, RFC-2822
//
try
{

22
bin/emailrelay-set-from.pl
View File

@ -1,19 +1,11 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-set-from.pl
@ -21,7 +13,7 @@
# An example E-MailRelay "--filter" script that edits the content originator
# fields (ie. From, Sender and Reply-To) to a fixed value.
#
# See also: RFC-2822
# See also: emailrelay-set-from.js, RFC-2822
#
use strict ;

20
bin/emailrelay-submit.sh.in
View File

@ -1,19 +1,11 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-submit.sh

25
bin/emailrelay.sh.in
View File

@ -1,17 +1,17 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
@ -38,10 +38,11 @@ PATH=/sbin:/bin:/usr/sbin:/usr/bin
NAME=emailrelay
DESC="E-MailRelay mail server"
CONFIG=__SYSCONF_DIR__/$NAME.conf
PIDFILE=__RUNDIR__/$NAME.pid
PIDFILE=__RUN_DIR__/$NAME.pid
GROUP=daemon
DAEMON=__SBIN_DIR__/$NAME
SUBMIT=__SBIN_DIR__/$NAME-submit
FACILITY=mail
test -f __SYSCONF_DIR__/default/$NAME && . __SYSCONF_DIR__/default/$NAME
test -f /etc/rc.conf.d/$NAME && . /etc/rc.conf.d/$NAME
@ -124,7 +125,7 @@ root_root()
# True if the given file exists and is owned by 'root.root',
# as if newly copied by the install process and never
# subsequently chown'ed by the administrator
ls -nd "$1" 2>/dev/null | cut -d' ' --fields=3,4 | grep -q '^0 0$'
ls -nd "$1" 2>/dev/null | cut -d' ' -f 3,4 | grep -q '^0 0$'
}
spooldir()
{
@ -180,12 +181,17 @@ setup_tools()
setup_sgid "__SBIN_DIR__/emailrelay-submit"
setup_sgid "__LIBEXEC_DIR__/emailrelay-filter-copy"
}
setup_openrc()
{
rc-update -q -q add "$NAME" >/dev/null 2>&1 || true
}
setup()
{
setup_config
setup_rundir
setup_spooldir
setup_tools
setup_openrc
}
if test "$1" = "setup" ; then setup ; exit 0 ; fi
@ -226,9 +232,10 @@ case "$1" in
log_daemon_msg "Starting $DESC"
log_progress_msg "$NAME"
setup_rundir
start_daemon -p "$PIDFILE" -- "$DAEMON" --as-server --syslog --pid-file "$PIDFILE" "$CONFIG"
start_daemon -p "$PIDFILE" -- "$DAEMON" --as-server --syslog=$FACILITY --pid-file "$PIDFILE" "$CONFIG"
e="$?"
log_end_msg $e
if test -d /run/systemd/system ; then sleep 0.2 2>/dev/null ; fi # pid file race
test "$e" -eq 0
else
log_warning_msg "$NAME startup is disabled in __SYSCONF_DIR__/default/$NAME"
@ -240,7 +247,9 @@ case "$1" in
log_daemon_msg "Stopping $DESC"
log_progress_msg "$NAME"
killproc -p "$PIDFILE" "$DAEMON"
log_end_msg $?
e="$?"
log_end_msg $e
test "$e" -eq 0
;;
reload)

221
bin/make-format Executable file
View File

@ -0,0 +1,221 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# make-format
#
# Runs clang-format with some post-processing to get close to the preferred
# style.
#
# usage: make-format [options] { [--list] -d <dir> | <file> [<file> ...] }
#
use strict ;
use FileHandle ;
use File::Find ;
use File::Copy ;
use Data::Dumper ;
use Getopt::Long ;
# configure
my $cfg_formatter = "clang-format" ;
my $cfg_tab = 4 ; # in .clang-format
my @cfg_stop = qw(
/gdef\.h$
/gconfig_defs\.h$
/moc_
/mbedtls/
) ;
# parse the command-line
my %opt = () ;
GetOptions( \%opt ,
"quiet|q" ,
"verbose|v" ,
"formatter|f=s" , # clang-format
"nofixup" , # no post-processing
"noformat|n" , # no clang-format
"nobackup|x" ,
"list" , # list files, with -d
"d=s" , # base directory for --list
) or die ;
$cfg_formatter = $opt{formatter} if $opt{formatter} ;
my @files = @ARGV ;
die "usage error\n" if ( $opt{list} && !$opt{d} ) ;
# deal with "--list -d ..."
if( $opt{list} && $opt{d} )
{
my @files = find_files( $opt{d} , \@cfg_stop ) ;
print join( "\n" , (@files,"") ) ;
exit 0 ;
}
# sanity checks
if( !$opt{noformat} )
{
chomp( my $version = `$cfg_formatter --version` ) ;
my ($v1,$v2) = ( $version =~ m/(\d+)\.(\d+)/ ) ;
die "make-format: error: cannot run [$cfg_formatter --version]\n"
if ( !$v1 && !$v2 ) ;
die "make-format: error: $cfg_formatter is too old [$v1.$v2]\n"
if ( $v1 < 3 || ( $v1 == 3 && $v2 < 10 ) ) ;
die "make-format: error: no .clang-format file in cwd\n"
if ! -e ".clang-format" ;
}
# check for future command-line options
my $formatter_options = "" ;
{
my $fh = new FileHandle( "$cfg_formatter --help |" ) ;
while(<$fh>)
{
chomp( my $line = $_ ) ;
if( $line =~ m/sort.includes/ ) # new in v11
{
$formatter_options = "--sort-includes=false" ;
}
}
}
# build the "-d" file list
if( $opt{d} )
{
@files = find_files( $opt{d} , \@cfg_stop , $opt{verbose} ) ;
}
# format each file
for my $fname ( @files )
{
my $cmd = "$cfg_formatter $formatter_options --style=file -i $fname" ;
print "make-format: [$fname]\n" unless $opt{quiet} ;
# make a backup
if( !$opt{nobackup} )
{
my $t = time() ;
File::Copy::copy( $fname , "$fname.$t.bak" ) or
die "make-format: error: cannot create a backup for [$fname]\n" ;
}
# run clang-format
if( !$opt{noformat} )
{
my $rc = system( $cmd ) ;
if( $rc )
{
die "make-format: error: failed to run clang-format on [$fname]\n $cmd\n" ;
}
}
# fix things that clang-format has messed up
if( !$opt{nofixup} )
{
fixup( $fname ) ;
}
}
sub fixup
{
my ( $fname ) = @_ ;
my $fh_in = new FileHandle( $fname ) or die ;
my $fh_out = new FileHandle( "$fname.new" , "w" ) or die ;
my $old_indent ;
my $bad_indent ;
while(<$fh_in>)
{
chomp( my $line = $_ ) ;
if( $line =~ m:^// clang-format off: )
{
$fh_out->close() ;
unlink( "$fname.new" ) ;
return ;
}
# clang-format tries to align with tabs followed by spaces --
# here we make sure that only tabs are used for indenting, with
# the indenting level increasing by no more than one tab on
# consecutive lines
my ( $indent ) = ( $line =~ m/^(\s*)/ ) ;
if( $line eq "" )
{
$old_indent = undef ;
$bad_indent = undef ;
}
elsif( defined($old_indent) && sizeof($indent) > (sizeof($old_indent)+$cfg_tab) )
{
$bad_indent = $indent ;
$line =~ s/^\s*/$old_indent\t/ ;
}
elsif( $indent =~ m/\t / )
{
$bad_indent = $indent ;
$line =~ s/^\s*/$old_indent\t/ ;
}
elsif( defined($bad_indent) && sizeof($indent) == sizeof($bad_indent) )
{
$line =~ s/^\s*/$old_indent\t/ ;
}
else
{
$old_indent = $indent ;
$bad_indent = undef ;
}
# add some more whitespace
$line =~ s:(\S);$:\1 ;: ;
$line =~ s:(\S); //(.*):\1 ; //\2: ;
$line =~ s:(\S),:\1 ,:g unless ( $line =~ m/["']/ or $line =~ m://.*,: ) ;
print $fh_out $line , "\n" or die ;
}
$fh_in->close() ;
$fh_out->close() or die ;
rename( "$fname.new" , $fname ) or die ;
}
sub sizeof
{
my ( $s ) = @_ ;
my $spaces = ' ' x $cfg_tab ;
$s =~ s/\t/$spaces/g ;
return length($s) ;
}
sub find_files
{
my ( $base , $stoplist , $verbose ) = @_ ;
my @files = () ;
my @stopped = () ;
my $callback = sub {
my $filename = $_ ;
my $path = $File::Find::name ;
return if( -d $path ) ;
if( $filename =~ m/\.cpp$|\.h$/ )
{
my $stop = 0 ;
map { my $re = $_ ; $stop = 1 if $path =~ m/$re/ } @$stoplist ;
$path =~ s:^\./:: ;
push @files , $path unless $stop ;
push @stopped , $path if $stop ;
}
} ;
File::Find::find( $callback , $base ) ;
map { print "ignoring [$_]\n" } @stopped if $verbose ;
return @files ;
}

8
bin/make-manifest.sh
View File

@ -1,17 +1,17 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===

8
bin/make-setup.sh
View File

@ -1,17 +1,17 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===

115
bin/make2cdb Executable file
View File

@ -0,0 +1,115 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# make2cdb
#
# Parses automake files throughout the source tree and generates
# a "compilation database" file, "compile_commands.json".
#
# See also: https://clang.llvm.org/docs/JSONCompilationDatabase.html
#
# Usage: make2cdb [--list] [<src-dir> [<top-dir> [<src-to-top>]]]
#
# Eg:
# $ cd src
# $ ../bin/make2cdb > compile_commands.json
# $ ../bin/make2cdb --list | xargs clang-tidy -p .
#
use strict ;
use Cwd ;
use FileHandle ;
use File::Find ;
use File::Basename ;
use File::Spec ;
use File::Copy ;
use lib dirname($0) ;
use CompilationDatabase ;
$CompilationDatabase::debug = 0 ;
my $show_list = $ARGV[0] eq "--list" ;
shift @ARGV if $show_list ;
my $src_dir = @ARGV ? $ARGV[0] : dirname($0)."/../src" ;
my $top_dir = @ARGV >= 1 ? $ARGV[1] : "$src_dir/.." ;
my $src_to_top = @ARGV >= 2 ? $ARGV[2] : ".." ;
my @dflags = (
"-DG_UNIX=1" ,
) ;
# makefile conditionals
my %switches = (
GCONFIG_BSD => 0 ,
GCONFIG_GUI => 0 ,
GCONFIG_ICONV => 0 ,
GCONFIG_INSTALL_HOOK => 0 ,
GCONFIG_INTERFACE_NAMES => 1 ,
GCONFIG_MAC => 0 ,
GCONFIG_PAM => 0 ,
GCONFIG_TESTING => 0 ,
GCONFIG_TLS_USE_BOTH => 0 ,
GCONFIG_TLS_USE_MBEDTLS => 0 ,
GCONFIG_TLS_USE_NONE => 0 ,
GCONFIG_TLS_USE_OPENSSL => 1 ,
GCONFIG_WINDOWS => 0 ,
) ;
# makefile expansion variables -- many are required but not relevant
my %vars = (
top_srcdir => $src_to_top ,
top_builddir => "." ,
sbindir => "." ,
mandir => "." ,
localedir => "." ,
e_spooldir => "/var/spool/emailrelay" ,
e_docdir => "." ,
e_initdir => "." ,
e_bsdinitdir => "." ,
e_rundir => "." ,
e_icondir => "." ,
e_examplesdir => "." ,
e_libexecdir => "." ,
e_pamdir => "." ,
e_sysconfdir => "/etc" ,
GCONFIG_WINDRES => "" ,
GCONFIG_WINDMC => "" ,
GCONFIG_QT_LIBS => "" ,
GCONFIG_QT_CFLAGS => "" ,
GCONFIG_QT_MOC => "" ,
GCONFIG_TLS_LIBS => "" ,
GCONFIG_STATIC_START => "" ,
GCONFIG_STATIC_END => "" ,
RPM_ARCH => "x86" ,
RPM_ROOT => "rpm" ,
) ;
my $cdb = new CompilationDatabase( $src_dir , ["-DG_UNIX=1"], ["-I$src_to_top"] , ["-std=c++11","-pthread"] , \%switches , \%vars ) ;
$cdb->{m_full_paths} = 1 ; # grr
if( $show_list )
{
print join( "\n" , $cdb->list() , "" ) ;
}
else
{
print "[\n" ;
print join( ",\n" , $cdb->stanzas() ) ;
print "]\n" ;
}

187
bin/make2cmake Executable file
View File

@ -0,0 +1,187 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# make2cmake
#
# Parses automake files throughout the source tree and generates
# simplistic cmake files for a unix build.
#
# Eg:
# $ ./make2cmake
# $ mkdir build
# $ cd build
# $ cmake -DCMAKE_MAKE_PROGRAM:FILEPATH=/usr/bin/make ..
# $ make VERBOSE=1
#
# See also: winbuild.pl
#
use strict ;
use Cwd ;
use FileHandle ;
use File::Find ;
use File::Basename ;
use File::Spec ;
use File::Copy ;
use lib dirname($0) ;
use AutoMakeParser ;
$AutoMakeParser::debug = 0 ;
# makefile conditionals
my %switches = (
GCONFIG_BSD => 0 ,
GCONFIG_GUI => 0 ,
GCONFIG_ICONV => 0 ,
GCONFIG_INSTALL_HOOK => 0 ,
GCONFIG_INTERFACE_NAMES => 1 ,
GCONFIG_MAC => 0 ,
GCONFIG_PAM => 0 ,
GCONFIG_TESTING => 0 ,
GCONFIG_TLS_USE_BOTH => 0 ,
GCONFIG_TLS_USE_MBEDTLS => 0 ,
GCONFIG_TLS_USE_NONE => 0 ,
GCONFIG_TLS_USE_OPENSSL => 1 ,
GCONFIG_WINDOWS => 0 ,
) ;
# makefile expansion variables -- many are required but not relevant
my %vars = (
top_srcdir => "." ,
top_builddir => "." ,
sbindir => "." ,
mandir => "." ,
localedir => "." ,
e_spooldir => "/var/spool/emailrelay" ,
e_docdir => "." ,
e_initdir => "." ,
e_bsdinitdir => "." ,
e_rundir => "." ,
e_icondir => "." ,
e_examplesdir => "." ,
e_libexecdir => "." ,
e_pamdir => "." ,
e_sysconfdir => "/etc" ,
GCONFIG_WINDRES => "" ,
GCONFIG_WINDMC => "" ,
GCONFIG_QT_LIBS => "" ,
GCONFIG_QT_CFLAGS => "" ,
GCONFIG_QT_MOC => "" ,
GCONFIG_TLS_LIBS => "-lssl -lcrypto" ,
GCONFIG_STATIC_START => "" ,
GCONFIG_STATIC_END => "" ,
RPM_ARCH => "x86" ,
RPM_ROOT => "rpm" ,
VERSION => FileHandle->new("VERSION")->gets() ,
) ;
run_generate( "emailrelay" , \%switches , \%vars ) ;
# ==
sub create_cmake_file
{
my ( $project , $m , $switches ) = @_ ;
my $path = join( "/" , dirname($m->path()) , "CMakeLists.txt" ) ;
print "cmake-file=[$path]\n" ;
my $fh = new FileHandle( $path , "w" ) or die ;
my $compile_options = "-std=c++11 -pthread" ;
my $link_options = "-pthread" ;
print $fh "# $path -- generated by $0\n" ;
if( $project )
{
print $fh "cmake_minimum_required(VERSION 2.8.11)\n" ;
print $fh "project($project)\n" ;
print $fh "add_compile_options($compile_options)\n" ;
}
print $fh "\n" ;
for my $subdir ( $m->subdirs() )
{
print $fh "add_subdirectory($subdir)\n" ;
}
my $definitions = join( " " , "G_UNIX=1" , $m->definitions() ) ;
my $includes = join( " " , "." , ".." , $m->includes($m->top()) ) ;
my @libraries = $m->libraries() ;
for my $library ( @libraries )
{
my $sources = join( " " , $m->sources( $library ) ) ;
( my $library_key = $library ) =~ s/\.a$// ; $library_key =~ s/^lib// ;
print $fh "\n" ;
print $fh "add_library($library_key $sources)\n" ;
print $fh "target_include_directories($library_key PUBLIC $includes)\n" ;
print $fh "target_compile_definitions($library_key PUBLIC $definitions)\n" ;
}
my @programs = $m->programs() ;
for my $program ( @programs )
{
my $sources = join( " " , $m->sources( $program ) ) ;
my $our_libs = join( " " , $m->our_libs( $program ) ) ;
my $sys_libs = join( " " , $m->sys_libs( $program ) ) ;
my $program_sources = join(" ",split(' ',"$sources")) ;
my $program_includes = join(" ",split(' ',"$includes")) ;
my $program_libs = join(" ",split(' ',"$our_libs $sys_libs")) ;
print $fh "\n" ;
print $fh "add_executable($program $program_sources)\n" ;
print $fh "target_include_directories($program PUBLIC $program_includes)\n" ;
print $fh "target_compile_definitions($program PUBLIC $definitions)\n" ;
print $fh "target_link_libraries($program $link_options $program_libs)\n" ;
}
$fh->close() or die ;
}
sub create_cmake_files
{
my ( $project , $switches , $vars ) = @_ ;
my @makefiles = AutoMakeParser::readall( "." , $switches , $vars , 1 ) ;
my $first = 1 ;
for my $m ( @makefiles )
{
create_cmake_file( $first?$project:undef , $m , $switches ) ;
$first = 0 ;
}
}
sub run_generate
{
my ( $project , $switches , $vars ) = @_ ;
create_cmake_files( $project , $switches , $vars ) ;
create_gconfig_header() ;
}
sub create_gconfig_header
{
my $path = "src/gconfig_defs.h" ;
if( ! -f $path )
{
my $fh = new FileHandle( $path , "w" ) or die ;
$fh->close() or die ;
}
}

443
bin/winbuild.pm Normal file
View File

@ -0,0 +1,443 @@
#!/usr/bin/perl
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# winbuild.pm
#
# Helper functions for winbuild.pl.
#
# Synopsis:
#
# require "winbuild.pm" ;
# winbuild::default_touchfile(...) ;
# winbuild::find_cmake(...) ;
# winbuild::find_msbuild(...) ;
# winbuild::find_qt(...) ;
# winbuild::find_mbedtls(...) ;
# winbuild::find_runtime(...) ;
# winbuild::spit_out_batch_files(...) ;
# winbuild::clean_cmake_files(...) ;
# winbuild::clean_cmake_cache_files(...) ;
# winbuild::deltree(...) ;
# winbuild::run_msbuild(...) ;
# winbuild::create_touchfile(...) ;
# winbuild::read_makefiles(...) ;
# winbuild::read_makefiles_imp(...) ;
# winbuild::cache_value(...) ;
# winbuild::find_msvc_base(...) ;
# winbuild::fixup(...) ;
# winbuild::touch(...) ;
# winbuild::file_copy(...) ;
#
use strict ;
use Cwd ;
use Carp ;
use FileHandle ;
use File::Basename ;
use File::Find ;
use File::Path ;
use File::Glob ':bsd_glob' ;
use lib dirname($0) , dirname($0)."/bin" ;
use AutoMakeParser ;
$AutoMakeParser::debug = 0 ;
package winbuild ;
sub find_cmake
{
return _fcache( "cmake" ,
_find_bypass( "cmake" ) ||
_find_basic( "find-cmake" , "cmake.exe" , _path_dirs() ) ||
_find_match( "find-cmake" , "cmake*/bin/cmake.exe" , undef ,
"$ENV{SystemDrive}" ,
"$ENV{ProgramFiles}" ) ) ;
}
sub find_msbuild
{
return _fcache( "msbuild" ,
_find_bypass( "msbuild" ) ||
_find_basic( "find-msbuild" , "msbuild.exe" , _path_dirs() ) ||
_find_under( "find-msbuild" , "msbuild.exe" ,
$ENV{'ProgramFiles(x86)'}."/msbuild" ,
$ENV{'ProgramFiles(x86)'}."/Microsoft Visual Studio" ,
$ENV{'ProgramFiles(x86)'} ,
$ENV{ProgramFiles} ) ) ;
}
sub find_qt
{
my @dirs = (
File::Basename::dirname($0)."/.." ,
"$ENV{HOMEDRIVE}$ENV{HOMEPATH}/qt" ,
"$ENV{SystemDrive}/qt" ,
) ;
my $x86 =
_find_bypass( "qt" , "x86" ) ||
_find_match( "find-qt(x86)" , "5*/msvc*/lib/cmake/qt5" , qr;/msvc\d\d\d\d/; , @dirs ) ;
my $x64 =
_find_bypass( "qt" , "x64" ) ||
_find_match( "find-qt(x64)" , "5*/msvc*_64/lib/cmake/qt5" , undef , @dirs ) ;
_fcache( "qt-x86" , $x86 ) ;
_fcache( "qt-x64" , $x64 ) ;
return { x86 => $x86 , x64 => $x64 } ;
}
sub find_mbedtls
{
return _fcache( "mbedtls" ,
_find_bypass( "mbedtls" ) ||
_find_match( "find-mbedtls" , "mbedtls*" , undef ,
File::Basename::dirname($0)."/.." ,
"$ENV{HOMEDRIVE}$ENV{HOMEPATH}" ,
"$ENV{SystemDrive}" ) ) ;
}
sub find_runtime
{
my ( $msvc_base , $arch , @names ) = @_ ;
my $search_base = "$msvc_base/redist" ;
my %runtime = () ;
for my $name ( @names )
{
my @paths = grep { m:/$arch/:i } _find_all_under( $name , $search_base ) ;
if( @paths )
{
# pick the shortest, as a heuristic
my @p = sort { length($a) <=> length($b) } @paths ;
my $path = $p[0] ;
print "runtime: [$name] for [$arch] is [$path]\n" ;
$runtime{$name} = { path => $path , name => $name } ;
}
else
{
print "runtime: [$name] not found under [$search_base]\n" ;
}
}
return \%runtime ;
}
sub default_touchfile
{
my ( $script ) = @_ ;
$script =~ s/\.pl$// ;
return "$script.ok" ;
}
sub _path_dirs
{
return split( ";" , $ENV{PATH} ) ;
}
sub _sanepath
{
my ( $path ) = @_ ;
$path =~ s:\\:/:g ;
return $path ;
}
sub _find_basic
{
my ( $logname , $fname , @dirs ) = @_ ;
my $result ;
for my $dir ( map {_sanepath($_)} @dirs )
{
my $path = "$dir/$fname" ;
if( -e $path ) { $result = Cwd::realpath($path) ; last }
print "$logname: not $path\n" ;
}
print "$logname=[$result]\n" if $result ;
return $result ;
}
sub _find_under
{
my ( $logname , $fname , @dirs ) = @_ ;
my $result ;
for my $dir ( map {_sanepath($_)} @dirs )
{
my @find_list = () ;
File::Find::find( sub { push @find_list , $File::Find::name if lc($_) eq $fname } , $dir ) ;
if( @find_list ) { $result = Cwd::realpath($find_list[0]) ; last }
print "$logname: not under $dir\n" ;
}
print "$logname=[$result]\n" if $result ;
return $result ;
}
sub _find_all_under
{
my ( $fname , $dir ) = @_ ;
my @result = () ;
File::Find::find( sub { push @result , $File::Find::name if lc($_) eq $fname } , $dir ) ;
return @result ;
}
my %fcache = () ;
sub _fcache
{
my ( $key , $value ) = @_ ;
$fcache{$key} = $value ;
return $value ;
}
sub fcache_delete
{
my $path = join( "/" , File::Basename::dirname(Cwd::realpath($0)) , "winbuild.cfg" ) ;
rename( "$path" , "${path}.old" ) ;
unlink( $path ) ;
}
sub fcache_write
{
my $path = join( "/" , File::Basename::dirname(Cwd::realpath($0)) , "winbuild.cfg" ) ;
my $fh = new FileHandle( $path , "w" ) or die "error: install: cannot create [$path]\n" ;
for my $k ( sort keys %fcache )
{
print $fh "$k $fcache{$k}\n" ;
}
$fh->close() or die ;
}
sub _find_bypass
{
my ( $name , $arch ) = @_ ;
# winbuild.cfg
# eg.
# cmake c:/cmake/bin/cmake.exe
# mbedtls c:/mbedtls-2.99
# msbuild c:/msbuild/msbuild.exe
# qt-x64 c:/qt/5.0/msvc_64/lib/cmake/Qt5
# qt-x86 c:/qt/5.0/msvc/lib/cmake/Qt5
my $fh = new FileHandle( "winbuild.cfg" , "r" ) ;
return undef if !$fh ;
my $key = $arch ? "$name-$arch" : $name ;
while(<$fh>)
{
chomp( my $line = $_ ) ;
my ( $k , $v ) = ( $line =~ m/(\S+)\s+(.*)/ ) ;
return $v if( $k eq $key ) ;
}
return undef ;
}
sub _find_match
{
my ( $logname , $glob , $re , @dirs ) = @_ ;
$re = qr;.; if !defined($re) ;
my $result ;
for my $dir ( map {_sanepath($_)} @dirs )
{
my @glob_match = () ;
push @glob_match , grep { -e $_ && $_ =~ m/$re/ } File::Glob::bsd_glob( "$dir/$glob" ) ;
if( @glob_match ) { $result = Cwd::realpath($glob_match[0]) ; last }
print "$logname: no match for $dir/$glob\n" ;
}
print "$logname=[$result]\n" if $result ;
return $result ;
}
sub spit_out_batch_files
{
my ( @parts ) = @_ ;
for my $part ( @parts )
{
my $fname = "winbuild-$part.bat" ;
if( ! -f $fname )
{
my $fh = new FileHandle( $fname , "w" ) or next ;
print $fh "runperl winbuild.pl winbuild.ok $part\n" ;
$fh->close() ;
}
}
}
sub clean_cmake_files
{
my ( $base_dir ) = @_ ;
$base_dir ||= "." ;
my @list = () ;
File::Find::find( sub { push @list , $File::Find::name if $_ eq "CMakeLists.txt" } , $base_dir ) ;
unlink @list ;
}
sub clean_cmake_cache_files
{
my ( $base_dir , $opt ) = @_ ;
my $verbose = $opt->{verbose} || 0 ;
$base_dir ||= "." ;
my @tree_list = () ;
my @file_list = () ;
File::Find::find( sub { push @tree_list , $File::Find::name if $_ eq "CMakeFiles" } , $base_dir ) ;
File::Find::find( sub { push @file_list , $File::Find::name if $_ eq "CMakeCache.txt" } , $base_dir ) ;
map { print "cmake: cleaning [$base_dir/$_]\n" if $verbose } ( @tree_list , @file_list ) ;
map { deltree($_) } @tree_list ;
map { unlink $_ or die } @file_list ;
}
sub deltree
{
my ( $dir ) = @_ ;
my $e ;
File::Path::remove_tree( $dir , {safe=>1,verbose=>0,error=>\$e} ) ;
if( $e && scalar(@$e) )
{
for my $x ( @$e )
{
my ( $f , $m ) = ( %$x ) ;
print "warning: " . ($f?"[$f]: ":"") . $m , "\n" ;
}
}
}
sub run_msbuild
{
my ( $msbuild , $project , $arch , $confname , $target ) = @_ ;
$arch ||= "x64" ;
$confname ||= "Release" ;
my $build_dir = $arch ;
my @msbuild_args = ( "/fileLogger" , "$build_dir/$project.sln" ) ;
push @msbuild_args , "/t:$target" if $target ;
push @msbuild_args , "/p:Configuration=$confname" ;
if( $^O eq "linux" ) { $msbuild = ("make") ; @msbuild_args = ( $target ) }
my $rc = system( $msbuild , @msbuild_args ) ;
print "msbuild-exit=[$rc]\n" ;
die unless $rc == 0 ;
}
sub create_touchfile
{
my ( $touchfile ) = @_ ;
my $fh = new FileHandle( $touchfile , "w" ) or die ;
$fh->close() or die ;
}
sub read_makefiles
{
my ( $switches , $vars ) = @_ ;
return AutoMakeParser::readall( "." , $switches , $vars , 1 ) ;
}
sub cache_value
{
my ( $arch , $re ) = @_ ;
my $fh = new FileHandle( "$arch/CMakeCache.txt" , "r" ) or Carp::confess "error: cannot open cmake cache file\n" ;
my $value ;
while(<$fh>)
{
chomp( my $line = $_ ) ;
my ( $x ) = ( $line =~ m/$re/i ) ;
if( $x )
{
$value = $x ;
last ;
}
}
return $value ;
}
sub find_msvc_base
{
my ( $arch ) = @_ ;
return _find_bypass("msvc") if _find_bypass("msvc") ;
my $msvc_linker = _cache_value_msvc_linker( $arch ) ;
my $dir = File::Basename::dirname( $msvc_linker ) ;
my ( $base ) = ( $dir =~ m:(.*/vc)/.*:i ) ; # could to better
$base or die "error: install: cannot determine the msvc base directory from [$msvc_linker]\n" ;
return _fcache( "msvc" , $base ) ;
}
sub _cache_value_msvc_linker
{
my ( $arch ) = @_ ;
my $msvc_linker = cache_value( $arch , qr/^CMAKE_LINKER:[A-Z]+=(.*)/ ) ;
$msvc_linker or die "error: install: cannot read linker path from CMakeCache.txt\n" ;
return $msvc_linker ;
}
sub fixup
{
my ( $base , $fnames , $fixes ) = @_ ;
for my $fname ( @$fnames )
{
my $fh_in = new FileHandle( "$base/$fname" , "r" ) or die ;
my $fh_out = new FileHandle( "$base/$fname.$$.tmp" , "w" ) or die ;
while(<$fh_in>)
{
my $line = $_ ;
for my $from ( keys %$fixes )
{
my $to = $fixes->{$from} ;
$line =~ s/\Q$from\E/$to/g ;
}
print $fh_out $line ;
}
$fh_in->close() or die ;
$fh_out->close() or die ;
rename( "$base/$fname.$$.tmp" , "$base/$fname" ) or die ;
}
}
sub touch
{
my ( $path ) = @_ ;
if( ! -f $path )
{
my $fh = new FileHandle( $path , "w" ) or die ;
$fh->close() or die ;
}
}
sub file_copy
{
my ( $src , $dst ) = @_ ;
my $to_crlf = undef ;
for my $ext ( "txt" , "js" , "pl" , "pm" )
{
$to_crlf = 1 if( ( ! -d $dst && ( $dst =~ m/$ext$/ ) ) || ( -d $dst && ( $src =~ m/$ext$/ ) ) ) ;
}
if( $to_crlf )
{
if( -d $dst ) { $dst = "$dst/".File::Basename::basename($src) }
my $fh_in = new FileHandle( $src , "r" ) ;
my $fh_out = new FileHandle( $dst , "w" ) ;
( $fh_in && $fh_out ) or die "error: failed to copy [$src] to [$dst]\n" ;
while(<$fh_in>)
{
chomp( my $line = $_ ) ;
print $fh_out $line , "\r\n" ;
}
$fh_out->close() or die "error: failed to copy [$src] to [$dst]\n" ;
}
else
{
File::Copy::copy( $src , $dst ) or die "error: failed to copy [$src] to [$dst]\n" ;
}
}
package main ;
1 ;

8
bsd/Makefile.am
View File

@ -1,16 +1,16 @@
#
## Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
#

1
bsd/Makefile.in
View File

@ -250,6 +250,7 @@ e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
e_sysconfdir = @e_sysconfdir@
e_systemddir = @e_systemddir@
exec_prefix = @exec_prefix@
host_alias = @host_alias@
htmldir = @htmldir@

8
bsd/emailrelay-bsd.sh.in
View File

@ -1,17 +1,17 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===

1986
configure vendored
View File

File diff suppressed because it is too large Load Diff

69
configure.ac
View File

@ -1,15 +1,15 @@
dnl Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
dnl
dnl Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
dnl
dnl This program is free software: you can redistribute it and/or modify
dnl it under the terms of the GNU General Public License as published by
dnl the Free Software Foundation, either version 3 of the License, or
dnl (at your option) any later version.
dnl
dnl
dnl This program is distributed in the hope that it will be useful,
dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
dnl GNU General Public License for more details.
dnl
dnl
dnl You should have received a copy of the GNU General Public License
dnl along with this program. If not, see <http://www.gnu.org/licenses/>.
dnl ===
@ -19,7 +19,7 @@ dnl
dnl Process this file with autoconf to produce a configure script.
dnl
AC_INIT([E-MailRelay],[2.1],[],[emailrelay])
AC_INIT([E-MailRelay],[2.2],[],[emailrelay])
AC_CONFIG_SRCDIR([src/glib/gdef.h])
AC_CONFIG_MACRO_DIR([m4])
AM_INIT_AUTOMAKE([no-define])
@ -31,7 +31,7 @@ dnl check for programs
dnl
AC_PROG_CC([cc gcc clang])
AC_PROG_CXX([c++ g++ clang++])
AX_CXX_COMPILE_STDCXX_11([],[optional])
AX_CXX_COMPILE_STDCXX_11([],[mandatory])
AC_PROG_INSTALL
AC_PROG_RANLIB
AC_PROG_SED
@ -65,44 +65,55 @@ GCONFIG_FN_QT
GCONFIG_FN_TLS_OPENSSL
GCONFIG_FN_TLS_MBEDTLS
dnl initialise aclocal/pkg.m4...
dnl initialise aclocal/pkg.m4
dnl
# if the configure script fails in this area then you are probably missing pkg.m4
PKG_PROG_PKG_CONFIG([0.9.0])
dnl possibly enable full gettext support -- uncomment this after running
dnl 'gettextize' and remove the other gettext lines below
dnl
dnl AM_GNU_GETTEXT([external])
dnl "--enable-whatever"
dnl
AC_ARG_ENABLE([std-thread],AS_HELP_STRING([--enable-std-thread],[use std::thread or not (default auto)]))
GCONFIG_FN_ENABLE_STD_THREAD
AC_ARG_ENABLE([debug],AS_HELP_STRING([--enable-debug],[enable extra debug messages at compile-time (default no)]))
GCONFIG_FN_ENABLE_DEBUG
AC_ARG_ENABLE([ipv6],AS_HELP_STRING([--enable-ipv6],[enable ipv6 (default auto)]))
GCONFIG_FN_ENABLE_IPV6
AC_ARG_ENABLE([gui],AS_HELP_STRING([--enable-gui],[enable configuration gui (requires Qt) (default auto)]))
GCONFIG_FN_ENABLE_GUI
AC_ARG_ENABLE([verbose],AS_HELP_STRING([--enable-verbose],[enable verbose logging (default yes)]))
GCONFIG_FN_ENABLE_VERBOSE
AC_ARG_ENABLE([bsd],AS_HELP_STRING([--enable-bsd],[enable building for bsd (default auto)]))
GCONFIG_FN_ENABLE_BSD
AC_ARG_ENABLE([mac],AS_HELP_STRING([--enable-mac],[enable building for mac os x (default auto)]))
GCONFIG_FN_ENABLE_MAC
AC_ARG_ENABLE([windows],AS_HELP_STRING([--enable-windows],[enable building for windows (default auto)]))
GCONFIG_FN_ENABLE_WINDOWS
AC_ARG_ENABLE([testing],AS_HELP_STRING([--enable-testing],[enable make check tests (default yes)]))
GCONFIG_FN_ENABLE_TESTING
AC_ARG_ENABLE([debug],AS_HELP_STRING([--enable-debug],[enable extra debug messages at compile-time (default no)]))
GCONFIG_FN_ENABLE_DEBUG
AC_ARG_ENABLE([epoll],AS_HELP_STRING([--enable-epoll],[enable epoll (default no)]))
GCONFIG_FN_ENABLE_EPOLL
AC_ARG_ENABLE([gui],AS_HELP_STRING([--enable-gui],[enable configuration gui (requires Qt) (default auto)]))
GCONFIG_FN_ENABLE_GUI
AC_ARG_ENABLE([install-hook],AS_HELP_STRING([--enable-install-hook],[enable fixing up the start/stop configuration file at install time (default yes)]))
GCONFIG_FN_ENABLE_INSTALL_HOOK
AC_ARG_ENABLE([interface-names],AS_HELP_STRING([--enable-interface-names],[allow network interface names for defining listening addresses (default yes)]))
GCONFIG_FN_ENABLE_INTERFACE_NAMES
AC_ARG_ENABLE([ipv6],AS_HELP_STRING([--enable-ipv6],[enable ipv6 (default auto)]))
GCONFIG_FN_ENABLE_IPV6
AC_ARG_ENABLE([mac],AS_HELP_STRING([--enable-mac],[enable building for mac os x (default auto)]))
GCONFIG_FN_ENABLE_MAC
AC_ARG_ENABLE([std-thread],AS_HELP_STRING([--enable-std-thread],[use std::thread or not (default auto)]))
GCONFIG_FN_ENABLE_STD_THREAD
AC_ARG_ENABLE([testing],AS_HELP_STRING([--enable-testing],[enable make check tests (default yes)]))
GCONFIG_FN_ENABLE_TESTING
AC_ARG_ENABLE([verbose],AS_HELP_STRING([--enable-verbose],[enable verbose logging (default yes)]))
GCONFIG_FN_ENABLE_VERBOSE
AC_ARG_ENABLE([windows],AS_HELP_STRING([--enable-windows],[enable building for windows (default auto)]))
GCONFIG_FN_ENABLE_WINDOWS
dnl "--with-whatever"
dnl
AC_ARG_WITH(doxygen,AS_HELP_STRING([--with-doxygen],[generate source code documentation with doxygen (default auto)]))
AC_ARG_WITH([doxygen],AS_HELP_STRING([--with-doxygen],[generate source code documentation with doxygen (default auto)]))
GCONFIG_FN_WITH_DOXYGEN
AC_ARG_WITH(man2html,AS_HELP_STRING([--with-man2html],[convert man pages to html using man2html (default auto)]))
AC_ARG_WITH([gettext],AS_HELP_STRING([--with-gettext],[use GNU gettext (default no)]))
GCONFIG_FN_WITH_GETTEXT
AC_ARG_WITH([man2html],AS_HELP_STRING([--with-man2html],[convert man pages to html using man2html (default auto)]))
GCONFIG_FN_WITH_MAN2HTML
AC_ARG_WITH(openssl,AS_HELP_STRING([--with-openssl],[use openssl for tls layer (default auto)]))
AC_ARG_WITH(mbedtls,AS_HELP_STRING([--with-mbedtls],[use mbedtls for tls layer (default auto)]))
AC_ARG_WITH([openssl],AS_HELP_STRING([--with-openssl],[use openssl for tls layer (default auto)]))
AC_ARG_WITH([mbedtls],AS_HELP_STRING([--with-mbedtls],[use mbedtls for tls layer (default auto)]))
GCONFIG_FN_TLS
AC_ARG_WITH(pam,AS_HELP_STRING([--with-pam],[use linux pam for authentication (default auto)]))
AC_ARG_WITH([pam],AS_HELP_STRING([--with-pam],[use linux pam for authentication (default auto)]))
GCONFIG_FN_WITH_PAM
dnl directory tweaking -- define e_ prefixed directory variables
@ -112,7 +123,7 @@ GCONFIG_FN_SET_DIRECTORIES_E
dnl generate files
dnl
AC_CONFIG_FILES([Makefile src/Makefile src/glib/Makefile src/gssl/Makefile src/gnet/Makefile src/gauth/Makefile src/gsmtp/Makefile src/gpop/Makefile src/main/Makefile src/main/icon/Makefile src/win32/Makefile src/gui/Makefile bin/Makefile doc/Makefile etc/Makefile test/Makefile test/certificates/Makefile m4/Makefile bsd/Makefile debian/Makefile])
AC_CONFIG_FILES([Makefile src/Makefile src/glib/Makefile src/gssl/Makefile src/gnet/Makefile src/gauth/Makefile src/gsmtp/Makefile src/gpop/Makefile src/main/Makefile src/main/icon/Makefile src/win32/Makefile src/gui/Makefile bin/Makefile doc/Makefile etc/Makefile test/Makefile test/certificates/Makefile m4/Makefile bsd/Makefile debian/Makefile po/Makefile])
AC_OUTPUT
dnl final warnings

185
configure.sh
View File

@ -1,51 +1,86 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
#
# configure.sh
#
# A simple wrapper for the autoconf configure script that specifies
# more sensible directories depending on the host environment and
# simplifies cross-compilation to windows or arm.
# A wrapper for the autoconf configure script that specifies more sensible
# directories depending on the host environment and simplifies
# cross-compilation.
#
# usage: configure.sh [-d] [{-o|-m|-p}] [<configure-options>]
# -d debug compiler flags
# -o openwrt sdk and uclibc (edit as required)
# -m mingw-w64
# -p rpi
# usage: configure.sh [-g] [{-d|-s <>}] [{-o|-m|-p}] -- [<configure-options>]
# -d add debug compiler flags
# -s add sanitiser compiler flags (eg. -s address)
# -o cross-compile for openwrt (edit as required)
# -m cross-compile for windows with mingw-w64
# -p cross-compile for rpi
# -g git-clone mbedtls
#
# For systemd add "e_systemddir=/usr/lib/systemd/system".
#
# When cross-compiling with mbedtls the mbedtls source should be unpacked
# into this base directory (see MBEDTLS_DIR below), or use '-g' to
# git-clone it.
#
thisdir="`cd \`dirname $0\` && pwd`"
usage="[-g] [{-d|-s <>}] [{-o|-m|-p}] -- <configure-args>"
while expr "x$1" : "x-" >/dev/null
do
valued=0
case "`echo \"$1\" | sed 's/^-//'`" in
g) opt_git=1 ;;
d) opt_debug=1 ;;
s) opt_sanitise="$2" ; valued=1 ;;
o) opt_openwrt=1 ;;
m) opt_mingw=1 ;;
p) opt_rpi=1 ;;
h) echo usage: `basename $0` $usage "..." ; $thisdir/configure --help=short ; exit 0 ;;
#\?) echo usage: `basename $0` $usage >&2 ; exit 2 ;;
*) opt_passthrough="$opt_passthrough $1" ;;
esac
if test $valued -eq 1 ; then shift ; fi
shift
done
if expr 0$opt_openwrt + 0$opt_mingw + 0$opt_rpi \> 1 > /dev/null
then
echo usage: too many target options >&2 ; exit 2
fi
if test ! -e "$thisdir/configure"
then
echo error: no autoconf configure script: try running \'bootstrap\' >&2
exit 1
fi
enable_debug=""
if test "$1" = "-d"
if test "0$opt_git" -eq 1
then
git clone https://salsa.debian.org/debian/mbedtls.git
fi
enable_debug=""
if test "0$opt_debug" -eq 1
then
shift
export CFLAGS="-O0 -g"
export CXXFLAGS="-O0 -g"
if expr "$*" : '.*enable.debug' ; then : ; else enable_debug="--enable-debug" ; fi
if expr "x$*" : '.*enable.debug' ; then : ; else enable_debug="--enable-debug" ; fi
:
elif expr "$*" : '.*enable.debug' >/dev/null
elif expr "x$*" : '.*enable.debug' >/dev/null
then
if test "$CFLAGS$CXXFLAGS" = ""
then
@ -54,26 +89,64 @@ then
fi
fi
if test "$1" = "-m"
if test "$opt_sanitise" != ""
then
export CXX="clang++"
export CXXFLAGS="-O3 -fstrict-aliasing -Wstrict-aliasing -fsanitize=$opt_sanitise"
export LDFLAGS="-fsanitize=$opt_sanitise"
fi
MBEDTLS_DIR="`find . -maxdepth 1 -type d -name mbedtls\* 2>/dev/null | head -1`"
make_mbedtls=0
with_mbedtls=""
if test "0$opt_mingw" -eq 1 -o "0$opt_rpi" -eq 1 -o "0$opt_openwrt" -eq 1
then
with_mbedtls="--with-mbedtls=no"
fi
if test -d "$MBEDTLS_DIR"
then
echo "configure.sh: mbedtls directory exists: adding --with-mbedtls and CPPFLAGS=-I$MBEDTLS_DIR/include etc"
with_mbedtls="--with-mbedtls"
make_mbedtls=1
export CPPFLAGS="$CPPFLAGS -I`pwd`/$MBEDTLS_DIR/include"
export LDFLAGS="$LDFLAGS -L`pwd`/$MBEDTLS_DIR/library"
fi
if test "0$opt_mingw" -eq 1
then
shift
TARGET="i686-w64-mingw32"
export CXX="$TARGET-g++"
export CC="$TARGET-gcc"
export CXX="$TARGET-g++-posix"
export CC="$TARGET-gcc-posix"
export AR="$TARGET-ar"
export STRIP="$TARGET-strip"
export GCONFIG_WINDMC="$TARGET-windmc"
export GCONFIG_WINDRES="$TARGET-windres"
export CXXFLAGS="$CXXFLAGS -std=c++11 -pthread"
#export CPPFLAGS="$CPPFLAGS -D_WIN32_WINNT=0x0501" eg. for Windows XP, otherwise whatever mingw defaults to
export LDFLAGS="$LDFLAGS -pthread"
if test -x "`which $CXX`" ; then : ; else echo "error: no mingw c++ compiler: [$CXX]\n" ; exit 1 ; fi
( echo msbuild . ; echo qt-x86 . ; echo qt-x64 . ; echo cmake . ; echo msvc . ) > winbuild.cfg
if test "$make_mbedtls" -eq 1
then
echo mbedtls $MBEDTLS_DIR >> winbuild.cfg
else
echo mbedtls . >> winbuild.cfg
fi
$thisdir/configure $enable_debug --host $TARGET \
--enable-windows \
--enable-windows --disable-interface-names \
$with_mbedtls \
--disable-gui --without-pam --without-doxygen \
--prefix=/usr --libexecdir=/usr/lib --sysconfdir=/etc \
--localstatedir=/var e_initdir=/etc/init.d "$@"
--localstatedir=/var $opt_passthrough e_initdir=/etc/init.d "$@"
echo :
echo "build with..."
test "$make_mbedtls" -eq 1 && echo " make -C $MBEDTLS_DIR/library WINDOWS=1 CC=$CC AR=$AR"
echo " make"
echo " make -C src/main strip"
echo " perl winbuild.pl mingw"
:
elif test "$1" = "-p"
elif test "0$opt_rpi" -eq 1
then
shift
TARGET="arm-linux-gnueabihf"
export CXX="$TARGET-g++"
export CC="$TARGET-gcc"
@ -82,77 +155,87 @@ then
export CXXFLAGS="$CXXFLAGS -std=c++11 -pthread"
export LDFLAGS="$LDFLAGS -pthread"
$thisdir/configure $enable_debug --host $TARGET \
--disable-gui --without-pam --without-doxygen \
--disable-gui $with_mbedtls --without-openssl \
--without-pam --without-doxygen \
--prefix=/usr --libexecdir=/usr/lib --sysconfdir=/etc \
--localstatedir=/var e_initdir=/etc/init.d "$@"
--localstatedir=/var $opt_passthrough e_initdir=/etc/init.d "$@"
echo :
echo "build with..."
test "$make_mbedtls" -eq 1 && echo " make -C $MBEDTLS_DIR/library CC=$CC AR=$AR"
echo " make"
echo " make -C src/main strip"
:
elif test "$1" = "-o"
elif test "0$opt_openwrt" -eq 1
then
shift
TARGET="mipsel-openwrt-linux-uclibc"
SDK_DIR="`find $HOME -maxdepth 3 -type d -iname openwrt-sdk\*uclibc\* 2>/dev/null | sort | head -1`"
SDK_TOOLCHAIN_DIR="`find \"$SDK_DIR/staging_dir\" -type d -iname toolchain-\*uclibc\* 2>/dev/null | sort | head -1`"
SDK_TARGET_DIR="`find \"$SDK_DIR/staging_dir\" -type d -iname target-\*uclibc\* 2>/dev/null | sort | head -1`"
TARGET="mips-openwrt-linux-musl"
SDK_DIR="`find $HOME -maxdepth 3 -type d -iname openwrt-sdk\* 2>/dev/null | sort | head -1`"
SDK_TOOLCHAIN_DIR="`find \"$SDK_DIR/staging_dir\" -type d -iname toolchain-\* 2>/dev/null | sort | head -1`"
SDK_TARGET_DIR="`find \"$SDK_DIR/staging_dir\" -type d -iname target-\* 2>/dev/null | sort | head -1`"
export CC="$SDK_TOOLCHAIN_DIR/bin/$TARGET-gcc"
export CXX="$SDK_TOOLCHAIN_DIR/bin/$TARGET-c++"
export AR="$SDK_TOOLCHAIN_DIR/bin/$TARGET-ar"
export STRIP="$SDK_TOOLCHAIN_DIR/bin/$TARGET-strip"
export CXXFLAGS="-fno-rtti -fno-threadsafe-statics -Os $CXXFLAGS"
export LDFLAGS="-L$SDK_TARGET_DIR/usr/lib -luClibc++ $LDFLAGS"
export CPPFLAGS="-I$SDK_TARGET_DIR/usr/include/uClibc++ $CPPFLAGS"
export CPPFLAGS="$CPPFLAGS -DG_SMALL"
export LDFLAGS="$LDFLAGS -static"
export LIBS="-lgcc_eh"
if test -x "$CXX" ; then : ; else echo "error: no c++ compiler for target [$TARGET]: CXX=[$CXX]\n" ; exit 1 ; fi
if test -f "$SDK_TARGET_DIR/usr/lib/libuClibc++.so" ; then : ; else echo "error: no uclibc++ library under [$SDK_TARGET_DIR]\n" ; exit 1 ; fi
$thisdir/configure $enable_debug --host $TARGET \
--disable-gui --without-pam --without-doxygen \
--without-mbedtls --disable-std-thread \
$with_mbedtls --disable-std-thread \
--prefix=/usr --libexecdir=/usr/lib --sysconfdir=/etc \
--localstatedir=/var e_initdir=/etc/init.d "$@"
echo export PATH=\"$SDK_TOOLCHAIN_DIR/bin:\$PATH\"
echo export STAGING_DIR=\"$SDK_DIR/staging_dir\"
--localstatedir=/var $opt_passthrough e_initdir=/etc/init.d "$@"
echo :
echo "build with..."
#echo " export PATH=\"$SDK_TOOLCHAIN_DIR/bin:\$PATH\""
#echo " export STAGING_DIR=\"$SDK_DIR/staging_dir\""
test "$make_mbedtls" -eq 1 && echo " make -C $MBEDTLS_DIR/library CC=$CC AR=$AR"
echo " make"
echo " make -C src/main strip"
:
elif test "`uname`" = "NetBSD"
then
export CPPFLAGS="$CPPFLAGS -I/usr/X11R7/include"
export LDFLAGS="$LDFLAGS -L/usr/X11R7/lib"
$thisdir/configure $enable_debug \
$thisdir/configure $enable_debug $with_mbedtls \
--prefix=/usr --libexecdir=/usr/lib --sysconfdir=/etc \
--localstatedir=/var e_bsdinitdir=/etc/rc.d "$@"
--localstatedir=/var $opt_passthrough e_bsdinitdir=/etc/rc.d "$@"
:
elif test "`uname`" = "FreeBSD"
then
export CPPFLAGS="$CPPFLAGS -I/usr/local/include -I/usr/local/include/libav"
export LDFLAGS="$LDFLAGS -L/usr/local/lib -L/usr/local/lib/libav"
$thisdir/configure $enable_debug \
$thisdir/configure $enable_debug $with_mbedtls \
--prefix=/usr/local --mandir=/usr/local/man \
e_bsdinitdir=/usr/local/etc/rc.d "$@"
$opt_passthrough e_bsdinitdir=/usr/local/etc/rc.d "$@"
:
elif test "`uname`" = "OpenBSD"
then
export CPPFLAGS="$CPPFLAGS -I/usr/X11R6/include"
export LDFLAGS="$LDFLAGS -L/usr/X11R6/lib"
$thisdir/configure $enable_debug \
$thisdir/configure $enable_debug $with_mbedtls \
--prefix=/usr/local --mandir=/usr/local/man \
e_bsdinitdir=/usr/local/etc/rc.d "$@"
$opt_passthrough e_bsdinitdir=/usr/local/etc/rc.d "$@"
:
elif test "`uname`" = "Darwin"
then
export CPPFLAGS="$CPPFLAGS -I/opt/local/include -I/opt/X11/include"
export LDFLAGS="$LDFLAGS -L/opt/local/lib -L/opt/X11/lib"
$thisdir/configure $enable_debug \
--prefix=/opt/local --mandir=/opt/local/man "$@"
$thisdir/configure $enable_debug $with_mbedtls \
--prefix=/opt/local --mandir=/opt/local/man $opt_passthrough "$@"
:
elif test "`uname`" = "Linux"
then
export CPPFLAGS
export LDFLAGS
$thisdir/configure $enable_debug \
$thisdir/configure $enable_debug $with_mbedtls \
--prefix=/usr --libexecdir=/usr/lib --sysconfdir=/etc \
--localstatedir=/var e_initdir=/etc/init.d \
e_rundir=/run/emailrelay "$@"
$opt_passthrough e_rundir=/run/emailrelay "$@"
:
else
export CPPFLAGS="$CPPFLAGS -I/usr/X11R7/include -I/usr/X11R6/include -I/usr/local/include -I/opt/local/include -I/opt/X11/include"
export LDFLAGS="$LDFLAGS -L/usr/X11R7/lib -L/usr/X11R6/lib -L/usr/local/lib -L/opt/local/lib -L/opt/X11/lib"
$thisdir/configure $enable_debug "$@"
$thisdir/configure $enable_debug $with_mbedtls $opt_passthrough "$@"
fi

9
debian/Makefile.am vendored
View File

@ -1,16 +1,16 @@
#
## Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
#
@ -18,6 +18,7 @@
EXTRA_DIST = \
emailrelay.init \
emailrelay.default \
emailrelay.service \
changelog \
control \
compat \

2
debian/Makefile.in vendored
View File

@ -220,6 +220,7 @@ e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
e_sysconfdir = @e_sysconfdir@
e_systemddir = @e_systemddir@
exec_prefix = @exec_prefix@
host_alias = @host_alias@
htmldir = @htmldir@
@ -249,6 +250,7 @@ top_srcdir = @top_srcdir@
EXTRA_DIST = \
emailrelay.init \
emailrelay.default \
emailrelay.service \
changelog \
control \
compat \

18
debian/changelog vendored
View File

@ -1,3 +1,19 @@
emailrelay (2.2) unstable; urgency=low
* Connections from IPv4 'private use' addresses are allowed by default (see "--remote-clients").
* Interface names can be used with "--interface" (eg. "--interface=eth0").
* New "--server-tls-connection" option for server-side implicit TLS.
* New "--forward-to-some" option to permit some message recipients to be rejected.
* New "--log-address" option to aid adaptive firewalling.
* Dynamic log file rolling when using "--log-file=%d".
* Choice of syslog 'facility' on Linux with "--syslog=local0" etc.
* Pipelined SMTP QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable "--filter" scripts.
* Optional epoll event loop on Linux ("configure --enable-epoll").
* Some internationalisation support (see NEWS file).
* Support for Windows XP restored when built with mingw-w64.
* C++ 2011 compiler is required.
-- maintainer graeme_walker <graeme_walker@users.sourceforge.net> Tue, 16 Feb 2021 00:00:00 +0000
emailrelay (2.1) unstable; urgency=low
* Backwards compatibility features for 1.9-to-2.0 transition removed.
* Better handling of too-many-connections on Windows.
@ -13,7 +29,7 @@ emailrelay (2.1) unstable; urgency=low
* TLS cipher name added to "Received" line as per RFC-8314 4.3.
* Certificate contents are not logged.
* Timestamp parts of spool filenames no longer limited to six digits.
-- maintainer graeme_walker <graeme_walker@users.sourceforge.net> Mon, 16 Sep 2019 02:34:03 +0000
-- maintainer graeme_walker <graeme_walker@users.sourceforge.net> Mon, 16 Sep 2019 00:00:00 +0000
emailrelay (2.0.1) unstable; urgency=low
* Make PLAIN client authentication work against servers with broken 334 responses.

2
debian/compat vendored
View File

@ -1 +1 @@
9
10

2
debian/copyright vendored
View File

@ -1,6 +1,6 @@
Copyright
=========
Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
Refer to the file COPYING (included), /usr/share/common-licenses/GPL-3, or
<http://www.gnu.org/licenses/> for the terms of the GNU General Public License.

23
debian/emailrelay.init vendored
View File

@ -1,17 +1,17 @@
#!/bin/sh
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
@ -42,6 +42,7 @@ PIDFILE=/run/emailrelay/$NAME.pid
GROUP=daemon
DAEMON=/usr/sbin/$NAME
SUBMIT=/usr/sbin/$NAME-submit
FACILITY=mail
test -f /etc/default/$NAME && . /etc/default/$NAME
test -f /etc/rc.conf.d/$NAME && . /etc/rc.conf.d/$NAME
@ -124,7 +125,7 @@ root_root()
# True if the given file exists and is owned by 'root.root',
# as if newly copied by the install process and never
# subsequently chown'ed by the administrator
ls -nd "$1" 2>/dev/null | cut -d' ' --fields=3,4 | grep -q '^0 0$'
ls -nd "$1" 2>/dev/null | cut -d' ' -f 3,4 | grep -q '^0 0$'
}
spooldir()
{
@ -180,12 +181,17 @@ setup_tools()
setup_sgid "/usr/sbin/emailrelay-submit"
setup_sgid "/usr/lib/emailrelay/emailrelay-filter-copy"
}
setup_openrc()
{
rc-update -q -q add "$NAME" >/dev/null 2>&1 || true
}
setup()
{
setup_config
setup_rundir
setup_spooldir
setup_tools
setup_openrc
}
if test "$1" = "setup" ; then setup ; exit 0 ; fi
@ -226,9 +232,10 @@ case "$1" in
log_daemon_msg "Starting $DESC"
log_progress_msg "$NAME"
setup_rundir
start_daemon -p "$PIDFILE" -- "$DAEMON" --as-server --syslog --pid-file "$PIDFILE" "$CONFIG"
start_daemon -p "$PIDFILE" -- "$DAEMON" --as-server --syslog=$FACILITY --pid-file "$PIDFILE" "$CONFIG"
e="$?"
log_end_msg $e
if test -d /run/systemd/system ; then sleep 0.2 2>/dev/null ; fi # pid file race
test "$e" -eq 0
else
log_warning_msg "$NAME startup is disabled in /etc/default/$NAME"
@ -240,7 +247,9 @@ case "$1" in
log_daemon_msg "Stopping $DESC"
log_progress_msg "$NAME"
killproc -p "$PIDFILE" "$DAEMON"
log_end_msg $?
e="$?"
log_end_msg $e
test "$e" -eq 0
;;
reload)

14
debian/emailrelay.service vendored Normal file
View File

@ -0,0 +1,14 @@
[Unit]
Description=E-MailRelay mail server
Documentation=man:emailrelay(1)
After=network-online.target
Wants=network-online.target
[Service]
Type=forking
Restart=on-success
KillMode=control-group
ExecStart=/etc/init.d/emailrelay start
ExecStop=/etc/init.d/emailrelay stop
PIDFile=/run/emailrelay/emailrelay.pid
SuccessExitStatus=0 143

17
doc/Makefile.am
View File

@ -1,16 +1,16 @@
#
## Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
#
@ -38,6 +38,7 @@ man_files_clean=\
emailrelay-filter-copy.1.gz
html_files_noinstall=\
man2html-missing.html \
doxygen-missing.html
html_files_install=\
@ -81,7 +82,7 @@ EXTRA_DIST = \
noinst_SCRIPTS = .dox
man1_MANS = $(man_files_install)
e_doc_DATA = $(txt_files_install) $(html_files_install) $(css_files_install) $(png_files_install)
CLEANFILES = $(noinst_SCRIPTS) $(man_files_clean) doxygen.out doxygen.cfg doxygen/search/* doxygen/*
CLEANFILES = $(noinst_SCRIPTS) $(man_files_clean) emailrelay-man.html doxygen.out doxygen.cfg doxygen/search/* doxygen/*
SUFFIXES = .txt .html
@ -92,7 +93,7 @@ run_doxygen=$(top_srcdir)/bin/doxygen.sh
$(run_doxygen) "$(GCONFIG_HAVE_DOXYGEN)" "$(top_srcdir)" "$(top_builddir)" doxygen doxygen.cfg.in && touch .dox
emailrelay-man.html: emailrelay.1
if test "$(GCONFIG_HAVE_MAN2HTML)" = "yes" ; then man2html -r -L. emailrelay.1 < /dev/null > emailrelay-man.html.tmp && mv emailrelay-man.html.tmp emailrelay-man.html ; grep -v '^Content-type:' < emailrelay-man.html | grep -v '^Time:' > emailrelay-man.html.tmp ; mv emailrelay-man.html.tmp emailrelay-man.html ; fi
if test "$(GCONFIG_HAVE_MAN2HTML)" = "yes" ; then man2html -r -L. emailrelay.1 < /dev/null > emailrelay-man.html.tmp && mv emailrelay-man.html.tmp emailrelay-man.html ; grep -v '^Content-type:' < emailrelay-man.html | grep -v '^Time:' > emailrelay-man.html.tmp ; mv emailrelay-man.html.tmp emailrelay-man.html ; else cp man2html-missing.html emailrelay-man.html ; fi
emailrelay.1.gz : emailrelay.1
if test -n "$(GZIP)" ; then $(GZIP) -c "$(top_srcdir)/doc/emailrelay.1" > emailrelay.1.gz ; fi
@ -130,6 +131,6 @@ sphinx:
.PHONY: website
website:
@chmod +x make-website || true
./make-website 2.1
@chmod +x $(top_srcdir)/doc/make-website || true
$(top_srcdir)/doc/make-website `cat $(top_srcdir)/VERSION`

10
doc/Makefile.in
View File

@ -255,6 +255,7 @@ e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
e_sysconfdir = @e_sysconfdir@
e_systemddir = @e_systemddir@
exec_prefix = @exec_prefix@
host_alias = @host_alias@
htmldir = @htmldir@
@ -304,6 +305,7 @@ man_files_clean = \
emailrelay-filter-copy.1.gz
html_files_noinstall = \
man2html-missing.html \
doxygen-missing.html
html_files_install = \
@ -346,7 +348,7 @@ EXTRA_DIST = \
noinst_SCRIPTS = .dox
man1_MANS = $(man_files_install)
e_doc_DATA = $(txt_files_install) $(html_files_install) $(css_files_install) $(png_files_install)
CLEANFILES = $(noinst_SCRIPTS) $(man_files_clean) doxygen.out doxygen.cfg doxygen/search/* doxygen/*
CLEANFILES = $(noinst_SCRIPTS) $(man_files_clean) emailrelay-man.html doxygen.out doxygen.cfg doxygen/search/* doxygen/*
SUFFIXES = .txt .html
run_doxygen = $(top_srcdir)/bin/doxygen.sh
all: all-am
@ -610,7 +612,7 @@ uninstall-man: uninstall-man1
$(run_doxygen) "$(GCONFIG_HAVE_DOXYGEN)" "$(top_srcdir)" "$(top_builddir)" doxygen doxygen.cfg.in && touch .dox
emailrelay-man.html: emailrelay.1
if test "$(GCONFIG_HAVE_MAN2HTML)" = "yes" ; then man2html -r -L. emailrelay.1 < /dev/null > emailrelay-man.html.tmp && mv emailrelay-man.html.tmp emailrelay-man.html ; grep -v '^Content-type:' < emailrelay-man.html | grep -v '^Time:' > emailrelay-man.html.tmp ; mv emailrelay-man.html.tmp emailrelay-man.html ; fi
if test "$(GCONFIG_HAVE_MAN2HTML)" = "yes" ; then man2html -r -L. emailrelay.1 < /dev/null > emailrelay-man.html.tmp && mv emailrelay-man.html.tmp emailrelay-man.html ; grep -v '^Content-type:' < emailrelay-man.html | grep -v '^Time:' > emailrelay-man.html.tmp ; mv emailrelay-man.html.tmp emailrelay-man.html ; else cp man2html-missing.html emailrelay-man.html ; fi
emailrelay.1.gz : emailrelay.1
if test -n "$(GZIP)" ; then $(GZIP) -c "$(top_srcdir)/doc/emailrelay.1" > emailrelay.1.gz ; fi
@ -648,8 +650,8 @@ sphinx:
.PHONY: website
website:
@chmod +x make-website || true
./make-website 2.1
@chmod +x $(top_srcdir)/doc/make-website || true
$(top_srcdir)/doc/make-website `cat $(top_srcdir)/VERSION`
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.

BIN
doc/authentication.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 16 KiB

2
doc/authentication.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

84
doc/changelog.html
View File

@ -9,7 +9,23 @@
<!-- index:0::::E-MailRelay Change Log -->
<div class="div-main">
<h1><a class="a-header" name="H_1">E-MailRelay Change Log</a></h1> <!-- index:1:H:1::E-MailRelay Change Log -->
<h2><a class="a-header" name="SH_1_1">2.0.1 -> 2.1</a></h2> <!-- index:2:SH:1:1:2.0.1 -> 2.1 -->
<h2><a class="a-header" name="SH_1_1">2.1 -> 2.2</a></h2> <!-- index:2:SH:1:1:2.1 -> 2.2 -->
<ul>
<li>Connections from IPv4 'private use' addresses are allowed by default (see <em>--remote-clients</em>).</li>
<li>Interface names can be used with <em>--interface</em> (eg. <em>--interface=eth0</em>).</li>
<li>New <em>--server-tls-connection</em> option for server-side implicit TLS.</li>
<li>New <em>--forward-to-some</em> option to permit some message recipients to be rejected.</li>
<li>New <em>--log-address</em> option to aid adaptive firewalling.</li>
<li>Dynamic log file rolling when using <em>--log-file=%d</em>.</li>
<li>Choice of syslog 'facility' on Linux with <em>--syslog=local0</em> etc.</li>
<li>Pipelined SMTP QUIT commands sent by broken clients are tolerated.</li>
<li>Better handling of overly-verbose or unkillable <em>--filter</em> scripts.</li>
<li>Optional epoll event loop on Linux (<em>configure --enable-epoll</em>).</li>
<li>Some internationalisation support (see NEWS file).</li>
<li>Support for Windows XP restored when built with mingw-w64.</li>
<li>C++ 2011 compiler is required.</li>
</ul>
<h2><a class="a-header" name="SH_1_2">2.0.1 -> 2.1</a></h2> <!-- index:2:SH:1:2:2.0.1 -> 2.1 -->
<ul>
<li>Backwards compatibility features for 1.9-to-2.0 transition removed.</li>
<li>Better handling of too-many-connections on Windows.</li>
@ -26,11 +42,11 @@
<li>Certificate contents are not logged.</li>
<li>Timestamp parts of spool filenames no longer limited to six digits.</li>
</ul>
<h2><a class="a-header" name="SH_1_2">2.0 -> 2.0.1</a></h2> <!-- index:2:SH:1:2:2.0 -> 2.0.1 -->
<h2><a class="a-header" name="SH_1_3">2.0 -> 2.0.1</a></h2> <!-- index:2:SH:1:3:2.0 -> 2.0.1 -->
<ul>
<li>Make PLAIN client authentication work against servers with broken 334 responses.</li>
</ul>
<h2><a class="a-header" name="SH_1_3">1.9.2 -> 2.0</a></h2> <!-- index:2:SH:1:3:1.9.2 -> 2.0 -->
<h2><a class="a-header" name="SH_1_4">1.9.2 -> 2.0</a></h2> <!-- index:2:SH:1:4:1.9.2 -> 2.0 -->
<ul>
<li>Improved IPv6 support, with IPv4 and IPv6 used independently at run-time (see <em>--interface</em>).</li>
<li>Server process is not blocked during <em>--filter</em> or <em>--address-verifier</em> execution, if multi-threaded.</li>
@ -61,7 +77,7 @@
<li>C++ 2011 is preferred, and required for multi-threading.</li>
<li>Support for very old versions of Windows is dropped.</li>
</ul>
<h2><a class="a-header" name="SH_1_4">1.9.1 -> 1.9.2</a></h2> <!-- index:2:SH:1:4:1.9.1 -> 1.9.2 -->
<h2><a class="a-header" name="SH_1_5">1.9.1 -> 1.9.2</a></h2> <!-- index:2:SH:1:5:1.9.1 -> 1.9.2 -->
<ul>
<li>Fixed a leak in the event-loop garbage collection.</li>
<li>A local hostname that fails to resolve is not an error.</li>
@ -77,11 +93,11 @@
<li>Qt4 or Qt5 selected by the <em>configure</em> script.</li>
<li>Improved the RPM spec file.</li>
</ul>
<h2><a class="a-header" name="SH_1_5">1.9 -> 1.9.1</a></h2> <!-- index:2:SH:1:5:1.9 -> 1.9.1 -->
<h2><a class="a-header" name="SH_1_6">1.9 -> 1.9.1</a></h2> <!-- index:2:SH:1:6:1.9 -> 1.9.1 -->
<ul>
<li>Updated OpenSSL from 1.0.1e to 1.0.1g in the Windows build.</li>
</ul>
<h2><a class="a-header" name="SH_1_6">1.8.2 -> 1.9</a></h2> <!-- index:2:SH:1:6:1.8.2 -> 1.9 -->
<h2><a class="a-header" name="SH_1_7">1.8.2 -> 1.9</a></h2> <!-- index:2:SH:1:7:1.8.2 -> 1.9 -->
<ul>
<li>Added negotiated TLS/SSL for POP (ie. <em>STLS</em>).</li>
<li>The first two fields in the secrets files are reordered (with backwards compatibility).</li>
@ -106,17 +122,17 @@
<li>Added Windows <em>--peer-lookup</em> option.</li>
<li>Fix for MD5 code in 64-bit builds.</li>
</ul>
<h2><a class="a-header" name="SH_1_7">1.8.1 -> 1.8.2</a></h2> <!-- index:2:SH:1:7:1.8.1 -> 1.8.2 -->
<h2><a class="a-header" name="SH_1_8">1.8.1 -> 1.8.2</a></h2> <!-- index:2:SH:1:8:1.8.1 -> 1.8.2 -->
<ul>
<li>Fix namespaces for gcc 3.4.</li>
</ul>
<h2><a class="a-header" name="SH_1_8">1.8 -> 1.8.1</a></h2> <!-- index:2:SH:1:8:1.8 -> 1.8.1 -->
<h2><a class="a-header" name="SH_1_9">1.8 -> 1.8.1</a></h2> <!-- index:2:SH:1:9:1.8 -> 1.8.1 -->
<ul>
<li>Changed the definition of <em>--as-proxy</em> to use <em>--poll 0</em> rather than <em>--immediate</em> [bug-id 1961652].</li>
<li>Fixed stalling bug when using server-side TLS/SSL (<em>--server-tls</em>) [bug-id 1961655].</li>
<li>Improved Debian packaging for Linux (<em>make deb</em>).</li>
</ul>
<h2><a class="a-header" name="SH_1_9">1.7 -> 1.8</a></h2> <!-- index:2:SH:1:9:1.7 -> 1.8 -->
<h2><a class="a-header" name="SH_1_10">1.7 -> 1.8</a></h2> <!-- index:2:SH:1:10:1.7 -> 1.8 -->
<ul>
<li>Speed optimisations (as identified by KCachegrind/valgrind in KDevelop).</li>
<li>Build-time size optimisations (eg. <em>./configure --disable-exec --enable-small-exceptions ...</em>).</li>
@ -132,7 +148,7 @@
<li>Improved native support for Mac OS X (10.5) with graphical installation from disk image.</li>
<li>Compatibility with gcc 2.95 restored.</li>
</ul>
<h2><a class="a-header" name="SH_1_10">1.6 -> 1.7</a></h2> <!-- index:2:SH:1:10:1.6 -> 1.7 -->
<h2><a class="a-header" name="SH_1_11">1.6 -> 1.7</a></h2> <!-- index:2:SH:1:11:1.6 -> 1.7 -->
<ul>
<li>TLS/SSL support for SMTP using OpenSSL (<em>./configure --with-openssl</em> with <em>--client-tls</em> and <em>--server-tls</em>).</li>
<li>Authentication mechanism <em>PLAIN</em> added.</li>
@ -140,7 +156,7 @@
<li>Windows service wrapper has an <em>--uninstall</em> option.</li>
<li>Windows installation GUI uninstalls the service before reinstalling it.</li>
</ul>
<h2><a class="a-header" name="SH_1_11">1.5 -> 1.6</a></h2> <!-- index:2:SH:1:11:1.5 -> 1.6 -->
<h2><a class="a-header" name="SH_1_12">1.5 -> 1.6</a></h2> <!-- index:2:SH:1:12:1.5 -> 1.6 -->
<ul>
<li>GPLv3 licence (see <em>http://gplv3.fsf.org</em>).</li>
<li>New <em>--prompt-timeout</em> switch for the timeout when waiting for the initial 220 prompt from the SMTP server.</li>
@ -160,7 +176,7 @@
<li>Experimental SpamAssassin spamc/spamd protocol support.</li>
<li>Acceptance tests added to the distribution.</li>
</ul>
<h2><a class="a-header" name="SH_1_12">1.4 -> 1.5</a></h2> <!-- index:2:SH:1:12:1.4 -> 1.5 -->
<h2><a class="a-header" name="SH_1_13">1.4 -> 1.5</a></h2> <!-- index:2:SH:1:13:1.4 -> 1.5 -->
<ul>
<li>New installation and configuration GUI using TrollTech Qt 4.x (<em>./configure --enable-gui</em>)</li>
<li>Default address verifier accepts all addresses as valid and never treats them as local mailboxes.</li>
@ -175,7 +191,7 @@
<li>Documentation also created in docbook format (requires xmlto).</li>
<li>Windows installation document revised.</li>
</ul>
<h2><a class="a-header" name="SH_1_13">1.3.3 -> 1.4</a></h2> <!-- index:2:SH:1:13:1.3.3 -> 1.4 -->
<h2><a class="a-header" name="SH_1_14">1.3.3 -> 1.4</a></h2> <!-- index:2:SH:1:14:1.3.3 -> 1.4 -->
<ul>
<li>POP3 server (enable with <em>--pop</em>, disable at build-time with <em>./configure --disable-pop</em>).</li>
<li>Fix for logging reentrancy bug (affects <em>./configure --enable-debug</em> with <em>--debug</em>).</li>
@ -189,7 +205,7 @@
<li>The <em>--dont-listen</em> switch is now <em>--no-smtp</em>.</li>
<li>Better IPv6 support (Linux only).</li>
</ul>
<h2><a class="a-header" name="SH_1_14">1.3.2 -> 1.3.3</a></h2> <!-- index:2:SH:1:14:1.3.2 -> 1.3.3 -->
<h2><a class="a-header" name="SH_1_15">1.3.2 -> 1.3.3</a></h2> <!-- index:2:SH:1:15:1.3.2 -> 1.3.3 -->
<ul>
<li>No bind() for outgoing connections [bug-id 1051689].</li>
<li>Updated rpm spec file [bug-id 1224850].</li>
@ -198,21 +214,21 @@
<li>Documentation of <em>auth</em> switches corrected.</li>
<li>State-machine template type declaration modernised, possibly breaking older compilers.</li>
</ul>
<h2><a class="a-header" name="SH_1_15">1.3.1 -> 1.3.2</a></h2> <!-- index:2:SH:1:15:1.3.1 -> 1.3.2 -->
<h2><a class="a-header" name="SH_1_16">1.3.1 -> 1.3.2</a></h2> <!-- index:2:SH:1:16:1.3.1 -> 1.3.2 -->
<ul>
<li>Fix for core dump when <em>--client-filter</em> pre-processing fails.</li>
<li>Revised code structure to prepare for asynchronous pre-processing.</li>
<li>Better diagnostics when pre-processor exec() fails.</li>
<li>Better cleanup of empty and orphaned files.</li>
</ul>
<h2><a class="a-header" name="SH_1_16">1.3 -> 1.3.1</a></h2> <!-- index:2:SH:1:16:1.3 -> 1.3.1 -->
<h2><a class="a-header" name="SH_1_17">1.3 -> 1.3.1</a></h2> <!-- index:2:SH:1:17:1.3 -> 1.3.1 -->
<ul>
<li>Windows resource leak from CreateProcess() fixed.</li>
<li>Windows dialog box double-close fix.</li>
<li>Some documentation for the <em>--scanner</em> switch.</li>
<li>New usage patterns section in the user guide.</li>
</ul>
<h2><a class="a-header" name="SH_1_17">1.2 -> 1.3</a></h2> <!-- index:2:SH:1:17:1.2 -> 1.3 -->
<h2><a class="a-header" name="SH_1_18">1.2 -> 1.3</a></h2> <!-- index:2:SH:1:18:1.2 -> 1.3 -->
<ul>
<li>Client protocol waits for a greeting from the server on startup [bug-id 842156].</li>
<li>Fix for incorrect backslash normalisation on <em>--verifier</em> command-lines containing spaces [bug-id 890646].</li>
@ -225,7 +241,7 @@
<li>New switches for the <em>configure</em> script.</li>
<li>More JavaScript example scripts.</li>
</ul>
<h2><a class="a-header" name="SH_1_18">1.1.2 -> 1.2</a></h2> <!-- index:2:SH:1:18:1.1.2 -> 1.2 -->
<h2><a class="a-header" name="SH_1_19">1.1.2 -> 1.2</a></h2> <!-- index:2:SH:1:19:1.1.2 -> 1.2 -->
<ul>
<li>The <em>--filter</em> and <em>--verifier</em> arguments interpreted as command-lines; spaces in executable paths now need escaping.</li>
<li>The <em>--interface</em> switch applies to outgoing connections too.</li>
@ -234,7 +250,7 @@
<li>Fix for dangling reference bug, seen after <em>quit</em> command on Windows.</li>
<li>JavaScript examples in the documentation.</li>
</ul>
<h2><a class="a-header" name="SH_1_19">1.1.1 -> 1.1.2</a></h2> <!-- index:2:SH:1:19:1.1.1 -> 1.1.2 -->
<h2><a class="a-header" name="SH_1_20">1.1.1 -> 1.1.2</a></h2> <!-- index:2:SH:1:20:1.1.1 -> 1.1.2 -->
<ul>
<li>Earlier check for un-bindable ports on startup, and later fork()ing [bug-id 776972].</li>
<li>Resolved the file-descriptor kludge for <em>--verifier</em> on Windows.</li>
@ -243,7 +259,7 @@
<li>Pre-processor (<em>--filter</em>) program's standard output searched for a failure reason string.</li>
<li>Undocumented <em>--scanner</em> switch added for asynchronous processing by a separate network server.</li>
</ul>
<h2><a class="a-header" name="SH_1_20">1.1.0 -> 1.1.1</a></h2> <!-- index:2:SH:1:20:1.1.0 -> 1.1.1 -->
<h2><a class="a-header" name="SH_1_21">1.1.0 -> 1.1.1</a></h2> <!-- index:2:SH:1:21:1.1.0 -> 1.1.1 -->
<ul>
<li>Restored the fix for building with gcc2.96.</li>
<li>Support for MinGW builds on Windows.</li>
@ -253,7 +269,7 @@
<li>Fix for <em>make install</em> when <em>man2html</em> is not available.</li>
<li>Updated init script.</li>
</ul>
<h2><a class="a-header" name="SH_1_21">1.0.2 -> 1.1.0</a></h2> <!-- index:2:SH:1:21:1.0.2 -> 1.1.0 -->
<h2><a class="a-header" name="SH_1_22">1.0.2 -> 1.1.0</a></h2> <!-- index:2:SH:1:22:1.0.2 -> 1.1.0 -->
<ul>
<li>In proxy mode unexpected client-side disconnects and timeouts do not leave <em>.bad</em> files [see also bug-id 659039].</li>
<li>By default proxy mode does not interpret addresses for local delivery (<em>--postmaster</em>).</li>
@ -268,14 +284,14 @@
<li>Support for Sun WorkShop 5.0 added.</li>
<li>Documentation overhaul.</li>
</ul>
<h2><a class="a-header" name="SH_1_22">1.0.0 -> 1.0.2</a></h2> <!-- index:2:SH:1:22:1.0.0 -> 1.0.2 -->
<h2><a class="a-header" name="SH_1_23">1.0.0 -> 1.0.2</a></h2> <!-- index:2:SH:1:23:1.0.0 -> 1.0.2 -->
<ul>
<li>Support for trusted IP addresses, allowing certain clients to avoid authentication.</li>
<li>Address verifier interface extended to include authentication information.</li>
<li>New public mail relay section added to the user guide.</li>
<li>Example verifier scripts etc. added to the reference guide.</li>
</ul>
<h2><a class="a-header" name="SH_1_23">1.0.0 -> 1.0.1</a></h2> <!-- index:2:SH:1:23:1.0.0 -> 1.0.1 -->
<h2><a class="a-header" name="SH_1_24">1.0.0 -> 1.0.1</a></h2> <!-- index:2:SH:1:24:1.0.0 -> 1.0.1 -->
<ul>
<li>In proxy mode unexpected client-side disconnects and timeouts result in <em>.bad</em> files [bug-id 659039].</li>
<li>Require successful <em>AUTH</em> before <em>MAIL FROM</em> when using <em>--server-auth</em>.</li>
@ -288,7 +304,7 @@
<li>Fix build when using gcc2.96 rather than gcc2.95 (1.0.0-pl1).</li>
<li>Fix default spool directory in example scripts (1.0.0-pl1).</li>
</ul>
<h2><a class="a-header" name="SH_1_24">0.9.9 -> 1.0.0</a></h2> <!-- index:2:SH:1:24:0.9.9 -> 1.0.0 -->
<h2><a class="a-header" name="SH_1_25">0.9.9 -> 1.0.0</a></h2> <!-- index:2:SH:1:25:0.9.9 -> 1.0.0 -->
<ul>
<li>Briefer <em>--help</em> output; works with <em>--verbose</em>.</li>
<li>Option to listen on a specific network interface (<em>--interface</em>).</li>
@ -301,7 +317,7 @@
<li>EHLO response parsing is now case-insensitive [bug-id 561522].</li>
<li>Fewer missing-secrets warnings [bug-id 564987].</li>
</ul>
<h2><a class="a-header" name="SH_1_25">0.9.8 -> 0.9.9</a></h2> <!-- index:2:SH:1:25:0.9.8 -> 0.9.9 -->
<h2><a class="a-header" name="SH_1_26">0.9.8 -> 0.9.9</a></h2> <!-- index:2:SH:1:26:0.9.8 -> 0.9.9 -->
<ul>
<li>More flexible logging options (<em>--verbose</em> and <em>--debug</em> work better).</li>
<li>File Hierarchy Standard (FHS) option for <em>configure</em> (<em>--enable-fhs</em>).</li>
@ -317,14 +333,14 @@
<li>Submit utility works under Windows. [rc2]</li>
<li>Improved Windows project files. [rc2]</li>
</ul>
<h2><a class="a-header" name="SH_1_26">0.9.7 -> 0.9.8</a></h2> <!-- index:2:SH:1:26:0.9.7 -> 0.9.8 -->
<h2><a class="a-header" name="SH_1_27">0.9.7 -> 0.9.8</a></h2> <!-- index:2:SH:1:27:0.9.7 -> 0.9.8 -->
<ul>
<li>Fix for running pre-processor (<em>--filter</em>) as root.</li>
<li>Ignore bogus <em>AUTH=LOGIN</em> lines in EHLO response.</li>
<li>Submit utility improved to work with mutt.</li>
<li>Installation of submit man page.</li>
</ul>
<h2><a class="a-header" name="SH_1_27">0.9.6 -> 0.9.7</a></h2> <!-- index:2:SH:1:27:0.9.6 -> 0.9.7 -->
<h2><a class="a-header" name="SH_1_28">0.9.6 -> 0.9.7</a></h2> <!-- index:2:SH:1:28:0.9.6 -> 0.9.7 -->
<ul>
<li>CRAM-MD5 authentication mechanism added.</li>
<li>Revoke root permissions at start up, and reclaim them when needed.</li>
@ -340,7 +356,7 @@
<li>Submission utility <em>emailrelay-submit</em> added.</li>
<li>HTML4.0 compliant HTML documentation, using CSS.</li>
</ul>
<h2><a class="a-header" name="SH_1_28">0.9.5 -> 0.9.6</a></h2> <!-- index:2:SH:1:28:0.9.5 -> 0.9.6 -->
<h2><a class="a-header" name="SH_1_29">0.9.5 -> 0.9.6</a></h2> <!-- index:2:SH:1:29:0.9.5 -> 0.9.6 -->
<ul>
<li>SMTP AUTHentication extension -- LOGIN mechanism only.</li>
<li>Client-side protocol timeout.</li>
@ -350,7 +366,7 @@
<li>Multiple hard-coded listening addresses supported at compile-time.</li>
<li>Fix for automatic reopening of stderr stream.</li>
</ul>
<h2><a class="a-header" name="SH_1_29">0.9.4 -> 0.9.5</a></h2> <!-- index:2:SH:1:29:0.9.4 -> 0.9.5 -->
<h2><a class="a-header" name="SH_1_30">0.9.4 -> 0.9.5</a></h2> <!-- index:2:SH:1:30:0.9.4 -> 0.9.5 -->
<p>
Windows fixes and improvements...
</p>
@ -360,14 +376,14 @@
<li>fix for content file deletion</li>
<li>fix for directory iterator</li>
</ul>
<h2><a class="a-header" name="SH_1_30">0.9.3 -> 0.9.4</a></h2> <!-- index:2:SH:1:30:0.9.3 -> 0.9.4 -->
<h2><a class="a-header" name="SH_1_31">0.9.3 -> 0.9.4</a></h2> <!-- index:2:SH:1:31:0.9.3 -> 0.9.4 -->
<ul>
<li>Fixed memory leak when no <em>--log</em> switch.</li>
<li>Windows build is more <em>gui</em> and less <em>command-line</em>.</li>
<li><em>Info</em> command added to the administration interface.</li>
<li>Doxygen files removed from binary RPM.</li>
</ul>
<h2><a class="a-header" name="SH_1_31">0.9.2 -> 0.9.3</a></h2> <!-- index:2:SH:1:31:0.9.2 -> 0.9.3 -->
<h2><a class="a-header" name="SH_1_32">0.9.2 -> 0.9.3</a></h2> <!-- index:2:SH:1:32:0.9.2 -> 0.9.3 -->
<ul>
<li>Proxy mode (<em>--immediate</em> and <em>--as-proxy</em>).</li>
<li>Message pre-processing (<em>--filter</em>).</li>
@ -375,7 +391,7 @@
<li>Improved notification script, with MIME encoding.</li>
<li>Builds with old 2.91 version of gcc.</li>
</ul>
<h2><a class="a-header" name="SH_1_32">0.9.1 -> 0.9.2</a></h2> <!-- index:2:SH:1:32:0.9.1 -> 0.9.2 -->
<h2><a class="a-header" name="SH_1_33">0.9.1 -> 0.9.2</a></h2> <!-- index:2:SH:1:33:0.9.1 -> 0.9.2 -->
<ul>
<li>Better autoconf detection.</li>
<li>Workround for FreeBSD uname() feature.</li>
@ -383,7 +399,7 @@
<li>Fixed a benign directory iterator bug.</li>
<li>Use of gcc's <em>exception</em> header.</li>
</ul>
<h2><a class="a-header" name="SH_1_33">0.9 -> 0.9.1</a></h2> <!-- index:2:SH:1:33:0.9 -> 0.9.1 -->
<h2><a class="a-header" name="SH_1_34">0.9 -> 0.9.1</a></h2> <!-- index:2:SH:1:34:0.9 -> 0.9.1 -->
<ul>
<li>Improved documentation from doxygen.</li>
<li>More complete use of namespaces.</li>
@ -393,4 +409,4 @@
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

21
doc/changelog.md
View File

@ -1,6 +1,23 @@
E-MailRelay Change Log
======================
2.1 -> 2.2
----------
* Connections from IPv4 'private use' addresses are allowed by default (see `--remote-clients`).
* Interface names can be used with `--interface` (eg. `--interface=eth0`).
* New `--server-tls-connection` option for server-side implicit [TLS][].
* New `--forward-to-some` option to permit some message recipients to be rejected.
* New `--log-address` option to aid adaptive firewalling.
* Dynamic log file rolling when using `--log-file=%d`.
* Choice of syslog 'facility' on Linux with `--syslog=local0` etc.
* Pipelined [SMTP][] QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable `--filter` scripts.
* Optional epoll event loop on Linux (`configure --enable-epoll`).
* Some internationalisation support (see NEWS file).
* Support for Windows XP restored when built with mingw-w64.
* C++ 2011 compiler is required.
2.0.1 -> 2.1
------------
@ -15,7 +32,7 @@ E-MailRelay Change Log
* New `--show` option on windows to better control the user interface style.
* The `--pop` option always requires `--pop-auth`.
* No message is spooled if all its envelope recipients are local-mailboxes.
* [TLS][] cipher name added to `Received` line as per [RFC-8314][] 4.3.
* TLS cipher name added to `Received` line as per [RFC-8314][] 4.3.
* Certificate contents are not logged.
* Timestamp parts of spool filenames no longer limited to six digits.
@ -36,7 +53,7 @@ E-MailRelay Change Log
* The `--tls-config` option works differently (see NEWS file).
* New `--client-tls-server-name` option for server name identification (SNI).
* New `--client-tls-required` option to force client connections to use TLS.
* New `--server-tls-required` option to force remote [SMTP][] clients to use STARTTLS.
* New `--server-tls-required` option to force remote SMTP clients to use STARTTLS.
* New `--forward-on-disconnect` option replaces `--poll=0`.
* The `--anonymous` option now suppresses the `Received` line, whatever the `--domain`.
* The second field in the secrets file indicates the password encoding, not AUTH mechanism.

21
doc/changelog.rst
View File

@ -2,6 +2,23 @@
E-MailRelay Change Log
**********************
2.1 -> 2.2
==========
* Connections from IPv4 'private use' addresses are allowed by default (see *--remote-clients*).
* Interface names can be used with *--interface* (eg. *--interface=eth0*).
* New *--server-tls-connection* option for server-side implicit TLS_.
* New *--forward-to-some* option to permit some message recipients to be rejected.
* New *--log-address* option to aid adaptive firewalling.
* Dynamic log file rolling when using *--log-file=%d*.
* Choice of syslog 'facility' on Linux with *--syslog=local0* etc.
* Pipelined SMTP_ QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable *--filter* scripts.
* Optional epoll event loop on Linux (\ *configure --enable-epoll*\ ).
* Some internationalisation support (see NEWS file).
* Support for Windows XP restored when built with mingw-w64.
* C++ 2011 compiler is required.
2.0.1 -> 2.1
============
@ -16,7 +33,7 @@ E-MailRelay Change Log
* New *--show* option on windows to better control the user interface style.
* The *--pop* option always requires *--pop-auth*.
* No message is spooled if all its envelope recipients are local-mailboxes.
* TLS_ cipher name added to *Received* line as per RFC-8314_ 4.3.
* TLS cipher name added to *Received* line as per RFC-8314_ 4.3.
* Certificate contents are not logged.
* Timestamp parts of spool filenames no longer limited to six digits.
@ -37,7 +54,7 @@ E-MailRelay Change Log
* The *--tls-config* option works differently (see NEWS file).
* New *--client-tls-server-name* option for server name identification (SNI).
* New *--client-tls-required* option to force client connections to use TLS.
* New *--server-tls-required* option to force remote SMTP_ clients to use STARTTLS.
* New *--server-tls-required* option to force remote SMTP clients to use STARTTLS.
* New *--forward-on-disconnect* option replaces *--poll=0*.
* The *--anonymous* option now suppresses the *Received* line, whatever the *--domain*.
* The second field in the secrets file indicates the password encoding, not AUTH mechanism.

16
doc/changelog.txt
View File

@ -1,6 +1,22 @@
E-MailRelay Change Log
======================
2.1 -> 2.2
----------
* Connections from IPv4 'private use' addresses are allowed by default (see "--remote-clients").
* Interface names can be used with "--interface" (eg. "--interface=eth0").
* New "--server-tls-connection" option for server-side implicit TLS.
* New "--forward-to-some" option to permit some message recipients to be rejected.
* New "--log-address" option to aid adaptive firewalling.
* Dynamic log file rolling when using "--log-file=%d".
* Choice of syslog 'facility' on Linux with "--syslog=local0" etc.
* Pipelined SMTP QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable "--filter" scripts.
* Optional epoll event loop on Linux ("configure --enable-epoll").
* Some internationalisation support (see NEWS file).
* Support for Windows XP restored when built with mingw-w64.
* C++ 2011 compiler is required.
2.0.1 -> 2.1
------------
* Backwards compatibility features for 1.9-to-2.0 transition removed.

6
doc/conf.py.sphinx
View File

@ -7,10 +7,10 @@ templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = u'E-MailRelay'
copyright = u'2019, Graeme Walker'
copyright = u'2021, Graeme Walker'
author = u'Graeme Walker'
version = u'2.1'
release = u'2.1'
version = u'2.2'
release = u'2.2'
language = None
today_fmt = '%Y-%m-%d'
exclude_patterns = []

93
doc/developer.html
View File

@ -23,19 +23,20 @@
<p>
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ runtime. Since that time OpenSSL
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support TLS encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
</p>
<p>
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout.
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
</p>
<h2><a class="a-header" name="SH_1_3">Portability</a></h2> <!-- index:2:SH:1:3:Portability -->
<p>
The E-MailRelay code is mostly written in C++-1998, but using some features of
C++-2011. A C++-1998 compiler can be used, but multi-threading will be disabled.
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
</p>
<p>
@ -61,11 +62,11 @@
</p>
<h2><a class="a-header" name="SH_1_4">Event model</a></h2> <!-- index:2:SH:1:4:Event model -->
<p>
The E-MailRelay server uses non-blocking socket i/o, with a select() event loop.
This event model means that the server can handle multiple network connections
simultaneously from a single thread, and even if multi-threading is disabled at
build-time the only blocking occurs when external programs are executed (see
<em>--filter</em> and <em>--address-verifier</em>).
The E-MailRelay server uses non-blocking socket i/o, with a select() or epoll()
event loop. This event model means that the server can handle multiple network
connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see <em>--filter</em> and <em>--address-verifier</em>).
</p>
<p>
@ -207,14 +208,16 @@
</p>
<p>
The combination of an exception handler and the optional exception source
pointer bound to it is known as an <em>ExceptionSink</em>.
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
</p>
<h2><a class="a-header" name="SH_1_8">Multi-threading</a></h2> <!-- index:2:SH:1:8:Multi-threading -->
<p>
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if std::thread is available then it
is used in a future/promise pattern to wrap up <em>getaddrinfo()</em> and <em>waitpid()</em>
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up <em>getaddrinfo()</em> and <em>waitpid()</em>
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see <em>GNet::FutureEvent</em>).
@ -252,12 +255,29 @@
<p>
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. (The payload used to be a single
archive file appended to the executable, but it is now simple directory
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
bundle.)
bundle, and it contains a configuration file to tell the installer where
to copy its files.
</p>
<h2><a class="a-header" name="SH_1_10">Windows packaging</a></h2> <!-- index:2:SH:1:10:Windows packaging -->
<h2><a class="a-header" name="SH_1_10">Windows build</a></h2> <!-- index:2:SH:1:10:Windows build -->
<p>
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (<em>winbuild.pl</em>) that creates
<em>cmake</em> files from the autotools makefiles, runs <em>cmake</em> to create the MSVC
project files and then runs <em>msbuild</em> to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
<em>winbuild.bat</em> batch file should be able to do a complete MSVC release build
in one go.
</p>
<p>
For MinGW cross-builds use <em>./configure.sh -m</em> and <em>make</em> on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running <em>dumpbin /dependents</em> in the normal
way.
</p>
<h2><a class="a-header" name="SH_1_11">Windows packaging</a></h2> <!-- index:2:SH:1:11:Windows packaging -->
<p>
On Windows E-MailRelay is packaged as a zip file containing the executables
(including the emailrelay GUI as <em>emailrelay-setup.exe</em>), documentation, and a
@ -269,7 +289,13 @@
The Qt tool <em>windeployqt</em> is used to add run-time dependencies, such as the
Qt DLLs.
</p>
<h2><a class="a-header" name="SH_1_11">Unix packaging</a></h2> <!-- index:2:SH:1:11:Unix packaging -->
<p>
To target ancient versions of Windows start with a cross-build using MinGW;
then <em>winbuild.pl mingw</em> can be used to assemble a slimmed-down package for
distribution.
</p>
<h2><a class="a-header" name="SH_1_12">Unix packaging</a></h2> <!-- index:2:SH:1:12:Unix packaging -->
<p>
On Unix-like operating systems it is more natural to use some sort of package
derived from the <em>make install</em> process rather than an installer program, so
@ -280,7 +306,22 @@
Top-level makefile targets <em>dist</em>, <em>deb</em> and <em>rpm</em> can be used to create a
binary tarball, a debian package, and an RPM package respectively.
</p>
<h2><a class="a-header" name="SH_1_12">Source control</a></h2> <!-- index:2:SH:1:12:Source control -->
<h2><a class="a-header" name="SH_1_13">Internationalisation</a></h2> <!-- index:2:SH:1:13:Internationalisation -->
<p>
The GUI code has i18n support using the Qt framework, with the tr() function
used throughout the GUI source code. The GUI main() function loads translations
from the <em>translations</em> sub-directory (relative to the executable), although
that can be overridden with the <em>--qm</em> command-line option. Qt's <em>-reverse</em>
option can also be used to reverse the widgets when using RTL languages.
</p>
<p>
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option (<em>--with-gettext</em>) to enable it at build-time and
a <em>--localedir</em> option at run-time. See also <em>po/Makefile.am</em>.
</p>
<h2><a class="a-header" name="SH_1_14">Source control</a></h2> <!-- index:2:SH:1:14:Source control -->
<p>
The source code is stored in the SourceForge <em>svn</em> repository. A working
copy can be checked out as follows:
@ -289,31 +330,33 @@
<div class="div-pre">
<pre>$ svn co https://svn.code.sf.net/p/emailrelay/code/trunk emailrelay</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_13">Compile-time features</a></h2> <!-- index:2:SH:1:13:Compile-time features -->
<h2><a class="a-header" name="SH_1_15">Compile-time features</a></h2> <!-- index:2:SH:1:15:Compile-time features -->
<p>
Compile-time features can be selected with options passed to the <em>configure</em>
script. These include the following:
</p>
<ul>
<li>Debug-level logging (<em>--enable-debug</em>)</li>
<li>Configuration GUI (<em>--enable-gui</em>)</li>
<li>Multi-threading (<em>--enable-std-thread</em>)</li>
<li>TLS library (<em>--with-openssl</em>, <em>--with-mbedtls</em>)</li>
<li>Debug-level logging (<em>--enable-debug</em>)</li>
<li>Event loop using epoll (<em>--enable-epoll</em>)</li>
<li>PAM support (<em>--with-pam</em>)</li>
</ul>
<p>
Use <em>./configure --help</em> to see a complete list of options and refer to
<em>acinclude.m4</em> for more detailed comments.
Use <em>./configure --help</em> to see a complete list of options.
</p>
<div class="div-footer">
<p>
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

77
doc/developer.md
View File

@ -14,17 +14,18 @@ Dependencies
------------
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ runtime. Since that time OpenSSL
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support [TLS][] encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout.
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
Portability
-----------
The E-MailRelay code is mostly written in C++-1998, but using some features of
C++-2011. A C++-1998 compiler can be used, but multi-threading will be disabled.
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The header files `gdef.h` in `src/glib` is used to fix up some compiler
portability issues such as missing standard types, non-standard system headers
@ -44,11 +45,11 @@ alternatives.
Event model
-----------
The E-MailRelay server uses non-blocking socket i/o, with a select() event loop.
This event model means that the server can handle multiple network connections
simultaneously from a single thread, and even if multi-threading is disabled at
build-time the only blocking occurs when external programs are executed (see
`--filter` and `--address-verifier`).
The E-MailRelay server uses non-blocking socket i/o, with a select() or epoll()
event loop. This event model means that the server can handle multiple network
connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see `--filter` and `--address-verifier`).
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
@ -162,14 +163,16 @@ identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
The combination of an exception handler and the optional exception source
pointer bound to it is known as an `ExceptionSink`.
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Multi-threading
---------------
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if std::thread is available then it
is used in a future/promise pattern to wrap up `getaddrinfo()` and `waitpid()`
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up `getaddrinfo()` and `waitpid()`
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see `GNet::FutureEvent`).
@ -199,10 +202,25 @@ When run in configure mode the GUI normally ends up simply editing the
`emailrelay.auth` secrets file.
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. (The payload used to be a single
archive file appended to the executable, but it is now simple directory
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
bundle.)
bundle, and it contains a configuration file to tell the installer where
to copy its files.
Windows build
-------------
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (`winbuild.pl`) that creates
`cmake` files from the autotools makefiles, runs `cmake` to create the MSVC
project files and then runs `msbuild` to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
`winbuild.bat` batch file should be able to do a complete MSVC release build
in one go.
For MinGW cross-builds use `./configure.sh -m` and `make` on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running `dumpbin /dependents` in the normal
way.
Windows packaging
-----------------
@ -214,6 +232,10 @@ again, and while this duplication is not ideal it is at least straightforward.
The Qt tool `windeployqt` is used to add run-time dependencies, such as the
Qt DLLs.
To target ancient versions of Windows start with a cross-build using MinGW;
then `winbuild.pl mingw` can be used to assemble a slimmed-down package for
distribution.
Unix packaging
--------------
On Unix-like operating systems it is more natural to use some sort of package
@ -223,6 +245,19 @@ the emailrelay GUI is not normally used.
Top-level makefile targets `dist`, `deb` and `rpm` can be used to create a
binary tarball, a debian package, and an RPM package respectively.
Internationalisation
--------------------
The GUI code has i18n support using the Qt framework, with the tr() function
used throughout the GUI source code. The GUI main() function loads translations
from the `translations` sub-directory (relative to the executable), although
that can be overridden with the `--qm` command-line option. Qt's `-reverse`
option can also be used to reverse the widgets when using RTL languages.
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option (`--with-gettext`) to enable it at build-time and
a `--localedir` option at run-time. See also `po/Makefile.am`.
Source control
--------------
The source code is stored in the SourceForge `svn` repository. A working
@ -235,12 +270,14 @@ Compile-time features
Compile-time features can be selected with options passed to the `configure`
script. These include the following:
* Debug-level logging (`--enable-debug`)
* Configuration GUI (`--enable-gui`)
* Multi-threading (`--enable-std-thread`)
* TLS library (`--with-openssl`, `--with-mbedtls`)
* Debug-level logging (`--enable-debug`)
* Event loop using epoll (`--enable-epoll`)
* [PAM][] support (`--with-pam`)
Use `./configure --help` to see a complete list of options and refer to
`acinclude.m4` for more detailed comments.
Use `./configure --help` to see a complete list of options.
@ -250,4 +287,4 @@ Use `./configure --help` to see a complete list of options and refer to
[TLS]: https://en.wikipedia.org/wiki/Transport_Layer_Security
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

77
doc/developer.rst
View File

@ -15,17 +15,18 @@ Dependencies
============
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ runtime. Since that time OpenSSL
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support TLS_ encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout.
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
Portability
===========
The E-MailRelay code is mostly written in C++-1998, but using some features of
C++-2011. A C++-1998 compiler can be used, but multi-threading will be disabled.
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The header files *gdef.h* in *src/glib* is used to fix up some compiler
portability issues such as missing standard types, non-standard system headers
@ -45,11 +46,11 @@ alternatives.
Event model
===========
The E-MailRelay server uses non-blocking socket i/o, with a select() event loop.
This event model means that the server can handle multiple network connections
simultaneously from a single thread, and even if multi-threading is disabled at
build-time the only blocking occurs when external programs are executed (see
*--filter* and *--address-verifier*).
The E-MailRelay server uses non-blocking socket i/o, with a select() or epoll()
event loop. This event model means that the server can handle multiple network
connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see *--filter* and *--address-verifier*).
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
@ -163,14 +164,16 @@ identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
The combination of an exception handler and the optional exception source
pointer bound to it is known as an *ExceptionSink*.
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Multi-threading
===============
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if std::thread is available then it
is used in a future/promise pattern to wrap up *getaddrinfo()* and *waitpid()*
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up *getaddrinfo()* and *waitpid()*
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see *GNet::FutureEvent*).
@ -200,10 +203,25 @@ When run in configure mode the GUI normally ends up simply editing the
*emailrelay.auth* secrets file.
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. (The payload used to be a single
archive file appended to the executable, but it is now simple directory
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
bundle.)
bundle, and it contains a configuration file to tell the installer where
to copy its files.
Windows build
=============
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (\ *winbuild.pl*\ ) that creates
*cmake* files from the autotools makefiles, runs *cmake* to create the MSVC
project files and then runs *msbuild* to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
*winbuild.bat* batch file should be able to do a complete MSVC release build
in one go.
For MinGW cross-builds use *./configure.sh -m* and *make* on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running *dumpbin /dependents* in the normal
way.
Windows packaging
=================
@ -215,6 +233,10 @@ again, and while this duplication is not ideal it is at least straightforward.
The Qt tool *windeployqt* is used to add run-time dependencies, such as the
Qt DLLs.
To target ancient versions of Windows start with a cross-build using MinGW;
then *winbuild.pl mingw* can be used to assemble a slimmed-down package for
distribution.
Unix packaging
==============
On Unix-like operating systems it is more natural to use some sort of package
@ -224,6 +246,19 @@ the emailrelay GUI is not normally used.
Top-level makefile targets *dist*, *deb* and *rpm* can be used to create a
binary tarball, a debian package, and an RPM package respectively.
Internationalisation
====================
The GUI code has i18n support using the Qt framework, with the tr() function
used throughout the GUI source code. The GUI main() function loads translations
from the *translations* sub-directory (relative to the executable), although
that can be overridden with the *--qm* command-line option. Qt's *-reverse*
option can also be used to reverse the widgets when using RTL languages.
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option (\ *--with-gettext*\ ) to enable it at build-time and
a *--localedir* option at run-time. See also *po/Makefile.am*.
Source control
==============
The source code is stored in the SourceForge *svn* repository. A working
@ -238,12 +273,14 @@ Compile-time features
Compile-time features can be selected with options passed to the *configure*
script. These include the following:
* Debug-level logging (\ *--enable-debug*\ )
* Configuration GUI (\ *--enable-gui*\ )
* Multi-threading (\ *--enable-std-thread*\ )
* TLS library (\ *--with-openssl*\ , *--with-mbedtls*)
* Debug-level logging (\ *--enable-debug*\ )
* Event loop using epoll (\ *--enable-epoll*\ )
* PAM_ support (\ *--with-pam*\ )
Use *./configure --help* to see a complete list of options and refer to
*acinclude.m4* for more detailed comments.
Use *./configure --help* to see a complete list of options.
@ -253,4 +290,4 @@ Use *./configure --help* to see a complete list of options and refer to
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. footer:: Copyright (C) 2001-2019 Graeme Walker
.. footer:: Copyright (C) 2001-2021 Graeme Walker

77
doc/developer.txt
View File

@ -13,17 +13,18 @@ Dependencies
------------
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ runtime. Since that time OpenSSL
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support TLS encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout.
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
Portability
-----------
The E-MailRelay code is mostly written in C++-1998, but using some features of
C++-2011. A C++-1998 compiler can be used, but multi-threading will be disabled.
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The header files "gdef.h" in "src/glib" is used to fix up some compiler
portability issues such as missing standard types, non-standard system headers
@ -43,11 +44,11 @@ alternatives.
Event model
-----------
The E-MailRelay server uses non-blocking socket i/o, with a select() event loop.
This event model means that the server can handle multiple network connections
simultaneously from a single thread, and even if multi-threading is disabled at
build-time the only blocking occurs when external programs are executed (see
"--filter" and "--address-verifier").
The E-MailRelay server uses non-blocking socket i/o, with a select() or epoll()
event loop. This event model means that the server can handle multiple network
connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see "--filter" and "--address-verifier").
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
@ -155,14 +156,16 @@ identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
The combination of an exception handler and the optional exception source
pointer bound to it is known as an "ExceptionSink".
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Multi-threading
---------------
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if std::thread is available then it
is used in a future/promise pattern to wrap up "getaddrinfo()" and "waitpid()"
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up "getaddrinfo()" and "waitpid()"
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see "GNet::FutureEvent").
@ -192,10 +195,25 @@ When run in configure mode the GUI normally ends up simply editing the
"emailrelay.auth" secrets file.
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. (The payload used to be a single
archive file appended to the executable, but it is now simple directory
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
bundle.)
bundle, and it contains a configuration file to tell the installer where
to copy its files.
Windows build
-------------
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script ("winbuild.pl") that creates
"cmake" files from the autotools makefiles, runs "cmake" to create the MSVC
project files and then runs "msbuild" to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
"winbuild.bat" batch file should be able to do a complete MSVC release build
in one go.
For MinGW cross-builds use "./configure.sh -m" and "make" on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running "dumpbin /dependents" in the normal
way.
Windows packaging
-----------------
@ -207,6 +225,10 @@ again, and while this duplication is not ideal it is at least straightforward.
The Qt tool "windeployqt" is used to add run-time dependencies, such as the
Qt DLLs.
To target ancient versions of Windows start with a cross-build using MinGW;
then "winbuild.pl mingw" can be used to assemble a slimmed-down package for
distribution.
Unix packaging
--------------
On Unix-like operating systems it is more natural to use some sort of package
@ -216,6 +238,19 @@ the emailrelay GUI is not normally used.
Top-level makefile targets "dist", "deb" and "rpm" can be used to create a
binary tarball, a debian package, and an RPM package respectively.
Internationalisation
--------------------
The GUI code has i18n support using the Qt framework, with the tr() function
used throughout the GUI source code. The GUI main() function loads translations
from the "translations" sub-directory (relative to the executable), although
that can be overridden with the "--qm" command-line option. Qt's "-reverse"
option can also be used to reverse the widgets when using RTL languages.
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option ("--with-gettext") to enable it at build-time and
a "--localedir" option at run-time. See also "po/Makefile.am".
Source control
--------------
The source code is stored in the SourceForge "svn" repository. A working
@ -228,14 +263,16 @@ Compile-time features
Compile-time features can be selected with options passed to the "configure"
script. These include the following:
* Debug-level logging ("--enable-debug")
* Configuration GUI ("--enable-gui")
* Multi-threading ("--enable-std-thread")
* TLS library ("--with-openssl", "--with-mbedtls")
* Debug-level logging ("--enable-debug")
* Event loop using epoll ("--enable-epoll")
* PAM support ("--with-pam")
Use "./configure --help" to see a complete list of options and refer to
"acinclude.m4" for more detailed comments.
Use "./configure --help" to see a complete list of options.
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

2
doc/doxygen-missing.html
View File

@ -11,4 +11,4 @@
</div>
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

4
doc/doxygen.cfg.in
View File

@ -913,7 +913,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = *_win32*
EXCLUDE_PATTERNS = *_none* *_win32* *_basic* *_mac* *_mbedtls* *_ipv4* *_ip.cpp *_both* *_epoll*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@ -2143,7 +2143,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = G_DOXYGEN=1 G_UNIX=1 __cplusplus=201400 G_EXCEPTION()= G_EXCEPTION_CLASS()= G_CONSTANT()= g__enum(x)="enum x" g__enum_end=";" __declspec__(x)= __attribute__(x)=
PREDEFINED = G_DOXYGEN=1 G_UNIX=1 __cplusplus=201400 G_EXCEPTION()= G_EXCEPTION_CLASS()= __declspec__(x)= __attribute__(x)=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The

2
doc/emailrelay-doxygen.css
View File

@ -1,5 +1,5 @@
/*
Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
*/
/*

13
doc/emailrelay-filter-copy.1
View File

@ -1,15 +1,15 @@
.\" Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.TH EMAILRELAY-FILTER-COPY 1 local
@ -47,7 +47,10 @@ forwarding.
When using
.I "-d"
all envelope files in the spool directory are copied to all
sub-directories.
sub-directories. This should be used after using
.B emailrelay-submit
has deposited an envelope file into the main spool
directory, or perhaps periodically from cron.
.SH SEE ALSO
.BR emailrelay (1),
.SH AUTHOR

47
doc/emailrelay-man.html
View File

@ -1,5 +1,6 @@
<HTML><HEAD><TITLE>Manpage of EMAILRELAY</TITLE>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of EMAILRELAY</TITLE>
</HEAD><BODY>
<H1>EMAILRELAY</H1>
Section: User Commands (1)<BR>Updated: local<BR><A HREF="#index">Index</A>
@ -102,11 +103,11 @@ Enables SMTP client authentication with the remote server, using the client acco
<DT><B>--client-auth-config </B><I>&lt;config&gt;</I>
<DD>
Configures the SMTP client authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces an ordered list of authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
Configures the SMTP client authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces an ordered list of authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
<DT><B>-Y, --client-filter </B><I>&lt;program&gt;</I>
<DD>
Runs the specified external filter program whenever a mail message is forwarded. The filter is passed the name of the message file in the spool directory so that it can edit it as required. A network filter can be specified as <I>net:&lt;transport-address&gt;</I> and prefixes of <I>spam:</I>, <I>spam-edit:</I> and <I>exit:</I> are also allowed. The <I>--filter</I> option is normally more useful than <I>--client-filter</I>.
Runs the specified external filter program whenever a mail message is forwarded. The filter is passed the name of the message file in the spool directory so that it can edit it as required. A network filter can be specified as <I>net:&lt;transport-address&gt;</I> and prefixes of <I>spam:</I>, <I>spam-edit:</I> and <I>exit:</I> are also allowed. The <I>spam:</I> and <I>spam-edit:</I> prefixes require a SpamAssassin daemon to be running. For store-and-forward applications the <I>--filter</I> option is normally more useful than <I>--client-filter</I>.
<DT><B>-6, --client-interface </B><I>&lt;ip-address&gt;</I>
<DD>
@ -154,7 +155,7 @@ Enables debug level logging, if built in. Debug messages are usually only useful
<DT><B>--dnsbl </B><I>&lt;config&gt;</I>
<DD>
Specifies a list of DNSBL servers that are used to reject SMTP connections from blocked addresses. The configuration string is made up of comma-separated fields: the DNS server's transport address, a timeout in milliseconds, a rejection threshold, and then the list of DNSBL servers.
Specifies a list of DNSBL servers that are used to reject SMTP connections from blocked addresses. The configuration string is made up of comma-separated fields: the DNS server's transport address, a timeout in milliseconds, a rejection threshold, and then the list of DNSBL servers.
<DT><B>-D, --domain </B><I>&lt;fqdn&gt;</I>
<DD>
@ -166,7 +167,7 @@ Disables all network serving, including SMTP, POP and administration interfaces.
<DT><B>-z, --filter </B><I>&lt;program&gt;</I>
<DD>
Runs the specified external filter program whenever a mail message is stored. The filter is passed the name of the message file in the spool directory so that it can edit it as required. The mail message is rejected if the filter program terminates with an exit code between 1 and 99. Use <I>net:&lt;transport-address&gt;</I> to communicate with a filter daemon over the network, or <I>spam:&lt;transport-address&gt;</I> for a spamassassin spamd daemon to accept or reject mail messages, or <I>spam-edit:&lt;transport-address&gt;</I> to have spamassassin edit the message content without rejecting it, or <I>exit:&lt;number&gt;</I> to emulate a filter program that just exits.
Runs the specified external filter program whenever a mail message is stored. The filter is passed the name of the message file in the spool directory so that it can edit it as required. The mail message is rejected if the filter program terminates with an exit code between 1 and 99. Use <I>net:&lt;transport-address&gt;</I> to communicate with a filter daemon over the network, or <I>spam:&lt;transport-address&gt;</I> for a spamassassin spamd daemon to accept or reject mail messages, or <I>spam-edit:&lt;transport-address&gt;</I> to have spamassassin edit the message content without rejecting it, or <I>exit:&lt;number&gt;</I> to emulate a filter program that just exits.
<DT><B>-W, --filter-timeout </B><I>&lt;time&gt;</I>
<DD>
@ -183,6 +184,10 @@ Causes spooled mail messages to be forwarded whenever a SMTP client connection d
<DD>
Specifies the transport address of the remote SMTP server that is use for mail message forwarding.
<DT><B>--forward-to-some</B>
<DD>
Allow forwarding to continue even if some recipient addresses on an e-mail envelope are rejected by the remote server.
<DT><B>-h, --help</B>
<DD>
@ -190,23 +195,31 @@ Displays help text and then exits. Use with <I>--verbose</I> for more complete o
<DT><B>-H, --hidden</B>
<DD>
Windows only. Hides the application window and disables all message boxes. This is useful when running as a windows service.
Windows only. Hides the application window and disables all message boxes, overriding any <I></I><I>--show</I><I></I> option. This is useful when running as a windows service.
<DT><B>--idle-timeout </B><I>&lt;time&gt;</I>
<DD>
Specifies a timeout (in seconds) for receiving network traffic from remote SMTP and POP clients. The default is 1800 seconds.
Specifies a timeout (in seconds) for receiving network traffic from remote SMTP and POP clients. The default is 1800 seconds.
<DT><B>-m, --immediate</B>
<DD>
Causes mail messages to be forwarded as they are received, even before they have been accepted. This can be used to do proxying without store-and-forward, but in practice clients tend to to time out while waiting for their mail message to be accepted.
Causes mail messages to be forwarded as they are received, even before they have been accepted. This can be used to do proxying without store-and-forward, but in practice clients tend to to time out while waiting for their mail message to be accepted.
<DT><B>-I, --interface </B><I>&lt;ip-address-list&gt;</I>
<DD>
Specifies the IP network addresses used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. <I>0.0.0.0</I> and <I>::</I>. Use this option to limit listening to particular addresses (and by implication to particular network interfaces). Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of <I>smtp=</I>, <I>pop=</I> or <I>admin=</I> on addresses that should apply only to those types of listening port.
Specifies the IP network addresses or interface names used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. <I>0.0.0.0</I> and <I>::</I>. Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of <I>smtp=</I>, <I>pop=</I> or <I>admin=</I> on addresses that should apply only to those types of listening port. Any link-local IPv6 addresses must include a zone name or scope id. Interface names can be used instead of addresses, in which case all the addresses associated with that interface at startup will used for listening. When an interface name is decorated with a <I>-ipv4</I> or <I>-ipv6</I> suffix only their IPv4 or IPv6 addresses will be used (eg. <I>ppp0-ipv4</I>).
<DT><B>--localedir </B><I>&lt;dir&gt;</I>
<DD>
Specifies a locale base directory where localisation message catalogues can be found. An empty directory can be used for the built-in default.
<DT><B>-l, --log</B>
<DD>
Enables logging to the standard error stream and to the syslog. The <I>--close-stderr</I> and <I>--no-syslog</I> options can be used to disable output to standard error stream and the syslog separately. Note that <I>--as-server</I>, <I>--as-client</I> and <I>--as-proxy</I> imply <I>--log</I>, and <I>--as-server</I> and <I>--as-proxy</I> also imply <I>--close-stderr</I>.
<DT><B>--log-address</B>
<DD>
Adds the network address of remote clients to the logging output.
<DT><B>-N, --log-file </B><I>&lt;file&gt;</I>
<DD>
@ -246,7 +259,7 @@ Specifies a file containing valid POP account details. The file format is the sa
<DT><B>-J, --pop-by-name</B>
<DD>
Modifies the spool directory used by the POP server to be a sub-directory with the same name as the POP authentication user-id. This allows multiple POP clients to read the spooled messages without interfering with each other, particularly when also using <I>--pop-no-delete</I>. Content files can stay in the main spool directory with only the envelope files copied into user-specific sub-directories. The <I>emailrelay-filter-copy</I> program is a convenient way of doing this when run via <I>--filter</I>.
Modifies the spool directory used by the POP server to be a sub-directory with the same name as the POP authentication user-id. This allows multiple POP clients to read the spooled messages without interfering with each other, particularly when also using <I>--pop-no-delete</I>. Content files can stay in the main spool directory with only the envelope files copied into user-specific sub-directories. The <I>emailrelay-filter-copy</I> program is a convenient way of doing this when run via <I>--filter</I>.
<DT><B>-G, --pop-no-delete</B>
<DD>
@ -266,7 +279,7 @@ Specifies a timeout (in seconds) for getting the initial prompt from a remote SM
<DT><B>-r, --remote-clients</B>
<DD>
Allows incoming connections from addresses that are not local. The default behaviour is to ignore connections that are not local in order to prevent accidental exposure to the public internet, but a firewall should also be used. The definition of 'local' is different for IPv4 and IPv6.
Allows incoming connections from addresses that are not local. The default behaviour is to reject connections that are not local in order to prevent accidental exposure to the public internet, although a firewall should also be used. Local address ranges are defined in RFC-1918, RFC-6890 etc.
<DT><B>-T, --response-timeout </B><I>&lt;time&gt;</I>
<DD>
@ -278,7 +291,7 @@ Enables SMTP server authentication of remote SMTP clients. Account names and pas
<DT><B>--server-auth-config </B><I>&lt;config&gt;</I>
<DD>
Configures the SMTP server authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces a preferred sub-set of the built-in authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
Configures the SMTP server authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces a preferred sub-set of the built-in authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
<DT><B>-K, --server-tls</B>
<DD>
@ -287,6 +300,10 @@ Enables TLS for incoming SMTP and POP connections. SMTP clients can then request
<DD>
Defines the TLS certificate file when acting as a SMTP or POP server. This file must contain the server's private key and certificate chain using the PEM file format. Keep the file permissions tight to avoid accidental exposure of the private key.
<DT><B>--server-tls-connection</B>
<DD>
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
<DT><B>--server-tls-required</B>
<DD>
@ -303,14 +320,14 @@ Limits the size of mail messages that can be submitted over SMTP.
<DD>
Specifies the directory used for holding mail messages that have been received but not yet forwarded.
<DT><B>-k, --syslog</B>
<DT><B>-k, --syslog, --syslog=</B><I>&lt;facility&gt;</I>
<DD>
When used with <I>--log</I> this option enables logging to the syslog even if the <I>--no-syslog</I> option is also used. This is typically used as a convenient override when using <I>--as-client</I>.
<DT><B>-9, --tls-config </B><I>&lt;options&gt;</I>
<DD>
Selects and configures the low-level TLS library, using a comma-separated list of keywords. If OpenSSL and mbedTLS are both built in then keywords of <I>openssl</I> and <I>mbedtls</I> will select one or the other. Keywords like <I>tlsv1.0</I> can be used to set a minimum TLS protocol version, or <I>-tlsv1.2</I> to set a maximum version.
Selects and configures the low-level TLS library, using a comma-separated list of keywords. If OpenSSL and mbedTLS are both built in then keywords of <I>openssl</I> and <I>mbedtls</I> will select one or the other. Keywords like <I>tlsv1.0</I> can be used to set a minimum TLS protocol version, or <I>-tlsv1.2</I> to set a maximum version.
<DT><B>-u, --user </B><I>&lt;username&gt;</I>
<DD>
@ -353,4 +370,4 @@ This document was created by
using the manual pages.<BR>
</BODY>
</HTML>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

23
doc/emailrelay-passwd.1
View File

@ -1,15 +1,15 @@
.\" Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.TH EMAILRELAY-PASSWD 1 local
@ -39,21 +39,6 @@ server md5 alice Oqng9/H7wAyKgbuqw5VzG1bNO6feqtblyiNEi6QuN5dH
.br
server md5 bob Ot6SDdGj23eWjdEuKICgN8Nj9z/Vx9IV3ISz9VvmnaUB
.SH OPTIONS
.TP
.B \-b, --base64
Interpret the input password as base64 encoded.
.TP
.B \-d, --dotted
Generate a dotted decimal format, for backwards compatibility.
.TP
.B \-H, --hash \fI<function>\fR
Specifies the hash function, such as MD5 or SHA1. MD5 is the default, and a hash function of NONE does simple xtext encoding. Other hash function may or may not be available, depending on the build.
.TP
.B \-h, --help
Shows help and exits.
.TP
.B \-p, --password \fI<pwd>\fR
Specifies the password to be hashed. Beware of leaking sensitive passwords via command-line history or the process-table when using this option.
.SH SEE ALSO
.BR emailrelay (1),
.BR emailrelay-submit (1),

9
doc/emailrelay-submit.1
View File

@ -1,15 +1,15 @@
.\" Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.TH EMAILRELAY-SUBMIT 1 local
@ -35,7 +35,6 @@ The verbose option causes the path of the new content file
to be printed.
.SH SEE ALSO
.BR emailrelay (1),
.BR emailrelay-poke (1),
.BR emailrelay-passwd (1)
.SH AUTHOR
Graeme Walker, mailto:graeme_walker@users.sourceforge.net

46
doc/emailrelay.1
View File

@ -1,15 +1,15 @@
.\" Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.TH EMAILRELAY 1 local
@ -77,10 +77,10 @@ This is equivalent to \fI--log\fR and \fI--close-stderr\fR. It is a convenient w
Enables SMTP client authentication with the remote server, using the client account details taken from the specified secrets file. The secrets file should normally contain one line that starts with \fIclient\fR and that line should have between four and five space-separated fields; the second field is the password encoding (\fIplain\fR or \fImd5\fR), the third is the user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by \fIemailrelay-passwd\fR. If the remote server does not support SMTP authentication then the SMTP connection will fail.
.TP
.B --client-auth-config \fI<config>\fR
Configures the SMTP client authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces an ordered list of authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
Configures the SMTP client authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces an ordered list of authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
.TP
.B \-Y, --client-filter \fI<program>\fR
Runs the specified external filter program whenever a mail message is forwarded. The filter is passed the name of the message file in the spool directory so that it can edit it as required. A network filter can be specified as \fInet:<transport-address>\fR and prefixes of \fIspam:\fR, \fIspam-edit:\fR and \fIexit:\fR are also allowed. The \fI--filter\fR option is normally more useful than \fI--client-filter\fR.
Runs the specified external filter program whenever a mail message is forwarded. The filter is passed the name of the message file in the spool directory so that it can edit it as required. A network filter can be specified as \fInet:<transport-address>\fR and prefixes of \fIspam:\fR, \fIspam-edit:\fR and \fIexit:\fR are also allowed. The \fIspam:\fR and \fIspam-edit:\fR prefixes require a SpamAssassin daemon to be running. For store-and-forward applications the \fI--filter\fR option is normally more useful than \fI--client-filter\fR.
.TP
.B \-6, --client-interface \fI<ip-address>\fR
Specifies the IP network address to be used to bind the local end of outgoing SMTP connections. By default the address will depend on the routing tables in the normal way. Use \fI0.0.0.0\fR to use only IPv4 addresses returned from DNS lookups of the \fI--forward-to\fR address, or \fI::\fR for IPv6.
@ -116,7 +116,7 @@ Specifies a timeout (in seconds) for establishing a TCP connection to remote SMT
Enables debug level logging, if built in. Debug messages are usually only useful when cross-referenced with the source code and they may expose plaintext passwords and mail message content.
.TP
.B --dnsbl \fI<config>\fR
Specifies a list of DNSBL servers that are used to reject SMTP connections from blocked addresses. The configuration string is made up of comma-separated fields: the DNS server's transport address, a timeout in milliseconds, a rejection threshold, and then the list of DNSBL servers.
Specifies a list of DNSBL servers that are used to reject SMTP connections from blocked addresses. The configuration string is made up of comma-separated fields: the DNS server's transport address, a timeout in milliseconds, a rejection threshold, and then the list of DNSBL servers.
.TP
.B \-D, --domain \fI<fqdn>\fR
Specifies the network name that is used in SMTP EHLO commands, \fIReceived\fR lines, and for generating authentication challenges. The default is derived from a DNS lookup of the local hostname.
@ -125,7 +125,7 @@ Specifies the network name that is used in SMTP EHLO commands, \fIReceived\fR li
Disables all network serving, including SMTP, POP and administration interfaces. The program will terminate as soon as any initial forwarding is complete.
.TP
.B \-z, --filter \fI<program>\fR
Runs the specified external filter program whenever a mail message is stored. The filter is passed the name of the message file in the spool directory so that it can edit it as required. The mail message is rejected if the filter program terminates with an exit code between 1 and 99. Use \fInet:<transport-address>\fR to communicate with a filter daemon over the network, or \fIspam:<transport-address>\fR for a spamassassin spamd daemon to accept or reject mail messages, or \fIspam-edit:<transport-address>\fR to have spamassassin edit the message content without rejecting it, or \fIexit:<number>\fR to emulate a filter program that just exits.
Runs the specified external filter program whenever a mail message is stored. The filter is passed the name of the message file in the spool directory so that it can edit it as required. The mail message is rejected if the filter program terminates with an exit code between 1 and 99. Use \fInet:<transport-address>\fR to communicate with a filter daemon over the network, or \fIspam:<transport-address>\fR for a spamassassin spamd daemon to accept or reject mail messages, or \fIspam-edit:<transport-address>\fR to have spamassassin edit the message content without rejecting it, or \fIexit:<number>\fR to emulate a filter program that just exits.
.TP
.B \-W, --filter-timeout \fI<time>\fR
Specifies a timeout (in seconds) for running a \fI--filter\fR program. The default is 300 seconds.
@ -139,24 +139,33 @@ Causes spooled mail messages to be forwarded whenever a SMTP client connection d
.B \-o, --forward-to \fI<host:port>\fR
Specifies the transport address of the remote SMTP server that is use for mail message forwarding.
.TP
.B --forward-to-some
Allow forwarding to continue even if some recipient addresses on an e-mail envelope are rejected by the remote server.
.TP
.B \-h, --help
Displays help text and then exits. Use with \fI--verbose\fR for more complete output.
.TP
.B \-H, --hidden
Windows only. Hides the application window and disables all message boxes. This is useful when running as a windows service.
Windows only. Hides the application window and disables all message boxes, overriding any \fI\fR\fI--show\fR\fI\fR option. This is useful when running as a windows service.
.TP
.B --idle-timeout \fI<time>\fR
Specifies a timeout (in seconds) for receiving network traffic from remote SMTP and POP clients. The default is 1800 seconds.
Specifies a timeout (in seconds) for receiving network traffic from remote SMTP and POP clients. The default is 1800 seconds.
.TP
.B \-m, --immediate
Causes mail messages to be forwarded as they are received, even before they have been accepted. This can be used to do proxying without store-and-forward, but in practice clients tend to to time out while waiting for their mail message to be accepted.
Causes mail messages to be forwarded as they are received, even before they have been accepted. This can be used to do proxying without store-and-forward, but in practice clients tend to to time out while waiting for their mail message to be accepted.
.TP
.B \-I, --interface \fI<ip-address-list>\fR
Specifies the IP network addresses used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. \fI0.0.0.0\fR and \fI::\fR. Use this option to limit listening to particular addresses (and by implication to particular network interfaces). Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of \fIsmtp=\fR, \fIpop=\fR or \fIadmin=\fR on addresses that should apply only to those types of listening port.
Specifies the IP network addresses or interface names used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. \fI0.0.0.0\fR and \fI::\fR. Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of \fIsmtp=\fR, \fIpop=\fR or \fIadmin=\fR on addresses that should apply only to those types of listening port. Any link-local IPv6 addresses must include a zone name or scope id. Interface names can be used instead of addresses, in which case all the addresses associated with that interface at startup will used for listening. When an interface name is decorated with a \fI-ipv4\fR or \fI-ipv6\fR suffix only their IPv4 or IPv6 addresses will be used (eg. \fIppp0-ipv4\fR).
.TP
.B --localedir \fI<dir>\fR
Specifies a locale base directory where localisation message catalogues can be found. An empty directory can be used for the built-in default.
.TP
.B \-l, --log
Enables logging to the standard error stream and to the syslog. The \fI--close-stderr\fR and \fI--no-syslog\fR options can be used to disable output to standard error stream and the syslog separately. Note that \fI--as-server\fR, \fI--as-client\fR and \fI--as-proxy\fR imply \fI--log\fR, and \fI--as-server\fR and \fI--as-proxy\fR also imply \fI--close-stderr\fR.
.TP
.B --log-address
Adds the network address of remote clients to the logging output.
.TP
.B \-N, --log-file \fI<file>\fR
Redirects standard-error logging to the specified file. Logging to the log file is not affected by \fI--close-stderr\fR. The filename can include \fI%d\fR to get daily log files; the \fI%d\fR is replaced by the current date in the local timezone using a \fIYYYYMMDD\fR format.
.TP
@ -185,7 +194,7 @@ Enables the POP server listening, by default on port 110, providing access to sp
Specifies a file containing valid POP account details. The file format is the same as for the SMTP server secrets file, ie. lines starting with \fIserver\fR, with user-id and password in the third and fourth fields. A special value of \fI/pam\fR can be used for authentication using linux PAM.
.TP
.B \-J, --pop-by-name
Modifies the spool directory used by the POP server to be a sub-directory with the same name as the POP authentication user-id. This allows multiple POP clients to read the spooled messages without interfering with each other, particularly when also using \fI--pop-no-delete\fR. Content files can stay in the main spool directory with only the envelope files copied into user-specific sub-directories. The \fIemailrelay-filter-copy\fR program is a convenient way of doing this when run via \fI--filter\fR.
Modifies the spool directory used by the POP server to be a sub-directory with the same name as the POP authentication user-id. This allows multiple POP clients to read the spooled messages without interfering with each other, particularly when also using \fI--pop-no-delete\fR. Content files can stay in the main spool directory with only the envelope files copied into user-specific sub-directories. The \fIemailrelay-filter-copy\fR program is a convenient way of doing this when run via \fI--filter\fR.
.TP
.B \-G, --pop-no-delete
Disables the POP DELE command so that the command appears to succeed but mail messages are not deleted from the spool directory.
@ -200,7 +209,7 @@ Sets the port number used for listening for incoming SMTP connections.
Specifies a timeout (in seconds) for getting the initial prompt from a remote SMTP server. If no prompt is received after this time then the SMTP dialog goes ahead without it.
.TP
.B \-r, --remote-clients
Allows incoming connections from addresses that are not local. The default behaviour is to ignore connections that are not local in order to prevent accidental exposure to the public internet, but a firewall should also be used. The definition of 'local' is different for IPv4 and IPv6.
Allows incoming connections from addresses that are not local. The default behaviour is to reject connections that are not local in order to prevent accidental exposure to the public internet, although a firewall should also be used. Local address ranges are defined in RFC-1918, RFC-6890 etc.
.TP
.B \-T, --response-timeout \fI<time>\fR
Specifies a timeout (in seconds) for getting responses from remote SMTP servers. The default is 1800 seconds.
@ -209,7 +218,7 @@ Specifies a timeout (in seconds) for getting responses from remote SMTP servers.
Enables SMTP server authentication of remote SMTP clients. Account names and passwords are taken from the specified secrets file. The secrets file should contain lines that have four space-separated fields, starting with \fIserver\fR in the first field; the second field is the password encoding (\fIplain\fR or \fImd5\fR), the third is the client user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by \fIemailrelay-passwd\fR. A special value of \fI/pam\fR can be used for authentication using linux PAM.
.TP
.B --server-auth-config \fI<config>\fR
Configures the SMTP server authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces a preferred sub-set of the built-in authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
Configures the SMTP server authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces a preferred sub-set of the built-in authentication mechanisms, and an 'x' is used for blocklisted mechanisms.
.TP
.B \-K, --server-tls
Enables TLS for incoming SMTP and POP connections. SMTP clients can then request TLS encryption by issuing the STARTTLS command. The \fI--server-tls-certificate\fR option must be used to define the server certificate.
@ -217,6 +226,9 @@ Enables TLS for incoming SMTP and POP connections. SMTP clients can then request
.B --server-tls-certificate \fI<pem-file>\fR
Defines the TLS certificate file when acting as a SMTP or POP server. This file must contain the server's private key and certificate chain using the PEM file format. Keep the file permissions tight to avoid accidental exposure of the private key.
.TP
.B --server-tls-connection
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
.TP
.B --server-tls-required
Makes the use of TLS mandatory for any incoming SMTP and POP connections. SMTP clients must use the STARTTLS command to establish a TLS session before they can issue SMTP AUTH or SMTP MAIL-TO commands.
.TP
@ -229,11 +241,11 @@ Limits the size of mail messages that can be submitted over SMTP.
.B \-s, --spool-dir \fI<dir>\fR
Specifies the directory used for holding mail messages that have been received but not yet forwarded.
.TP
.B \-k, --syslog
.B \-k, --syslog, --syslog=\fI<facility>\fR
When used with \fI--log\fR this option enables logging to the syslog even if the \fI--no-syslog\fR option is also used. This is typically used as a convenient override when using \fI--as-client\fR.
.TP
.B \-9, --tls-config \fI<options>\fR
Selects and configures the low-level TLS library, using a comma-separated list of keywords. If OpenSSL and mbedTLS are both built in then keywords of \fIopenssl\fR and \fImbedtls\fR will select one or the other. Keywords like \fItlsv1.0\fR can be used to set a minimum TLS protocol version, or \fI-tlsv1.2\fR to set a maximum version.
Selects and configures the low-level TLS library, using a comma-separated list of keywords. If OpenSSL and mbedTLS are both built in then keywords of \fIopenssl\fR and \fImbedtls\fR will select one or the other. Keywords like \fItlsv1.0\fR can be used to set a minimum TLS protocol version, or \fI-tlsv1.2\fR to set a maximum version.
.TP
.B \-u, --user \fI<username>\fR
When started as root the program switches to an non-privileged effective user-id when idle. This option can be used to define which user-id is used. Specify \fIroot\fR to disable all user-id switching. Ignored on Windows.

2
doc/emailrelay.css
View File

@ -1,5 +1,5 @@
/*
Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
*/
/*

BIN
doc/forwardto.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 14 KiB

2
doc/forwardto.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

6
doc/index.html
View File

@ -13,11 +13,11 @@
<li><a class="a-href" href="windows.html">Windows guide</a></li>
<li><a class="a-href" href="developer.html">Developer guide</a></li>
<li><a class="a-href" href="changelog.html">Change log</a></li>
<li><a class="a-href" href="doxygen/index.html">Source code documentation</a> (generated by <a class="a-href" href="http://www.doxygen.org">doxygen</a>, if available)</li>
<li><a class="a-href" href="emailrelay-man.html">Man page</a> (generated by man2html, if available)</li>
<li><a class="a-href" href="doxygen/index.html">Source code documentation</a></li>
<li><a class="a-href" href="emailrelay-man.html">Man page</a></li>
<li><a class="a-href" href="http://emailrelay.sourceforge.net">Web site</a></li>
</ul>
</div>
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

46
doc/make-website
View File

@ -1,17 +1,17 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# ===
@ -20,8 +20,9 @@
#
# usage: make-website [--host=<key>] <version-for-download-button>
#
# Pulls together a doxygen-based website. Developed against
# doxygen version 1.8.14.
# Pulls together a doxygen-based website. Requires doxygen and dot
# on the path. Developed against doxygen version 1.8.14.
#
#
use strict ;
@ -35,7 +36,7 @@ die "usage error" if scalar(@ARGV) == 0 ;
my $cfg_upload_version = $ARGV[0] ;
my $cfg_author = "Graeme Walker" ;
my $cfg_copyright = "Copyright (C) 2018 $cfg_author" ;
my $cfg_copyright = "Copyright (C) 2021 $cfg_author" ;
my $cfg_output_dir = "website" ;
my %colour = ( h => 195 , s => 255 , v => 100 ) ; # #0090c0
my %cfg_meta = (
@ -114,13 +115,18 @@ my %config = (
sub make_config
{
my ( $fname ) = @_ ;
my $fh_in = new FileHandle( "doxygen -g - |" ) or die ;
my $fh = new FileHandle( $fname , "w" ) or die ;
# use "doxygen -g" to create a template config file
my $fh_in = new FileHandle( "doxygen -g - |" ) or die "make-website: error: cannot run \"doxygen -g\"\n" ;
# edit the config file according to %config
my $fh = new FileHandle( $fname , "w" ) or die "make-website: error: cannot create file [$fname]\n" ;
my $line_number = 0 ;
while(<$fh_in>)
{
chomp( my $line = $_ ) ;
# check the doxygen version number while we're here
if( $line_number++ == 0 && $line =~ m/^# Doxyfile/ )
{
my ( $a , $b , $c ) = ( $line =~ m/# Doxyfile (\d+).?(\d*).?(\d*)/ ) ;
@ -130,7 +136,7 @@ sub make_config
my $version = $a * 1000000 + $b * 1000 + $c ;
if( $version < 1008014 )
{
warn "warning: doxygen is too old: [$version]: please use 1.8.14 or later" ;
warn "make-website: warning: doxygen is too old: [$version]: please use 1.8.14 or later" ;
}
}
@ -157,7 +163,7 @@ sub make_mainpage_md
print $fh "\\mainpage E-MailRelay\n\n" ;
for my $fname ( @cfg_mainpage )
{
my $fh_in = new FileHandle( $fname , "r" ) or die "cannot open [$fname]" ;
my $fh_in = new FileHandle( $fname , "r" ) or die "make-website: error: cannot open file [$fname]\n" ;
my @lines = () ;
while(<$fh_in>)
{
@ -281,15 +287,27 @@ sub make_pages_md
sub make_header
{
my ( $header_out , $config_in ) = @_ ;
-e $config_in or die ;
my $header_tmp = ".header.$$.tmp" ;
my $footer_tmp = ".footer.$$.tmp" ;
my $layout_tmp = ".layout.$$.tmp" ;
system( "doxygen -w html $header_tmp $footer_tmp $layout_tmp $config_in" ) ;
# the header_out file is referred to in the config, so make sure it exists
{ my $fh = new FileHandle( $header_out , "w" ) or die ; }
# get doxygen to create header, footer and layout files
my $cmd = "doxygen -w html $header_tmp $footer_tmp $layout_tmp $config_in" ;
system( $cmd ) ;
-e $footer_tmp && -e $layout_tmp or die "make-website: error: \"doxygen -w\" failed\n" ;
# discard the generated footer and layout files
unlink( $footer_tmp ) ;
unlink( $layout_tmp ) ;
my $fh_in = new FileHandle( $header_tmp , "r" ) or die ;
# edit the generated header file into the output file
my $fh_in = new FileHandle( $header_tmp , "r" ) or die "make-website: error \"doxygen -w\" did not create a header file\n" ;
my $fh = new FileHandle( "$header_out.tmp" , "w" ) or die ;
my $active = 1 ;
my $seen = 0 ;
@ -456,7 +474,7 @@ sub fixup
sub copy_doxygen_tree
{
my $this_dir = dirname($0) ;
die "no doxygen tree" if ( ! -d "$this_dir/doxygen" ) ;
die "make-website: error: no doxygen tree\n" if ( ! -d "$this_dir/doxygen" ) ;
#if( -d "$this_dir/doxygen" )
{
system( "cp -r $this_dir/doxygen $cfg_output_dir" ) ;

15
doc/man2html-missing.html Normal file
View File

@ -0,0 +1,15 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>E-MailRelay man page unavailable</title>
<link rel="stylesheet" href="emailrelay.css" type="text/css">
</head>
<body>
<div class="div-main">
<h1>E-MailRelay Man Page</h1>
<p>
The E-MailRelay man page is not available as HTML because man2html was not installed.
</div>
</body>
</html>
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

4
doc/readme.html
View File

@ -119,7 +119,7 @@
</p>
<p>
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the <em>--remote-clients</em> option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
</p>
@ -158,4 +158,4 @@
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

2
doc/readme.md
View File

@ -70,7 +70,7 @@ To run E-MailRelay as a [POP][] server without SMTP use `--pop` and `--no-smtp`:
The `emailrelay-submit` utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the `--remote-clients` option, but please
check your firewall settings to make sure this cannot be exploited by spammers.

2
doc/readme.rst
View File

@ -89,7 +89,7 @@ To run E-MailRelay as a POP_ server without SMTP use *--pop* and *--no-smtp*:
The *emailrelay-submit* utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the *--remote-clients* option, but please
check your firewall settings to make sure this cannot be exploited by spammers.

2
doc/readme.txt
View File

@ -64,7 +64,7 @@ To run E-MailRelay as a POP server without SMTP use "--pop" and "--no-smtp":
The "emailrelay-submit" utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the "--remote-clients" option, but please
check your firewall settings to make sure this cannot be exploited by spammers.

172
doc/reference.html
View File

@ -79,10 +79,10 @@
</dd>
<dt>--client-auth-config &lt;config&gt;</dt>
<dd>
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
blocklisted mechanisms.
</dd>
<dt>--client-filter &lt;program&gt; (-Y)</dt>
@ -91,8 +91,10 @@
forwarded. The filter is passed the name of the message file in the spool
directory so that it can edit it as required. A network filter can be
specified as <em>net:<transport-address></em> and prefixes of <em>spam:</em>,
<em>spam-edit:</em> and <em>exit:</em> are also allowed. The <em>--filter</em> option is
normally more useful than <em>--client-filter</em>.
<em>spam-edit:</em> and <em>exit:</em> are also allowed. The <em>spam:</em> and <em>spam-edit:</em>
prefixes require a SpamAssassin daemon to be running. For store-and-forward
applications the <em>--filter</em> option is normally more useful than
<em>--client-filter</em>.
</dd>
<dt>--client-interface &lt;ip-address&gt; (-6)</dt>
<dd>
@ -161,7 +163,7 @@
</dd>
<dt>--dnsbl &lt;config&gt;</dt>
<dd>
Specifies a list of DNSBL servers that are used to reject SMTP connections
Specifies a list of DNSBL servers that are used to reject SMTP connections
from blocked addresses. The configuration string is made up of
comma-separated fields: the DNS server's transport address, a timeout in
milliseconds, a rejection threshold, and then the list of DNSBL servers.
@ -186,9 +188,9 @@
program terminates with an exit code between 1 and 99. Use
<em>net:<transport-address></em> to communicate with a filter daemon over the
network, or <em>spam:<transport-address></em> for a spamassassin spamd daemon to
accept or reject mail messages, or <em>spam-edit:<transport-address></em> to have
spamassassin edit the message content without rejecting it, or
<em>exit:<number></em> to emulate a filter program that just exits.
accept or reject mail messages, or <em>spam-edit:<transport-address></em> to have
spamassassin edit the message content without rejecting it, or
<em>exit:<number></em> to emulate a filter program that just exits.
</dd>
<dt>--filter-timeout &lt;time&gt; (-W)</dt>
<dd>
@ -209,6 +211,11 @@
Specifies the transport address of the remote SMTP server that is use for
mail message forwarding.
</dd>
<dt>--forward-to-some</dt>
<dd>
Allow forwarding to continue even if some recipient addresses on an e-mail
envelope are rejected by the remote server.
</dd>
<dt>--help (-h)</dt>
<dd>
Displays help text and then exits. Use with <em>--verbose</em> for more complete
@ -216,31 +223,40 @@
</dd>
<dt>--hidden (-H)</dt>
<dd>
Windows only. Hides the application window and disables all message boxes.
This is useful when running as a windows service.
Windows only. Hides the application window and disables all message boxes,
overriding any <em></em>--show<em></em> option. This is useful when running as a windows
service.
</dd>
<dt>--idle-timeout &lt;time&gt;</dt>
<dd>
Specifies a timeout (in seconds) for receiving network traffic from remote
Specifies a timeout (in seconds) for receiving network traffic from remote
SMTP and POP clients. The default is 1800 seconds.
</dd>
<dt>--immediate (-m)</dt>
<dd>
Causes mail messages to be forwarded as they are received, even before they
Causes mail messages to be forwarded as they are received, even before they
have been accepted. This can be used to do proxying without
store-and-forward, but in practice clients tend to to time out while
waiting for their mail message to be accepted.
</dd>
<dt>--interface &lt;ip-address-list&gt; (-I)</dt>
<dd>
Specifies the IP network addresses used to bind listening ports. By default
listening ports for incoming SMTP, POP and administration connections will
bind the 'any' address for IPv4 and for IPv6, ie. <em>0.0.0.0</em> and <em>::</em>. Use
this option to limit listening to particular addresses (and by implication
to particular network interfaces). Multiple addresses can be specified by
using the option more than once or by using a comma-separated list. Use a
prefix of <em>smtp=</em>, <em>pop=</em> or <em>admin=</em> on addresses that should apply only
to those types of listening port.
Specifies the IP network addresses or interface names used to bind listening
ports. By default listening ports for incoming SMTP, POP and administration
connections will bind the 'any' address for IPv4 and for IPv6, ie.
<em>0.0.0.0</em> and <em>::</em>. Multiple addresses can be specified by using the option
more than once or by using a comma-separated list. Use a prefix of <em>smtp=</em>,
<em>pop=</em> or <em>admin=</em> on addresses that should apply only to those types of
listening port. Any link-local IPv6 addresses must include a zone name or
scope id. Interface names can be used instead of addresses, in which case
all the addresses associated with that interface at startup will used for
listening. When an interface name is decorated with a <em>-ipv4</em> or <em>-ipv6</em>
suffix only their IPv4 or IPv6 addresses will be used (eg. <em>ppp0-ipv4</em>).
</dd>
<dt>--localedir &lt;dir&gt;</dt>
<dd>
Specifies a locale base directory where localisation message catalogues can
be found. An empty directory can be used for the built-in default.
</dd>
<dt>--log (-l)</dt>
<dd>
@ -250,6 +266,10 @@
<em>--as-client</em> and <em>--as-proxy</em> imply <em>--log</em>, and <em>--as-server</em> and
<em>--as-proxy</em> also imply <em>--close-stderr</em>.
</dd>
<dt>--log-address</dt>
<dd>
Adds the network address of remote clients to the logging output.
</dd>
<dt>--log-file &lt;file&gt; (-N)</dt>
<dd>
Redirects standard-error logging to the specified file. Logging to the log
@ -305,9 +325,9 @@
Modifies the spool directory used by the POP server to be a sub-directory
with the same name as the POP authentication user-id. This allows multiple
POP clients to read the spooled messages without interfering with each
other, particularly when also using <em>--pop-no-delete</em>. Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The <em>emailrelay-filter-copy</em> program is a
other, particularly when also using <em>--pop-no-delete</em>. Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The <em>emailrelay-filter-copy</em> program is a
convenient way of doing this when run via <em>--filter</em>.
</dd>
<dt>--pop-no-delete (-G)</dt>
@ -332,9 +352,9 @@
<dt>--remote-clients (-r)</dt>
<dd>
Allows incoming connections from addresses that are not local. The default
behaviour is to ignore connections that are not local in order to prevent
accidental exposure to the public internet, but a firewall should also be
used. The definition of 'local' is different for IPv4 and IPv6.
behaviour is to reject connections that are not local in order to prevent
accidental exposure to the public internet, although a firewall should also
be used. Local address ranges are defined in RFC-1918, RFC-6890 etc.
</dd>
<dt>--response-timeout &lt;time&gt; (-T)</dt>
<dd>
@ -354,11 +374,11 @@
</dd>
<dt>--server-auth-config &lt;config&gt;</dt>
<dd>
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
</dd>
<dt>--server-tls (-K)</dt>
<dd>
@ -374,6 +394,11 @@
PEM file format. Keep the file permissions tight to avoid accidental
exposure of the private key.
</dd>
<dt>--server-tls-connection</dt>
<dd>
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over
TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
</dd>
<dt>--server-tls-required</dt>
<dd>
Makes the use of TLS mandatory for any incoming SMTP and POP connections.
@ -396,7 +421,7 @@
Specifies the directory used for holding mail messages that have been
received but not yet forwarded.
</dd>
<dt>--syslog (-k)</dt>
<dt>--syslog[=&lt;facility&gt;] (-k)</dt>
<dd>
When used with <em>--log</em> this option enables logging to the syslog even if the
<em>--no-syslog</em> option is also used. This is typically used as a convenient
@ -407,7 +432,7 @@
Selects and configures the low-level TLS library, using a comma-separated
list of keywords. If OpenSSL and mbedTLS are both built in then keywords of
<em>openssl</em> and <em>mbedtls</em> will select one or the other. Keywords like
<em>tlsv1.0</em> can be used to set a minimum TLS protocol version, or <em>-tlsv1.2</em>
<em>tlsv1.0</em> can be used to set a minimum TLS protocol version, or <em>-tlsv1.2</em>
to set a maximum version.
</dd>
<dt>--user &lt;username&gt; (-u)</dt>
@ -493,10 +518,12 @@
</p>
<p>
All recipient e-mail addresses must be accepted by the remote server when
E-MailRelay forwards an e-mail message. If any one recipient is rejected then
the message will be left in the spool directory with a <em>.bad</em> suffix on the
envelope file.
By default all recipient e-mail addresses must be accepted by the remote server
when E-MailRelay forwards an e-mail message. If any one recipient is rejected
then the message will be left in the spool directory with a <em>.bad</em> suffix on
the envelope file. This behaviour can be changed by using <em>--forward-to-some</em>
command-line option so that forwarding will succeed for the valid recipients
and the failed message will contain the invalid ones.
</p>
<h2><a class="a-header" name="SH_1_4">Mail processing</a></h2> <!-- index:2:SH:1:4:Mail processing -->
<p>
@ -884,6 +911,12 @@ server plain carol my+20password
This is sometimes called SMTP-over-TLS or secure SMTP (smtps) or implicit TLS
and it is normally used with port number 465.
</p>
<p>
Similarly, when using <em>--server-tls-connection</em> the E-MailRelay server will
expect all connections to be using TLS from the start, so the whole SMTP
dialogue is encrypted, without the need for <em>STARTTLS</em>.
</p>
<h2><a class="a-header" name="SH_1_7">PAM Authentication</a></h2> <!-- index:2:SH:1:7:PAM Authentication -->
<p>
E-MailRelay on Linux supports the use of PAM (Pluggable Authentication Modules)
@ -973,8 +1006,32 @@ password required pam_deny.so
</pre>
</div><!-- div-pre -->
<p>
A listening address can also be qualified by one of the prefixes <em>smtp=</em>,
<em>pop=</em> or <em>admin=</em> so that it is only used in that context.
On some systems interface names can be used, in which case all the addresses
associated with that interface are used for listening.
</p>
<p>
Eg:
</p>
<div class="div-pre">
<pre>--interface eth0
</pre>
</div><!-- div-pre -->
<p>
The interface name can have a <em>-ipv4</em> or <em>-ipv6</em> suffix to limit the listening
addresses to one address family.
</p>
<p>
Eg:
</p>
<div class="div-pre">
<pre>--interface eth0-ipv4
</pre>
</div><!-- div-pre -->
<p>
The <em>--interface</em> option can also have one of the prefixes <em>smtp=</em>, <em>pop=</em> or
<em>admin=</em> so that it is only used in that context.
</p>
<p>
@ -982,6 +1039,7 @@ password required pam_deny.so
</p>
<div class="div-pre">
<pre>--interface smtp=192.168.0.1 --interface pop=127.0.0.1 --interface admin=127.0.0.1
--interface smtp=eth0-ipv4,pop=eth1-ipv6
</pre>
</div><!-- div-pre -->
<p>
@ -1081,7 +1139,7 @@ password required pam_deny.so
</p>
<p>
For future-proofing a verifier must report a version number of <em>2.0</em> if called
For future-proofing a verifier should report a version number of <em>2.0</em> if called
with a command-line starting with <em>--emailrelay-version</em>.
</p>
@ -1124,7 +1182,8 @@ exit 0
<p>
For invalid addresses the exit value should be non-zero and the first line
of output is the error response.
of output is the error response. A second output line can be used for
diagnostic information that gets put into the E-MailRelay log file.
</p>
<div class="div-pre">
@ -1156,6 +1215,11 @@ exit 3
exit 100
</pre>
</div><!-- div-pre -->
<p>
Any other exit code, from 4 to 99 or 101 and above, behaves in the same way
as an exit code of 2.
</p>
<p>
In this more complete example the verifier script accepts all addresses as
valid as long as they contain an <em>at</em> character:
@ -1241,7 +1305,7 @@ catch( e )
send address verification requests as lines with pipe-delimited fields. The
expected response is another pipe-delimited line containing the same
information as returned by verifier scripts but in reverse, such as
<em>3|address unavailable</em> or <em>0|postmaster|Local Postmaster <postmaster@eg.com></em>.
<em>0|postmaster|Local Postmaster <postmaster@eg.com></em> or <em>2|mailbox unavailable</em>.
</p>
<h2><a class="a-header" name="SH_1_11">Connection blocking</a></h2> <!-- index:2:SH:1:11:Connection blocking -->
<p>
@ -1259,8 +1323,8 @@ catch( e )
</p>
<p>
The <em>--dnsbl</em> configuration starts with the DNS server network address and a
millisond timeout, followed by the threshold and list of servers:
The <em>--dnsbl</em> configuration starts with the DNS server transport address and a
millisecond timeout, followed by the threshold and list of servers:
</p>
<div class="div-pre">
@ -1275,8 +1339,8 @@ catch( e )
<p>
If the timeout period expires before a collective decision is reached then the
connection is allowed. This default behaviour can be changed by using a negative
timeout, but for finer control use a DNSBL proxy.
connection is allowed by default. This default behaviour can be changed by
using a negative timeout, but for finer control use a DNSBL proxy.
</p>
<p>
@ -1428,6 +1492,7 @@ E-MailRelay> quit
<ul>
<li>--mandir=&lt;dir&gt;</li>
<li>--sbindir=&lt;dir&gt;</li>
<li>--localedir=&lt;dir&gt;</li>
<li>e_bsdinitdir=&lt;dir&gt;</li>
<li>e_docdir=&lt;dir&gt;</li>
<li>e_examplesdir=&lt;dir&gt;</li>
@ -1438,6 +1503,7 @@ E-MailRelay> quit
<li>e_spooldir=&lt;dir&gt;</li>
<li>e_sysconfdir=&lt;dir&gt;</li>
<li>e_rundir=&lt;dir&gt;</li>
<li>e_systemddir=&lt;dir&gt;</li>
</ul>
<p>
@ -1446,8 +1512,8 @@ E-MailRelay> quit
</p>
<p>
For a directory structure conforming more closely to the FHS use this configure
command:
For a directory structure conforming more closely to the File Hierarchy
Standard (FHS) use this configure command:
</p>
<div class="div-pre">
@ -1457,7 +1523,7 @@ E-MailRelay> quit
<p>
It is possible to change the installation root directory after building by
using <em>make DESTDIR=<root> install</em> or <em>DESTDIR=<root> make -e install</em>.
However, this will not affect the default spool directory path built into the
However, this will not change the default spool directory path built into the
scripts and executables so the correct spool directory will have to be
specified at run-time with the <em>--spool-dir</em> command-line option.
</p>
@ -1472,10 +1538,10 @@ E-MailRelay> quit
<div class="div-footer">
<p>
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

156
doc/reference.md
View File

@ -65,10 +65,10 @@ where &lt;option&gt; is:
* \-\-client-auth-config &lt;config&gt;
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
blocklisted mechanisms.
* \-\-client-filter &lt;program&gt; (-Y)
@ -77,8 +77,10 @@ where &lt;option&gt; is:
forwarded. The filter is passed the name of the message file in the spool
directory so that it can edit it as required. A network filter can be
specified as `net:<transport-address>` and prefixes of `spam:`,
`spam-edit:` and `exit:` are also allowed. The `--filter` option is
normally more useful than `--client-filter`.
`spam-edit:` and `exit:` are also allowed. The `spam:` and `spam-edit:`
prefixes require a SpamAssassin daemon to be running. For store-and-forward
applications the `--filter` option is normally more useful than
`--client-filter`.
* \-\-client-interface &lt;ip-address&gt; (-6)
@ -147,7 +149,7 @@ where &lt;option&gt; is:
* \-\-dnsbl &lt;config&gt;
Specifies a list of [DNSBL][] servers that are used to reject SMTP connections
Specifies a list of [DNSBL][] servers that are used to reject SMTP connections
from blocked addresses. The configuration string is made up of
comma-separated fields: the DNS server's transport address, a timeout in
milliseconds, a rejection threshold, and then the list of DNSBL servers.
@ -172,9 +174,9 @@ where &lt;option&gt; is:
program terminates with an exit code between 1 and 99. Use
`net:<transport-address>` to communicate with a filter daemon over the
network, or `spam:<transport-address>` for a spamassassin spamd daemon to
accept or reject mail messages, or `spam-edit:<transport-address>` to have
spamassassin edit the message content without rejecting it, or
`exit:<number>` to emulate a filter program that just exits.
accept or reject mail messages, or `spam-edit:<transport-address>` to have
spamassassin edit the message content without rejecting it, or
`exit:<number>` to emulate a filter program that just exits.
* \-\-filter-timeout &lt;time&gt; (-W)
@ -195,6 +197,11 @@ where &lt;option&gt; is:
Specifies the transport address of the remote SMTP server that is use for
mail message forwarding.
* \-\-forward-to-some
Allow forwarding to continue even if some recipient addresses on an e-mail
envelope are rejected by the remote server.
* \-\-help (-h)
Displays help text and then exits. Use with `--verbose` for more complete
@ -202,31 +209,40 @@ where &lt;option&gt; is:
* \-\-hidden (-H)
Windows only. Hides the application window and disables all message boxes.
This is useful when running as a windows service.
Windows only. Hides the application window and disables all message boxes,
overriding any ``--show`` option. This is useful when running as a windows
service.
* \-\-idle-timeout &lt;time&gt;
Specifies a timeout (in seconds) for receiving network traffic from remote
Specifies a timeout (in seconds) for receiving network traffic from remote
SMTP and POP clients. The default is 1800 seconds.
* \-\-immediate (-m)
Causes mail messages to be forwarded as they are received, even before they
Causes mail messages to be forwarded as they are received, even before they
have been accepted. This can be used to do proxying without
store-and-forward, but in practice clients tend to to time out while
waiting for their mail message to be accepted.
* \-\-interface &lt;ip-address-list&gt; (-I)
Specifies the IP network addresses used to bind listening ports. By default
listening ports for incoming SMTP, POP and administration connections will
bind the 'any' address for IPv4 and for IPv6, ie. `0.0.0.0` and `::`. Use
this option to limit listening to particular addresses (and by implication
to particular network interfaces). Multiple addresses can be specified by
using the option more than once or by using a comma-separated list. Use a
prefix of `smtp=`, `pop=` or `admin=` on addresses that should apply only
to those types of listening port.
Specifies the IP network addresses or interface names used to bind listening
ports. By default listening ports for incoming SMTP, POP and administration
connections will bind the 'any' address for IPv4 and for IPv6, ie.
`0.0.0.0` and `::`. Multiple addresses can be specified by using the option
more than once or by using a comma-separated list. Use a prefix of `smtp=`,
`pop=` or `admin=` on addresses that should apply only to those types of
listening port. Any link-local IPv6 addresses must include a zone name or
scope id. Interface names can be used instead of addresses, in which case
all the addresses associated with that interface at startup will used for
listening. When an interface name is decorated with a `-ipv4` or `-ipv6`
suffix only their IPv4 or IPv6 addresses will be used (eg. `ppp0-ipv4`).
* \-\-localedir &lt;dir&gt;
Specifies a locale base directory where localisation message catalogues can
be found. An empty directory can be used for the built-in default.
* \-\-log (-l)
@ -236,6 +252,10 @@ where &lt;option&gt; is:
`--as-client` and `--as-proxy` imply `--log`, and `--as-server` and
`--as-proxy` also imply `--close-stderr`.
* \-\-log-address
Adds the network address of remote clients to the logging output.
* \-\-log-file &lt;file&gt; (-N)
Redirects standard-error logging to the specified file. Logging to the log
@ -291,9 +311,9 @@ where &lt;option&gt; is:
Modifies the spool directory used by the POP server to be a sub-directory
with the same name as the POP authentication user-id. This allows multiple
POP clients to read the spooled messages without interfering with each
other, particularly when also using `--pop-no-delete`. Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The `emailrelay-filter-copy` program is a
other, particularly when also using `--pop-no-delete`. Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The `emailrelay-filter-copy` program is a
convenient way of doing this when run via `--filter`.
* \-\-pop-no-delete (-G)
@ -318,9 +338,9 @@ where &lt;option&gt; is:
* \-\-remote-clients (-r)
Allows incoming connections from addresses that are not local. The default
behaviour is to ignore connections that are not local in order to prevent
accidental exposure to the public internet, but a firewall should also be
used. The definition of 'local' is different for IPv4 and IPv6.
behaviour is to reject connections that are not local in order to prevent
accidental exposure to the public internet, although a firewall should also
be used. Local address ranges are defined in [RFC-1918][], RFC-6890 etc.
* \-\-response-timeout &lt;time&gt; (-T)
@ -340,11 +360,11 @@ where &lt;option&gt; is:
* \-\-server-auth-config &lt;config&gt;
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
* \-\-server-tls (-K)
@ -360,6 +380,11 @@ where &lt;option&gt; is:
PEM file format. Keep the file permissions tight to avoid accidental
exposure of the private key.
* \-\-server-tls-connection
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over
TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
* \-\-server-tls-required
Makes the use of TLS mandatory for any incoming SMTP and POP connections.
@ -382,7 +407,7 @@ where &lt;option&gt; is:
Specifies the directory used for holding mail messages that have been
received but not yet forwarded.
* \-\-syslog (-k)
* \-\-syslog[=&lt;facility&gt;] (-k)
When used with `--log` this option enables logging to the syslog even if the
`--no-syslog` option is also used. This is typically used as a convenient
@ -393,7 +418,7 @@ where &lt;option&gt; is:
Selects and configures the low-level TLS library, using a comma-separated
list of keywords. If OpenSSL and mbedTLS are both built in then keywords of
`openssl` and `mbedtls` will select one or the other. Keywords like
`tlsv1.0` can be used to set a minimum TLS protocol version, or `-tlsv1.2`
`tlsv1.0` can be used to set a minimum TLS protocol version, or `-tlsv1.2`
to set a maximum version.
* \-\-user &lt;username&gt; (-u)
@ -459,10 +484,12 @@ When using `--as-client`, or `--dont-serve` and `--forward`, the spooled
messages begin to be forwarded as soon as the program starts up, and the
program terminates once they have all been sent.
All recipient e-mail addresses must be accepted by the remote server when
E-MailRelay forwards an e-mail message. If any one recipient is rejected then
the message will be left in the spool directory with a `.bad` suffix on the
envelope file.
By default all recipient e-mail addresses must be accepted by the remote server
when E-MailRelay forwards an e-mail message. If any one recipient is rejected
then the message will be left in the spool directory with a `.bad` suffix on
the envelope file. This behaviour can be changed by using `--forward-to-some`
command-line option so that forwarding will succeed for the valid recipients
and the failed message will contain the invalid ones.
Mail processing
---------------
@ -755,6 +782,10 @@ the whole SMTP dialog is encrypted from the start (`--client-tls-connection`).
This is sometimes called SMTP-over-TLS or secure SMTP (smtps) or implicit TLS
and it is normally used with port number 465.
Similarly, when using `--server-tls-connection` the E-MailRelay server will
expect all connections to be using TLS from the start, so the whole SMTP
dialogue is encrypted, without the need for `STARTTLS`.
PAM Authentication
------------------
E-MailRelay on Linux supports the use of PAM (Pluggable Authentication Modules)
@ -815,12 +846,27 @@ Eg:
--interface 192.168.0.1,127.0.0.1,fc00::1,::1
--interface 192.168.0.1 --interface 127.0.0.1 --interface fc00::1 --interface ::1
A listening address can also be qualified by one of the prefixes `smtp=`,
`pop=` or `admin=` so that it is only used in that context.
On some systems interface names can be used, in which case all the addresses
associated with that interface are used for listening.
Eg:
--interface eth0
The interface name can have a `-ipv4` or `-ipv6` suffix to limit the listening
addresses to one address family.
Eg:
--interface eth0-ipv4
The `--interface` option can also have one of the prefixes `smtp=`, `pop=` or
`admin=` so that it is only used in that context.
Eg:
--interface smtp=192.168.0.1 --interface pop=127.0.0.1 --interface admin=127.0.0.1
--interface smtp=eth0-ipv4,pop=eth1-ipv6
The IPv4 and IPv6 wildcard addresses (`0.0.0.0` and `::`) can be used with
`--interface` and `--client-interface` to enable the use of IPv4 only or IPv6
@ -889,7 +935,7 @@ the following command-line:
The verifier program is expected to generate two lines of output on the
standard output stream and then terminate with a specific exit code.
For future-proofing a verifier must report a version number of `2.0` if called
For future-proofing a verifier should report a version number of `2.0` if called
with a command-line starting with `--emailrelay-version`.
For valid addresses the first line of output is ignored, the second line should
@ -920,7 +966,8 @@ created. This mechanism can be used to create a separate channel for
administrative messages such as delivery reports.
For invalid addresses the exit value should be non-zero and the first line
of output is the error response.
of output is the error response. A second output line can be used for
diagnostic information that gets put into the E-MailRelay log file.
#!/bin/sh
# address verifier -- reject as invalid (550)
@ -941,6 +988,9 @@ which may be useful in limiting the impact of denial of service attacks:
# address verifier -- abort
exit 100
Any other exit code, from 4 to 99 or 101 and above, behaves in the same way
as an exit code of 2.
In this more complete example the verifier script accepts all addresses as
valid as long as they contain an `at` character:
@ -1011,7 +1061,7 @@ E-MailRelay will connect to the specified verifier daemon over the network and
send address verification requests as lines with pipe-delimited fields. The
expected response is another pipe-delimited line containing the same
information as returned by verifier scripts but in reverse, such as
`3|address unavailable` or `0|postmaster|Local Postmaster <postmaster@eg.com>`.
`0|postmaster|Local Postmaster <postmaster@eg.com>` or `2|mailbox unavailable`.
Connection blocking
-------------------
@ -1025,8 +1075,8 @@ list of DNSBL servers, together with a rejection threshold. If the threshold
number of servers 'deny' the incoming connection's network address then
E-MailRelay will drop the connection immediately.
The `--dnsbl` configuration starts with the DNS server network address and a
millisond timeout, followed by the threshold and list of servers:
The `--dnsbl` configuration starts with the DNS server transport address and a
millisecond timeout, followed by the threshold and list of servers:
emailrelay -r --dnsbl 1.1.1.1:53,500,1,spam.example.com,block.example.com ...
@ -1035,8 +1085,8 @@ are always allowed. This can be combined with verbose logging (`--log -v`)
for initial testing.
If the timeout period expires before a collective decision is reached then the
connection is allowed. This default behaviour can be changed by using a negative
timeout, but for finer control use a DNSBL proxy.
connection is allowed by default. This default behaviour can be changed by
using a negative timeout, but for finer control use a DNSBL proxy.
Connections from loopback and private ([RFC-1918][]) network addresses are never
checked.
@ -1167,6 +1217,7 @@ Installation directories can be defined at build-time by the following
* \-\-mandir=&lt;dir&gt;
* \-\-sbindir=&lt;dir&gt;
* \-\-localedir=&lt;dir&gt;
* e_bsdinitdir=&lt;dir&gt;
* e_docdir=&lt;dir&gt;
* e_examplesdir=&lt;dir&gt;
@ -1177,18 +1228,19 @@ Installation directories can be defined at build-time by the following
* e_spooldir=&lt;dir&gt;
* e_sysconfdir=&lt;dir&gt;
* e_rundir=&lt;dir&gt;
* e_systemddir=&lt;dir&gt;
These are all defaulted to paths that are ultimately based on `--prefix`, so
`./configure --prefix=$HOME` will work as expected.
For a directory structure conforming more closely to the [FHS][] use this configure
command:
For a directory structure conforming more closely to the File Hierarchy
Standard ([FHS][]) use this configure command:
./configure --prefix=/usr --localstatedir=/var --libexecdir=/usr/lib --sysconfdir=/etc e_initdir=/etc/init.d e_rundir=/run/emailrelay
It is possible to change the installation root directory after building by
using `make DESTDIR=<root> install` or `DESTDIR=<root> make -e install`.
However, this will not affect the default spool directory path built into the
However, this will not change the default spool directory path built into the
scripts and executables so the correct spool directory will have to be
specified at run-time with the `--spool-dir` command-line option.
@ -1215,4 +1267,4 @@ and these default to `%ProgramFiles%/E-MailRelay` for programs and
[TLS]: https://en.wikipedia.org/wiki/Transport_Layer_Security
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

160
doc/reference.rst
View File

@ -68,10 +68,10 @@ where \<option\> is:
* --client-auth-config \<config\>
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
blocklisted mechanisms.
* --client-filter \<program\> (-Y)
@ -80,8 +80,10 @@ where \<option\> is:
forwarded. The filter is passed the name of the message file in the spool
directory so that it can edit it as required. A network filter can be
specified as *net:<transport-address>* and prefixes of *spam:*,
*spam-edit:* and *exit:* are also allowed. The *--filter* option is
normally more useful than *--client-filter*.
*spam-edit:* and *exit:* are also allowed. The *spam:* and *spam-edit:*
prefixes require a SpamAssassin daemon to be running. For store-and-forward
applications the *--filter* option is normally more useful than
\ *--client-filter*\ .
* --client-interface \<ip-address\> (-6)
@ -150,7 +152,7 @@ where \<option\> is:
* --dnsbl \<config\>
Specifies a list of DNSBL_ servers that are used to reject SMTP connections
Specifies a list of DNSBL_ servers that are used to reject SMTP connections
from blocked addresses. The configuration string is made up of
comma-separated fields: the DNS server's transport address, a timeout in
milliseconds, a rejection threshold, and then the list of DNSBL servers.
@ -175,9 +177,9 @@ where \<option\> is:
program terminates with an exit code between 1 and 99. Use
*net:<transport-address>* to communicate with a filter daemon over the
network, or *spam:<transport-address>* for a spamassassin spamd daemon to
accept or reject mail messages, or *spam-edit:<transport-address>* to have
spamassassin edit the message content without rejecting it, or
*exit:<number>* to emulate a filter program that just exits.
accept or reject mail messages, or *spam-edit:<transport-address>* to have
spamassassin edit the message content without rejecting it, or
*exit:<number>* to emulate a filter program that just exits.
* --filter-timeout \<time\> (-W)
@ -198,6 +200,11 @@ where \<option\> is:
Specifies the transport address of the remote SMTP server that is use for
mail message forwarding.
* --forward-to-some
Allow forwarding to continue even if some recipient addresses on an e-mail
envelope are rejected by the remote server.
* --help (-h)
Displays help text and then exits. Use with *--verbose* for more complete
@ -205,31 +212,40 @@ where \<option\> is:
* --hidden (-H)
Windows only. Hides the application window and disables all message boxes.
This is useful when running as a windows service.
Windows only. Hides the application window and disables all message boxes,
overriding any **--show** option. This is useful when running as a windows
service.
* --idle-timeout \<time\>
Specifies a timeout (in seconds) for receiving network traffic from remote
Specifies a timeout (in seconds) for receiving network traffic from remote
SMTP and POP clients. The default is 1800 seconds.
* --immediate (-m)
Causes mail messages to be forwarded as they are received, even before they
Causes mail messages to be forwarded as they are received, even before they
have been accepted. This can be used to do proxying without
store-and-forward, but in practice clients tend to to time out while
waiting for their mail message to be accepted.
* --interface \<ip-address-list\> (-I)
Specifies the IP network addresses used to bind listening ports. By default
listening ports for incoming SMTP, POP and administration connections will
bind the 'any' address for IPv4 and for IPv6, ie. *0.0.0.0* and *::*. Use
this option to limit listening to particular addresses (and by implication
to particular network interfaces). Multiple addresses can be specified by
using the option more than once or by using a comma-separated list. Use a
prefix of *smtp=*, *pop=* or *admin=* on addresses that should apply only
to those types of listening port.
Specifies the IP network addresses or interface names used to bind listening
ports. By default listening ports for incoming SMTP, POP and administration
connections will bind the 'any' address for IPv4 and for IPv6, ie.
*0.0.0.0* and *::*. Multiple addresses can be specified by using the option
more than once or by using a comma-separated list. Use a prefix of *smtp=*,
*pop=* or *admin=* on addresses that should apply only to those types of
listening port. Any link-local IPv6 addresses must include a zone name or
scope id. Interface names can be used instead of addresses, in which case
all the addresses associated with that interface at startup will used for
listening. When an interface name is decorated with a *-ipv4* or *-ipv6*
suffix only their IPv4 or IPv6 addresses will be used (eg. *ppp0-ipv4*).
* --localedir \<dir\>
Specifies a locale base directory where localisation message catalogues can
be found. An empty directory can be used for the built-in default.
* --log (-l)
@ -239,6 +255,10 @@ where \<option\> is:
*--as-client* and *--as-proxy* imply *--log*, and *--as-server* and
*--as-proxy* also imply *--close-stderr*.
* --log-address
Adds the network address of remote clients to the logging output.
* --log-file \<file\> (-N)
Redirects standard-error logging to the specified file. Logging to the log
@ -294,9 +314,9 @@ where \<option\> is:
Modifies the spool directory used by the POP server to be a sub-directory
with the same name as the POP authentication user-id. This allows multiple
POP clients to read the spooled messages without interfering with each
other, particularly when also using *--pop-no-delete*. Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The *emailrelay-filter-copy* program is a
other, particularly when also using *--pop-no-delete*. Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The *emailrelay-filter-copy* program is a
convenient way of doing this when run via *--filter*.
* --pop-no-delete (-G)
@ -321,9 +341,9 @@ where \<option\> is:
* --remote-clients (-r)
Allows incoming connections from addresses that are not local. The default
behaviour is to ignore connections that are not local in order to prevent
accidental exposure to the public internet, but a firewall should also be
used. The definition of 'local' is different for IPv4 and IPv6.
behaviour is to reject connections that are not local in order to prevent
accidental exposure to the public internet, although a firewall should also
be used. Local address ranges are defined in RFC-1918_, RFC-6890 etc.
* --response-timeout \<time\> (-T)
@ -343,11 +363,11 @@ where \<option\> is:
* --server-auth-config \<config\>
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
* --server-tls (-K)
@ -363,6 +383,11 @@ where \<option\> is:
PEM file format. Keep the file permissions tight to avoid accidental
exposure of the private key.
* --server-tls-connection
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over
TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
* --server-tls-required
Makes the use of TLS mandatory for any incoming SMTP and POP connections.
@ -385,7 +410,7 @@ where \<option\> is:
Specifies the directory used for holding mail messages that have been
received but not yet forwarded.
* --syslog (-k)
* --syslog[=\<facility\>] (-k)
When used with *--log* this option enables logging to the syslog even if the
*--no-syslog* option is also used. This is typically used as a convenient
@ -396,7 +421,7 @@ where \<option\> is:
Selects and configures the low-level TLS library, using a comma-separated
list of keywords. If OpenSSL and mbedTLS are both built in then keywords of
*openssl* and *mbedtls* will select one or the other. Keywords like
*tlsv1.0* can be used to set a minimum TLS protocol version, or *-tlsv1.2*
*tlsv1.0* can be used to set a minimum TLS protocol version, or *-tlsv1.2*
to set a maximum version.
* --user \<username\> (-u)
@ -462,10 +487,12 @@ When using *--as-client*, or *--dont-serve* and *--forward*, the spooled
messages begin to be forwarded as soon as the program starts up, and the
program terminates once they have all been sent.
All recipient e-mail addresses must be accepted by the remote server when
E-MailRelay forwards an e-mail message. If any one recipient is rejected then
the message will be left in the spool directory with a *.bad* suffix on the
envelope file.
By default all recipient e-mail addresses must be accepted by the remote server
when E-MailRelay forwards an e-mail message. If any one recipient is rejected
then the message will be left in the spool directory with a *.bad* suffix on
the envelope file. This behaviour can be changed by using *--forward-to-some*
command-line option so that forwarding will succeed for the valid recipients
and the failed message will contain the invalid ones.
Mail processing
===============
@ -778,6 +805,10 @@ the whole SMTP dialog is encrypted from the start (\ *--client-tls-connection*\
This is sometimes called SMTP-over-TLS or secure SMTP (smtps) or implicit TLS
and it is normally used with port number 465.
Similarly, when using *--server-tls-connection* the E-MailRelay server will
expect all connections to be using TLS from the start, so the whole SMTP
dialogue is encrypted, without the need for *STARTTLS*.
PAM Authentication
==================
E-MailRelay on Linux supports the use of PAM (Pluggable Authentication Modules)
@ -846,14 +877,33 @@ Eg:
--interface 192.168.0.1,127.0.0.1,fc00::1,::1
--interface 192.168.0.1 --interface 127.0.0.1 --interface fc00::1 --interface ::1
A listening address can also be qualified by one of the prefixes *smtp=*,
*pop=* or *admin=* so that it is only used in that context.
On some systems interface names can be used, in which case all the addresses
associated with that interface are used for listening.
Eg:
::
--interface eth0
The interface name can have a *-ipv4* or *-ipv6* suffix to limit the listening
addresses to one address family.
Eg:
::
--interface eth0-ipv4
The *--interface* option can also have one of the prefixes *smtp=*, *pop=* or
*admin=* so that it is only used in that context.
Eg:
::
--interface smtp=192.168.0.1 --interface pop=127.0.0.1 --interface admin=127.0.0.1
--interface smtp=eth0-ipv4,pop=eth1-ipv6
The IPv4 and IPv6 wildcard addresses (*0.0.0.0* and *::*) can be used with
*--interface* and *--client-interface* to enable the use of IPv4 only or IPv6
@ -932,7 +982,7 @@ the following command-line:
The verifier program is expected to generate two lines of output on the
standard output stream and then terminate with a specific exit code.
For future-proofing a verifier must report a version number of *2.0* if called
For future-proofing a verifier should report a version number of *2.0* if called
with a command-line starting with *--emailrelay-version*.
For valid addresses the first line of output is ignored, the second line should
@ -967,7 +1017,8 @@ created. This mechanism can be used to create a separate channel for
administrative messages such as delivery reports.
For invalid addresses the exit value should be non-zero and the first line
of output is the error response.
of output is the error response. A second output line can be used for
diagnostic information that gets put into the E-MailRelay log file.
::
@ -994,6 +1045,9 @@ which may be useful in limiting the impact of denial of service attacks:
# address verifier -- abort
exit 100
Any other exit code, from 4 to 99 or 101 and above, behaves in the same way
as an exit code of 2.
In this more complete example the verifier script accepts all addresses as
valid as long as they contain an *at* character:
@ -1070,7 +1124,7 @@ E-MailRelay will connect to the specified verifier daemon over the network and
send address verification requests as lines with pipe-delimited fields. The
expected response is another pipe-delimited line containing the same
information as returned by verifier scripts but in reverse, such as
*3|address unavailable* or *0|postmaster|Local Postmaster <postmaster@eg.com>*.
*0|postmaster|Local Postmaster <postmaster@eg.com>* or *2|mailbox unavailable*.
Connection blocking
===================
@ -1084,8 +1138,8 @@ list of DNSBL servers, together with a rejection threshold. If the threshold
number of servers 'deny' the incoming connection's network address then
E-MailRelay will drop the connection immediately.
The *--dnsbl* configuration starts with the DNS server network address and a
millisond timeout, followed by the threshold and list of servers:
The *--dnsbl* configuration starts with the DNS server transport address and a
millisecond timeout, followed by the threshold and list of servers:
::
@ -1096,8 +1150,8 @@ are always allowed. This can be combined with verbose logging (\ *--log -v*\ )
for initial testing.
If the timeout period expires before a collective decision is reached then the
connection is allowed. This default behaviour can be changed by using a negative
timeout, but for finer control use a DNSBL proxy.
connection is allowed by default. This default behaviour can be changed by
using a negative timeout, but for finer control use a DNSBL proxy.
Connections from loopback and private (RFC-1918_) network addresses are never
checked.
@ -1230,6 +1284,7 @@ Installation directories can be defined at build-time by the following
* --mandir=\<dir\>
* --sbindir=\<dir\>
* --localedir=\<dir\>
* e_bsdinitdir=\<dir\>
* e_docdir=\<dir\>
* e_examplesdir=\<dir\>
@ -1240,12 +1295,13 @@ Installation directories can be defined at build-time by the following
* e_spooldir=\<dir\>
* e_sysconfdir=\<dir\>
* e_rundir=\<dir\>
* e_systemddir=\<dir\>
These are all defaulted to paths that are ultimately based on *--prefix*, so
*./configure --prefix=$HOME* will work as expected.
For a directory structure conforming more closely to the FHS_ use this configure
command:
For a directory structure conforming more closely to the File Hierarchy
Standard (FHS_) use this configure command:
::
@ -1253,7 +1309,7 @@ command:
It is possible to change the installation root directory after building by
using *make DESTDIR=<root> install* or *DESTDIR=<root> make -e install*.
However, this will not affect the default spool directory path built into the
However, this will not change the default spool directory path built into the
scripts and executables so the correct spool directory will have to be
specified at run-time with the *--spool-dir* command-line option.
@ -1280,4 +1336,4 @@ and these default to *%ProgramFiles%/E-MailRelay* for programs and
.. _SOCKS: https://en.wikipedia.org/wiki/SOCKS
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. footer:: Copyright (C) 2001-2019 Graeme Walker
.. footer:: Copyright (C) 2001-2021 Graeme Walker

150
doc/reference.txt
View File

@ -56,10 +56,10 @@ where <option> is:
connection will fail.
# --client-auth-config <config>
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
Configures the SMTP client authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces an
ordered list of authentication mechanisms, and an 'x' is used for
blocklisted mechanisms.
# --client-filter <program> (-Y)
@ -67,8 +67,10 @@ where <option> is:
forwarded. The filter is passed the name of the message file in the spool
directory so that it can edit it as required. A network filter can be
specified as "net:<transport-address>" and prefixes of "spam:",
"spam-edit:" and "exit:" are also allowed. The "--filter" option is
normally more useful than "--client-filter".
"spam-edit:" and "exit:" are also allowed. The "spam:" and "spam-edit:"
prefixes require a SpamAssassin daemon to be running. For store-and-forward
applications the "--filter" option is normally more useful than
"--client-filter".
# --client-interface <ip-address> (-6)
Specifies the IP network address to be used to bind the local end of outgoing
@ -125,7 +127,7 @@ where <option> is:
plaintext passwords and mail message content.
# --dnsbl <config>
Specifies a list of DNSBL servers that are used to reject SMTP connections
Specifies a list of DNSBL servers that are used to reject SMTP connections
from blocked addresses. The configuration string is made up of
comma-separated fields: the DNS server's transport address, a timeout in
milliseconds, a rejection threshold, and then the list of DNSBL servers.
@ -147,9 +149,9 @@ where <option> is:
program terminates with an exit code between 1 and 99. Use
"net:<transport-address>" to communicate with a filter daemon over the
network, or "spam:<transport-address>" for a spamassassin spamd daemon to
accept or reject mail messages, or "spam-edit:<transport-address>" to have
spamassassin edit the message content without rejecting it, or
"exit:<number>" to emulate a filter program that just exits.
accept or reject mail messages, or "spam-edit:<transport-address>" to have
spamassassin edit the message content without rejecting it, or
"exit:<number>" to emulate a filter program that just exits.
# --filter-timeout <time> (-W)
Specifies a timeout (in seconds) for running a "--filter" program. The
@ -166,33 +168,45 @@ where <option> is:
Specifies the transport address of the remote SMTP server that is use for
mail message forwarding.
# --forward-to-some
Allow forwarding to continue even if some recipient addresses on an e-mail
envelope are rejected by the remote server.
# --help (-h)
Displays help text and then exits. Use with "--verbose" for more complete
output.
# --hidden (-H)
Windows only. Hides the application window and disables all message boxes.
This is useful when running as a windows service.
Windows only. Hides the application window and disables all message boxes,
overriding any ""--show"" option. This is useful when running as a windows
service.
# --idle-timeout <time>
Specifies a timeout (in seconds) for receiving network traffic from remote
Specifies a timeout (in seconds) for receiving network traffic from remote
SMTP and POP clients. The default is 1800 seconds.
# --immediate (-m)
Causes mail messages to be forwarded as they are received, even before they
Causes mail messages to be forwarded as they are received, even before they
have been accepted. This can be used to do proxying without
store-and-forward, but in practice clients tend to to time out while
waiting for their mail message to be accepted.
# --interface <ip-address-list> (-I)
Specifies the IP network addresses used to bind listening ports. By default
listening ports for incoming SMTP, POP and administration connections will
bind the 'any' address for IPv4 and for IPv6, ie. "0.0.0.0" and "::". Use
this option to limit listening to particular addresses (and by implication
to particular network interfaces). Multiple addresses can be specified by
using the option more than once or by using a comma-separated list. Use a
prefix of "smtp=", "pop=" or "admin=" on addresses that should apply only
to those types of listening port.
Specifies the IP network addresses or interface names used to bind listening
ports. By default listening ports for incoming SMTP, POP and administration
connections will bind the 'any' address for IPv4 and for IPv6, ie.
"0.0.0.0" and "::". Multiple addresses can be specified by using the option
more than once or by using a comma-separated list. Use a prefix of "smtp=",
"pop=" or "admin=" on addresses that should apply only to those types of
listening port. Any link-local IPv6 addresses must include a zone name or
scope id. Interface names can be used instead of addresses, in which case
all the addresses associated with that interface at startup will used for
listening. When an interface name is decorated with a "-ipv4" or "-ipv6"
suffix only their IPv4 or IPv6 addresses will be used (eg. "ppp0-ipv4").
# --localedir <dir>
Specifies a locale base directory where localisation message catalogues can
be found. An empty directory can be used for the built-in default.
# --log (-l)
Enables logging to the standard error stream and to the syslog. The
@ -201,6 +215,9 @@ where <option> is:
"--as-client" and "--as-proxy" imply "--log", and "--as-server" and
"--as-proxy" also imply "--close-stderr".
# --log-address
Adds the network address of remote clients to the logging output.
# --log-file <file> (-N)
Redirects standard-error logging to the specified file. Logging to the log
file is not affected by "--close-stderr". The filename can include "%d" to
@ -246,9 +263,9 @@ where <option> is:
Modifies the spool directory used by the POP server to be a sub-directory
with the same name as the POP authentication user-id. This allows multiple
POP clients to read the spooled messages without interfering with each
other, particularly when also using "--pop-no-delete". Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The "emailrelay-filter-copy" program is a
other, particularly when also using "--pop-no-delete". Content files can
stay in the main spool directory with only the envelope files copied into
user-specific sub-directories. The "emailrelay-filter-copy" program is a
convenient way of doing this when run via "--filter".
# --pop-no-delete (-G)
@ -268,9 +285,9 @@ where <option> is:
# --remote-clients (-r)
Allows incoming connections from addresses that are not local. The default
behaviour is to ignore connections that are not local in order to prevent
accidental exposure to the public internet, but a firewall should also be
used. The definition of 'local' is different for IPv4 and IPv6.
behaviour is to reject connections that are not local in order to prevent
accidental exposure to the public internet, although a firewall should also
be used. Local address ranges are defined in RFC-1918, RFC-6890 etc.
# --response-timeout <time> (-T)
Specifies a timeout (in seconds) for getting responses from remote SMTP
@ -287,11 +304,11 @@ where <option> is:
"/pam" can be used for authentication using linux PAM.
# --server-auth-config <config>
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
Configures the SMTP server authentication module using a semicolon-separated
list of configuration items. Each item is a single-character key, followed
by a colon and then a comma-separated list. A 'm' character introduces a
preferred sub-set of the built-in authentication mechanisms, and an 'x' is
used for blocklisted mechanisms.
# --server-tls (-K)
Enables TLS for incoming SMTP and POP connections. SMTP clients can then
@ -305,6 +322,10 @@ where <option> is:
PEM file format. Keep the file permissions tight to avoid accidental
exposure of the private key.
# --server-tls-connection
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over
TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
# --server-tls-required
Makes the use of TLS mandatory for any incoming SMTP and POP connections.
SMTP clients must use the STARTTLS command to establish a TLS session
@ -323,7 +344,7 @@ where <option> is:
Specifies the directory used for holding mail messages that have been
received but not yet forwarded.
# --syslog (-k)
# --syslog[=<facility>] (-k)
When used with "--log" this option enables logging to the syslog even if the
"--no-syslog" option is also used. This is typically used as a convenient
override when using "--as-client".
@ -332,7 +353,7 @@ where <option> is:
Selects and configures the low-level TLS library, using a comma-separated
list of keywords. If OpenSSL and mbedTLS are both built in then keywords of
"openssl" and "mbedtls" will select one or the other. Keywords like
"tlsv1.0" can be used to set a minimum TLS protocol version, or "-tlsv1.2"
"tlsv1.0" can be used to set a minimum TLS protocol version, or "-tlsv1.2"
to set a maximum version.
# --user <username> (-u)
@ -395,10 +416,12 @@ When using "--as-client", or "--dont-serve" and "--forward", the spooled
messages begin to be forwarded as soon as the program starts up, and the
program terminates once they have all been sent.
All recipient e-mail addresses must be accepted by the remote server when
E-MailRelay forwards an e-mail message. If any one recipient is rejected then
the message will be left in the spool directory with a ".bad" suffix on the
envelope file.
By default all recipient e-mail addresses must be accepted by the remote server
when E-MailRelay forwards an e-mail message. If any one recipient is rejected
then the message will be left in the spool directory with a ".bad" suffix on
the envelope file. This behaviour can be changed by using "--forward-to-some"
command-line option so that forwarding will succeed for the valid recipients
and the failed message will contain the invalid ones.
Mail processing
---------------
@ -691,6 +714,10 @@ the whole SMTP dialog is encrypted from the start ("--client-tls-connection").
This is sometimes called SMTP-over-TLS or secure SMTP (smtps) or implicit TLS
and it is normally used with port number 465.
Similarly, when using "--server-tls-connection" the E-MailRelay server will
expect all connections to be using TLS from the start, so the whole SMTP
dialogue is encrypted, without the need for "STARTTLS".
PAM Authentication
------------------
E-MailRelay on Linux supports the use of PAM (Pluggable Authentication Modules)
@ -748,11 +775,24 @@ Eg:
--interface 192.168.0.1,127.0.0.1,fc00::1,::1
--interface 192.168.0.1 --interface 127.0.0.1 --interface fc00::1 --interface ::1
A listening address can also be qualified by one of the prefixes "smtp=",
"pop=" or "admin=" so that it is only used in that context.
On some systems interface names can be used, in which case all the addresses
associated with that interface are used for listening.
Eg:
--interface eth0
The interface name can have a "-ipv4" or "-ipv6" suffix to limit the listening
addresses to one address family.
Eg:
--interface eth0-ipv4
The "--interface" option can also have one of the prefixes "smtp=", "pop=" or
"admin=" so that it is only used in that context.
Eg:
--interface smtp=192.168.0.1 --interface pop=127.0.0.1 --interface admin=127.0.0.1
--interface smtp=eth0-ipv4,pop=eth1-ipv6
The IPv4 and IPv6 wildcard addresses ("0.0.0.0" and "::") can be used with
"--interface" and "--client-interface" to enable the use of IPv4 only or IPv6
@ -820,7 +860,7 @@ the following command-line:
The verifier program is expected to generate two lines of output on the
standard output stream and then terminate with a specific exit code.
For future-proofing a verifier must report a version number of "2.0" if called
For future-proofing a verifier should report a version number of "2.0" if called
with a command-line starting with "--emailrelay-version".
For valid addresses the first line of output is ignored, the second line should
@ -851,7 +891,8 @@ created. This mechanism can be used to create a separate channel for
administrative messages such as delivery reports.
For invalid addresses the exit value should be non-zero and the first line
of output is the error response.
of output is the error response. A second output line can be used for
diagnostic information that gets put into the E-MailRelay log file.
#!/bin/sh
# address verifier -- reject as invalid (550)
@ -872,6 +913,9 @@ which may be useful in limiting the impact of denial of service attacks:
# address verifier -- abort
exit 100
Any other exit code, from 4 to 99 or 101 and above, behaves in the same way
as an exit code of 2.
In this more complete example the verifier script accepts all addresses as
valid as long as they contain an "at" character:
@ -942,7 +986,7 @@ E-MailRelay will connect to the specified verifier daemon over the network and
send address verification requests as lines with pipe-delimited fields. The
expected response is another pipe-delimited line containing the same
information as returned by verifier scripts but in reverse, such as
"3|address unavailable" or "0|postmaster|Local Postmaster <postmaster@eg.com>".
"0|postmaster|Local Postmaster <postmaster@eg.com>" or "2|mailbox unavailable".
Connection blocking
-------------------
@ -956,8 +1000,8 @@ list of DNSBL servers, together with a rejection threshold. If the threshold
number of servers 'deny' the incoming connection's network address then
E-MailRelay will drop the connection immediately.
The "--dnsbl" configuration starts with the DNS server network address and a
millisond timeout, followed by the threshold and list of servers:
The "--dnsbl" configuration starts with the DNS server transport address and a
millisecond timeout, followed by the threshold and list of servers:
emailrelay -r --dnsbl 1.1.1.1:53,500,1,spam.example.com,block.example.com ...
@ -966,8 +1010,8 @@ are always allowed. This can be combined with verbose logging ("--log -v")
for initial testing.
If the timeout period expires before a collective decision is reached then the
connection is allowed. This default behaviour can be changed by using a negative
timeout, but for finer control use a DNSBL proxy.
connection is allowed by default. This default behaviour can be changed by
using a negative timeout, but for finer control use a DNSBL proxy.
Connections from loopback and private (RFC-1918) network addresses are never
checked.
@ -1097,6 +1141,7 @@ Installation directories can be defined at build-time by the following
"configure" script command-line options:
* --mandir=<dir>
* --sbindir=<dir>
* --localedir=<dir>
* e_bsdinitdir=<dir>
* e_docdir=<dir>
* e_examplesdir=<dir>
@ -1107,18 +1152,19 @@ Installation directories can be defined at build-time by the following
* e_spooldir=<dir>
* e_sysconfdir=<dir>
* e_rundir=<dir>
* e_systemddir=<dir>
These are all defaulted to paths that are ultimately based on "--prefix", so
"./configure --prefix=$HOME" will work as expected.
For a directory structure conforming more closely to the FHS use this configure
command:
For a directory structure conforming more closely to the File Hierarchy
Standard (FHS) use this configure command:
./configure --prefix=/usr --localstatedir=/var --libexecdir=/usr/lib --sysconfdir=/etc e_initdir=/etc/init.d e_rundir=/run/emailrelay
It is possible to change the installation root directory after building by
using "make DESTDIR=<root> install" or "DESTDIR=<root> make -e install".
However, this will not affect the default spool directory path built into the
However, this will not change the default spool directory path built into the
scripts and executables so the correct spool directory will have to be
specified at run-time with the "--spool-dir" command-line option.
@ -1129,4 +1175,4 @@ and these default to "%ProgramFiles%/E-MailRelay" for programs and
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

BIN
doc/serverclient.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 15 KiB

2
doc/serverclient.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

76
doc/userguide.html
View File

@ -154,7 +154,7 @@
</p>
<p>
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the <em>--remote-clients</em> option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
</p>
@ -261,12 +261,12 @@
</p>
<div class="div-pre">
<pre>emailrelay --as-server --pop --pop-auth=/etc/emailrelay.auth
<pre>emailrelay --as-server --pop --pop-auth=/etc/pop.auth
</pre>
</div><!-- div-pre -->
<p>
You will need to create the authentication secrets file (<em>emailrelay.auth</em> in
this example) containing usernames and passwords. A simple example would look
You will need to create the authentication secrets file (<em>pop.auth</em> in this
example) containing usernames and passwords. A simple example would look
like this:
</p>
@ -284,7 +284,7 @@ server plain user2 password2
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify <em>emailrelay-filter-copy</em>
as the <em>--filter</em> program.
as the E-MailRelay <em>--filter</em> program.
</p>
<p>
@ -328,14 +328,14 @@ exec /usr/local/sbin/emailrelay --as-client=smtp.example.com:smtp
<p>
You should check for <em>.bad</em> envelope files in the E-MailRelay spool directory
from time to time.
from time to time. If you want them to be retried next time then just remove
the <em>.bad</em> filename suffix.
</p>
<p>
If you want failed e-mails to be retried a few times you can run the
<em>emailrelay-resubmit</em> script periodically. This script simply removes the <em>.bad</em>
suffix from files in the spool directory, as long as they have not been retried
too many times already.
You can run the <em>emailrelay-resubmit</em> script periodically to automate this; it
removes the <em>.bad</em> suffix from files in the spool directory as long as they
have not been retried too many times already.
</p>
<h2><a class="a-header" name="SH_1_11">Usage patterns</a></h2> <!-- index:2:SH:1:11:Usage patterns -->
<p>
@ -392,12 +392,22 @@ WScript.Quit( 0 ) ;
</p>
<p>
To get E-MailRelay to reject spam outright you can just use <em>spamassassin -e</em> as
It's easiest to run SpamAssassin's <em>spamd</em> program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin <em>spamd</em> uses port 783 so you should use an E-MailRelay
command-line option of <em>--filter spam-edit:127.0.0.1:783</em> if you want spam
messages to pass through with a warning added, or <em>--filter spam:127.0.0.1:783</em>
if you want spam messages to be rejected outright.
</p>
<p>
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use <em>spamassassin -e</em> as
your E-MailRelay <em>--filter</em> program:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --filter="/usr/bin/spamassassin --exit-code"
<pre>emailrelay --as-server --filter="/usr/bin/spamassassin -e"
</pre>
</div><!-- div-pre -->
<p>
@ -405,7 +415,7 @@ WScript.Quit( 0 ) ;
</p>
<div class="div-pre">
<pre>emailrelay --as-server --filter="c:/Program\ Files/perl/site/bin/spamassassin.bat --exit-code"
<pre>emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
</pre>
</div><!-- div-pre -->
<p>
@ -431,18 +441,10 @@ exit 0
</p>
<div class="div-pre">
<pre>c:\Program Files\perl\site\bin\spamassassin.bat %1 > %1.tmp
<pre>c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
</pre>
exit 0</pre>
</div><!-- div-pre -->
<p>
E-MailRelay can also talk to a SpamAssassin <em>spamd</em> daemon over the network
by using <em>--filter spam:localhost:783</em>. This rejects the the message if
<em>spamd</em> thinks it is spam, or by using <em>--filter spam-edit:localhost:783</em>
the message will be accepted but the content will be replaced by the
<em>spamd</em> output.
</p>
<h2><a class="a-header" name="SH_1_14">Google mail</a></h2> <!-- index:2:SH:1:14:Google mail -->
<p>
To send mail via Google mail's SMTP gateway you will need to create a client
@ -485,18 +487,32 @@ exit 0
</p>
<div class="div-pre">
<pre>emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
</pre>
<pre>emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_16">Blocklists and dynamic firewalls</a></h2> <!-- index:2:SH:1:16:Blocklists and dynamic firewalls -->
<p>
E-MailRelay can consult with remote DNSBL blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
<em>--dnsbl</em> option for more details.
</p>
<p>
It is also possible to integrate E-MailRelay with intrusion detection systems
such as <em>fail2ban</em> that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's <em>--log-address</em> command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to <em>fail2ban</em>.
</p>
<div class="div-footer">
<p>
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

57
doc/userguide.md
View File

@ -98,7 +98,7 @@ To run E-MailRelay as a POP server without SMTP use `--pop` and `--no-smtp`:
The `emailrelay-submit` utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the `--remote-clients` option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
@ -181,10 +181,10 @@ messages from the E-MailRelay spool directory directly.
To allow POP access to spooled messages use a command-line something like this:
emailrelay --as-server --pop --pop-auth=/etc/emailrelay.auth
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
You will need to create the authentication secrets file (`emailrelay.auth` in
this example) containing usernames and passwords. A simple example would look
You will need to create the authentication secrets file (`pop.auth` in this
example) containing usernames and passwords. A simple example would look
like this:
server plain user1 password1
@ -198,7 +198,7 @@ copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify `emailrelay-filter-copy`
as the `--filter` program.
as the E-MailRelay `--filter` program.
Refer to the documentation of the various `--pop` command-line options for
more detail: `--pop`, `--pop-port`, `--pop-auth`, `--pop-no-delete` and
@ -230,12 +230,12 @@ envelope files in the spool directory are given a `.bad` suffix. The reason for
the failure will be recorded in the envelope file itself.
You should check for `.bad` envelope files in the E-MailRelay spool directory
from time to time.
from time to time. If you want them to be retried next time then just remove
the `.bad` filename suffix.
If you want failed e-mails to be retried a few times you can run the
`emailrelay-resubmit` script periodically. This script simply removes the `.bad`
suffix from files in the spool directory, as long as they have not been retried
too many times already.
You can run the `emailrelay-resubmit` script periodically to automate this; it
removes the `.bad` suffix from files in the spool directory as long as they
have not been retried too many times already.
Usage patterns
--------------
@ -280,14 +280,22 @@ SpamAssassin
The E-MailRelay server can use [SpamAssassin](http://spamassassin.apache.org)
to mark or reject potential spam.
To get E-MailRelay to reject spam outright you can just use `spamassassin -e` as
It's easiest to run SpamAssassin's `spamd` program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin `spamd` uses port 783 so you should use an E-MailRelay
command-line option of `--filter spam-edit:127.0.0.1:783` if you want spam
messages to pass through with a warning added, or `--filter spam:127.0.0.1:783`
if you want spam messages to be rejected outright.
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use `spamassassin -e` as
your E-MailRelay `--filter` program:
emailrelay --as-server --filter="/usr/bin/spamassassin --exit-code"
emailrelay --as-server --filter="/usr/bin/spamassassin -e"
Or on Windows:
emailrelay --as-server --filter="c:/Program\ Files/perl/site/bin/spamassassin.bat --exit-code"
emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small `--filter` script to collect
@ -303,16 +311,10 @@ On Unix your `--filter` shell script could look something like this:
On Windows an equivalent batch script would be:
c:\Program Files\perl\site\bin\spamassassin.bat %1 > %1.tmp
c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
E-MailRelay can also talk to a SpamAssassin `spamd` daemon over the network
by using `--filter spam:localhost:783`. This rejects the the message if
`spamd` thinks it is spam, or by using `--filter spam-edit:localhost:783`
the message will be accepted but the content will be replaced by the
`spamd` output.
Google mail
-----------
To send mail via Google mail's SMTP gateway you will need to create a client
@ -343,10 +345,23 @@ local Tor server on port 9050 to the mail server at smtp.example.com:
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
Blocklists and dynamic firewalls
--------------------------------
E-MailRelay can consult with remote [DNSBL][] blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
`--dnsbl` option for more details.
It is also possible to integrate E-MailRelay with intrusion detection systems
such as `fail2ban` that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's `--log-address` command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to `fail2ban`.
[DNSBL]: https://en.wikipedia.org/wiki/DNSBL
[MTA]: https://en.wikipedia.org/wiki/Message_transfer_agent
[POP]: https://en.wikipedia.org/wiki/Post_Office_Protocol
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
@ -354,4 +369,4 @@ local Tor server on port 9050 to the mail server at smtp.example.com:
[TLS]: https://en.wikipedia.org/wiki/Transport_Layer_Security
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

57
doc/userguide.rst
View File

@ -117,7 +117,7 @@ To run E-MailRelay as a POP server without SMTP use *--pop* and *--no-smtp*:
The *emailrelay-submit* utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the *--remote-clients* option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
@ -204,10 +204,10 @@ To allow POP access to spooled messages use a command-line something like this:
::
emailrelay --as-server --pop --pop-auth=/etc/emailrelay.auth
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
You will need to create the authentication secrets file (*emailrelay.auth* in
this example) containing usernames and passwords. A simple example would look
You will need to create the authentication secrets file (*pop.auth* in this
example) containing usernames and passwords. A simple example would look
like this:
::
@ -223,7 +223,7 @@ copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify *emailrelay-filter-copy*
as the *--filter* program.
as the E-MailRelay *--filter* program.
Refer to the documentation of the various *--pop* command-line options for
more detail: *--pop*, *--pop-port*, *--pop-auth*, *--pop-no-delete* and
@ -257,12 +257,12 @@ envelope files in the spool directory are given a *.bad* suffix. The reason for
the failure will be recorded in the envelope file itself.
You should check for *.bad* envelope files in the E-MailRelay spool directory
from time to time.
from time to time. If you want them to be retried next time then just remove
the *.bad* filename suffix.
If you want failed e-mails to be retried a few times you can run the
*emailrelay-resubmit* script periodically. This script simply removes the *.bad*
suffix from files in the spool directory, as long as they have not been retried
too many times already.
You can run the *emailrelay-resubmit* script periodically to automate this; it
removes the *.bad* suffix from files in the spool directory as long as they
have not been retried too many times already.
Usage patterns
==============
@ -309,18 +309,26 @@ SpamAssassin
The E-MailRelay server can use `SpamAssassin <http://spamassassin.apache.org>`_
to mark or reject potential spam.
To get E-MailRelay to reject spam outright you can just use *spamassassin -e* as
It's easiest to run SpamAssassin's *spamd* program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin *spamd* uses port 783 so you should use an E-MailRelay
command-line option of *--filter spam-edit:127.0.0.1:783* if you want spam
messages to pass through with a warning added, or *--filter spam:127.0.0.1:783*
if you want spam messages to be rejected outright.
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use *spamassassin -e* as
your E-MailRelay *--filter* program:
::
emailrelay --as-server --filter="/usr/bin/spamassassin --exit-code"
emailrelay --as-server --filter="/usr/bin/spamassassin -e"
Or on Windows:
::
emailrelay --as-server --filter="c:/Program\ Files/perl/site/bin/spamassassin.bat --exit-code"
emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small *--filter* script to collect
@ -340,16 +348,10 @@ On Windows an equivalent batch script would be:
::
c:\Program Files\perl\site\bin\spamassassin.bat %1 > %1.tmp
c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
E-MailRelay can also talk to a SpamAssassin *spamd* daemon over the network
by using *--filter spam:localhost:783*. This rejects the the message if
*spamd* thinks it is spam, or by using *--filter spam-edit:localhost:783*
the message will be accepted but the content will be replaced by the
*spamd* output.
Google mail
===========
To send mail via Google mail's SMTP gateway you will need to create a client
@ -386,15 +388,28 @@ local Tor server on port 9050 to the mail server at smtp.example.com:
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
Blocklists and dynamic firewalls
================================
E-MailRelay can consult with remote DNSBL_ blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
*--dnsbl* option for more details.
It is also possible to integrate E-MailRelay with intrusion detection systems
such as *fail2ban* that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's *--log-address* command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to *fail2ban*.
.. _DNSBL: https://en.wikipedia.org/wiki/DNSBL
.. _MTA: https://en.wikipedia.org/wiki/Message_transfer_agent
.. _POP: https://en.wikipedia.org/wiki/Post_Office_Protocol
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
.. _SOCKS: https://en.wikipedia.org/wiki/SOCKS
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. footer:: Copyright (C) 2001-2019 Graeme Walker
.. footer:: Copyright (C) 2001-2021 Graeme Walker

56
doc/userguide.txt
View File

@ -97,7 +97,7 @@ To run E-MailRelay as a POP server without SMTP use "--pop" and "--no-smtp":
The "emailrelay-submit" utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
By default E-MailRelay will always reject connections from remote machines. To
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the "--remote-clients" option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
@ -180,10 +180,10 @@ messages from the E-MailRelay spool directory directly.
To allow POP access to spooled messages use a command-line something like this:
emailrelay --as-server --pop --pop-auth=/etc/emailrelay.auth
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
You will need to create the authentication secrets file ("emailrelay.auth" in
this example) containing usernames and passwords. A simple example would look
You will need to create the authentication secrets file ("pop.auth" in this
example) containing usernames and passwords. A simple example would look
like this:
server plain user1 password1
@ -197,7 +197,7 @@ copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify "emailrelay-filter-copy"
as the "--filter" program.
as the E-MailRelay "--filter" program.
Refer to the documentation of the various "--pop" command-line options for
more detail: "--pop", "--pop-port", "--pop-auth", "--pop-no-delete" and
@ -229,12 +229,12 @@ envelope files in the spool directory are given a ".bad" suffix. The reason for
the failure will be recorded in the envelope file itself.
You should check for ".bad" envelope files in the E-MailRelay spool directory
from time to time.
from time to time. If you want them to be retried next time then just remove
the ".bad" filename suffix.
If you want failed e-mails to be retried a few times you can run the
"emailrelay-resubmit" script periodically. This script simply removes the ".bad"
suffix from files in the spool directory, as long as they have not been retried
too many times already.
You can run the "emailrelay-resubmit" script periodically to automate this; it
removes the ".bad" suffix from files in the spool directory as long as they
have not been retried too many times already.
Usage patterns
--------------
@ -279,14 +279,22 @@ SpamAssassin
The E-MailRelay server can use *SpamAssassin* [http://spamassassin.apache.org]
to mark or reject potential spam.
To get E-MailRelay to reject spam outright you can just use "spamassassin -e" as
It's easiest to run SpamAssassin's "spamd" program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin "spamd" uses port 783 so you should use an E-MailRelay
command-line option of "--filter spam-edit:127.0.0.1:783" if you want spam
messages to pass through with a warning added, or "--filter spam:127.0.0.1:783"
if you want spam messages to be rejected outright.
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use "spamassassin -e" as
your E-MailRelay "--filter" program:
emailrelay --as-server --filter="/usr/bin/spamassassin --exit-code"
emailrelay --as-server --filter="/usr/bin/spamassassin -e"
Or on Windows:
emailrelay --as-server --filter="c:/Program\ Files/perl/site/bin/spamassassin.bat --exit-code"
emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small "--filter" script to collect
@ -302,16 +310,10 @@ On Unix your "--filter" shell script could look something like this:
On Windows an equivalent batch script would be:
c:\Program Files\perl\site\bin\spamassassin.bat %1 > %1.tmp
c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
E-MailRelay can also talk to a SpamAssassin "spamd" daemon over the network
by using "--filter spam:localhost:783". This rejects the the message if
"spamd" thinks it is spam, or by using "--filter spam-edit:localhost:783"
the message will be accepted but the content will be replaced by the
"spamd" output.
Google mail
-----------
To send mail via Google mail's SMTP gateway you will need to create a client
@ -342,8 +344,20 @@ local Tor server on port 9050 to the mail server at smtp.example.com:
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
Blocklists and dynamic firewalls
--------------------------------
E-MailRelay can consult with remote DNSBL blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
"--dnsbl" option for more details.
It is also possible to integrate E-MailRelay with intrusion detection systems
such as "fail2ban" that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's "--log-address" command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to "fail2ban".
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

BIN
doc/whatisit.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 20 KiB

2
doc/whatisit.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

88
doc/windows.html
View File

@ -33,9 +33,16 @@
<h2><a class="a-header" name="SH_1_2">Running the program</a></h2> <!-- index:2:SH:1:2:Running the program -->
<p>
After a successful installation you should see E-MailRelay listed in the Windows
Start Menu. This will run the <em>emailrelay-start.bat</em> batch file to start
the E-MailRelay server, and you should then see an icon appear in the Windows
system tray.
Start Menu, or an E-MailRelay link under <em>Program Files/E-MailRelay</em>. This will
run the <em>emailrelay-start.bat</em> batch file to start the E-MailRelay server, and
you should then see an icon appear in the Windows system tray under the "Show
hidden icons" button.
</p>
<p>
Note that the <em>emailrelay-start.bat</em> file lives under <em>ProgramData</em>, and although
this might be a hidden directory you can still navigate there by right-clicking
on the E-MailRelay link under <em>Program Files</em> and selecting <em>Open file location</em>.
</p>
<h2><a class="a-header" name="SH_1_3">Configuration</a></h2> <!-- index:2:SH:1:3:Configuration -->
<p>
@ -44,21 +51,11 @@
</p>
<p>
These options are all documented in the reference document, although there are
some Windows-specific variations:
You can edit the batch file directly using Notepad, or run <em>emailrelay-gui.exe</em>.
</p>
<ul>
<li>The <em>--syslog</em> option refers to the Windows Event Viewer's Application log.</li>
<li>The <em>--no-daemon</em> option is used for a normal window rather than an icon in the system tray.</li>
<li>The <em>--minimise</em> option, used with <em>--no-daemon</em>, makes the window start minimised.</li>
<li>The <em>--hidden</em> option with <em>--no-daemon</em> hides all windows and suppresses message boxes.</li>
</ul>
<p>
The Windows-only <em>--show</em> option can be used as a more flexible alternative
to <em>--no-daemon</em> and <em>--hidden</em> using <em>--show=popup</em> and <em>--show=hidden</em>
respectively, or <em>--show=window</em> for a minimisable window, <em>--show=tray</em>
for the default system-tray icon or <em>--show=window,tray</em> for both.
All command-line options are documented in the E-MailRelay reference document.
</p>
<p>
@ -75,12 +72,12 @@
<li>Create a new program directory <em>c:\Program Files\E-MailRelay</em></li>
<li>Copy the packaged files into <em>c:\Program Files\E-MailRelay</em></li>
<li>Create a new spool directory <em>c:\ProgramData\E-MailRelay\spool</em></li>
<li>Create a new text file, eg. <em>c:\ProgramData\E-MailRelay\emailrelay-auth.txt</em>, to contain account details</li>
<li>Add your account details to <em>emailrelay-auth.txt</em> with a line like <em>client plain myaccount mypassword</em></li>
<li>Create a new text file, eg. <em>c:\ProgramData\E-MailRelay\auth.txt</em>, to contain account details</li>
<li>Add your account details to <em>auth.txt</em> with a line like <em>client plain myaccount mypassword</em></li>
<li>Right-drag <em>emailrelay.exe</em> onto the desktop to create a shortcut for the server.</li>
<li>Add <em>--as-server --verbose</em> to the server shortcut properties in the <em>target</em> box.</li>
<li>Right-drag again to create a shortcut to do the forwarding.</li>
<li>Add <em>--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\emailrelay-auth.txt</em> to the client shortcut.</li>
<li>Add <em>--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\auth.txt</em> to the client shortcut.</li>
</ul>
<p>
@ -89,16 +86,16 @@
<h2><a class="a-header" name="SH_1_5">Running as a service</a></h2> <!-- index:2:SH:1:5:Running as a service -->
<p>
E-MailRelay can be set up as a service so that it starts up automatically at
boot-time. If you are setting this up manually you must first have a one-line
batch file called <em>emailrelay-start.bat</em> that contains all the command-line
options for running the E-MailRelay server, and you must have a simple
configuration file called <em>emailrelay-service.cfg</em> that points to it. The
configuration file must be in the same directory as the
<em>emailrelay-service.exe</em> executable.
boot-time. Do do this manually you must first have a one-line batch file
called <em>emailrelay-start.bat</em> that contains all the command-line options for
running the E-MailRelay server, and you must have a simple service-wrapper
configuration file called <em>emailrelay-service.cfg</em> that points to it, and this
must be in the same directory as the service wrapper executable
(<em>emailrelay-service.exe</em>).
</p>
<p>
The batch file should contain a single line, something like this:
The startup batch file should contain a single line, something like this:
</p>
<div class="div-pre">
@ -111,7 +108,9 @@
</p>
<p>
The contents of the configuration file can be a single line like this:
The contents of the service-wrapper configuration file can be a single
line that points to the directory containing the startup batch file,
like this:
</p>
<div class="div-pre">
@ -124,8 +123,8 @@
</p>
<p>
Every time the service starts it reads the configuration file and the startup
batch file in order to run the E-MailRelelay program.
Every time the service starts it reads the service-wrapper configuration file
and the startup batch file in order to run the E-MailRelay program.
</p>
<p>
@ -140,7 +139,7 @@
To uninstall:
</p>
<ul>
<li>Stop the program and/or the service (<em>ControlPanel</em>-><em>SystemAndSecurity</em>-><em>AdministrativeTools</em>-><em>Services</em>).</li>
<li>Stop the program and/or the service.</li>
<li>Uninstall the service, if installed (<em>emailrelay-service --remove</em>).</li>
<li>Delete the files from the E-MailRelay <em>program files</em> folder (eg. <em>C:\Program Files\E-MailRelay</em>).</li>
<li>Delete the files from the E-MailRelay <em>program data</em> folder (eg. <em>C:\ProgramData\E-MailRelay</em>).</li>
@ -157,21 +156,23 @@
</p>
<p>
The Windows Event Log can be accessed by running <em>eventvwr.exe</em> or going to
<em>ControlPanel</em>-><em>SystemAndSecurity</em>-><em>AdministrativeTools</em>-><em>EventViewer</em>; from
there look under <em>Windows Logs</em> and <em>Application</em>.
The Windows Event Log can be accessed by running <em>eventvwr.exe</em> or searching for
<em>Event Viewer</em>; from there look under <em>Windows Logs</em> and <em>Application</em>.
</p>
<p>
You can increase the verbosity of the logging by adding the <em>--verbose</em> option
to the E-MailRelay command-line, typically by editing the <em>emailrelay-start.bat</em>
batch script.
batch script in <em>C:\ProgramData\E-MailRelay</em>.
</p>
<h2><a class="a-header" name="SH_1_8">Testing with telnet</a></h2> <!-- index:2:SH:1:8:Testing with telnet -->
<p>
The <em>telnet</em> program can be used for testing an E-MailRelay server. You should
start by enabling the Windows telnet client using
<em>ControlPanel</em>-><em>Programs</em>-><em>TurnWindowsFeaturesOnAndOff</em>.
The <em>telnet</em> program can be used for testing an E-MailRelay server.
</p>
<p>
To install the program search for <em>Windows Features</em> and enable the "Telnet
client" checkbox.
</p>
<p>
@ -188,25 +189,16 @@
start typing SMTP commands like <em>EHLO</em>, <em>MAIL FROM:<..></em>, <em>RCPT TO:<...></em>
and <em>DATA</em>.
</p>
<h2><a class="a-header" name="SH_1_9">Building from source</a></h2> <!-- index:2:SH:1:9:Building from source -->
<p>
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (<em>winbuild</em>) that creates
<em>cmake</em> files from the autotools makefiles, runs <em>cmake</em> to create the MSVC
project files and then runs <em>msbuild</em> to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
<em>winbuild.bat</em> batch file should be able to do a complete MSVC release build
in one go.
</p>
<div class="div-footer">
<p>
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

79
doc/windows.md
View File

@ -19,27 +19,23 @@ Follow the `Manual installation` section below for more help.
Running the program
-------------------
After a successful installation you should see E-MailRelay listed in the Windows
Start Menu. This will run the `emailrelay-start.bat` batch file to start
the E-MailRelay server, and you should then see an icon appear in the Windows
system tray.
Start Menu, or an E-MailRelay link under `Program Files/E-MailRelay`. This will
run the `emailrelay-start.bat` batch file to start the E-MailRelay server, and
you should then see an icon appear in the Windows system tray under the "Show
hidden icons" button.
Note that the `emailrelay-start.bat` file lives under `ProgramData`, and although
this might be a hidden directory you can still navigate there by right-clicking
on the E-MailRelay link under `Program Files` and selecting `Open file location`.
Configuration
-------------
E-MailRelay is configured though command-line options like `--verbose` or
`--spool-dir=c:/temp` in the `emailrelay-startup.bat` batch file.
These options are all documented in the reference document, although there are
some Windows-specific variations:
You can edit the batch file directly using Notepad, or run `emailrelay-gui.exe`.
* The `--syslog` option refers to the Windows Event Viewer's Application log.
* The `--no-daemon` option is used for a normal window rather than an icon in the system tray.
* The `--minimise` option, used with `--no-daemon`, makes the window start minimised.
* The `--hidden` option with `--no-daemon` hides all windows and suppresses message boxes.
The Windows-only `--show` option can be used as a more flexible alternative
to `--no-daemon` and `--hidden` using `--show=popup` and `--show=hidden`
respectively, or `--show=window` for a minimisable window, `--show=tray`
for the default system-tray icon or `--show=window,tray` for both.
All command-line options are documented in the E-MailRelay reference document.
Account information can be configured by editing the E-MailRelay `secrets` file.
Look for the `--client-auth` or `--server-auth` options in the startup batch
@ -53,41 +49,43 @@ setup program, goes something like this:
* Create a new program directory `c:\Program Files\E-MailRelay`
* Copy the packaged files into `c:\Program Files\E-MailRelay`
* Create a new spool directory `c:\ProgramData\E-MailRelay\spool`
* Create a new text file, eg. `c:\ProgramData\E-MailRelay\emailrelay-auth.txt`, to contain account details
* Add your account details to `emailrelay-auth.txt` with a line like `client plain myaccount mypassword`
* Create a new text file, eg. `c:\ProgramData\E-MailRelay\auth.txt`, to contain account details
* Add your account details to `auth.txt` with a line like `client plain myaccount mypassword`
* Right-drag `emailrelay.exe` onto the desktop to create a shortcut for the server.
* Add `--as-server --verbose` to the server shortcut properties in the `target` box.
* Right-drag again to create a shortcut to do the forwarding.
* Add `--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\emailrelay-auth.txt` to the client shortcut.
* Add `--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\auth.txt` to the client shortcut.
Copy the shortcuts to `Start Menu` and `Startup` folders as necessary.
Running as a service
--------------------
E-MailRelay can be set up as a service so that it starts up automatically at
boot-time. If you are setting this up manually you must first have a one-line
batch file called `emailrelay-start.bat` that contains all the command-line
options for running the E-MailRelay server, and you must have a simple
configuration file called `emailrelay-service.cfg` that points to it. The
configuration file must be in the same directory as the
`emailrelay-service.exe` executable.
boot-time. Do do this manually you must first have a one-line batch file
called `emailrelay-start.bat` that contains all the command-line options for
running the E-MailRelay server, and you must have a simple service-wrapper
configuration file called `emailrelay-service.cfg` that points to it, and this
must be in the same directory as the service wrapper executable
(`emailrelay-service.exe`).
The batch file should contain a single line, something like this:
The startup batch file should contain a single line, something like this:
start "emailrelay" "C:\Program Files\E-MailRelay\emailrelay.exe" --forward-to smtp.example.com:25 ...
There is no need to use `--no-daemon` and `--hidden`; these are added
automatically.
The contents of the configuration file can be a single line like this:
The contents of the service-wrapper configuration file can be a single
line that points to the directory containing the startup batch file,
like this:
dir-config="C:\ProgramData\E-MailRelay"
Then just run `emailrelay-service --install` from an Administrator command
prompt to install the service.
Every time the service starts it reads the configuration file and the startup
batch file in order to run the E-MailRelelay program.
Every time the service starts it reads the service-wrapper configuration file
and the startup batch file in order to run the E-MailRelay program.
If you need to run multiple E-MailRelay services then put a unique service
name and display name on the `emailrelay-service --install <name> <display-name>`
@ -99,7 +97,7 @@ Uninstall
---------
To uninstall:
* Stop the program and/or the service (`ControlPanel`->`SystemAndSecurity`->`AdministrativeTools`->`Services`).
* Stop the program and/or the service.
* Uninstall the service, if installed (`emailrelay-service --remove`).
* Delete the files from the E-MailRelay `program files` folder (eg. `C:\Program Files\E-MailRelay`).
* Delete the files from the E-MailRelay `program data` folder (eg. `C:\ProgramData\E-MailRelay`).
@ -114,19 +112,19 @@ E-MailRelay logging is sent to the Windows Event Log and/or written to a log
file, and individual failed mail messages will have the failure reason recorded
inside the `.bad` envelope file.
The Windows Event Log can be accessed by running `eventvwr.exe` or going to
`ControlPanel`->`SystemAndSecurity`->`AdministrativeTools`->`EventViewer`; from
there look under `Windows Logs` and `Application`.
The Windows Event Log can be accessed by running `eventvwr.exe` or searching for
`Event Viewer`; from there look under `Windows Logs` and `Application`.
You can increase the verbosity of the logging by adding the `--verbose` option
to the E-MailRelay command-line, typically by editing the `emailrelay-start.bat`
batch script.
batch script in `C:\ProgramData\E-MailRelay`.
Testing with telnet
-------------------
The `telnet` program can be used for testing an E-MailRelay server. You should
start by enabling the Windows telnet client using
`ControlPanel`->`Programs`->`TurnWindowsFeaturesOnAndOff`.
The `telnet` program can be used for testing an E-MailRelay server.
To install the program search for `Windows Features` and enable the "Telnet
client" checkbox.
Then run telnet from a command prompt, using `localhost` and the E-MailRelay
port number as command-line parameters:
@ -137,15 +135,6 @@ This should show a greeting from the E-MailRelay server and then you can
start typing [SMTP][] commands like `EHLO`, `MAIL FROM:<..>`, `RCPT TO:<...>`
and `DATA`.
Building from source
--------------------
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (`winbuild`) that creates
`cmake` files from the autotools makefiles, runs `cmake` to create the MSVC
project files and then runs `msbuild` to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
`winbuild.bat` batch file should be able to do a complete MSVC release build
in one go.
@ -153,4 +142,4 @@ in one go.
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

79
doc/windows.rst
View File

@ -20,27 +20,23 @@ Follow the *Manual installation* section below for more help.
Running the program
===================
After a successful installation you should see E-MailRelay listed in the Windows
Start Menu. This will run the *emailrelay-start.bat* batch file to start
the E-MailRelay server, and you should then see an icon appear in the Windows
system tray.
Start Menu, or an E-MailRelay link under *Program Files/E-MailRelay*. This will
run the *emailrelay-start.bat* batch file to start the E-MailRelay server, and
you should then see an icon appear in the Windows system tray under the "Show
hidden icons" button.
Note that the *emailrelay-start.bat* file lives under *ProgramData*, and although
this might be a hidden directory you can still navigate there by right-clicking
on the E-MailRelay link under *Program Files* and selecting *Open file location*.
Configuration
=============
E-MailRelay is configured though command-line options like *--verbose* or
*--spool-dir=c:/temp* in the *emailrelay-startup.bat* batch file.
These options are all documented in the reference document, although there are
some Windows-specific variations:
You can edit the batch file directly using Notepad, or run *emailrelay-gui.exe*.
* The *--syslog* option refers to the Windows Event Viewer's Application log.
* The *--no-daemon* option is used for a normal window rather than an icon in the system tray.
* The *--minimise* option, used with *--no-daemon*, makes the window start minimised.
* The *--hidden* option with *--no-daemon* hides all windows and suppresses message boxes.
The Windows-only *--show* option can be used as a more flexible alternative
to *--no-daemon* and *--hidden* using *--show=popup* and *--show=hidden*
respectively, or *--show=window* for a minimisable window, *--show=tray*
for the default system-tray icon or *--show=window,tray* for both.
All command-line options are documented in the E-MailRelay reference document.
Account information can be configured by editing the E-MailRelay *secrets* file.
Look for the *--client-auth* or *--server-auth* options in the startup batch
@ -54,26 +50,26 @@ setup program, goes something like this:
* Create a new program directory *c:\\Program Files\\E-MailRelay*
* Copy the packaged files into *c:\\Program Files\\E-MailRelay*
* Create a new spool directory *c:\\ProgramData\\E-MailRelay\\spool*
* Create a new text file, eg. *c:\\ProgramData\\E-MailRelay\\emailrelay-auth.txt*, to contain account details
* Add your account details to *emailrelay-auth.txt* with a line like *client plain myaccount mypassword*
* Create a new text file, eg. *c:\\ProgramData\\E-MailRelay\\auth.txt*, to contain account details
* Add your account details to *auth.txt* with a line like *client plain myaccount mypassword*
* Right-drag *emailrelay.exe* onto the desktop to create a shortcut for the server.
* Add *--as-server --verbose* to the server shortcut properties in the *target* box.
* Right-drag again to create a shortcut to do the forwarding.
* Add *--as-client example.com:smtp --client-auth c:\\ProgramData\\E-MailRelay\\emailrelay-auth.txt* to the client shortcut.
* Add *--as-client example.com:smtp --client-auth c:\\ProgramData\\E-MailRelay\\auth.txt* to the client shortcut.
Copy the shortcuts to *Start Menu* and *Startup* folders as necessary.
Running as a service
====================
E-MailRelay can be set up as a service so that it starts up automatically at
boot-time. If you are setting this up manually you must first have a one-line
batch file called *emailrelay-start.bat* that contains all the command-line
options for running the E-MailRelay server, and you must have a simple
configuration file called *emailrelay-service.cfg* that points to it. The
configuration file must be in the same directory as the
*emailrelay-service.exe* executable.
boot-time. Do do this manually you must first have a one-line batch file
called *emailrelay-start.bat* that contains all the command-line options for
running the E-MailRelay server, and you must have a simple service-wrapper
configuration file called *emailrelay-service.cfg* that points to it, and this
must be in the same directory as the service wrapper executable
(\ *emailrelay-service.exe*\ ).
The batch file should contain a single line, something like this:
The startup batch file should contain a single line, something like this:
::
@ -82,7 +78,9 @@ The batch file should contain a single line, something like this:
There is no need to use *--no-daemon* and *--hidden*; these are added
automatically.
The contents of the configuration file can be a single line like this:
The contents of the service-wrapper configuration file can be a single
line that points to the directory containing the startup batch file,
like this:
::
@ -91,8 +89,8 @@ The contents of the configuration file can be a single line like this:
Then just run *emailrelay-service --install* from an Administrator command
prompt to install the service.
Every time the service starts it reads the configuration file and the startup
batch file in order to run the E-MailRelelay program.
Every time the service starts it reads the service-wrapper configuration file
and the startup batch file in order to run the E-MailRelay program.
If you need to run multiple E-MailRelay services then put a unique service
name and display name on the *emailrelay-service --install <name> <display-name>*
@ -104,7 +102,7 @@ Uninstall
=========
To uninstall:
* Stop the program and/or the service (\ *ControlPanel*\ ->\ *SystemAndSecurity*\ ->\ *AdministrativeTools*\ ->\ *Services*\ ).
* Stop the program and/or the service.
* Uninstall the service, if installed (\ *emailrelay-service --remove*\ ).
* Delete the files from the E-MailRelay *program files* folder (eg. *C:\\Program Files\\E-MailRelay*).
* Delete the files from the E-MailRelay *program data* folder (eg. *C:\\ProgramData\\E-MailRelay*).
@ -119,19 +117,19 @@ E-MailRelay logging is sent to the Windows Event Log and/or written to a log
file, and individual failed mail messages will have the failure reason recorded
inside the *.bad* envelope file.
The Windows Event Log can be accessed by running *eventvwr.exe* or going to
\ *ControlPanel*\ ->\ *SystemAndSecurity*\ ->\ *AdministrativeTools*\ ->\ *EventViewer*\ ; from
there look under *Windows Logs* and *Application*.
The Windows Event Log can be accessed by running *eventvwr.exe* or searching for
\ *Event Viewer*\ ; from there look under *Windows Logs* and *Application*.
You can increase the verbosity of the logging by adding the *--verbose* option
to the E-MailRelay command-line, typically by editing the *emailrelay-start.bat*
batch script.
batch script in *C:\\ProgramData\\E-MailRelay*.
Testing with telnet
===================
The *telnet* program can be used for testing an E-MailRelay server. You should
start by enabling the Windows telnet client using
\ *ControlPanel*\ ->\ *Programs*\ ->\ *TurnWindowsFeaturesOnAndOff*\ .
The *telnet* program can be used for testing an E-MailRelay server.
To install the program search for *Windows Features* and enable the "Telnet
client" checkbox.
Then run telnet from a command prompt, using *localhost* and the E-MailRelay
port number as command-line parameters:
@ -144,15 +142,6 @@ This should show a greeting from the E-MailRelay server and then you can
start typing SMTP_ commands like *EHLO*, *MAIL FROM:<..>*, *RCPT TO:<...>*
and *DATA*.
Building from source
====================
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (\ *winbuild*\ ) that creates
*cmake* files from the autotools makefiles, runs *cmake* to create the MSVC
project files and then runs *msbuild* to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
*winbuild.bat* batch file should be able to do a complete MSVC release build
in one go.
@ -160,4 +149,4 @@ in one go.
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
.. footer:: Copyright (C) 2001-2019 Graeme Walker
.. footer:: Copyright (C) 2001-2021 Graeme Walker

78
doc/windows.txt
View File

@ -19,26 +19,23 @@ Follow the "Manual installation" section below for more help.
Running the program
-------------------
After a successful installation you should see E-MailRelay listed in the Windows
Start Menu. This will run the "emailrelay-start.bat" batch file to start
the E-MailRelay server, and you should then see an icon appear in the Windows
system tray.
Start Menu, or an E-MailRelay link under "Program Files/E-MailRelay". This will
run the "emailrelay-start.bat" batch file to start the E-MailRelay server, and
you should then see an icon appear in the Windows system tray under the "Show
hidden icons" button.
Note that the "emailrelay-start.bat" file lives under "ProgramData", and although
this might be a hidden directory you can still navigate there by right-clicking
on the E-MailRelay link under "Program Files" and selecting "Open file location".
Configuration
-------------
E-MailRelay is configured though command-line options like "--verbose" or
"--spool-dir=c:/temp" in the "emailrelay-startup.bat" batch file.
These options are all documented in the reference document, although there are
some Windows-specific variations:
* The "--syslog" option refers to the Windows Event Viewer's Application log.
* The "--no-daemon" option is used for a normal window rather than an icon in the system tray.
* The "--minimise" option, used with "--no-daemon", makes the window start minimised.
* The "--hidden" option with "--no-daemon" hides all windows and suppresses message boxes.
You can edit the batch file directly using Notepad, or run "emailrelay-gui.exe".
The Windows-only "--show" option can be used as a more flexible alternative
to "--no-daemon" and "--hidden" using "--show=popup" and "--show=hidden"
respectively, or "--show=window" for a minimisable window, "--show=tray"
for the default system-tray icon or "--show=window,tray" for both.
All command-line options are documented in the E-MailRelay reference document.
Account information can be configured by editing the E-MailRelay "secrets" file.
Look for the "--client-auth" or "--server-auth" options in the startup batch
@ -51,41 +48,43 @@ setup program, goes something like this:
* Create a new program directory "c:\Program Files\E-MailRelay"
* Copy the packaged files into "c:\Program Files\E-MailRelay"
* Create a new spool directory "c:\ProgramData\E-MailRelay\spool"
* Create a new text file, eg. "c:\ProgramData\E-MailRelay\emailrelay-auth.txt", to contain account details
* Add your account details to "emailrelay-auth.txt" with a line like "client plain myaccount mypassword"
* Create a new text file, eg. "c:\ProgramData\E-MailRelay\auth.txt", to contain account details
* Add your account details to "auth.txt" with a line like "client plain myaccount mypassword"
* Right-drag "emailrelay.exe" onto the desktop to create a shortcut for the server.
* Add "--as-server --verbose" to the server shortcut properties in the "target" box.
* Right-drag again to create a shortcut to do the forwarding.
* Add "--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\emailrelay-auth.txt" to the client shortcut.
* Add "--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\auth.txt" to the client shortcut.
Copy the shortcuts to "Start Menu" and "Startup" folders as necessary.
Running as a service
--------------------
E-MailRelay can be set up as a service so that it starts up automatically at
boot-time. If you are setting this up manually you must first have a one-line
batch file called "emailrelay-start.bat" that contains all the command-line
options for running the E-MailRelay server, and you must have a simple
configuration file called "emailrelay-service.cfg" that points to it. The
configuration file must be in the same directory as the
"emailrelay-service.exe" executable.
boot-time. Do do this manually you must first have a one-line batch file
called "emailrelay-start.bat" that contains all the command-line options for
running the E-MailRelay server, and you must have a simple service-wrapper
configuration file called "emailrelay-service.cfg" that points to it, and this
must be in the same directory as the service wrapper executable
("emailrelay-service.exe").
The batch file should contain a single line, something like this:
The startup batch file should contain a single line, something like this:
start "emailrelay" "C:\Program Files\E-MailRelay\emailrelay.exe" --forward-to smtp.example.com:25 ...
There is no need to use "--no-daemon" and "--hidden"; these are added
automatically.
The contents of the configuration file can be a single line like this:
The contents of the service-wrapper configuration file can be a single
line that points to the directory containing the startup batch file,
like this:
dir-config="C:\ProgramData\E-MailRelay"
Then just run "emailrelay-service --install" from an Administrator command
prompt to install the service.
Every time the service starts it reads the configuration file and the startup
batch file in order to run the E-MailRelelay program.
Every time the service starts it reads the service-wrapper configuration file
and the startup batch file in order to run the E-MailRelay program.
If you need to run multiple E-MailRelay services then put a unique service
name and display name on the "emailrelay-service --install <name> <display-name>"
@ -96,7 +95,7 @@ command-line options, so you will need to create that first.
Uninstall
---------
To uninstall:
* Stop the program and/or the service ("ControlPanel"->"SystemAndSecurity"->"AdministrativeTools"->"Services").
* Stop the program and/or the service.
* Uninstall the service, if installed ("emailrelay-service --remove").
* Delete the files from the E-MailRelay "program files" folder (eg. "C:\Program Files\E-MailRelay").
* Delete the files from the E-MailRelay "program data" folder (eg. "C:\ProgramData\E-MailRelay").
@ -111,19 +110,19 @@ E-MailRelay logging is sent to the Windows Event Log and/or written to a log
file, and individual failed mail messages will have the failure reason recorded
inside the ".bad" envelope file.
The Windows Event Log can be accessed by running "eventvwr.exe" or going to
"ControlPanel"->"SystemAndSecurity"->"AdministrativeTools"->"EventViewer"; from
there look under "Windows Logs" and "Application".
The Windows Event Log can be accessed by running "eventvwr.exe" or searching for
"Event Viewer"; from there look under "Windows Logs" and "Application".
You can increase the verbosity of the logging by adding the "--verbose" option
to the E-MailRelay command-line, typically by editing the "emailrelay-start.bat"
batch script.
batch script in "C:\ProgramData\E-MailRelay".
Testing with telnet
-------------------
The "telnet" program can be used for testing an E-MailRelay server. You should
start by enabling the Windows telnet client using
"ControlPanel"->"Programs"->"TurnWindowsFeaturesOnAndOff".
The "telnet" program can be used for testing an E-MailRelay server.
To install the program search for "Windows Features" and enable the "Telnet
client" checkbox.
Then run telnet from a command prompt, using "localhost" and the E-MailRelay
port number as command-line parameters:
@ -134,17 +133,8 @@ This should show a greeting from the E-MailRelay server and then you can
start typing SMTP commands like "EHLO", "MAIL FROM:<..>", "RCPT TO:<...>"
and "DATA".
Building from source
--------------------
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script ("winbuild") that creates
"cmake" files from the autotools makefiles, runs "cmake" to create the MSVC
project files and then runs "msbuild" to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
"winbuild.bat" batch file should be able to do a complete MSVC release build
in one go.
_____________________________________
Copyright (C) 2001-2019 Graeme Walker
Copyright (C) 2001-2021 Graeme Walker

15
emailrelay.spec
View File

@ -1,11 +1,11 @@
Summary: Simple e-mail message transfer agent and proxy using SMTP
Name: emailrelay
Version: 2.1
Version: 2.2
Release: 1
License: GPL3
Group: System Environment/Daemons
URL: http://emailrelay.sourceforge.net
Source: http://sourceforge.net/projects/emailrelay/files/emailrelay/2.1/emailrelay-2.1-src.tar.gz
Source: http://sourceforge.net/projects/emailrelay/files/emailrelay/2.2/emailrelay-2.2-src.tar.gz
BuildRoot: /tmp/emailrelay-install
%description
@ -34,7 +34,7 @@ General Public License V3.
%setup
%build
./configure --prefix=/usr --localstatedir=/var --libexecdir=/usr/lib --sysconfdir=/etc e_initdir=/etc/init.d --without-doxygen --without-man2html --with-openssl --without-mbedtls --with-pam --disable-gui --disable-install-hook --disable-testing
./configure --prefix=/usr --localstatedir=/var --libexecdir=/usr/lib --sysconfdir=/etc e_initdir=/etc/init.d e_systemddir=/usr/lib/systemd/system --without-doxygen --without-man2html --with-openssl --without-mbedtls --with-pam --disable-gui --disable-install-hook --disable-testing
make
%install
@ -53,17 +53,25 @@ test "$RPM_BUILD_ROOT" = "/" || rm -rf "$RPM_BUILD_ROOT"
%files
/etc/emailrelay.auth.template
/etc/emailrelay.auth.template
%config /etc/emailrelay.conf
/etc/emailrelay.conf.template
/etc/emailrelay.conf.template
/etc/init.d/emailrelay
%config /etc/pam.d/emailrelay
%config /etc/pam.d/emailrelay
%dir /usr/lib/emailrelay
%attr(2755, root, daemon) /usr/lib/emailrelay/emailrelay-filter-copy
%dir /usr/lib/emailrelay/examples
/usr/lib/emailrelay/examples/emailrelay
/usr/lib/emailrelay/examples/emailrelay-bcc-check.pl
/usr/lib/emailrelay/examples/emailrelay-deliver.sh
/usr/lib/emailrelay/examples/emailrelay-fail2ban-filter
/usr/lib/emailrelay/examples/emailrelay-fail2ban-filter
/usr/lib/emailrelay/examples/emailrelay-fail2ban-jail
/usr/lib/emailrelay/examples/emailrelay-fail2ban-jail
/usr/lib/emailrelay/examples/emailrelay-ldap-verify.py
/usr/lib/emailrelay/examples/emailrelay-multicast.sh
/usr/lib/emailrelay/examples/emailrelay-notify.sh
/usr/lib/emailrelay/examples/emailrelay-resubmit.sh
@ -72,6 +80,7 @@ test "$RPM_BUILD_ROOT" = "/" || rm -rf "$RPM_BUILD_ROOT"
/usr/lib/emailrelay/examples/emailrelay-set-from.js
/usr/lib/emailrelay/examples/emailrelay-set-from.pl
/usr/lib/emailrelay/examples/emailrelay-submit.sh
/usr/lib/systemd/system/emailrelay.service
/usr/sbin/emailrelay
/usr/sbin/emailrelay-passwd
%attr(2755, root, daemon) /usr/sbin/emailrelay-submit

38
etc/Makefile.am
View File

@ -1,16 +1,16 @@
#
## Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## Copyright (C) 2001-2021 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
#
@ -24,25 +24,43 @@ endif
EXTRA_DIST = \
emailrelay.conf.template \
emailrelay.auth.template \
emailrelay-fail2ban-jail \
emailrelay-fail2ban-filter \
emailrelay.service.in \
emailrelay.pam
e_sysconf_DATA = \
emailrelay.conf.template \
emailrelay.auth.template
e_examples_DATA = \
emailrelay-fail2ban-jail \
emailrelay-fail2ban-filter
e_systemd_DATA = \
emailrelay.service
emailrelay: emailrelay.pam
cp $(top_srcdir)/etc/emailrelay.pam $@
clean-local:
-rm -f emailrelay 2>/dev/null
do_sed = sed -e "s:__INIT_DIR__:$(e_initdir):g" -e "s:__RUN_DIR__:$(e_rundir):g"
emailrelay.service: emailrelay.service.in
$(do_sed) < $(srcdir)/emailrelay.service.in > emailrelay.service
CLEANFILES = \
emailrelay \
emailrelay.service
if GCONFIG_INSTALL_HOOK
# create the .conf file from .conf.template with directory edits - disable
# this when running configure for a .deb or .rpm package by using
# 'configure --disable-install-hook'
# disable this section when running configure for a .deb or .rpm
# package by using 'configure --disable-install-hook'
#
# creates the .conf file from .conf.template with directory edits
#
install-data-hook:
if test -f "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; then : ; else cat "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf.template" | sed "s:^#spool-dir .*:spool-dir $(e_spooldir):g" | sed 's:"/var/spool/emailrelay":"'"$(e_spooldir)"'":g' | sed "s:/etc:$(e_sysconfdir):g" | sed "s:/usr/local/bin:$(e_libexecdir):g" > "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; fi
if test -f "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; then : ; else sed -e "s:^#spool-dir .*:spool-dir $(e_spooldir):g" -e 's:"/var/spool/emailrelay":"'"$(e_spooldir)"'":g' -e "s:/etc:$(e_sysconfdir):g" -e "s:/usr/local/bin:$(e_libexecdir):g" < "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf.template" > "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; fi
cp "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf.makeinstall"
# remove the .conf file if it has not been editied

115
etc/Makefile.in
View File

@ -148,8 +148,10 @@ am__uninstall_files_from_dir = { \
|| { echo " ( cd '$$dir' && rm -f" $$files ")"; \
$(am__cd) "$$dir" && rm -f $$files; }; \
}
am__installdirs = "$(DESTDIR)$(e_pamdir)" "$(DESTDIR)$(e_sysconfdir)"
DATA = $(e_pam_DATA) $(e_sysconf_DATA)
am__installdirs = "$(DESTDIR)$(e_examplesdir)" "$(DESTDIR)$(e_pamdir)" \
"$(DESTDIR)$(e_sysconfdir)" "$(DESTDIR)$(e_systemddir)"
DATA = $(e_examples_DATA) $(e_pam_DATA) $(e_sysconf_DATA) \
$(e_systemd_DATA)
am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
am__DIST_COMMON = $(srcdir)/Makefile.in
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@ -250,6 +252,7 @@ e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
e_sysconfdir = @e_sysconfdir@
e_systemddir = @e_systemddir@
exec_prefix = @exec_prefix@
host_alias = @host_alias@
htmldir = @htmldir@
@ -281,12 +284,27 @@ top_srcdir = @top_srcdir@
EXTRA_DIST = \
emailrelay.conf.template \
emailrelay.auth.template \
emailrelay-fail2ban-jail \
emailrelay-fail2ban-filter \
emailrelay.service.in \
emailrelay.pam
e_sysconf_DATA = \
emailrelay.conf.template \
emailrelay.auth.template
e_examples_DATA = \
emailrelay-fail2ban-jail \
emailrelay-fail2ban-filter
e_systemd_DATA = \
emailrelay.service
do_sed = sed -e "s:__INIT_DIR__:$(e_initdir):g" -e "s:__RUN_DIR__:$(e_rundir):g"
CLEANFILES = \
emailrelay \
emailrelay.service
all: all-am
.SUFFIXES:
@ -319,6 +337,27 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps)
$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(am__aclocal_m4_deps):
install-e_examplesDATA: $(e_examples_DATA)
@$(NORMAL_INSTALL)
@list='$(e_examples_DATA)'; test -n "$(e_examplesdir)" || list=; \
if test -n "$$list"; then \
echo " $(MKDIR_P) '$(DESTDIR)$(e_examplesdir)'"; \
$(MKDIR_P) "$(DESTDIR)$(e_examplesdir)" || exit 1; \
fi; \
for p in $$list; do \
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; \
done | $(am__base_list) | \
while read files; do \
echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(e_examplesdir)'"; \
$(INSTALL_DATA) $$files "$(DESTDIR)$(e_examplesdir)" || exit $$?; \
done
uninstall-e_examplesDATA:
@$(NORMAL_UNINSTALL)
@list='$(e_examples_DATA)'; test -n "$(e_examplesdir)" || list=; \
files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \
dir='$(DESTDIR)$(e_examplesdir)'; $(am__uninstall_files_from_dir)
install-e_pamDATA: $(e_pam_DATA)
@$(NORMAL_INSTALL)
@list='$(e_pam_DATA)'; test -n "$(e_pamdir)" || list=; \
@ -361,6 +400,27 @@ uninstall-e_sysconfDATA:
@list='$(e_sysconf_DATA)'; test -n "$(e_sysconfdir)" || list=; \
files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \
dir='$(DESTDIR)$(e_sysconfdir)'; $(am__uninstall_files_from_dir)
install-e_systemdDATA: $(e_systemd_DATA)
@$(NORMAL_INSTALL)
@list='$(e_systemd_DATA)'; test -n "$(e_systemddir)" || list=; \
if test -n "$$list"; then \
echo " $(MKDIR_P) '$(DESTDIR)$(e_systemddir)'"; \
$(MKDIR_P) "$(DESTDIR)$(e_systemddir)" || exit 1; \
fi; \
for p in $$list; do \
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; \
done | $(am__base_list) | \
while read files; do \
echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(e_systemddir)'"; \
$(INSTALL_DATA) $$files "$(DESTDIR)$(e_systemddir)" || exit $$?; \
done
uninstall-e_systemdDATA:
@$(NORMAL_UNINSTALL)
@list='$(e_systemd_DATA)'; test -n "$(e_systemddir)" || list=; \
files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \
dir='$(DESTDIR)$(e_systemddir)'; $(am__uninstall_files_from_dir)
tags TAGS:
ctags CTAGS:
@ -402,7 +462,7 @@ check-am: all-am
check: check-am
all-am: Makefile $(DATA)
installdirs:
for dir in "$(DESTDIR)$(e_pamdir)" "$(DESTDIR)$(e_sysconfdir)"; do \
for dir in "$(DESTDIR)$(e_examplesdir)" "$(DESTDIR)$(e_pamdir)" "$(DESTDIR)$(e_sysconfdir)" "$(DESTDIR)$(e_systemddir)"; do \
test -z "$$dir" || $(MKDIR_P) "$$dir"; \
done
install: install-am
@ -427,6 +487,7 @@ install-strip:
mostlyclean-generic:
clean-generic:
-test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
distclean-generic:
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
@ -437,7 +498,7 @@ maintainer-clean-generic:
@echo "it deletes files that may require special tools to rebuild."
clean: clean-am
clean-am: clean-generic clean-local mostlyclean-am
clean-am: clean-generic mostlyclean-am
distclean: distclean-am
-rm -f Makefile
@ -455,7 +516,8 @@ info: info-am
info-am:
install-data-am: install-e_pamDATA install-e_sysconfDATA
install-data-am: install-e_examplesDATA install-e_pamDATA \
install-e_sysconfDATA install-e_systemdDATA
@$(NORMAL_INSTALL)
$(MAKE) $(AM_MAKEFLAGS) install-data-hook
install-dvi: install-dvi-am
@ -500,23 +562,26 @@ ps: ps-am
ps-am:
uninstall-am: uninstall-e_pamDATA uninstall-e_sysconfDATA
uninstall-am: uninstall-e_examplesDATA uninstall-e_pamDATA \
uninstall-e_sysconfDATA uninstall-e_systemdDATA
@$(NORMAL_INSTALL)
$(MAKE) $(AM_MAKEFLAGS) uninstall-hook
.MAKE: install-am install-data-am install-strip uninstall-am
.PHONY: all all-am check check-am clean clean-generic clean-local \
cscopelist-am ctags-am distclean distclean-generic distdir dvi \
dvi-am html html-am info info-am install install-am \
install-data install-data-am install-data-hook install-dvi \
install-dvi-am install-e_pamDATA install-e_sysconfDATA \
install-exec install-exec-am install-html install-html-am \
install-info install-info-am install-man install-pdf \
install-pdf-am install-ps install-ps-am install-strip \
installcheck installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic pdf \
pdf-am ps ps-am tags-am uninstall uninstall-am \
uninstall-e_pamDATA uninstall-e_sysconfDATA uninstall-hook
.PHONY: all all-am check check-am clean clean-generic cscopelist-am \
ctags-am distclean distclean-generic distdir dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-data-hook install-dvi install-dvi-am \
install-e_examplesDATA install-e_pamDATA install-e_sysconfDATA \
install-e_systemdDATA install-exec install-exec-am \
install-html install-html-am install-info install-info-am \
install-man install-pdf install-pdf-am install-ps \
install-ps-am install-strip installcheck installcheck-am \
installdirs maintainer-clean maintainer-clean-generic \
mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags-am \
uninstall uninstall-am uninstall-e_examplesDATA \
uninstall-e_pamDATA uninstall-e_sysconfDATA \
uninstall-e_systemdDATA uninstall-hook
.PRECIOUS: Makefile
@ -524,14 +589,16 @@ uninstall-am: uninstall-e_pamDATA uninstall-e_sysconfDATA
emailrelay: emailrelay.pam
cp $(top_srcdir)/etc/emailrelay.pam $@
clean-local:
-rm -f emailrelay 2>/dev/null
emailrelay.service: emailrelay.service.in
$(do_sed) < $(srcdir)/emailrelay.service.in > emailrelay.service
# create the .conf file from .conf.template with directory edits - disable
# this when running configure for a .deb or .rpm package by using
# 'configure --disable-install-hook'
# disable this section when running configure for a .deb or .rpm
# package by using 'configure --disable-install-hook'
#
# creates the .conf file from .conf.template with directory edits
#
@GCONFIG_INSTALL_HOOK_TRUE@install-data-hook:
@GCONFIG_INSTALL_HOOK_TRUE@ if test -f "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; then : ; else cat "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf.template" | sed "s:^#spool-dir .*:spool-dir $(e_spooldir):g" | sed 's:"/var/spool/emailrelay":"'"$(e_spooldir)"'":g' | sed "s:/etc:$(e_sysconfdir):g" | sed "s:/usr/local/bin:$(e_libexecdir):g" > "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; fi
@GCONFIG_INSTALL_HOOK_TRUE@ if test -f "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; then : ; else sed -e "s:^#spool-dir .*:spool-dir $(e_spooldir):g" -e 's:"/var/spool/emailrelay":"'"$(e_spooldir)"'":g' -e "s:/etc:$(e_sysconfdir):g" -e "s:/usr/local/bin:$(e_libexecdir):g" < "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf.template" > "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" ; fi
@GCONFIG_INSTALL_HOOK_TRUE@ cp "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf" "$(DESTDIR)$(e_sysconfdir)/emailrelay.conf.makeinstall"
# remove the .conf file if it has not been editied

16
etc/emailrelay-fail2ban-filter Normal file
View File

@ -0,0 +1,16 @@
# Example fail2ban filter definition for emailrelay.
#
# Install this as /etc/fail2ban/filter.d/emailrelay.conf
# and configure emailrelay to use the "--log-address"
# option.
[Definition]
failregex = emailrelay: warning: <HOST>; failed authentication
emailrelay: warning: <HOST>; .* AUTH requested but not advertised
emailrelay: warning: <HOST>; empty MAIL-FROM return path
emailrelay: info: <HOST>; address verifier: exit code
ignoreregex = emailrelay: warning: <HOST>; dnsbl
emailrelay: info: <HOST>; address verifier: exit code 1:

40
etc/emailrelay-fail2ban-jail Normal file
View File

@ -0,0 +1,40 @@
# Example fail2ban jail definition for emailrelay.
#
# Add this to /etc/fail2ban/jail.local.
#
# Configure syslog so that emailrelay warnings get logged to the fail2ban
# 'syslog_mail' file -- typically "/var/log/mail" or "/var/log/mail.log".
# Refer to '/etc/fail2ban/jail.conf', '/etc/fail2ban/paths*' and
# 'man rsyslog.conf' for more details.
#
# When configuring syslog note that emailrelay emits logging using a syslog
# 'facility' of "mail" by default, but you can change this by using the
# emailrelay "--syslog" option, eg. "--syslog=local2".
#
# Test by using 'maxretry=1' and 'bantime = 30' below and then:
# $ fail2ban-client reload
# $ logger -p mail.warn emailrelay: warning: "1.2.3.4;" failed authentication
#
# You should see address 1.2.3.4 being banned by fail2ban for 30 seconds.
#
# Choose action 'action_mwl' below to ban the address using iptables and
# also send notification emails using 'sendmail'. Refer to the '[DEFAULT]'
# section of 'jail.conf' for pre-configured actions and for the mailer
# configuration.
#
# Consider installing the 'emailrelay-sendmail.pl' script if you want
# emails generated by fail2ban to go into the emailrelay spool directory.
#
[emailrelay]
enabled = true
ignoreip = 127.0.0.0/8 169.254.0.0/16 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16
port = smtp,submission
logpath = %(syslog_mail)s
#logpath = %(syslog_mail_warn)s
action = %(action_)s
#action = %(action_mwl)s
#action = %(action_mw)s
#maxretry = 1
#bantime = 30

Some files were not shown because too many files have changed in this diff Show More