]>
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 | ||
47 | Network setup. We never modify this files directly. Instead, we write | |
48 | changes to `/etc/network/interfaces.new`. When you reboot, we rename | |
49 | the file to `/etc/network/interfaces`, so any changes gets activated | |
50 | on the next reboot. | |
51 | ||
9bfe27f3 DM |
52 | `/etc/resolv.conf`:: |
53 | ||
54 | DNS search domain and nameserver setup. | |
55 | ||
56 | `/etc/hostname`:: | |
57 | ||
58 | The system's host name. | |
59 | ||
60 | `/etc/hosts`:: | |
61 | ||
62 | Static table lookup for hostnames. | |
63 | ||
66e9c719 DM |
64 | `/etc/pmg/pmg.conf`:: |
65 | ||
66 | Stores common administration options, i.e. the spam and mail proxy setup. | |
67 | ||
68 | `/etc/pmg/cluster.conf`:: | |
69 | ||
70 | The cluster setup. | |
71 | ||
72 | `/etc/pmg/domains`:: | |
73 | ||
74 | The list of relay domains. | |
75 | ||
76 | `/etc/pmg/fetchmailrc`:: | |
77 | ||
78 | Fetchmail configuration (POP3 and IMAP setup). | |
79 | ||
80 | `/etc/pmg/ldap.conf`:: | |
81 | ||
82 | LDAP configuration. | |
83 | ||
84 | `/etc/pmg/mynetworks`:: | |
85 | ||
86 | List of local (trusted) networks. | |
87 | ||
88 | `/etc/pmg/subscription`:: | |
89 | ||
90 | Stores your subscription key and status. | |
91 | ||
37b2b051 SI |
92 | `/etc/pmg/tls_policy`:: |
93 | ||
94 | TLS policy for outbound connections. | |
95 | ||
66e9c719 DM |
96 | `/etc/pmg/transports`:: |
97 | ||
98 | Message delivery transport setup. | |
99 | ||
100 | `/etc/pmg/user.conf`:: | |
101 | ||
102 | GUI user configuration. | |
103 | ||
797db11d DM |
104 | `/etc/mail/spamassassin/custom.cf`:: |
105 | ||
106 | Custom {spamassassin} setup. | |
107 | ||
66e9c719 DM |
108 | |
109 | Keys and Certificates | |
110 | --------------------- | |
111 | ||
112 | `/etc/pmg/pmg-api.pem`:: | |
113 | ||
114 | Key and certificate (combined) used be the HTTPs server (API). | |
115 | ||
116 | `/etc/pmg/pmg-authkey.key`:: | |
117 | ||
118 | Privat key use to generate authentication tickets. | |
119 | ||
120 | `/etc/pmg/pmg-authkey.pub`:: | |
121 | ||
122 | Public key use to verify authentication tickets. | |
123 | ||
124 | `/etc/pmg/pmg-csrf.key`:: | |
125 | ||
126 | Internally used to generate CSRF tokens. | |
127 | ||
128 | `/etc/pmg/pmg-tls.pem`:: | |
129 | ||
130 | Key and certificate (combined) to encrypt mail traffic (TLS). | |
131 | ||
132 | ||
133 | Service Configuration Templates | |
134 | ------------------------------- | |
135 | ||
9c85cc80 DM |
136 | {pmg} uses various services to implement mail filtering, for example |
137 | the {postfix} Mail Transport Agent (MTA), the {clamav} antivirus | |
138 | engine and the Apache {spamassassin} project. Those services use | |
139 | separate configuration files, so we need to rewrite those files when | |
140 | configuration is changed. | |
141 | ||
142 | We use a template based approach to generate those files. The {tts} is | |
143 | a well known, fast and flexible template processing system. You can | |
144 | find the default templates in `/var/lib/pmg/templates/`. Please do not | |
145 | modify them directly, because your modification would get lost on the | |
9dd45bd7 SI |
146 | next update. Instead, copy the template you wish to change to |
147 | `/etc/pmg/templates/`, then apply your changes there. | |
9c85cc80 DM |
148 | |
149 | Templates can access any configuration setting, and you can use the | |
150 | `pmgconfig dump` command to get a list of all variable names: | |
151 | ||
152 | ---- | |
153 | # pmgconfig dump | |
154 | ... | |
155 | dns.domain = yourdomain.tld | |
156 | dns.hostname = pmg | |
157 | ipconfig.int_ip = 192.168.2.127 | |
158 | pmg.admin.advfilter = 1 | |
159 | ... | |
160 | ---- | |
161 | ||
162 | The same tool is used to force regeneration of all template based | |
163 | configuration files. You need to run that after modifying a template, | |
164 | or when you directly edit configuration files | |
165 | ||
166 | ---- | |
167 | # pmgconfig sync --restart 1 | |
168 | ---- | |
169 | ||
9dd45bd7 | 170 | The above command also restarts services if the underlying configuration |
9c85cc80 DM |
171 | files are changed. Please note that this is automatically done when |
172 | you change the configuration using the GUI or API. | |
173 | ||
174 | NOTE: Modified templates from `/etc/pmg/templates/` are automatically | |
175 | synced from the master node to all cluster members. | |
66e9c719 DM |
176 | |
177 | ||
4a08dffe | 178 | [[pmgconfig_systemconfig]] |
685576c2 DM |
179 | System Configuration |
180 | -------------------- | |
181 | ||
182 | Network and Time | |
183 | ~~~~~~~~~~~~~~~~ | |
184 | ||
185 | ifndef::manvolnum[] | |
186 | image::images/screenshot/pmg-gui-network-config.png[] | |
187 | endif::manvolnum[] | |
188 | ||
45de5bf5 | 189 | Normally the network and time is already configured when you visit the |
c6e27848 | 190 | GUI. The installer asks for those settings and sets up the correct |
45de5bf5 DM |
191 | values. |
192 | ||
193 | The default setup uses a single Ethernet adapter and static IP | |
194 | assignment. The configuration is stored at '/etc/network/interfaces', | |
195 | and the actual network setup is done the standard Debian way using | |
196 | package 'ifupdown'. | |
197 | ||
198 | .Example network setup '/etc/network/interfaces' | |
199 | ---- | |
200 | source /etc/network/interfaces.d/* | |
201 | ||
202 | auto lo | |
203 | iface lo inet loopback | |
204 | ||
205 | auto ens18 | |
206 | iface ens18 inet static | |
207 | address 192.168.2.127 | |
208 | netmask 255.255.240.0 | |
209 | gateway 192.168.2.1 | |
210 | ---- | |
211 | ||
212 | .DNS recommendations | |
213 | ||
214 | Many tests to detect SPAM mails use DNS queries, so it is important to | |
215 | have a fast and reliable DNS server. We also query some public | |
216 | available DNS Blacklists. Most of them apply rate limits for clients, | |
217 | so they simply will not work if you use a public DNS server (because | |
218 | they are usually blocked). We recommend to use your own DNS server, | |
219 | which need to be configured in 'recursive' mode. | |
685576c2 DM |
220 | |
221 | ||
222 | Options | |
223 | ~~~~~~~ | |
224 | ||
225 | ifndef::manvolnum[] | |
226 | image::images/screenshot/pmg-gui-system-options.png[] | |
227 | endif::manvolnum[] | |
228 | ||
e09057ab DM |
229 | |
230 | Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`, | |
231 | using the following configuration keys: | |
232 | ||
685576c2 DM |
233 | include::pmg.admin-conf-opts.adoc[] |
234 | ||
c331641e DM |
235 | |
236 | Mail Proxy Configuration | |
237 | ------------------------ | |
238 | ||
4a08dffe | 239 | [[pmgconfig_mailproxy_relaying]] |
c331641e DM |
240 | Relaying |
241 | ~~~~~~~~ | |
242 | ||
c331641e DM |
243 | ifndef::manvolnum[] |
244 | image::images/screenshot/pmg-gui-mailproxy-relaying.png[] | |
245 | endif::manvolnum[] | |
246 | ||
e09057ab DM |
247 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
248 | using the following configuration keys: | |
249 | ||
250 | include::pmg.mail-relaying-conf-opts.adoc[] | |
c331641e | 251 | |
4a08dffe | 252 | [[pmgconfig_mailproxy_relay_domains]] |
c331641e DM |
253 | Relay Domains |
254 | ~~~~~~~~~~~~~ | |
255 | ||
c331641e DM |
256 | ifndef::manvolnum[] |
257 | image::images/screenshot/pmg-gui-mailproxy-relaydomains.png[] | |
258 | endif::manvolnum[] | |
259 | ||
6822b369 DM |
260 | List of relayed mail domains, i.e. what destination domains this |
261 | system will relay mail to. The system will reject incoming mails to | |
262 | other domains. | |
c331641e | 263 | |
d9c56b22 | 264 | |
4a08dffe | 265 | [[pmgconfig_mailproxy_ports]] |
c331641e DM |
266 | Ports |
267 | ~~~~~ | |
268 | ||
c331641e DM |
269 | ifndef::manvolnum[] |
270 | image::images/screenshot/pmg-gui-mailproxy-ports.png[] | |
271 | endif::manvolnum[] | |
272 | ||
d9c56b22 DM |
273 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
274 | using the following configuration keys: | |
275 | ||
276 | include::pmg.mail-ports-conf-opts.adoc[] | |
277 | ||
c331641e | 278 | |
4a08dffe | 279 | [[pmgconfig_mailproxy_options]] |
c331641e DM |
280 | Options |
281 | ~~~~~~~ | |
282 | ||
c331641e DM |
283 | ifndef::manvolnum[] |
284 | image::images/screenshot/pmg-gui-mailproxy-options.png[] | |
285 | endif::manvolnum[] | |
286 | ||
e3d778e0 DM |
287 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
288 | using the following configuration keys: | |
289 | ||
290 | include::pmg.mail-options-conf-opts.adoc[] | |
c331641e DM |
291 | |
292 | ||
4a08dffe | 293 | [[pmgconfig_mailproxy_transports]] |
c331641e DM |
294 | Transports |
295 | ~~~~~~~~~~ | |
296 | ||
297 | ifndef::manvolnum[] | |
298 | image::images/screenshot/pmg-gui-mailproxy-transports.png[] | |
299 | endif::manvolnum[] | |
300 | ||
b335e06b DM |
301 | You can use {pmg} to send e-mails to different internal |
302 | e-mail servers. For example you can send e-mails addressed to | |
303 | domain.com to your first e-mail server, and e-mails addressed to | |
304 | subdomain.domain.com to a second one. | |
305 | ||
306 | You can add the IP addresses, hostname and SMTP ports and mail domains (or | |
307 | just single email addresses) of your additional e-mail servers. | |
c331641e DM |
308 | |
309 | ||
4a08dffe | 310 | [[pmgconfig_mailproxy_networks]] |
c331641e DM |
311 | Networks |
312 | ~~~~~~~~ | |
313 | ||
314 | ifndef::manvolnum[] | |
315 | image::images/screenshot/pmg-gui-mailproxy-networks.png[] | |
316 | endif::manvolnum[] | |
317 | ||
20e879ad DM |
318 | You can add additional internal (trusted) IP networks or hosts. |
319 | All hosts in this list are allowed to relay. | |
320 | ||
321 | NOTE: Hosts in the same subnet with Proxmox can relay by default and | |
322 | it’s not needed to add them in this list. | |
c331641e DM |
323 | |
324 | ||
4a08dffe | 325 | [[pmgconfig_mailproxy_tls]] |
c331641e DM |
326 | TLS |
327 | ~~~ | |
328 | ||
329 | ifndef::manvolnum[] | |
330 | image::images/screenshot/pmg-gui-mailproxy-tls.png[] | |
331 | endif::manvolnum[] | |
332 | ||
20e879ad DM |
333 | Transport Layer Security (TLS) provides certificate-based |
334 | authentication and encrypted sessions. An encrypted session protects | |
335 | the information that is transmitted with SMTP mail. When you activate | |
336 | TLS, {pmg} automatically generates a new self signed | |
337 | certificate for you (`/etc/pmg/pmg-tls.pem`). | |
338 | ||
37b2b051 | 339 | {pmg} uses opportunistic TLS encryption by default. The SMTP transaction is |
20e879ad | 340 | encrypted if the 'STARTTLS' ESMTP feature is supported by the remote |
37b2b051 SI |
341 | server. Otherwise, messages are sent in the clear. |
342 | You can set a different TLS policy per desitination domain, should you for | |
343 | example need to prevent e-mail delivery without encryption, or to work around | |
344 | a broken 'STARTTLS' ESMTP implementation. See {postfix_tls_readme} for details | |
345 | on the supported policies. | |
20e879ad DM |
346 | |
347 | Enable TLS logging:: | |
348 | ||
349 | To get additional information about SMTP TLS activity you can enable | |
350 | TLS logging. That way information about TLS sessions and used | |
351 | certificate’s is logged via syslog. | |
352 | ||
353 | Add TLS received header:: | |
354 | ||
355 | Set this option to include information about the protocol and cipher | |
356 | used as well as the client and issuer CommonName into the "Received:" | |
357 | message header. | |
358 | ||
a649b38f DM |
359 | Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`, |
360 | using the following configuration keys: | |
361 | ||
362 | include::pmg.mail-tls-conf-opts.adoc[] | |
363 | ||
c331641e | 364 | |
20522d96 SI |
365 | [[pmgconfig_mailproxy_dkim]] |
366 | DKIM Signing | |
367 | ~~~~~~~~~~~~ | |
368 | ||
369 | DomainKeys Identified Mail (DKIM) Signatures (see {dkim_rfc}) is a method to | |
370 | cryptographically authenticate a mail as originating from a particular domain. | |
371 | Before sending the mail a hash over certain header fields and the body is | |
372 | computed, signed with a private key and added in the `DKIM-Signature` header of | |
373 | the mail. The 'selector' (a short identifier chosen by you, used to identify | |
374 | which system and private key were used for signing) is also included in the | |
375 | `DKIM-Signature` header. | |
376 | ||
377 | The verification is done by the receiver: The public key is fetched | |
378 | via DNS TXT lookup for `yourselector._domainkey.yourdomain.example` and used | |
379 | for verifying the hash. You can publish multiple selectors for your domain, | |
380 | each use by a system which sends e-mail from your domain, without the need to | |
381 | share the private key. | |
382 | ||
383 | {pmg} verifies DKIM Signatures for inbound mail in the Spam Filter by default. | |
384 | ||
385 | Additionally it supports conditionally signing outbound mail if configured. | |
386 | It uses one private key and selector per PMG deployment (all nodes in a cluster | |
387 | use the same key). The key has a minimal size of 1024 bits and rsa-sha256 is | |
388 | used as signing algorithm. | |
389 | ||
390 | The headers included in the signature are taken from the list of | |
391 | `Mail::DKIM::Signer`. Additionally `Content-Type` (if present), `From`, `To`, | |
392 | `CC`, `Reply-To` and `Subject` get oversigned. | |
393 | ||
394 | You can either sign all mails received on the internal port using the domain of | |
395 | the envelope sender address or create a list of domains, for which e-mails | |
396 | should be signed, defaulting to the list of relay domains. | |
397 | ||
398 | ||
399 | Enable DKIM Signing:: | |
400 | ||
401 | Controls whether outbound mail should get DKIM signed. | |
402 | ||
403 | Selector:: | |
404 | ||
405 | The selector used for signing the mail. The private key used for signing is | |
3fe91910 | 406 | saved under `/etc/pmg/dkim/yourselector.private`. You can display the DNS TXT |
20522d96 SI |
407 | record which you need to add to all domains signed by {pmg} by clicking on the |
408 | 'View DNS Record' Button. | |
409 | ||
410 | Sign all Outgoing Mail:: | |
411 | ||
412 | Controls whether all outbound mail should get signed or only mails from domains | |
413 | listed in `/etc/pmg/dkim/domains` if it exists and `/etc/pmg/domains` otherwise. | |
414 | ||
415 | Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`, | |
416 | using the following configuration keys: | |
417 | ||
418 | include::pmg.admin-dkim-conf-opts.adoc[] | |
419 | ||
420 | ||
c331641e DM |
421 | Whitelist |
422 | ~~~~~~~~~ | |
423 | ||
424 | ifndef::manvolnum[] | |
425 | image::images/screenshot/pmg-gui-mailproxy-whitelist.png[] | |
426 | endif::manvolnum[] | |
427 | ||
6822b369 DM |
428 | All SMTP checks are disabled for those entries (e. g. Greylisting, |
429 | SPF, RBL, ...) | |
430 | ||
431 | NOTE: If you use a backup MX server (e.g. your ISP offers this service | |
432 | for you) you should always add those servers here. | |
c331641e DM |
433 | |
434 | ||
4a08dffe | 435 | [[pmgconfig_spamdetector]] |
c331641e DM |
436 | Spam Detector Configuration |
437 | --------------------------- | |
438 | ||
2d672352 DM |
439 | Options |
440 | ~~~~~~~ | |
441 | ||
74bfe8ba DM |
442 | ifndef::manvolnum[] |
443 | image::images/screenshot/pmg-gui-spam-options.png[] | |
444 | endif::manvolnum[] | |
445 | ||
3371c521 DM |
446 | {pmg} uses a wide variety of local and network tests to identify spam |
447 | signatures. This makes it harder for spammers to identify one aspect | |
448 | which they can craft their messages to work around the spam filter. | |
449 | ||
450 | Every single e-mail will be analyzed and gets a spam score | |
451 | assigned. The system attempts to optimize the efficiency of the rules | |
452 | that are run in terms of minimizing the number of false positives and | |
453 | false negatives. | |
454 | ||
455 | include::pmg.spam-conf-opts.adoc[] | |
456 | ||
457 | ||
4a08dffe | 458 | [[pmgconfig_spamdetector_quarantine]] |
2d672352 DM |
459 | Quarantine |
460 | ~~~~~~~~~~ | |
3371c521 | 461 | |
74bfe8ba DM |
462 | ifndef::manvolnum[] |
463 | image::images/screenshot/pmg-gui-spamquar-options.png[] | |
464 | endif::manvolnum[] | |
465 | ||
3371c521 DM |
466 | Proxmox analyses all incoming e-mail messages and decides for each |
467 | e-mail if its ham or spam (or virus). Good e-mails are delivered to | |
468 | the inbox and spam messages can be moved into the spam quarantine. | |
469 | ||
470 | The system can be configured to send daily reports to inform users | |
471 | about the personal spam messages received the last day. That report is | |
472 | only sent if there are new messages in the quarantine. | |
473 | ||
ee34edb0 DC |
474 | Some options are only available in the config file `/etc/pmg/pmg.conf`, |
475 | and not in the webinterface. | |
476 | ||
3371c521 | 477 | include::pmg.spamquar-conf-opts.adoc[] |
c331641e DM |
478 | |
479 | ||
4a08dffe | 480 | [[pmgconfig_clamav]] |
c331641e DM |
481 | Virus Detector Configuration |
482 | ---------------------------- | |
483 | ||
4a08dffe | 484 | [[pmgconfig_clamav_options]] |
2d672352 DM |
485 | Options |
486 | ~~~~~~~ | |
487 | ||
e7c18c7c DM |
488 | ifndef::manvolnum[] |
489 | image::images/screenshot/pmg-gui-virus-options.png[] | |
490 | endif::manvolnum[] | |
491 | ||
0bfbbf88 DM |
492 | All mails are automatically passed to the included virus detector |
493 | ({clamav}). The default setting are considered safe, so it is usually | |
494 | not required to change them. | |
495 | ||
496 | {clamav} related settings are saved to subsection 'clamav' in `/etc/pmg/pmg.conf`, | |
497 | using the following configuration keys: | |
498 | ||
499 | include::pmg.clamav-conf-opts.adoc[] | |
500 | ||
e7c18c7c DM |
501 | ifndef::manvolnum[] |
502 | image::images/screenshot/pmg-gui-clamav-database.png[] | |
503 | endif::manvolnum[] | |
504 | ||
505 | Please note that the virus signature database it automatically | |
506 | updated. But you can see the database status on the GUI, and you can | |
507 | trigger manual updates there. | |
508 | ||
0bfbbf88 | 509 | |
4a08dffe | 510 | [[pmgconfig_clamav_quarantine]] |
2d672352 DM |
511 | Quarantine |
512 | ~~~~~~~~~~ | |
0bfbbf88 | 513 | |
e7c18c7c DM |
514 | ifndef::manvolnum[] |
515 | image::images/screenshot/pmg-gui-virusquar-options.png[] | |
516 | endif::manvolnum[] | |
517 | ||
0bfbbf88 DM |
518 | Indentified virus mails are automatically moved to the virus |
519 | quarantine. The administartor can view those mails using the GUI, or | |
520 | deliver them in case of false positives. {pmg} does not notify | |
521 | individual users about received virus mails. | |
522 | ||
523 | Virus quarantine related settings are saved to subsection 'virusquar' | |
524 | in `/etc/pmg/pmg.conf`, using the following configuration keys: | |
525 | ||
526 | include::pmg.virusquar-conf-opts.adoc[] | |
c331641e DM |
527 | |
528 | ||
7eff8815 DM |
529 | Custom SpamAssassin configuration |
530 | --------------------------------- | |
531 | ||
833e1edc SI |
532 | This is only for advanced users. {spamassassin}'s rules and their associated |
533 | scores get updated regularly and are trained on a huge corpus, which gets | |
534 | classified by experts. In most cases adding a rule for matching a particular | |
535 | keyword is the wrong approach, leading to many false positives. Usually bad | |
536 | detection rates are better addressed by properly setting up DNS than by adding | |
537 | a custom rule - watch out for matches to 'URIBL_BLOCKED' in the logs or | |
538 | spam-headers - see the {spamassassin_dnsbl}. | |
539 | ||
540 | To add or change the Proxmox {spamassassin} configuration please login to the | |
541 | console via SSH. Go to directory `/etc/mail/spamassassin/`. In this directory | |
542 | there are several files (`init.pre`, `local.cf`, ...) – do not change them. | |
543 | ||
544 | To add your special configuration, you have to create a new file and name it | |
545 | `custom.cf` (in this directory), then add your configuration there. Be aware to | |
546 | use the {spamassassin} syntax, and test with | |
7eff8815 DM |
547 | |
548 | ---- | |
549 | # spamassassin -D --lint | |
550 | ---- | |
551 | ||
552 | If you run a cluster, the `custom.cf` file is synchronized from the | |
553 | master node to all cluster members. | |
554 | ||
555 | ||
ed7970d8 SI |
556 | [[pmgconfig_custom_check]] |
557 | Custom Check Interface | |
558 | ---------------------- | |
559 | ||
560 | For use cases which are not handled by the {pmg} Virus Detector and | |
561 | {spamassassin} configuration, advanced users can create a custom check | |
562 | executable which, if enabled will be called before the Virus Detector and before | |
563 | passing an e-mail through the Rule System. The custom check API is kept as | |
564 | simple as possible, while still providing a great deal of control over the | |
565 | treatment of an e-mail. Its input is passed via two CLI arguments: | |
566 | ||
567 | * the 'api-version' (currently `v1`) - for potential future change of the | |
568 | invocation | |
569 | ||
570 | * the 'queue-file-name' - a filename, which contains the complete e-mail as | |
571 | rfc822/eml file | |
572 | ||
573 | The expected output need to be printed on STDOUT and consists of two lines: | |
574 | ||
575 | * the 'api-version' (currently 'v1') - see above | |
576 | ||
577 | * one of the following 3 results: | |
578 | ** 'OK' - e-mail is ok | |
579 | ** 'VIRUS: <virusdescription>' - e-mail is treated as if it contained a virus | |
580 | (the virusdescription is logged and added to the e-mail's headers) | |
581 | ** 'SCORE: <number>' - <number> is added (negative numbers are also possible) | |
582 | to the e-mail's spamscore | |
583 | ||
584 | The check is run with a 5 minute timeout - if it is exceeded the check | |
585 | executable is killed and the e-mail is treated as OK. | |
586 | ||
587 | All output written to STDERR by the check is written with priority 'err' to the | |
588 | journal/mail.log. | |
589 | ||
590 | A simple sample script following the API (and yielding a random result) for | |
591 | reference: | |
592 | ||
593 | ---- | |
594 | #!/bin/sh | |
595 | ||
596 | echo "called with $*" 1>&2 | |
597 | ||
598 | if [ "$#" -ne 2 ]; then | |
599 | echo "usage: $0 APIVERSION QUEUEFILENAME" 1>&2 | |
600 | exit 1 | |
601 | fi | |
602 | ||
603 | apiver="$1" | |
604 | shift | |
605 | ||
606 | if [ "$apiver" != "v1" ]; then | |
607 | echo "wrong APIVERSION: $apiver" 1>&2 | |
608 | exit 2 | |
609 | fi | |
610 | ||
611 | queue_file="$1" | |
612 | ||
613 | echo "v1" | |
614 | ||
615 | choice=$(shuf -i 0-3 -n1) | |
616 | ||
617 | case "$choice" in | |
618 | 0) | |
619 | echo OK | |
620 | ;; | |
621 | 1) | |
622 | echo SCORE: 4 | |
623 | ;; | |
624 | 2) | |
625 | echo VIRUS: Random Virus | |
626 | ;; | |
627 | 3) #timeout-test | |
628 | for i in $(seq 1 7); do | |
629 | echo "custom checking mail: $queue_file - minute $i" 1>&2 | |
630 | sleep 60 | |
631 | done | |
632 | ;; | |
633 | esac | |
634 | ||
635 | exit 0 | |
636 | ---- | |
637 | ||
638 | The custom check needs to be enabled in the admin section of `/etc/pmg/pmg.conf` | |
639 | ||
640 | ---- | |
641 | section: admin | |
642 | custom_check 1 | |
643 | ---- | |
644 | ||
645 | The location of the custom check executable can also be set there with the key | |
646 | `custom_check_path` and defaults to `/usr/local/bin/pmg-custom-check`. | |
647 | ||
648 | ||
c331641e DM |
649 | User Management |
650 | --------------- | |
651 | ||
05336835 DC |
652 | User management in {pmg} consists of three types of users/accounts: |
653 | ||
654 | ||
4a08dffe | 655 | [[pmgconfig_localuser]] |
05336835 DC |
656 | Local Users |
657 | ~~~~~~~~~~~ | |
658 | ||
f02d2b90 DM |
659 | image::images/screenshot/pmg-gui-local-user-config.png[] |
660 | ||
05336835 DC |
661 | Local users are used to manage and audit {pmg}. Those users can login on the |
662 | management web interface. | |
663 | ||
664 | There are three roles: | |
665 | ||
666 | * Administrator | |
667 | + | |
668 | Is allowed to manage settings of {pmg}, except some tasks like | |
669 | network configuration and upgrading. | |
670 | ||
671 | * Quarantine manager | |
672 | + | |
673 | Is allowed to manage quarantines, blacklists and whitelists, but not other | |
674 | settings. Has no right to view any other data. | |
675 | ||
676 | * Auditor | |
677 | + | |
678 | With this role, the user is only allowed to view data and configuration, but | |
679 | not to edit it. | |
680 | ||
681 | In addition there is always the 'root' user, which is used to perform special | |
682 | system administrator tasks, such as updgrading a host or changing the | |
683 | network configuration. | |
684 | ||
685 | NOTE: Only pam users are able to login via the webconsole and ssh, which the | |
686 | users created with the web interface are not. Those users are created for | |
687 | {pmg} administration only. | |
688 | ||
689 | Local user related settings are saved in `/etc/pmg/user.conf`. | |
690 | ||
691 | For details of the fields see xref:pmg_user_configuration_file[user.conf] | |
692 | ||
4a08dffe | 693 | [[pmgconfig_ldap]] |
05336835 DC |
694 | LDAP/Active Directory |
695 | ~~~~~~~~~~~~~~~~~~~~~ | |
696 | ||
f02d2b90 DM |
697 | image::images/screenshot/pmg-gui-ldap-user-config.png[] |
698 | ||
05336835 DC |
699 | You can specify multiple LDAP/Active Directory profiles, so that you can |
700 | create rules matching those users and groups. | |
701 | ||
702 | Creating a profile requires (at least) the following: | |
703 | ||
704 | * profile name | |
705 | * protocol (LDAP or LDAPS; LDAPS is recommended) | |
706 | * at least one server | |
707 | * a user and password (if your server does not support anonymous binds) | |
708 | ||
709 | All other fields should work with the defaults for most setups, but can be | |
710 | used to customize the queries. | |
711 | ||
712 | The settings are saved to `/etc/pmg/ldap.conf`. Details for the options | |
713 | can be found here: xref:pmg_ldap_configuration_file[ldap.conf] | |
714 | ||
715 | Bind user | |
716 | ^^^^^^^^^ | |
717 | ||
718 | It is highly recommended that the user which you use for connecting to the | |
719 | LDAP server only has the permission to query the server. For LDAP servers | |
720 | (for example OpenLDAP or FreeIPA), the username has to be of a format like | |
721 | 'uid=username,cn=users,cn=accounts,dc=domain' , where the specific fields are | |
722 | depending on your setup. For Active Directory servers, the format should be | |
723 | like 'username@domain' or 'domain\username'. | |
724 | ||
725 | Sync | |
726 | ^^^^ | |
727 | ||
728 | {pmg} synchronizes the relevant user and group info periodically, so that | |
729 | that information is available in a fast manner, even when the LDAP/AD server | |
730 | is temporarily not accessible. | |
731 | ||
732 | After a successfull sync, the groups and users should be visible on the web | |
733 | interface. After that, you can create rules targeting LDAP users and groups. | |
c331641e DM |
734 | |
735 | ||
4a08dffe | 736 | [[pmgconfig_fetchmail]] |
8538d9a2 | 737 | Fetchmail |
05336835 DC |
738 | ~~~~~~~~~ |
739 | ||
f02d2b90 DM |
740 | image::images/screenshot/pmg-gui-fetchmail-config.png[] |
741 | ||
05336835 DC |
742 | Fetchmail is utility for polling and forwarding e-mails. You can define |
743 | e-mail accounts, which will then be fetched and forwarded to the e-mail | |
744 | address you defined. | |
745 | ||
746 | You have to add an entry for each account/target combination you want to | |
747 | fetch and forward. Those will then be regularly polled and forwarded, | |
748 | according to your configuration. | |
749 | ||
750 | The API and web interface offer following configuration options: | |
8538d9a2 DM |
751 | |
752 | include::fetchmail.conf.5-opts.adoc[] | |
753 | ||
754 | ||
e62ceaf0 DM |
755 | ifdef::manvolnum[] |
756 | include::pmg-copyright.adoc[] | |
757 | endif::manvolnum[] | |
758 |