Haraka 3.1.2 → 3.1.4

package/connection.js

@@ -191,11 +191,7 @@ class Connection {
         })
 
         const ha_list = net.isIPv6(self.remote.ip) ? haproxy_hosts_ipv6 : haproxy_hosts_ipv4
-        if (
-            ha_list.some((element, index, array) => {
-                return ipaddr.parse(self.remote.ip).match(element[0], element[1])
-            })
-        ) {
+        if (ha_list.some((element) => ipaddr.parse(self.remote.ip).match(element[0], element[1]))) {
             self.proxy.allowed = true
             // Wait for PROXY command
             self.proxy.timer = setTimeout(() => {
@@ -302,7 +298,7 @@ class Connection {
         /* eslint no-control-regex: 0 */
         if (/[^\x00-\x7F]/.test(this.current_line)) {
             // See if this is a TLS handshake
-            const buf = Buffer.from(this.current_line.substr(0, 3), 'binary')
+            const buf = Buffer.from(this.current_line.slice(0, 3), 'binary')
             if (
                 buf[0] === 0x16 &&
                 buf[1] === 0x03 &&
@@ -348,10 +344,13 @@ class Connection {
         } else if (this.state === states.LOOP) {
             // Allow QUIT
             if (this.current_line.toUpperCase() === 'QUIT') {
+                this.state = states.PAUSE_SMTP
                 this.cmd_quit()
             } else {
                 this.respond(this.loop_code, this.loop_msg)
             }
+        } else if (this.state === states.PAUSE_SMTP) {
+            // Do nothing
         } else {
             throw new Error(`unknown state ${this.state}`)
         }
@@ -516,9 +515,7 @@ class Connection {
         } else {
             messages = msg.slice()
         }
-        messages = messages.filter((msg2) => {
-            return /\S/.test(msg2)
-        })
+        messages = messages.filter((msg2) => /\S/.test(msg2))
 
         // Multiline AUTH PLAIN as in RFC-4954 page 8.
         if (code === 334 && !messages.length) {
@@ -530,7 +527,7 @@ class Connection {
             if (cfg.uuid.deny_chars) {
                 uuid = (this.transaction || this).uuid
                 if (cfg.uuid.deny_chars > 1) {
-                    uuid = uuid.substr(0, cfg.uuid.deny_chars)
+                    uuid = uuid.slice(0, cfg.uuid.deny_chars)
                 }
             }
         }
@@ -673,10 +670,10 @@ class Connection {
     resume() {
         if (this.state >= states.DISCONNECTING) return
         this.client.resume()
-        if (this.prev_state) {
+        if (this.prev_state && this.state === states.PAUSE_DATA) {
             this.state = this.prev_state
-            this.prev_state = null
         }
+        this.prev_state = null
         setImmediate(() => this._process_data())
     }
     /////////////////////////////////////////////////////////////////////////////
@@ -793,12 +790,12 @@ class Connection {
                     greeting = [...cfg.message.greeting]
                     greeting[0] = `${this.local.host} ESMTP ${greeting[0]}`
                     if (cfg.uuid.banner_chars) {
-                        greeting[0] += ` (${this.uuid.substr(0, cfg.uuid.banner_chars)})`
+                        greeting[0] += ` (${this.uuid.slice(0, cfg.uuid.banner_chars)})`
                     }
                 } else {
                     greeting = `${this.local.host} ESMTP ${this.local.info} ready`
                     if (cfg.uuid.banner_chars) {
-                        greeting += ` (${this.uuid.substr(0, cfg.uuid.banner_chars)})`
+                        greeting += ` (${this.uuid.slice(0, cfg.uuid.banner_chars)})`
                     }
                 }
                 this.respond(220, msg || greeting)
@@ -964,7 +961,7 @@ class Connection {
             let addr = sender.format()
             if (addr.length > 2) {
                 // all but null sender
-                addr = addr.substr(1, addr.length - 2) // trim off < >
+                addr = addr.slice(1, -1) // trim off < >
             }
             this.transaction.results.add(
                 { name: 'mail_from' },
@@ -1012,7 +1009,7 @@ class Connection {
 
         const addr = rcpt.format()
         const recipient = {
-            address: addr.substr(1, addr.length - 2),
+            address: addr.slice(1, -1),
             action,
         }
 
@@ -1446,10 +1443,9 @@ class Connection {
         }
 
         // assemble the new header
-        let header = [this.local.host]
-        header = header.concat(this.notes.authentication_results)
+        let header = [this.local.host, ...this.notes.authentication_results]
         if (has_tran === true) {
-            header = header.concat(this.transaction.notes.authentication_results)
+            header = [...header, ...this.transaction.notes.authentication_results]
         }
         if (header.length === 1) return '' // no results
         return header.join(';\r\n\t')

package/docs/CoreConfig.md

@@ -30,9 +30,6 @@ The list of plugins to load
   - daemonize - enable this to cause Haraka to fork into the background on start-up (default: 0)
   - daemon_log_file - (default: /var/log/haraka.log) where to redirect stdout/stderr when daemonized
   - daemon_pid_file - (default: /var/run/haraka.pid) where to write a PID file to
-  - spool_dir - (default: none) directory to create temporary spool files in
-  - spool_after - (default: -1) if message exceeds this size in bytes, then spool the message to disk
-    specify -1 to disable spooling completely or 0 to force all messages to be spooled to disk.
   - graceful_shutdown - (default: false) enable this to wait for sockets on shutdown instead of closing them quickly
   - force_shutdown_timeout - (default: 30) number of seconds to wait for a graceful shutdown
 
@@ -45,6 +42,8 @@ The list of plugins to load
 
   See inline comments in connection.ini for the following settings:
 
+  - main.spool_dir
+  - main.spool_after
   - haproxy.hosts_ipv4
   - haproxy.hosts_ipv6
   - headers.\*

package/docs/Plugins.md

@@ -166,7 +166,7 @@ These are the hook and their parameters (next excluded):
 - rcpt_ok (to)
 - data - called at the DATA command
 - data_post - called at the end-of-data marker
-- max_data_exceeded - called when the message exceeds connection.max_bytes
+- max_data_exceeded - called when the message exceeds connection.max.bytes
 - queue - called to queue the mail
 - queue_outbound - called to queue the mail when connection.relaying is set
 - queue_ok - called when a mail has been queued successfully

package/docs/plugins/aliases.md

@@ -97,7 +97,6 @@ WARNING: DO NOT USE THIS PLUGIN WITH queue/smtp_proxy.
 - action (required)
 
   The following is a list of supported actions, and the options they require.
-
   - drop
 
     This action simply drops a message, while pretending everything was
@@ -110,7 +109,6 @@ WARNING: DO NOT USE THIS PLUGIN WITH queue/smtp_proxy.
     "to" option. A note about matching in addition to the note
     about wildcard '-' above. When we match an alias, we store the
     hostname of the match for a shortcut substitution syntax later.
-
     - to (required)
 
       This option is the full address, or local part at matched hostname

package/docs/plugins/queue/qmail-queue.md

@@ -10,7 +10,6 @@ for both inbound and outbound delivery.
   The path to the `qmail-queue` binary. Default: `/var/qmail/bin/qmail-queue`
 
 - qmail-queue.ini
-
   - enable_outbound=true
 
     Deliver outbound email to qmail. Set to false to use Haraka's

package/docs/tutorials/Migrating_from_v1_to_v2.md

@@ -6,7 +6,7 @@ Streams are an abstraction over a data flow that is provided by Node core and is
 
 For more information about the Stream API, see http://nodejs.org/api/stream.html
 
-Note that when using bundled Haraka plugins, it's very unlikely you will need to change anything. Though you may want to configure `spool_dir` and `spool_after` in `config/smtp.ini`. If you have custom plugins, continue reading.
+Note that when using bundled Haraka plugins, it's very unlikely you will need to change anything. Though you may want to configure `spool_dir` and `spool_after` in `config/smtp.ini` (v2.x), or in `config/connection.ini` (v3.1 or newer). If you have custom plugins, continue reading.
 
 ## Changes To Look For
 

package/logger.js

@@ -255,9 +255,9 @@ logger.log_if_level = (level, key, origin) =>
                 if (Object.hasOwn(data, 'uuid')) logobj.uuid = data.uuid
                 if (data.todo?.uuid) logobj.uuid = data.todo.uuid // outbound/hmail
             } else if (logger.format === logger.formats.LOGFMT && data.constructor === Object) {
-                logobj = Object.assign(logobj, data)
+                logobj = { ...logobj, ...data }
             } else if (logger.format === logger.formats.JSON && data.constructor === Object) {
-                logobj = Object.assign(logobj, data)
+                logobj = { ...logobj, ...data }
             } else if (Object.hasOwn(data, 'uuid')) {
                 // outbound/client_pool
                 logobj.uuid = data.uuid

package/outbound/client_pool.js

@@ -37,7 +37,7 @@ exports.get_client = function (mx, callback) {
         const errMsg = err.message
             ? err.message
             : err instanceof AggregateError
-              ? err.map((e) => e.message).join(', ')
+              ? err.errors.map((e) => e.message).join(', ')
               : util.inspect(err, { depth: 3 })
         callback(errMsg, null)
     })

package/outbound/hmail.js

@@ -1,7 +1,8 @@
 'use strict'
 
 const events = require('node:events')
-const fs = require('node:fs')
+const fs = require('node:fs/promises')
+const { createReadStream } = require('node:fs')
 const dns = require('node:dns')
 const net = require('node:net')
 const path = require('node:path')
@@ -68,20 +69,15 @@ class HMailItem extends events.EventEmitter {
     }
 
     data_stream() {
-        return fs.createReadStream(this.path, {
+        return createReadStream(this.path, {
             start: this.data_start,
             end: this.file_size,
         })
     }
 
-    size_file() {
-        fs.stat(this.path, (err, stats) => {
-            if (err) {
-                // we are fucked... guess I need somewhere for this to go
-                this.logerror(`Error obtaining file size: ${err}`)
-                this.temp_fail('Error obtaining file size')
-                return
-            }
+    async size_file() {
+        try {
+            const stats = await fs.stat(this.path)
             if (stats.size === 0) {
                 this.logerror(`Error reading queue file ${this.filename}: zero bytes`)
                 this.emit('error', `Error reading queue file ${this.filename}: zero bytes`)
@@ -90,74 +86,73 @@ class HMailItem extends events.EventEmitter {
 
             this.file_size = stats.size
             this.read_todo()
-        })
+        } catch (err) {
+            // we are fucked... guess I need somewhere for this to go
+            this.logerror(`Error obtaining file size: ${err}`)
+            this.temp_fail('Error obtaining file size')
+        }
     }
 
-    read_todo() {
-        this._stream_bytes_from(this.path, { start: 0, end: 3 }, (err, bytes) => {
-            if (err) {
-                const errMsg = `Error reading queue file ${this.filename}: ${err}`
-                this.logerror(errMsg)
-                this.temp_fail(errMsg)
-                return
-            }
+    async read_todo() {
+        try {
+            const bytes = await this._stream_bytes_from(this.path, { start: 0, end: 3 })
 
             const todo_len = bytes.readUInt32BE(0)
             this.logdebug(`todo header length: ${todo_len}`)
             this.data_start = todo_len + 4
 
-            this._stream_bytes_from(this.path, { start: 4, end: todo_len + 3 }, (err2, todo_bytes) => {
-                if (todo_bytes.length !== todo_len) {
-                    const wrongLength = `Didn't find right amount of data in todo!: ${err2} ${this.path}`
-                    this.logcrit(wrongLength)
-                    fs.rename(this.path, path.join(queue_dir, `error.${this.filename}`), (err3) => {
-                        if (err3) {
-                            this.logerror(`Error creating (error.${this.filename}): ${err3}`)
-                        }
-                    })
-                    this.emit('error', wrongLength) // Note nothing picks this up yet
-                    return
-                }
-
-                // we read everything
-                const todo_json = todo_bytes.toString().trim()
-                const last_char = todo_json.charAt(todo_json.length - 1)
-                if (last_char !== '}') {
-                    this.emit(
-                        'error',
-                        `invalid todo header end char: ${last_char} at pos ${todo_len} of ${this.filename}`,
-                    )
-                    return
+            const todo_bytes = await this._stream_bytes_from(this.path, { start: 4, end: todo_len + 3 })
+            if (todo_bytes.length !== todo_len) {
+                const wrongLength = `Didn't find right amount of data in todo: ${this.path}`
+                this.logcrit(wrongLength)
+                try {
+                    await fs.rename(this.path, path.join(queue_dir, `error.${this.filename}`))
+                } catch (renameErr) {
+                    this.logerror(`Failed to move corrupt todo file ${this.path} to error queue: ${renameErr}`)
                 }
-                this.todo = JSON.parse(todo_json)
-                this.todo.mail_from = new Address(this.todo.mail_from)
-                this.todo.rcpt_to = this.todo.rcpt_to.map((a) => new Address(a))
-                this.todo.notes = new Notes(this.todo.notes)
-                this.emit('ready')
-            })
-        })
-    }
+                this.emit('error', wrongLength) // Note nothing picks this up yet
+                return
+            }
 
-    _stream_bytes_from(file_path, opts, done) {
-        if (opts.encoding !== undefined) {
-            // passing an encoding to fs.createReadStream will change the type of data returned
-            // ex: instead of returning a buffer, it may return a String, which will cause
-            // Buffer.concat to barf. There's a reason this function has 'bytes' in the name
-            done(new Error('Thar be dragons here! Encode/decode on the result of this function'))
-            return
+            // we read everything
+            const todo_json = todo_bytes.toString().trim()
+            const last_char = todo_json.charAt(todo_json.length - 1)
+            if (last_char !== '}') {
+                this.emit('error', `invalid todo header end char: ${last_char} at pos ${todo_len} of ${this.filename}`)
+                return
+            }
+            this.todo = JSON.parse(todo_json)
+            this.todo.mail_from = new Address(this.todo.mail_from)
+            this.todo.rcpt_to = this.todo.rcpt_to.map((a) => new Address(a))
+            this.todo.notes = new Notes(this.todo.notes)
+            this.emit('ready')
+        } catch (err) {
+            const errMsg = `Error reading queue file ${this.filename}: ${err}`
+            this.logerror(errMsg)
+            this.temp_fail(errMsg)
         }
+    }
 
-        const stream = fs.createReadStream(file_path, opts)
-
-        stream.on('error', done)
+    _stream_bytes_from(file_path, opts) {
+        return new Promise((resolve, reject) => {
+            if (opts.encoding !== undefined) {
+                // passing an encoding to fs.createReadStream will change the type of data returned
+                // ex: instead of returning a buffer, it may return a String, which will cause
+                // Buffer.concat to barf. There's a reason this function has 'bytes' in the name
+                reject(new Error('Thar be dragons here! Encode/decode on the result of this function'))
+                return
+            }
+            const stream = createReadStream(file_path, opts)
+            stream.on('error', reject)
 
-        let raw_bytes = Buffer.alloc(0)
-        stream.on('data', (data) => {
-            raw_bytes = Buffer.concat([raw_bytes, data])
-        })
+            let raw_bytes = Buffer.alloc(0)
+            stream.on('data', (data) => {
+                raw_bytes = Buffer.concat([raw_bytes, data])
+            })
 
-        stream.on('end', () => {
-            done(null, raw_bytes)
+            stream.on('end', () => {
+                resolve(raw_bytes)
+            })
         })
     }
 
@@ -365,7 +360,7 @@ class HMailItem extends events.EventEmitter {
             socket.emit('error', `socket timeout waiting on ${command}`)
         })
 
-        socket.once('error', (err) => {
+        socket.on('error', (err) => {
             if (!processing_mail) return
 
             self.logerror(`Ongoing connection failed to ${host}:${port} : ${err}`)
@@ -1290,7 +1285,7 @@ class HMailItem extends events.EventEmitter {
 
     double_bounce(err) {
         this.lognotice(`Double bounce: ${err}`)
-        fs.unlink(this.path, () => {})
+        fs.unlink(this.path).catch(() => {})
         this.next_cb()
         // TODO: fill this in... ?
         // One strategy is perhaps log to an mbox file. What do other servers do?
@@ -1320,7 +1315,7 @@ class HMailItem extends events.EventEmitter {
         this.refcount--
         if (this.refcount === 0) {
             // Remove the file.
-            fs.unlink(this.path, () => {})
+            fs.unlink(this.path).catch(() => {})
             this.next_cb()
         }
     }
@@ -1349,7 +1344,7 @@ class HMailItem extends events.EventEmitter {
         plugins.run_hooks('deferred', this, { delay, err, ...(extra || {}) })
     }
 
-    deferred_respond(retval, msg, params) {
+    async deferred_respond(retval, msg, params) {
         if (retval !== constants.cont && retval !== constants.denysoft) {
             this.loginfo(`plugin responded with: ${retval}. Not deferring. Deleting mail.`)
             return this.discard() // calls next_cb
@@ -1367,11 +1362,8 @@ class HMailItem extends events.EventEmitter {
         parts.attempts = this.num_failures
         const new_filename = _qfile.name(parts)
 
-        fs.rename(this.path, path.join(queue_dir, new_filename), (err) => {
-            if (err) {
-                return this.bounce(`Error re-queueing email: ${err}`)
-            }
-
+        try {
+            await fs.rename(this.path, path.join(queue_dir, new_filename))
             this.path = path.join(queue_dir, new_filename)
             this.filename = new_filename
 
@@ -1380,7 +1372,9 @@ class HMailItem extends events.EventEmitter {
             temp_fail_queue.add(this.filename, delay, () => {
                 delivery_queue.push(this)
             })
-        })
+        } catch (err) {
+            return this.bounce(`Error re-queueing email: ${err}`)
+        }
     }
 
     // The following handler impacts outgoing mail. It removes the queue file.
@@ -1472,18 +1466,17 @@ class HMailItem extends events.EventEmitter {
                 err_handler(err, 'hmail.data_stream reader')
             })
             rs.on('end', () => {
-                ws.on('close', () => {
-                    const dest_path = path.join(queue_dir, fname)
-                    fs.rename(tmp_path, dest_path, (err) => {
-                        if (err) {
-                            err_handler(err, 'tmp file rename')
-                            return
-                        }
+                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()
             })

package/outbound/index.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const fs = require('node:fs')
+const fs = require('node:fs/promises')
 const path = require('node:path')
 
 const { Address } = require('address-rfc2821')
@@ -42,30 +42,35 @@ const qlfns = [
     'flush_queue',
     'load_pid_queue',
     'ensure_queue_dir',
-    'load_queue',
+    'init_queue',
     'stats',
 ]
 for (const n of qlfns) {
     exports[n] = queuelib[n]
 }
 
-process.on('message', (msg) => {
+process.on('message', async (msg) => {
     if (!msg.event) return
 
-    if (msg.event === 'outbound.load_pid_queue') {
-        exports.load_pid_queue(msg.data)
-        return
-    }
-    if (msg.event === 'outbound.flush_queue') {
-        exports.flush_queue(msg.domain, process.pid)
-        return
-    }
-    if (msg.event === 'outbound.shutdown') {
-        logger.info(exports, 'Shutting down temp fail queue')
-        temp_fail_queue.shutdown()
+    try {
+        if (msg.event === 'outbound.load_pid_queue') {
+            await exports.load_pid_queue(msg.data)
+            return
+        }
+        if (msg.event === 'outbound.flush_queue') {
+            await exports.flush_queue(msg.domain, process.pid)
+            return
+        }
+        if (msg.event === 'outbound.shutdown') {
+            logger.info(exports, 'Shutting down temp fail queue')
+            temp_fail_queue.shutdown()
+            return
+        }
+        // ignores the message
+    } catch (err) {
+        logger.error(exports, err)
         return
     }
-    // ignores the message
 })
 
 exports.send_email = function (from, to, contents, next, options = {}) {
@@ -120,11 +125,11 @@ exports.send_email = function (from, to, contents, next, options = {}) {
         while ((match = utils.line_regexp.exec(contents))) {
             let line = match[1]
             line = line.replace(/\r?\n?$/, '\r\n') // make sure it ends in \r\n
-            if (dot_stuffed === false && line.length >= 3 && line.substr(0, 1) === '.') {
+            if (dot_stuffed === false && line.length >= 3 && line.substring(0, 1) === '.') {
                 line = `.${line}`
             }
             transaction.add_data(Buffer.from(line))
-            contents = contents.substr(match[1].length)
+            contents = contents.substring(match[1].length)
             if (contents.length === 0) {
                 break
             }
@@ -252,7 +257,7 @@ exports.send_trans_email = function (transaction, next) {
             }
         } catch (err) {
             for (let i = 0, l = ok_paths.length; i < l; i++) {
-                fs.unlink(ok_paths[i], () => {})
+                await fs.unlink(ok_paths[i]).catch(() => {})
             }
             transaction.results.add({ name: 'outbound' }, { err })
             if (next) next(constants.denysoft, err)
@@ -279,32 +284,29 @@ exports.process_delivery = function (ok_paths, todo, hmails) {
             flags: constants.WRITE_EXCL,
         })
 
-        ws.on('close', () => {
+        ws.on('close', async () => {
             const dest_path = path.join(queue_dir, fname)
-            fs.rename(tmp_path, dest_path, (err) => {
-                if (err) {
-                    logger.error(exports, `Unable to rename tmp file!: ${err}`)
-                    fs.unlink(tmp_path, () => {})
-                    reject('Queue error')
-                } else {
-                    hmails.push(new HMailItem(fname, dest_path, todo.notes))
-                    ok_paths.push(dest_path)
-                    resolve()
-                }
-            })
+            try {
+                await fs.rename(tmp_path, dest_path)
+                hmails.push(new HMailItem(fname, dest_path, todo.notes))
+                ok_paths.push(dest_path)
+                resolve()
+            } catch (err) {
+                logger.error(exports, `Unable to rename tmp file: ${err}`)
+                await fs.unlink(tmp_path).catch(() => {})
+                reject('Queue error')
+            }
         })
 
-        ws.on('error', (err) => {
+        ws.on('error', async (err) => {
             logger.error(exports, `Unable to write queue file (${fname}): ${err}`)
             ws.destroy()
-            fs.unlink(tmp_path, () => {})
+            await fs.unlink(tmp_path).catch(() => {})
             reject('Queueing failed')
         })
 
         this.build_todo(todo, ws, () => {
-            // SUNSET: dot_stuffing was renamed to dot_stuffed, remove it after 2026-01
             todo.message_stream.pipe(ws, {
-                dot_stuffing: true,
                 dot_stuffed: false,
             })
         })