diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index b3fa1e0..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,12 +0,0 @@ -version: 2 -updates: - - package-ecosystem: github-actions - directory: "/" - schedule: - interval: daily - time: "04:00" - reviewers: - - "waja" - pull-request-branch-name: - separator: "-" - open-pull-requests-limit: 10 diff --git a/.github/workflows/packaging_test.yml b/.github/workflows/packaging_test.yml deleted file mode 100644 index c478ef5..0000000 --- a/.github/workflows/packaging_test.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Packaging Test - -on: - push: - branches: - - $default-branch - - development - - master - # Run tests for any PRs - pull_request: - -env: - SOURCE_DIR: ./ - ARTIFACTS_DIR: debian/build/release/ - -jobs: - test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - env: - DEBIAN_FRONTEND: "noninteractive" - - name: Remove github artefacts - run: | - rm -rf .github* - - name: Adjust distibution in changelog file - run: | - sed -i '0,/restricted/s//stable/' debian/changelog - - name: Build Debian package - uses: dawidd6/action-debian-package@v1.5.0 - with: - artifacts_directory: debian/build/release/ - os_distribution: testing - - name: Debug - run: | - ls -la diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f384f5e..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,71 +0,0 @@ -on: - push: - # Sequence of patterns matched against refs/tags - tags: - - 'debian/*' # Push events to matching debian/*, i.e. debian/1.0-2, debian/20.15.10, debian/23.20020326 - -name: Release Process - -env: - SOURCE_DIR: ./ - ARTIFACTS_DIR: debian/build/release/ - -jobs: - create-release: - name: Create Release - runs-on: ubuntu-latest - outputs: - release-id: ${{ steps.create_release.outputs.id }} - steps: - - name: Checkout code - uses: actions/checkout@v4 - - name: Install needed packages - run: | - if [ $(dpkg -l | grep -c dpkg-dev) -ne 1 ]; then sudo apt-get update && sudo apt-get install -y dpkg-dev; fi - - name: Gather changelog - run: | - ls -la - dpkg-parsechangelog | tail -n +9 > debian.changelog - - name: Create Release - id: create_release - uses: actions/create-release@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token - with: - tag_name: ${{ github.ref }} - release_name: Release ${{ github.ref }} - body_path: debian.changelog - draft: false - prerelease: false - - build: - name: Build and upload packages - needs: create-release - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - env: - DEBIAN_FRONTEND: "noninteractive" - - name: Remove github artefacts - run: | - rm -rf .github* - - name: Adjust distibution in changelog file - run: | - sed -i '0,/restricted/s//stable/' debian/changelog - - name: Build Debian package - uses: dawidd6/action-debian-package@v1.5.0 - with: - artifacts_directory: debian/build/release/ - os_distribution: testing -# - name: Build Debian package -# uses: pi-top/action-debian-package@v0.2.0 -# with: -# artifacts_directory: debian/build/release/ -# target_architectures: "amd64,i386" - - name: Upload the artifacts - uses: skx/github-action-publish-binaries@release-2.0 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - releaseId: ${{ needs.create-release.outputs.release-id }} - args: debian/build/release/* diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index fcf0af0..0000000 --- a/.travis.yml +++ /dev/null @@ -1,32 +0,0 @@ -dist: xenial -sudo: required - -env: - - TRAVIS_DEBIAN_DISTRIBUTION=unstable TRAVIS_DEBIAN_MIRROR="http://httpredir.debian.org/debian/" TRAVIS_DEBIAN_SECURITY_UPDATES=false - - TRAVIS_DEBIAN_DISTRIBUTION=testing TRAVIS_DEBIAN_MIRROR="http://httpredir.debian.org/debian/" - - TRAVIS_DEBIAN_DISTRIBUTION=stable TRAVIS_DEBIAN_MIRROR="http://httpredir.debian.org/debian/" - -services: - - docker - -before_script: - # fetch all tags (not done due travis cloning with depth=50) - - git fetch --tags - -script: - # build the debian package - - wget -O- http://travis.debian.net/script.sh | sh - - -after_script: - # run lintian after build - - sudo add-apt-repository -y ppa:waja/trusty-backports - - sudo apt-get update -qq - - sudo apt-get install -qq --no-install-recommends lintian - - lintian --info --display-info --display-experimental --pedantic --show-overrides ../*.deb && lintian --info --display-info --display-experimental --pedantic --show-overrides ../*.dsc - -#notifications: -# email: false - -branches: - except: - - /^debian\/\d/ diff --git a/bin/postfwd-script.sh b/bin/postfwd-script.sh index 0992843..4dac696 100755 --- a/bin/postfwd-script.sh +++ b/bin/postfwd-script.sh @@ -7,7 +7,6 @@ PATH=/bin:/usr/bin:/usr/local/bin # path to program -#PFWCMD=/usr/local/postfwd/sbin/postfwd2 PFWCMD=/usr/local/postfwd/sbin/postfwd # rulesetconfig file PFWCFG=/etc/postfix/postfwd.cf diff --git a/debian/.gitlab-ci.yml b/debian/.gitlab-ci.yml deleted file mode 100644 index 0100fa0..0000000 --- a/debian/.gitlab-ci.yml +++ /dev/null @@ -1,14 +0,0 @@ -include: - - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/salsa-ci.yml - - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/pipeline-jobs.yml - -variables: - RELEASE: 'unstable' - SALSA_CI_DISABLE_APTLY: 0 - SALSA_CI_DISABLE_AUTOPKGTEST: 1 - SALSA_CI_DISABLE_BLHC: 0 - SALSA_CI_DISABLE_LINTIAN: 0 - SALSA_CI_DISABLE_PIUPARTS: 1 - SALSA_CI_DISABLE_REPROTEST: 1 - SALSA_CI_DISABLE_BUILD_PACKAGE_ALL: 0 - SALSA_CI_DISABLE_BUILD_PACKAGE_ANY: 0 diff --git a/debian/bin/github-release.sh b/debian/bin/github-release.sh deleted file mode 100755 index 79da0c9..0000000 --- a/debian/bin/github-release.sh +++ /dev/null @@ -1,188 +0,0 @@ -#!/bin/bash - -# Copyright (c) 2014 Terry Burton -# -# https://github.com/terryburton/travis-github-release -# -# Permission is hereby granted, free of charge, to any -# person obtaining a copy of this software and associated -# documentation files (the "Software"), to deal in the -# Software without restriction, including without -# limitation the rights to use, copy, modify, merge, -# publish, distribute, sublicense, and/or sell copies of -# the Software, and to permit persons to whom the Software -# is furnished to do so, subject to the following -# conditions: -# -# The above copyright notice and this permission notice -# shall be included in all copies or substantial portions -# of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY -# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO -# THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A -# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, -# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF -# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -# IN THE SOFTWARE. - -# This script provides a simple continuous deployment -# solution that allows Travis CI to publish a new GitHub -# release and upload assets to it whenever a tag is pushed: -# git tag; git push --tags -# -# It is created as a temporary solution whilst we wait for -# Travis DPL to support GitHub: -# -# https://github.com/travis-ci/dpl -# -# Place this script somewhere in your project repository (perhaps by forking -# the github-travis-release repo and adding your fork as a git submodule) then -# put something like this to your .travis.yml: -# -# after_success: .travis/github-release.sh "$TRAVIS_REPO_SLUG" "`head -1 src/VERSION`" build/release/* -# -# The first argument is your repository in the format -# "username/repository", which Travis provides in the -# TRAVIS_REPO_SLUG environment variable. -# -# The second argument is the release version which as a -# sanity check should match the tag that you are releasing. -# You could pass "`git describe`" to satisfy this check. -# -# The remaining arguments are a list of asset files that you -# want to publish along with the release. -# -# The script requires that you create a GitHub OAuth access -# token to facilitate the upload: -# -# https://help.github.com/articles/creating-an-access-token-for-command-line-use -# -# You must pass this securely in the GITHUBTOKEN environment -# variable: -# -# http://docs.travis-ci.com/user/encryption-keys/ -# -# For testing purposes you can create a local convenience -# file in the script directory called GITHUBTOKEN that sets -# the GITHUBTOKEN environment variable. If you do so you MUST -# ensure that this doesn't get pushed to your repository, -# perhaps by adding it to a .gitignore file. -# -# Should you get stuck then look at a working example. This -# code is being used by Barcode Writer in Pure PostScript -# for automated deployment: -# -# https://github.com/terryburton/postscriptbarcode - -set -e - -REPO=$1 && shift -RELEASE=$1 && shift -RELEASEFILES=$@ - -if ! TAG=`git describe --exact-match --tags 2>/dev/null`; then - echo "This commit is not a tag so not creating a release" - exit 0 -fi - -if [ "$TRAVIS" = "true" ] && [ -z "$TRAVIS_TAG" ]; then - echo "This build is not for the tag so not creating a release" - exit 0 -fi - -if [ "$TRAVIS" = "true" ] && [ "$TRAVIS_TAG" != "$RELEASE" ]; then - echo "Error: TRAVIS_TAG ($TRAVIS_TAG) does not match the indicated release ($RELEASE)" - exit 1 -fi - -if [ "$TAG" != "$RELEASE" ]; then - echo "Error: The tag ($TAG) does not match the indicated release ($RELEASE)" - exit 1 -fi - -if [[ -z "$RELEASEFILES" ]]; then - echo "Error: No release files provided" - exit 1 -fi - -SCRIPTDIR=`dirname $0` -[ -e "$SCRIPTDIR/GITHUBTOKEN" ] && . "$SCRIPTDIR/GITHUBTOKEN" -if [[ -z "$GITHUBTOKEN" ]]; then - echo "Error: GITHUBTOKEN is not set" - exit 1 -fi - -echo "Creating GitHub release for $RELEASE" - -echo -n "Create draft release... " -JSON=$(cat < Mon, 23 Jan 2023 12:43:03 +0000 - -postfwd (1.35-8) unstable; urgency=medium - - * [d32c972] d/watch: Update to new url scheme - * [47e9ee0] Bump debhelper from old 12 to 13. - * [cac0b96] Bump Standards-Version to 4.6.2 - * [98d8062] Update watch file format version to 4. - * [7ba39f1] Drop lsb-base, sysvinit-utils is essential - * [be975fb] Set Rules-Requires-Root: no. - - -- Jan Wagner Mon, 23 Jan 2023 12:40:57 +0000 - -postfwd (1.35-7) unstable; urgency=medium - - * [f2a169d] Use secure copyright file specification URI. - * [270413d] Use secure URI in Homepage field. - * [1563d38] d/source/options: Adding .github to diff ignore - * [f32e604] Adding d/.gitlab-ci.yml - * [94f95bc] Adding Dependabot config - * [b16de77] Do not remove .git* anymore - * [4926505] ci: pin action versions - * [d0ecd91] d/rules: Calling dh_installsystemd (Closes: #994901) - - -- Jan Wagner Tue, 28 Sep 2021 13:28:53 +0200 - -postfwd (1.35-6) unstable; urgency=medium - - * [1446da0] Fix initscript (Closes: #942414) - * [3abd7a4] Bump Standards-Version to 4.5.1.0, no changes needed - * [27de180] Adding Github CI - * [a282d29] d/control: Raise compat level to 12 - - -- Jan Wagner Wed, 06 Jan 2021 21:49:07 +0100 - -postfwd (1.35-5) unstable; urgency=medium - - * [217213b] Adding systemd unit file - * [8e419b4] Add a bit documentation about systemd (and sysvinit) - * [62139a7] travis-ci: Use xenial image - * [ac0ac42] d/control: Bump Standards-Version to 4.3.0, no changes needed - * [e438455] d/postfwd.postrm: detect existens of command by which and - not 'test -x' - - -- Jan Wagner Thu, 24 Jan 2019 09:37:19 +0100 - -postfwd (1.35-4) unstable; urgency=medium - - * [e8799d3] travis-ci: don't install build-deps manual - * [c86c540] travis-ci: build package with dpkg-buildpackage - * [07e9eeb] travis-ci: Initial support for uploading releases to github - * [231a90f] Merging upstream changes of github-release.sh - * [b832cd0] Updating copyright and author of debian/bin/github-release.sh - * [5e353b5] debian/control: reformating with warp-and-sort - * [3862572] Reformating with warp-and-sort the rest of debian/ - * [d4687ee] travis-ci: grab actual used upstream version - * [4d0d01d] travis-ci: Adding required arguments for trusty - * [11da7ca] travis-ci: automatically install dependencies - * [7ad8c99] d/control: Bump Standards-Version to 3.9.8, no changes needed - * [80b011c] d/control: Depend on lsb-base - * [583a10d] travis-ci: Make use of travis.d.n - - -- Jan Wagner Mon, 05 Dec 2016 11:50:27 +0100 - -postfwd (1.35-3) unstable; urgency=medium - - * [965e0d7] Remove shiped html files from binaries - * [17c1925] Bump Standards-Version to 3.9.6, no changes needed - - -- Jan Wagner Mon, 13 Oct 2014 15:02:11 +0200 - -postfwd (1.35-2) unstable; urgency=low - - * Migrate over example installation to postfwd.examples - * Add plugins/*.sample to examples - * [6f4f77b] Remove generated hapolicy manpage in clean target - * [05ca589] Updating standards version to 3.9.4, no changes needed - * [bb64a82] Source init functions in init script - * [5d8b250] Update Vcs-headers - * [0df5d0a] Updating standards version to 3.9.5, no changes needed - * [86f8f61] Add travis-ci config - * [010082b] Remove unneeded purge from travis config - * [7542e86] Reorder and comment .travis.yml - * [7025f4f] Add lintian checks after build - * [ddbfcc0] Update to recent copyright format - * [b9b503e] Move samples into /usr/share/doc/postfwd/examples - * [1e7c202] Add 10_fix_wording_manpages.patch to fix manpages - * [f7da50f] travis-ci: Remove dpatch from build-deps - * [dd5f01d] Add 20_fix_postfwd1_default_umask.patch to fix postfwd default - umask (Closes: #717607), thanks Jesse Norell - * [172a432] Fix bug report source format move - - -- Jan Wagner Sun, 09 Mar 2014 23:43:28 +0100 - -postfwd (1.35-1) unstable; urgency=low - - * New upstream release - - fixed fixed taint mode logging error - - check_* functions use print/getline instead of send/recv for large - --dumpcache output - - log_* routines added to allow the same plugins for postfwd1 and postfwd2 - - added more information when using --debug=cleanup - - new sendmail(sendmail-path::from::to::subject::body) action - - rate(), size() and rcpt() function index is now case insensitive by - default - - fixed segfault when using new perl versions (Closes: #697653) - - -- Jan Wagner Wed, 22 May 2013 14:49:15 +0200 - -postfwd (1.33-1) UNRELEASED; urgency=low - - * New upstream release - - fixed bug when computing scores with more than 1 digit after the "." - - fixed bug when computing negative values with the set action - - ITEMS plugins returning zero values were handled incorrectly - - max command recursion was not reset for each rule - - fixed warning about use of (uninitialized value) when STORABLE - is available but no cache file was defined (Closes: #697657) - * Fix comment in /etc/default/postfwd (Closes: #679924), thanks Jeroen - Koekkoek - * Fix typo in README.Debian (closes: #691242), thanks Axel Beckert - - -- Jan Wagner Thu, 29 Mar 2012 20:31:17 +0200 - -postfwd (1.32-2) unstable; urgency=low - - * Switch over to packaging format 3.0 (quilt) (Closes: #664368) - * Updating standards version to 3.9.3, no changes needed - * Remove build-dependency of dpatch - * Use dh_prep instead of dh_clean -k - * Add build-arch and build-indep targets to debian/rules - - -- Jan Wagner Thu, 29 Mar 2012 20:22:17 +0200 - -postfwd (1.32-1) unstable; urgency=low - - * New upstream release - - new option --save_rates= is able to load and save rate limit counters - to disk on program start and termination. - - the --debugitem="sender=example\.org$" option allows verbose logging for - particular requests - - the debug() action enables verbose logging for certain rules - - nested commands are possible now - - new mail(server/helo/from/to/subject/body) action. - - single cache items can be wiped - - sasl_username is logged if available - - rate limit action is executed, if the first request exceeds the limit - - exceeded ratecounters will not be kept permanently anymore - - rate limits are evaluated at ruleset stage now - - new parser enhancement is able to omit the trailing "\" for multi-line - rules - - new plugin interface (BETA) - - Time::HiRes is used if available - - multiple rate limits for the same items are supported now - - new $$ratecount variable for rate() actions - - new option --keep_rates - - queueid is logged when available - - rate limits fixed - - new --debug class 'cleanup' - - documentation updates and fixes - * Suppress output on restarting via init script (Closes: #636782), thanks - Martin F. Krafft for reporting - * Add hapolicy and manpage into separate binary package - * Reorganize documentation - - Add new files from upstream to documentation - - Changelogs where renamed by upstream - * Bump Standards-Version to 3.9.2, no changes needed - - -- Jan Wagner Wed, 21 Dec 2011 22:27:27 +0100 - -postfwd (1.20-1) unstable; urgency=low - - * New upstream release - - Release contains postfwd1 and postfwd2 now (Closes: #582969) - - new --umask setting allows to set filepermissions for pidfiles and unix - domain sockets - - Rate limit code rewritten - - rbl checks disabled for ipv6 addresses, cidr compare will switch to - default (regex/string) - - rbl check could fail on multiple dnsbl answers - * Add dpatch infrastructure - * Provide update-alternatives for choosing the postfwd variant - * Install also CHANGELOG2 - * Bump Standards-Version to 3.9.1, no changes needed - - -- Jan Wagner Thu, 10 Feb 2011 08:38:04 +0100 - -postfwd (1.18-1) unstable; urgency=low - - * New upstream release - - Fixed bug when comparing sender and recipient addresses, like - "sender=$$recipient" - - -- Jan Wagner Thu, 29 Apr 2010 08:46:25 +0200 - -postfwd (1.17-1) unstable; urgency=low - - * New upstream release - - Net::DNS internal errors will now be handled gracefully - - default for options --dns_max_ns_a_lookups and --dns_max_mx_a_lookups of - 100 - - Fixed variable substitution when the '=' operator is used - - -- Jan Wagner Mon, 22 Mar 2010 09:02:31 +0100 - -postfwd (1.16-2) unstable; urgency=low - - * Bump Standards-Version to 3.8.4, no changes needed - * Migrate Vcs-Fields over to scm.uncompleted.org - * Add 1.0 to debian/source/format - - -- Jan Wagner Wed, 10 Mar 2010 12:35:57 +0100 - -postfwd (1.16-1) unstable; urgency=low - - * NEW upstream release - - documentation fixed - - configuration parser improvements - - option --reload (HUP signal) now reloads config, if the file is unchanged - - redirect syslog to stdout for --kill, --reload and --showconfig - - new rcpt() command counts recipients for rate limits - - helo_address, and sender_(ns|mx)_addrs can now be csv items - - items may now be retrieved from files using "item=file:/some/where" - * Add "Copyright" to all copyrights in debian/copyright - * Bump standards version to 3.8.3 (no changes needed) - * Fix speeling errors in debian/README.Debian - - -- Jan Wagner Thu, 14 Jan 2010 19:32:26 +0100 - -postfwd (1.14-1) unstable; urgency=low - - * new upstream release - - new compare operators - - added --nodaemon option - - perform non dns items first - - enabled dns cache for sender(ns|mx) and helo address - - new options --dns_max_ns_lookups and --dns_max_mx_lookups - - new items sender_ns_names and sender_ns_addrs - - new items sender_mx_names and sender_mx_addrs - - new item helo_address, please see docs for more - - added --proto switch, to enable the use of unix domain sockets - - added command-line options --kill and --reload - - dnsbl txt lookups only for dnsbls with at least one a record - - small performance improvement - - ask() action allows to use another policy service - - new options --noidlestats and --norulelog - * install postfwd.cf.sample, was renamed upstream - * leave hints about documentation and config verification in README.Debian - * Bump standards version to 3.8.2 (no changes needed) - - -- Jan Wagner Mon, 06 Jul 2009 21:15:35 +0200 - -postfwd (1.10pre8b-1) unstable; urgency=low - - * new upstream release - - Net::CIDR::Lite is not required any longer - - Net::DNS::Async is no longer used - - changed Net::Server behaviour to ignore syslog errors - - --shortlog is now default behaviour (use -v to see more) - - days=Wed now means exactly Wednesday - - disabled fallback to synchronous dns on timed out rbls - - new item "rhsbl_helo" allows to check helo against rhsbls - - the new variable $$request_hits contains a list of all matching ruleids - - the new variable $$dnsbltext allows access to txt records of rbls - - new options --no-rulestats and --nodnslog - - ttls of the dns responses override --cache-rbl-timeout when bigger - * drop dependency of libnet-cidr-lite-perl and libnet-dns-async-perl - * add dependency of libnet-dns-perl - - -- Jan Wagner Thu, 19 Feb 2009 22:39:09 +0100 - -postfwd (1.10pre7c-3) unstable; urgency=low - - * implement machine-interpretable copyright file - * fix init script (Closes: #503597). - - let daemon write pid file for his own - - point start-stop daemon to pidfile when stoping - - fix reload by fixing the way how to get the pid - * fix example-cfg2.txt to work with 1.10pre7 (Closes: #503596). - - -- Jan Wagner Fri, 31 Oct 2008 09:55:52 +0100 - -postfwd (1.10pre7c-2) unstable; urgency=low - - * Uploading to unstable. - * Updating standards version to 3.8.0, no changes needed - - -- Jan Wagner Tue, 15 Jul 2008 22:43:08 +0200 - -postfwd (1.10pre7c-1) experimental; urgency=low - - * Initial release (Closes: #470356). - - -- Jan Wagner Sat, 31 May 2008 22:07:08 +0200 diff --git a/debian/control b/debian/control deleted file mode 100644 index 995c952..0000000 --- a/debian/control +++ /dev/null @@ -1,36 +0,0 @@ -Source: postfwd -Section: mail -Priority: optional -Maintainer: Jan Wagner -Build-Depends: debhelper-compat (= 13), html2text -Homepage: https://www.postfwd.org/ -Vcs-Browser: https://gitlab.uncompleted.org/debian/postfwd -Vcs-Git: https://gitlab.uncompleted.org/debian/postfwd.git -Standards-Version: 4.6.2 -Rules-Requires-Root: no - -Package: postfwd -Architecture: all -Depends: adduser, - libnet-dns-perl, - libnet-server-perl, - ${misc:Depends}, - ${perl:Depends} -Conflicts: postfwd2 -Description: Postfix policyd to combine complex restrictions in a ruleset - Postfwd is written in perl to combine complex postfix restrictions in a - ruleset similar to those of the most firewalls. The program uses the postfix - policy delegation protocol to control access to the mail system before a - message has been accepted. It allows you to choose an action (e.g. reject, - dunno) for a combination of several smtp parameters (like sender and recipient - address, size or the client's TLS fingerprint). - -Package: hapolicy -Architecture: all -Depends: ${misc:Depends}, ${perl:Depends} -Description: Balancing and fallback postfix policy delegation service - Hapolicy enables high availability, weighted loadbalancing and a fallback - action for postfix policy delegation services. Invoked via postfix spawn - it acts as a wrapper that queries other policy servers via tcp connection. - The order of the service queries can be influenced by assigning a specific - priority and weight to each service. diff --git a/debian/copyright b/debian/copyright deleted file mode 100644 index ba7f2f8..0000000 --- a/debian/copyright +++ /dev/null @@ -1,82 +0,0 @@ -Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ -Upstream-Name: postfwd -Upstream-Contact: Jan Peter Kessler -Source: http://www.postfwd.org - -Files: * -Copyright: Copyright (c) 2007, Jan Peter Kessler, All rights reserved. -License: BSD-3 - -Files: debian/* -Copyright: Copyright (C) 2006, 2008 Jan Wagner -License: GPL-2+ - -Files: debian/example-cfg2.txt -Copyright: Copyright (c) 2008, Henrik Krohns -License: BSD-3 - -Files: debian/bin/github-release.sh -Copyright: Copyright (c) 2014 Terry Burton -License: Expat - -License: Expat - Permission is hereby granted, free of charge, to any person obtaining - a copy of this software and associated documentation files (the - "Software"), to deal in the Software without restriction, including - without limitation the rights to use, copy, modify, merge, publish, - distribute, sublicense, and/or sell copies of the Software, and to - permit persons to whom the Software is furnished to do so, subject to - the following conditions: - . - The above copyright notice and this permission notice shall be included - in all copies or substantial portions of the Software. - . - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -License: BSD-3 - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are met: - . - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - * Neither the name of the authors nor the names of his contributors may be - used to endorse or promote products derived from this software without - specific prior written permission. - . - THIS SOFTWARE IS PROVIDED BY ME ``AS IS'' AND ANY EXPRESS OR IMPLIED - WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO - EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, - PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; - OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, - WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR - OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -License: GPL-2+ - 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 2 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, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - . - On Debian systems, the complete text of the GNU General Public License can be - found in /usr/share/common-licenses/GPL-2 file. diff --git a/debian/example-cfg2.txt b/debian/example-cfg2.txt deleted file mode 100644 index e8ef10a..0000000 --- a/debian/example-cfg2.txt +++ /dev/null @@ -1,146 +0,0 @@ -# downloaded from http://hege.li/howto/spam/etc/postfwd/postfwd.conf -# check for more recent versions! - -### -### Example config for postfwd 1.10pre7+ -### - -## Check DNS whitelists, maybe we don't need more checks - -id=OK_DNSWL; \ - rbl=list.dnswl.org/^127/43200; \ - action=DUNNO - -## Check (non-fqdn/ip/dynamic) HELO and (missing) reverse DNS - -id=SET_HELO; \ - helo_name=!!\.; \ - helo_name=[0-9.-]{7}; \ - action=set(HIT_helo=1) - -id=SET_NODNS; \ - client_name=^unknown$; \ - action=set(HIT_nodns=1) - -id=REJECT_HELO_NODNS; \ - HIT_helo==1; HIT_nodns==1; \ - action=REJECT Blocked - contact postmaster@example.net for help - Suspicious HELO [$$helo_name] and missing reverse DNS [$$client_address] - -## Check ZEN first for immediate blocking - less queries for other lists -## See usage policy: http://www.spamhaus.org/organization/dnsblusage.html - -id=REJECT_RBL_ZEN; \ - rbl=zen.spamhaus.org; \ - action=REJECT Blocked - contact postmaster@example.net for help - zen.spamhaus.org RBL - -## Check other DNSBLs in parallel - -&&DNSBLS { \ - rbl=bl.spamcop.net; \ - rbl=dnsbl-1.uceprotect.net; \ - rbl=dnsbl-2.uceprotect.net; \ - rbl=dnsbl-3.uceprotect.net; \ - rbl=psbl.surriel.com; \ - rbl=combined.njabl.org; \ - rbl=dnsbl.ahbl.org; \ - rbl=dnsbl.sorbs.net; \ - rbl=ix.dnsbl.manitu.net; \ - rbl=dyna.spamrats.com; \ -}; - -id=EVAL_DNSBLS; \ - &&DNSBLS; rblcount=all; \ - action=set(HIT_rbls=$$rblcount) - -id=REJECT_RBL_MULTI; \ - HIT_rbls>=2; \ - action=REJECT Blocked - contact postmaster@example.net for help - Multiple DNSBLs - -## Check RHSBLs if there wasn't enough DNSBLs hit - -&&RHSBLS_REVERSE { \ - rhsbl_reverse_client=dynamic.rhs.mailpolice.com; \ -}; - -&&RHSBLS_SENDER { \ - rhsbl_sender=multi.uribl.com; \ - rhsbl_sender=multi.surbl.org; \ - rhsbl_sender=bulk.rhs.mailpolice.com; \ - rhsbl_sender=rhsbl.ahbl.org; \ - rhsbl_sender=rhsbl.sorbs.net; \ - rhsbl_sender=dsn.rfc-ignorant.org; \ -}; - -id=EVAL_RHSBLS; \ - &&RHSBLS_REVERSE; &&RHSBLS_SENDER; rhsblcount=all; \ - action=set(HIT_rhsbls=$$rhsblcount) - -id=REJECT_RHSBL_MULTI; \ - HIT_rhsbls>=2; \ - action=REJECT Blocked - contact postmaster@example.net for help - Multiple RHSBLs - -## See if we get any combined hits from rules before - -id=REJECT_RBL_RHSBL; \ - HIT_rbls>=1; HIT_rhsbls>=1; \ - action=REJECT Blocked - contact postmaster@example.net for help - RHSBL and DNSBL - -id=REJECT_RBL_HELO; \ - HIT_rbls>=1; HIT_helo==1; \ - action=REJECT Blocked - contact postmaster@example.net for help - DNSBL and suspicious HELO [$$helo_name] - -id=REJECT_RBL_NODNS; \ - HIT_rbls>=1; HIT_nodns==1; \ - action=REJECT Blocked - contact postmaster@example.net for help - DNSBL and missing reverse DNS [$$client_address] - -id=REJECT_RHSBL_HELO; \ - HIT_rhsbls>=1; HIT_helo==1; \ - action=REJECT Blocked - contact postmaster@example.net for help - RHSBL and suspicious HELO [$$helo_name] - -id=REJECT_RHSBL_NODNS; \ - HIT_rhsbls>=1; HIT_nodns==1; \ - action=REJECT Blocked - contact postmaster@example.net for help - RHSBL and missing reverse DNS [$$client_address] - -## Finally greylist all lesser hits. -## -## A more DNSBL friendly way would be to greylist everything suspicious -## before DNS checks. Currently this requires you to setup some postfix -## tables before postfwd is called, since greylisting can be only done last -## in postfwd (action always exits processing). - -id=GREY_HELO; HIT_helo==1; action=check_postgrey -id=GREY_NODNS; HIT_nodns==1; action=check_postgrey -id=GREY_RBL; HIT_rbls>=1; action=check_postgrey -id=GREY_RHSBL; HIT_rhsbls>=1; action=check_postgrey - - -## -## This example is free to use as per BSD license: -## -## Copyright (c) 2008, Henrik Krohns -## All rights reserved. -## -## Redistribution and use in source and binary forms, with or without modification, -## are permitted provided that the following conditions are met: -## -## * Redistributions of source code must retain the above copyright -## notice, this list of conditions and the following disclaimer. -## * Redistributions in binary form must reproduce the above copyright -## notice, this list of conditions and the following disclaimer in -## the documentation and/or other materials provided with the -## distribution. -## * Neither the name of the authors nor the names of his contributors -## may be used to endorse or promote products derived from this -## software without specific prior written permission. -## -## THIS SOFTWARE IS PROVIDED BY ME ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, -## INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -## FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, -## INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -## NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -## PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, -## WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -## POSSIBILITY OF SUCH DAMAGE. -## - diff --git a/debian/hapolicy.docs b/debian/hapolicy.docs deleted file mode 100644 index 8216e68..0000000 --- a/debian/hapolicy.docs +++ /dev/null @@ -1,3 +0,0 @@ -doc/hapolicy.txt -tools/hapolicy/hapolicy.* -tools/hapolicy/hapolicy[0-9a-zA-Z.]* diff --git a/debian/hapolicy.manpages b/debian/hapolicy.manpages deleted file mode 100644 index e093172..0000000 --- a/debian/hapolicy.manpages +++ /dev/null @@ -1 +0,0 @@ -man/man8/hapolicy.1 diff --git a/debian/patches/10_fix_wording_manpages.patch b/debian/patches/10_fix_wording_manpages.patch deleted file mode 100644 index 156253c..0000000 --- a/debian/patches/10_fix_wording_manpages.patch +++ /dev/null @@ -1,172 +0,0 @@ -From: Jan Wagner -Subject: Fixing cosmetical issues -diff --git a/man/man8/postfwd.8 b/man/man8/postfwd.8 -index 3e4354b..49deff1 100644 ---- a/man/man8/postfwd.8 -+++ b/man/man8/postfwd.8 -@@ -335,7 +335,7 @@ postfwd versions prior to 1.30 require trailing ';' and '\e'\-characters: - \& the specified action will be returned to postfix - \& scores are set global until redefined! - \& --\& request_score \- this value allows to access a request\*(Aqs score. it -+\& request_score \- this value allows one to access a request\*(Aqs score. it - \& may be used as variable ($$request_score). - \& - \& rbl, rhsbl, \- query the specified RBLs/RHSBLs, possible values are: -@@ -466,7 +466,7 @@ The following items currently have to be unique: - \& id, minimum and maximum values, rblcount and rhsblcount - .Ve - .PP --Any item can be negated by preceeding '!!' to it, e.g.: -+Any item can be negated by preceding '!!' to it, e.g.: - .PP - .Vb 1 - \& id=HOST001 ; hostname == !!secure.trust.local ; action=REJECT only secure.trust.local please -@@ -484,7 +484,7 @@ To avoid confusion with regexps or simply for better visibility you can use '!!( - \& id=USER01 ; sasl_username = !!( (bob|alice) ) ; action=REJECT who is that? - .Ve - .PP --Request attributes can be compared by preceeding '$$' characters, e.g.: -+Request attributes can be compared by preceding '$$' characters, e.g.: - .PP - .Vb 3 - \& id=R\-003 ; client_name = !! $$helo_name ; action=WARN helo does not match DNS -@@ -637,7 +637,7 @@ with postfwd1 v1.15 and postfwd2 v0.18 and higher. - \&\fIGeneral\fR - .PP - Actions will be executed, when all rule items have matched a request (or at least one of any item list). You can refer to --request attributes by preceeding $$ characters, like: -+request attributes by preceding $$ characters, like: - .PP - .Vb 3 - \& id=R\-003; client_name = !!$$helo_name; action=WARN helo \*(Aq$$helo_name\*(Aq does not match DNS \*(Aq$$client_name\*(Aq -@@ -730,7 +730,7 @@ postfwd actions control the behaviour of the program. Currently you can specify - \& means that requests from bob@example.local and BoB@example.local will be treated differently - \& - \& ask (:[:]) --\& allows to delegate the policy decision to another policy service (e.g. postgrey). the first -+\& allows one to delegate the policy decision to another policy service (e.g. postgrey). the first - \& and the second argument (address and port) are mandatory. a third optional argument may be - \& specified to tell postfwd to ignore certain answers and go on parsing the ruleset: - \& # example1: query postgrey and return it\*(Aqs answer to postfix -@@ -832,7 +832,7 @@ carefully, because errors may cause postfwd to break! It is also - allowed to override attributes or built-in functions, but be sure that you know - what you do because some of them are used internally. - .PP --Please keep security in mind, when you access sensible ressources and never, ever -+Please keep security in mind, when you access sensible resources and never, ever - run postfwd as privileged user! Also never trust your input (especially hostnames, - and e\-mail addresses). - .PP -@@ -866,7 +866,7 @@ the policy delegation request and therefore may be used in postfwd's ruleset. - \& - \& # EXAMPLES \- integrated in postfwd. no need to activate them here. - \& --\& # allows to check postfwd version in ruleset -+\& # allows one to check postfwd version in ruleset - \& "version" => sub { - \& my(%request) = @_; - \& my(%result) = ( -@@ -1505,7 +1505,7 @@ equals to - \& id=R001; sender=bob@alice.local; client_address=192.168.1.1; action=dunno - .Ve - .PP --Lists will be evaluated in the specified order. This allows to place faster expressions at first: -+Lists will be evaluated in the specified order. This allows one to place faster expressions at first: - .PP - .Vb 1 - \& postfwd \-vv \-L \-r "id=RBL001; rbl=localrbl.local zen.spamhaus.org; action=REJECT" /some/where/request.sample -diff --git a/man/man8/postfwd2.8 b/man/man8/postfwd2.8 -index 11319fd..fdb3a6f 100644 ---- a/man/man8/postfwd2.8 -+++ b/man/man8/postfwd2.8 -@@ -193,7 +193,7 @@ postfwd2 \- postfix firewall daemon - \& \-n, \-\-nodns skip any dns based test - \& \-\-dns_timeout dns query timeout in seconds - \& \-\-dns_timeout_max disable dnsbl after timeouts --\& \-\-dns_timeout_interval reenable dnsbl after seconds -+\& \-\-dns_timeout_interval re-enable dnsbl after seconds - \& \-\-cache\-rbl\-timeout default dns ttl if not specified in ruleset - \& \-\-cache\-rbl\-default default dns pattern if not specified in ruleset - \& \-\-cleanup\-rbls cleanup old dns cache items every seconds -@@ -364,7 +364,7 @@ postfwd versions prior to 1.30 require trailing ';' and '\e'\-characters: - \& the specified action will be returned to postfix - \& scores are set global until redefined! - \& --\& request_score \- this value allows to access a request\*(Aqs score. it -+\& request_score \- this value allows one to access a request\*(Aqs score. it - \& may be used as variable ($$request_score). - \& - \& rbl, rhsbl, \- query the specified RBLs/RHSBLs, possible values are: -@@ -495,7 +495,7 @@ The following items must be unique: - \& id, minimum and maximum values, rblcount and rhsblcount - .Ve - .PP --Any item can be negated by preceeding '!!' to it, e.g.: -+Any item can be negated by preceding '!!' to it, e.g.: - .PP - .Vb 1 - \& id=HOST001 ; hostname == !!secure.trust.local ; action=REJECT only secure.trust.local please -@@ -513,7 +513,7 @@ To avoid confusion with regexps or simply for better visibility you can use '!!( - \& id=USER01 ; sasl_username =~ !!( /^(bob|alice)$/ ) ; action=REJECT who is that? - .Ve - .PP --Request attributes can be compared by preceeding '$$' characters, e.g.: -+Request attributes can be compared by preceding '$$' characters, e.g.: - .PP - .Vb 3 - \& id=R\-003 ; client_name = !! $$helo_name ; action=WARN helo does not match DNS -@@ -666,7 +666,7 @@ with postfwd1 v1.15 and postfwd2 v0.18 and higher. - \&\fIGeneral\fR - .PP - Actions will be executed, when all rule items have matched a request (or at least one of any item list). You can refer to --request attributes by preceeding $$ characters, like: -+request attributes by preceding $$ characters, like: - .PP - .Vb 3 - \& id=R\-003; client_name = !!$$helo_name; action=WARN helo \*(Aq$$helo_name\*(Aq does not match DNS \*(Aq$$client_name\*(Aq -@@ -750,7 +750,7 @@ postfwd2 actions control the behaviour of the program. Currently you can specify - \& means that requests from bob@example.local and BoB@example.local will be treated differently - \& - \& ask (:[:]) --\& allows to delegate the policy decision to another policy service (e.g. postgrey). the first -+\& allows one to delegate the policy decision to another policy service (e.g. postgrey). the first - \& and the second argument (address and port) are mandatory. a third optional argument may be - \& specified to tell postfwd2 to ignore certain answers and go on parsing the ruleset: - \& # example1: query postgrey and return it\*(Aqs answer to postfix -@@ -852,7 +852,7 @@ carefully, because errors may cause postfwd to break! It is also - allowed to override attributes or built-in functions, but be sure that you know - what you do because some of them are used internally. - .PP --Please keep security in mind, when you access sensible ressources and never, ever -+Please keep security in mind, when you access sensible resources and never, ever - run postfwd as privileged user! Also never trust your input (especially hostnames, - and e\-mail addresses). - .PP -@@ -886,7 +886,7 @@ the policy delegation request and therefore may be used in postfwd's ruleset. - \& - \& # EXAMPLES \- integrated in postfwd. no need to activate them here. - \& --\& # allows to check postfwd version in ruleset -+\& # allows one to check postfwd version in ruleset - \& "version" => sub { - \& my(%request) = @_; - \& my(%result) = ( -@@ -1524,7 +1524,7 @@ equals to - \& id=R001; sender=bob@alice.local; client_address=192.168.1.1; action=dunno - .Ve - .PP --Lists will be evaluated in the specified order. This allows to place faster expressions at first: -+Lists will be evaluated in the specified order. This allows one to place faster expressions at first: - .PP - .Vb 1 - \& postfwd2 \-\-nodaemon \-vv \-L \-r "id=RBL001; rbl=localrbl.local zen.spamhaus.org; action=REJECT" /some/where/request.sample -@@ -1601,7 +1601,7 @@ To debug special steps of the parser the '\-\-debug' switch takes a list of debu - .PP - The common way to use postfwd2 is to start it as daemon, listening at a specified tcp port. - postfwd2 will spawn multiple child processes which communicate with a parent cache. This is --the prefered way to use postfwd2 in high volume environments. Start postfwd2 with the following parameters: -+the preferred way to use postfwd2 in high volume environments. Start postfwd2 with the following parameters: - .PP - .Vb 1 - \& postfwd2 \-d \-f /etc/postfwd.cf \-i 127.0.0.1 \-p 10045 \-u nobody \-g nobody \-S diff --git a/debian/patches/20_fix_postfwd1_default_umask.patch b/debian/patches/20_fix_postfwd1_default_umask.patch deleted file mode 100644 index 8bf3c99..0000000 --- a/debian/patches/20_fix_postfwd1_default_umask.patch +++ /dev/null @@ -1,15 +0,0 @@ -From: Jan Wagner -Subject: Fixing default umask of postfwd -diff --git a/sbin/postfwd b/sbin/postfwd -index e17a729..62f90bb 100755 ---- a/sbin/postfwd -+++ b/sbin/postfwd -@@ -49,7 +49,7 @@ our($def_net_chroot) = ""; - our($def_net_interface) = "127.0.0.1"; - our($def_net_port) = "10040"; - our($def_net_proto) = "tcp"; --our($def_net_umask) = "0111"; -+our($def_net_umask) = "0177"; - our($def_net_user) = "nobody"; - our($def_net_group) = "nobody"; - our($def_dns_queuesize) = "300"; diff --git a/debian/patches/series b/debian/patches/series deleted file mode 100644 index c5ee770..0000000 --- a/debian/patches/series +++ /dev/null @@ -1,2 +0,0 @@ -10_fix_wording_manpages.patch -20_fix_postfwd1_default_umask.patch diff --git a/debian/postfwd.README.Debian b/debian/postfwd.README.Debian deleted file mode 100644 index 3786797..0000000 --- a/debian/postfwd.README.Debian +++ /dev/null @@ -1,68 +0,0 @@ -postfwd for Debian ------------------- - -1. PROVIDE A CONFIGFILE ------------------------ - -Please provide a config file, usually /etc/postfix/postfwd.cf. Examples are -located in /usr/share/doc/postfwd/examples/. -Another can be found at http://hege.li/howto/spam/etc/postfwd/postfwd.conf -and is provided as example-cfg2.txt. - -A quickstart guide is available at http://www.postfwd.org/quick.html and the -online documentation at http://www.postfwd.org/doc.html, the offline version -can be viewed with 'postfwd -m'. - -2. VERIFY CONFIG ----------------- - -How interpret the parser your rules, you can check with: - -# postfwd -f /etc/postfix/postfwd.cf -C -v - -Check your rules against sample request: - -# cat request.sample | postfwd -f /etc/postfix/postfwd.cf -L - -# cat request.sample - ------- snip ------- -ccert_fingerprint= -size=64063 -helo_name=english-breakfast.cloud9.net -reverse_client_name=english-breakfast.cloud9.net -queue_id= -encryption_cipher= -encryption_protocol= -etrn_domain= -ccert_subject= -request=smtpd_access_policy -protocol_state=RCPT -recipient=someone@domain.local -instance=6748.46adf3f8.62156.0 -protocol_name=ESMTP -encryption_keysize=0 -recipient_count=0 -ccert_issuer= -sender=owner-postfix-users@postfix.org -client_name=english-breakfast.cloud9.net -client_address=168.100.1.7 ------- snip ------- - -Samples can be taken into the logfile when starting the daemon with "-vv" - -3. AUTOMATIC STARTUP --------------------- - -In order to avoid the startup of the daemon on an unconfigured machine, -automatic startup, on boot, is disabled by default. To enable it just run -'systemctl enable postfwd.service', when still using SysVinit edit the -file /etc/default/postfwd and set the "startup" variable to 1. - -4. CHOOSING WHICH POSTFWD VERSION TO USE ----------------------------------------- - -Since some time, there is also a prefork version available, called postfwd2. -You can use update-alternatives to choose between 'postfwd1' and 'postfwd2'. - - -- Jan Wagner Mon, 10 Mar 2008 22:37:44 +0100 diff --git a/debian/postfwd.default b/debian/postfwd.default deleted file mode 100644 index 619f4ea..0000000 --- a/debian/postfwd.default +++ /dev/null @@ -1,15 +0,0 @@ -# Global options for postfwd(8). - -# Set to '1' to enable startup (daemon mode), doesn't affect systemd -STARTUP=0 - -# Config file -CONF=/etc/postfix/postfwd.cf -# IP where listen to -INET=127.0.0.1 -# Port where listen to -PORT=10040 -# run as user postfw -RUNAS="postfw" -# Arguments passed on start (--daemon implied) -ARGS="--summary=600 --cache=600 --cache-rdomain-only --cache-no-size" diff --git a/debian/postfwd.docs b/debian/postfwd.docs deleted file mode 100644 index d4b6199..0000000 --- a/debian/postfwd.docs +++ /dev/null @@ -1,5 +0,0 @@ -debian/tmp/*.txt -doc/*.txt -doc/postfwd-ARCH.png -doc/postfwd2.CHANGELOG -tools/*.pl diff --git a/debian/postfwd.examples b/debian/postfwd.examples deleted file mode 100644 index 26c37f7..0000000 --- a/debian/postfwd.examples +++ /dev/null @@ -1,4 +0,0 @@ -debian/example-cfg* -etc/postfwd.cf.sample -plugins/*.sample -tools/*.sample diff --git a/debian/postfwd.init b/debian/postfwd.init deleted file mode 100644 index 0394b06..0000000 --- a/debian/postfwd.init +++ /dev/null @@ -1,103 +0,0 @@ -#! /bin/sh -# Written by Miquel van Smoorenburg . -# Modified for Debian -# by Ian Murdock . -# -# Version: @(#)skeleton 1.9 26-Feb-2001 miquels@cistron.nl -# /etc/init.d/postfwd: v1 2008/03/12 Jan Wagner - -### BEGIN INIT INFO -# Provides: postfwd -# Required-Start: $local_fs $network $remote_fs $syslog -# Required-Stop: $local_fs $network $remote_fs $syslog -# Default-Start: 2 3 4 5 -# Default-Stop: 0 1 6 -# Short-Description: start and stop the postfw daemon -# Description: a Perl policy daemon for the Postfix MTA -### END INIT INFO - -PATH=/sbin:/bin:/usr/sbin:/usr/bin -NAME=postfwd -DAEMON=/usr/sbin/${NAME} -PIDFILE=/var/run/$NAME.pid -DESC=postfwd - -. /lib/lsb/init-functions - -test -x $DAEMON || exit 0 - -not_configured () { - echo "#### WARNING ####" - echo "${NAME} won't be started/stopped unless it is configured." - echo "If you want to start ${NAME} as daemon, see /etc/default/${NAME}." - echo "#################" - exit 0 -} - -no_configfile () { - echo "#### WARNING ####" - echo "${NAME} won't be started/stopped unless a rules file is provided at $CONF." - echo "#################" - exit 0 -} - -# check if postfwd is configured or not -if [ -f "/etc/default/$NAME" ] -then - . /etc/default/$NAME - if [ "$STARTUP" != "1" ] - then - not_configured - fi -else - not_configured -fi - -# check if rules file is there -if [ ! -f $CONF ] -then - no_configfile -fi - -# Check whether we have to drop privileges. -if [ -n "$RUNAS" ] -then - if ! getent passwd "$RUNAS" >/dev/null; then - RUNAS="" - fi -fi - -set -e - -case "$1" in - start) - echo -n "Starting $DESC: " - start-stop-daemon --start --quiet \ - --name ${NAME} \ - --exec $DAEMON -- ${ARGS} --daemon --file=${CONF} --interface=${INET} --port=${PORT} --user=${RUNAS} --group=${RUNAS} --pidfile=$PIDFILE - echo "$NAME." - ;; - stop) - echo -n "Stopping $DESC: " - start-stop-daemon --stop --quiet --oknodo --pidfile $PIDFILE && rm -rf $PIDFILE - echo "$NAME." - ;; - reload) - echo "Reloading $DESC configuration files." - kill -HUP $(cat $PIDFILE) - ;; - restart|force-reload) - echo -n "Restarting $DESC (incl. cache): " - $0 stop > /dev/null - sleep 1 - $0 start > /dev/null - echo "$NAME." - ;; - *) - N=/etc/init.d/$NAME - echo "Usage: $N {start|stop|restart|reload|force-reload}" >&2 - exit 1 - ;; -esac - -exit 0 diff --git a/debian/postfwd.manpages b/debian/postfwd.manpages deleted file mode 100644 index 638a3b9..0000000 --- a/debian/postfwd.manpages +++ /dev/null @@ -1,2 +0,0 @@ -debian/tmp/postfwd1.8 -man/man8/postfwd2.8 diff --git a/debian/postfwd.postinst b/debian/postfwd.postinst deleted file mode 100644 index fed6a61..0000000 --- a/debian/postfwd.postinst +++ /dev/null @@ -1,63 +0,0 @@ -#!/bin/sh -# based on arpwatch.postinst: v11 2004/09/15 KELEMEN Peter -# postinst: v1 2006/01/12 Jan Wagner - -set -e - -NUSER="postfw" -NGROUP="postfw" -NHOME="/var/lib/$NUSER" -NGECOS="postfwd user" - -case "$1" in - configure) - # Take care of group. - if NGROUP_ENTRY=`getent group $NGROUP`; then - # group exists - : - else - # group does not exist yet - addgroup --quiet --system $NGROUP - fi - - # Take care of user. - if NUSER_ENTRY=`getent passwd $NUSER`; then - # user exists - adduser --quiet $NUSER $NGROUP - # - else - # user does not exist yet - adduser --quiet --system \ - --ingroup $NGROUP \ - --gecos "$NGECOS" \ - --home $NHOME \ - --no-create-home \ - --shell /bin/sh \ - --disabled-login \ - --disabled-password \ - --shell /bin/false \ - $NUSER - fi - - # Set up home directory. - if [ -d $NHOME ]; then - chown -R ${NUSER}:${NGROUP} $NHOME - chmod -R o-rwX $NHOME - fi - ;; - - abort-upgrade|abort-remove|abort-deconfigure) - ;; - *) - echo "postinst called with unknown argument \`$1'" >&2 - exit 1 - ;; -esac - -update-alternatives --install /usr/sbin/postfwd postfwd /usr/sbin/postfwd1 100 \ - --slave /usr/share/man/man1/postfwd.1.gz postfwd.1.gz \ - /usr/share/man/man1/postfwd1.1.gz -update-alternatives --install /usr/sbin/postfwd postfwd /usr/sbin/postfwd2 120 \ - --slave /usr/share/man/man1/postfwd.2.gz postfwd.2.gz \ - /usr/share/man/man1/postfwd2.1.gz -#DEBHELPER# diff --git a/debian/postfwd.postrm b/debian/postfwd.postrm deleted file mode 100644 index 5c1cb0e..0000000 --- a/debian/postfwd.postrm +++ /dev/null @@ -1,56 +0,0 @@ -#!/bin/sh -# based on arpwatch.postrm: v2 2004/09/15 KELEMEN Peter -# postrm: v1 2006/10/12 Jan Wagner - -NUSER="postfw" -NGROUP="postfw" - -set -e - -case "$1" in - purge) - # find first and last SYSTEM_UID numbers - for LINE in `grep SYSTEM_UID /etc/adduser.conf | grep -v "^#"`; do - case $LINE in - FIRST_SYSTEM_UID*) - FIST_SYSTEM_UID=`echo $LINE | cut -f2 -d '='` - ;; - LAST_SYSTEM_UID*) - LAST_SYSTEM_UID=`echo $LINE | cut -f2 -d '='` - ;; - *) - ;; - esac - done - # remove system account if necessary - if [ -n "$FIST_SYSTEM_UID" ] && [ -n "$LAST_SYSTEM_UID" ]; then - if USERID=`getent passwd $NUSER | cut -f 3 -d ':'`; then - if [ -n "$USERID" ]; then - if [ "$FIST_SYSTEM_UID" -le "$USERID" ] && \ - [ "$USERID" -le "$LAST_SYSTEM_UID" ]; then - if which deluser > /dev/null; then - deluser --quiet $NUSER || true - # And then remove the group - GROUPID=`getent group $NGROUP | cut -f 3 -d ':'` - if [ -n "$GROUPID" ]; then - if which delgroup > /dev/null; then - delgroup --quiet $NGROUP || true - fi - fi - fi - fi - fi - fi - fi - ;; - - remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear) - ;; - - *) - echo "postrm called with unknown argument \`$1'" >&2 - exit 1 - ;; -esac - -#DEBHELPER# diff --git a/debian/postfwd.prerm b/debian/postfwd.prerm deleted file mode 100644 index 66018fb..0000000 --- a/debian/postfwd.prerm +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/sh - -set -e - -if [ "$1" = remove ] || [ "$1" = deconfigure ]; then - update-alternatives --remove postfwd /usr/sbin/postfwd1 - update-alternatives --remove postfwd /usr/sbin/postfwd2 -fi - -#DEBHELPER# diff --git a/debian/postfwd.service b/debian/postfwd.service deleted file mode 100644 index 2ca97aa..0000000 --- a/debian/postfwd.service +++ /dev/null @@ -1,15 +0,0 @@ -[Unit] -Description=Postfix firewall daemon -After=network.target -Before=postfix.service - -[Service] -Environment=PIDFILE=/var/run/postfwd.pid -EnvironmentFile=-/etc/default/postfwd -ExecStart=/usr/sbin/postfwd $ARGS --daemon --file $CONF --interface $INET --port $PORT --user $RUNAS --group $RUNAS --pidfile $PIDFILE -ExecStop=/usr/sbin/postfwd --file $CONF --pidfile $PIDFILE --kill -ExecReload=/usr/sbin/postfwd --file $CONF --pidfile $PIDFILE --reload -Type=forking - -[Install] -WantedBy=multi-user.target diff --git a/debian/rules b/debian/rules deleted file mode 100755 index f27e5e3..0000000 --- a/debian/rules +++ /dev/null @@ -1,57 +0,0 @@ -#!/usr/bin/make -f -# written by Jan Wagner -# -# Uncomment this to turn on verbose mode. -#export DH_VERBOSE=1 - -build: build-arch build-indep -build-arch: -build-indep: - -clean: - # removing generated manpage (not initial shipped) - rm -rf man/man8/hapolicy.1 - dh_testdir - dh_testroot - dh_clean - -install: build - dh_testdir - dh_testroot - dh_prep - - # install binaries - install -D -m 644 sbin/postfwd debian/postfwd/usr/sbin/postfwd1 - install -D -m 644 sbin/postfwd2 debian/postfwd/usr/sbin/postfwd2 - install -D -m 644 tools/hapolicy/hapolicy debian/hapolicy/usr/sbin/hapolicy - # install man page - mkdir -p debian/tmp/ - cp man/man8/postfwd.8 debian/tmp/postfwd1.8 - html2text doc/quick.html > debian/tmp/quick.txt - html2text doc/versions.html > debian/tmp/versions.txt - pod2man debian/hapolicy/usr/sbin/hapolicy man/man8/hapolicy.1 - -# Build architecture-independent files here. -binary-indep: build install - dh_testdir - dh_testroot - dh_installchangelogs doc/postfwd.CHANGELOG - dh_installdocs -ppostfwd -Xhapolicy - dh_installdocs -phapolicy tools/hapolicy/hapolicy[0-9a-zA-Z.]* - dh_installexamples - dh_installinit -- defaults 19 21 - dh_installsystemd --no-enable - dh_installman - dh_compress - dh_fixperms - dh_perl - dh_installdeb - dh_gencontrol - dh_md5sums - dh_builddeb - -# Build architecture-dependent files here. -binary-arch: build install - -binary: binary-indep binary-arch -.PHONY: build clean binary-indep binary-arch binary install diff --git a/debian/source/format b/debian/source/format deleted file mode 100644 index 163aaf8..0000000 --- a/debian/source/format +++ /dev/null @@ -1 +0,0 @@ -3.0 (quilt) diff --git a/debian/source/options b/debian/source/options deleted file mode 100644 index b746363..0000000 --- a/debian/source/options +++ /dev/null @@ -1 +0,0 @@ -extend-diff-ignore = '(^|/)(\.travis\.yml|\.git|\.github|\.gitgnore|config\.sub|config\.guess)' diff --git a/debian/watch b/debian/watch deleted file mode 100644 index 191f206..0000000 --- a/debian/watch +++ /dev/null @@ -1,2 +0,0 @@ -version=4 -https://postfwd.org postfwd-(.*)\.tar\.gz diff --git a/doc/postfwd.CHANGELOG b/doc/CHANGELOG similarity index 68% rename from doc/postfwd.CHANGELOG rename to doc/CHANGELOG index eacb5b0..3f4949d 100644 --- a/doc/postfwd.CHANGELOG +++ b/doc/CHANGELOG @@ -1,156 +1,3 @@ -1.35 -==== -- code: rate(), size() and rcpt() function index is now case insensitive by default - (same limit counters for from@example.org and fRom@eXample.org) - if you need to treat the localpart case-sensitive according to rfc5321 - you may use rate5321(), size5321() and rcpt5321() - -1.34 -==== -- bugfix: fixed taint mode logging error for verbose --showconfig and --stdoutlog - options and newer perl versions. -- bugfix: check_* functions use print/getline instead of send/recv for large - --dumpcache output (thanks to Alexandre Simon) -- code: log_* routines added to allow the same plugins for postfwd1 and postfwd2 -- code: added more information when using --debug=cleanup -- docs: documentation updates -- feature: new sendmail(sendmail-path::from::to::subject::body) action. - Please take a look at the manual, especially about - it's limitations, before using it! - ------------------------------------------------------------ - # alert - action=sendmail(/usr/sbin/sendmail::from@example.org::to@example.org::Subject::Text) - ------------------------------------------------------------ - - -1.33 -==== -- feature: new compare operators * - ==================================================================== - *ITEM > VALUE true if ITEM > VALUE - *ITEM < VALUE true if ITEM < VALUE - ==================================================================== -- bugfix: fixed bug when computing scores with more than 1 digit after the "." (n.nn) -- bugfix: fixed bug when computing negative values with the set action -- bugfix: ITEMS plugins returning zero values were handled incorrectly -- bugfix: max command recursion was not reset for each rule - - -1.32 -==== -- feature: new option --save_rates= allows to load and save - rate limit counters to disk on program start and termination. - this allows rate limit persistence during restarts and reboots - (requires perl module 'Storable') -- feature: the --debugitem="sender=example\.org$" option - allows verbose logging for particular requests -- feature: the debug() action allows verbose logging for certain - rules: - ------------------------------------------------------------ - id=R01 - client_address=1.1.1.1 - action=debug(on) - id=R02 - ... - id=R42 - action=debug(off) - ------------------------------------------------------------ -- feature: nested commands are possible now, e.g.: - ------------------------------------------------------------ - # throttle - action=rate(client_address/10/60/wait(3)) - ------------------------------------------------------------ -- feature: new mail(server/helo/from/to/subject/body) action. - Please take a look at the manual, especially about - it's limitations, before using it! - ------------------------------------------------------------ - # alert - action=size(recipient_domain/100000000/86400/mail(mailhost/helo/from/to/subject/text)) - ------------------------------------------------------------ - -1.31 -==== -- feature: single cache items can be wiped using --delcache - or --delrate options. use --dumpcache to identify -- feature: sasl_username is logged if available - (thanks to Bernhard Schmidt) -- code: rate limit action is executed, if the first request exceeds the limit -- code: exceeded ratecounters will not be kept permanently anymore. this - allows further requests to pass, if they are below the limit -- code: rate limits are evaluated at ruleset stage now, which leads to - much more comprehensible behaviour. due to this change the request - cache is now disabled, if rate limits are used. use the - --fast_limit_evaluation option to revert to the former mode. - -1.30 -==== -- feature: new parser enhancement allows to omit the trailing "\" for multi-line rules, - if the following lines are prefixed by whitespace characters: - -------------------------------------- - id=RCPTCOUNT - protocol_state == END-OF-MESSAGE - client_address != 10.1.1.0/24 - recipient_count >= 100 - action=REJECT too many recipients - -------------------------------------- -- feature: new plugin interface (BETA) -- feature: Time::HiRes is used if available -- feature: new $$ratecount variable for rate() actions -- feature: ported --dumpstats and --dumpcache option from postfwd2 -- bugfix: fixed program usage statistics (--summary) -- docs: documentation updates - -1.22 -===== -- feature: new option --keep_rates -- feature: queueid is logged when available -- bugfix: rate limits using the same item and the same limits - did not work correctly (thanks to Yves Blusseau): - id=INT01; INT_DOMAIN==1; \ - action=rate(sender/100/60/450 4.7.1 too much for internal domains) - id=EXT01; EXT_DOMAIN==1; \ - action=rate(sender/100/60/450 4.7.1 too much for external domains) -- bugfix: small fix for cleanup of old rate limits -- docs: documentation updates and fixes (thanks to Vincent Lefevre) - -1.21 -===== -- feature: postfwd supports multiple rate limits to the same items now. - this means that the following will now work as expected: - id=R001; recipient_count>=100; action=rate(sender/3/3600/WARN state RED) - id=R002; recipient_count>=100; action=rate(sender/2/3600/WARN state YELLOW) - id=R003; recipient_count>=100; action=rate(sender/1/3600/WARN state GREEN) -- code: ported command-line option --facility from postfwd2 -- docs: documentation updates and fixes (thanks to Vincent Lefevre) - -1.20 -===== -- code: changed the default umask for the server socket to 0111 - to support out-of-the-box postfix setup. Use the - --umask setting to change this -- bugfix: rbl check could fail on multiple dnsbl answers -- bugfix: rbl checks disabled for ipv6 addresses, cidr compare - will switch to default (regex/string) - -1.19 -===== -- code: Rate limit code rewritten -- code: new --umask setting allows to set filepermissions for pidfiles - and unix domain sockets. Default is 0117 (owner and group rw). - -1.18 -===== -- bugfix: Fixed bug when comparing sender and recipient addresses, like - "sender=$$recipient". This affects only postfwd version 1.17. - -1.17 -===== -- bugfix: Invalid characters in variable substitutions were not correctly catched when - the '=' operator was used, like "client_name=$$helo_name". If you can not - upgrade for some reason change your rule to "client_name=~$$helo_name" -- code: Net::DNS errors will now be handled gracefully -- code: default for options --dns_max_ns_a_lookups and --dns_max_mx_a_lookups of 100 - 1.16 ===== - bugfix: this is a bugfix release for 1.15. anyone affected is encouraged to upgrade. @@ -175,6 +22,7 @@ large files or loops. use --config_timeout to override - bugfix: documentation fixed (missing "action=" in ask() examples) + 1.14 ===== - feature: new compare operators * diff --git a/doc/arch.html b/doc/arch.html deleted file mode 100644 index 279c19c..0000000 --- a/doc/arch.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -postfwd - basic architecture - - - - - - - - -

postfwd workflow


- -

-

-

- -
http://www.postfwd.org/ - 2007 - 2009 by Jan Peter Kessler - info (AT) postfwd (DOT) org -
-
-

- - - diff --git a/doc/hapolicy.html b/doc/hapolicy.html deleted file mode 100644 index 2cc13fa..0000000 --- a/doc/hapolicy.html +++ /dev/null @@ -1,151 +0,0 @@ - - - -hapolicy - policy delegation high availability script - - - - - -

- - - - - -
-

-

-

NAME

-

hapolicy - policy delegation high availability script

-

-

-
-

SYNOPSIS

-

hapolicy [OPTIONS] --service=SERVICE1 [--service=SERVICE2 ...]

-
-        Services:
-        -s, --service <name>=<address>:<port>[:<prio>:<weight>:<timeout>]
-
-        Options:
-        -d, --default <action>  returns <action> if no service was available (default: 'dunno')
-        -l, --logging           log requests
-        -v, --verbose           increase logging verbosity
-        -L, --stdout            log to stdout, for debugging, do NOT use with postfix
-

-

-
-

DESCRIPTION

-

-

-

INTRODUCTION

-

hapolicy enables high availability, weighted loadbalancing and a fallback action for postfix policy delegation services. Invoked via postfix spawn it acts as a wrapper that queries -other policy servers via tcp connection. The order of the service queries can be influenced by assigning a specific priority and weight to each service. A service is considered 'failing', -if the connection is refused or the specified service timeout is reached. If all of the configured policy services were failing, hapolicy returns a default action (e.g. dunno) to postfix.

-

With version 1.00 hapolicy has less than 200 lines of perl code using only standard perl modules. It does not require any disk access nor configuration files and runs under an unpriviledged -user account. This should allow fast and reliable operation.

-

-

-

CONFIGURATION

-

A service has the following attributes

-
-    "servicename"           => {
-               ip              => '127.0.0.1',         # ip address
-               port            => '10040',             # tcp port
-               prio            => '10',                # optional, lower wins
-               weight          => '1',                 # optional, for items with same prio (weighted round-robin), higher is better
-               timeout         => '30',                # optional, query timeout in seconds
-    },
-

You may define multiple services at the command line. Which means that

-
-        hapolicy -s "grey1=10.0.0.1:10031:10" -s "grey2=10.0.0.2:10031:20"
-

will always try first service grey1 at ip 10.0.0.1 port 10031 and if that service is not available or -does not answer within the default of 30 seconds the next service grey2 at ip 10.0.0.2 port 10031 will -be queried.

-

If you want to load balance connections you may define

-
-        hapolicy -s "polw1=10.0.0.1:12525:10:2" -s "polw2=10.0.0.2:12525:10:1"
-

which queries service polw1 at ip 10.0.0.1 twice as much as service polw2 at ip 10.0.0.2. Note that this -setup also ensures high availability for both services. If polw1 is not available or does not answer -within the default of 30 seconds polw2 will be queried and vice versa. There is no reason to define a service twice.

-

-

-

INTEGRATION

-

Enter the following at the bottom of your postfix master.cf (usually located at /etc/postfix):

-
-        # service description, note the leading blanks at the second line
-        127.0.0.1:10060 inet    n       n       n       -       0       spawn
-          user=nobody argv=/usr/local/bin/hapolicy -l -s GREY1=10.0.0.1:10031:10 -s GREY2=10.0.0.2:10031:10
-

save the file and open postfix main.cf. Modify it as follows:

-
-        127.0.0.1:10060_time_limit   = 3600
-
-        smtpd_recipient_restrictions =
-            permit_mynetworks,
-            ... other authed permits ...
-            reject_unauth_destination,
-            ... other restrictions ...
-            check_policy_service inet:127.0.0.1:10060   # <- hapolicy query
-

Now issue 'postfix reload' at the command line. Of course you can have more enhanced setups -using postfix restriction classes. Please see LINKS for further options.

-

-

-
-

LINKS

-

[1] Postfix SMTP Access Policy Delegation -http://www.postfix.org/SMTPD_POLICY_README.html

-

[2] Postfix Per-Client/User/etc. Access Control -http://www.postfix.org/RESTRICTION_CLASS_README.html

-

-

-
-

LICENSE

-

hapolicy is free software and released under BSD license, which basically means -that you can do what you want as long as you keep the copyright notice:

-

Copyright (c) 2008, Jan Peter Kessler -All rights reserved.

-

Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met:

-
- * Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in
-   the documentation and/or other materials provided with the
-   distribution.
- * Neither the name of the authors nor the names of his contributors
-   may be used to endorse or promote products derived from this
-   software without specific prior written permission.
-

THIS SOFTWARE IS PROVIDED BY ME ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, -INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, -INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, -WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE.

-

-

-
-

AUTHOR

-

Jan Peter Kessler <info (AT) postfwd (DOT) org>. Let me know, if you have any suggestions.

- - - - diff --git a/doc/hapolicy.txt b/doc/hapolicy.txt deleted file mode 100644 index 335d19a..0000000 --- a/doc/hapolicy.txt +++ /dev/null @@ -1,127 +0,0 @@ -NAME - hapolicy - policy delegation high availability script - -SYNOPSIS - hapolicy [OPTIONS] --service=SERVICE1 [--service=SERVICE2 ...] - - Services: - -s, --service =
:[:::] - - Options: - -d, --default returns if no service was available (default: 'dunno') - -l, --logging log requests - -v, --verbose increase logging verbosity - -L, --stdout log to stdout, for debugging, do NOT use with postfix - -DESCRIPTION - INTRODUCTION - hapolicy enables high availability, weighted loadbalancing and a - fallback action for postfix policy delegation services. Invoked via - postfix spawn it acts as a wrapper that queries other policy servers via - tcp connection. The order of the service queries can be influenced by - assigning a specific priority and weight to each service. A service is - considered 'failing', if the connection is refused or the specified - service timeout is reached. If all of the configured policy services - were failing, hapolicy returns a default action (e.g. dunno) to postfix. - - With version 1.00 hapolicy has less than 200 lines of perl code using - only standard perl modules. It does not require any disk access nor - configuration files and runs under an unpriviledged user account. This - should allow fast and reliable operation. - - CONFIGURATION - A service has the following attributes - - "servicename" => { - ip => '127.0.0.1', # ip address - port => '10040', # tcp port - prio => '10', # optional, lower wins - weight => '1', # optional, for items with same prio (weighted round-robin), higher is better - timeout => '30', # optional, query timeout in seconds - }, - - You may define multiple services at the command line. Which means that - - hapolicy -s "grey1=10.0.0.1:10031:10" -s "grey2=10.0.0.2:10031:20" - - will always try first service *grey1* at ip 10.0.0.1 port 10031 and if - that service is not available or does not answer within the default of - 30 seconds the next service *grey2* at ip 10.0.0.2 port 10031 will be - queried. - - If you want to load balance connections you may define - - hapolicy -s "polw1=10.0.0.1:12525:10:2" -s "polw2=10.0.0.2:12525:10:1" - - which queries service *polw1* at ip 10.0.0.1 twice as much as service - *polw2* at ip 10.0.0.2. Note that this setup also ensures high - availability for both services. If *polw1* is not available or does not - answer within the default of 30 seconds *polw2* will be queried and vice - versa. There is no reason to define a service twice. - - INTEGRATION - Enter the following at the bottom of your postfix master.cf (usually - located at /etc/postfix): - - # service description, note the leading blanks at the second line - 127.0.0.1:10060 inet n n n - 0 spawn - user=nobody argv=/usr/local/bin/hapolicy -l -s GREY1=10.0.0.1:10031:10 -s GREY2=10.0.0.2:10031:10 - - save the file and open postfix main.cf. Modify it as follows: - - 127.0.0.1:10060_time_limit = 3600 - - smtpd_recipient_restrictions = - permit_mynetworks, - ... other authed permits ... - reject_unauth_destination, - ... other restrictions ... - check_policy_service inet:127.0.0.1:10060 # <- hapolicy query - - Now issue 'postfix reload' at the command line. Of course you can have - more enhanced setups using postfix restriction classes. Please see - "LINKS" for further options. - -LINKS - [1] Postfix SMTP Access Policy Delegation - - - [2] Postfix Per-Client/User/etc. Access Control - - -LICENSE - hapolicy is free software and released under BSD license, which - basically means that you can do what you want as long as you keep the - copyright notice: - - Copyright (c) 2008, Jan Peter Kessler All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are - met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of the authors nor the names of his contributors - may be used to endorse or promote products derived from this - software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY ME ``AS IS'' AND ANY EXPRESS OR IMPLIED - WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN - NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, - PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR - PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF - LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -AUTHOR - Jan Peter Kessler . Let me know, if you - have any suggestions. - diff --git a/doc/postfwd-ARCH.png b/doc/postfwd-ARCH.png deleted file mode 100644 index ecba4ba..0000000 Binary files a/doc/postfwd-ARCH.png and /dev/null differ diff --git a/doc/postfwd.html b/doc/postfwd.html index 7f7233a..6674868 100644 --- a/doc/postfwd.html +++ b/doc/postfwd.html @@ -1,18 +1,14 @@ - postfwd - postfix firewall daemon - - - -

+ - -
-
+

NAME

@@ -57,71 +51,53 @@

postfwd [OPTIONS] [SOURCE1, SOURCE2, ...]

         Ruleset: (at least one, multiple use is allowed):
-        -f, --file <file>            reads rules from <file>
-        -r, --rule <rule>            adds <rule> to config
+ -f, --file <file> reads rules from <file> + -r, --rule <rule> adds <rule> to config 
         Scoring:
-        -s, --scores <v>=<r>         returns <r> when score exceeds <v>
-
-        Control:
-        -d, --daemon                 run postfwd as daemon
-        -k, --kill                   stops daemon
-            --reload                 reloads configuration
-            --dumpstats              displays usage statistics
-            --dumpcache              displays cache contents
-            --delcache <item>        removes an item from the request cache
-            --delrate <item>         removes an item from the rate cache
+ -s, --scores <v>=<r> returns <r> when score exceeds <v> 
         Networking:
-        -i, --interface <dev>        listen on interface <dev>
-        -p, --port <port>            listen on port <port>
-            --proto <proto>          socket type (tcp or unix)
-        -u, --user <name>            set uid to user <name>
-        -g, --group <name>           set gid to group <name>
-            --umask <mask>           set umask for file permissions
-        -R, --chroot <path>          chroot the daemon to <path>
-            --pidfile <path>         create pidfile under <path>
-            --facility <f>           syslog facility
-            --socktype <s>           syslog socktype
-        -l, --logname <label>        label for syslog messages
-            --loglen <int>           truncates syslogs after <int> chars
+ -d, --daemon run postfwd as daemon + -i, --interface <dev> listen on interface <dev> + -p, --port <port> listen on port <port> + --proto <proto> socket type (tcp or unix) + -u, --user <name> set uid to user <name> + -g, --group <name> set gid to group <name> + -R, --chroot <path> chroot the daemon to <path> + --pidfile <path> create pidfile under <path> + -l, --logname <label> label for syslog messages + --loglen <int> truncates syslogs after <int> chars 
         Caching:
-        -c, --cache <int>            sets the request-cache timeout to <int> seconds
-            --cache-no-size          ignores size attribute for caching
-            --cache-no-sender        ignores sender address in cache
-            --cache-rdomain-only     ignores localpart of recipient address in cache
-            --cache-rbl-timeout      default rbl timeout, if not specified in ruleset
-            --cache-rbl-default      default rbl response pattern to match (regexp)
-            --cacheid <item>, ..     list of attributes for request cache identifier
-            --cleanup-requests       cleanup interval in seconds for request cache
-            --cleanup-rbls           cleanup interval in seconds for rbl cache
-            --cleanup-rates          cleanup interval in seconds for rate cache
+ -c, --cache <int> sets the request-cache timeout to <int> seconds + --cache-no-size ignores size attribute for caching + --cache-no-sender ignores sender address in cache + --cache-rdomain-only ignores localpart of recipient address in cache + --cache-rbl-timeout default rbl timeout, if not specified in ruleset + --cache-rbl-default default rbl response pattern to match (regexp) + --cacheid <item>, .. list of attributes for request cache identifier + --cleanup-requests cleanup interval in seconds for request cache + --cleanup-rbls cleanup interval in seconds for rbl cache + --cleanup-rates cleanup interval in seconds for rate cache 
         Optional:
-        -t, --test                   testing, always returns "dunno"
-        -v, --verbose                verbose logging, use twice (-vv) to increase level
-        -S, --summary <int>          show some usage statistics every <int> seconds
-            --norulelog              disbles rule logging
-            --norulestats            disables per rule statistics
-            --noidlestats            disables statistics when idle
-        -n, --nodns                  disable dns
-            --nodnslog               disable dns logging
-            --dns_async_txt          perform dnsbl A and TXT lookups simultaneously
-            --dns_timeout            timeout in seconds for asynchonous dns queries
-            --dns_timeout_max        maximum of dns timeouts until a dnsbl will be deactivated
-            --dns_timeout_interval   interval in seconds for dns timeout maximum counter
-            --dns_max_ns_lookups     max names to look up with sender_ns_addrs
-            --dns_max_mx_lookups     max names to look up with sender_mx_addrs
-        -I, --instantcfg             re-reads rulefiles for every new request
-            --config_timeout <i>     parser timeout in seconds
-            --keep_rates             do not clear rate limit counters on reload
-            --save_rates <file>      save and load rate limits on disk
-            --fast_limit_evaluation  evaluate rate limits before ruleset is parsed
-                                     (please note the limitations)
-
-        Plugins:
-            --plugins <file>        loads postfwd plugins from file
+ -t, --test testing, always returns "dunno" + -v, --verbose verbose logging, use twice (-vv) to increase level + -S, --summary <int> show some usage statistics every <int> seconds + --norulelog disbles rule logging + --norulestats disables per rule statistics + --noidlestats disables statistics when idle + -n, --nodns disable dns + --nodnslog disable dns logging + --dns_async_txt perform dnsbl A and TXT lookups simultaneously + --dns_timeout timeout in seconds for asynchonous dns queries + --dns_timeout_max maximum of dns timeouts until a dnsbl will be deactivated + --dns_timeout_interval interval in seconds for dns timeout maximum counter + --dns_max_ns_lookups max names to look up with sender_ns_addrs + --dns_max_mx_lookups max names to look up with sender_mx_addrs + -I, --instantcfg re-reads rulefiles for every new request + --config_timeout <i> parser timeout in seconds 
         Informational (use only at command-line!):
         -C, --showconfig            shows ruleset summary, -v for verbose
@@ -130,6 +106,9 @@
         -V, --version               shows program version
         -h, --help                  shows usage
         -m, --manual                shows program manual
+
+        Plugins:
+            --plugins <file>        loads plugins from <file>

@@ -158,7 +137,7 @@ which should allow straightforward and easy-to-read configurations.

A configuration line consists of optional item=value pairs, separated by semicolons (`;`) and the appropriate desired action:

-        [ <item1>=<value>; <item2>=<value>; ... ] action=<result>
+ [ <item1>[=><~]=<value>; <item2>[=><~]=<value>; ... ] action=<result>

Example:

         client_address=192.168.1.1 ; sender==no@bad.local ; action=REJECT
@@ -172,8 +151,6 @@ is not important. So the following would lead to the same result as the previous ITEM == VALUE true if ITEM equals VALUE ITEM => VALUE true if ITEM >= VALUE ITEM =< VALUE true if ITEM <= VALUE - ITEM > VALUE true if ITEM > VALUE - ITEM < VALUE true if ITEM < VALUE ITEM =~ VALUE true if ITEM ~= /^VALUE$/i ITEM != VALUE false if ITEM equals VALUE ITEM !> VALUE false if ITEM >= VALUE @@ -189,19 +166,10 @@ or trailing whitespace characters will be ignored. Use '#' to comment your confi appreciate.

A ruleset consists of one or multiple rules, which can be loaded from files or passed as command line arguments. Please see the COMMAND LINE section below for more information on this topic.

-

Since postfwd version 1.30 rules spanning span multiple lines can be defined by prefixing the following -lines with one or multiple whitespace characters (or '}' for macros):

+

Rules can span multiple lines by adding a trailing backslash ``\'' character:

-        id=RULE001
-                client_address=192.168.1.0/24
-                sender==no@bad.local
-                action=REJECT no access
-

postfwd versions prior to 1.30 require trailing ';' and '\'-characters:

-
-        id=RULE001; \
-                client_address=192.168.1.0/24; \
-                sender==no@bad.local; \
-                action=REJECT no access
+ id=R_001 ; client_address=192.168.1.0/24; sender==no@bad.local; \ + action=REJECT please use your relay from there

ITEMS

@@ -267,14 +235,8 @@ lines with one or multiple whitespace characters (or '}' for macros):

this enables version based checks in your rulesets (e.g. for migration). works with old versions too, because a non-existing item always returns false: - # version >= 1.10 - id=R01; version~=1\.[1-9][0-9]; sender_domain==some.org \ + id=R01; version~=1.10; sender_domain==some.org \ ; action=REJECT sorry no access -
-        ratecount               - only available for rate(), size() and rcpt() actions.
-                                  contains the actual limit counter:
-                                        id=R01; action=rate(sender/200/600/REJECT limit of 200 exceeded [$$ratecount hits])
-                                        id=R02; action=rate(sender/100/600/WARN limit of 100 exceeded [$$ratecount hits])

Besides these you can specify any attribute of the postfix policy delegation protocol. Feel free to combine them the way you need it (have a look at the EXAMPLES section below).

Most values can be specified as regular expressions (PCRE). Please see the table below @@ -324,33 +286,34 @@ for details:

encryption_keysize=256 mask = numeric, will match if keysize >= 256 ...

the current list can be found at http://www.postfix.org/SMTPD_POLICY_README.html. Please read carefully about which -attribute can be used at which level of the smtp transaction (e.g. size will only work reliably at END-OF-MESSAGE level). +attribute can be used at which level of the smtp transaction (e.g. size will only work reliably at END_OF_DATA level). Pattern matching is performed case insensitive.

Multiple use of the same item is allowed and will compared as logical OR, which means that this will work as expected:

-        id=TRUST001; action=OK; encryption_keysize=64
-                ccert_fingerprint=11:22:33:44:55:66:77:88:99
-                ccert_fingerprint=22:33:44:55:66:77:88:99:00
-                ccert_fingerprint=33:44:55:66:77:88:99:00:11
+        id=TRUST001; action=OK; encryption_keysize=64;          \
+                ccert_fingerprint=11:22:33:44:55:66:77:88:99;   \
+                ccert_fingerprint=22:33:44:55:66:77:88:99:00;   \
+                ccert_fingerprint=33:44:55:66:77:88:99:00:11;   \
                 sender=@domain\.local$

client_address, rbl and rhsbl items may also be specified as whitespace-or-comma-separated values:

-        id=SKIP01; action=dunno
+        id=SKIP01; action=dunno; \
                 client_address=192.168.1.0/24, 172.16.254.23
-        id=SKIP02; action=dunno
-                client_address=10.10.3.32 10.216.222.0/27
+ id=SKIP02; action=dunno; \ + client_address= 10.10.3.32 \ + 10.216.222.0/27

The following items currently have to be unique:

         id, minimum and maximum values, rblcount and rhsblcount

Any item can be negated by preceeding '!!' to it, e.g.:

-        id=HOST001 ;  hostname == !!secure.trust.local ;  action=REJECT only secure.trust.local please
+ id=TLS001 ; hostname=!!^secure\.trust\.local$ ; action=REJECT only secure.trust.local please

or using the right compare operator:

-        id=HOST001 ;  hostname != secure.trust.local ;  action=REJECT only secure.trust.local please
+ id=USER01 ; sasl_username !~ /^(bob|alice)$/ ; action=REJECT who is that?

To avoid confusion with regexps or simply for better visibility you can use '!!(...)':

-        id=USER01 ;  sasl_username = !!( (bob|alice) )  ;  action=REJECT who is that?
+ id=USER01 ; sasl_username=!!( (bob|alice) ) ; action=REJECT who is that?

Request attributes can be compared by preceeding '$$' characters, e.g.:

         id=R-003 ;  client_name = !! $$helo_name      ;  action=WARN helo does not match DNS
@@ -358,29 +321,6 @@ Pattern matching is performed case insensitive.

         id=R-003 ;  client_name = !!($$(helo_name))   ;  action=WARN helo does not match DNS

This is only valid for PCRE values (see list above). The comparison will be performed as case insensitive exact match. Use the '-vv' option to debug.

-

These special items will be reset for any new rule:

-
-        rblcount        - contains the number of RBL answers
-        rhsblcount      - contains the number of RHSBL answers
-        matches         - contains the number of matched items
-        dnsbltext       - contains the dns TXT part of all RBL and RHSBL replies in the form
-                          rbltype:rblname:<txt>; rbltype:rblname:<txt>; ...
-

These special items will be changed for any matching rule:

-
-        request_hits    - contains ids of all matching rules
-

This means that it might be necessary to save them, if you plan to use these values in later rules:

-
-        # set vals
-        id=RBL01 ; rhsblcount=all; rblcount=all
-                action=set(HIT_rhls=$$rhsblcount,HIT_rbls=$$rblcount,HIT_txt=$$dnsbltext)
-                rbl=list.dsbl.org, bl.spamcop.net, dnsbl.sorbs.net, zen.spamhaus.org
-                rhsbl_client=rddn.dnsbl.net.au, rhsbl.ahbl.org, rhsbl.sorbs.net
-                rhsbl_sender=rddn.dnsbl.net.au, rhsbl.ahbl.org, rhsbl.sorbs.net
-
-        # compare
-        id=RBL02 ; HIT_rhls>=1 ; HIT_rbls>=1 ; action=554 5.7.1 blocked using $$HIT_rhls RHSBLs and $$HIT_rbls RBLs [INFO: $$HIT_txt]
-        id=RBL03 ; HIT_rhls>=2               ; action=554 5.7.1 blocked using $$HIT_rhls RHSBLs [INFO: $$HIT_txt]
-        id=RBL04 ; HIT_rbls>=2               ; action=554 5.7.1 blocked using $$HIT_rbls RBLs [INFO: $$HIT_txt]

FILES

@@ -400,15 +340,15 @@ Use the '-vv' option to debug.

id=R001 ; ccert_fingerprint==table:/etc/postfwd/wl_ccerts ; action=DUNNO

This will ignore the right-hand value. Items can be mixed:

-        id=R002 ;  action=REJECT
-                client_name==unknown
+        id=R002 ;  action=REJECT \
+                client_name==unknown; \
                 client_name==file:/etc/postfwd/blacklisted

and for non pcre (comma separated) items:

-        id=R003 ;  action=REJECT
+        id=R003 ;  action=REJECT \
                 client_address==10.1.1.1, file:/etc/postfwd/blacklisted
-        id=R004 ;  action=REJECT
+        id=R004 ;  action=REJECT \
                 rbl=myrbl.home.local, zen.spamhaus.org, file:/etc/postfwd/rbls_changing

You can check your configuration with the --show_config option at the command line:

@@ -451,7 +391,7 @@ necessary. Of course this might increase the system load, so please use it with
 
         -- FILE /etc/postfwd/clients_west.cf --
         192.168.3.0/24

-
Note that there is currently no loop detection (/a/file calls /a/file) and that this feature is only available
+
Remind that there is currently no loop detection (/a/file calls /a/file) and that this feature is only available
 with postfwd1 v1.15 and postfwd2 v0.18 and higher.

 

 

@@ -465,7 +405,7 @@ request attributes by preceeding $$ characters, like:

         id=R-003; client_name = !!$$helo_name; action=WARN helo '$$(helo_name)' does not match DNS '$$(client_name)'

postfix actions

Actions will be replied to postfix as result to policy delegation requests. Any action that postfix understands is allowed - see -"man 5 access" or http://www.postfix.org/access.5.html for a description. If no action is specified, the postfix WARN action +``man 5 access'' or http://www.postfix.org/access.5.html for a description. If no action is specified, the postfix WARN action which simply logs the event will be used for the corresponding rule.

postfwd will return dunno if it has reached the end of the ruleset and no rule has matched. This can be changed by placing a last rule containing only an action statement:

@@ -503,28 +443,18 @@ rule containing only an action statement:

this command creates a counter for the given <item>, which will be increased any time a request containing it arrives. if it exceeds <max> within <time> seconds it will return <action> to postfix. rate counters are very fast as they are executed before the ruleset is parsed. - please note that <action> was limited to postfix actions (no postfwd actions) for postfwd versions <1.33! # no more than 3 requests per 5 minutes # from the same "unknown" client - id=RATE01 ; client_name==unknown - action=rate(client_address/3/300/450 4.7.1 sorry, max 3 requests per 5 minutes) - Please note also that the order of rate limits in your ruleset is important, which means - that this: - # works as expected - id=R001; action=rcpt(sender/500/3600/REJECT limit of 500 recipients per hour for sender $$sender exceeded) - id=R002; action=rcpt(sender/200/3600/WARN state YELLOW for sender $$sender) - leads to different results than this: - # rule R002 never gets executed - id=R001; action=rcpt(sender/200/3600/WARN state YELLOW for sender $$sender) - id=R002; action=rcpt(sender/500/3600/REJECT limit of 500 recipients per hour for sender $$sender exceeded) + id=RATE01 ; client_name==unknown ; \ + action==rate($$client_address/3/300/450 4.7.1 sorry, max 3 requests per 5 minutes) 
         size (<item>/<max>/<time>/<action>)
         this command works similar to the rate() command with the difference, that the rate counter is
         increased by the request's size attribute. to do this reliably you should call postfwd from
         smtpd_end_of_data_restrictions. if you want to be sure, you could check it within the ruleset:
            # size limit 1.5mb per hour per client
-           id=SIZE01 ;  protocol_state==END-OF-MESSAGE ;  client_address!=10.1.1.1
-              action=size(client_address/1572864/3600/450 4.7.1 sorry, max 1.5mb per hour)
+ id=SIZE01 ; state==END_OF_DATA ; client_address==!!(10.1.1.1); \ + action==size($$client_address/1572864/3600/450 4.7.1 sorry, max 1.5mb per hour) 
         rcpt (<item>/<max>/<time>/<action>)
         this command works similar to the rate() command with the difference, that the rate counter is
@@ -532,13 +462,8 @@ rule containing only an action statement:

         from smtpd_data_restrictions or smtpd_end_of_data_restrictions. if you want to be sure, you could
         check it within the ruleset:
            # recipient count limit 3 per hour per client
-           id=RCPT01 ;  protocol_state==END-OF-MESSAGE ;  client_address!=10.1.1.1
-              action=rcpt(client_address/3/3600/450 4.7.1 sorry, max 3 recipients per hour)
-
-        rate5321,size5321,rcpt5321 (<item>/<max>/<time>/<action>)
-        same as the corresponding non-5321 functions, with the difference that the localpart of
-        sender oder recipient addresses are evaluated case-sensitive according to rfc5321. That
-        means that requests from bob@example.local and BoB@example.local will be treated differently
+ id=RCPT01 ; state==END_OF_DATA ; client_address==!!(10.1.1.1); \ + action==rcpt($$client_address/3/3600/450 4.7.1 sorry, max 3 recipients per hour) 
         ask (<addr>:<port>[:<ignore>])
         allows to delegate the policy decision to another policy service (e.g. postgrey). the first
@@ -546,20 +471,9 @@ rule containing only an action statement:

         specified to tell postfwd to ignore certain answers and go on parsing the ruleset:
            # example1: query postgrey and return it's answer to postfix
            id=GREY; client_address==10.1.1.1; action=ask(127.0.0.1:10031)
-           # example2: query postgrey but ignore the answer, if it matches 'DUNNO'
+           # example2: query postgrey but ignore it's answer, if it matches 'DUNNO'
            # and continue parsing postfwd's ruleset
            id=GREY; client_address==10.1.1.1; action=ask(127.0.0.1:10031:^dunno$)
-
-        mail(server/helo/from/to/subject/body)
-        This command is deprecated. You should try to use the sendmail() action instead.
-        Very basic mail command, that sends a message with the given arguments. LIMITATIONS:
-        This basically performs a telnet. No authentication or TLS are available. Additionally it does
-        not track notification state and will notify you any time, the corresponding rule hits.
-
-        sendmail(sendmail-path::from::to::subject::body)
-        Mail command, that uses an existing sendmail binary and sends a message with the given arguments.
-        LIMITATIONS: The command does not track notification state and will notify you any time, the
-        corresponding rule hits (which could mean 100 mails for a mail with 100 recipients at RCPT stage).
         wait (<delay>)
         pauses the program execution for <delay> seconds. use this for
@@ -567,7 +481,7 @@ rule containing only an action statement:

 
         note (<string>)
         just logs the given string and continues parsing the ruleset.
-        if the string is empty, nothing will be logged (noop).

+        if the string is empty, nothing will be logged.
         quit (<code>)
         terminates the program with the given exit-code. postfix doesn`t
@@ -575,6 +489,29 @@ rule containing only an action statement:

 
You can reference to request attributes, like

 
         id=R-HELO ;  helo_name=^[^\.]+$ ;  action=REJECT invalid helo '$$helo_name'

+
These special attributes will be reset for any new rule:

+
+        rblcount        - contains the number of RBL answers
+        rhsblcount      - contains the number of RHSBL answers
+        matches         - contains the number of matched items
+        dnsbltext       - contains the dns TXT part of all RBL and RHSBL replies in the form
+                          rbltype:rblname:<txt>; rbltype:rblname:<txt>; ...

+
These special attributes will be changed for any matching rule:

+
+        request_hits    - contains ids of all matching rules

+
This means that it might be necessary to save them, if you plan to use these values in later rules:

+
+        # set vals
+        id=RBL01 ; rhsblcount=all ; rblcount=all ; \
+                rbl=list.dsbl.org, bl.spamcop.net, dnsbl.sorbs.net, zen.spamhaus.org ; \
+                rhsbl_client=rddn.dnsbl.net.au, rhsbl.ahbl.org, rhsbl.sorbs.net ; \
+                rhsbl_sender=rddn.dnsbl.net.au, rhsbl.ahbl.org, rhsbl.sorbs.net ; \
+                action=set(HIT_rhls=$$rhsblcount,HIT_rbls=$$rblcount,HIT_txt=$$dnsbltext)

+
+        # compare
+        id=RBL02 ; HIT_rhls>=1 ; HIT_rbls>=1 ; action=554 5.7.1 blocked using $$HIT_rhls RHSBLs and $$HIT_rbls RBLs [INFO: $$HIT_txt]
+        id=RBL03 ; HIT_rhls>=2               ; action=554 5.7.1 blocked using $$HIT_rhls RHSBLs [INFO: $$HIT_txt]
+        id=RBL04 ; HIT_rbls>=2               ; action=554 5.7.1 blocked using $$HIT_rbls RBLs [INFO: $$HIT_txt]

 

 

 
MACROS/ACLS

@@ -597,18 +534,18 @@ First the macros have to be defined as follows:

         &&GONOW ;  &&RBLS ;  client_name=[\.-_](adsl|dynamic|ppp|)[\.-_]

Macros can contain macros, too:

-        # definition
-        &&RBLS{
-                rbl=zen.spamhaus.org
-                rbl=list.dsbl.org
-                rbl=bl.spamcop.net
-                rbl=dnsbl.sorbs.net
-                rbl=ix.dnsbl.manitu.net
+        # definition (note the trailing "\" characters)
+        &&RBLS {                                                \
+                rbl=zen.spamhaus.org ;                          \
+                rbl=list.dsbl.org ;                             \
+                rbl=bl.spamcop.net ;                            \
+                rbl=dnsbl.sorbs.net ;                           \
+                rbl=ix.dnsbl.manitu.net ;                       \
         };
-        &&DYNAMIC{
-                client_name=^unknown$
-                client_name=(\d+[\.-_]){4}
-                client_name=[\.-_](adsl|dynamic|ppp|)[\.-_]
+        &&DYNAMIC {                                             \
+                client_name=^unknown$ ;                         \
+                client_name=(\d+[\.-_]){4} ;                    \
+                client_name=[\.-_](adsl|dynamic|ppp|)[\.-_] ;   \
         };
         &&GOAWAY { &&RBLS; &&DYNAMIC; };
         # rules
@@ -617,145 +554,7 @@ First the macros have to be defined as follows:

 

 

 
PLUGINS

-
Description

-
The plugin interface allow you to define your own checks and enhance postfwd's
-functionality. Feel free to share useful things!

-
Warning

-
Note that the plugin interface is still at devel stage. Please test your plugins
-carefully, because errors may cause postfwd to break! It is also
-allowed to override attributes or built-in functions, but be sure that you know
-what you do because some of them are used internally.

-
Please keep security in mind, when you access sensible ressources and never, ever
-run postfwd as privileged user! Also never trust your input (especially hostnames,
-and e-mail addresses).

-
ITEMS

-
Item plugins are perl subroutines which integrate additional attributes to requests
-before they are evaluated against postfwd's ruleset like any other item of the
-policy delegation protocol. This allows you to create your own checks.

-
plugin-items can not be used selective. these functions will be executed for every
-request postfwd receives, so keep performance in mind.

-
-        SYNOPSIS: %result = postfwd_items_plugin{<name>}(%request)

-
means that your subroutine, called <name>, has access to a hash called %request,
-which contains all request attributes, like $request{client_name} and must
-return a value in the following form:

-
-        save: $result{<item>} = <value>

-
this creates the new item <item> containing <value>, which will be integrated in
-the policy delegation request and therefore may be used in postfwd's ruleset.

-
-        # do NOT remove the next line
-        %postfwd_items_plugin = (

-
-                # EXAMPLES - integrated in postfwd. no need to activate them here.
-                
-                        # allows to check postfwd version in ruleset
-                        "version" => sub {
-                                my(%request) = @_;
-                                my(%result) = (
-                                        "version" => $NAME." ".$VERSION,
-                                );
-                                return %result;
-                        },
-                
-                        # sender_domain and recipient_domain
-                        "address_parts" => sub {
-                                my(%request) = @_;
-                                my(%result) = ();
-                                $request{sender} =~ /@([^@]*)$/;
-                                $result{sender_domain} = ($1 || '');
-                                $request{recipient} =~ /@([^@]*)$/;
-                                $result{recipient_domain} = ($1 || '');
-                                return %result;
-                        },

-
-        # do NOT remove the next line
-        );

-
COMPARE

-
Compare plugins allow you to define how your new items should be compared to the ruleset.
-These are optional. If you don't specify one, the default (== for exact match, =~ for PCRE, ...)
-will be used.

-
-        SYNOPSIS:  <item> => sub { return &{$postfwd_compare{<type>}}(@_); },

-
-        # do NOT remove the next line
-        %postfwd_compare_plugin = (

-
-                EXAMPLES - integrated in postfwd. no need to activate them here.
-        
-                        # Simple example
-                        # SYNOPSIS:  <result> = <item> (return &{$postfwd_compare{<type>}}(@_))
-                        "client_address"  => sub { return &{$postfwd_compare{cidr}}(@_); },
-                        "size"            => sub { return &{$postfwd_compare{numeric}}(@_); },
-                        "recipient_count" => sub { return &{$postfwd_compare{numeric}}(@_); },
-        
-                        # Complex example
-                        # SYNOPSIS:  <result> = <item>(<operator>, <ruleset value>, <request value>, <request>)
-                        "numeric" => sub {
-                                my($cmp,$val,$myitem,%request) = @_;
-                                my($myresult) = undef;  $myitem ||= "0"; $val ||= "0";
-                                if ($cmp eq '==') {
-                                        $myresult = ($myitem == $val);
-                                } elsif ($cmp eq '=<') {
-                                        $myresult = ($myitem <= $val);
-                                } elsif ($cmp eq '=>') {
-                                        $myresult = ($myitem >= $val);
-                                } elsif ($cmp eq '<') {
-                                        $myresult = ($myitem < $val);
-                                } elsif ($cmp eq '>') {
-                                        $myresult = ($myitem > $val);
-                                } elsif ($cmp eq '!=') {
-                                        $myresult = not($myitem == $val);
-                                } elsif ($cmp eq '!<') {
-                                        $myresult = not($myitem <= $val);
-                                } elsif ($cmp eq '!>') {
-                                        $myresult = not($myitem >= $val);
-                                } else {
-                                        $myresult = ($myitem >= $val);
-                                };
-                                return $myresult;
-                        },

-
-        # do NOT remove the next line
-        );

-
ACTIONS

-
Action plugins allow to define new postfwd actions. By setting the $stop-flag you can decide to
-continue or to stop parsing the ruleset.

-
-        SYNOPSIS:  (<stop rule parsing>, <next rule index>, <return action>, <logprefix>, <request>) =
-                        <action> (<current rule index>, <current time>, <command name>, <argument>, <logprefix>, <request>)

-
-        # do NOT remove the next line
-        %postfwd_actions_plugin = (

-
-                # EXAMPLES - integrated in postfwd. no need to activate them here.
-        
-                        # note(<logstring>) command
-                        "note"  => sub {
-                                my($index,$now,$mycmd,$myarg,$myline,%request) = @_;
-                                my($myaction) = 'dunno'; my($stop) = 0;
-                                log_info "[RULES] ".$myline." - note: ".$myarg if $myarg;
-                                return ($stop,$index,$myaction,$myline,%request);
-                        },
-        
-                        # skips next <myarg> rules
-                        "skip" => sub {
-                                my($index,$now,$mycmd,$myarg,$myline,%request) = @_;
-                                my($myaction) = 'dunno'; my($stop) = 0;
-                                $index += $myarg if ( $myarg and not(($index + $myarg) > $#Rules) );
-                                return ($stop,$index,$myaction,$myline,%request);
-                        },
-        
-                        # dumps current request contents to syslog
-                        "dumprequest" => sub {
-                                my($index,$now,$mycmd,$myarg,$myline,%request) = @_;
-                                my($myaction) = 'dunno'; my($stop) = 0;
-                                map { log_info "[DUMP] rule=$index, Attribute: $_=$request{$_}" } (keys %request);
-                                return ($stop,$index,$myaction,$myline,%request);
-                        },

-
-        # do NOT remove the next line
-        );

+
Please visit http://www.postfwd.org/postfwd.plugins

 

 

 
COMMAND LINE

@@ -770,51 +569,29 @@ that at least one of the following is required for postfwd to work.

         -r, --rule <rule>
         Adds <rule> to ruleset. Remember that you might have to quote
         strings that contain whitespaces or shell characters.
+

Plugins

+
+        --plugins
+        A file containing plugin routines for postfwd. Please see the
+        PLUGINS section for more information.

Scoring

         -s, --scores <val>=<action>
         Returns <action> to postfix, when the request's score exceeds <val>

Multiple usage is allowed. Just chain your arguments, like:

-        postfwd -r "<item>=<value>;action=<result>" -f <file> -f <file> ...
+        postfwd -r "<item>=<value>;action=<result>" -f <file> -f <file> --plugins <file> ...
           or
         postfwd --scores 4.5="WARN high score" --scores 5.0="REJECT postfwd score too high" ...

In case of multiple scores, the highest match will count. The order of the arguments will be reflected in the postfwd ruleset.

-

Control

+

Networking

+

postfwd can be run as daemon so that it listens on the network for incoming requests. +The following arguments will control it's behaviour in this case.

         -d, --daemon
         postfwd will run as daemon and listen on the network for incoming
         queries (default 127.0.0.1:10040).
-
-        -k, --kill
-        Stops a running postfwd daemon.
-
-        --reload
-        Reloads configuration.
-
-        --dumpstats
-        Displays program usage statistics.
-
-        --dumpcache
-        Displays cache contents.
-
-        --delcache <item>
-        Removes an item from the request cache. Use --dumpcache to identify objects.
-        E.g.:
-                # postfwd --dumpcache
-                ...
-                %rate_cache -> %sender=gmato@jqvo.org -> %RATE002+2_600 -> @count    -> '1'
-                %rate_cache -> %sender=gmato@jqvo.org -> %RATE002+2_600 -> @maxcount -> '2'
-                ...
-                # postfwd --delrate="sender=gmato@jqvo.org"
-                rate cache item 'sender=gmato@jqvo.org' removed
-
-        --delrate <item>
-        Removes an item from the rate cache. Use --dumpcache to identify objects.
-

Networking

-

postfwd can be run as daemon so that it listens on the network for incoming requests. -The following arguments will control it's behaviour in this case.

         -i, --interface <dev>
         Bind postfwd to the specified interface (default 127.0.0.1).
@@ -832,11 +609,6 @@ The following arguments will control it's behaviour in this case.

         -g, --group <name>
         Changes real and effective group to <name>.
-
-        --umask <mask>
-        Changes the umask for filepermissions (unix domain sockets, pidfiles).
-        Attention: This is umask, not chmod - you have to specify the bits that
-        should NOT apply. E.g.: umask 077 equals to chmod 700.
         -R, --chroot <path>
         Chroot the process to the specified path.
@@ -844,13 +616,6 @@ The following arguments will control it's behaviour in this case.

 
         --pidfile <path>
         The process id will be saved in the specified file.

-
-        --facility <f>
-        sets the syslog facility, default is 'mail'

-
-        --socktype <s>
-        sets the Sys::Syslog socktype to 'native', 'inet' or 'unix'.
-        Default is to auto-detect this depening on module version and os.

 
         -l, --logname <label>
         Labels the syslog messages. Useful when running multiple
@@ -858,11 +623,6 @@ The following arguments will control it's behaviour in this case.

 
         --loglen <int>
         Truncates any syslog message after <int> characters.

-
Plugins

-
-        --plugins <file>
-        Loads postfwd plugins from file. Please see http://postfwd.org/postfwd.plugins
-        or the plugins.postfwd.sample that is available from the tarball for more info.

 
Optional arguments

 
These parameters influence the way postfwd is working. Any of them can be combined.

 
@@ -987,26 +747,7 @@ The following arguments will control it's behaviour in this case.

 
         --config_timeout    (default=3)
         timeout in seconds to parse a single configuration line. if exceeded, the rule will
-        be skipped. this is used to prevent problems due to large files or loops.
-        
-        --keep_rates    (default=0)
-        With this option set postfwd does not clear the rate limit counters on reload. Please
-        note that you have to restart (not reload) postfwd with this option if you change
-        any rate limit rules.

-
-        --save_rates    (default=none)
-        With this option postfwd saves existing rate limit counters to disk and reloads them
-        on program start. This allows persistent rate limits across program restarts or reboots.
-        Please note that postfwd needs read and write access to the specified file.

-
-        --fast_limit_evaluation    (default=0)
-        Once a ratelimit was set by the ruleset, future requests will be evaluated against it
-        before consulting the ruleset. This mode was the default behaviour until v1.30.
-        With this mode rate limits will be faster, but also eventually set up
-        whitelisting-rules within the ruleset might not work as expected.
-        LIMITATIONS: This option does not allow nested postfwd commands like
-                action=rate(sender/3/60/wait(3))
-        This option doe not work with the strict-rfc5321 rate() functions.

+        be skipped. this is used to prevent problems due to large files or loops.

 
Informational arguments

 
These arguments are for command line usage only. Never ever use them with postfix spawn!

 
@@ -1064,25 +805,17 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
         # 1. 30MB for systems in *.customer1.tld
         # 2. 20MB for SASL user joejob
         # 3. 10MB default
-        id=SZ001; protocol_state==END-OF-MESSAGE; action=DUNNO; size<=30000000 ; client_name=\.customer1.tld$
-        id=SZ002; protocol_state==END-OF-MESSAGE; action=DUNNO; size<=20000000 ; sasl_username==joejob
-        id=SZ002; protocol_state==END-OF-MESSAGE; action=DUNNO; size<=10000000
-        id=SZ100; protocol_state==END-OF-MESSAGE; action=REJECT message too large

+        id=SZ001; state==END-OF-MESSAGE; action=REJECT message too large; size=30000000 ; client_name=\.customer1.tld$
+        id=SZ002; state==END-OF-MESSAGE; action=REJECT message too large; size=20000000 ; sasl_username==joejob
+        id=SZ003; state==END-OF-MESSAGE; action=REJECT message too large; size=10000000

 
         ## Selective Greylisting
-        ##
-        ## Note that postfwd does not include greylisting. This setup requires a running postgrey service
-        ## at port 10031 and the following postfix restriction class in your main.cf:
-        ##
-        ##      smtpd_restriction_classes = check_postgrey, ...
-        ##      check_postgrey = check_policy_service inet:127.0.0.1:10031
-        #
         # 1. if listed on zen.spamhaus.org with results 127.0.0.10 or .11, dns cache timeout 1200s
         # 2. Client has no rDNS
         # 3. Client comes from several dialin domains
-        id=GR001; action=check_postgrey ; rbl=dul.dnsbl.sorbs.net, zen.spamhaus.org/127.0.0.1[01]/1200
-        id=GR002; action=check_postgrey ; client_name=^unknown$
-        id=GR003; action=check_postgrey ; client_name=\.(t-ipconnect|alicedsl|ish)\.de$

+        id=GR001; action=greylisting ; rbl=dul.dnsbl.sorbs.net, zen.spamhaus.org/127.0.0.1[01]/1200
+        id=GR002; action=greylisting ; client_name=^unknown$
+        id=GR003; action=greylisting ; client_name=\.(t-ipconnect|alicedsl|ish)\.de$
         ## Date Time
         date=24.12.2007-26.12.2007          ;  action=450 4.7.1 office closed during christmas
@@ -1090,7 +823,7 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
         time=-07:00:00 ;  sasl_username=jim ;  action=450 4.7.1 to early for you, jim
         time=22:00:00- ;  sasl_username=jim ;  action=450 4.7.1 to late now, jim
         months=-Apr                         ;  action=450 4.7.1 see you in may
-        days=!!Mon-Fri                      ;  action=check_postgrey
+ days=!!Mon-Fri ; action=greylist 
         ## Usage of jump
         # The following allows a message size of 30MB for different
@@ -1100,8 +833,8 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
         id=R003 ; action=jump(R100) ; ccert_fingerprint=AA:BB:CC:DD:...
         id=R004 ; action=jump(R100) ; ccert_fingerprint=AF:BE:CD:DC:...
         id=R005 ; action=jump(R100) ; ccert_fingerprint=DD:CC:BB:DD:...
-        id=R099 ; protocol_state==END-OF-MESSAGE; action=REJECT message too big (max. 10MB); size=10000000
-        id=R100 ; protocol_state==END-OF-MESSAGE; action=REJECT message too big (max. 30MB); size=30000000
+ id=R099 ; state==END-OF-MESSAGE; action=REJECT message too big (max. 10MB); size=10000000 + id=R100 ; state==END-OF-MESSAGE; action=REJECT message too big (max. 30MB); size=30000000 
         ## Usage of score
         # The following rejects a mail, if the client
@@ -1109,7 +842,7 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
         # - is listed in 1 RBL or 1 RHSBL and has no correct rDNS
         # - other clients without correct rDNS will be greylist-checked
         # - some whitelists are used to lower the score
-        id=S01 ; score=2.6              ; action=check_postgrey
+        id=S01 ; score=2.6              ; action=greylisting
         id=S02 ; score=5.0              ; action=REJECT postfwd score too high
         id=R00 ; action=score(-1.0)     ; rbl=exemptions.ahbl.org,list.dnswl.org,query.bondedsender.org,spf.trusted-forwarder.org
         id=R01 ; action=score(2.5)      ; rbl=bl.spamcop.net, list.dsbl.org, dnsbl.sorbs.net
@@ -1122,10 +855,10 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
         # The following temporary rejects requests from "unknown" clients, if they
         # 1. exceeded 30 requests per hour or
         # 2. tried to send more than 1.5mb within 10 minutes
-        id=RATE01 ;  client_name==unknown ;  protocol_state==RCPT
-                action=rate(client_address/30/3600/450 4.7.1 sorry, max 30 requests per hour)
-        id=SIZE01 ;  client_name==unknown ;  protocol_state==END-OF-MESSAGE
-                action=size(client_address/1572864/600/450 4.7.1 sorry, max 1.5mb per 10 minutes)
+ id=RATE01 ; client_name==unknown ; state==RCPT ; \ + action==rate($$client_address/30/3600/450 4.7.1 sorry, max 30 requests per hour) + id=SIZE01 ; client_name==unknown ; state==END_OF_DATA ; \ + action==size($$client_address/1572864/600/450 4.7.1 sorry, max 1.5mb per 10 minutes) 
         ## Macros
         # definition
@@ -1138,34 +871,34 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
 
         ## Groups
         # definition
-        &&RBLS{
-                rbl=zen.spamhaus.org
-                rbl=list.dsbl.org
-                rbl=bl.spamcop.net
-                rbl=dnsbl.sorbs.net
-                rbl=ix.dnsbl.manitu.net
+        &&RBLS { \
+                rbl=zen.spamhaus.org ;          \
+                rbl=list.dsbl.org ;             \
+                rbl=bl.spamcop.net ;            \
+                rbl=dnsbl.sorbs.net ;           \
+                rbl=ix.dnsbl.manitu.net ;       \
         };
-        &&RHSBLS{
+        &&RHSBLS { \
                 ...
         };
-        &&DYNAMIC{
-                client_name==unknown
-                client_name~=(\d+[\.-_]){4}
-                client_name~=[\.-_](adsl|dynamic|ppp|)[\.-_]
+        &&DYNAMIC { \
+                client_name==unknown ;                          \
+                client_name~=(\d+[\.-_]){4} ;                   \
+                client_name~=[\.-_](adsl|dynamic|ppp|)[\.-_] ;  \
                 ...
         };
-        &&BAD_HELO{
-                helo_name==my.name.tld
-                helo_name~=^([^\.]+)$
-                helo_name~=\.(local|lan)$
+        &&BAD_HELO { \
+                helo_name==my.name.tld;         \
+                helo_name~=^([^\.]+)$;          \
+                helo_name~=\.(local|lan)$;      \
                 ...
         };
-        &&MAINTENANCE{
-                date=15.01.2007
-                date=15.04.2007
-                date=15.07.2007
-                date=15.10.2007
-                time=03:00:00 - 04:00:00
+        &&MAINTENANCE { \
+                date=15.01.2007 ; \
+                date=15.04.2007 ; \
+                date=15.07.2007 ; \
+                date=15.10.2007 ; \
+                time=03:00:00 - 04:00:00 ; \
         };
         # rules
         id=COMBINED    ;  &&RBLS ;  &&DYNAMIC ;  action=REJECT dynamic client and listed on RBL
@@ -1182,7 +915,7 @@ the '-I' switch to have your configuration refreshed for every request postfwd r
 
         ## combined with enhanced rbl features
         #
-        id=RBL01 ; rhsblcount=all ; rblcount=all ; &&RBLS ; &&RHSBLS
+        id=RBL01 ; rhsblcount=all ; rblcount=all ; &&RBLS ; &&RHSBLS ; \
              action=set(HIT_dnsbls=$$rhsblcount,HIT_dnsbls+=$$rblcount,HIT_dnstxt=$$dnsbltext)
         id=RBL02 ; HIT_dnsbls>=2  ; action=554 5.7.1 blocked using $$HIT_dnsbls DNSBLs [INFO: $$HIT_dnstxt]

 

@@ -1220,7 +953,7 @@ check the parser with the -C | --showconfig switch at the command line before ap
         Rule   0: id->"RBL001"; action->"REJECT listed on spamcop and bad rdns"; rbl->"bl.spamcop.net"; client_name->"^unknown$"

 
Request processing

 
When a policy delegation request arrives it will be compared against postfwd`s ruleset. To inspect the processing in detail you should increase
-verbority using use the "-v" or "-vv" switch. "-L" redirects log messages to stdout.

+verbority using use the ``-v'' or ``-vv'' switch. ``-L'' redirects log messages to stdout.

 
Keeping the order of the ruleset in general, items will be compared in random order, which basically means that

 
         id=R001; action=dunno; client_address=192.168.1.1; sender=bob@alice.local

@@ -1259,7 +992,7 @@ to compare against the request attribute the parser will jump to the next rule i
 
If a rule matches, there are two options:

 
* Rule returns postfix action (dunno, reject, ...)
 The parser stops rule processing and returns the action to postfix. Other rules will not be evaluated.

-
* Rule returns postfwd action (jump(), note(), ...)
+
* Rule returns postfwd action (jump(), note(), ...)
 The parser evaluates the given action and continues with the next rule (except for the jump() or quit() actions - please see the ACTIONS section
 for more information). Nothing will be sent to postfix.

 
If no rule has matched and the end of the ruleset is reached postfwd will return dunno without logging anything unless in verbose mode. You may
@@ -1279,7 +1012,7 @@ it`s internal caching in that case. Start postfwd with the following parameters:
         postfwd -d -f /etc/postfwd.cf -i 127.0.0.1 -p 10040 -u nobody -g nobody -S

For efficient caching you should check if you can use the options --cache-rdomain-only, --cache-no-sender and --cache-no-size.

-

Now check your syslogs (default facility "mail") for a line like:

+

Now check your syslogs (default facility ``mail'') for a line like:

         Aug  9 23:00:24 mail postfwd[5158]: postfwd n.nn ready for input

and use `netstat -an|grep 10040` to check for something like

@@ -1334,7 +1067,7 @@ I won`t discuss that here. If you plan to do so, just add the following line to disable = no }

and restart the xinetd daemon (usually a SIGHUP should be fine). If you experience problems -you might want to check your system's log for xinetd errors like "socket already in use".

+you might want to check your system's log for xinetd errors like ``socket already in use''.

The integration with postfix is similar to the Integration via daemon mode section above. Reload postfix and watch your logs to see if everything works.

diff --git a/doc/postfwd.txt b/doc/postfwd.txt index 29b039f..ff1b49b 100644 --- a/doc/postfwd.txt +++ b/doc/postfwd.txt @@ -5,71 +5,53 @@ SYNOPSIS postfwd [OPTIONS] [SOURCE1, SOURCE2, ...] Ruleset: (at least one, multiple use is allowed): - -f, --file reads rules from - -r, --rule adds to config + -f, --file reads rules from + -r, --rule adds to config Scoring: - -s, --scores = returns when score exceeds - - Control: - -d, --daemon run postfwd as daemon - -k, --kill stops daemon - --reload reloads configuration - --dumpstats displays usage statistics - --dumpcache displays cache contents - --delcache removes an item from the request cache - --delrate removes an item from the rate cache + -s, --scores = returns when score exceeds Networking: - -i, --interface listen on interface - -p, --port listen on port - --proto socket type (tcp or unix) - -u, --user set uid to user - -g, --group set gid to group - --umask set umask for file permissions - -R, --chroot chroot the daemon to - --pidfile create pidfile under - --facility syslog facility - --socktype syslog socktype - -l, --logname

-

postfwd2 - chroot setup


-If you care about security and want to run postfwd2 within a chroot environment you have to setup it up before. This document will give you an idea about what has to be prepared. - -

-How to create a minimal chroot environment for postfwd2
-=======================================================
-
-Tested with SLES 11 x86_64, customize this to suit your specific system.
-For example, on SLES 10 x86_64, use perl version 5.8.8 instead of 5.10.0
-and glibc version 2.4 instead of 2.11.1.
-
-cd $CHROOTDIR
-for dir in tmp dev var var/tmp etc lib64 usr usr/lib usr/lib/perl5 \
-  usr/lib/perl5/site_perl \
-  usr/lib/perl5/site_perl/5.10.0 \
-  usr/lib/perl5/site_perl/5.10.0/Net \
-  usr/lib/perl5/site_perl/5.10.0/Net/Server \
-  usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto ; do
-    mkdir $dir
-    chmod --reference /$dir $dir
-    chown --reference /$dir $dir
-done
-for file in dev/null etc/protocols etc/localtime etc/resolv.conf \
-  lib64/libnss_files-2.11.1.so lib64/libnss_files.so.2 \
-  usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/TCP.pm \
-  usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/UNIX.pm ; do
-    cp -p /$file $file
-done
-grep nobody /etc/passwd > etc/passwd
-grep nobody /etc/group > etc/group
-echo -e 'passwd: files\ngroup: files\nprotocols: files' > etc/nsswitch.conf
-
-=> Configure your syslog daemon to listen to $CHROOTDIR/dev/log:
-    echo 'SYSLOGD_ADDITIONAL_SOCKET_POSTFWD="$CHROOTDIR/dev/log"' \
-      >> /etc/sysconfig/syslog
-    /etc/init.d/syslog restart
-
-=> Place your postfwd configuration in $CHROOTDIR:
-    cp $POSTFWDCONF $CHROOTDIR/etc/postfwd.conf
-
-=> Start postfwd2:
-    /usr/local/sbin/postfwd2 --file=/etc/postfwd.conf --chroot=$CHROOTDIR
-
-
-List of directories
-===================
-
-tmp
-lib64
-dev
-var
-var/tmp
-etc
-usr
-usr/lib
-usr/lib/perl5
-usr/lib/perl5/site_perl
-usr/lib/perl5/site_perl/5.10.0
-usr/lib/perl5/site_perl/5.10.0/Net
-usr/lib/perl5/site_perl/5.10.0/Net/Server
-usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto
-
-
-List of files
-=============
-
-lib64/libnss_files.so.2
-lib64/libnss_files-2.11.1.so
-dev/null
-dev/log
-etc/localtime
-etc/protocols
-etc/postfwd.conf
-etc/nsswitch.conf
-etc/passwd
-etc/resolv.conf
-etc/group
-usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/UNIX.pm
-usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/TCP.pm
-

- -Thanks to Lukas Wunner for providing this howto and the patch for postfwd2! - - - diff --git a/doc/postfwd2-chroot.txt b/doc/postfwd2-chroot.txt deleted file mode 100644 index 997e0d7..0000000 --- a/doc/postfwd2-chroot.txt +++ /dev/null @@ -1,82 +0,0 @@ -postfwd2 - chroot setup -======================= -If you care about security and want to run postfwd2 within a chroot environment you have to setup it up before. This document will give you an idea about what has to be prepared. - -How to create a minimal chroot environment for postfwd2 -======================================================= - -Tested with SLES 11 x86_64, customize this to suit your specific system. -For example, on SLES 10 x86_64, use perl version 5.8.8 instead of 5.10.0 -and glibc version 2.4 instead of 2.11.1. - -cd $CHROOTDIR -for dir in tmp dev var var/tmp etc lib64 usr usr/lib usr/lib/perl5 \ - usr/lib/perl5/site_perl \ - usr/lib/perl5/site_perl/5.10.0 \ - usr/lib/perl5/site_perl/5.10.0/Net \ - usr/lib/perl5/site_perl/5.10.0/Net/Server \ - usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto ; do - mkdir $dir - chmod --reference /$dir $dir - chown --reference /$dir $dir -done -for file in dev/null etc/protocols etc/localtime etc/resolv.conf \ - lib64/libnss_files-2.11.1.so lib64/libnss_files.so.2 \ - usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/TCP.pm \ - usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/UNIX.pm ; do - cp -p /$file $file -done -grep nobody /etc/passwd > etc/passwd -grep nobody /etc/group > etc/group -echo -e 'passwd: files\ngroup: files\nprotocols: files' > etc/nsswitch.conf - -=> Configure your syslog daemon to listen to $CHROOTDIR/dev/log: - echo 'SYSLOGD_ADDITIONAL_SOCKET_POSTFWD="$CHROOTDIR/dev/log"' \ - >> /etc/sysconfig/syslog - /etc/init.d/syslog restart - -=> Place your postfwd configuration in $CHROOTDIR: - cp $POSTFWDCONF $CHROOTDIR/etc/postfwd.conf - -=> Start postfwd2: - /usr/local/sbin/postfwd2 --file=/etc/postfwd.conf --chroot=$CHROOTDIR - - -List of directories -=================== - -tmp -lib64 -dev -var -var/tmp -etc -usr -usr/lib -usr/lib/perl5 -usr/lib/perl5/site_perl -usr/lib/perl5/site_perl/5.10.0 -usr/lib/perl5/site_perl/5.10.0/Net -usr/lib/perl5/site_perl/5.10.0/Net/Server -usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto - - -List of files -============= - -lib64/libnss_files.so.2 -lib64/libnss_files-2.11.1.so -dev/null -dev/log -etc/localtime -etc/protocols -etc/postfwd.conf -etc/nsswitch.conf -etc/passwd -etc/resolv.conf -etc/group -usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/UNIX.pm -usr/lib/perl5/site_perl/5.10.0/Net/Server/Proto/TCP.pm - -Thanks to Lukas Wunner for providing this howto and the patch for postfwd2! - diff --git a/doc/postfwd2.CHANGELOG b/doc/postfwd2.CHANGELOG deleted file mode 100644 index 4c99d51..0000000 --- a/doc/postfwd2.CHANGELOG +++ /dev/null @@ -1,286 +0,0 @@ -postfwd2 1.35 -============= -- code: rate(), size() and rcpt() function index is now case insensitive by default - (same limit counters for from@example.org and fRom@eXample.org) - if you need to treat the localpart case-sensitive according to rfc5321 - you may use rate5321(), size5321() and rcpt5321(). -- bugfix: fixed segfault when using new perl versions (prevented to work with upstart) - -postfwd2 1.34 -============= -- bugfix: fixed taint mode logging error for verbose --showconfig and --stdoutlog - options and newer perl versions. -- bugfix: check_* functions use print/getline instead of send/recv for large - --dumpcache output (thanks to Alexandre Simon) -- code: added more information when using --debug=cleanup -- docs: documentation updates -- feature: new sendmail(sendmail-path::from::to::subject::body) action. - Please take a look at the manual, especially about - it's limitations, before using it! - ------------------------------------------------------------ - # alert - action=sendmail(/usr/sbin/sendmail::from@example.org::to@example.org::Subject::Text) - ------------------------------------------------------------ - -postfwd2 1.33 -============= -- feature: new compare operators * - ==================================================================== - ITEM > VALUE true if ITEM > VALUE - ITEM < VALUE true if ITEM < VALUE - ==================================================================== -- bugfix: fixed bug when computing scores with more than 1 digit after the "." (n.nn) -- bugfix: fixed bug when computing negative values with the set action -- bugfix: ITEMS plugins returning zero values were handled incorrectly -- bugfix: max command recursion was not reset for each rule -- bugfix: fixed warning about use of (uninitialized value) when STORABLE is available - but no cache file was defined - -postfwd2 1.32 -============= -- feature: new option --save_rates= allows to load and save - rate limit counters to disk on program start and termination. - this allows rate limit persistence during restarts and reboots - (requires perl module 'Storable') -- feature: the --debugitem="sender=example\.org$" option - allows verbose logging for particular requests -- feature: the debug() action allows verbose logging for certain - rules: - ------------------------------------------------------------ - id=R01 - client_address=1.1.1.1 - action=debug(on) - id=R02 - ... - id=R42 - action=debug(off) - ------------------------------------------------------------ -- feature: nested commands are possible now, e.g.: - ------------------------------------------------------------ - # throttle - action=rate(client_address/10/60/wait(3)) - ------------------------------------------------------------ -- feature: new mail(server/helo/from/to/subject/body) action. - Please take a look at the manual, especially about - it's limitations, before using it! - ------------------------------------------------------------ - # alert - action=size(recipient_domain/100000000/86400/mail(mailhost/helo/from/to/subject/text)) - ------------------------------------------------------------ -- feature: --chroot option works now (patch by Lukas Wunner). - Look for his notes at http://postfwd.org/postfwd2-chroot.html - on how to set up the required chroot environment. - -postfwd2 1.31 -============= -- feature: single cache items can be wiped using --delcache - or --delrate options. use --dumpcache to identify -- feature: sasl_username is logged if available - (thanks to Bernhard Schmidt) -- code: rate limit action is executed, if the first request exceeds the limit -- code: exceeded ratecounters will not be kept permanently anymore. this - allows further requests to pass, if they are below the limit -- code: rate limits are evaluated at ruleset stage now, which leads to - much more comprehensible behaviour. due to this change the request - cache is now disabled, if rate limits are used. use the - --fast_limit_evaluation option to return to the former mode. - -postfwd2 1.30 -============= -- feature: new parser enhancement allows to omit the trailing "\" for multi-line rules, - if the following lines are prefixed by whitespace characters: - -------------------------------------- - id=RCPTCOUNT - protocol_state == END-OF-MESSAGE - client_address != 10.1.1.0/24 - recipient_count >= 100 - action=REJECT too many recipients - -------------------------------------- -- feature: new plugin interface (BETA) -- feature: Time::HiRes is used if available -- feature: multiple rate limits for the same items are supported now -- feature: new $$ratecount variable for rate() actions -- feature: new option --keep_rates -- code: new --debug class 'cleanup' -- docs: documentation updates - -postfwd2 1.22 -============= -- general: adapted postfwd1 versioning scheme -- feature: queueid is logged when available -- bugfix: rate limits did not work correctly (thanks to Yves Blusseau) -- docs: documentation updates and fixes (thanks to Vincent Lefevre) - -postfwd2 1.00 -============= -- code: changed the default umask for the server socket to 0111 - to support out-of-the-box postfix setup. Use the - --server_umask setting to change this -- code: --dumpcache command does not require debug mode anymore -- code: rate hits included to cache stats -- bugfix: rbl checks disabled for ipv6 addresses, cidr compare - will switch to default (regex/string) - -postfwd2 0.22 -============= -- feature: Rate limits are completely supported by postfwd2 now. - Please note that the cache daemon is required for reliable operation. -- bugfix: --syslog_facility could not be changed -- code: rate limit code rewritten -- code: new --umask, --cache_umask and --server_umask settings allow to set - filepermissions for pidfiles and unix domain sockets. New defaults are: - * master (pidfile): 0177 (owner rw) - * cache (socket): 0177 (owner rw) - * server (socket): 0117 (owner and group rw) - -postfwd2 0.21 -============= -- bugfix: Fixed bug when comparing sender and recipient addresses, like - "sender=$$recipient". This affects only postfwd2 version 0.20. - -postfwd2 0.20 -============= -- bugfix: Invalid characters in variable substitutions were not correctly catched when - the '=' operator was used, like "client_name=$$helo_name". If you can not - upgrade for some reason change your rule to "client_name=~$$helo_name" -- code: Net::DNS errors will now be handled gracefully -- code: default for options --dns_max_ns_a_lookups and --dns_max_mx_a_lookups of 100 - -postfwd2 0.19 -============= -- bugfix: this is a bugfix release for 0.18. anyone affected is encouraged to upgrade. - detail: the default behavior for the '=' operator with numeric items - (size, recipient_count, ...) changed with version 0.18 to '==' (equals to). - now these items are compared '>=' (greater than) again. - note: if you are using 0.18 and you are not able upgrade for some reason, - please change '=' to '>=' in your ruleset where you mean 'greater than'. - -postfwd2 0.18 -============= -- feature: items may now be retrieved from files using "item=file:/some/where" - more information in the postfwd manual (FILES section) -- feature: helo_address, and sender_(ns|mx)_addrs can now be csv items -- feature: new rcpt() command counts recipients for rate limits (thanks to Sahil Tandon) -- code: redirect syslog to stdout for --kill, --reload, --showconfig and --dump(cache|stats) -- code: option --reload (HUP signal) now reloads config, if the file is unchanged -- code: new --debug classes 'config' and 'request' -- code: configuration parser improvements: - * rules without defined action will be skipped at configuration stage - * undefined ACLs will now be detected and skipped at configuration stage - * parser timeout skips loading a rule after 4s, to prevent problems with - large files or loops. use --config_timeout to override -- bugfix: documentation fixed (missing "action=" in ask() examples) -- bugfix: fixed logging of an uninitialized value in cache cleanups - -postfwd2 0.17 -============= -- feature: new compare operators * - ==================================================================== - ITEM == VALUE true if ITEM equals VALUE - ITEM => VALUE true if ITEM >= VALUE - ITEM =< VALUE true if ITEM <= VALUE - ITEM =~ VALUE true if ITEM ~= /^VALUE$/i - *ITEM != VALUE false if ITEM equals VALUE - *ITEM !> VALUE false if ITEM >= VALUE - *ITEM !< VALUE false if ITEM <= VALUE - *ITEM !~ VALUE false if ITEM ~= /^VALUE$/i - ITEM = VALUE default behaviour (see ITEMS section) - ==================================================================== -- feature: added --nodaemon and --stdout options -- code: non dns items first: if a rule contains dns and non dns items, the - lookups will only be done if all non dns items matched -- bugfix: empty pcre with empty sender_(ns|mx)_names was parsed incorrectly. - this bug affects postfwd2 versions 0.15 - 0.16 -- bugfix: negated pcre items with '~=' operator were parsed incorrectly. - this bug affects postfwd2 version 0.16 - -postfwd2 0.16 -============= -- feature: enabled dns cache for sender(ns|mx) and helo address -- feature: new options --dns_max_ns_lookups and --dns_max_mx_lookups -- code: parent_dns_cache is now disabled by default. use - --parent_dns_cache if you have a slow nameserver -- bugfix: workaround: Net::Server died if a unix domain socket - filename without a dot ('.') was used (B. Frauendienst) - -postfwd2 0.15 -============= -- feature: new items sender_ns_names and sender_ns_addrs -- feature: new items sender_mx_names and sender_mx_addrs -- feature: new item helo_address, please see docs for more -- feature: new parent cache statistics. the command line option --dumpstats - uses the --daemons setting now (default: cache,server) -- feature: dnsbl txt lookups only for dnsbls with at least one a record. - use --dns_async_txt for the old behaviour (see docs for more). -- code: summary function went to postfwd::master (and will stay there ;) -- code: small performance improvement (5-10%) for pcre (~= or =~) items -- bugfix: network 0.0.0.0/0 did not work as expected on all platforms - - -postfwd2 0.14 -============= -- code: summary function was moved from postfwd::cache to postfwd::policy. - the reduced policy <-> cache communication increases throughput - considerably and improves cpu balancing on multiprocessor systems -- bugfix: fixed potential division by zero in summary function - - -postfwd2 0.13 -============= -- feature: new options --noidlestats and --norulestats -- feature: more informative --version -- feature: documentation updates -- bugfix: disabled parent_cache counters when --summary=0 - - -postfwd2 0.12 -============= -- feature: the ask() action allows to delegate the policy decision to another - policy service (like postgrey). a new parameter allows to specify - answer patterns which should be ignored by postfwd. please look - at the 'ACTIONS' section in the manual (postfwd2 -m) for details. -- feature: parent-request cache will now only be updated, if a rule matches. - if postfwd should cache all requests, you must place a last rule: - id=DEFAULT; action=dunno -- bugfix: reorganised some parent-cache loggings for -vv and *cache debug classes - - -postfwd2 0.11 -============= -- bugfix: all postfwd settings are now detainted -- bugfix: cache-update used an uninitialized value when no rule had hit - - -postfwd2 0.10 -============= -- bugfix: command line arguments --pidfile - - -postfwd2 0.09 -============= -- bugfix: command line arguments --user and --group were not correctly de-tainted - - -postfwd2 0.08 -============= -- bugfix: command line argument --pid_file was ignored -- bugfix: command line argument --manual (-m) did not work - - -postfwd2 0.07 -============= -- first semi-public release of postfwd2 -- full ruleset compatibility, no changes required when migrating from postfwd v1 -- new architecture: - - * Net::Server::PreFork - ruleset processor (server) forks new child for any request - - * Net::Server::Multiplex for parent cache - offers a shared request, dns and rate cache for postfwd2 children - - * Net::Server::Daemonize for master process - controls server and cache (watchdog function) and allows direct - access to statistics, cache-contents, ... from the command-line - -- many new commandline options (see postfwd2 -h) for more information diff --git a/doc/postfwd2.html b/doc/postfwd2.html deleted file mode 100644 index e4d1ec7..0000000 --- a/doc/postfwd2.html +++ /dev/null @@ -1,1421 +0,0 @@ - - - - -postfwd2 - postfix firewall daemon - - - - - - - - - - - -

-

-

NAME

-

postfwd2 - postfix firewall daemon

-

-

-
-

SYNOPSIS

-

postfwd2 [OPTIONS] [SOURCE1, SOURCE2, ...]

-
-        Ruleset: (at least one, multiple use is allowed):
-        -f, --file <file>               reads rules from <file>
-        -r, --rule <rule>               adds <rule> to config
-        -s, --scores <v>=<r>            returns <r> when score exceeds <v>
-
-        Server:
-        -i, --interface <dev>           listen on interface <dev>
-        -p, --port <port>               listen on port <port>
-            --proto <proto>             socket type (tcp or unix)
-            --server_socket <sock>      e.g. tcp:127.0.0.1:10045
-        -u, --user <name>               set uid to user <name>
-        -g, --group <name>              set gid to group <name>
-            --umask <mask>              umask for master filepermissions
-            --server_umask <mask>       umask for server filepermissions
-            --pidfile <path>            create pidfile under <path>
-            --min_servers <i>           spawn at least <i> children
-            --max_servers <i>           do not spawn more than <i> children
-            --min_spare_servers <i>     minimum idle children
-            --max_spare_servers <i>     maximum idle children
-
-        Cache:
-        -c, --cache <int>               sets the request-cache timeout to <int> seconds
-            --cleanup-requests <int>    cleanup interval in seconds for request cache
-            --cache_interface <dev>     listen on interface <dev>
-            --cache_port <port>         listen on port <port>
-            --cache_proto <proto>       socket type (tcp or unix)
-            --cache_socket <sock>       e.g. tcp:127.0.0.1:10043
-            --cache_umask <mask>        umask for cache filepermissions
-            --cacheid <list>            list of request items for cache-id
-            --cache-rdomain-only        skip recipient localpart for cache-id
-            --cache-no-sender           skip sender address for cache-id
-            --cache-no-size             skip size for cache-id
-            --no_parent_request_cache   disable parent request cache
-            --no_parent_rate_cache      disable parent rate cache
-            --no_parent_dns_cache       disable parent dns cache (default)
-            --no_parent_cache           disable all parent caches
-
-        Rates:
-            --cleanup-rates <int>       cleanup interval in seconds for rate cache
-
-        Control:
-        -k, --kill, --stop              terminate postfwd2
-            --reload, --hup             reload postfwd2
-            --watchdog <w>              watchdog timer in seconds
-            --respawn <r>               respawn delay in seconds
-            --failures <f>              max respawn failure counter
-            --daemons <list>            list of daemons to start
-            --dumpcache                 show cache contents
-            --dumpstats                 show statistics
-        -R, --chroot <path>             chroot to <path> before start
-            --delcache <item>           removes an item from the request cache
-            --delrate <item>            removes an item from the rate cache
-
-        DNS:
-        -n, --nodns                     skip any dns based test
-            --dns_timeout <i>           dns query timeout in seconds
-            --dns_timeout_max <i>       disable dnsbl after <i> timeouts
-            --dns_timeout_interval <i>  reenable dnsbl after <i> seconds
-            --cache-rbl-timeout <i>     default dns ttl if not specified in ruleset
-            --cache-rbl-default <s>     default dns pattern if not specified in ruleset
-            --cleanup-rbls <i>          cleanup old dns cache items every <i> seconds
-            --dns_async_txt             perform dnsbl A and TXT lookups simultaneously
-            --dns_max_ns_lookups        max names to look up with sender_ns_addrs
-            --dns_max_mx_lookups        max names to look up with sender_mx_addrs
-
-        Optional:
-        -t, --test                      testing, always returns "dunno"
-        -S, --summary <i>               show stats every <i> seconds
-            --noidlestats               disables statistics when idle
-            --norulestats               disables per rule statistics
-        -I, --instantcfg                reloads ruleset on every new request
-            --config_timeout <i>        parser timeout in seconds
-            --keep_rates                do not clear rate limit counters on reload
-            --save_rates <file>         save and load rate limits on disk
-            --fast_limit_evaluation     evaluate rate limits before ruleset is parsed
-                                        (please note the limitations)
-
-        Plugins:
-            --plugins <file>            loads postfwd plugins from file
-
-        Logging:
-        -l, --logname <label>           label for syslog messages
-            --facility <s>              use syslog facility <s>
-            --socktype <s>              use syslog socktype <s>
-            --nodnslog                  do not log dns results
-            --anydnslog                 log any dns (even cached) results
-            --norulelog                 do not log rule actions
-            --nolog|--perfmon           no logging at all
-        -v, --verbose                   verbose logging, use twice to increase
-            --debug <s>                 list of debugging classes
-
-        Information (use only at command-line!):
-        -h, --help                      display this help and exit
-        -m, --manual                    shows program manual
-        -V, --version                   output version information and exit
-        -D, --defaults                  show postfwd2 settings and exit
-        -C, --showconfig                show postfwd2 ruleset and exit (-v allowed)
-        -L, --stdout                    redirect syslog messages to stdout
-        -q, --quiet                     no syslogging, no stdout (-P works for compatibility)
-
-        Obsolete (only for compatibility with postfwd v1):
-        -d|--daemon, --shortlog, --dns_queuesize, --dns_retries
-

-

-
-

DESCRIPTION

-

-

-

INTRODUCTION

-

postfwd2 is written to combine complex postfix restrictions in a ruleset similar to those of the most firewalls. -The program uses the postfix policy delegation protocol to control access to the mail system before a message -has been accepted (please visit http://www.postfix.org/SMTPD_POLICY_README.html for more information).

-

postfwd2 allows you to choose an action (e.g. reject, dunno) for a combination of several smtp parameters -(like sender and recipient address, size or the client's TLS fingerprint). Also it offers simple macros/acls -which should allow straightforward and easy-to-read configurations.

-

Features:

-

* Complex combinations of smtp parameters

-

* Combined RBL/RHSBL lookups with arbitrary actions depending on results

-

* Scoring system

-

* Date/time based rules

-

* Macros/ACLs, Groups, Negation

-

* Compare request attributes (e.g. client_name and helo_name)

-

* Internal caching for requests and dns lookups

-

* Built in statistics for rule efficiency analysis

-

-

-

CONFIGURATION

-

A configuration line consists of optional item=value pairs, separated by semicolons -(`;`) and the appropriate desired action:

-
-        [ <item1>=<value>; <item2>=<value>; ... ] action=<result>
-

Example:

-
-        client_address=192.168.1.1 ; sender==no@bad.local ; action=REJECT
-

This will deny all mail from 192.168.1.1 with envelope sender no@bad.local. The order of the elements -is not important. So the following would lead to the same result as the previous example:

-
-        action=REJECT ; client_address=192.168.1.1 ; sender==no@bad.local
-

The way how request items are compared to the ruleset can be influenced in the following way:

-
-        ====================================================================
-         ITEM == VALUE                true if ITEM equals VALUE
-         ITEM => VALUE                true if ITEM >= VALUE
-         ITEM =< VALUE                true if ITEM <= VALUE
-         ITEM >  VALUE                true if ITEM >  VALUE
-         ITEM <  VALUE                true if ITEM <  VALUE
-         ITEM =~ VALUE                true if ITEM ~= /^VALUE$/i
-         ITEM != VALUE                false if ITEM equals VALUE
-         ITEM !> VALUE                false if ITEM >= VALUE
-         ITEM !< VALUE                false if ITEM <= VALUE
-         ITEM !~ VALUE                false if ITEM ~= /^VALUE$/i
-         ITEM =  VALUE                default behaviour (see ITEMS section)
-        ====================================================================
-

To identify single rules in your log files, you may add an unique identifier for each of it:

-
-        id=R_001 ; action=REJECT ; client_address=192.168.1.1 ; sender==no@bad.local
-

You may use these identifiers as target for the `jump()` command (see ACTIONS section below). Leading -or trailing whitespace characters will be ignored. Use '#' to comment your configuration. Others will -appreciate.

-

A ruleset consists of one or multiple rules, which can be loaded from files or passed as command line -arguments. Please see the COMMAND LINE section below for more information on this topic.

-

Since postfwd version 1.30 rules spanning span multiple lines can be defined by prefixing the following -lines with one or multiple whitespace characters (or '}' for macros):

-
-        id=RULE001
-                client_address=192.168.1.0/24
-                sender==no@bad.local
-                action=REJECT no access
-

postfwd versions prior to 1.30 require trailing ';' and '\'-characters:

-
-        id=RULE001; \
-                client_address=192.168.1.0/24; \
-                sender==no@bad.local; \
-                action=REJECT no access
-

-

-

ITEMS

-
-        id                      - a unique rule id, which can be used for log analysis
-                                  ids also serve as targets for the "jump" command.
-
-        date, time              - a time or date range within the specified rule shall hit
-                                  # FORMAT:
-                                  # Feb, 29th
-                                  date=29.02.2008
-                                  # Dec, 24th - 26th
-                                  date=24.12.2008-26.12.2008
-                                  # from today until Nov, 23rd
-                                  date=-23.09.2008
-                                  # from April, 1st until today
-                                  date=01.04.2008-
-
-        days, months            - a range of weekdays (Sun-Sat) or months (Jan-Dec)
-                                  within the specified rule shall hit
-
-        score                   - when the specified score is hit (see ACTIONS section)
-                                  the specified action will be returned to postfix
-                                  scores are set global until redefined!
-
-        request_score           - this value allows to access a request's score. it
-                                  may be used as variable ($$request_score).
-
-        rbl, rhsbl,             - query the specified RBLs/RHSBLs, possible values are:
-        rhsbl_client,             <name>[/<reply>/<maxcache>, <name>/<reply>/<maxcache>]
-        rhsbl_sender,             (defaults: reply=^127\.0\.0\.\d+$ maxcache=3600)
-        rhsbl_reverse_client      the results of all rhsbl_* queries will be combined
-                                  in rhsbl_count (see below).
-
-        rblcount, rhsblcount    - minimum RBL/RHSBL hitcounts to match. if not specified
-                                  a single RBL/RHSBL hit will match the rbl/rhsbl items.
-                                  you may specify 'all' to evaluate all items, and use
-                                  it as variable in an action (see ACTIONS section)
-                                  (default: 1)
-
-        sender_localpart,       - the local-/domainpart of the sender address
-        sender_domain
-
-        recipient_localpart,    - the local-/domainpart of the recipient address
-        recipient_domain
-
-        helo_address            - postfwd2 tries to look up the helo_name. use
-                                  helo_address=!!(0.0.0.0/0) to check for unknown.
-                                  Please do not use this for positive access control
-                                  (whitelisting), as it might be forged.
-
-        sender_ns_names,        - postfwd2 tries to look up the names/ip addresses
-        sender_ns_addrs           of the nameservers for the sender domain part.
-                                  Please do not use this for positive access control
-                                  (whitelisting), as it might be forged.
-
-        sender_mx_names,        - postfwd2 tries to look up the names/ip addresses
-        sender_mx_addrs           of the mx records for the sender domain part.
-                                  Please do not use this for positive access control
-                                  (whitelisting), as it might be forged.
-
-        version                 - postfwd2 version, contains "postfwd2 n.nn"
-                                  this enables version based checks in your rulesets
-                                  (e.g. for migration). works with old versions too,
-                                  because a non-existing item always returns false:
-                                  # version >= 1.10
-                                  id=R01; version~=1\.[1-9][0-9]; sender_domain==some.org \
-                                        ; action=REJECT sorry no access
-
-        ratecount               - only available for rate(), size() and rcpt() actions.
-                                  contains the actual limit counter:
-                                        id=R01; action=rate(sender/200/600/REJECT limit of 200 exceeded [$$ratecount hits])
-                                        id=R02; action=rate(sender/100/600/WARN limit of 100 exceeded [$$ratecount hits])
-

Besides these you can specify any attribute of the postfix policy delegation protocol. -Feel free to combine them the way you need it (have a look at the EXAMPLES section below).

-

Most values can be specified as regular expressions (PCRE). Please see the table below -for details:

-
-        # ==========================================================
-        # ITEM=VALUE                            TYPE
-        # ==========================================================
-        id=something                            mask = string
-        date=01.04.2007-22.04.2007              mask = date (DD.MM.YYYY-DD.MM.YYYY)
-        time=08:30:00-17:00:00                  mask = time (HH:MM:SS-HH:MM:SS)
-        days=Mon-Wed                            mask = weekdays (Mon-Wed) or numeric (1-3)
-        months=Feb-Apr                          mask = months (Feb-Apr) or numeric (1-3)
-        score=5.0                               mask = maximum floating point value
-        rbl=zen.spamhaus.org                    mask = <name>/<reply>/<maxcache>[,...]
-        rblcount=2                              mask = numeric, will match if rbl hits >= 2
-        helo_address=<a.b.c.d/nn>               mask = CIDR[,CIDR,...]
-        sender_ns_names=some.domain.tld         mask = PCRE
-        sender_mx_names=some.domain.tld         mask = PCRE
-        sender_ns_addrs=<a.b.c.d/nn>            mask = CIDR[,CIDR,...]
-        sender_mx_addrs=<a.b.c.d/nn>            mask = CIDR[,CIDR,...]
-        # ------------------------------
-        # Postfix version 2.1 and later:
-        # ------------------------------
-        client_address=<a.b.c.d/nn>             mask = CIDR[,CIDR,...]
-        client_name=another.domain.tld          mask = PCRE
-        reverse_client_name=another.domain.tld  mask = PCRE
-        helo_name=some.domain.tld               mask = PCRE
-        sender=foo@bar.tld                      mask = PCRE
-        recipient=bar@foo.tld                   mask = PCRE
-        recipient_count=5                       mask = numeric, will match if recipients >= 5
-        # ------------------------------
-        # Postfix version 2.2 and later:
-        # ------------------------------
-        sasl_method=plain                       mask = PCRE
-        sasl_username=you                       mask = PCRE
-        sasl_sender=                            mask = PCRE
-        size=12345                              mask = numeric, will match if size >= 12345
-        ccert_subject=blackhole.nowhere.local   mask = PCRE (only if tls verified)
-        ccert_issuer=John+20Doe                 mask = PCRE (only if tls verified)
-        ccert_fingerprint=AA:BB:CC:DD:EE:...    mask = PCRE (do NOT use "..." here)
-        # ------------------------------
-        # Postfix version 2.3 and later:
-        # ------------------------------
-        encryption_protocol=TLSv1/SSLv3         mask = PCRE
-        encryption_cipher=DHE-RSA-AES256-SHA    mask = PCRE
-        encryption_keysize=256                  mask = numeric, will match if keysize >= 256
-        ...
-

the current list can be found at http://www.postfix.org/SMTPD_POLICY_README.html. Please read carefully about which -attribute can be used at which level of the smtp transaction (e.g. size will only work reliably at END-OF-MESSAGE level). -Pattern matching is performed case insensitive.

-

Multiple use of the same item is allowed and will compared as logical OR, which means that this will work as expected:

-
-        id=TRUST001; action=OK; encryption_keysize=64
-                ccert_fingerprint=11:22:33:44:55:66:77:88:99
-                ccert_fingerprint=22:33:44:55:66:77:88:99:00
-                ccert_fingerprint=33:44:55:66:77:88:99:00:11
-                sender=@domain\.local$
-

client_address, rbl and rhsbl items may also be specified as whitespace-or-comma-separated values:

-
-        id=SKIP01; action=dunno
-                client_address=192.168.1.0/24, 172.16.254.23
-        id=SKIP02; action=dunno
-                client_address= 10.10.3.32 10.216.222.0/27
-

The following items must be unique:

-
-        id, minimum and maximum values, rblcount and rhsblcount
-

Any item can be negated by preceeding '!!' to it, e.g.:

-
-        id=HOST001 ;  hostname == !!secure.trust.local ;  action=REJECT only secure.trust.local please
-

or using the right compare operator:

-
-        id=HOST001 ;  hostname != secure.trust.local ;  action=REJECT only secure.trust.local please
-

To avoid confusion with regexps or simply for better visibility you can use '!!(...)':

-
-        id=USER01 ;  sasl_username =~ !!( /^(bob|alice)$/ )  ;  action=REJECT who is that?
-

Request attributes can be compared by preceeding '$$' characters, e.g.:

-
-        id=R-003 ;  client_name = !! $$helo_name      ;  action=WARN helo does not match DNS
-        # or
-        id=R-003 ;  client_name = !!($$(helo_name))   ;  action=WARN helo does not match DNS
-

This is only valid for PCRE values (see list above). The comparison will be performed as case insensitive exact match. -Use the '-vv' option to debug.

-

These special items will be reset for any new rule:

-
-        rblcount        - contains the number of RBL answers
-        rhsblcount      - contains the number of RHSBL answers
-        matches         - contains the number of matched items
-        dnsbltext       - contains the dns TXT part of all RBL and RHSBL replies in the form
-                          rbltype:rblname:<txt>; rbltype:rblname:<txt>; ...
-

These special items will be changed for any matching rule:

-
-        request_hits    - contains ids of all matching rules
-

This means that it might be necessary to save them, if you plan to use these values in later rules:

-
-        # set vals
-        id=RBL01 ; rhsblcount=all; rblcount=all
-                action=set(HIT_rhls=$$rhsblcount,HIT_rbls=$$rblcount,HIT_txt=$$dnsbltext)
-                rbl=list.dsbl.org, bl.spamcop.net, dnsbl.sorbs.net, zen.spamhaus.org
-                rhsbl_client=rddn.dnsbl.net.au, rhsbl.ahbl.org, rhsbl.sorbs.net
-                rhsbl_sender=rddn.dnsbl.net.au, rhsbl.ahbl.org, rhsbl.sorbs.net
-
-        # compare
-        id=RBL02 ; HIT_rhls>=1 ; HIT_rbls>=1 ; action=554 5.7.1 blocked using $$HIT_rhls RHSBLs and $$HIT_rbls RBLs [INFO: $$HIT_txt]
-        id=RBL03 ; HIT_rhls>=2               ; action=554 5.7.1 blocked using $$HIT_rhls RHSBLs [INFO: $$HIT_txt]
-        id=RBL04 ; HIT_rbls>=2               ; action=554 5.7.1 blocked using $$HIT_rbls RBLs [INFO: $$HIT_txt]
-

-

-

FILES

-

Since postfwd1 v1.15 and postfwd2 v0.18 long item lists can be stored in separate files:

-
-        id=R001 ;  ccert_fingerprint==file:/etc/postfwd/wl_ccerts ;  action=DUNNO
-

postfwd2 will read a list of items (one item per line) from /etc/postfwd/wl_ccerts. comments are allowed:

-
-        # client1
-        11:22:33:44:55:66:77:88:99
-        # client2
-        22:33:44:55:66:77:88:99:00
-        # client3
-        33:44:55:66:77:88:99:00:11
-

To use existing tables in key=value format, you can use:

-
-        id=R001 ;  ccert_fingerprint==table:/etc/postfwd/wl_ccerts ;  action=DUNNO
-

This will ignore the right-hand value. Items can be mixed:

-
-        id=R002 ;  action=REJECT
-                client_name==unknown
-                client_name==file:/etc/postfwd/blacklisted
-

and for non pcre (comma separated) items:

-
-        id=R003 ;  action=REJECT
-                client_address==10.1.1.1, file:/etc/postfwd/blacklisted
-
-        id=R004 ;  action=REJECT
-                rbl=myrbl.home.local, zen.spamhaus.org, file:/etc/postfwd/rbls_changing
-

You can check your configuration with the --show_config option at the command line:

-
-        # postfwd2 --showconfig --rule='action=DUNNO; client_address=10.1.0.0/16, file:/etc/postfwd/wl_clients, 192.168.2.1'
-

should give something like:

-
-        Rule   0: id->"R-0"; action->"DUNNO"; client_address->"=;10.1.0.0/16, =;194.123.86.10, =;186.4.6.12, =;192.168.2.1"
-

If a file can not be read, it will be ignored:

-
-        # postfwd2 --showconfig --rule='action=DUNNO; client_address=10.1.0.0/16, file:/etc/postfwd/wl_clients, 192.168.2.1'
-        [LOG warning]: error: file /etc/postfwd/wl_clients not found - file will be ignored ?
-        Rule   0: id->"R-0"; action->"DUNNO"; client_address->"=;10.1.0.0/16, =;192.168.2.1"
-

File items are evaluated at configuration stage. Therefore postfwd2 needs to be reloaded if a file has changed

-

If you want to specify a file, that will be reloaded for each request, you can use lfile: and ltable:

-
-        id=R001; client_address=lfile:/etc/postfwd/client_whitelist; action=dunno
-

This will check the modification time of /etc/postfwd/client_whitelist every time the rule is evaluated and reload it as -necessary. Of course this might increase the system load, so please use it with care.

-

The --showconfig option illustrates the difference:

-
-        ## evaluated at configuration stage
-        # postfwd2 --nodaemon -L --rule='client_address=table:/etc/postfwd/clients; action=dunno' -C
-        Rule   0: id->"R-0"; action->"dunno"; client_address->"=;1.1.1.1, =;1.1.1.2, =;1.1.1.3"
-
-        ## evaluated for any rulehit
-        # postfwd2 --nodaemon -L --rule='client_address=ltable:/etc/postfwd/clients; action=dunno' -C
-        Rule   0: id->"R-0"; action->"dunno"; client_address->"=;ltable:/etc/postfwd/clients"
-

Files can refer to other files. The following is valid.

-
-        -- FILE /etc/postfwd/rules.cf --
-        id=R01; client_address=file:/etc/postfwd/clients_master.cf; action=DUNNO
-
-        -- FILE /etc/postfwd/clients_master.cf --
-        192.168.1.0/24
-        file:/etc/postfwd/clients_east.cf
-        file:/etc/postfwd/clients_west.cf
-
-        -- FILE /etc/postfwd/clients_east.cf --
-        192.168.2.0/24
-
-        -- FILE /etc/postfwd/clients_west.cf --
-        192.168.3.0/24
-

Note that there is currently no loop detection (/a/file calls /a/file) and that this feature is only available -with postfwd1 v1.15 and postfwd2 v0.18 and higher.

-

-

-

ACTIONS

-

General

-

Actions will be executed, when all rule items have matched a request (or at least one of any item list). You can refer to -request attributes by preceeding $$ characters, like:

-
-        id=R-003; client_name = !!$$helo_name; action=WARN helo '$$helo_name' does not match DNS '$$client_name'
-        # or
-        id=R-003; client_name = !!$$helo_name; action=WARN helo '$$(helo_name)' does not match DNS '$$(client_name)'
-

postfix actions

-

Actions will be replied to postfix as result to policy delegation requests. Any action that postfix understands is allowed - see -"man 5 access" or http://www.postfix.org/access.5.html for a description. If no action is specified, the postfix WARN action -which simply logs the event will be used for the corresponding rule.

-

postfwd2 will return dunno if it has reached the end of the ruleset and no rule has matched. This can be changed by placing a last -rule containing only an action statement:

-
-        ...
-        action=dunno ; sender=@domain.local     # sender is ok
-        action=reject                           # default deny
-

postfwd2 actions

-

postfwd2 actions control the behaviour of the program. Currently you can specify the following:

-
-        jump (<id>)
-        jumps to rule with id <id>, use this to skip certain rules.
-        you can jump backwards - but remember that there is no loop
-        detection at the moment! jumps to non-existing ids will be skipped.
-
-        score (<score>)
-        the request's score will be modified by the specified <score>,
-        which must be a floating point value. the modificator can be either
-                +n.nn   adds n.nn to current score
-                -n.nn   sustracts n.nn from the current score
-                *n.nn   multiplies the current score by n.nn
-                /n.nn   divides the current score through n.nn
-                =n.nn   sets the current score to n.nn
-        if the score exceeds the maximum set by `--scores` option (see
-        COMMAND LINE) or the score item (see ITEMS section), the action
-        defined for this case will be returned (default: 5.0=>"REJECT postfwd2 score exceeded").
-
-        set (<item>=<value>,<item>=<value>,...)
-        this command allows you to insert or override request attributes, which then may be
-        compared to your further ruleset. use this to speed up repeated comparisons to large item lists.
-        please see the EXAMPLES section for more information. you may separate multiple key=value pairs
-        by "," characters.
-
-        rate (<item>/<max>/<time>/<action>)
-        this command creates a counter for the given <item>, which will be increased any time a request
-        containing it arrives. if it exceeds <max> within <time> seconds it will return <action> to postfix.
-        rate counters are very fast as they are executed before the ruleset is parsed.
-        please note that <action> was limited to postfix actions (no postfwd actions) for postfwd versions <1.33!
-            # no more than 3 requests per 5 minutes
-            # from the same "unknown" client
-            id=RATE01 ;  client_name==unknown
-               action=rate(client_address/3/300/450 4.7.1 sorry, max 3 requests per 5 minutes)
-
-        size (<item>/<max>/<time>/<action>)
-        this command works similar to the rate() command with the difference, that the rate counter is
-        increased by the request's size attribute. to do this reliably you should call postfwd2 from
-        smtpd_end_of_data_restrictions. if you want to be sure, you could check it within the ruleset:
-           # size limit 1.5mb per hour per client
-           id=SIZE01 ;  protocol_state==END-OF-MESSAGE ;  client_address==!!(10.1.1.1)
-              action=size(client_address/1572864/3600/450 4.7.1 sorry, max 1.5mb per hour)
-
-        rcpt (<item>/<max>/<time>/<action>)
-        this command works similar to the rate() command with the difference, that the rate counter is
-        increased by the request's recipient_count attribute. to do this reliably you should call postfwd
-        from smtpd_data_restrictions or smtpd_end_of_data_restrictions. if you want to be sure, you could
-        check it within the ruleset:
-           # recipient count limit 3 per hour per client
-           id=RCPT01 ;  protocol_state==END-OF-MESSAGE ;  client_address==!!(10.1.1.1)
-              action=rcpt(client_address/3/3600/450 4.7.1 sorry, max 3 recipients per hour)
-
-        rate5321,size5321,rcpt5321 (<item>/<max>/<time>/<action>)
-        same as the corresponding non-5321 functions, with the difference that the localpart of
-        sender oder recipient addresses are evaluated case-sensitive according to rfc5321. That
-        means that requests from bob@example.local and BoB@example.local will be treated differently
-
-        ask (<addr>:<port>[:<ignore>])
-        allows to delegate the policy decision to another policy service (e.g. postgrey). the first
-        and the second argument (address and port) are mandatory. a third optional argument may be
-        specified to tell postfwd2 to ignore certain answers and go on parsing the ruleset:
-           # example1: query postgrey and return it's answer to postfix
-           id=GREY; client_address==10.1.1.1; action=ask(127.0.0.1:10031)
-           # example2: query postgrey but ignore it's answer, if it matches 'DUNNO'
-           # and continue parsing postfwd's ruleset
-           id=GREY; client_address==10.1.1.1; action=ask(127.0.0.1:10031:^dunno$)
-
-        mail(server/helo/from/to/subject/body)
-        This command is deprecated. You should try to use the sendmail() action instead.
-        Very basic mail command, that sends a message with the given arguments. LIMITATIONS:
-        This basically performs a telnet. No authentication or TLS are available. Additionally it does
-        not track notification state and will notify you any time, the corresponding rule hits.
-
-        sendmail(sendmail-path::from::to::subject::body)
-        Mail command, that uses an existing sendmail binary and sends a message with the given arguments.
-        LIMITATIONS: The command does not track notification state and will notify you any time, the
-        corresponding rule hits (which could mean 100 mails for a mail with 100 recipients at RCPT stage).
-
-        wait (<delay>)
-        pauses the program execution for <delay> seconds. use this for
-        delaying or throtteling connections.
-
-        note (<string>)
-        just logs the given string and continues parsing the ruleset.
-        if the string is empty, nothing will be logged (noop).
-
-        quit (<code>)
-        terminates the program with the given exit-code. postfix doesn`t
-        like that too much, so use it with care.
-

You can reference to request attributes, like

-
-        id=R-HELO ;  helo_name=^[^\.]+$ ;  action=REJECT invalid helo '$$helo_name'
-

-

-

MACROS/ACLS

-

Multiple use of long items or combinations of them may be abbreviated by macros. Those must be prefixed by '&&' (two '&' characters). -First the macros have to be defined as follows:

-
-        &&RBLS { rbl=zen.spamhaus.org,list.dsbl.org,bl.spamcop.net,dnsbl.sorbs.net,ix.dnsbl.manitu.net; };
-

Then these may be used in your rules, like:

-
-        &&RBLS ;  client_name=^unknown$                         ; action=REJECT
-        &&RBLS ;  client_name=(\d+[\.-_]){4}                    ; action=REJECT
-        &&RBLS ;  client_name=[\.-_](adsl|dynamic|ppp|)[\.-_]   ; action=REJECT
-

Macros can contain actions, too:

-
-        # definition
-        &&GONOW { action=REJECT your request caused our spam detection policy to reject this message. More info at http://www.domain.local; };
-        # rules
-        &&GONOW ;  &&RBLS ;  client_name=^unknown$
-        &&GONOW ;  &&RBLS ;  client_name=(\d+[\.-_]){4}
-        &&GONOW ;  &&RBLS ;  client_name=[\.-_](adsl|dynamic|ppp|)[\.-_]
-

Macros can contain macros, too:

-
-        # definition
-        &&RBLS{
-                rbl=zen.spamhaus.org
-                rbl=list.dsbl.org
-                rbl=bl.spamcop.net
-                rbl=dnsbl.sorbs.net
-                rbl=ix.dnsbl.manitu.net
-        };
-        &&DYNAMIC{
-                client_name=^unknown$
-                client_name=(\d+[\.-_]){4}
-                client_name=[\.-_](adsl|dynamic|ppp|)[\.-_]
-        };
-        &&GOAWAY { &&RBLS; &&DYNAMIC; };
-        # rules
-        &&GOAWAY ; action=REJECT dynamic client and listed on RBL
-

Basically macros are simple text substitutions - see the PARSER section for more information.

-

-

-

PLUGINS

-

Description

-

The plugin interface allow you to define your own checks and enhance postfwd's -functionality. Feel free to share useful things!

-

Warning

-

Note that the plugin interface is still at devel stage. Please test your plugins -carefully, because errors may cause postfwd to break! It is also -allowed to override attributes or built-in functions, but be sure that you know -what you do because some of them are used internally.

-

Please keep security in mind, when you access sensible ressources and never, ever -run postfwd as privileged user! Also never trust your input (especially hostnames, -and e-mail addresses).

-

ITEMS

-

Item plugins are perl subroutines which integrate additional attributes to requests -before they are evaluated against postfwd's ruleset like any other item of the -policy delegation protocol. This allows you to create your own checks.

-

plugin-items can not be used selective. these functions will be executed for every -request postfwd receives, so keep performance in mind.

-
-        SYNOPSIS: %result = postfwd_items_plugin{<name>}(%request)
-

means that your subroutine, called <name>, has access to a hash called %request, -which contains all request attributes, like $request{client_name} and must -return a value in the following form:

-
-        save: $result{<item>} = <value>
-

this creates the new item <item> containing <value>, which will be integrated in -the policy delegation request and therefore may be used in postfwd's ruleset.

-
-        # do NOT remove the next line
-        %postfwd_items_plugin = (
-
-                # EXAMPLES - integrated in postfwd. no need to activate them here.
-                
-                        # allows to check postfwd version in ruleset
-                        "version" => sub {
-                                my(%request) = @_;
-                                my(%result) = (
-                                        "version" => $NAME." ".$VERSION,
-                                );
-                                return %result;
-                        },
-                
-                        # sender_domain and recipient_domain
-                        "address_parts" => sub {
-                                my(%request) = @_;
-                                my(%result) = ();
-                                $request{sender} =~ /@([^@]*)$/;
-                                $result{sender_domain} = ($1 || '');
-                                $request{recipient} =~ /@([^@]*)$/;
-                                $result{recipient_domain} = ($1 || '');
-                                return %result;
-                        },
-
-        # do NOT remove the next line
-        );
-

COMPARE

-

Compare plugins allow you to define how your new items should be compared to the ruleset. -These are optional. If you don't specify one, the default (== for exact match, =~ for PCRE, ...) -will be used.

-
-        SYNOPSIS:  <item> => sub { return &{$postfwd_compare{<type>}}(@_); },
-
-        # do NOT remove the next line
-        %postfwd_compare_plugin = (
-
-                EXAMPLES - integrated in postfwd. no need to activate them here.
-        
-                        # Simple example
-                        # SYNOPSIS:  <result> = <item> (return &{$postfwd_compare{<type>}}(@_))
-                        "client_address"  => sub { return &{$postfwd_compare{cidr}}(@_); },
-                        "size"            => sub { return &{$postfwd_compare{numeric}}(@_); },
-                        "recipient_count" => sub { return &{$postfwd_compare{numeric}}(@_); },
-        
-                        # Complex example
-                        # SYNOPSIS:  <result> = <item>(<operator>, <ruleset value>, <request value>, <request>)
-                        "numeric" => sub {
-                                my($cmp,$val,$myitem,%request) = @_;
-                                my($myresult) = undef;  $myitem ||= "0"; $val ||= "0";
-                                if ($cmp eq '==') {
-                                        $myresult = ($myitem == $val);
-                                } elsif ($cmp eq '=<') {
-                                        $myresult = ($myitem <= $val);
-                                } elsif ($cmp eq '=>') {
-                                        $myresult = ($myitem >= $val);
-                                } elsif ($cmp eq '<') {
-                                        $myresult = ($myitem < $val);
-                                } elsif ($cmp eq '>') {
-                                        $myresult = ($myitem > $val);
-                                } elsif ($cmp eq '!=') {
-                                        $myresult = not($myitem == $val);
-                                } elsif ($cmp eq '!<') {
-                                        $myresult = not($myitem <= $val);
-                                } elsif ($cmp eq '!>') {
-                                        $myresult = not($myitem >= $val);
-                                } else {
-                                        $myresult = ($myitem >= $val);
-                                };
-                                return $myresult;
-                        },
-
-        # do NOT remove the next line
-        );
-

ACTIONS

-

Action plugins allow to define new postfwd actions. By setting the $stop-flag you can decide to -continue or to stop parsing the ruleset.

-
-        SYNOPSIS:  (<stop rule parsing>, <next rule index>, <return action>, <logprefix>, <request>) =
-                        <action> (<current rule index>, <current time>, <command name>, <argument>, <logprefix>, <request>)
-
-        # do NOT remove the next line
-        %postfwd_actions_plugin = (
-
-                # EXAMPLES - integrated in postfwd. no need to activate them here.
-        
-                        # note(<logstring>) command
-                        "note"  => sub {
-                                my($index,$now,$mycmd,$myarg,$myline,%request) = @_;
-                                my($myaction) = 'dunno'; my($stop) = 0;
-                                log_info "[RULES] ".$myline." - note: ".$myarg if $myarg;
-                                return ($stop,$index,$myaction,$myline,%request);
-                        },
-        
-                        # skips next <myarg> rules
-                        "skip" => sub {
-                                my($index,$now,$mycmd,$myarg,$myline,%request) = @_;
-                                my($myaction) = 'dunno'; my($stop) = 0;
-                                $index += $myarg if ( $myarg and not(($index + $myarg) > $#Rules) );
-                                return ($stop,$index,$myaction,$myline,%request);
-                        },
-        
-                        # dumps current request contents to syslog
-                        "dumprequest" => sub {
-                                my($index,$now,$mycmd,$myarg,$myline,%request) = @_;
-                                my($myaction) = 'dunno'; my($stop) = 0;
-                                map { log_info "[DUMP] rule=$index, Attribute: $_=$request{$_}" } (keys %request);
-                                return ($stop,$index,$myaction,$myline,%request);
-                        },
-
-        # do NOT remove the next line
-        );
-

-

-

COMMAND LINE

-

Ruleset

-

The following arguments are used to specify the source of the postfwd2 ruleset. This means -that at least one of the following is required for postfwd2 to work.

-
-        -f, --file <file>
-        Reads rules from <file>. Please see the CONFIGURATION section
-        below for more information.
-
-        -r, --rule <rule>
-        Adds <rule> to ruleset. Remember that you might have to quote
-        strings that contain whitespaces or shell characters.
-

Scoring

-
-        -s, --scores <val>=<action>
-        Returns <action> to postfix, when the request's score exceeds <val>
-

Multiple usage is allowed. Just chain your arguments, like:

-
-        postfwd2 -r "<item>=<value>;action=<result>" -f <file> -f <file> ...
-          or
-        postfwd2 --scores 4.5="WARN high score" --scores 5.0="REJECT postfwd2 score too high" ...
-

In case of multiple scores, the highest match will count. The order of the arguments will be -reflected in the postfwd2 ruleset.

-

Networking

-

postfwd2 can be run as daemon so that it listens on the network for incoming requests. -The following arguments will control it's behaviour in this case.

-
-        -d, --daemon
-        postfwd2 will run as daemon and listen on the network for incoming
-        queries (default 127.0.0.1:10045).
-
-        -i, --interface <dev>
-        Bind postfwd2 to the specified interface (default 127.0.0.1).
-
-        -p, --port <port>
-        postfwd2 listens on the specified port (default tcp/10045).
-
-        --proto <type>
-        The protocol type for postfwd's socket. Currently you may use 'tcp' or 'unix' here.
-        To use postfwd2 with a unix domain socket, run it as follows:
-            postfwd2 --proto=unix --port=/somewhere/postfwd.socket
-
-        -u, --user <name>
-        Changes real and effective user to <name>.
-
-        -g, --group <name>
-        Changes real and effective group to <name>.
-
-        --umask <mask>
-        Changes the umask for filepermissions of the master process (pidfile).
-        Attention: This is umask, not chmod - you have to specify the bits that
-        should NOT apply. E.g.: umask 077 equals to chmod 700.
-
-        --cache_umask <mask>
-        Changes the umask for filepermissions of the cache process (unix domain socket).
-
-        --server_umask <mask>
-        Changes the umask for filepermissions of the server process (unix domain socket).
-
-        -R, --chroot <path>
-        Chroot the process to the specified path.
-        Please look at http://postfwd.org/postfwd2-chroot.html before use!
-
-        --pidfile <path>
-        The process id will be saved in the specified file.
-
-        --facility <f>
-        sets the syslog facility, default is 'mail'
-
-        --socktype <s>
-        sets the Sys::Syslog socktype to 'native', 'inet' or 'unix'.
-        Default is to auto-detect this depening on module version and os.
-
-        -l, --logname <label>
-        Labels the syslog messages. Useful when running multiple
-        instances of postfwd.
-
-        --loglen <int>
-        Truncates any syslog message after <int> characters.
-

Plugins

-
-        --plugins <file>
-        Loads postfwd plugins from file. Please see http://postfwd.org/postfwd.plugins
-        or the plugins.postfwd.sample that is available from the tarball for more info.
-

Optional arguments

-

These parameters influence the way postfwd2 is working. Any of them can be combined.

-
-        -v, --verbose
-        Verbose logging displays a lot of useful information but can cause
-        your logfiles to grow noticeably. So use it with caution. Set the option
-        twice (-vv) to get more information (logs all request attributes).
-
-        -c, --cache <int>    (default=600)
-        Timeout for request cache, results for identical requests will be
-        cached until config is reloaded or this time (in seconds) expired.
-        A setting of 0 disables this feature.
-
-        --cache-no-size
-        Ignores size attribute for cache comparisons which will lead to better
-        cache-hit rates. You should set this option, if you don't use the size
-        item in your ruleset.
-
-        --cache-no-sender
-        Ignores sender address for cache comparisons which will lead to better
-        cache-hit rates. You should set this option, if you don't use the sender
-        item in your ruleset.
-
-        --cache-rdomain-only 
-        This will strip the localpart of the recipient's address before filling the
-        cache. This may considerably increase cache-hit rates.
-
-        --cache-rbl-timeout <timeout>     (default=3600)
-        This default value will be used as timeout in seconds for rbl cache items,
-        if not specified in the ruleset.
-
-        --cache-rbl-default <pattern>    (default=^127\.0\.0\.\d+$)
-        Matches <pattern> to rbl/rhsbl answers (regexp) if not specified in the ruleset.
-
-        --cacheid <item>, <item>, ...
-        This csv-separated list of request attributes will be used to construct
-        the request cache identifier. Use this only, if you know exactly what you
-        are doing. If you, for example, use postfwd2 only for RBL/RHSBL control,
-        you may set this to
-                postfwd2 --cache=3600 --cacheid=client_name,client_address
-        This increases efficiency of caching and improves postfwd's performance.
-        Warning: You should list all items here, which are used in your ruleset!
-
-        --cleanup-requests <interval>    (default=600)
-        The request cache will be searched for timed out items after this <interval> in
-        seconds. It is a minimum value. The cleanup process will only take place, when
-        a new request arrives.
-
-        --cleanup-rbls <interval>    (default=600)
-        The rbl cache will be searched for timed out items after this <interval> in
-        seconds. It is a minimum value. The cleanup process will only take place, when
-        a new request arrives.
-
-        --cleanup-rates <interval>    (default=600)
-        The rate cache will be searched for timed out items after this <interval> in
-        seconds. It is a minimum value. The cleanup process will only take place, when
-        a new request arrives.
-
-        -S, --summary <int>    (default=600)
-        Shows some usage statistics (program uptime, request counter, matching rules)
-        every <int> seconds. This option is included by the -v switch.
-        This feature uses the alarm signal, so you can force postfwd2 to dump the stats
-        using `kill -ALRM <pid>` (where <pid> is the process id of postfwd).
-
-        Example:
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Counters: 213000 seconds uptime, 39 rules
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Requests: 71643 overall, 49 last interval, 62.88% cache hits
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Averages: 20.18 overall, 4.90 last interval, 557.30 top
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Contents: 44 cached requests, 239 cached dnsbl results
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Rule ID: R-001   matched: 2704 times
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Rule ID: R-002   matched: 9351 times
-        Aug 19 12:39:45 mail1 postfwd[666]: [STATS] Rule ID: R-003   matched: 3116 times
-        ...
-
-        --no-rulestats
-        Disables per rule statistics. Keeps your log clean, if you do not use them.
-        This option has no effect without --summary or --verbose set.
-
-        -L, --stdout
-        Redirects all syslog messages to stdout for debugging. Never use this with postfix!
-
-        -t, --test
-        In test mode postfwd2 always returns "dunno", but logs according
-        to it`s ruleset. -v will be set automatically with this option.
-
-        -n, --nodns
-        Disables all DNS based checks like RBL checks. Rules containing
-        such elements will be ignored.
-
-        -n, --nodnslog
-        Disables logging of dns events.
-
-        --dns_timeout     (default: 14)
-        Sets the timeout for asynchonous dns queries in seconds. This value will apply to
-        all dns items in a rule.
-
-        --dns_timeout_max    (default: 10)
-        Sets the maximum timeout counter for dnsbl lookups. If the timeouts exceed this value
-        the corresponding dnsbl will be deactivated for a while (see --dns_timeout_interval).
-
-        --dns_timeout_interval    (default=1200)
-        The dnsbl timeout counter will be cleaned after this interval in seconds. Use this
-        in conjunction with the --dns_timeout_max parameter.
-
-        --dns_async_txt
-        Perform dnsbl A and TXT lookups simultaneously (otherwise only for listings with at
-        least one A record). This needs more network bandwidth due to increased queries but
-        might increase throughput because the lookups can be parallelized.
-
-        --dns_max_ns_lookups     (default=0)
-        maximum ns names to lookup up with sender_ns_addrs item. use 0 for no maximum.
-
-        --dns_max_mx_lookups     (default=0)
-        maximum mx names to lookup up with sender_mx_addrs item. use 0 for no maximum.
-
-        -I, --instantcfg
-        The config files, specified by -f will be re-read for every request
-        postfwd2 receives. This enables on-the-fly configuration changes
-        without restarting. Though files will be read only if necessary
-        (which means their access times changed since last read) this might
-        significantly increase system load.
-
-        --config_timeout    (default=3)
-        timeout in seconds to parse a single configuration line. if exceeded, the rule will
-        be skipped. this is used to prevent problems due to large files or loops.
-        
-        --keep_rates    (default=0)
-        With this option set postfwd2 does not clear the rate limit counters on reload. Please
-        note that you have to restart (not reload) postfwd with this option if you change
-        any rate limit rules.
-
-        --save_rates    (default=none)
-        With this option postfwd saves existing rate limit counters to disk and reloads them
-        on program start. This allows persistent rate limits across program restarts or reboots.
-        Please note that postfwd needs read and write access to the specified file.
-
-        --fast_limit_evaluation    (default=0)
-        Once a ratelimit was set by the ruleset, future requests will be evaluated against it
-        before consulting the ruleset. This mode was the default behaviour until v1.30.
-        With this mode rate limits will be faster, but also eventually set up
-        whitelisting-rules within the ruleset might not work as expected.
-        LIMITATIONS: This option does not allow nested postfwd commands like
-                action=rate(sender/3/60/wait(3))
-        This option doe not work with the strict-rfc5321 rate() functions.
-

Informational arguments

-

These arguments are for command line usage only. Never ever use them with postfix!

-
-        -C, --showconfig
-        Displays the current ruleset. Use -v for verbose output.
-
-        -V, --version
-        Displays the program version.
-
-        -h, --help
-        Shows program usage.
-
-        -m, --manual
-        Displays the program manual.
-
-        -D, --defaults
-        displays complete postfwd2 settings.
-
-        -P, --perfmon
-        This option turns of any syslogging and output. It is included
-        for performance testing.
-
-        --dumpstats
-        Displays program usage statistics.
-
-        --dumpcache
-        Displays cache contents.
-
-        --delcache <item>
-        Removes an item from the request cache. Use --dumpcache to identify objects.
-        E.g.:
-                # postfwd --dumpcache
-                ...
-                %rate_cache -> %sender=gmato@jqvo.org -> %RATE002+2_600 -> @count    -> '1'
-                %rate_cache -> %sender=gmato@jqvo.org -> %RATE002+2_600 -> @maxcount -> '2'
-                ...
-                # postfwd --delrate="sender=gmato@jqvo.org"
-                rate cache item 'sender=gmato@jqvo.org' removed
-
-        --delrate <item>
-        Removes an item from the rate cache. Use --dumpcache to identify objects.
-

-

-

REFRESH

-

In daemon mode postfwd2 reloads it's ruleset after receiving a HUP signal. Please see the description of -the '-I' switch to have your configuration refreshed for every request postfwd2 receives.

-

-

-

EXAMPLES

-
-        ## whitelisting
-        # 1. networks 192.168.1.0/24, 192.168.2.4
-        # 2. client_names *.gmx.net and *.gmx.de
-        # 3. sender *@someshop.tld from 11.22.33.44
-        id=WL001; action=dunno ; client_address=192.168.1.0/24, 192.168.2.4
-        id=WL002; action=dunno ; client_name=\.gmx\.(net|de)$
-        id=WL003; action=dunno ; sender=@someshop\.tld$ ; client_address=11.22.33.44
-
-        ## TLS control
-        # 1. *@authority.tld only with correct TLS fingerprint
-        # 2. *@secret.tld only with keysizes >=64
-        id=TL001; action=dunno                          ; sender=@authority\.tld$ ; ccert_fingerprint=AA:BB:CC..
-        id=TL002; action=REJECT wrong TLS fingerprint   ; sender=@authority\.tld$
-        id=TL003; action=REJECT tls keylength < 64      ; sender=@secret\.tld$ ; encryption_keysize=64
-
-        ## Combined RBL checks
-        # This will reject mail if
-        # 1. listed on ix.dnsbl.manitu.net
-        # 2. listed on zen.spamhaus.org (sbl and xbl, dns cache timeout 1200s instead of 3600s)
-        # 3. listed on min 2 of bl.spamcop.net, list.dsbl.org, dnsbl.sorbs.net
-        # 4. listed on bl.spamcop.net and one of rhsbl.ahbl.org, rhsbl.sorbs.net
-        id=RBL01 ; action=REJECT listed on ix.dnsbl.manitu.net  ; rbl=ix.dnsbl.manitu.net
-        id=RBL02 ; action=REJECT listed on zen.spamhaus.org     ; rbl=zen.spamhaus.org/127.0.0.[2-8]/1200
-        id=RBL03 ; action=REJECT listed on too many RBLs        ; rblcount=2 ; rbl=bl.spamcop.net, list.dsbl.org, dnsbl.sorbs.net
-        id=RBL04 ; action=REJECT combined RBL+RHSBL check       ; rbl=bl.spamcop.net ; rhsbl=rhsbl.ahbl.org, rhsbl.sorbs.net
-
-        ## Message size (requires message_size_limit to be set to 30000000)
-        # 1. 30MB for systems in *.customer1.tld
-        # 2. 20MB for SASL user joejob
-        # 3. 10MB default
-        id=SZ001; protocol_state==END-OF-MESSAGE; action=DUNNO; size<=30000000 ; client_name=\.customer1.tld$
-        id=SZ002; protocol_state==END-OF-MESSAGE; action=DUNNO; size<=20000000 ; sasl_username==joejob
-        id=SZ002; protocol_state==END-OF-MESSAGE; action=DUNNO; size<=10000000
-        id=SZ100; protocol_state==END-OF-MESSAGE; action=REJECT message too large
-
-        ## Selective Greylisting
-        ##
-        ## Note that postfwd does not include greylisting. This setup requires a running postgrey service
-        ## at port 10031 and the following postfix restriction class in your main.cf:
-        ##
-        ##      smtpd_restriction_classes = check_postgrey, ...
-        ##      check_postgrey = check_policy_service inet:127.0.0.1:10031
-        #
-        # 1. if listed on zen.spamhaus.org with results 127.0.0.10 or .11, dns cache timeout 1200s
-        # 2. Client has no rDNS
-        # 3. Client comes from several dialin domains
-        id=GR001; action=check_postgrey ; rbl=dul.dnsbl.sorbs.net, zen.spamhaus.org/127.0.0.1[01]/1200
-        id=GR002; action=check_postgrey ; client_name=^unknown$
-        id=GR003; action=check_postgrey ; client_name=\.(t-ipconnect|alicedsl|ish)\.de$
-
-        ## Date Time
-        date=24.12.2007-26.12.2007          ;  action=450 4.7.1 office closed during christmas
-        time=04:00:00-05:00:00              ;  action=450 4.7.1 maintenance ongoing, try again later
-        time=-07:00:00 ;  sasl_username=jim ;  action=450 4.7.1 to early for you, jim
-        time=22:00:00- ;  sasl_username=jim ;  action=450 4.7.1 to late now, jim
-        months=-Apr                         ;  action=450 4.7.1 see you in may
-        days=!!Mon-Fri                      ;  action=check_postgrey
-
-        ## Usage of jump
-        # The following allows a message size of 30MB for different
-        # users/clients while others will only have 10MB.
-        id=R001 ; action=jump(R100) ; sasl_username=^(Alice|Bob|Jane)$
-        id=R002 ; action=jump(R100) ; client_address=192.168.1.0/24
-        id=R003 ; action=jump(R100) ; ccert_fingerprint=AA:BB:CC:DD:...
-        id=R004 ; action=jump(R100) ; ccert_fingerprint=AF:BE:CD:DC:...
-        id=R005 ; action=jump(R100) ; ccert_fingerprint=DD:CC:BB:DD:...
-        id=R099 ; protocol_state==END-OF-MESSAGE; action=REJECT message too big (max. 10MB); size=10000000
-        id=R100 ; protocol_state==END-OF-MESSAGE; action=REJECT message too big (max. 30MB); size=30000000
-
-        ## Usage of score
-        # The following rejects a mail, if the client
-        # - is listed on 1 RBL and 1 RHSBL
-        # - is listed in 1 RBL or 1 RHSBL and has no correct rDNS
-        # - other clients without correct rDNS will be greylist-checked
-        # - some whitelists are used to lower the score
-        id=S01 ; score=2.6              ; action=check_postgrey
-        id=S02 ; score=5.0              ; action=REJECT postfwd score too high
-        id=R00 ; action=score(-1.0)     ; rbl=exemptions.ahbl.org,list.dnswl.org,query.bondedsender.org,spf.trusted-forwarder.org
-        id=R01 ; action=score(2.5)      ; rbl=bl.spamcop.net, list.dsbl.org, dnsbl.sorbs.net
-        id=R02 ; action=score(2.5)      ; rhsbl=rhsbl.ahbl.org, rhsbl.sorbs.net
-        id=N01 ; action=score(-0.2)     ; client_name==$$helo_name
-        id=N02 ; action=score(2.7)      ; client_name=^unknown$
-        ...
-
-        ## Usage of rate and size
-        # The following temporary rejects requests from "unknown" clients, if they
-        # 1. exceeded 30 requests per hour or
-        # 2. tried to send more than 1.5mb within 10 minutes
-        id=RATE01 ;  client_name==unknown ;  protocol_state==RCPT
-                action=rate(client_address/30/3600/450 4.7.1 sorry, max 30 requests per hour)
-        id=SIZE01 ;  client_name==unknown ;  protocol_state==END-OF-MESSAGE
-                action=size(client_address/1572864/600/450 4.7.1 sorry, max 1.5mb per 10 minutes)
-
-        ## Macros
-        # definition
-        &&RBLS { rbl=zen.spamhaus.org,list.dsbl.org,bl.spamcop.net,dnsbl.sorbs.net,ix.dnsbl.manitu.net; };
-        &&GONOW { action=REJECT your request caused our spam detection policy to reject this message. More info at http://www.domain.local; };
-        # rules
-        &&GONOW ;  &&RBLS ;  client_name=^unknown$
-        &&GONOW ;  &&RBLS ;  client_name=(\d+[\.-_]){4}
-        &&GONOW ;  &&RBLS ;  client_name=[\.-_](adsl|dynamic|ppp|)[\.-_]
-
-        ## Groups
-        # definition
-        &&RBLS{
-                rbl=zen.spamhaus.org
-                rbl=list.dsbl.org
-                rbl=bl.spamcop.net
-                rbl=dnsbl.sorbs.net
-                rbl=ix.dnsbl.manitu.net
-        };
-        &&RHSBLS{
-                ...
-        };
-        &&DYNAMIC{
-                client_name==unknown
-                client_name~=(\d+[\.-_]){4}
-                client_name~=[\.-_](adsl|dynamic|ppp|)[\.-_]
-                ...
-        };
-        &&BAD_HELO{
-                helo_name==my.name.tld
-                helo_name~=^([^\.]+)$
-                helo_name~=\.(local|lan)$
-                ...
-        };
-        &&MAINTENANCE{
-                date=15.01.2007
-                date=15.04.2007
-                date=15.07.2007
-                date=15.10.2007
-                time=03:00:00 - 04:00:00
-        };
-        # rules
-        id=COMBINED    ;  &&RBLS ;  &&DYNAMIC ;  action=REJECT dynamic client and listed on RBL
-        id=MAINTENANCE ;  &&MAINTENANCE       ;  action=DEFER maintenance time - please try again later
-        
-        # now with the set() command, note that long item
-        # lists don't have to be compared twice
-        id=RBL01    ;  &&RBLS      ;  action=set(HIT_rbls=1)
-        id=HELO01   ;  &&BAD_HELO  ;  action=set(HIT_helo=1)
-        id=DYNA01   ;  &&DYNAMIC   ;  action=set(HIT_dyna=1)
-        id=REJECT01 ;  HIT_rbls==1 ;  HIT_helo==1  ; action=REJECT please see http://some.org/info?reject=01 for more info
-        id=REJECT02 ;  HIT_rbls==1 ;  HIT_dyna==1  ; action=REJECT please see http://some.org/info?reject=02 for more info
-        id=REJECT03 ;  HIT_helo==1 ;  HIT_dyna==1  ; action=REJECT please see http://some.org/info?reject=03 for more info
-
-        ## combined with enhanced rbl features
-        #
-        id=RBL01 ; rhsblcount=all ; rblcount=all ; &&RBLS ; &&RHSBLS
-             action=set(HIT_dnsbls=$$rhsblcount,HIT_dnsbls+=$$rblcount,HIT_dnstxt=$$dnsbltext)
-        id=RBL02 ; HIT_dnsbls>=2  ; action=554 5.7.1 blocked using $$HIT_dnsbls DNSBLs [INFO: $$HIT_dnstxt]
-

-

-

PARSER

-

Configuration

-

The postfwd2 ruleset can be specified at the commandline (-r option) or be read from files (-f). The order of your arguments will be kept. You should -check the parser with the -C | --showconfig switch at the command line before applying a new config. The following call:

-
-        postfwd2 --showconfig \
-                -r "id=TEST; recipient_count=100; action=WARN mail with 100+ recipients" \
-                -f /etc/postfwd.cf \
-                -r "id=DEFAULT; action=dunno";
-

will produce the following output:

-
-        Rule   0: id->"TEST" action->"WARN mail with 100+ recipients"; recipient_count->"100"
-        ...
-        ... <content of /etc/postfwd.cf> ...
-        ...
-        Rule <n>: id->"DEFAULT" action->"dunno"
-

Multiple items of the same type will be added to lists (see the ITEMS section for more info):

-
-        postfwd2 --showconfig \
-                -r "client_address=192.168.1.0/24; client_address=172.16.26.32; action=dunno"
-

will result in:

-
-        Rule   0: id->"R-0"; action->"dunno"; client_address->"192.168.1.0/24, 172.16.26.32"
-

Macros are evaluated at configuration stage, which means that

-
-        postfwd2 --showconfig \
-                -r "&&RBLS { rbl=bl.spamcop.net; client_name=^unknown$; };" \
-                -r "id=RBL001; &&RBLS; action=REJECT listed on spamcop and bad rdns";
-

will result in:

-
-        Rule   0: id->"RBL001"; action->"REJECT listed on spamcop and bad rdns"; rbl->"bl.spamcop.net"; client_name->"^unknown$"
-

Request processing

-

When a policy delegation request arrives it will be compared against postfwd`s ruleset. To inspect the processing in detail you should increase -verbority using use the "-v" or "-vv" switch. "-L" redirects log messages to stdout.

-

Keeping the order of the ruleset in general, items will be compared in random order, which basically means that

-
-        id=R001; action=dunno; client_address=192.168.1.1; sender=bob@alice.local
-

equals to

-
-        id=R001; sender=bob@alice.local; client_address=192.168.1.1; action=dunno
-

Lists will be evaluated in the specified order. This allows to place faster expressions at first:

-
-        postfwd2 --nodaemon -vv -L -r "id=RBL001; rbl=localrbl.local zen.spamhaus.org; action=REJECT" /some/where/request.sample
-

produces the following

-
-        [LOGS info]: compare rbl: "remotehost.remote.net[68.10.1.7]"  ->  "localrbl.local"
-        [LOGS info]: count1 rbl:  "2"  ->  "0"
-        [LOGS info]: query rbl:   localrbl.local 7.1.10.68 (7.1.10.68.localrbl.local)
-        [LOGS info]: count2 rbl:  "2"  ->  "0"
-        [LOGS info]: match rbl:   FALSE
-        [LOGS info]: compare rbl: "remotehost.remote.net[68.10.1.7]"  ->  "zen.spamhaus.org"
-        [LOGS info]: count1 rbl:  "2"  ->  "0"
-        [LOGS info]: query rbl:   zen.spamhaus.org 7.1.10.68 (7.1.10.68.zen.spamhaus.org)
-        [LOGS info]: count2 rbl:  "2"  ->  "0"
-        [LOGS info]: match rbl:   FALSE
-        [LOGS info]: Action: dunno
-

The negation operator !!(<value>) has the highest priority and therefore will be evaluated first. Then variable substitutions are performed:

-
-        postfwd2 --nodaemon -vv -L -r "id=TEST; action=REJECT; client_name=!!($$heloname)" /some/where/request.sample
-

will give

-
-        [LOGS info]: compare client_name:     "unknown"  ->  "!!($$helo_name)"
-        [LOGS info]: negate client_name:      "unknown"  ->  "$$helo_name"
-        [LOGS info]: substitute client_name:  "unknown"  ->  "english-breakfast.cloud8.net"
-        [LOGS info]: match client_name:  TRUE
-        [LOGS info]: Action: REJECT
-

Ruleset evaluation

-

A rule hits when all items (or at least one element of a list for each item) have matched. As soon as one item (or all elements of a list) fails -to compare against the request attribute the parser will jump to the next rule in the postfwd2 ruleset.

-

If a rule matches, there are two options:

-

* Rule returns postfix action (dunno, reject, ...) -The parser stops rule processing and returns the action to postfix. Other rules will not be evaluated.

-

* Rule returns postfwd2 action (jump(), note(), ...) -The parser evaluates the given action and continues with the next rule (except for the jump() or quit() actions - please see the ACTIONS section -for more information). Nothing will be sent to postfix.

-

If no rule has matched and the end of the ruleset is reached postfwd2 will return dunno without logging anything unless in verbose mode. You may -place a last catch-all rule to change that behaviour:

-
-        ... <your rules> ...
-        id=DEFAULT ;  action=dunno
-

will log any request that passes the ruleset without having hit a prior rule.

-

-

-

DEBUGGING

-

To debug special steps of the parser the '--debug' switch takes a list of debug classes. Currently the following classes are defined:

-
-        all cache config debugdns devel dns getcache getdns
-        getdnspacket rates request setcache setdns
-        parent_cache parent_dns_cache parent_rate_cache parent_request_cache
-        child_cache  child_dns_cache  child_rate_cache  child_request_cache
-

-

-

INTEGRATION

-

Integration via daemon mode

-

The common way to use postfwd2 is to start it as daemon, listening at a specified tcp port. -postfwd2 will spawn multiple child processes which communicate with a parent cache. This is -the prefered way to use postfwd2 in high volume environments. Start postfwd2 with the following parameters:

-
-        postfwd2 -d -f /etc/postfwd.cf -i 127.0.0.1 -p 10045 -u nobody -g nobody -S
-

For efficient caching you should check if you can use the options --cacheid, --cache-rdomain-only, ---cache-no-sender and --cache-no-size.

-

Now check your syslogs (default facility "mail") for a line like:

-
-        Aug  9 23:00:24 mail postfwd[5158]: postfwd2 n.nn ready for input
-

and use `netstat -an|grep 10045` to check for something like

-
-        tcp  0  0  127.0.0.1:10045  0.0.0.0:*  LISTEN
-

If everything works, open your postfix main.cf and insert the following

-
-        127.0.0.1:10045_time_limit      = 3600                                          <--- integration
-        smtpd_recipient_restrictions    = permit_mynetworks                             <--- recommended
-                                          reject_unauth_destination                     <--- recommended
-                                          check_policy_service inet:127.0.0.1:10045     <--- integration
-

Reload your configuration with `postfix reload` and watch your logs. In it works you should see -lines like the following in your mail log:

-
-        Aug  9 23:01:24 mail postfwd[5158]: rule=22, id=ML_POSTFIX, client=english-breakfast.cloud9.net[168.100.1.7], sender=owner-postfix-users@postfix.tld, recipient=someone@domain.local, helo=english-breakfast.cloud9.net, proto=ESMTP, state=RCPT, action=dunno
-

If you want to check for size or rcpt_count items you must integrate postfwd2 in smtp_data_restrictions or -smtpd_end_of_data_restrictions. Of course you can also specify a restriction class and use it in your access -tables. First create a file /etc/postfix/policy containing:

-
-        domain1.local           postfwdcheck
-        domain2.local           postfwdcheck
-        ...
-

Then postmap that file (`postmap hash:/etc/postfix/policy`), open your main.cf and enter

-
-        # Restriction Classes
-        smtpd_restriction_classes       = postfwdcheck, <some more>...                          <--- integration
-        postfwdcheck                    = check_policy_service inet:127.0.0.1:10045             <--- integration
-
-        127.0.0.1:10045_time_limit      = 3600                                                  <--- integration
-        smtpd_recipient_restrictions    = permit_mynetworks,                                    <--- recommended
-                                          reject_unauth_destination,                            <--- recommended
-                                          ...                                                   <--- optional
-                                          check_recipient_access hash:/etc/postfix/policy,      <--- integration
-                                          ...                                                   <--- optional
-

Reload postfix and watch your logs.

-

-

-

TESTING

-

First you have to create a ruleset (see Configuration section). Check it with

-
-        postfwd2 -f /etc/postfwd.cf -C
-

There is an example policy request distributed with postfwd, called 'request.sample'. -Simply change it to meet your requirements and use

-
-        postfwd2 -f /etc/postfwd.cf <request.sample
-

You should get an answer like

-
-        action=<whateveryouconfigured>
-

For network tests I use netcat:

-
-        nc 127.0.0.1 10045 <request.sample
-

to send a request to postfwd. If you receive nothing, make sure that postfwd2 is running and -listening on the specified network settings.

-

-

-

PERFORMANCE

-

Some of these proposals might not match your environment. Please check your requirements and test new options carefully!

-
-        - use caching options
-        - use the correct match operator ==, <=, >=
-        - use ^ and/or $ in regular expressions
-        - use item lists (faster than single rules)
-        - use set() action on repeated item lists
-        - use jumps and rate limits
-        - use a pre-lookup rule for rbl/rhsbls with empty note() action
-

-

-

SEE ALSO

-

See http://www.postfix.org/SMTPD_POLICY_README.html for a description -of how Postfix policy servers work.

-

-

-
-

LICENSE

-

postfwd2 is free software and released under BSD license, which basically means -that you can do what you want as long as you keep the copyright notice:

-

Copyright (c) 2009, Jan Peter Kessler -All rights reserved.

-

Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met:

-
- * Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in
-   the documentation and/or other materials provided with the
-   distribution.
- * Neither the name of the authors nor the names of his contributors
-   may be used to endorse or promote products derived from this
-   software without specific prior written permission.
-

THIS SOFTWARE IS PROVIDED BY ME ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, -INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, -INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, -WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE.

-

-

-
-

AUTHOR

-

Jan Peter Kessler <info (AT) postfwd (DOT) org>. Let me know, if you have any suggestions.

- - - - diff --git a/doc/postfwd2.txt b/doc/postfwd2.txt deleted file mode 100644 index 17e0e71..0000000 --- a/doc/postfwd2.txt +++ /dev/null @@ -1,1521 +0,0 @@ -NAME - postfwd2 - postfix firewall daemon - -SYNOPSIS - postfwd2 [OPTIONS] [SOURCE1, SOURCE2, ...] - - Ruleset: (at least one, multiple use is allowed): - -f, --file reads rules from - -r, --rule adds to config - -s, --scores = returns when score exceeds - - Server: - -i, --interface listen on interface - -p, --port listen on port - --proto socket type (tcp or unix) - --server_socket e.g. tcp:127.0.0.1:10045 - -u, --user set uid to user - -g, --group set gid to group - --umask umask for master filepermissions - --server_umask umask for server filepermissions - --pidfile create pidfile under - --min_servers spawn at least children - --max_servers do not spawn more than children - --min_spare_servers minimum idle children - --max_spare_servers maximum idle children - - Cache: - -c, --cache sets the request-cache timeout to seconds - --cleanup-requests cleanup interval in seconds for request cache - --cache_interface listen on interface - --cache_port listen on port - --cache_proto socket type (tcp or unix) - --cache_socket e.g. tcp:127.0.0.1:10043 - --cache_umask umask for cache filepermissions - --cacheid list of request items for cache-id - --cache-rdomain-only skip recipient localpart for cache-id - --cache-no-sender skip sender address for cache-id - --cache-no-size skip size for cache-id - --no_parent_request_cache disable parent request cache - --no_parent_rate_cache disable parent rate cache - --no_parent_dns_cache disable parent dns cache (default) - --no_parent_cache disable all parent caches - - Rates: - --cleanup-rates cleanup interval in seconds for rate cache - - Control: - -k, --kill, --stop terminate postfwd2 - --reload, --hup reload postfwd2 - --watchdog watchdog timer in seconds - --respawn respawn delay in seconds - --failures max respawn failure counter - --daemons list of daemons to start - --dumpcache show cache contents - --dumpstats show statistics - -R, --chroot chroot to before start - --delcache removes an item from the request cache - --delrate removes an item from the rate cache - - DNS: - -n, --nodns skip any dns based test - --dns_timeout dns query timeout in seconds - --dns_timeout_max disable dnsbl after timeouts - --dns_timeout_interval reenable dnsbl after seconds - --cache-rbl-timeout default dns ttl if not specified in ruleset - --cache-rbl-default default dns pattern if not specified in ruleset - --cleanup-rbls cleanup old dns cache items every seconds - --dns_async_txt perform dnsbl A and TXT lookups simultaneously - --dns_max_ns_lookups max names to look up with sender_ns_addrs - --dns_max_mx_lookups max names to look up with sender_mx_addrs - - Optional: - -t, --test testing, always returns "dunno" - -S, --summary show stats every seconds - --noidlestats disables statistics when idle - --norulestats disables per rule statistics - -I, --instantcfg reloads ruleset on every new request - --config_timeout parser timeout in seconds - --keep_rates do not clear rate limit counters on reload - --save_rates save and load rate limits on disk - --fast_limit_evaluation evaluate rate limits before ruleset is parsed - (please note the limitations) - - - Plugins: - --plugins loads postfwd plugins from file - - Logging: - -l, --logname