Haraka 3.1.0 → 3.1.2

package/plugins/queue/smtp_proxy.js

@@ -1,133 +1,131 @@
-'use strict';
+'use strict'
 // Proxy to an SMTP server
 // Opens the connection to the ongoing SMTP server at MAIL FROM time
 // and passes back any errors seen on the ongoing server to the
 // originating server.
 
-const smtp_client_mod = require('./smtp_client');
+const smtp_client_mod = require('./smtp_client')
 
 exports.register = function () {
-
-    this.load_smtp_proxy_ini();
+    this.load_smtp_proxy_ini()
 
     if (this.cfg.main.enable_outbound) {
-        this.register_hook('queue_outbound', 'hook_queue');
+        this.register_hook('queue_outbound', 'hook_queue')
     }
 }
 
 exports.load_smtp_proxy_ini = function () {
-
-    this.cfg = this.config.get('smtp_proxy.ini', {
-        booleans: [
-            '-main.enable_tls',
-            '+main.enable_outbound',
-        ],
-    },
-    () => {
-        this.load_smtp_proxy_ini();
-    });
+    this.cfg = this.config.get(
+        'smtp_proxy.ini',
+        {
+            booleans: ['-main.enable_tls', '+main.enable_outbound'],
+        },
+        () => {
+            this.load_smtp_proxy_ini()
+        },
+    )
 
     if (this.cfg.main.enable_outbound) {
-        this.lognotice('outbound enabled, will default to disabled in Haraka v3 (see #1472)');
+        this.lognotice('outbound enabled, will default to disabled in Haraka v3 (see #1472)')
     }
 }
 
 exports.hook_mail = function (next, connection, params) {
-    const c = this.cfg.main;
-    connection.loginfo(this, `forwarding to ${
-        c.forwarding_host_pool ? "configured forwarding_host_pool" : `${c.host}:${c.port}`}`
-    );
+    const c = this.cfg.main
+    connection.loginfo(
+        this,
+        `forwarding to ${c.forwarding_host_pool ? 'configured forwarding_host_pool' : `${c.host}:${c.port}`}`,
+    )
     smtp_client_mod.get_client_plugin(this, connection, c, (err, smtp_client) => {
-        connection.notes.smtp_client = smtp_client;
-        smtp_client.next = next;
+        connection.notes.smtp_client = smtp_client
+        smtp_client.next = next
 
-        smtp_client.on('mail', smtp_client.call_next);
-        smtp_client.on('rcpt', smtp_client.call_next);
-        smtp_client.on('data', smtp_client.call_next);
+        smtp_client.on('mail', smtp_client.call_next)
+        smtp_client.on('rcpt', smtp_client.call_next)
+        smtp_client.on('data', smtp_client.call_next)
 
         smtp_client.on('dot', () => {
             if (smtp_client.is_dead_sender(this, connection)) {
-                delete connection.notes.smtp_client;
-                return;
+                delete connection.notes.smtp_client
+                return
             }
 
-            smtp_client.call_next(OK, smtp_client.response);
-            smtp_client.release();
-            delete connection.notes.smtp_client;
-        });
+            smtp_client.call_next(OK, smtp_client.response)
+            smtp_client.release()
+            delete connection.notes.smtp_client
+        })
 
         smtp_client.on('error', () => {
-            delete connection.notes.smtp_client;
-        });
+            delete connection.notes.smtp_client
+        })
 
         smtp_client.on('bad_code', (code, msg) => {
-            smtp_client.call_next(code.match(/^4/) ? DENYSOFT : DENY,
-                smtp_client.response.slice());
+            smtp_client.call_next(code.match(/^4/) ? DENYSOFT : DENY, smtp_client.response.slice())
 
             if (smtp_client.command !== 'rcpt') {
                 // errors are OK for rcpt, but nothing else
                 // this can also happen if the destination server
                 // times out, but that is okay.
-                connection.loginfo(this, "message denied, proxying failed");
-                smtp_client.release();
-                delete connection.notes.smtp_client;
+                connection.loginfo(this, 'message denied, proxying failed')
+                smtp_client.release()
+                delete connection.notes.smtp_client
             }
-        });
-    });
+        })
+    })
 }
 
 exports.hook_rcpt_ok = (next, connection, recipient) => {
-    const { smtp_client } = connection.notes;
-    if (!smtp_client) return next();
+    const { smtp_client } = connection.notes
+    if (!smtp_client) return next()
     if (smtp_client.is_dead_sender(this, connection)) {
-        delete connection.notes.smtp_client;
-        return;
+        delete connection.notes.smtp_client
+        return
     }
-    smtp_client.next = next;
-    smtp_client.send_command('RCPT', `TO:${recipient.format(!smtp_client.smtp_utf8)}`);
+    smtp_client.next = next
+    smtp_client.send_command('RCPT', `TO:${recipient.format(!smtp_client.smtp_utf8)}`)
 }
 
 exports.hook_data = (next, connection) => {
-    const { smtp_client } = connection.notes;
-    if (!smtp_client) return next();
+    const { smtp_client } = connection.notes
+    if (!smtp_client) return next()
 
     if (smtp_client.is_dead_sender(this, connection)) {
-        delete connection.notes.smtp_client;
-        return;
+        delete connection.notes.smtp_client
+        return
     }
-    smtp_client.next = next;
-    smtp_client.send_command("DATA");
+    smtp_client.next = next
+    smtp_client.send_command('DATA')
 }
 
 exports.hook_queue = function (next, connection) {
-    if (!connection?.transaction || !connection?.notes) return next();
+    if (!connection?.transaction || !connection?.notes) return next()
 
-    const { smtp_client } = connection.notes;
-    if (!smtp_client) return next();
+    const { smtp_client } = connection.notes
+    if (!smtp_client) return next()
 
     if (smtp_client.is_dead_sender(this, connection)) {
-        delete connection.notes.smtp_client;
-        return;
+        delete connection.notes.smtp_client
+        return
     }
-    smtp_client.next = next;
-    smtp_client.start_data(connection.transaction.message_stream);
+    smtp_client.next = next
+    smtp_client.start_data(connection.transaction.message_stream)
 }
 
 exports.hook_rset = (next, connection) => {
-    const { smtp_client } = connection.notes;
-    if (!smtp_client) return next();
-    smtp_client.release();
-    delete connection.notes.smtp_client;
-    next();
+    const { smtp_client } = connection.notes
+    if (!smtp_client) return next()
+    smtp_client.release()
+    delete connection.notes.smtp_client
+    next()
 }
 
-exports.hook_quit = exports.hook_rset;
+exports.hook_quit = exports.hook_rset
 
 exports.hook_disconnect = (next, connection) => {
-    const { smtp_client } = connection.notes;
-    if (!smtp_client) return next();
-    smtp_client.release();
-    delete connection.notes.smtp_client;
-    smtp_client.call_next();
-    next();
+    const { smtp_client } = connection.notes
+    if (!smtp_client) return next()
+    smtp_client.release()
+    delete connection.notes.smtp_client
+    smtp_client.call_next()
+    next()
 }

package/plugins/queue/test.js

@@ -1,15 +1,15 @@
-const fs = require('node:fs');
-const os = require('node:os');
+const fs = require('node:fs')
+const os = require('node:os')
 
-const tempDir = os.tmpdir();
+const tempDir = os.tmpdir()
 
 exports.hook_queue = function (next, connection) {
-    const txn = connection?.transaction;
-    if (!txn) return next();
+    const txn = connection?.transaction
+    if (!txn) return next()
 
     const file_path = `${tempDir}/mail_${txn.uuid}.eml`
-    const ws = fs.createWriteStream(file_path);
-    connection.logdebug(this, `Saving to ${file_path}`);
-    ws.once('close', () => next(OK));
-    connection.transaction.message_stream.pipe(ws);
+    const ws = fs.createWriteStream(file_path)
+    connection.logdebug(this, `Saving to ${file_path}`)
+    ws.once('close', () => next(OK))
+    connection.transaction.message_stream.pipe(ws)
 }

package/plugins/rcpt_to.host_list_base.js

@@ -1,69 +1,65 @@
-'use strict';
+'use strict'
 // Base class for plugins that use config/host_list
 
 exports.load_host_list = function () {
-
-    const lowered_list = {};  // assemble
+    const lowered_list = {} // assemble
     const raw_list = this.config.get('host_list', 'list', () => {
-        this.load_host_list();
-    });
+        this.load_host_list()
+    })
 
     for (const i in raw_list) {
-        lowered_list[raw_list[i].toLowerCase()] = true;
+        lowered_list[raw_list[i].toLowerCase()] = true
     }
 
-    this.host_list = lowered_list;
+    this.host_list = lowered_list
 }
 
 exports.load_host_list_regex = function () {
+    this.host_list_regex = this.config.get('host_list_regex', 'list', () => {
+        this.load_host_list_regex()
+    })
 
-    this.host_list_regex = this.config.get(
-        'host_list_regex',
-        'list',
-        () => { this.load_host_list_regex(); }
-    );
-
-    this.hl_re = new RegExp (`^(?:${this.host_list_regex.join('|')})$`, 'i');
+    this.hl_re = new RegExp(`^(?:${this.host_list_regex.join('|')})$`, 'i')
 }
 
 exports.hook_mail = function (next, connection, params) {
-    const txn = connection?.transaction;
-    if (!txn) return;
+    const txn = connection?.transaction
+    if (!txn) return
 
-    const email = params[0].address();
+    const email = params[0].address()
     if (!email) {
-        txn.results.add(this, {skip: 'mail_from.null', emit: true});
-        return next();
+        txn.results.add(this, { skip: 'mail_from.null', emit: true })
+        return next()
     }
 
-    const domain = params[0].host.toLowerCase();
+    const domain = params[0].host.toLowerCase()
 
-    const anti_spoof = this.config.get('host_list.anti_spoof') || false;
+    const anti_spoof = this.config.get('host_list.anti_spoof') || false
 
     if (this.in_host_list(domain, connection) || this.in_host_regex(domain, connection)) {
         if (anti_spoof && !connection.relaying) {
-            txn.results.add(this, {fail: 'mail_from.anti_spoof'});
-            return next(DENY, `Mail from domain '${domain}' is not allowed from your host`);
+            txn.results.add(this, { fail: 'mail_from.anti_spoof' })
+            return next(DENY, `Mail from domain '${domain}' is not allowed from your host`)
         }
-        txn.results.add(this, {pass: 'mail_from'});
-        txn.notes.local_sender = true;
-        return next();
+        txn.results.add(this, { pass: 'mail_from' })
+        txn.notes.local_sender = true
+        return next()
     }
 
-    txn.results.add(this, {msg: 'mail_from!local'});
-    return next();
+    txn.results.add(this, { msg: 'mail_from!local' })
+    return next()
 }
 
 exports.in_host_list = function (domain, connection) {
-    this.logdebug(connection, `checking ${domain} in config/host_list`);
-    return !!(this.host_list[domain]);
+    this.logdebug(connection, `checking ${domain} in config/host_list`)
+    return !!this.host_list[domain]
 }
 
 exports.in_host_regex = function (domain, connection) {
-    if (!this.host_list_regex) return false;
-    if (!this.host_list_regex.length) return false;
+    if (!this.host_list_regex) return false
+    if (!this.host_list_regex.length) return false
 
-    this.logdebug(connection, `checking ${domain} against config/host_list_regex `);
+    this.logdebug(connection, `checking ${domain} against config/host_list_regex `)
 
-    return !!(this.hl_re.test(domain));
+    return !!this.hl_re.test(domain)
 }

package/plugins/rcpt_to.in_host_list.js

@@ -1,4 +1,4 @@
-'use strict';
+'use strict'
 // Check RCPT TO domain is in config/host_list
 
 // Previous versions of this plugin (Haraka <= 2.4.0) did not account for
@@ -10,47 +10,47 @@
 // is enabled and the sending domain is local, the receipt is OK.
 
 exports.register = function () {
-    this.inherits('rcpt_to.host_list_base');
+    this.inherits('rcpt_to.host_list_base')
 
-    this.load_host_list();
-    this.load_host_list_regex();
+    this.load_host_list()
+    this.load_host_list_regex()
 }
 
 exports.hook_rcpt = function (next, connection, params) {
-    const txn = connection?.transaction;
-    if (!txn) return;
+    const txn = connection?.transaction
+    if (!txn) return
 
-    const rcpt = params[0];
+    const rcpt = params[0]
 
     // Check for RCPT TO without an @ first - ignore those here
     if (!rcpt.host) {
-        txn.results.add(this, {fail: 'rcpt!domain'});
-        return next();
+        txn.results.add(this, { fail: 'rcpt!domain' })
+        return next()
     }
 
-    connection.logdebug(this, `Checking if ${rcpt} host is in host_list`);
+    connection.logdebug(this, `Checking if ${rcpt} host is in host_list`)
 
-    const domain = rcpt.host.toLowerCase();
+    const domain = rcpt.host.toLowerCase()
 
     if (this.in_host_list(domain, connection)) {
-        txn.results.add(this, {pass: 'rcpt_to'});
-        return next(OK);
+        txn.results.add(this, { pass: 'rcpt_to' })
+        return next(OK)
     }
 
     if (this.in_host_regex(domain, connection)) {
-        txn.results.add(this, {pass: 'rcpt_to'});
-        return next(OK);
+        txn.results.add(this, { pass: 'rcpt_to' })
+        return next(OK)
     }
 
     // in this case, a client with relaying privileges is sending FROM a local
     // domain. For them, any RCPT address is accepted.
     if (connection.relaying && txn.notes.local_sender) {
-        txn.results.add(this, {pass: 'relaying local_sender'});
-        return next(OK);
+        txn.results.add(this, { pass: 'relaying local_sender' })
+        return next(OK)
     }
 
     // the MAIL FROM domain is not local and neither is the RCPT TO
     // Another RCPT plugin may yet vouch for this recipient.
-    txn.results.add(this, {msg: 'rcpt!local'});
-    return next();
+    txn.results.add(this, { msg: 'rcpt!local' })
+    return next()
 }

package/plugins/record_envelope_addresses.js

@@ -4,14 +4,14 @@
 
 exports.hook_rcpt = (next, connection, params) => {
     if (connection?.transaction) {
-        connection.transaction.add_header('X-Envelope-To', params[0].address());
+        connection.transaction.add_header('X-Envelope-To', params[0].address())
     }
-    next();
+    next()
 }
 
 exports.hook_mail = (next, connection, params) => {
     if (connection?.transaction) {
-        connection.transaction.add_header('X-Envelope-From', params[0].address());
+        connection.transaction.add_header('X-Envelope-From', params[0].address())
     }
-    next();
+    next()
 }

package/plugins/reseed_rng.js

@@ -1,7 +1,7 @@
-const crypto = require('node:crypto');
+const crypto = require('node:crypto')
 
 exports.hook_init_child = function (next) {
-    Math.seedrandom(crypto.randomBytes(256).toString('hex'));
-    this.logdebug("reseeded rng");
-    next();
+    Math.seedrandom(crypto.randomBytes(256).toString('hex'))
+    this.logdebug('reseeded rng')
+    next()
 }