-- This require statement is needed in any script passed to KumoMTA. -- Includes from this policy script will not need this declared again. local kumo = require 'kumo' local utils = require 'policy-extras.policy_utils' -- Load the policy helpers to simplify common configuration use cases local shaping = require 'policy-extras.shaping' local queue_module = require 'policy-extras.queue' local listener_domains = require 'policy-extras.listener_domains' local sources = require 'policy-extras.sources' local dkim_sign = require 'policy-extras.dkim_sign' local log_hooks = require 'policy-extras.log_hooks' -- START SETUP -- Configure the sending IP addresses that will be used by KumoMTA to -- connect to remote systems using the sources.lua policy helper. -- Note that defining sources and pools does nothing without some form of -- policy in effect to assign messages to the source pools you have defined. -- WARNING: THIS WILL NOT LOAD WITHOUT THE source.toml FILE IN PLACE -- SEE https://docs.kumomta.com/userguide/configuration/sendingips/ sources:setup { '/opt/kumomta/etc/policy/sources.toml' } -- Configure DKIM signing. In this case we use the dkim_sign.lua policy helper. -- WARNING: THIS WILL NOT LOAD WITHOUT the dkim_data.toml FILE IN PLACE -- See https://docs.kumomta.com/userguide/configuration/dkim/ local dkim_signer = dkim_sign:setup { '/opt/kumomta/etc/policy/dkim_data.toml', '/opt/kumomta/etc/policy/dkim_dynamic.json', } -- Load Traffic Shaping Automation Helper local shaper = shaping:setup_with_automation { publish = { 'http://127.0.0.1:8008' }, subscribe = { 'http://127.0.0.1:8008' }, extra_files = { '/opt/kumomta/etc/policy/shaping.toml' }, no_default_files = true, } -- Send a JSON webhook to a local network host. -- See https://docs.kumomta.com/userguide/operation/webhooks/ --log_hooks:new_json { -- name = 'webhook', -- url = 'http://10.0.0.1:4242/log', -- log_parameters = { -- headers = { 'Subject', 'X-Customer-ID' }, -- }, --} local log_hooks = require 'policy-extras.log_hooks' log_hooks:new { name = 'webhook', -- log_parameters are combined with the name and -- passed through to kumo.configure_log_hook log_parameters = { headers = { 'X-envid', 'Message-ID' }, }, -- queue config are passed to kumo.make_queue_config. -- You can use these to override the retry parameters -- if you wish. -- The defaults are shown below. queue_config = { retry_interval = '1m', max_retry_interval = '24h', max_message_rate = '100000/s', }, -- The constructor is called when kumod needs to initiate -- a new connection to the log target. It must return -- a connection object constructor = function(domain, tenant, campaign) -- Define the connection object local connection = {} -- Create an HTTP client local client = kumo.amqp.build_client 'amqp://accounting:xxx@10.15.222.110/accounting' -- The send method is called for each log event function connection:send(message) local confirm = client:publish { routing_key = 'accounting', payload = message:get_data(), } local result = confirm:wait() if result.status == 'Ack' or result.status == 'NotRequested' then return string.format('250 %s', kumo.json_encode(result)) end -- result.status must be `Nack`; log the full result kumo.reject(500, kumo.json_encode(result)) end -- The close method is called when the connection needs -- to be closed function connection:close() client:close() end return connection end, } -- Configure queue management settings. These are not throttles, but instead -- control how messages flow through the queues. -- WARNING: ENSURE THAT WEBHOOKS AND SHAPING ARE SETUP BEFORE THE QUEUE HELPER FOR PROPER OPERATION -- WARNING: THIS WILL NOT LOAD WITHOUT the queues.toml FILE IN PLACE -- See https://docs.kumomta.com/userguide/configuration/queuemanagement/ local queue_helper = queue_module:setup { '/opt/kumomta/etc/policy/queues.toml', -- '/opt/kumomta/etc/policy/queues-account.json' } -- END SETUP --START EVENT HANDLERS kumo.on('pre_init', function() kumo.set_smtpsrv_threads(24) end) -- Called On Startup, handles initial configuration kumo.on('init', function() -- Define the default "data" spool location; this is where -- message bodies will be stored. -- See https://docs.kumomta.com/userguide/configuration/spool/ kumo.define_spool { name = 'data', path = '/var/spool/kumomta/data', kind = 'RocksDB', } -- Define the default "meta" spool location; this is where -- message envelope and metadata will be stored. kumo.define_spool { name = 'meta', path = '/var/spool/kumomta/meta', kind = 'RocksDB', } -- Configure publishing of TSA logs to automation daemon shaper.setup_publish() -- Configure logging to local disk. Separating spool and logs to separate -- disks helps reduce IO load and can help performance. -- See https://docs.kumomta.com/userguide/configuration/logging/ kumo.configure_local_logs { log_dir = '/var/log/kumomta', max_segment_duration = '5 minutes', headers = { 'X-envid', 'Message-ID' }, } -- Configure bounce classification. -- See https://docs.kumomta.com/userguide/configuration/bounce/ kumo.configure_bounce_classifier { files = { '/opt/kumomta/etc/policy/bounce_classifier.toml', '/opt/kumomta/share/bounce_classifier/iana.toml', }, } -- Configure HTTP Listeners for injection and management APIs. -- See https://docs.kumomta.com/userguide/configuration/httplisteners/ kumo.start_http_listener { listen = '0.0.0.0:8000', -- allowed to access any http endpoint without additional auth trusted_hosts = { '127.0.0.1', '::1', '10.0.0.0/8', '172.17.0.0/16', '172.18.0.0/24', '172.19.0.0/24' }, } kumo.start_http_listener { use_tls = true, listen = '0.0.0.0:8001', -- allowed to access any http endpoint without additional auth trusted_hosts = { '127.0.0.1', '::1', '10.0.0.0/8', '172.17.0.0/16', '172.18.0.0/24', '172.19.0.0/24' }, } -- Define an SMTP listener. Can be used multiple times with different -- parameters to define multiple listeners! -- See https://docs.kumomta.com/userguide/configuration/smtplisteners/ kumo.start_esmtp_listener { listen = '0.0.0.0:25', hostname = 'mta05.sendnode.com', max_message_size = 104857600, -- deferred_spool = true, -- override the default set of relay hosts relay_hosts = { '127.0.0.1', '10.0.0.0/8', '172.17.0.0/16', '172.18.0.0/24', '172.19.0.0/24' }, } -- Use shared throttles rather than in-process throttles, do not enable -- without first installing and configuring redis. -- See https://docs.kumomta.com/reference/kumo/configure_redis_throttles/ -- kumo.configure_redis_throttles { node = 'redis://127.0.0.1/' } end) -- END OF THE INIT EVENT -- Configure listener domains for relay, oob bounces, and FBLs using the -- listener_domains.lua policy helper. -- WARNING: THIS WILL NOT LOAD WITHOUT THE listener_domains.toml FILE IN PLACE -- SEE https://docs.kumomta.com/userguide/configuration/smtplisteners/ kumo.on( 'get_listener_domain', listener_domains:setup { '/opt/kumomta/etc/policy/listener_domains.toml' } ) -- Configure traffic shaping using the shaping.lua policy helper. -- Commented out by default since we recommend using the Traffic Shaping Automation helper loaded below. -- WARNING: THIS WILL NOT LOAD WITHOUT AN ADDITIONAL SCRIPT IN PLACE -- SEE https://docs.kumomta.com/userguide/configuration/trafficshaping/ -- kumo.on('get_egress_path_config', shaping:setup { '/opt/kumomta/share/policy-extras/shaping.toml', '/opt/kumomta/etc/policy/shaping.toml', }) -- Call the Traffic Shaping Automation Helper to configure shaping rules. kumo.on('get_egress_path_config', shaper.get_egress_path_config) local get_dsn_classifier = kumo.memoize(function() local data = kumo.json_load '/opt/kumomta/etc/policy/dsn_rewrite.json' return kumo.regex_set_map.new(data) end, { name = 'dsn_rewrite', ttl = '5 minutes', capacity = 1, }) kumo.on('smtp_client_rewrite_delivery_status', function(response, domain, tenant, campaign, routing_domain) local map = get_dsn_classifier() return map[response] end ) -- Processing of incoming messages via SMTP kumo.on('smtp_server_message_received', function(msg) -- Protect against SMTP Smuggling (https://sec-consult.com/blog/detail/smtp-smuggling-spoofing-e-mails-worldwide/) local failed = msg:check_fix_conformance( -- check for and reject messages with these issues: 'NON_CANONICAL_LINE_ENDINGS', -- fix messages with these issues: '' ) if failed then kumo.reject(552, string.format('5.6.0 %s', failed)) end -- Call the queue helper to set up the queue for the message. queue_helper:apply(msg) -- SIGNING MUST COME LAST OR YOU COULD BREAK YOUR DKIM SIGNATURES dkim_signer(msg) end) -- Processing of incoming messages via HTTP kumo.on('http_message_generated', function(msg) -- Call the queue helper to set up the queue for the message. queue_helper:apply(msg) -- SIGNING MUST COME LAST OR YOU COULD BREAK YOUR DKIM SIGNATURES dkim_signer(msg) end) -- END OF EVENT HANDLERS