ANVIL(8) ANVIL(8)

NAME
       anvil - Postfix session count and request rate control

SYNOPSIS
       aannvviill [generic Postfix daemon options]

DESCRIPTION
       The  Postfix  aannvviill(8) server maintains statistics about client connec-
       tion counts or client request rates. This information can  be  used  to
       defend against clients that hammer a server with either too many simul-
       taneous sessions, or with too many successive requests within a config-
       urable  time interval.  This server is designed to run under control by
       the Postfix mmaasstteerr(8) server.

       In the following text, iiddeenntt specifies a (service, client) combination.
       The  exact  syntax  of  that  information is application-dependent; the
       aannvviill(8) server does not care.

CCOONNNNEECCTTIIOONN CCOOUUNNTT//RRAATTEE CCOONNTTRROOLL
       To register a new connection send the following request to the aannvviill(8)
       server:

           rreeqquueesstt==ccoonnnneecctt
           iiddeenntt==string

       The aannvviill(8) server answers with the number of simultaneous connections
       and the number of connections per unit time for the  (service,  client)
       combination specified with iiddeenntt:

           ssttaattuuss==00
           ccoouunntt==number
           rraattee==number

       To  register  a  disconnect  event  send  the  following request to the
       aannvviill(8) server:

           rreeqquueesstt==ddiissccoonnnneecctt
           iiddeenntt==string

       The aannvviill(8) server replies with:

           ssttaattuuss==00

MMEESSSSAAGGEE RRAATTEE CCOONNTTRROOLL
       To register a message delivery request send the  following  request  to
       the aannvviill(8) server:

           rreeqquueesstt==mmeessssaaggee
           iiddeenntt==string

       The  aannvviill(8)  server  answers  with  the  number  of  message delivery
       requests per unit time for the (service, client) combination  specified
       with iiddeenntt:

           ssttaattuuss==00
           rraattee==number

RREECCIIPPIIEENNTT RRAATTEE CCOONNTTRROOLL
       To  register  a  recipient  request  send  the following request to the
       aannvviill(8) server:

           rreeqquueesstt==rreecciippiieenntt
           iiddeenntt==string

       The aannvviill(8) server answers with the number of recipient addresses  per
       unit time for the (service, client) combination specified with iiddeenntt:

           ssttaattuuss==00
           rraattee==number

TTLLSS SSEESSSSIIOONN NNEEGGOOTTIIAATTIIOONN RRAATTEE CCOONNTTRROOLL
       The  features  described in this section are available with Postfix 2.3
       and later.

       To register a request for a new (i.e. not cached) TLS session send  the
       following request to the aannvviill(8) server:

           rreeqquueesstt==nneewwttllss
           iiddeenntt==string

       The aannvviill(8) server answers with the number of new TLS session requests
       per unit time for the  (service,  client)  combination  specified  with
       iiddeenntt:

           ssttaattuuss==00
           rraattee==number

       To  retrieve  new TLS session request rate information without updating
       the counter information, send:

           rreeqquueesstt==nneewwttllssrreeppoorrtt
           iiddeenntt==string

       The aannvviill(8) server answers with the number of new TLS session requests
       per  unit  time  for  the  (service, client) combination specified with
       iiddeenntt:

           ssttaattuuss==00
           rraattee==number

SSEECCUURRIITTYY
       The aannvviill(8) server does not talk to the network or to local users, and
       can run chrooted at fixed low privilege.

       The aannvviill(8) server maintains an in-memory table with information about
       recent clients requests.  No persistent state is kept because  standard
       system  library  routines are not sufficiently robust for update-inten-
       sive applications.

       Although the in-memory state is kept only temporarily, this may require
       a  lot  of  memory  on systems that handle connections from many remote
       clients.  To reduce memory usage, reduce the time unit over which state
       is kept.

DIAGNOSTICS       Problems and transactions are logged to ssyyssllooggdd(8).

       Upon  exit, and every aannvviillssttaattuussuuppddaatteettiimmee seconds, the server logs
       the maximal count and rate values  measured,  together  with  (service,
       client)  information  and the time of day associated with those events.
       In order to avoid unnecessary overhead, no measurements  are  done  for
       activity that isn't concurrency limited or rate limited.

BUGS
       Systems behind network address translating routers or proxies appear to
       have the same client address and can run into connection  count  and/or
       rate limits falsely.

       In  this  preliminary  implementation, a count (or rate) limited server
       can have only one remote client at a time. If a server reports multiple
       simultaneous  clients, state is kept only for the last reported client.

       The aannvviill(8) server automatically discards client  request  information
       after  it  expires.   To  prevent  the  aannvviill(8) server from discarding
       client request rate information too early or too late, a  rate  limited
       service  should  always register connect/disconnect events even when it
       does not explicitly limit them.

CCOONNFFIIGGUURRAATTIIOONN PPAARRAAMMEETTEERRSS
       On low-traffic mail systems, changes to mmaaiinn..ccff are picked up automati-
       cally  as  aannvviill(8) processes run for only a limited amount of time. On
       other mail systems, use the command "ppoossttffiixx  rreellooaadd"  to  speed  up  a
       change.

       The  text  below provides only a parameter summary. See ppoossttccoonnff(5) for
       more details including examples.

       aannvviillrraatteettiimmeeuunniitt ((6600ss))
              The time unit over which client connection rates and other rates
              are calculated.

       aannvviillssttaattuussuuppddaatteettiimmee ((660000ss))
              How  frequently the aannvviill(8) connection and rate limiting server
              logs peak usage information.

       ccoonnffiiggddiirreeccttoorryy ((sseeee ''ppoossttccoonnff -dd'' oouuttppuutt))
              The default location of the Postfix main.cf and  master.cf  con-
              figuration files.

       ddaaeemmoonnttiimmeeoouutt ((1188000000ss))
              How  much  time  a  Postfix  daemon process may take to handle a
              request before it is terminated by a built-in watchdog timer.

       iippccttiimmeeoouutt ((33660000ss))
              The time limit for sending  or  receiving  information  over  an
              internal communication channel.

       mmaaxxiiddllee ((110000ss))
              The  maximum  amount of time that an idle Postfix daemon process
              waits for an incoming connection before terminating voluntarily.

       mmaaxxuussee ((110000))
              The maximal number of incoming connections that a Postfix daemon
              process will service before terminating voluntarily.

       pprroocceessssiidd ((rreeaadd-oonnllyy))
              The process ID of a Postfix command or daemon process.

       pprroocceessssnnaammee ((rreeaadd-oonnllyy))
              The process name of a Postfix command or daemon process.

       ssyyssllooggffaacciilliittyy ((mmaaiill))
              The syslog facility of Postfix logging.

       ssyyssllooggnnaammee ((ppoossttffiixx))
              The mail system name that is prepended to the  process  name  in
              syslog  records,  so  that  "smtpd" becomes, for example, "post-
              fix/smtpd".

SEE ALSO
       smtpd(8), Postfix SMTP server
       postconf(5), configuration parameters
       master(5), generic daemon options

README FILES       Use "ppoossttccoonnff rreeaaddmmeeddiirreeccttoorryy" or "ppoossttccoonnff hhttmmllddiirreeccttoorryy" to  locate
       this information.
       TUNINGREADME, performance tuning

LLIICCEENNSSEE
       The Secure Mailer license must be distributed with this software.

HISTORY
       The anvil service is available in Postfix 2.2 and later.

AUTHOR(S)       Wietse Venema
       IBM T.J. Watson Research
       P.O. Box 704
       Yorktown Heights, NY 10598, USA



                                                                      ANVIL(8)