1ANVIL(8) System Manager's Manual ANVIL(8)
2
6 anvil - Postfix session count and request rate control
7
9 anvil [generic Postfix daemon options]
10
12 The Postfix anvil(8) server maintains statistics about client connec‐
13 tion counts or client request rates. This information can be used to
14 defend against clients that hammer a server with either too many simul‐
15 taneous sessions, or with too many successive requests within a config‐
16 urable time interval. This server is designed to run under control by
17 the Postfix master(8) server.
18 In the following text, ident specifies a (service, client) combination.
20 The exact syntax of that information is application-dependent; the
21 anvil(8) server does not care.
22
24 To register a new connection send the following request to the anvil(8)
25 server:
26 request=connect
28 ident=string
29 The anvil(8) server answers with the number of simultaneous connections
31 and the number of connections per unit time for the (service, client)
32 combination specified with ident:
33 status=0
35 count=number
36 rate=number
37 To register a disconnect event send the following request to the
39 anvil(8) server:
40 request=disconnect
42 ident=string
43 The anvil(8) server replies with:
45 status=0
47
49 To register a message delivery request send the following request to
50 the anvil(8) server:
51 request=message
53 ident=string
54 The anvil(8) server answers with the number of message delivery
56 requests per unit time for the (service, client) combination specified
57 with ident:
58 status=0
60 rate=number
61
63 To register a recipient request send the following request to the
64 anvil(8) server:
65 request=recipient
67 ident=string
68 The anvil(8) server answers with the number of recipient addresses per
70 unit time for the (service, client) combination specified with ident:
71 status=0
73 rate=number
74
76 The features described in this section are available with Postfix 2.3
77 and later.
78 To register a request for a new (i.e. not cached) TLS session send the
80 following request to the anvil(8) server:
81 request=newtls
83 ident=string
84 The anvil(8) server answers with the number of new TLS session requests
86 per unit time for the (service, client) combination specified with
87 ident:
88 status=0
90 rate=number
91 To retrieve new TLS session request rate information without updating
93 the counter information, send:
94 request=newtls_report
96 ident=string
97 The anvil(8) server answers with the number of new TLS session requests
99 per unit time for the (service, client) combination specified with
100 ident:
101 status=0
103 rate=number
104
106 The anvil(8) server does not talk to the network or to local users, and
107 can run chrooted at fixed low privilege.
108 The anvil(8) server maintains an in-memory table with information about
110 recent clients requests. No persistent state is kept because standard
111 system library routines are not sufficiently robust for update-inten‐
112 sive applications.
113 Although the in-memory state is kept only temporarily, this may require
115 a lot of memory on systems that handle connections from many remote
116 clients. To reduce memory usage, reduce the time unit over which state
117 is kept.
118
120 Problems and transactions are logged to syslogd(8).
121 Upon exit, and every anvil_status_update_time seconds, the server logs
123 the maximal count and rate values measured, together with (service,
124 client) information and the time of day associated with those events.
125 In order to avoid unnecessary overhead, no measurements are done for
126 activity that isn't concurrency limited or rate limited.
127
129 Systems behind network address translating routers or proxies appear to
130 have the same client address and can run into connection count and/or
131 rate limits falsely.
132 In this preliminary implementation, a count (or rate) limited server
134 can have only one remote client at a time. If a server reports multiple
135 simultaneous clients, state is kept only for the last reported client.
136 The anvil(8) server automatically discards client request information
138 after it expires. To prevent the anvil(8) server from discarding
139 client request rate information too early or too late, a rate limited
140 service should always register connect/disconnect events even when it
141 does not explicitly limit them.
142
144 On low-traffic mail systems, changes to main.cf are picked up automati‐
145 cally as anvil(8) processes run for only a limited amount of time. On
146 other mail systems, use the command "postfix reload" to speed up a
147 change.
148 The text below provides only a parameter summary. See postconf(5) for
150 more details including examples.
151 anvil_rate_time_unit (60s)
153 The time unit over which client connection rates and other rates
154 are calculated.
155 anvil_status_update_time (600s)
157 How frequently the anvil(8) connection and rate limiting server
158 logs peak usage information.
159 config_directory (see 'postconf -d' output)
161 The default location of the Postfix main.cf and master.cf con‐
162 figuration files.
163 daemon_timeout (18000s)
165 How much time a Postfix daemon process may take to handle a
166 request before it is terminated by a built-in watchdog timer.
167 ipc_timeout (3600s)
169 The time limit for sending or receiving information over an
170 internal communication channel.
171 max_idle (100s)
173 The maximum amount of time that an idle Postfix daemon process
174 waits for an incoming connection before terminating voluntarily.
175 max_use (100)
177 The maximal number of incoming connections that a Postfix daemon
178 process will service before terminating voluntarily.
179 process_id (read-only)
181 The process ID of a Postfix command or daemon process.
182 process_name (read-only)
184 The process name of a Postfix command or daemon process.
185 syslog_facility (mail)
187 The syslog facility of Postfix logging.
188 syslog_name (postfix)
190 The mail system name that is prepended to the process name in
191 syslog records, so that "smtpd" becomes, for example, "post‐
192 fix/smtpd".
193
195 smtpd(8), Postfix SMTP server
196 postconf(5), configuration parameters
197 master(5), generic daemon options
198
200 Use "postconf readme_directory" or "postconf html_directory" to locate
201 this information.
202 TUNING_README, performance tuning
203
205 The Secure Mailer license must be distributed with this software.
206
208 The anvil service is available in Postfix 2.2 and later.
209
211 Wietse Venema
212 IBM T.J. Watson Research
213 P.O. Box 704
214 Yorktown Heights, NY 10598, USA
215 ANVIL(8)