Rewrite SMTP MAIL FROM: address , when using smtp_forward plugin

[rogereiddir]

Hello ,

so want to edit the MAIL FROM adresse and i am having some issue this is the code

// edit_headers

// documentation via: haraka -c /etc/haraka -h plugins/edit_headers

// Put your plugin code here
// type: `haraka -h Plugins` for documentation on how to create a plugin

exports.register = function () {
  const plugin = this
  plugin.register_hook('get_mx','edit_mail_return_path');
}

exports.edit_mail_return_path = function (next , hmail) {
  this.loginfo(hmail.todo.mail_from)
  this.loginfo(hmail.todo.domain)
  this.loginfo(hmail.todo.notes)

  hmail.todo.mail_from.original_host = "domain.com"
  hmail.todo.mail_from.user = "user"
  
  this.loginfo(hmail.todo.mail_from)
  next();
}

but this not working

[rogereiddir]

so my solution to this was copied the smtp_forward plugin code and modified it , and disabled the default one this the code if there something i did wrong please correct me thank you i am going to close this

'use strict';
// Forward to an SMTP server
// Opens the connection to the ongoing SMTP server at queue time
// and passes back any errors seen on the ongoing server to the
// originating server.

exports.register = function () {
    const plugin = this;
    plugin.load_errs = [];

    plugin.load_smtp_forward_ini();

    if (plugin.load_errs.length > 0) return;
    plugin.register_hook('queue_outbound', 'queue_forward'); 
    plugin.register_hook('get_mx', 'get_mx'); // for relaying outbound messages
}

exports.load_smtp_forward_ini = function () {
    const plugin = this;

    plugin.cfg = plugin.config.get('smtp_forward.ini', {
        booleans: [
            '-main.enable_tls',
            '+main.enable_outbound',
            'main.one_message_per_rcpt',
            '-main.check_sender',
            '-main.check_recipient',
            '*.enable_tls',
            '*.enable_outbound'
        ],
    },
    () => {
        plugin.load_smtp_forward_ini();
    });

    if (plugin.cfg.main.enable_outbound) {
        plugin.lognotice('outbound enabled, will default to disabled in Haraka v3 (see #1472)');
    }
}

exports.get_config = function (conn) {
    const plugin = this;

    if (!conn.transaction) return plugin.cfg.main;

    let dom;
    if (plugin.cfg.main.domain_selector === 'mail_from') {
        if (!conn.transaction.mail_from) return plugin.cfg.main;
        dom = conn.transaction.mail_from.host;
        const returnPath = conn.transaction.header.get('Return-Path');
        this.loginfo("retr" + returnPath)
        if(returnPath){
          conn.transaction.notes.returnPath = returnPath
        }
    }
    else {
        if (!conn.transaction.rcpt_to[0]) return plugin.cfg.main;
        dom = conn.transaction.rcpt_to[0].host;
    }

    if (!dom)             return plugin.cfg.main;
    if (!plugin.cfg[dom]) return plugin.cfg.main;  // no specific route

    return plugin.cfg[dom];
}

exports.queue_forward = function (next, connection) {
  const plugin = this;
  const conn = connection;
  plugin.get_config(conn);
  next()
}


exports.get_mx = function (next, hmail, domain) {
    const plugin = this;

    // hmail.todo not defined in tests.
    if (hmail.todo.notes.next_hop) {
        return next(OK, plugin.get_mx_next_hop(hmail.todo.notes.next_hop));
    }

    const dom = plugin.cfg.main.domain_selector === 'mail_from' ? hmail.todo.mail_from.host.toLowerCase() : domain.toLowerCase();
    const cfg = plugin.cfg[dom];
    if(hmail.todo.notes.returnPath){
        const host = hmail.todo.notes.returnPath.replace('\n' , '').split('@')[1]
        const user = hmail.todo.notes.returnPath.replace('\n' , '').split('@')[0]
        hmail.todo.mail_from.host = host
        hmail.todo.mail_from.user = user
    }
    if (cfg === undefined) {
        plugin.logdebug(`using DNS MX for: ${domain}`);
        return next();
    }

    const mx_opts = [
        'auth_type', 'auth_user', 'auth_pass', 'bind', 'bind_helo',
        'using_lmtp'
    ]

    const mx = {
        priority: 0,
        exchange: cfg.host || plugin.cfg.main.host,
        port: cfg.port || plugin.cfg.main.port || 25,
    }

    // apply auth/mx options
    mx_opts.forEach(o => {
        if (cfg[o] === undefined) return;
        mx[o] = plugin.cfg[dom][o];
    })

    return next(OK, mx);
}

[msimerson]

Hi @rogereiddir, it's a good idea to post your version of smtp_forward, so that someone else who wants to do this can find it. Thanks for that. Also a good idea is to just post a patch (diff -u) here, which is much smaller and also highlights exactly what you needed to change to get your preferred behavior.

[rogereiddir]

Hi @msimerson can you help me create the patch diff i am not familiar with it , so i don't know how to do it

[msimerson]

You create patches / diff files with the diff utility. A command like this will create a unified patch:

diff -u smtp_forward.original smtp_forward

[rogereiddir]

Hi @msimerson can you check this going to cause me any issues while sending

https://gist.github.com/rogereiddir/c0ae7b029da213261e3f701fba73febb

[msimerson]

--- smtp_forward.js	2020-12-16 13:59:03.000000000 -0800
+++ smtp_forward.js-roger	2021-01-06 10:43:48.000000000 -0800
@@ -4,10 +4,6 @@
 // and passes back any errors seen on the ongoing server to the
 // originating server.
 
-const url = require('url');
-
-const smtp_client_mod = require('./smtp_client');
-
 exports.register = function () {
     const plugin = this;
     plugin.load_errs = [];
@@ -15,17 +11,7 @@
     plugin.load_smtp_forward_ini();
 
     if (plugin.load_errs.length > 0) return;
-
-    if (plugin.cfg.main.check_sender) {
-        plugin.register_hook('mail', 'check_sender');
-    }
-
-    if (plugin.cfg.main.check_recipient) {
-        plugin.register_hook('rcpt', 'check_recipient');
-    }
-
-    plugin.register_hook('queue', 'queue_forward');
-
+    plugin.register_hook('queue_outbound', 'queue_forward'); 
     plugin.register_hook('get_mx', 'get_mx'); // for relaying outbound messages
 }
 
@@ -61,6 +47,11 @@
     if (plugin.cfg.main.domain_selector === 'mail_from') {
         if (!conn.transaction.mail_from) return plugin.cfg.main;
         dom = conn.transaction.mail_from.host;
+        const returnPath = conn.transaction.header.get('Return-Path');
+        this.loginfo("retr" + returnPath)
+        if(returnPath){
+          conn.transaction.notes.returnPath = returnPath
+        }
     }
     else {
         if (!conn.transaction.rcpt_to[0]) return plugin.cfg.main;
@@ -73,264 +64,13 @@
     return plugin.cfg[dom];
 }
 
-exports.is_outbound_enabled = function (dom_cfg) {
-    const plugin = this;
-
-    if ('enable_outbound' in dom_cfg) return dom_cfg.enable_outbound; // per-domain flag
-
-    return plugin.cfg.main.enable_outbound; // follow the global configuration
-};
-
-exports.check_sender = function (next, connection, params) {
-    const plugin = this;
-    if (!connection.transaction) return;
-    const txn = connection.transaction;
-
-    const email = params[0].address();
-    if (!email) {
-        txn.results.add(plugin, {skip: 'mail_from.null', emit: true});
-        return next();
-    }
-
-    const domain = params[0].host.toLowerCase();
-    if (!plugin.cfg[domain]) return next();
-
-    // domain is defined in smtp_forward.ini
-    txn.notes.local_sender = true;
-
-    if (!connection.relaying) {
-        txn.results.add(plugin, {fail: 'mail_from!spoof'});
-        return next(DENY, "Spoofed MAIL FROM");
-    }
-
-    txn.results.add(plugin, {pass: 'mail_from'});
-    return next();
-}
-
-exports.set_queue = function (connection, queue_wanted, domain) {
-    const plugin = this;
-
-    let dom_cfg = plugin.cfg[domain];
-    if (dom_cfg === undefined) dom_cfg = {};
-
-    if (!queue_wanted) queue_wanted = dom_cfg.queue || plugin.cfg.main.queue;
-    if (!queue_wanted) return true;
-
-    let dst_host = dom_cfg.host || plugin.cfg.main.host;
-    if (dst_host) dst_host = `smtp://${dst_host}`;
-
-    const notes = connection.transaction.notes;
-    if (!notes.get('queue.wants')) {
-        notes.set('queue.wants', queue_wanted);
-        if (dst_host) {
-            notes.set('queue.next_hop', dst_host);
-        }
-        return true;
-    }
-
-    // multiple recipients with same destination
-    if (notes.get('queue.wants') === queue_wanted) {
-        if (!dst_host) return true;
-        const next_hop = notes.get('queue.next_hop');
-        if (!next_hop) return true;
-        if (next_hop === dst_host) return true;
-    }
-
-    // multiple recipients with different forward host, soft deny
-    return false;
-}
-
-exports.check_recipient = function (next, connection, params) {
-    const plugin = this;
-    const txn = connection.transaction;
-    if (!txn) return;
-
-    const rcpt = params[0];
-    if (!rcpt.host) {
-        txn.results.add(plugin, {skip: 'rcpt!domain'});
-        return next();
-    }
-
-    if (connection.relaying && txn.notes.local_sender) {
-        plugin.set_queue(connection, 'outbound');
-        txn.results.add(plugin, {pass: 'relaying local_sender'});
-        return next(OK);
-    }
-
-    const domain = rcpt.host.toLowerCase();
-    if (plugin.cfg[domain] !== undefined) {
-        if (plugin.set_queue(connection, 'smtp_forward', domain)) {
-            txn.results.add(plugin, {pass: 'rcpt_to'});
-            return next(OK);
-        }
-        txn.results.add(plugin, {pass: 'rcpt_to.split'});
-        return next(DENYSOFT, "Split transaction, retry soon");
-    }
-
-    // the MAIL FROM domain is not local and neither is the RCPT TO
-    // Another RCPT plugin may vouch for this recipient.
-    txn.results.add(plugin, {msg: 'rcpt!local'});
-    return next();
-}
-
-exports.auth = function (cfg, connection, smtp_client) {
-    const plugin = this;
-
-    connection.loginfo(plugin, `Configuring authentication for SMTP server ${cfg.host}:${cfg.port}`);
-    smtp_client.on('capabilities', () => {
-        connection.loginfo(plugin, 'capabilities received');
-
-        if ('secured' in smtp_client) {
-            connection.loginfo(plugin, 'secured is pending');
-            if (smtp_client.secured === false) {
-                connection.loginfo(plugin, "Waiting for STARTTLS to complete. AUTH postponed");
-                return;
-            }
-        }
-
-        function base64 (str) {
-            const buffer = Buffer.from(str, 'UTF-8');
-            return buffer.toString('base64');
-        }
-
-        if (cfg.auth_type === 'plain') {
-            connection.loginfo(plugin, `Authenticating with AUTH PLAIN ${cfg.auth_user}`);
-            smtp_client.send_command('AUTH', `PLAIN ${base64(`\0${cfg.auth_user}\0${cfg.auth_pass}`)}`);
-        }
-        else if (cfg.auth_type === 'login') {
-            smtp_client.authenticating = true;
-            smtp_client.authenticated = false;
-
-            connection.loginfo(plugin, `Authenticating with AUTH LOGIN ${cfg.auth_user}`);
-            smtp_client.send_command('AUTH', 'LOGIN');
-            smtp_client.on('auth', () => {
-                //TODO: nothing?
-
-            });
-            smtp_client.on('auth_username', () => {
-                smtp_client.send_command(base64(cfg.auth_user));
-            });
-            smtp_client.on('auth_password', () => {
-                smtp_client.send_command(base64(cfg.auth_pass));
-            });
-        }
-    });
-}
-
-exports.forward_enabled = function (conn, dom_cfg) {
-    const plugin = this;
-
-    const q_wants = conn.transaction.notes.get('queue.wants');
-    if (q_wants && q_wants !== 'smtp_forward') {
-        conn.logdebug(plugin, `skipping, unwanted (${q_wants})`);
-        return false;
-    }
-
-    if (conn.relaying && !plugin.is_outbound_enabled(dom_cfg)) {
-        conn.logdebug(plugin, 'skipping, outbound disabled');
-        return false;
-    }
-
-    return true;
-}
-
 exports.queue_forward = function (next, connection) {
-    const plugin = this;
-    const conn = connection;
-    const txn = connection.transaction;
-
-    const cfg = plugin.get_config(conn);
-    if (!plugin.forward_enabled(conn, cfg)) return next();
-
-    smtp_client_mod.get_client_plugin(plugin, conn, cfg, (err, smtp_client) => {
-        smtp_client.next = next;
-
-        let rcpt = 0;
-
-        if (cfg.auth_user) plugin.auth(cfg, conn, smtp_client);
-
-        conn.loginfo(plugin, `forwarding to ${
-            cfg.forwarding_host_pool ? 'host_pool' : `${cfg.host}:${cfg.port}`}`
-        );
-
-        function get_rs () {
-            if (connection.transaction) return txn.results;
-            return conn.results;
-        }
-
-        function dead_sender () {
-            if (smtp_client.is_dead_sender(plugin, conn)) {
-                get_rs().add(plugin, { err: 'dead sender' });
-                return true;
-            }
-            return false;
-        }
-
-        function send_rcpt () {
-            if (dead_sender()) return;
-            if (rcpt === txn.rcpt_to.length) {
-                smtp_client.send_command('DATA');
-                return;
-            }
-            smtp_client.send_command('RCPT', `TO:${txn.rcpt_to[rcpt].format(!smtp_client.smtp_utf8)}`);
-            rcpt++;
-        }
-
-        smtp_client.on('mail', send_rcpt);
-
-        if (cfg.one_message_per_rcpt) {
-            smtp_client.on('rcpt', () => {
-                smtp_client.send_command('DATA');
-            });
-        }
-        else {
-            smtp_client.on('rcpt', send_rcpt);
-        }
-
-        smtp_client.on('data', () => {
-            if (dead_sender()) return;
-            smtp_client.start_data(txn.message_stream);
-        });
-
-        smtp_client.on('dot', () => {
-            if (dead_sender()) return;
-            get_rs().add(plugin, { pass: smtp_client.response });
-            if (rcpt < txn.rcpt_to.length) {
-                smtp_client.send_command('RSET');
-                return;
-            }
-            smtp_client.call_next(OK, smtp_client.response);
-            smtp_client.release();
-        });
-
-        smtp_client.on('rset', () => {
-            if (dead_sender()) return;
-            smtp_client.send_command('MAIL', `FROM:${txn.mail_from}`);
-        });
-
-        smtp_client.on('bad_code', (code, msg) => {
-            if (dead_sender()) return;
-            smtp_client.call_next(((code && code[0] === '5') ? DENY : DENYSOFT),
-                msg);
-            smtp_client.release();
-        });
-    });
+  const plugin = this;
+  const conn = connection;
+  plugin.get_config(conn);
+  next()
 }
 
-exports.get_mx_next_hop = next_hop => {
-    const dest = url.parse(next_hop);
-    const mx = {
-        priority: 0,
-        port: dest.port || 25,
-        exchange: dest.hostname,
-    }
-    if (dest.auth) {
-        mx.auth_type = 'plain';
-        mx.auth_user = dest.auth.split(':')[0];
-        mx.auth_pass = dest.auth.split(':')[1];
-    }
-    return mx;
-}
 
 exports.get_mx = function (next, hmail, domain) {
     const plugin = this;
@@ -342,7 +82,12 @@
 
     const dom = plugin.cfg.main.domain_selector === 'mail_from' ? hmail.todo.mail_from.host.toLowerCase() : domain.toLowerCase();
     const cfg = plugin.cfg[dom];
-
+    if(hmail.todo.notes.returnPath){
+        const host = hmail.todo.notes.returnPath.replace('\n' , '').split('@')[1]
+        const user = hmail.todo.notes.returnPath.replace('\n' , '').split('@')[0]
+        hmail.todo.mail_from.host = host
+        hmail.todo.mail_from.user = user
+    }
     if (cfg === undefined) {
         plugin.logdebug(`using DNS MX for: ${domain}`);
         return next();