authentication_milter - A Perl Mail Authentication Milter
version 2.20180525
authentication_milter [-c|--control <command>] [-d|--daemon] [--pidfile <file>] [-h|--help] [--prefix <dir>] [-i|--ident <ident>]
Control a running daemon process or start a new one. start|restart Start a new daemon process, or restart an existing process. stop Stop an already running daemon process. status Show the status of a running daemon process. Control implies --daemon, and takes account of --pidfile If no valid data is found in the pidfile then control will search the process list for a master process. If you are running multiple distinct instances of authentication milter on a single host, each with differing configurations then you should use the --ident identifier to differentiate between them.
Show this help.
Output an example default configuration, including config for all installed handler modules.
Show a list of installed handler modules.
Show help for a particular handler module. Modules installed by default include the following. AddID Auth DKIM DMARC IPRev LocalIP PTR ReturnOK Sanitize SenderID SpamAssassin SPF TrustedIP TLS
detach from shell and run as a daemon
Write the process PID to the given file. defaults to /run/authentication_milter.pid
Read configuration from dir rather than /etc/
A string identifier for use in process management and logging This should be used when you are running multiple instances of authentication_milter on a single host, each with different configurations.
The milter reads configuration from /etc/authentication_milter.json The configuration file format is as follows... { "external_callback_processor" : "My::Module", | Name of module containing external callback methods "debug" : 0, | Verbose debugging output "dryrun" : 0, | Dryrun (do not alter or reject mail) "logtoerr" : 0, | Also write logs to STDERR "error_log" : "/var/log/authentication_milter.err", | Capture STDERR to logfile "connection" : "inet:12345@localhost", | The connection to use "umask" : "0000", | Set umask (for unix socket) "connections" : { | Other than the default connection, also bind to | these connections. "name_two" : { | Name of connection "connection" : "unix:/var/sock/a.sock", | The connection to use "umask" : "0000", | Set umask } "name_one" : { | Name of connection "connection" : "inet:12346@localhost", | The connection to use } }, "runas" : "nobody", | Drop privs and run as this user (root only) "rungroup" : "nogroup", | Drop privs and run as this group (root daemon only) "chroot" : "/path/to/chroot" | Set chroot before forking (root only) | N.B. This path will need to be setup with all required | files or the server WILL segfault. "listen_backlog" : 20, | socket listen backlog limit (default 20) "min_children" : 20, | Max number of children to pre fork "max_children" : 200, | Max number of children to pre fork "min_spare_children" : 10, | Min number of spare children to maintain "max_spare_children" : 20, | Max number of spare children to maintain "max_requests_per_child" : 200, | Max number of requests per child process (prefork) "metric_connection" : "inet:12346@localhost", | Optional connection on which to expose metrics interface "metric_timeout" : 10, | Timeout for metrics IPC (default 5) # metric_port and metric_host are deprecated. # please use metric_connection instead "metric_port" : 8081, | Optional port on which to expose metrics interface "metric_host" : "127.0.0.1", | Optional host for binding metrics interface "protocol" : "milter", | The protocol the milter is to use | can be either milter or smtp "smtp" : { | Parameters for use when protocol is smtp "server_name" : "scan.example.com", | The server name to use for the server "sock_type" : "inet", | Socket type (inet or unix) "sock_host" : "localhost", | Host to connect to (when inet) "sock_port" : "2525", | Port to connect to (when inet) "sock_path" : "/var/run/smtp.sock", | Socket path to connect to (when unix) "timeout_in" : "10", | Timeout when waiting for inbound SMTP data "timeout_out" : "10", | Timeout when waiting for outbound SMTP data "pipeline_limit" : "50", | Limit the number of transactions accepted in an SMTP pipeline "queue_type" : "before", | SMTP Queue type, either before or after. After queues have | an upstream queue ID, before queues do not. "tcp:12346" : { | Outbound SMTP details can be set per inbound port/socket | This allows outbound SMTP to be routed differently for | different inbound ports. The key is the inbound port specified | as unix:<socket path> or inet:<port> | It is not currently possible to set based on listening host. | If a specific config set is not found them we use the default | set as defined above. "server_name" : "scan.example.com", | The server name to use for the server "sock_type" : "inet", | Socket type (inet or unix) "sock_host" : "localhost", | Host to connect to (when inet) "sock_port" : "2526", | Port to connect to (when inet) "timeout_in" : "10", | Timeout when waiting for inbound SMTP data "timeout_out" : "10" | Timeout when waiting for outbound SMTP data }, "unix:/var/sock/a.sock" : { "server_name" : "util.example.com", "sock_type" : "unix", "sock_path" : "/var/run/smtp.sock", "timeout_in" : "10", "timeout_out" : "10" } }, | Timeouts for callbacks, should be slightly lower | than the corresponding timeouts in Postfix | Timeouts are ignored if missing. "connect_timeout" : 30, | Timeout for Connect callbacks "command_timeout" : 30, | Timeout for Helo,Mail,Rcpt,Data and Unknown callbacks "content_timeout" : 300, | Timeout for Header,Eoh, Body and Eom callbacksa "dns_resolvers" : [ | Explicit list of DNS resolvers to use "8.8.8.8", "127.0.0.1" ], "dns_timeout" : 10, | Timeout for DNS lookups "dns_retry" : 2, | Number of times a lookup will retry per call "header_indent_style" : "entry", | Optional style to indent/fold Authentication-Results header by. "header_fold_at" : 77, | Optional line length to attempt folding of Authentication-Results header at. | Header lines over this size will be folded at token boundaries where possible. "header_indent_by" : 4, | Optional number of spaces to indent/fold Authentication-Results header by. | The style matches those defined in Mail::AuthenticationResults. | options are none; no folding | entry; fold on each entry | subentry; fold on each subentry | full; fold on each item | the default style is entry, and the default by is 4 | NB. This only apply when there are no handlers using the | legacy string method of adding a section to the header. "tempfail_on_error" : "1", | Tempfail on errors "tempfail_on_error_authenticated" : "0", | Tempfail on errors for Authenticated IP Connections "tempfail_on_error_local" : "0", | Tempfail on errors for Local IP Connections "tempfail_on_error_trusted" : "0", | Tempfail on errors for Trusted IP Connections "ip_map" : { | List of IP Addresses or CIDR ranges to remap. "1.2.3.4" : { | Any incoming IP address which matches a given key "ip": "5.6.7.8", "helo" : mx.test" | will be remapped to use the value supplied }, | This is useful, for example, when internal infrastructure "dead:beef::/32" : { | connects to your MX via a private internal address, but you "ip" : "5.6.7.8", "helo" : "mx.test" | want to run IP based checks (eg SPF) against its external } | IP address instead. }, "handlers" : { | Config for each handlers, can be prefixed with ! | to disable that handler without having to remove | its config. "ActiveModule" : { "foo" : "bar" }, "!InactiveModule" : {}, | Additionally, config for a module can be placed in a file | with filename /etc/authentication_milter.d/ModuleName.json | the contents of which should be the JSON assigned to the | entry here. | Please see the help for each handler for its individual | configuration requirements. } }
This milter uses Mail::DMARC as a backend for DMARC checks, this module requires that a configuration file is setup.
You should create and populate /etc/mail-dmarc.ini
For DMARC reporting you are also required to setup a datastore, including creating a basic table structure. The detauls of this are to be found in the Mail::DMARC documentation.
At this time forensic reports are not supported by Mail::DMARC or this milter. Only aggregate reports will be generated.
To check reports please use the dmarc_view_reports command, to send reports please use the dmarc_send_reports command. These are included with the Mail::DMARC module.
Marc Bradshaw <marc@marcbradshaw.net>
This software is copyright (c) 2018 by Marc Bradshaw.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Mail::Milter::Authentication, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Milter::Authentication
CPAN shell
perl -MCPAN -e shell install Mail::Milter::Authentication
For more information on module installation, please visit the detailed CPAN module installation guide.