]> git.proxmox.com Git - pmg-docs.git/blob - pmgconfig.adoc
e6ebe579e79cb93f3d7f0501db83cd5480d9652b
[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, transport protocol (smtp/lmtp),
375 transport ports and mail domains (or just single email addresses)
376 of your additional e-mail servers. When transport protocol is set to `lmtp`,
377 the option 'Use MX' is useless and will be automatically set to 'No'.
378
379
380 [[pmgconfig_mailproxy_networks]]
381 Networks
382 ~~~~~~~~
383
384 ifndef::manvolnum[]
385 [thumbnail="pmg-gui-mailproxy-networks.png", big=1]
386 endif::manvolnum[]
387
388 You can add additional internal (trusted) IP networks or hosts.
389 All hosts in this list are allowed to relay.
390
391 NOTE: Hosts in the same subnet with Proxmox can relay by default and
392 it’s not needed to add them in this list.
393
394
395 [[pmgconfig_mailproxy_tls]]
396 TLS
397 ~~~
398
399 ifndef::manvolnum[]
400 [thumbnail="pmg-gui-mailproxy-tls.png", big=1]
401 endif::manvolnum[]
402
403 Transport Layer Security (TLS) provides certificate-based
404 authentication and encrypted sessions. An encrypted session protects
405 the information that is transmitted with SMTP mail. When you activate
406 TLS, {pmg} automatically generates a new self signed
407 certificate for you (`/etc/pmg/pmg-tls.pem`).
408
409 {pmg} uses opportunistic TLS encryption by default. The SMTP transaction is
410 encrypted if the 'STARTTLS' ESMTP feature is supported by the remote
411 server. Otherwise, messages are sent in the clear.
412 You can set a different TLS policy per desitination domain, should you for
413 example need to prevent e-mail delivery without encryption, or to work around
414 a broken 'STARTTLS' ESMTP implementation. See {postfix_tls_readme} for details
415 on the supported policies.
416
417 Enable TLS logging::
418
419 To get additional information about SMTP TLS activity you can enable
420 TLS logging. That way information about TLS sessions and used
421 certificate’s is logged via syslog.
422
423 Add TLS received header::
424
425 Set this option to include information about the protocol and cipher
426 used as well as the client and issuer CommonName into the "Received:"
427 message header.
428
429 Those settings are saved to subsection 'mail' in `/etc/pmg/pmg.conf`,
430 using the following configuration keys:
431
432 include::pmg.mail-tls-conf-opts.adoc[]
433
434
435 [[pmgconfig_mailproxy_dkim]]
436 DKIM Signing
437 ~~~~~~~~~~~~
438
439 ifndef::manvolnum[]
440 [thumbnail="pmg-gui-mailproxy-dkim.png", big=1]
441 endif::manvolnum[]
442
443 DomainKeys Identified Mail (DKIM) Signatures (see {dkim_rfc}) is a method to
444 cryptographically authenticate a mail as originating from a particular domain.
445 Before sending the mail a hash over certain header fields and the body is
446 computed, signed with a private key and added in the `DKIM-Signature` header of
447 the mail. The 'selector' (a short identifier chosen by you, used to identify
448 which system and private key were used for signing) is also included in the
449 `DKIM-Signature` header.
450
451 The verification is done by the receiver: The public key is fetched
452 via DNS TXT lookup for `yourselector._domainkey.yourdomain.example` and used
453 for verifying the hash. You can publish multiple selectors for your domain,
454 each use by a system which sends e-mail from your domain, without the need to
455 share the private key.
456
457 {pmg} verifies DKIM Signatures for inbound mail in the Spam Filter by default.
458
459 Additionally it supports conditionally signing outbound mail if configured.
460 It uses one private key and selector per PMG deployment (all nodes in a cluster
461 use the same key). The key has a minimal size of 1024 bits and rsa-sha256 is
462 used as signing algorithm.
463
464 The headers included in the signature are taken from the list of
465 `Mail::DKIM::Signer`. Additionally `Content-Type` (if present), `From`, `To`,
466 `CC`, `Reply-To` and `Subject` get oversigned.
467
468 You can either sign all mails received on the internal port using the domain of
469 the envelope sender address or create a list of domains, for which e-mails
470 should be signed, defaulting to the list of relay domains.
471
472
473 Enable DKIM Signing::
474
475 Controls whether outbound mail should get DKIM signed.
476
477 Selector::
478
479 The selector used for signing the mail. The private key used for signing is
480 saved under `/etc/pmg/dkim/yourselector.private`. You can display the DNS TXT
481 record which you need to add to all domains signed by {pmg} by clicking on the
482 'View DNS Record' Button.
483
484 Sign all Outgoing Mail::
485
486 Controls whether all outbound mail should get signed or only mails from domains
487 listed in `/etc/pmg/dkim/domains` if it exists and `/etc/pmg/domains` otherwise.
488
489 Those settings are saved to subsection 'admin' in `/etc/pmg/pmg.conf`,
490 using the following configuration keys:
491
492 include::pmg.admin-dkim-conf-opts.adoc[]
493
494
495 Whitelist
496 ~~~~~~~~~
497
498 ifndef::manvolnum[]
499 [thumbnail="pmg-gui-mailproxy-whitelist.png", big=1]
500 endif::manvolnum[]
501
502 All SMTP checks are disabled for those entries (e. g. Greylisting,
503 SPF, RBL, ...)
504
505 NOTE: If you use a backup MX server (e.g. your ISP offers this service
506 for you) you should always add those servers here.
507
508
509 [[pmgconfig_spamdetector]]
510 Spam Detector Configuration
511 ---------------------------
512
513 Options
514 ~~~~~~~
515
516 ifndef::manvolnum[]
517 [thumbnail="pmg-gui-spam-options.png", big=1]
518 endif::manvolnum[]
519
520 {pmg} uses a wide variety of local and network tests to identify spam
521 signatures. This makes it harder for spammers to identify one aspect
522 which they can craft their messages to work around the spam filter.
523
524 Every single e-mail will be analyzed and gets a spam score
525 assigned. The system attempts to optimize the efficiency of the rules
526 that are run in terms of minimizing the number of false positives and
527 false negatives.
528
529 include::pmg.spam-conf-opts.adoc[]
530
531
532 [[pmgconfig_spamdetector_quarantine]]
533 Quarantine
534 ~~~~~~~~~~
535
536 ifndef::manvolnum[]
537 [thumbnail="pmg-gui-spamquar-options.png", big=1]
538 endif::manvolnum[]
539
540 Proxmox analyses all incoming e-mail messages and decides for each
541 e-mail if its ham or spam (or virus). Good e-mails are delivered to
542 the inbox and spam messages can be moved into the spam quarantine.
543
544 The system can be configured to send daily reports to inform users
545 about the personal spam messages received the last day. That report is
546 only sent if there are new messages in the quarantine.
547
548 Some options are only available in the config file `/etc/pmg/pmg.conf`,
549 and not in the webinterface.
550
551 include::pmg.spamquar-conf-opts.adoc[]
552
553
554 [[pmgconfig_spamdetector_customscores]]
555 Customization of Rulescores
556 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
557
558 ifndef::manvolnum[]
559 [thumbnail="pmg-gui-spam-custom-scores.png", big=1]
560 endif::manvolnum[]
561
562 While the default scoring of {spamassassin}'s ruleset provides very good
563 detection rates, sometimes your particular environment can benefit from
564 slightly adjusting the score of a particular rule. Two examples:
565
566 * Your system receives spam mails which are scored at 4.9 and you have
567 a rule which puts all mails above 5 in the quarantine. The one thing the
568 spam mails have in common is that they all hit 'URIBL_BLACK'. By increasing
569 the score of this rule by 0.2 points the spam mails would all be quarantined
570 instead of being sent to your users
571
572 * Your system tags many legitimate mails from a partner organization as spam,
573 because the organization has a policy that each mail has to start with
574 'Dear madam or sir' (generating 1.9 points through the rule
575 'DEAR_SOMETHING'). By setting the score of this rule to 0 you can disable
576 it completely.
577
578 The system logs all rules which particular mail hits. Analyzing the logs can
579 lead to finding such a pattern in your environment.
580
581 You can adjust the score of a rule by creating a new 'Custom Rule Score' entry
582 in the GUI.
583
584 NOTE: In general it is strongly recommended to not make large changes to the
585 default scores.
586
587
588 [[pmgconfig_clamav]]
589 Virus Detector Configuration
590 ----------------------------
591
592 [[pmgconfig_clamav_options]]
593 Options
594 ~~~~~~~
595
596 ifndef::manvolnum[]
597 [thumbnail="pmg-gui-virus-options.png", big=1]
598 endif::manvolnum[]
599
600 All mails are automatically passed to the included virus detector
601 ({clamav}). The default setting are considered safe, so it is usually
602 not required to change them.
603
604 {clamav} related settings are saved to subsection 'clamav' in `/etc/pmg/pmg.conf`,
605 using the following configuration keys:
606
607 include::pmg.clamav-conf-opts.adoc[]
608
609 ifndef::manvolnum[]
610 [thumbnail="pmg-gui-clamav-database.png", big=1]
611 endif::manvolnum[]
612
613 Please note that the virus signature database it automatically
614 updated. But you can see the database status on the GUI, and you can
615 trigger manual updates there.
616
617
618 [[pmgconfig_clamav_quarantine]]
619 Quarantine
620 ~~~~~~~~~~
621
622 ifndef::manvolnum[]
623 [thumbnail="pmg-gui-virusquar-options.png", big=1]
624 endif::manvolnum[]
625
626 Indentified virus mails are automatically moved to the virus
627 quarantine. The administartor can view those mails using the GUI, or
628 deliver them in case of false positives. {pmg} does not notify
629 individual users about received virus mails.
630
631 Virus quarantine related settings are saved to subsection 'virusquar'
632 in `/etc/pmg/pmg.conf`, using the following configuration keys:
633
634 include::pmg.virusquar-conf-opts.adoc[]
635
636
637 Custom SpamAssassin configuration
638 ---------------------------------
639
640 This is only for advanced users. {spamassassin}'s rules and their associated
641 scores get updated regularly and are trained on a huge corpus, which gets
642 classified by experts. In most cases adding a rule for matching a particular
643 keyword is the wrong approach, leading to many false positives. Usually bad
644 detection rates are better addressed by properly setting up DNS than by adding
645 a custom rule - watch out for matches to 'URIBL_BLOCKED' in the logs or
646 spam-headers - see the {spamassassin_dnsbl}.
647
648 To add or change the Proxmox {spamassassin} configuration please login to the
649 console via SSH. Change to the `/etc/mail/spamassassin/` directory. In this
650 directory there are several files (`init.pre`, `local.cf`, ...) - do not change
651 them, as `init.pre`, `v310.pre`, `v320.pre`, `local.cf` will be overwritten by
652 the xref:pmgconfig_template_engine[template engine], while the others can
653 get updated by any {spamassassin} package upgrade.
654
655 To add your special configuration, you have to create a new file and name it
656 `custom.cf` (in this directory), then add your configuration there. Make sure
657 to use the correct {spamassassin} syntax, and test with
658
659 ----
660 # spamassassin -D --lint
661 ----
662
663 If you run a cluster, the `custom.cf` file is synchronized from the
664 master node to all cluster members automatically.
665
666 Should you only wish to adjust the score assigned to a particular rule you
667 can also use the xref:pmgconfig_spamdetector_customscores[Custom Rule Score]
668 settings in the GUI.
669
670
671 [[pmgconfig_custom_check]]
672 Custom Check Interface
673 ----------------------
674
675 For use cases which are not handled by the {pmg} Virus Detector and
676 {spamassassin} configuration, advanced users can create a custom check
677 executable which, if enabled will be called before the Virus Detector and before
678 passing an e-mail through the Rule System. The custom check API is kept as
679 simple as possible, while still providing a great deal of control over the
680 treatment of an e-mail. Its input is passed via two CLI arguments:
681
682 * the 'api-version' (currently `v1`) - for potential future change of the
683 invocation
684
685 * the 'queue-file-name' - a filename, which contains the complete e-mail as
686 rfc822/eml file
687
688 The expected output need to be printed on STDOUT and consists of two lines:
689
690 * the 'api-version' (currently 'v1') - see above
691
692 * one of the following 3 results:
693 ** 'OK' - e-mail is ok
694 ** 'VIRUS: <virusdescription>' - e-mail is treated as if it contained a virus
695 (the virusdescription is logged and added to the e-mail's headers)
696 ** 'SCORE: <number>' - <number> is added (negative numbers are also possible)
697 to the e-mail's spamscore
698
699 The check is run with a 5 minute timeout - if it is exceeded the check
700 executable is killed and the e-mail is treated as OK.
701
702 All output written to STDERR by the check is written with priority 'err' to the
703 journal/mail.log.
704
705 A simple sample script following the API (and yielding a random result) for
706 reference:
707
708 ----
709 #!/bin/sh
710
711 echo "called with $*" 1>&2
712
713 if [ "$#" -ne 2 ]; then
714 echo "usage: $0 APIVERSION QUEUEFILENAME" 1>&2
715 exit 1
716 fi
717
718 apiver="$1"
719 shift
720
721 if [ "$apiver" != "v1" ]; then
722 echo "wrong APIVERSION: $apiver" 1>&2
723 exit 2
724 fi
725
726 queue_file="$1"
727
728 echo "v1"
729
730 choice=$(shuf -i 0-3 -n1)
731
732 case "$choice" in
733 0)
734 echo OK
735 ;;
736 1)
737 echo SCORE: 4
738 ;;
739 2)
740 echo VIRUS: Random Virus
741 ;;
742 3) #timeout-test
743 for i in $(seq 1 7); do
744 echo "custom checking mail: $queue_file - minute $i" 1>&2
745 sleep 60
746 done
747 ;;
748 esac
749
750 exit 0
751 ----
752
753 The custom check needs to be enabled in the admin section of `/etc/pmg/pmg.conf`
754
755 ----
756 section: admin
757 custom_check 1
758 ----
759
760 The location of the custom check executable can also be set there with the key
761 `custom_check_path` and defaults to `/usr/local/bin/pmg-custom-check`.
762
763
764 User Management
765 ---------------
766
767 User management in {pmg} consists of three types of users/accounts:
768
769
770 [[pmgconfig_localuser]]
771 Local Users
772 ~~~~~~~~~~~
773
774 [thumbnail="pmg-gui-local-user-config.png", big=1]
775
776 Local users are used to manage and audit {pmg}. Those users can login on the
777 management web interface.
778
779 There are three roles:
780
781 * Administrator
782 +
783 Is allowed to manage settings of {pmg}, except some tasks like
784 network configuration and upgrading.
785
786 * Quarantine manager
787 +
788 Is allowed to manage quarantines, blacklists and whitelists, but not other
789 settings. Has no right to view any other data.
790
791 * Auditor
792 +
793 With this role, the user is only allowed to view data and configuration, but
794 not to edit it.
795
796 In addition there is always the 'root' user, which is used to perform special
797 system administrator tasks, such as updgrading a host or changing the
798 network configuration.
799
800 NOTE: Only pam users are able to login via the webconsole and ssh, which the
801 users created with the web interface are not. Those users are created for
802 {pmg} administration only.
803
804 Local user related settings are saved in `/etc/pmg/user.conf`.
805
806 For details of the fields see xref:pmg_user_configuration_file[user.conf]
807
808 [[pmgconfig_ldap]]
809 LDAP/Active Directory
810 ~~~~~~~~~~~~~~~~~~~~~
811
812 [thumbnail="pmg-gui-ldap-user-config.png", big=1]
813
814 You can specify multiple LDAP/Active Directory profiles, so that you can
815 create rules matching those users and groups.
816
817 Creating a profile requires (at least) the following:
818
819 * profile name
820 * protocol (LDAP or LDAPS; LDAPS is recommended)
821 * at least one server
822 * a user and password (if your server does not support anonymous binds)
823
824 All other fields should work with the defaults for most setups, but can be
825 used to customize the queries.
826
827 The settings are saved to `/etc/pmg/ldap.conf`. Details for the options
828 can be found here: xref:pmg_ldap_configuration_file[ldap.conf]
829
830 Bind user
831 ^^^^^^^^^
832
833 It is highly recommended that the user which you use for connecting to the
834 LDAP server only has the permission to query the server. For LDAP servers
835 (for example OpenLDAP or FreeIPA), the username has to be of a format like
836 'uid=username,cn=users,cn=accounts,dc=domain' , where the specific fields are
837 depending on your setup. For Active Directory servers, the format should be
838 like 'username@domain' or 'domain\username'.
839
840 Sync
841 ^^^^
842
843 {pmg} synchronizes the relevant user and group info periodically, so that
844 that information is available in a fast manner, even when the LDAP/AD server
845 is temporarily not accessible.
846
847 After a successfull sync, the groups and users should be visible on the web
848 interface. After that, you can create rules targeting LDAP users and groups.
849
850
851 [[pmgconfig_fetchmail]]
852 Fetchmail
853 ~~~~~~~~~
854
855 [thumbnail="pmg-gui-fetchmail-config.png", big=1]
856
857 Fetchmail is utility for polling and forwarding e-mails. You can define
858 e-mail accounts, which will then be fetched and forwarded to the e-mail
859 address you defined.
860
861 You have to add an entry for each account/target combination you want to
862 fetch and forward. Those will then be regularly polled and forwarded,
863 according to your configuration.
864
865 The API and web interface offer following configuration options:
866
867 include::fetchmail.conf.5-opts.adoc[]
868
869
870 ifdef::manvolnum[]
871 include::pmg-copyright.adoc[]
872 endif::manvolnum[]
873