- prefix node builtin deps with node:

- conn: replace a fn with arrow function
- contrib/plugin2npm.sh: fix path to package.json
- config/plugins: consistent formatting

Changes.md

@@ -8,17 +8,20 @@
 
 #### Changed
 
+- prefix node libs with 'node:' #3359
 - .gitignore: add config/me and config/*.pem
 - auth_base: enable disabling constrain_sender at runtime #3298
 - auth_base: skip constrain_sender when auth user has no domain #3319
 - avg: repackaged as NPM module #3347
 - bounce: repackaged plugin as NPM module #3341
 - clamd: repackaged plugin as NPM module
+- config/plugins: consistent formatting #3359
 - connection: check remote is connected before queue #3338
   - improve log message for queue* hooks, fixes #2998
   - support IPv6 when setting remote.is_private #3295
   - in setTLS, replace forEach with for...of
   - NOTE: remove a handful of 3.0 sunset property names #3315
+- contrib/plugin2npm.sh: fix path to package.json #3359
 - deps: bump all versions to latest #3303, #3344
 - dkim: repackaged as NPM module #3311
 - esets: repackaged as NPM module #3353

bin/haraka

@@ -3,13 +3,13 @@
 // this script takes inspiration from:
 // https://github.com/tnantoka/LooseLeaf/blob/master/bin/looseleaf
 
-const child = require('child_process');
-const fs   = require('fs');
-const net  = require('net');
-const nopt = require('nopt');
-const path = require('path');
-const os   = require('os');
+const child = require('node:child_process');
+const fs   = require('node:fs');
+const net  = require('node:net');
+const path = require('node:path');
+const os   = require('node:os');
 
+const nopt = require('nopt');
 const utils   = require('haraka-utils');
 const sprintf = require('sprintf-js').sprintf;
 const base = path.join(__dirname, '..');

config/plugins

@@ -1,71 +1,72 @@
 # This file lists plugins that Haraka will run
 #
 # Plugin ordering often matters, run 'haraka -o -c /path/to/haraka/config'
-# to see the order plugins (and their hooks) will run in.
+# to see the order plugins (and their hooks) will run.
 #
-# To see a list of all plugins, run 'haraka -l'
+# To see a list of installed plugins, run 'haraka -l'
 #
-# To see the help docs for a particular plugin, run 'haraka -h plugin.name'
+# The plugin registry: https://github.com/haraka/Haraka/blob/master/Plugins.md
+#
+# To see the docs for a plugin, run 'haraka -h plugin.name'
 
-#status
-#process_title
-# Log to syslog (see 'haraka -h syslog')
+# status
+# process_title
 # syslog
+# watch
 
 # CONNECT
-#toobusy
-#karma
-#relay
-# control which IPs, rDNS hostnames, HELO hostnames, MAIL FROM addresses, and
-# RCPT TO address you accept mail from. See 'haraka -h access'.
+# ----------
+# toobusy
+# karma
+# relay
 # access
 # p0f
 # geoip
 # asn
 # fcrdns
-# block & allow lists (see config/dns-list.ini)
-dns-list
+# dns-list
 
 # HELO
-#early_talker
-# see config/helo.checks.ini for configuration
-helo.checks
-# see 'haraka -h tls' for config instructions before enabling!
+# ----------
+# early_talker
+# helo.checks
+# see 'haraka -h tls' before enabling!
 # tls
 #
 # AUTH plugins require TLS before AUTH is advertised, see
 #     https://github.com/haraka/Haraka/wiki/Require-SSL-TLS
+# ----------
 # auth/flat_file
 # auth/auth_proxy
 # auth/auth_ldap
 
 # MAIL FROM
-# Only accept mail where the MAIL FROM domain is resolvable to an MX record
+# ----------
 mail_from.is_resolvable
-#spf
+# spf
 
 # RCPT TO
-# At least one rcpt_to plugin is REQUIRED for inbound email. The simplest
-# plugin is in_host_list, see 'haraka -h rcpt_to.in_host_list' to configure.
+# ----------
+# At least one rcpt_to plugin is REQUIRED for inbound email.
 rcpt_to.in_host_list
-#qmail-deliverable
-#rcpt_to.ldap
-#rcpt_to.routes
+# qmail-deliverable
+# rcpt_to.ldap
+# rcpt_to.routes
 
 # DATA
-#bounce
-# Check mail headers are valid
-headers
-#uribl
-#attachment
-#clamd
-#spamassassin
-#dkim
-#limit
+# ----------
+# attachment
+# bounce
+# clamd
+# dkim
+# headers
+# limit
+# rspamd
+# spamassassin
+# uribl
 
 # QUEUE
+# ----------
 # queues: discard  qmail-queue  quarantine  smtp_forward  smtp_proxy
 # Queue mail via smtp - see config/smtp_forward.ini for where your mail goes
 queue/smtp_forward
-
-#watch

connection.js

@@ -1,10 +1,9 @@
 'use strict';
 // a single connection
 
-// node.js built-in libs
-const dns         = require('dns');
-const net         = require('net');
-const os          = require('os');
+const dns         = require('node:dns');
+const net         = require('node:net');
+const os          = require('node:os');
 
 // npm libs
 const ipaddr      = require('ipaddr.js');
@@ -959,7 +958,6 @@ class Connection {
         })
     }
     mail_respond (retval, msg) {
-        const self = this;
         if (!this.transaction) {
             this.logerror("mail_respond found no transaction!");
             return;
@@ -974,12 +972,12 @@ class Connection {
             }
         );
 
-        function store_results (action) {
+        const store_results = (action) => {
             let addr = sender.format();
             if (addr.length > 2) {  // all but null sender
                 addr = addr.substr(1, addr.length -2); // trim off < >
             }
-            self.transaction.results.add({name: 'mail_from'}, {
+            this.transaction.results.add({name: 'mail_from'}, {
                 action,
                 code: constants.translate(retval),
                 address: addr,
@@ -990,25 +988,25 @@ class Connection {
             case constants.deny:
                 this.respond(550, msg || `${dmsg} denied`, () => {
                     store_results('reject');
-                    self.reset_transaction();
+                    this.reset_transaction();
                 });
                 break;
             case constants.denydisconnect:
                 this.respond(550, msg ||  `${dmsg} denied`, () => {
                     store_results('reject');
-                    self.disconnect();
+                    this.disconnect();
                 });
                 break;
             case constants.denysoft:
                 this.respond(450, msg || `${dmsg} denied`, () => {
                     store_results('tempfail');
-                    self.reset_transaction();
+                    this.reset_transaction();
                 });
                 break;
             case constants.denysoftdisconnect:
                 this.respond(450, msg || `${dmsg} denied`, () => {
                     store_results('tempfail');
-                    self.disconnect();
+                    this.disconnect();
                 });
                 break;
             default:

contrib/plugin2npm.sh

@@ -32,7 +32,8 @@ if grep template "$PLUGIN_REPO/README.md"; then
         -e "s/template\.ini/$1.ini/" \
         "$PLUGIN_REPO/test/index.js"
 
-    sed -i '' -e "s/template/${1}/g" package.json
+    sed -i '' -e "s/template/${1}/g" "$PLUGIN_REPO/package.json"
+
     sed -i '' \
         -e "s/_template/_${1}/g" \
         -e "s/template\.ini/$1.ini/" \

endpoint.js

@@ -1,7 +1,7 @@
 'use strict';
 // Socket address parser/formatter and server binding helper
 
-const fs = require('fs');
+const fs = require('node:fs');
 const sockaddr = require('sockaddr');
 
 module.exports = function endpoint (addr, defaultPort) {

host_pool.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const net    = require('net');
+const net    = require('node:net');
 const utils  = require('haraka-utils');
 
 /* HostPool:

line_socket.js

@@ -1,7 +1,7 @@
 'use strict';
 // A subclass of Socket which reads data by line
 
-const net   = require('net');
+const net   = require('node:net');
 const utils = require('haraka-utils');
 
 const tls_socket = require('./tls_socket');

logger.js

@@ -1,8 +1,8 @@
 'use strict';
 // Log class
 
-const util      = require('util');
-const tty       = require('tty');
+const util      = require('node:util');
+const tty       = require('node:tty');
 
 const config    = require('haraka-config');
 const constants = require('haraka-constants');

outbound/fsync_writestream.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const fs = require('fs');
+const fs = require('node:fs');
 
 class FsyncWriteStream extends fs.WriteStream {
     constructor (path, options) {

outbound/hmail.js

@@ -1,9 +1,9 @@
 'use strict';
 
-const events       = require('events');
-const fs           = require('fs');
-const dns          = require('dns');
-const path         = require('path');
+const events       = require('node:events');
+const fs           = require('node:fs');
+const dns          = require('node:dns');
+const path         = require('node:path');
 
 const { Address } = require('address-rfc2821');
 const config      = require('haraka-config');

outbound/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const fs          = require('fs');
-const path        = require('path');
+const fs          = require('node:fs');
+const path        = require('node:path');
 
 const async       = require('async');
 const { Address } = require('address-rfc2821');

outbound/qfile.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const os = require('os');
+const os = require('node:os');
 const platform_dot = `${(['win32','win64'].includes(process.platform)) ? '' : '__tmp__'}.`;
 
 let QFILECOUNTER = 0;

outbound/queue.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const child_process = require('child_process');
-const fs          = require('fs');
-const path        = require('path');
+const child_process = require('node:child_process');
+const fs          = require('node:fs');
+const path        = require('node:path');
 
 const async       = require('async');
 const { Address } = require('address-rfc2821');

outbound/tls.js

@@ -1,12 +1,13 @@
 'use strict';
 
-const net          = require('net')
+const net          = require('node:net')
 
-const logger       = require('../logger');
-const tls_socket   = require('../tls_socket');
 const config       = require('haraka-config');
 const hkredis      = require('haraka-plugin-redis');
 
+const logger       = require('../logger');
+const tls_socket   = require('../tls_socket');
+
 const inheritable_opts = [
     'key', 'cert', 'ciphers', 'minVersion', 'dhparam',
     'requestCert', 'honorCipherOrder', 'rejectUnauthorized',

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');
@@ -480,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 = [];
@@ -570,11 +568,16 @@ function log_run_item (item, hook, retval, object, params, msg) {
 
 function sanitize (msg) {
     if (!msg) return ''
-    const sanitized = { ...msg }; // copy the message
-    for (const priv of ['password','auth_pass']) {
-        delete sanitized[priv]
+    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)
     }
-    return sanitized
+    logger.logerror(`what is ${msg} (typeof ${typeof msg})?`)
 }
 
 function is_deny_retval (val) {

plugins/auth/auth_base.js

@@ -4,7 +4,7 @@
 
 // Note: You can disable setting `connection.notes.auth_passwd` by `plugin.blankout_password = true`
 
-const crypto = require('crypto');
+const crypto = require('node:crypto');
 
 const tlds   = require('haraka-tld')
 const utils  = require('haraka-utils');

plugins/auth/auth_vpopmaild.js

@@ -1,6 +1,6 @@
 // Auth against vpopmaild
 
-const net = require('net');
+const net = require('node:net');
 
 exports.register = function () {
     this.inherits('auth/auth_base');