]>
Commit | Line | Data |
---|---|---|
e62ceaf0 DM |
1 | [[chapter_pmgconfig]] |
2 | ifdef::manvolnum[] | |
3 | pmgconfig(1) | |
4 | ============ | |
5 | :pmg-toplevel: | |
6 | ||
7 | NAME | |
8 | ---- | |
9 | ||
10 | pmgconfig - Proxmox Mail Gateway Configuration Management Toolkit | |
11 | ||
12 | ||
13 | SYNOPSIS | |
14 | -------- | |
15 | ||
16 | include::pmgconfig.1-synopsis.adoc[] | |
17 | ||
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
22 | ifndef::manvolnum[] | |
66e9c719 DM |
23 | Configuration Management |
24 | ======================== | |
e62ceaf0 DM |
25 | :pmg-toplevel: |
26 | endif::manvolnum[] | |
27 | ||
685576c2 DM |
28 | {pmg} is usually configured using the web-based Graphical User |
29 | Interface (GUI), but it is also possible to directly edit the | |
30 | configuration files, use the REST API over 'https' | |
66e9c719 | 31 | or the command line tool `pmgsh`. |
685576c2 | 32 | |
66e9c719 | 33 | The command line tool `pmgconfig` is used to simplify some common |
685576c2 DM |
34 | configuration tasks, i.e. to generate cerificates and to rewrite |
35 | service configuration files. | |
36 | ||
66e9c719 DM |
37 | NOTE: We use a Postgres database to store mail filter rules and |
38 | statistic data. See chapter xref:chapter_pmgdb[Database Management] | |
39 | for more information. | |
40 | ||
41 | ||
42 | Configuration files overview | |
43 | ---------------------------- | |
44 | ||
45 | `/etc/network/interfaces`:: | |
46 | ||
3f18659b | 47 | Network setup. We never modify this file directly. Instead, we write |
66e9c719 | 48 | changes to `/etc/network/interfaces.new`. When you reboot, we rename |
3f18659b | 49 | the file to `/etc/network/interfaces`, so the changes are applied |
66e9c719 DM |
50 | on the next reboot. |
51 | ||
9bfe27f3 DM |
52 | `/etc/resolv.conf`:: |
53 | ||
fa483193 SI |
54 | DNS search domain and nameserver setup. {pmg} uses the search domain setting |
55 | to create the FQDN and domain name used in the postfix configuration. | |
9bfe27f3 DM |
56 | |
57 | `/etc/hostname`:: | |
58 | ||
fa483193 SI |
59 | The system's host name. {pmg} uses the hostname to create the FQDN used |
60 | in the postfix configuration. | |
9bfe27f3 DM |
61 | |
62 | `/etc/hosts`:: | |
63 | ||
64 | Static table lookup for hostnames. | |
65 | ||
66e9c719 DM |
66 | `/etc/pmg/pmg.conf`:: |
67 | ||
68 | Stores common administration options, i.e. the spam and mail proxy setup. | |
69 | ||
70 | `/etc/pmg/cluster.conf`:: | |
71 | ||
72 | The cluster setup. | |
73 | ||
74 | `/etc/pmg/domains`:: | |
75 | ||
76 | The list of relay domains. | |
77 | ||
5053eecc SI |
78 | `/etc/pmg/dkim/domains`:: |
79 | ||
80 | The list of domains for outbound DKIM signing. | |
81 | ||
66e9c719 DM |
82 | `/etc/pmg/fetchmailrc`:: |
83 | ||
84 | Fetchmail configuration (POP3 and IMAP setup). | |
85 | ||
86 | `/etc/pmg/ldap.conf`:: | |
87 | ||
88 | LDAP configuration. | |
89 | ||
90 | `/etc/pmg/mynetworks`:: | |
91 | ||
92 | List of local (trusted) networks. | |
93 | ||
94 | `/etc/pmg/subscription`:: | |
95 | ||
96 | Stores your subscription key and status. | |
97 | ||
37b2b051 SI |
98 | `/etc/pmg/tls_policy`:: |
99 | ||
100 | TLS policy for outbound connections. | |
101 | ||
66e9c719 DM |
102 | `/etc/pmg/transports`:: |
103 | ||
104 | Message delivery transport setup. | |
105 | ||
106 | `/etc/pmg/user.conf`:: | |
107 | ||
108 | GUI user configuration. | |
109 | ||
797db11d DM |
110 | `/etc/mail/spamassassin/custom.cf`:: |
111 | ||
112 | Custom {spamassassin} setup. | |
113 | ||
8b4756e5 SI |
114 | `/etc/mail/spamassassin/pmg-scores.cf`:: |
115 | ||
116 | Custom {spamassassin} rule scores. | |
66e9c719 DM |
117 | |
118 | Keys and Certificates | |
119 | --------------------- | |
120 | ||
121 | `/etc/pmg/pmg-api.pem`:: | |
122 | ||
123 | Key and certificate (combined) used be the HTTPs server (API). | |
124 | ||
125 | `/etc/pmg/pmg-authkey.key`:: | |
126 | ||
127 | Privat key use to generate authentication tickets. | |
128 | ||
129 | `/etc/pmg/pmg-authkey.pub`:: | |
130 | ||
131 | Public key use to verify authentication tickets. | |
132 | ||
133 | `/etc/pmg/pmg-csrf.key`:: | |
134 | ||
135 | Internally used to generate CSRF tokens. | |
136 | ||
137 | `/etc/pmg/pmg-tls.pem`:: | |
138 | ||
139 | Key and certificate (combined) to encrypt mail traffic (TLS). | |
140 | ||
5053eecc SI |
141 | `/etc/pmg/dkim/<selector>.private`:: |
142 | ||
143 | Key for DKIM signing mails with selector '<selector>'. | |
144 | ||
66e9c719 | 145 | |
69a428d9 | 146 | [[pmgconfig_template_engine]] |
66e9c719 DM |
147 | Service Configuration Templates |
148 | ------------------------------- | |
149 | ||
9c85cc80 DM |
150 | {pmg} uses various services to implement mail filtering, for example |
151 | the {postfix} Mail Transport Agent (MTA), the {clamav} antivirus | |
3f18659b | 152 | engine and the Apache {spamassassin} project. These services use |
9c85cc80 DM |
153 | separate configuration files, so we need to rewrite those files when |
154 | configuration is changed. | |
155 | ||
156 | We use a template based approach to generate those files. The {tts} is | |
157 | a well known, fast and flexible template processing system. You can | |
158 | find the default templates in `/var/lib/pmg/templates/`. Please do not | |
159 | modify them directly, because your modification would get lost on the | |
9dd45bd7 SI |
160 | next update. Instead, copy the template you wish to change to |
161 | `/etc/pmg/templates/`, then apply your changes there. | |
9c85cc80 DM |
162 | |
163 | Templates can access any configuration setting, and you can use the | |
164 | `pmgconfig dump` command to get a list of all variable names: | |
165 | ||
166 | ---- | |
167 | # pmgconfig dump | |
168 | ... | |
169 | dns.domain = yourdomain.tld | |
170 | dns.hostname = pmg | |
171 | ipconfig.int_ip = 192.168.2.127 | |
172 | pmg.admin.advfilter = 1 | |
173 | ... | |
174 | ---- | |
175 | ||
176 | The same tool is used to force regeneration of all template based | |
177 | configuration files. You need to run that after modifying a template, | |
178 | or when you directly edit configuration files | |
179 | ||
180 | ---- | |
181 | # pmgconfig sync --restart 1 | |
182 | ---- | |
183 | ||
9dd45bd7 | 184 | The above command also restarts services if the underlying configuration |
9c85cc80 DM |
185 | files are changed. Please note that this is automatically done when |
186 | you change the configuration using the GUI or API. | |
187 | ||
188 | NOTE: Modified templates from `/etc/pmg/templates/` are automatically | |
189 | synced from the master node to all cluster members. | |
66e9c719 | 190 | |
7e7126d6 ML |
191 | [[pmgconfig_whitelist_overview]] |
192 | White- and Blacklists | |
193 | --------------------- | |
194 | ||
195 | {pmg} has multiple white- and blacklists. It differentiates between the | |
196 | xref:pmgconfig_mailproxy_options[SMTP Whitelist]. The rule-based whitelist | |
197 | and the user whitelist. | |
198 | In addition to the whitelists there are 2 separate blacklists. The rule-based | |
199 | blacklist and the user blacklist. | |
200 | ||
201 | SMTP Whitelist | |
202 | ~~~~~~~~~~~~~~ | |
203 | ||
204 | The xref:pmgconfig_mailproxy_options[SMTP Whitelist] is responsible for disabling | |
205 | greylisting as well as SPF and DNSBL checks. These are done during the SMTP | |
206 | dialogue. | |
207 | ||
208 | Rule-based White-/Blacklist | |
209 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
210 | ||
211 | The xref:chapter_mailfilter[rule-based white- and blacklists] are predefined | |
212 | rules. They work by checking the attached 'Who' objects, containing e.g. a | |
213 | domain or a mail address, for a match. If it matches, the assigned action is | |
214 | used which by default is 'Accept' for the whitelist rule and 'Block' for the | |
215 | blacklist rule. In the default setup the blacklist rule has priority over the | |
216 | whitelist rule and spam checks. | |
217 | ||
218 | User White-/Blacklist | |
219 | ~~~~~~~~~~~~~~~~~~~~~ | |
220 | ||
221 | The user white- and blacklist are user specific. Every user can add mail addresses | |
222 | to their white- and blacklist. When a user adds a mail address to the whitelist, | |
223 | the result of the spam analysis will be discarded for that recipient. This can | |
224 | help the mail being accepted, but it still depends on the other rules what | |
225 | happens next. In the default setup this results in the mail being accepted for | |
226 | this recipient. | |
227 | ||
228 | For mail addresses on a user's blacklist the spam score will be increased by 100. | |
229 | It still depends on the rule system what happens when a spam score that high is | |
230 | encountered. In the default setup it will be recognized as spam and quarantined | |
231 | (spam score of 3 or higher). | |
66e9c719 | 232 | |
4a08dffe | 233 | [[pmgconfig_systemconfig]] |
685576c2 DM |
234 | System Configuration |
235 | -------------------- | |
236 | ||
237 | Network and Time | |
238 | ~~~~~~~~~~~~~~~~ | |
239 | ||
240 | ifndef::manvolnum[] | |
a695a527 | 241 | [thumbnail="pmg-gui-network-config.png", big=1] |
685576c2 DM |
242 | endif::manvolnum[] |
243 | ||
45de5bf5 | 244 | Normally the network and time is already configured when you visit the |
c6e27848 | 245 | GUI. The installer asks for those settings and sets up the correct |
45de5bf5 DM |
246 | values. |
247 | ||
248 | The default setup uses a single Ethernet adapter and static IP | |
249 | assignment. The configuration is stored at '/etc/network/interfaces', | |
250 | and the actual network setup is done the standard Debian way using | |
251 | package 'ifupdown'. | |
252 | ||
253 | .Example network setup '/etc/network/interfaces' | |
254 | ---- | |
255 | source /etc/network/interfaces.d/* | |
256 | ||
257 | auto lo | |
258 | iface lo inet loopback | |
259 | ||
260 | auto ens18 | |
261 | iface ens18 inet static | |
262 | address 192.168.2.127 | |
263 | netmask 255.255.240.0 | |
264 | gateway 192.168.2.1 | |
265 | ---- | |
266 | ||
267 | .DNS recommendations | |
268 | ||
269 | Many tests to detect SPAM mails use DNS queries, so it is important to | |
3f18659b | 270 | have a fast and reliable DNS server. We also query some publicly |
45de5bf5 DM |
271 | available DNS Blacklists. Most of them apply rate limits for clients, |
272 | so they simply will not work if you use a public DNS server (because | |
273 | they are usually blocked). We recommend to use your own DNS server, | |
3f18659b | 274 | which needs to be configured in 'recursive' mode. |
685576c2 DM |
275 | |
276 | ||
277 | Options | |
278 | ~~~~~~~ | |
279 | ||
280 | ifndef::manvolnum[] | |
a695a527 | 281 | [thumbnail="pmg-gui-system-options.png", big=1] |
685576c2 DM |
282 | endif::manvolnum[] |
283 | ||
e09057ab DM |
284 | |
285 | Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`, | |
286 | using the following configuration keys: | |
287 | ||
685576c2 DM |
288 | include::pmg.admin-conf-opts.adoc[] |
289 | ||
c331641e | 290 | |
8c889e95 TL |
291 | include::pmg-ssl-certificate.adoc[] |
292 | ||
c331641e DM |
293 | Mail Proxy Configuration |
294 | ------------------------ | |
295 | ||
4a08dffe | 296 | [[pmgconfig_mailproxy_relaying]] |
c331641e DM |
297 | Relaying |
298 | ~~~~~~~~ | |
299 | ||
c331641e | 300 | ifndef::manvolnum[] |
a695a527 | 301 | [thumbnail="pmg-gui-mailproxy-relaying.png", big=1] |
c331641e DM |
302 | endif::manvolnum[] |
303 | ||
e09057ab DM |
304 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
305 | using the following configuration keys: | |
306 | ||
307 | include::pmg.mail-relaying-conf-opts.adoc[] | |
c331641e | 308 | |
4a08dffe | 309 | [[pmgconfig_mailproxy_relay_domains]] |
c331641e DM |
310 | Relay Domains |
311 | ~~~~~~~~~~~~~ | |
312 | ||
c331641e | 313 | ifndef::manvolnum[] |
a695a527 | 314 | [thumbnail="pmg-gui-mailproxy-relaydomains.png", big=1] |
c331641e DM |
315 | endif::manvolnum[] |
316 | ||
6822b369 DM |
317 | List of relayed mail domains, i.e. what destination domains this |
318 | system will relay mail to. The system will reject incoming mails to | |
319 | other domains. | |
c331641e | 320 | |
d9c56b22 | 321 | |
4a08dffe | 322 | [[pmgconfig_mailproxy_ports]] |
c331641e DM |
323 | Ports |
324 | ~~~~~ | |
325 | ||
c331641e | 326 | ifndef::manvolnum[] |
a695a527 | 327 | [thumbnail="pmg-gui-mailproxy-ports.png", big=1] |
c331641e DM |
328 | endif::manvolnum[] |
329 | ||
d9c56b22 DM |
330 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
331 | using the following configuration keys: | |
332 | ||
333 | include::pmg.mail-ports-conf-opts.adoc[] | |
334 | ||
c331641e | 335 | |
4a08dffe | 336 | [[pmgconfig_mailproxy_options]] |
c331641e DM |
337 | Options |
338 | ~~~~~~~ | |
339 | ||
c331641e | 340 | ifndef::manvolnum[] |
a695a527 | 341 | [thumbnail="pmg-gui-mailproxy-options.png", big=1] |
c331641e DM |
342 | endif::manvolnum[] |
343 | ||
e3d778e0 DM |
344 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
345 | using the following configuration keys: | |
346 | ||
347 | include::pmg.mail-options-conf-opts.adoc[] | |
c331641e DM |
348 | |
349 | ||
89028579 SI |
350 | [[pmgconfig_mailproxy_before_after_queue]] |
351 | Before and After Queue scanning | |
352 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
353 | ||
354 | Scanning email can happen at two different stages of mail-processing: | |
355 | ||
1824eab9 SI |
356 | * Before-queue filtering: During the SMTP Session, after the complete message |
357 | has been received (after the 'DATA' command). | |
89028579 | 358 | |
1824eab9 SI |
359 | * After-queue filtering: After initially accepting the mail and putting it on |
360 | a queue for further processing. | |
89028579 | 361 | |
1824eab9 SI |
362 | Before-queue filtering has the advantage that the system can reject a mail (by |
363 | sending a permanent reject code '554'), and leave the task of notifying the | |
364 | original sender to the other mailserver. This is of particular advantage if | |
365 | the processed mail is a spam message or contains a virus and has a forged | |
89028579 SI |
366 | sender-address. Sending out a notification in this situation leads so-called |
367 | 'backscatter' mail, which might cause your server to get listed as spamming on | |
3f18659b | 368 | RBLs (Real-time Blackhole List). |
89028579 | 369 | |
1824eab9 SI |
370 | After-queue filtering has the advantage of providing faster delivery of |
371 | mails for the sending servers, since queueing mails is much faster than | |
372 | analyzing it for spam and viruses. | |
89028579 SI |
373 | |
374 | If a mail is addressed to multiple recipients (e.g. when multiple addresses are | |
3f18659b | 375 | subscribed to the same mailing list) the situation is more complicated: Your |
89028579 SI |
376 | mailserver can only reject or accept the mail for all recipients, after having |
377 | received the complete message, while your rule setup might accept the mail for | |
378 | part of the recipients and reject it for others. This can be due to a | |
379 | complicated rule setup, or if your users use the 'User White- and Blacklist' | |
380 | feature. | |
381 | ||
382 | If the resulting action of the rule system is the same for all recipients {pmg} | |
383 | responds accordingly if configured for before queue filtering (sending '554' | |
384 | for a blocked mail and '250' for an accepted or quarantined mail). If some | |
3f18659b | 385 | mailboxes accept the mail and some reject it, the system has to accept the mail. |
89028579 SI |
386 | |
387 | Whether {pmg} notifies the sender that delivery failed for some recipients by | |
388 | sending a non-delivery report, depends on the 'ndr_on_block' setting in | |
389 | '/etc/pmg/pmg.conf'. If enabled an NDR is sent. Keeping it disabled prevents | |
390 | NDRs being sent to the (possibly forged) sender and thus minimizes the chance | |
391 | of getting your IP listed on a RBL. However in certain environments it can be | |
392 | unacceptable not to inform the sender about a rejected mail. | |
393 | ||
394 | The setting has the same effect if after queue filtering is configured, with | |
395 | the exception that an NDR is always sent out, even if all recipients block the | |
396 | mail, since the mail already got accepted before being analyzed. | |
397 | ||
398 | The details of integrating the mail proxy with {postfix} in both setups are | |
399 | explained in {postfix_beforequeue} and {postfix_afterqueue} respectively. | |
400 | ||
89028579 | 401 | |
d41aa039 SI |
402 | [[pmgconfig_mailproxy_greylisting]] |
403 | Greylisting | |
404 | ~~~~~~~~~~~ | |
405 | ||
406 | Greylisting is a technique for preventing unwanted messages from reaching the | |
407 | resource intensive stages of content analysis (virus detection and spam | |
408 | detection): By initially replying with a temporary failure code ('450') to | |
409 | each new email, the {pmg} tells the sending server that it should queue the | |
410 | mail and retry delivery at a later moment. Since certain kinds of spam get | |
411 | sent out by software, which has no provisioning for queueing, these mails are | |
412 | dropped without reaching {pmg} or your mailbox. | |
413 | ||
414 | The downside of greylisting is the delay introduced by the initial deferral of | |
415 | the email, which usually amounts to less than 30 minutes. | |
416 | ||
417 | In order to prevent unnecessary delays in delivery from known sources, emails | |
418 | coming from a source for a recipient, which have passed greylisting in the | |
419 | past are directly passed on: For each email the triple '<sender network, | |
420 | sender email, recipient email>' is stored in a list, along with the time when | |
421 | delivery was attempted. If an email fits an already existing triple, the | |
422 | timestamp for that triple is updated and the email is accepted for further | |
423 | processing. | |
424 | ||
425 | As long as a sender and recipient do communicate frequently there is no delay | |
426 | introduced by enabling greylisting. A triple is removed after a longer period | |
427 | of time, when no mail fitting that triple has been seen. The timeouts in {pmg} | |
428 | are: | |
429 | ||
430 | * 2 days for the retry of the first delivery | |
431 | ||
432 | * 36 days for known triples | |
433 | ||
434 | Mails with an empty envelope-sender are always delayed. | |
435 | ||
436 | Some email service providers send out emails for one domain from multiple | |
437 | servers. To prevent delays due to an email coming in from 2 separate IPs of | |
438 | the same provider the triples store a network ('cidr') instead of a single IP. | |
439 | For certain large providers the default network size might be too small. You | |
440 | can configure the netmask applied to an IP for the greylist lookup in | |
441 | '/etc/pmg/pmg.conf' or in the GUI with the settings 'greylistmask' for IPv4 | |
442 | and 'greylistmask6' for IPv6 respectively. | |
443 | ||
444 | ||
4a08dffe | 445 | [[pmgconfig_mailproxy_transports]] |
c331641e DM |
446 | Transports |
447 | ~~~~~~~~~~ | |
448 | ||
449 | ifndef::manvolnum[] | |
a695a527 | 450 | [thumbnail="pmg-gui-mailproxy-transports.png", big=1] |
c331641e DM |
451 | endif::manvolnum[] |
452 | ||
3599cb04 TL |
453 | You can use {pmg} to send emails to different internal email servers. For |
454 | example you can send emails addressed to domain.com to your first email server, | |
455 | and emails addressed to subdomain.domain.com to a second one. | |
b335e06b | 456 | |
31259590 | 457 | You can add the IP addresses, hostname, transport protocol (smtp/lmtp), |
3599cb04 TL |
458 | transport ports and mail domains (or just single email addresses) of your |
459 | additional email servers. When transport protocol is set to `lmtp`, the option | |
460 | 'Use MX' is useless and will be automatically set to 'No'. | |
c331641e DM |
461 | |
462 | ||
4a08dffe | 463 | [[pmgconfig_mailproxy_networks]] |
c331641e DM |
464 | Networks |
465 | ~~~~~~~~ | |
466 | ||
467 | ifndef::manvolnum[] | |
a695a527 | 468 | [thumbnail="pmg-gui-mailproxy-networks.png", big=1] |
c331641e DM |
469 | endif::manvolnum[] |
470 | ||
3599cb04 TL |
471 | You can add additional internal (trusted) IP networks or hosts. All hosts in |
472 | this list are allowed to relay. | |
20e879ad | 473 | |
3599cb04 TL |
474 | NOTE: Hosts in the same subnet with Proxmox can relay by default and it’s not |
475 | needed to add them in this list. | |
c331641e DM |
476 | |
477 | ||
4a08dffe | 478 | [[pmgconfig_mailproxy_tls]] |
c331641e DM |
479 | TLS |
480 | ~~~ | |
481 | ||
482 | ifndef::manvolnum[] | |
a695a527 | 483 | [thumbnail="pmg-gui-mailproxy-tls.png", big=1] |
c331641e DM |
484 | endif::manvolnum[] |
485 | ||
3599cb04 TL |
486 | Transport Layer Security (TLS) provides certificate-based authentication and |
487 | encrypted sessions. An encrypted session protects the information that is | |
488 | transmitted with SMTP mail. When you activate TLS, {pmg} automatically | |
489 | generates a new self signed certificate for you (`/etc/pmg/pmg-tls.pem`). | |
20e879ad | 490 | |
37b2b051 | 491 | {pmg} uses opportunistic TLS encryption by default. The SMTP transaction is |
20e879ad | 492 | encrypted if the 'STARTTLS' ESMTP feature is supported by the remote |
3f18659b | 493 | server. Otherwise, messages are sent in the clear. |
91d501f6 SI |
494 | |
495 | You can set a different TLS policy per destination. A destination is either a | |
496 | remote domain or a next-hop destination as specified in `/etc/pmg/transport`. | |
3f18659b | 497 | This can be used if you need to prevent email delivery without |
91d501f6 SI |
498 | encryption, or to work around a broken 'STARTTLS' ESMTP implementation. See |
499 | {postfix_tls_readme} for details on the supported policies. | |
20e879ad DM |
500 | |
501 | Enable TLS logging:: | |
502 | ||
503 | To get additional information about SMTP TLS activity you can enable | |
504 | TLS logging. That way information about TLS sessions and used | |
3f18659b | 505 | certificates is logged via syslog. |
20e879ad DM |
506 | |
507 | Add TLS received header:: | |
508 | ||
509 | Set this option to include information about the protocol and cipher | |
510 | used as well as the client and issuer CommonName into the "Received:" | |
511 | message header. | |
512 | ||
a649b38f DM |
513 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
514 | using the following configuration keys: | |
515 | ||
516 | include::pmg.mail-tls-conf-opts.adoc[] | |
517 | ||
c331641e | 518 | |
20522d96 SI |
519 | [[pmgconfig_mailproxy_dkim]] |
520 | DKIM Signing | |
521 | ~~~~~~~~~~~~ | |
522 | ||
f5fddbff | 523 | ifndef::manvolnum[] |
a695a527 | 524 | [thumbnail="pmg-gui-mailproxy-dkim.png", big=1] |
f5fddbff SI |
525 | endif::manvolnum[] |
526 | ||
20522d96 SI |
527 | DomainKeys Identified Mail (DKIM) Signatures (see {dkim_rfc}) is a method to |
528 | cryptographically authenticate a mail as originating from a particular domain. | |
529 | Before sending the mail a hash over certain header fields and the body is | |
530 | computed, signed with a private key and added in the `DKIM-Signature` header of | |
531 | the mail. The 'selector' (a short identifier chosen by you, used to identify | |
532 | which system and private key were used for signing) is also included in the | |
533 | `DKIM-Signature` header. | |
534 | ||
535 | The verification is done by the receiver: The public key is fetched | |
536 | via DNS TXT lookup for `yourselector._domainkey.yourdomain.example` and used | |
537 | for verifying the hash. You can publish multiple selectors for your domain, | |
3f18659b | 538 | each used by a system which sends email from your domain, without the need to |
20522d96 SI |
539 | share the private key. |
540 | ||
541 | {pmg} verifies DKIM Signatures for inbound mail in the Spam Filter by default. | |
542 | ||
543 | Additionally it supports conditionally signing outbound mail if configured. | |
544 | It uses one private key and selector per PMG deployment (all nodes in a cluster | |
545 | use the same key). The key has a minimal size of 1024 bits and rsa-sha256 is | |
546 | used as signing algorithm. | |
547 | ||
548 | The headers included in the signature are taken from the list of | |
549 | `Mail::DKIM::Signer`. Additionally `Content-Type` (if present), `From`, `To`, | |
550 | `CC`, `Reply-To` and `Subject` get oversigned. | |
551 | ||
552 | You can either sign all mails received on the internal port using the domain of | |
3f18659b | 553 | the envelope sender address or create a list of domains, for which emails |
20522d96 SI |
554 | should be signed, defaulting to the list of relay domains. |
555 | ||
556 | ||
557 | Enable DKIM Signing:: | |
558 | ||
559 | Controls whether outbound mail should get DKIM signed. | |
560 | ||
561 | Selector:: | |
562 | ||
563 | The selector used for signing the mail. The private key used for signing is | |
3fe91910 | 564 | saved under `/etc/pmg/dkim/yourselector.private`. You can display the DNS TXT |
20522d96 SI |
565 | record which you need to add to all domains signed by {pmg} by clicking on the |
566 | 'View DNS Record' Button. | |
567 | ||
568 | Sign all Outgoing Mail:: | |
569 | ||
570 | Controls whether all outbound mail should get signed or only mails from domains | |
571 | listed in `/etc/pmg/dkim/domains` if it exists and `/etc/pmg/domains` otherwise. | |
572 | ||
573 | Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`, | |
574 | using the following configuration keys: | |
575 | ||
576 | include::pmg.admin-dkim-conf-opts.adoc[] | |
577 | ||
578 | ||
c331641e DM |
579 | Whitelist |
580 | ~~~~~~~~~ | |
581 | ||
582 | ifndef::manvolnum[] | |
a695a527 | 583 | [thumbnail="pmg-gui-mailproxy-whitelist.png", big=1] |
c331641e DM |
584 | endif::manvolnum[] |
585 | ||
3f18659b | 586 | All SMTP checks are disabled for those entries (e.g. Greylisting, |
74ec1f38 ML |
587 | SPF, DNSBL, ...) |
588 | ||
589 | DNSBL checks are done by `postscreen` which works on IP addresses and networks. | |
590 | This means it can only make use of the `IP Address` and `IP Network` entries. | |
6822b369 DM |
591 | |
592 | NOTE: If you use a backup MX server (e.g. your ISP offers this service | |
593 | for you) you should always add those servers here. | |
c331641e | 594 | |
74ec1f38 ML |
595 | NOTE: To disable DNSBL checks entirely, remove any `DNSBL Sites` entries in |
596 | xref:pmgconfig_mailproxy_options[Mail Proxy Options]. | |
c331641e | 597 | |
4a08dffe | 598 | [[pmgconfig_spamdetector]] |
c331641e DM |
599 | Spam Detector Configuration |
600 | --------------------------- | |
601 | ||
2d672352 DM |
602 | Options |
603 | ~~~~~~~ | |
604 | ||
74bfe8ba | 605 | ifndef::manvolnum[] |
a695a527 | 606 | [thumbnail="pmg-gui-spam-options.png", big=1] |
74bfe8ba DM |
607 | endif::manvolnum[] |
608 | ||
3371c521 DM |
609 | {pmg} uses a wide variety of local and network tests to identify spam |
610 | signatures. This makes it harder for spammers to identify one aspect | |
611 | which they can craft their messages to work around the spam filter. | |
612 | ||
3f18659b | 613 | Every single email will be analyzed and gets a spam score |
3371c521 DM |
614 | assigned. The system attempts to optimize the efficiency of the rules |
615 | that are run in terms of minimizing the number of false positives and | |
616 | false negatives. | |
617 | ||
618 | include::pmg.spam-conf-opts.adoc[] | |
619 | ||
620 | ||
4a08dffe | 621 | [[pmgconfig_spamdetector_quarantine]] |
2d672352 DM |
622 | Quarantine |
623 | ~~~~~~~~~~ | |
3371c521 | 624 | |
74bfe8ba | 625 | ifndef::manvolnum[] |
a695a527 | 626 | [thumbnail="pmg-gui-spamquar-options.png", big=1] |
74bfe8ba DM |
627 | endif::manvolnum[] |
628 | ||
3f18659b OB |
629 | {pmg} analyses all incoming email messages and decides for each |
630 | email if it is ham or spam (or virus). Good emails are delivered to | |
631 | the inbox and spam messages are moved into the spam quarantine. | |
3371c521 DM |
632 | |
633 | The system can be configured to send daily reports to inform users | |
3f18659b | 634 | about the personal spam messages received the last day. The report is |
3371c521 DM |
635 | only sent if there are new messages in the quarantine. |
636 | ||
ee34edb0 | 637 | Some options are only available in the config file `/etc/pmg/pmg.conf`, |
3f18659b | 638 | and not in the web interface. |
ee34edb0 | 639 | |
3371c521 | 640 | include::pmg.spamquar-conf-opts.adoc[] |
c331641e DM |
641 | |
642 | ||
36b169e6 SI |
643 | [[pmgconfig_spamdetector_customscores]] |
644 | Customization of Rulescores | |
645 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
646 | ||
f5fddbff | 647 | ifndef::manvolnum[] |
a695a527 | 648 | [thumbnail="pmg-gui-spam-custom-scores.png", big=1] |
f5fddbff SI |
649 | endif::manvolnum[] |
650 | ||
36b169e6 SI |
651 | While the default scoring of {spamassassin}'s ruleset provides very good |
652 | detection rates, sometimes your particular environment can benefit from | |
653 | slightly adjusting the score of a particular rule. Two examples: | |
654 | ||
655 | * Your system receives spam mails which are scored at 4.9 and you have | |
656 | a rule which puts all mails above 5 in the quarantine. The one thing the | |
657 | spam mails have in common is that they all hit 'URIBL_BLACK'. By increasing | |
658 | the score of this rule by 0.2 points the spam mails would all be quarantined | |
659 | instead of being sent to your users | |
660 | ||
661 | * Your system tags many legitimate mails from a partner organization as spam, | |
662 | because the organization has a policy that each mail has to start with | |
663 | 'Dear madam or sir' (generating 1.9 points through the rule | |
664 | 'DEAR_SOMETHING'). By setting the score of this rule to 0 you can disable | |
665 | it completely. | |
666 | ||
3f18659b | 667 | The system logs all the rules which a particular mail hits. Analyzing the logs can |
36b169e6 SI |
668 | lead to finding such a pattern in your environment. |
669 | ||
670 | You can adjust the score of a rule by creating a new 'Custom Rule Score' entry | |
671 | in the GUI. | |
672 | ||
673 | NOTE: In general it is strongly recommended to not make large changes to the | |
674 | default scores. | |
675 | ||
676 | ||
4a08dffe | 677 | [[pmgconfig_clamav]] |
c331641e DM |
678 | Virus Detector Configuration |
679 | ---------------------------- | |
680 | ||
4a08dffe | 681 | [[pmgconfig_clamav_options]] |
2d672352 DM |
682 | Options |
683 | ~~~~~~~ | |
684 | ||
e7c18c7c | 685 | ifndef::manvolnum[] |
a695a527 | 686 | [thumbnail="pmg-gui-virus-options.png", big=1] |
e7c18c7c DM |
687 | endif::manvolnum[] |
688 | ||
0bfbbf88 | 689 | All mails are automatically passed to the included virus detector |
3f18659b | 690 | ({clamav}). The default settings are considered safe, so it is usually |
0bfbbf88 DM |
691 | not required to change them. |
692 | ||
693 | {clamav} related settings are saved to subsection 'clamav' in `/etc/pmg/pmg.conf`, | |
694 | using the following configuration keys: | |
695 | ||
696 | include::pmg.clamav-conf-opts.adoc[] | |
697 | ||
e7c18c7c | 698 | ifndef::manvolnum[] |
a695a527 | 699 | [thumbnail="pmg-gui-clamav-database.png", big=1] |
e7c18c7c DM |
700 | endif::manvolnum[] |
701 | ||
3f18659b OB |
702 | Please note that the virus signature database is automatically |
703 | updated. You can see the database status in the GUI, and also | |
e7c18c7c DM |
704 | trigger manual updates there. |
705 | ||
0bfbbf88 | 706 | |
4a08dffe | 707 | [[pmgconfig_clamav_quarantine]] |
2d672352 DM |
708 | Quarantine |
709 | ~~~~~~~~~~ | |
0bfbbf88 | 710 | |
e7c18c7c | 711 | ifndef::manvolnum[] |
a695a527 | 712 | [thumbnail="pmg-gui-virusquar-options.png", big=1] |
e7c18c7c DM |
713 | endif::manvolnum[] |
714 | ||
0bfbbf88 | 715 | Indentified virus mails are automatically moved to the virus |
3f18659b OB |
716 | quarantine. The administrator can view these mails using the GUI, and |
717 | choose to deliver them in case of false positives. {pmg} does not notify | |
0bfbbf88 DM |
718 | individual users about received virus mails. |
719 | ||
720 | Virus quarantine related settings are saved to subsection 'virusquar' | |
721 | in `/etc/pmg/pmg.conf`, using the following configuration keys: | |
722 | ||
723 | include::pmg.virusquar-conf-opts.adoc[] | |
c331641e DM |
724 | |
725 | ||
7eff8815 DM |
726 | Custom SpamAssassin configuration |
727 | --------------------------------- | |
728 | ||
833e1edc SI |
729 | This is only for advanced users. {spamassassin}'s rules and their associated |
730 | scores get updated regularly and are trained on a huge corpus, which gets | |
731 | classified by experts. In most cases adding a rule for matching a particular | |
732 | keyword is the wrong approach, leading to many false positives. Usually bad | |
733 | detection rates are better addressed by properly setting up DNS than by adding | |
734 | a custom rule - watch out for matches to 'URIBL_BLOCKED' in the logs or | |
735 | spam-headers - see the {spamassassin_dnsbl}. | |
736 | ||
737 | To add or change the Proxmox {spamassassin} configuration please login to the | |
d2f49775 TL |
738 | console via SSH. Change to the `/etc/mail/spamassassin/` directory. In this |
739 | directory there are several files (`init.pre`, `local.cf`, ...) - do not change | |
69a428d9 SI |
740 | them, as `init.pre`, `v310.pre`, `v320.pre`, `local.cf` will be overwritten by |
741 | the xref:pmgconfig_template_engine[template engine], while the others can | |
742 | get updated by any {spamassassin} package upgrade. | |
833e1edc | 743 | |
3f18659b | 744 | To add your custom configuration, you have to create a new file and name it |
d2f49775 | 745 | `custom.cf` (in this directory), then add your configuration there. Make sure |
3f18659b | 746 | to use the correct {spamassassin} syntax, and test it with: |
7eff8815 DM |
747 | |
748 | ---- | |
749 | # spamassassin -D --lint | |
750 | ---- | |
751 | ||
752 | If you run a cluster, the `custom.cf` file is synchronized from the | |
d2f49775 | 753 | master node to all cluster members automatically. |
7eff8815 | 754 | |
3f18659b | 755 | To adjust the score assigned to a particular rule you |
36b169e6 SI |
756 | can also use the xref:pmgconfig_spamdetector_customscores[Custom Rule Score] |
757 | settings in the GUI. | |
758 | ||
7eff8815 | 759 | |
ed7970d8 SI |
760 | [[pmgconfig_custom_check]] |
761 | Custom Check Interface | |
762 | ---------------------- | |
763 | ||
3f18659b | 764 | For use-cases which are not handled by the {pmg} Virus Detector and |
ed7970d8 SI |
765 | {spamassassin} configuration, advanced users can create a custom check |
766 | executable which, if enabled will be called before the Virus Detector and before | |
3f18659b | 767 | passing an email through the Rule System. The custom check API is kept as |
ed7970d8 | 768 | simple as possible, while still providing a great deal of control over the |
3f18659b | 769 | treatment of an email. Its input is passed via two CLI arguments: |
ed7970d8 SI |
770 | |
771 | * the 'api-version' (currently `v1`) - for potential future change of the | |
772 | invocation | |
773 | ||
3f18659b | 774 | * the 'queue-file-name' - a filename, which contains the complete email as |
ed7970d8 SI |
775 | rfc822/eml file |
776 | ||
777 | The expected output need to be printed on STDOUT and consists of two lines: | |
778 | ||
779 | * the 'api-version' (currently 'v1') - see above | |
780 | ||
781 | * one of the following 3 results: | |
3f18659b OB |
782 | ** 'OK' - email is ok |
783 | ** 'VIRUS: <virusdescription>' - email is treated as if it contained a virus | |
784 | (the virus description is logged and added to the email's headers) | |
ed7970d8 | 785 | ** 'SCORE: <number>' - <number> is added (negative numbers are also possible) |
3f18659b | 786 | to the email's spamscore |
ed7970d8 SI |
787 | |
788 | The check is run with a 5 minute timeout - if it is exceeded the check | |
3f18659b | 789 | executable is killed and the email is treated as OK. |
ed7970d8 SI |
790 | |
791 | All output written to STDERR by the check is written with priority 'err' to the | |
792 | journal/mail.log. | |
793 | ||
794 | A simple sample script following the API (and yielding a random result) for | |
795 | reference: | |
796 | ||
797 | ---- | |
798 | #!/bin/sh | |
799 | ||
800 | echo "called with $*" 1>&2 | |
801 | ||
802 | if [ "$#" -ne 2 ]; then | |
803 | echo "usage: $0 APIVERSION QUEUEFILENAME" 1>&2 | |
804 | exit 1 | |
805 | fi | |
806 | ||
807 | apiver="$1" | |
808 | shift | |
809 | ||
810 | if [ "$apiver" != "v1" ]; then | |
811 | echo "wrong APIVERSION: $apiver" 1>&2 | |
812 | exit 2 | |
813 | fi | |
814 | ||
815 | queue_file="$1" | |
816 | ||
817 | echo "v1" | |
818 | ||
819 | choice=$(shuf -i 0-3 -n1) | |
820 | ||
821 | case "$choice" in | |
822 | 0) | |
823 | echo OK | |
824 | ;; | |
825 | 1) | |
826 | echo SCORE: 4 | |
827 | ;; | |
828 | 2) | |
829 | echo VIRUS: Random Virus | |
830 | ;; | |
831 | 3) #timeout-test | |
832 | for i in $(seq 1 7); do | |
833 | echo "custom checking mail: $queue_file - minute $i" 1>&2 | |
834 | sleep 60 | |
835 | done | |
836 | ;; | |
837 | esac | |
838 | ||
839 | exit 0 | |
840 | ---- | |
841 | ||
842 | The custom check needs to be enabled in the admin section of `/etc/pmg/pmg.conf` | |
843 | ||
844 | ---- | |
845 | section: admin | |
846 | custom_check 1 | |
847 | ---- | |
848 | ||
849 | The location of the custom check executable can also be set there with the key | |
850 | `custom_check_path` and defaults to `/usr/local/bin/pmg-custom-check`. | |
851 | ||
852 | ||
c331641e DM |
853 | User Management |
854 | --------------- | |
855 | ||
05336835 DC |
856 | User management in {pmg} consists of three types of users/accounts: |
857 | ||
858 | ||
4a08dffe | 859 | [[pmgconfig_localuser]] |
05336835 DC |
860 | Local Users |
861 | ~~~~~~~~~~~ | |
862 | ||
a695a527 | 863 | [thumbnail="pmg-gui-local-user-config.png", big=1] |
f02d2b90 | 864 | |
4885bff7 TL |
865 | Local users can manage and audit {pmg}. They can login on the management web |
866 | interface. | |
05336835 | 867 | |
a8ac4ab3 | 868 | There are four roles: |
05336835 | 869 | |
4885bff7 TL |
870 | Administrator:: |
871 | ||
872 | Is allowed to manage settings of {pmg}, except some tasks like network | |
873 | configuration and upgrading. | |
874 | ||
875 | Quarantine manager:: | |
05336835 | 876 | |
05336835 DC |
877 | Is allowed to manage quarantines, blacklists and whitelists, but not other |
878 | settings. Has no right to view any other data. | |
879 | ||
4885bff7 TL |
880 | Auditor:: |
881 | ||
05336835 DC |
882 | With this role, the user is only allowed to view data and configuration, but |
883 | not to edit it. | |
884 | ||
a8ac4ab3 TL |
885 | Helpdesk:: |
886 | ||
887 | Combines permissions of the 'Auditor' and the 'Quarantine Manager' role. | |
888 | ||
05336835 | 889 | In addition there is always the 'root' user, which is used to perform special |
4885bff7 TL |
890 | system administrator tasks, such as upgrading a host or changing the network |
891 | configuration. | |
05336835 DC |
892 | |
893 | NOTE: Only pam users are able to login via the webconsole and ssh, which the | |
4885bff7 TL |
894 | users created with the web interface are not. Those users are created for {pmg} |
895 | administration only. | |
05336835 DC |
896 | |
897 | Local user related settings are saved in `/etc/pmg/user.conf`. | |
898 | ||
899 | For details of the fields see xref:pmg_user_configuration_file[user.conf] | |
900 | ||
4a08dffe | 901 | [[pmgconfig_ldap]] |
05336835 DC |
902 | LDAP/Active Directory |
903 | ~~~~~~~~~~~~~~~~~~~~~ | |
904 | ||
a695a527 | 905 | [thumbnail="pmg-gui-ldap-user-config.png", big=1] |
f02d2b90 | 906 | |
05336835 DC |
907 | You can specify multiple LDAP/Active Directory profiles, so that you can |
908 | create rules matching those users and groups. | |
909 | ||
910 | Creating a profile requires (at least) the following: | |
911 | ||
912 | * profile name | |
913 | * protocol (LDAP or LDAPS; LDAPS is recommended) | |
914 | * at least one server | |
915 | * a user and password (if your server does not support anonymous binds) | |
916 | ||
917 | All other fields should work with the defaults for most setups, but can be | |
918 | used to customize the queries. | |
919 | ||
920 | The settings are saved to `/etc/pmg/ldap.conf`. Details for the options | |
921 | can be found here: xref:pmg_ldap_configuration_file[ldap.conf] | |
922 | ||
923 | Bind user | |
924 | ^^^^^^^^^ | |
925 | ||
926 | It is highly recommended that the user which you use for connecting to the | |
927 | LDAP server only has the permission to query the server. For LDAP servers | |
928 | (for example OpenLDAP or FreeIPA), the username has to be of a format like | |
929 | 'uid=username,cn=users,cn=accounts,dc=domain' , where the specific fields are | |
930 | depending on your setup. For Active Directory servers, the format should be | |
931 | like 'username@domain' or 'domain\username'. | |
932 | ||
933 | Sync | |
934 | ^^^^ | |
935 | ||
936 | {pmg} synchronizes the relevant user and group info periodically, so that | |
3f18659b | 937 | the information is available in a fast manner, even when the LDAP/AD server |
05336835 DC |
938 | is temporarily not accessible. |
939 | ||
3f18659b | 940 | After a successful sync, the groups and users should be visible on the web |
05336835 | 941 | interface. After that, you can create rules targeting LDAP users and groups. |
c331641e DM |
942 | |
943 | ||
4a08dffe | 944 | [[pmgconfig_fetchmail]] |
8538d9a2 | 945 | Fetchmail |
05336835 DC |
946 | ~~~~~~~~~ |
947 | ||
a695a527 | 948 | [thumbnail="pmg-gui-fetchmail-config.png", big=1] |
f02d2b90 | 949 | |
3f18659b OB |
950 | Fetchmail is utility for polling and forwarding emails. You can define |
951 | email accounts, which will then be fetched and forwarded to the email | |
05336835 DC |
952 | address you defined. |
953 | ||
954 | You have to add an entry for each account/target combination you want to | |
955 | fetch and forward. Those will then be regularly polled and forwarded, | |
956 | according to your configuration. | |
957 | ||
958 | The API and web interface offer following configuration options: | |
8538d9a2 DM |
959 | |
960 | include::fetchmail.conf.5-opts.adoc[] | |
961 | ||
962 | ||
e62ceaf0 DM |
963 | ifdef::manvolnum[] |
964 | include::pmg-copyright.adoc[] | |
965 | endif::manvolnum[] | |
966 |