Haraka 3.0.3 → 3.0.4

package/plugins.js

@@ -2,9 +2,9 @@
 // load all defined plugins
 
 // node built-ins
-const fs          = require('fs');
-const path        = require('path');
-const vm          = require('vm');
+const fs          = require('node:fs');
+const path        = require('node:path');
+const vm          = require('node:vm');
 
 // npm modules
 exports.config    = require('haraka-config');
@@ -74,8 +74,8 @@ class Plugin {
 
         // development mode
         paths = paths.concat(plugin_search_paths(__dirname, name));
-        paths.forEach(pp => {
-            if (this.plugin_path) return;
+        for (const pp of paths) {
+            if (this.plugin_path) continue;
             try {
                 fs.statSync(pp);
                 this.plugin_path = pp;
@@ -84,7 +84,7 @@ class Plugin {
                 }
             }
             catch (ignore) {}
-        });
+        }
     }
 
     _get_config () {
@@ -128,8 +128,7 @@ class Plugin {
         this.hooks[hook_name] = this.hooks[hook_name] || [];
         this.hooks[hook_name].push(method_name);
 
-        logger.logdebug(`registered hook ${hook_name} to ${this.name}.` +
-                        `${method_name} priority ${priority}`);
+        plugins.logdebug(`registered hook ${hook_name} to ${this.name}.${method_name} priority ${priority}`);
     }
 
     register () {} // noop
@@ -140,12 +139,6 @@ class Plugin {
             if (!this[method]) {
                 this[method] = parent_plugin[method];
             }
-            // else if (method == 'shutdown') {
-            //     Method is in this module, so it exists in the plugin
-            //     if (!this.hasOwnProperty('shutdown')) {
-            //         this[method] = parent_plugin[method];
-            //     }
-            // }
         }
         if (parent_plugin.register) {
             parent_plugin.register.call(this);
@@ -195,7 +188,7 @@ class Plugin {
         }
         catch (err) {
             if (exports.config.get('smtp.ini').main.ignore_bad_plugins) {
-                logger.logcrit(`Loading plugin ${this.name} failed: ${err}`);
+                plugins.logcrit(`Loading ${this.name} failed: ${err}`);
                 return;
             }
             throw `Loading plugin ${this.name} failed: ${err}`;
@@ -231,16 +224,13 @@ class Plugin {
             vm.runInNewContext(code, sandbox, pp);
         }
         catch (err) {
-            logger.logcrit(`Compiling plugin: ${this.name} failed`);
+            plugins.logcrit(`compiling '${this.name}' failed`);
             if (exports.config.get('smtp.ini').main.ignore_bad_plugins) {
-                logger.logcrit(`Loading plugin ${this.name} failed: `,
-                    `${err.message} - will skip this plugin and continue`);
+                plugins.logcrit(`Loading '${this.name}' failed: ${err.message} - skipping`);
                 return;
             }
             throw err; // default is to re-throw and stop Haraka
         }
-
-        return this;
     }
 }
 
@@ -254,7 +244,7 @@ exports.shutdown_plugins = () => {
 
 process.on('message', msg => {
     if (msg.event && msg.event == 'plugins.shutdown') {
-        logger.loginfo("[plugins] Shutting down plugins");
+        plugins.loginfo("Shutting down");
         exports.shutdown_plugins();
     }
 });
@@ -270,39 +260,28 @@ function plugin_search_paths (prefix, name) {
 function get_timeout (name) {
     let timeout = parseFloat((exports.config.get(`${name}.timeout`)));
     if (isNaN(timeout)) {
-        logger.logdebug(`no timeout in ${name}.timeout`);
+        plugins.logdebug(`no timeout in ${name}.timeout`);
         timeout = parseFloat(exports.config.get('plugin_timeout'));
     }
     if (isNaN(timeout)) {
-        logger.logdebug('no timeout in plugin_timeout');
+        plugins.logdebug('no timeout in plugin_timeout');
         timeout = 30;
     }
 
-    logger.logdebug(`plugin ${name} timeout is: ${timeout}s`);
+    plugins.logdebug(`plugin ${name} timeout is: ${timeout}s`);
     return timeout;
 }
 
-// copy logger methods into Plugin:
-for (const key in logger) {
-    if (!/^log\w/.test(key)) continue;
-    // console.log(`adding Plugin.${key} method`);
-    Plugin.prototype[key] = (function (lev) {
-        return function () {
-            const args = [this];
-            for (let i=0, l=arguments.length; i<l; i++) {
-                args.push(arguments[i]);
-            }
-            logger[lev].apply(logger, args);
-        };
-    })(key);
-}
+logger.add_log_methods(Plugin)
 
 const plugins = exports;
 
+logger.add_log_methods(plugins, 'plugins')
+
 plugins.Plugin = Plugin;
 
 plugins.load_plugins = override => {
-    logger.loginfo('Loading plugins');
+    plugins.logdebug('Loading');
     let plugin_list;
     if (override) {
         if (!Array.isArray(override)) override = [ override ];
@@ -312,22 +291,21 @@ plugins.load_plugins = override => {
         plugin_list = exports.config.get('plugins', 'list');
     }
 
-    plugin_list.forEach(plugin => {
+    for (let plugin of plugin_list) {
         if (plugin.startsWith('haraka-plugin-')) plugin = plugin.substr(14)
         if (plugins.deprecated[plugin]) {
-            logger.lognotice(`the plugin ${plugin} has been replaced by '${plugins.deprecated[plugin]}'. Please update config/plugins`)
+            plugins.lognotice(`${plugin} has been replaced by '${plugins.deprecated[plugin]}'. Please update config/plugins`)
             plugins.load_plugin(plugins.deprecated[plugin]);
         }
         else {
             plugins.load_plugin(plugin);
         }
-    });
+    }
 
     plugins.plugin_list = Object.keys(plugins.registered_plugins);
 
     // Sort registered_hooks by priority
-    const hooks = Object.keys(plugins.registered_hooks);
-    for (const hook of hooks) {
+    for (const hook of Object.keys(plugins.registered_hooks)) {
         plugins.registered_hooks[hook].sort((a, b) => {
             if (a.priority < b.priority) return -1;
             if (a.priority > b.priority) return 1;
@@ -343,6 +321,8 @@ plugins.load_plugins = override => {
 }
 
 plugins.deprecated = {
+    'auth/auth_ldap'      : 'auth-ldap',
+    'backscatterer'       : 'dns-list',
     'connect.asn'         : 'asn',
     'connect.fcrdns'      : 'fcrdns',
     'connect.geoip'       : 'geoip',
@@ -352,6 +332,11 @@ plugins.deprecated = {
     'data.noreceived'     : 'headers',
     'data.rfc5322_header_checks': 'headers',
     'data.headers'        : 'headers',
+    'dkim_sign'           : 'dkim',
+    'dkim_verify'         : 'dkim',
+    'data.uribl'          : 'uribl',
+    'dnsbl'               : 'dns-list',
+    'dnswl'               : 'dns-list',
     'log.syslog'          : 'syslog',
     'mail_from.access'    : 'access',
     'mail_from.blocklist' : 'access',
@@ -360,6 +345,8 @@ plugins.deprecated = {
     'rate_limit'          : 'limit',
     'rcpt_to.access'      : 'access',
     'rcpt_to.blocklist'   : 'access',
+    'rcpt_to.ldap'        : 'rcpt-ldap',
+    'rcpt_to.max_count'   : 'limit',
     'rcpt_to.qmail_deliverable' : 'qmail-deliverable',
     'rdns.regexp'         : 'access',
     'relay_acl'           : 'relay',
@@ -368,7 +355,7 @@ plugins.deprecated = {
 }
 
 plugins.load_plugin = name => {
-    logger.loginfo(`Loading plugin: ${name}`);
+    plugins.loginfo(`loading ${name}`);
 
     const plugin = plugins._load_and_compile_plugin(name);
     if (plugin) {
@@ -376,7 +363,6 @@ plugins.load_plugin = name => {
     }
 
     plugins.registered_plugins[name] = plugin;
-    return plugin;
 }
 
 // Set in server.js; initialized to empty object
@@ -388,7 +374,7 @@ plugins._load_and_compile_plugin = name => {
     if (!plugin.plugin_path) {
         const err = `Loading plugin ${plugin.name} failed: No plugin with this name found`;
         if (exports.config.get('smtp.ini').main.ignore_bad_plugins) {
-            logger.logcrit(err);
+            plugins.logcrit(err);
             return;
         }
         throw err;
@@ -407,8 +393,6 @@ plugins._register_plugin = plugin => {
             plugin.register_hook(result[1], method);
         }
     }
-
-    return plugin;
 }
 
 plugins.run_hooks = (hook, object, params) => {
@@ -496,10 +480,8 @@ plugins.run_next_hook = (hook, object, params) => {
 
         const respond_method = `${hook}_respond`;
         if (item && is_deny_retval(retval) && hook.substr(0,5) !== 'init_') {
-            object.deny_respond =
-                get_denyfn(object, hook, params, retval, msg, respond_method);
-            plugins.run_hooks('deny', object,
-                [retval, msg, item[0].name, item[1], params, hook]);
+            object.deny_respond = get_denyfn(object, hook, params, retval, msg, respond_method);
+            plugins.run_hooks('deny', object, [retval, msg, item[0].name, item[1], params, hook]);
         }
         else {
             object.hooks_to_run = [];
@@ -579,11 +561,25 @@ function log_run_item (item, hook, retval, object, params, msg) {
             'function'  :  item[1],
             'params'    :  ((params) ? ((typeof params === 'string') ? params : params[0]) : ''),
             'retval'    : constants.translate(retval),
-            'msg'       :  ((msg) ? msg : ''),
+            'msg'       :  sanitize(msg),
         });
     }
 }
 
+function sanitize (msg) {
+    if (!msg) return ''
+    if (typeof msg === 'string') return msg
+    if (typeof msg === 'object') {
+        if (msg.constructor.name === 'DSN') return msg.reply
+        const sanitized = { ...msg }; // copy the message
+        for (const priv of ['password','auth_pass']) {
+            delete sanitized[priv]
+        }
+        return JSON.stringify(sanitized)
+    }
+    logger.logerror(`what is ${msg} (typeof ${typeof msg})?`)
+}
+
 function is_deny_retval (val) {
     switch (val) {
         case constants.deny:

package/run_tests

@@ -1,32 +1,5 @@
-#!/usr/bin/env node
+#!/bin/sh
 
-'use strict';
+TESTS=${1:-"test test/outbound test/plugins/auth test/plugins/queue test/plugins"}
 
-let reporter;
-try {
-    reporter = require('nodeunit-x').reporters.default;
-}
-catch (e) {
-    console.log(`Error: ${e.message}
-
-Cannot find nodeunit module. Please run the following:
-
-    npm install\n`);
-
-    process.exit();
-}
-
-process.chdir(__dirname);
-
-let tests = [
-    'tests', 'tests/outbound', 'tests/plugins',
-    'tests/plugins/auth', 'tests/plugins/queue'
-];
-
-if (process.argv[2]) {
-    console.log("Running tests: ", process.argv.slice(2));
-    tests = process.argv.slice(2);
-}
-reporter.run(tests, undefined, function (err) {
-    process.exit(((err) ? 1 : 0));
-});
+npx mocha --exit $TESTS