Haraka 3.2.1 → 3.3.1

package/eslint.config.mjs

@@ -1,30 +1,2 @@
-import globals from 'globals'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-import js from '@eslint/js'
-import { FlatCompat } from '@eslint/eslintrc'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-  recommendedConfig: js.configs.recommended,
-  allConfig: js.configs.all,
-})
-
-export default [
-  ...compat.extends('@haraka'),
-  {
-    languageOptions: {
-      globals: {
-        ...globals.node,
-      },
-    },
-
-    rules: {
-      'prefer-template': 'warn',
-      'no-unneeded-ternary': 1,
-      'no-unused-vars': 0,
-    },
-  },
-]
+import haraka from '@haraka/eslint-config'
+export default [...haraka]

package/haraka.js

@@ -12,7 +12,7 @@ if (!process.env.HARAKA) {
 process.env.HARAKA = process.env.HARAKA || path.resolve('.')
 try {
     require.paths.push(makePathJoin())
-} catch (e) {
+} catch {
     process.env.NODE_PATH = process.env.NODE_PATH ? `${process.env.NODE_PATH}:${makePathJoin()}` : makePathJoin()
     require('module')._initPaths() // Horrible hack
 }
@@ -60,7 +60,7 @@ process.on('SIGHUP', () => {
     server.flushQueue()
 })
 
-process.on('exit', (code) => {
+process.on('exit', () => {
     if (shutting_down) return
     const [, filename] = process.argv
     process.title = path.basename(filename, '.js')

package/line_socket.js

@@ -1,40 +1,13 @@
 'use strict'
-// A subclass of Socket which reads data by line
+// Back-compat shim. The Socket class lives in haraka-net-utils as LineSocket;
+// the line-processing helper is `add_line_processor` there. The connect()
+// helper stays here because it depends on Haraka's tls_socket.
 
-const net = require('node:net')
-const utils = require('haraka-utils')
+const { LineSocket, add_line_processor } = require('haraka-net-utils')
 
 const tls_socket = require('./tls_socket')
 
-class Socket extends net.Socket {
-    constructor(options) {
-        super(options)
-        setup_line_processor(this)
-    }
-}
-
-function setup_line_processor(socket) {
-    let current_data = ''
-
-    socket.on('data', function on_socket_data(data) {
-        current_data += data
-        let results
-        while ((results = utils.line_regexp.exec(current_data))) {
-            const this_line = results[1]
-            current_data = current_data.slice(this_line.length)
-            socket.emit('line', this_line)
-        }
-    })
-
-    socket.on('end', function on_socket_end() {
-        if (current_data.length) {
-            socket.emit('line', current_data)
-        }
-        current_data = ''
-    })
-}
-
-exports.Socket = Socket
+exports.Socket = LineSocket
 
 // New interface - uses TLS
 exports.connect = (port, host) => {
@@ -46,6 +19,6 @@ exports.connect = (port, host) => {
         options.host = host
     }
     const sock = tls_socket.connect(options)
-    setup_line_processor(sock)
+    add_line_processor(sock)
     return sock
 }

package/outbound/hmail.js

@@ -7,7 +7,7 @@ const dns = require('node:dns')
 const net = require('node:net')
 const path = require('node:path')
 
-const { Address } = require('../address')
+const { Address } = require('@haraka/email-address')
 const config = require('haraka-config')
 const constants = require('haraka-constants')
 const DSN = require('haraka-dsn')
@@ -24,7 +24,7 @@ const _qfile = require('./qfile')
 const outbound = require('./index')
 const obtls = require('./tls')
 
-const FsyncWriteStream = require('./fsync_writestream')
+const FsyncWriteStream = utils.FsyncWriteStream
 
 let queue_dir
 let temp_fail_queue
@@ -713,7 +713,7 @@ class HMailItem extends events.EventEmitter {
                             break
                         case 'CRAM-MD5':
                             // The response is our challenge
-                            return send_command(cram_md5_response(mx.auth_user, mx.auth_pass, resp))
+                            return send_command(utils.cram_md5_response(mx.auth_user, mx.auth_pass, resp))
                         default:
                         // This shouldn't happen...
                     }
@@ -975,7 +975,7 @@ class HMailItem extends events.EventEmitter {
             data_stream.on('error', (err) => {
                 cb(err)
             })
-        } catch (err) {
+        } catch {
             this.populate_bounce_message_with_headers(from, to, reason, header, cb)
         }
     }
@@ -1247,7 +1247,7 @@ class HMailItem extends events.EventEmitter {
         plugins.run_hooks('bounce', this, err)
     }
 
-    bounce_respond(retval, msg) {
+    bounce_respond(retval) {
         if (retval !== constants.cont) {
             this.loginfo(`Plugin responded with: ${retval}. Not sending bounce.`)
             return this.discard() // calls next_cb
@@ -1272,7 +1272,7 @@ class HMailItem extends events.EventEmitter {
                 from,
                 recip,
                 data_lines.join(''),
-                (code, msg2) => {
+                (code) => {
                     if (code === constants.deny) {
                         // failed to even queue the mail
                         return self.double_bounce('Unable to queue the bounce message. Not sending bounce!')
@@ -1466,20 +1466,18 @@ class HMailItem extends events.EventEmitter {
             rs.on('error', (err) => {
                 err_handler(err, 'hmail.data_stream reader')
             })
-            rs.on('end', () => {
-                ws.on('close', async () => {
-                    try {
-                        const dest_path = path.join(queue_dir, fname)
-                        await fs.rename(tmp_path, dest_path)
-                        const split_mail = new HMailItem(fname, dest_path, hmail.notes)
-                        split_mail.once('ready', () => {
-                            cb(split_mail)
-                        })
-                    } catch (err) {
-                        err_handler(err, 'tmp file rename')
-                    }
-                })
-                ws.destroySoon()
+            rs.on('end', async () => {
+                try {
+                    await ws.close()
+                    const dest_path = path.join(queue_dir, fname)
+                    await fs.rename(tmp_path, dest_path)
+                    const split_mail = new HMailItem(fname, dest_path, hmail.notes)
+                    split_mail.once('ready', () => {
+                        cb(split_mail)
+                    })
+                } catch (err) {
+                    err_handler(err, 'tmp file close/rename')
+                }
             })
         }
 
@@ -1504,12 +1502,3 @@ module.exports.obtls = obtls
 logger.add_log_methods(HMailItem)
 
 const smtp_regexp = /^([2345]\d\d)([ -])#?(?:(\d\.\d\.\d)\s)?(.*)/
-
-function cram_md5_response(username, password, challenge) {
-    const crypto = require('crypto')
-    const c = utils.unbase64(challenge)
-    const hmac = crypto.createHmac('md5', password)
-    hmac.update(c)
-    const digest = hmac.digest('hex')
-    return utils.base64(`${username} ${digest}`)
-}

package/outbound/index.js

@@ -3,7 +3,7 @@
 const fs = require('node:fs/promises')
 const path = require('node:path')
 
-const { Address } = require('../address')
+const { Address } = require('@haraka/email-address')
 const config = require('haraka-config')
 const constants = require('haraka-constants')
 const net_utils = require('haraka-net-utils')
@@ -13,7 +13,7 @@ const ResultStore = require('haraka-results')
 const logger = require('../logger')
 const trans = require('../transaction')
 const plugins = require('../plugins')
-const FsyncWriteStream = require('./fsync_writestream')
+const FsyncWriteStream = utils.FsyncWriteStream
 
 const obc = require('./config')
 const queuelib = require('./queue')
@@ -241,7 +241,7 @@ exports.send_trans_email = function (transaction, next) {
         transaction.results = new ResultStore(connection)
     }
 
-    connection.pre_send_trans_email_respond = async (retval) => {
+    connection.pre_send_trans_email_respond = async () => {
         const deliveries = get_deliveries(transaction)
         const hmails = []
         const ok_paths = []

package/outbound/queue.js

@@ -4,11 +4,12 @@ const child_process = require('node:child_process')
 const fs = require('node:fs/promises')
 const path = require('node:path')
 
-const { Address } = require('../address')
+const { Address } = require('@haraka/email-address')
 const config = require('haraka-config')
+const utils = require('haraka-utils')
 
 const logger = require('../logger')
-const TimerQueue = require('./timer_queue')
+const TimerQueue = utils.TimerQueue
 const HMailItem = require('./hmail')
 const obc = require('./config')
 const _qfile = require('./qfile')
@@ -101,7 +102,7 @@ const delivery_queue = (exports.delivery_queue = new Queue(async (hmail) => {
     })
 }))
 
-const temp_fail_queue = (exports.temp_fail_queue = new TimerQueue())
+const temp_fail_queue = (exports.temp_fail_queue = new TimerQueue(1000, { logger }))
 
 let queue_count = 0
 
@@ -111,7 +112,7 @@ exports.list_queue = async () => {
     return exports._load_cur_queue(null, exports._list_file)
 }
 
-exports._stat_file = async (file) => {
+exports._stat_file = async () => {
     queue_count++
 }
 
@@ -180,7 +181,9 @@ exports.rename_to_actual_pid = async (file, parts) => {
         await fs.rename(path.join(exports.queue_dir, file), path.join(exports.queue_dir, new_filename))
         return new_filename
     } catch (err) {
-        throw new Error(`Unable to rename queue file: ${file} to ${new_filename} : ${err}`)
+        throw new Error(`Unable to rename queue file: ${file} to ${new_filename}`, {
+            cause: err,
+        })
     }
 }
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "Matt Sergeant <helpme@gmail.com> (http://baudehlo.com/)",
+  "author": "Matt Sergeant <helpme@gmail.com>",
   "name": "Haraka",
   "license": "MIT",
   "description": "An SMTP Server project.",
@@ -9,7 +9,7 @@
     "server",
     "email"
   ],
-  "version": "3.2.1",
+  "version": "3.3.1",
   "homepage": "http://haraka.github.io",
   "repository": {
     "type": "git",
@@ -20,77 +20,80 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@haraka/email-address": "~3.1.3",
-    "haraka-config": "~1.6.0",
-    "haraka-constants": "~1.0.7",
+    "@haraka/email-address": "~3.1.6",
+    "haraka-config": "~1.6.3",
+    "haraka-constants": "~1.0.8",
     "haraka-dsn": "~1.2.0",
-    "haraka-email-message": "~1.3.3",
-    "haraka-net-utils": "~1.8.2",
+    "haraka-email-message": "~1.4.0",
+    "haraka-net-utils": "~1.9.2",
     "haraka-notes": "~1.1.3",
-    "haraka-plugin-redis": "~2.0.11",
-    "haraka-results": "~2.3.0",
-    "haraka-tld": "~1.3.4",
-    "haraka-utils": "~1.1.4",
+    "haraka-plugin-redis": "~2.1.0",
+    "haraka-results": "~2.4.0",
+    "haraka-tld": "~1.3.6",
+    "haraka-utils": "~2.2.1",
     "ipaddr.js": "~2.4.0",
-    "node-gyp": "~12.3.0",
-    "nopt": "~10.0.0",
-    "redis": "~5.12.1",
-    "semver": "~7.8.0"
+    "node-gyp": "~12.4.0",
+    "nopt": "~10.0.1",
+    "redis": "~6.0.0",
+    "semver": "~7.8.4"
   },
   "optionalDependencies": {
     "@haraka/ocsp": "~1.2.0",
-    "haraka-plugin-access": "~1.2.0",
-    "haraka-plugin-aliases": "~1.0.3",
-    "haraka-plugin-asn": "~2.1.0",
-    "haraka-plugin-attachment": "~1.2.0",
-    "haraka-plugin-bounce": "~2.1.2",
-    "haraka-plugin-clamd": "~1.0.2",
+    "haraka-plugin-access": "~1.4.0",
+    "haraka-plugin-aliases": "~1.1.0",
+    "haraka-plugin-asn": "~2.2.0",
+    "haraka-plugin-attachment": "~1.2.1",
+    "haraka-plugin-bounce": "~2.2.1",
+    "haraka-plugin-clamd": "~1.0.3",
     "haraka-plugin-dcc": "~1.0.3",
     "haraka-plugin-dkim": "~1.2.0",
-    "haraka-plugin-dns-list": "~1.2.4",
+    "haraka-plugin-dns-list": "~1.3.0",
     "haraka-plugin-early_talker": "~1.0.2",
-    "haraka-plugin-fcrdns": "~1.1.2",
+    "haraka-plugin-fcrdns": "~1.2.1",
     "haraka-plugin-geoip": "~1.1.2",
-    "haraka-plugin-greylist": "~1.1.1",
-    "haraka-plugin-headers": "~1.1.2",
-    "haraka-plugin-helo.checks": "~1.1.1",
-    "haraka-plugin-karma": "~2.4.1",
-    "haraka-plugin-known-senders": "~1.1.4",
-    "haraka-plugin-limit": "~1.2.7",
-    "haraka-plugin-mail_from.is_resolvable": "~1.2.0",
-    "haraka-plugin-messagesniffer": "~1.0.1",
-    "haraka-plugin-qmail-deliverable": "~1.3.5",
+    "haraka-plugin-greylist": "~1.2.1",
+    "haraka-plugin-headers": "~1.2.0",
+    "haraka-plugin-helo.checks": "~1.1.3",
+    "haraka-plugin-karma": "~2.5.2",
+    "haraka-plugin-known-senders": "~1.2.0",
+    "haraka-plugin-limit": "~1.3.2",
+    "haraka-plugin-mail_from.is_resolvable": "~1.3.0",
+    "haraka-plugin-messagesniffer": "~1.0.2",
+    "haraka-plugin-qmail-deliverable": "~1.4.0",
     "haraka-plugin-relay": "~1.0.2",
     "haraka-plugin-rspamd": "~1.6.0",
-    "haraka-plugin-spamassassin": "~1.0.4",
-    "haraka-plugin-spf": "~1.2.11",
-    "haraka-plugin-syslog": "~1.1.0",
-    "haraka-plugin-uribl": "~1.0.10"
+    "haraka-plugin-spamassassin": "~1.1.0",
+    "haraka-plugin-spf": "~1.3.0",
+    "haraka-plugin-syslog": "~1.1.2",
+    "haraka-plugin-uribl": "~2.0.0"
   },
   "devDependencies": {
-    "@haraka/eslint-config": "~2.0.4",
-    "haraka-test-fixtures": "~1.6.0",
-    "mock-require": "~3.0.3"
+    "@haraka/eslint-config": "~3.0.0",
+    "haraka-test-fixtures": "^1.7.1",
+    "mock-require": "~3.0.3",
+    "toobusy-js": "^0.5.1"
   },
   "bugs": {
     "mail": "haraka.mail@gmail.com",
     "url": "https://github.com/haraka/Haraka/issues"
   },
   "bin": {
-    "haraka": "./bin/haraka",
-    "haraka_grep": "./bin/haraka_grep"
+    "haraka": "bin/haraka",
+    "haraka_grep": "bin/haraka_grep"
   },
   "scripts": {
+    "prepare": "git rev-parse --git-dir >/dev/null 2>&1 && git config core.hooksPath .githooks || true",
     "format": "npm run prettier:fix && npm run lint:fix",
-    "lint": "npx eslint *.js outbound plugins plugins/*/*.js test test/*/*.js test/*/*/*.js bin/haraka",
-    "lint:fix": "npx eslint --fix *.js outbound plugins plugins/*/*.js test test/*/*.js test/*/*/*.js bin/haraka",
+    "lint": "npx eslint *.js outbound plugins plugins/*/*.js test test/*/*.js test/*/*/*.js",
+    "lint:fix": "npx eslint --fix *.js outbound plugins plugins/*/*.js test test/*/*.js test/*/*/*.js",
     "prettier": "npx prettier . --check",
     "prettier:fix": "npx prettier . --write --log-level=warn",
+    "qlty": "qlty smells --all",
     "test": "sh ./run_tests",
+    "test:coverage": "node --test --test-concurrency=1 --experimental-test-coverage --test-coverage-include=*.js --test-coverage-include=plugins/**/*.js --test-coverage-include=outbound/*.js",
+    "test:coverage:lcov": "mkdir -p coverage && node --test --test-concurrency=1 --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info --test-coverage-include=*.js --test-coverage-include=plugins/**/*.js --test-coverage-include=outbound/*.js",
     "versions": "npx npm-dep-mgr check",
-    "versions:fix": "npx npm-dep-mgr update",
-    "test:coverage": "node --test --test-concurrency=1 --experimental-test-coverage",
-    "test:coverage:lcov": "mkdir -p coverage && node --test --test-concurrency=1 --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info"
+    "versions:fix": "npx npm-dep-mgr update"
   },
   "prettier": {
     "singleQuote": true,

package/plugins/auth/auth_proxy.js

@@ -1,7 +1,5 @@
 // Proxy AUTH requests selectively by domain
 
-const net = require('node:net')
-
 const utils = require('haraka-utils')
 const net_utils = require('haraka-net-utils')
 
@@ -56,8 +54,12 @@ exports.try_auth_proxy = function (connection, hosts, user, passwd, cb) {
     }
 
     const self = this
-    let [host, port] = hosts.shift().split(':') /* eslint prefer-const: 0 */
-    if (!port) port = 25
+    const ep = net_utils.endpoint(hosts.shift(), 25)
+    if (ep instanceof Error) {
+        connection.logerror(this, `invalid host: ${ep.message}`)
+        return this.try_auth_proxy(connection, hosts, user, passwd, cb)
+    }
+    const { host, port } = ep
     let methods = []
     let auth_complete = false
     let auth_success = false
@@ -134,6 +136,7 @@ exports.try_auth_proxy = function (connection, hosts, user, passwd, cb) {
                     // certificate to negotiate TLS, so always STARTTLS when
                     // the backend offers it. The local key/cert are only
                     // attached if configured (mutual TLS), not required.
+                    /* eslint no-useless-assignment: 0 */
                     key = self.config.get(self.tls_cfg.main.key || 'tls_key.pem', 'binary')
                     cert = self.config.get(self.tls_cfg.main.cert || 'tls_cert.pem', 'binary')
                     this.on('secure', () => {

package/plugins/block_me.js

@@ -53,7 +53,7 @@ exports.hook_data_post = function (next, connection) {
             connection.logerror(this, `Unable to append to mail_from.blocklist: ${err}`)
             return
         }
-        fs.write(fd, `${to_block}\n`, null, 'UTF-8', (err2, written) => {
+        fs.write(fd, `${to_block}\n`, null, 'UTF-8', () => {
             fs.close(fd)
         })
     })

package/plugins/delay_deny.js

@@ -101,7 +101,7 @@ exports.hook_deny = function (next, connection, params) {
     }
 }
 
-exports.hook_rcpt_ok = function (next, connection, rcpt) {
+exports.hook_rcpt_ok = function (next, connection) {
     const transaction = connection?.transaction
     if (!transaction) return next()
 

package/plugins/queue/qmail-queue.js

@@ -87,7 +87,7 @@ exports.hook_queue = function (next, connection) {
         }
         plugin.loginfo('Message Stream sent to qmail. Now sending envelope')
         const buf = plugin.build_envelope(connection.transaction)
-        qmail_queue.stdout.on('error', (err) => {}) // stdout throws an error on close
+        qmail_queue.stdout.on('error', () => {}) // stdout throws an error on close
         qmail_queue.stdout.end(buf)
     })
 }

package/plugins/queue/quarantine.js

@@ -10,7 +10,7 @@ exports.register = function () {
     this.register_hook('queue_outbound', 'quarantine')
 }
 
-exports.hook_init_master = function (next, server) {
+exports.hook_init_master = function (next) {
     this.init_quarantine_dir(() => {
         this.clean_tmp_directory(next)
     })
@@ -62,8 +62,8 @@ exports.init_quarantine_dir = function (done) {
     const tmp_dir = path.join(this.get_base_dir(), 'tmp')
     fs.promises
         .mkdir(tmp_dir, { recursive: true })
-        .then((made) => this.loginfo(`created ${tmp_dir}`))
-        .catch((err) => this.logerror(`Unable to create ${tmp_dir}`))
+        .then(() => this.loginfo(`created ${tmp_dir}`))
+        .catch(() => this.logerror(`Unable to create ${tmp_dir}`))
         .finally(done)
 }
 
@@ -98,11 +98,11 @@ exports.quarantine = function (next, connection) {
     // final destination.
     fs.promises
         .mkdir(msg_dir, { recursive: true })
-        .catch((err) => {
+        .catch(() => {
             connection.logerror(this, `Error creating directory: ${msg_dir}`)
             next()
         })
-        .then((ok) => {
+        .then(() => {
             const ws = fs.createWriteStream(tmp_path)
 
             ws.on('error', (err) => {

package/plugins/queue/smtp_bridge.js

@@ -21,7 +21,7 @@ exports.hook_data_post = (next, connection) => {
     return next()
 }
 
-exports.hook_get_mx = function (next, hmail, domain) {
+exports.hook_get_mx = function (next, hmail) {
     let priority = 10
     if (this.cfg.main.priority) {
         priority = this.cfg.main.priority

package/plugins/queue/smtp_proxy.js

@@ -41,7 +41,7 @@ exports.load_smtp_proxy_ini = function () {
     }
 }
 
-exports.hook_mail = function (next, connection, params) {
+exports.hook_mail = function (next, connection) {
     const c = this.cfg.main
     connection.loginfo(
         this,
@@ -70,7 +70,7 @@ exports.hook_mail = function (next, connection, params) {
             delete connection.notes.smtp_client
         })
 
-        smtp_client.on('bad_code', (code, msg) => {
+        smtp_client.on('bad_code', (code) => {
             smtp_client.call_next(code.match(/^4/) ? DENYSOFT : DENY, smtp_client.response.slice())
 
             if (smtp_client.command !== 'rcpt') {

package/plugins/status.js

@@ -136,8 +136,8 @@ exports.queue_inspect = function (cb) {
 exports.queue_discard = function (file, cb) {
     try {
         this.outbound.temp_fail_queue.discard(file)
-    } catch (e) {
-        // we ignore not found error
+    } catch {
+        // ignore not found error
     }
 
     fs.unlink(path.join(this.queue_dir || '', file), () => {

package/plugins/toobusy.js

@@ -29,7 +29,7 @@ exports.loadConfig = function () {
     }
 }
 
-exports.check_busy = function (next, connection) {
+exports.check_busy = function (next) {
     if (!toobusy()) {
         was_busy = false
         return next()

package/plugins.js

@@ -197,11 +197,12 @@ class Plugin {
             __filename: pp,
             __dirname: path.dirname(pp),
             exports: this,
-            setTimeout,
+            fetch,
             clearTimeout,
-            setInterval,
             clearInterval,
             process,
+            setInterval,
+            setTimeout,
             Buffer,
             Math,
             server: plugins.server,
@@ -585,7 +586,7 @@ function get_denyfn(object, hook, params, retval, msg, respond_method) {
         switch (deny_retval) {
             case constants.ok:
                 // Override rejection
-                object.loginfo(`deny(soft?) overriden by deny hook${deny_msg ? ': deny_msg' : ''}`)
+                object.loginfo(`deny(soft?) overridden by deny hook${deny_msg ? ': deny_msg' : ''}`)
                 // Restore hooks_to_run with saved copy so that
                 // any other plugins on this hook can also run.
                 if (object.saved_hooks_to_run.length > 0) {