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