Haraka 2.8.28 → 3.0.1

package/.eslintrc.yaml

@@ -1,15 +1,7 @@
 env:
   es6: true
   node: true
-
-parserOptions:
-  #ecmaVersion: 2015 (6)
-  #ecmaVersion: 2016 (7) (node 6)
-  #ecmaVersion: 2017 (8) (node 8)
-  ecmaVersion: 2017
-  #ecmaVersion: 2018 (9) (node 10)
-  #ecmaVersion: 2019 (10) (node 12)
-  #ecmaVersion: 2020 (11) (node 14)
+  es2020: true
 
 plugins:
   - haraka
@@ -17,7 +9,7 @@ plugins:
 root: true
 
 rules:
-  semi-style: [error, last]
+  semi-style: [ error, last ]
   prefer-template: "warn"
   no-unneeded-ternary: 1
 

package/Changes.md

@@ -1,5 +1,83 @@
 
-## NEXT - 2021-MM-DD
+### Unreleased
+
+
+### [3.0.1] - 2023-01-19
+
+#### Fixed
+
+- fix(bin/haraka): set server.cfg and pass to conn, fixes #3143
+- fix(bin/haraka): correct error messages for help options #3142
+- fix: dkim_verify fails to find record #3149
+
+#### Changed
+
+- plugins: Add haraka-plugin-outbound-logger to registry #3146
+- dep(pi-spf): bump version 1.1.3 to 1.2.0
+
+
+### [3.0.0] - 2022-12-17
+
+#### Added
+
+- feat: prevent local delivery loop when target exchange resolves to a local hostname #3002
+- feat: format DKIM signature to multiline #2991
+
+#### Fixed
+
+- fix(tls): redis promise syntax for tls & ob/tls #3064
+- fix(attachment): error handling with complex archive #3035
+- fix(smtp_client): run "secured" once, fixes  #3020
+- fix(smtp_client): add missing `$` char in front of interpolated string
+- fix(auth_proxy): run "secured" only once, improvement for #3022
+- fix(helo): remove multi-check from should_skip #3041
+- fix(outbound): outbound local mx check #3010
+- fix(outbound): prevent delivery loop when target MX resolves to local hostname #3002
+- fix(conn): socket can't be released when disconnect after DATA command #2994
+
+#### Changed
+
+- dep(generic-pool): remove pooling from outbound #3115
+- smtp_client: disable pooling in get_client_plugin, #3113
+- smtp_forward: restore ability to enable queue_outbound #3119
+- ./mailbody & ./mailheader moved to haraka-email-message #3071
+- config/plugins: update name of uribl plugin
+- doc(queue.js) spelling & grammar improvement #3051
+- doc(rails): add haraka-plugin-queue-rails #2995
+- doc(smtp.ini): correct spelling of SMTPUTF8 #2993
+- style(es6): use optional chaining when accessing transactions #2732
+- style(smtp_client): pass args as objects (was positional)
+- style(plugin/\*): transaction guarding #3032
+- dep(spf): remove to separate plugin #3078
+- dep(iconv): removed, declared in haraka-email-message)
+- dep(haraka-plugin-redis)!: 1.0 -> 2.0  #3038
+- dep(redis)!: 3.1 -> 4.1 #3058
+- dep(generic-pool): remove pooling from outbound #3115
+- smtp_client: remove smtp_\* pooling support in #3113
+- dep: bump plugin versions #3063
+- dep: bump haraka-plugin-asn from 1.0.9 to 2.0.0 #3062
+- dep(redis): 3.1 -> 4.1 #3058
+- dep(nopt): 5 -> 6.0.0  #3076
+- dep(haraka-plugin-fcrdns): 1.0.3 -> 1.1.0  #3076
+- dep(haraka-plugin-redis): 1.0 -> 2.0  #3038
+- dep(nodemailer): 6.7.0 to 6.7.2 #3000, #3004
+- dep: add explicit dependency on node-gyp 9
+- ci: github action tweaks #3047
+- chore: transaction guarding #3032
+- ci: enable windows node 16 testing #3036
+- chore: update phusion image #2988
+- chore: add lots of `if (!transaction) return` in places #2732
+- chore(test): build shims for windows-2022 & node on windows #3052
+- chore(test): restore CI tests to working order #3030
+- dkim_sign: reformat dkim signature to multi-line #2991
+- dkim_sign: remove spurious error logging #3034
+- tls: add force_tls option to the ToDo object
+- fix(banner): banner was inserted erroneously into text attachments
+- outbound: remove hardcoded AUTH PLAIN authorization identity
+- outbound: set acquireTimeoutMillis to prevent constant reconnect to unreachable servers
+- style(smtp_client): pass args as objects (was positional)
+- uribl: timeout DNS 1 second before plugin, #3077
+- uribl: load .ini config to plugin.cfg, add basic tests #3077
 
 
 ## 2.8.28 - 2021-10-14
@@ -14,7 +92,7 @@
 - spamassassin: allow returning DENYSOFT on errors #2967
 - dep: use caret version range for all dependencies #2965
 - outbound: disable outbound to localhost by default #2952
-- connection error logging: use key-value paris #2921
+- connection error logging: use key-value pairs #2921
 - tls: change default to NOT send TLS client certs #2902
 - dep: redis is now a dependency #2896
 - use address-rfc2821 2.0.0
@@ -1263,3 +1341,7 @@
 * Small fixes to data.uribl
 
 ## 1.4.0 -
+
+
+[3.0.0]: https://github.com/haraka/Haraka/releases/tag/3.0.0
+[3.0.1]: https://github.com/haraka/Haraka/releases/tag/3.0.1

package/Dockerfile

@@ -13,7 +13,7 @@
 # DOCKER-VERSION    0.5.3
 
 # See http://phusion.github.io/baseimage-docker/
-FROM phusion/baseimage:latest
+FROM phusion/baseimage:master
 
 MAINTAINER Justin Plock <jplock@gmail.com>
 

package/Plugins.md

@@ -42,7 +42,7 @@ Create a PR adding yours to this list.
 | [clamd][url-clamd]          | Anti-Virus scanning with ClamAV |
 | [connect.p0f][url-p0f]      | TCP Fingerprinting |
 | [data.signatures][url-sigs] | Block emails whose bodies match signatures |
-| [data.uribl][url-uribl]     | Block based on URI blacklists |
+| [uribl][url-uribl]          | Block based on URI blacklists |
 | [dcc][url-dcc]              | Distributed Checksum Clearinghouse |
 | [delay_deny][url-delay]     | Delays all pre-DATA 'deny' results |
 | [dkim_sign][url-sign]       | DKIM sign outbound messages |
@@ -69,6 +69,7 @@ Create a PR adding yours to this list.
 | [messagesniffer][url-msgsniff]    | Anti-spam via [MessageSniffer][url-ms] |
 | [milter][url-milter]              | milter support |
 | [mongodb][mongo-url]              | Queue emails to MongoDB |
+| [outbound-logger][url-outbound-logger] | JSON logging of outbound email traffic. Logs useful metadata about delivered/bounced emails |
 | [prevent_credential_leaks][url-creds]  | Prevent users from emailing their credentials |
 | [process_title][url-proctitle]    | Populate `ps` output with activity counters |
 | queue/[discard][url-qdisc]        | queues messages to /dev/null |
@@ -77,6 +78,7 @@ Create a PR adding yours to this list.
 | queue/[quarantine][url-qquart]    | queue to a quarantine directory |
 | queue/[rabbitmq][url-qrabbit]     | queue to RabbitMQ |
 | queue/[rabbitmq_amqplib][url-qrabbita]  | queue to RabbitMQ using amqplib |
+| queue/[rails][url-qrails]          | queue messages to a Rails app using [Action Mailbox][url-action-mailbox] |
 | queue/[smtp_bridge][url-qbridge]   | Bridge SMTP sessions to another MTA |
 | queue/[smtp_forward][url-qforward] | Forward emails to another MTA |
 | queue/[smtp_proxy][url-qproxy]     | Proxy SMTP connections to another MTA |
@@ -110,9 +112,10 @@ Create a PR adding yours to this list.
 [plugins-doc]: https://haraka.github.io/manual/Plugins.html
 [url-access]: https://github.com/haraka/haraka-plugin-access
 [url-acc-files]: https://github.com/acharkizakaria/haraka-plugin-accounting-files/blob/master/README.md
+[url-action-mailbox]: https://guides.rubyonrails.org/action_mailbox_basics.html
 [url-aliases]: https://github.com/haraka/Haraka/blob/master/docs/plugins/aliases.md
 [url-asn]: https://github.com/haraka/haraka-plugin-asn
-[url-attach]: https://github.com/haraka/Haraka/blob/master/docs/plugins/attachment.md
+[url-attach]: https://github.com/haraka/haraka-plugin-attachment
 [url-authencflat]: https://github.com/AuspeXeu/haraka-plugin-auth-enc-file
 [url-authflat]: https://github.com/haraka/Haraka/blob/master/docs/plugins/auth/flat_file.md
 [url-authbridge]: https://github.com/haraka/Haraka/blob/master/docs/plugins/auth/auth_bridge.md
@@ -130,7 +133,7 @@ Create a PR adding yours to this list.
 [url-p0f]: https://github.com/haraka/haraka-plugin-p0f
 [url-headers]: https://github.com/haraka/haraka-plugin-headers
 [url-sigs]: https://github.com/haraka/Haraka/blob/master/docs/plugins/data.signatures.md
-[url-uribl]: https://github.com/haraka/Haraka/blob/master/docs/plugins/data.uribl.md
+[url-uribl]: https://github.com/haraka/haraka-plugin-uribl
 [url-dcc]: https://github.com/haraka/haraka-plugin-dcc
 [url-delay]: https://github.com/haraka/Haraka/blob/master/docs/plugins/delay_deny.md
 [url-sign]: https://github.com/haraka/Haraka/blob/master/docs/plugins/dkim_sign.md
@@ -167,6 +170,7 @@ Create a PR adding yours to this list.
 [url-qbridge]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/smtp_bridge.md
 [url-qforward]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/smtp_forward.md
 [url-qproxy]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/smtp_proxy.md
+[url-qrails]: https://github.com/mailprotector/haraka-plugin-queue-rails
 [url-redis]: https://github.com/haraka/haraka-plugin-redis
 [url-rhost]: https://github.com/haraka/Haraka/blob/master/docs/plugins/rcpt_to.in_host_list.md
 [url-rcpt-ldap]: https://github.com/haraka/haraka-plugin-rcpt-ldap
@@ -177,7 +181,7 @@ Create a PR adding yours to this list.
 [url-rng]: https://github.com/haraka/Haraka/blob/master/docs/plugins/reseed_rng.md
 [url-rspamd]: https://github.com/haraka/haraka-plugin-rspamd
 [url-spamass]: https://github.com/haraka/Haraka/blob/master/docs/plugins/spamassassin.md
-[url-spf]: https://github.com/haraka/Haraka/blob/master/docs/plugins/spf.md
+[url-spf]: https://github.com/haraka/haraka-plugin-spf
 [url-srs]: https://github.com/swerter/haraka-plugins/blob/master/plugins/srs.js
 [url-tarpit]: https://github.com/haraka/Haraka/blob/master/docs/plugins/tarpit.md
 [url-tls]: https://github.com/haraka/Haraka/blob/master/docs/plugins/tls.md
@@ -187,4 +191,5 @@ Create a PR adding yours to this list.
 [url-wildduck]: https://github.com/nodemailer/haraka-plugin-wildduck
 [url-xclient]: https://github.com/haraka/Haraka/blob/master/docs/plugins/xclient.md
 [mongo-url]: https://github.com/Helpmonks/haraka-plugin-mongodb
+[url-outbound-logger]: https://github.com/mr-karan/haraka-plugin-outbound-logger
 

package/README.md

@@ -2,8 +2,7 @@
 Haraka - a Node.js Mail Server
 ------------------------------
 
-![Tests](https://github.com/haraka/Haraka/workflows/Haraka%20Tests/badge.svg)
-![Tests - Windows](https://github.com/haraka/Haraka/workflows/Haraka%20Tests%20-%20Windows/badge.svg)
+![Tests](https://github.com/haraka/Haraka/actions/workflows/ci.yml/badge.svg)
 [![Coverage Status][cov-img]][cov-url]
 
 
@@ -28,7 +27,6 @@ queued for outbound delivery.
 ### Getting Help
 
 * [Join the mailing list][8] (implemented as a Haraka plugin)
-* [Join us on Slack][14]
 * [GitHub Issues][15]
 
 
@@ -131,8 +129,7 @@ Finally run Haraka:
 
 Haraka is MIT licensed - see the [LICENSE][16] file for details.
 
-Haraka is a project started by [Matt Sergeant][17], a 10 year veteran of the email
-and anti-spam world. Previous projects have been the project leader for
+Haraka is a project started by [Matt Sergeant][17], a 10 year veteran of the email and anti-spam world. Previous projects have been the project leader for
 SpamAssassin and a hacker on [Qpsmtpd][13].
 
 [1]: http://nodejs.org/
@@ -148,7 +145,6 @@ SpamAssassin and a hacker on [Qpsmtpd][13].
 [11]: https://haraka.github.io/manual/plugins/dnsbl.html
 [12]: https://github.com/haraka/Haraka/tree/master/plugins
 [13]: https://github.com/smtpd/qpsmtpd/
-[14]: https://communityinviter.com/apps/harakaserver/public-inviter
 [15]: https://github.com/haraka/Haraka/issues
 [16]: https://github.com/haraka/Haraka/blob/master/LICENSE
 [17]: https://github.com/baudehlo

package/bin/haraka

@@ -383,7 +383,7 @@ else if (parsed.qlist) {
 }
 else if (parsed.qstat) {
     if (!parsed.configs) {
-        fail("qlist option requires config path");
+        fail("qstat option requires config path");
     }
     process.env.HARAKA = parsed.configs;
     logger = require(path.join(base, "logger"));
@@ -435,7 +435,7 @@ else if (parsed.graceful) {
 }
 else if (parsed.qempty) {
     if (!parsed.configs) {
-        fail("qlist option requires config path");
+        fail("qempty option requires config path");
     }
     fail("qempty is unimplemented");
 }
@@ -476,7 +476,7 @@ else if (parsed.order) {
 }
 else if (parsed.test) {
     if (!parsed.configs) {
-        fail("order option requires config path");
+        fail("test option requires config path");
     }
     process.env.HARAKA = parsed.configs;
     try {
@@ -528,9 +528,10 @@ else if (parsed.test) {
         address () {
             return { port: 25, family: 'ipv4', address: '127.0.0.1' };
         },
+        cfg  : require('haraka-config').get('smtp.ini'),
         notes: new Notes(),
     }
-    const connection = Connection.createConnection(client, server);
+    const connection = Connection.createConnection(client, server, server.cfg);
     if (parsed['set-relay']) connection.relaying = true;
 
     const run_next_hook = function () {

package/config/outbound.ini

@@ -21,10 +21,3 @@
 
 ; received_header (default: "Haraka outbound")
 ; received_header=Haraka outbound
-
-; pool_timeout: default : 300
-; pool_timeout=0
-
-; pool_concurrency_max: default: 10
-; set to zero to disable pools
-; pool_concurrency_max=0

package/config/plugins

@@ -56,7 +56,7 @@ rcpt_to.in_host_list
 #bounce
 # Check mail headers are valid
 headers
-#data.uribl
+#uribl
 #attachment
 #clamd
 #spamassassin

package/config/smtp.ini

@@ -47,7 +47,7 @@
 ; SMTP service extensions: https://tools.ietf.org/html/rfc1869
 ; strict_rfc1869 = false
 
-; Advertise support for SMTPTUF8 (RFC-6531)
+; Advertise support for SMTPUTF8 (RFC-6531)
 ;smtputf8=true
 
 [headers]

package/config/smtp_forward.ini

@@ -4,12 +4,6 @@ host=localhost
 ; port to connect to
 port=2555
 ;
-; timeout backend connection from pool
-;timeout=300
-;
-; max connections in pool
-;max_connections=1000
-;
 ; uncomment to enable TLS to the backend SMTP server
 ;enable_tls=true
 ;
@@ -23,5 +17,5 @@ port=2555
 ;auth_pass=
 
 ; should outbound messages be delivered by smtp_forward?
-; see https://github.com/haraka/Haraka/issues/1472
-; enable_outbound=true
+; see #1472 and #2795
+; enable_outbound=false

package/config/smtp_proxy.ini

@@ -4,12 +4,6 @@ host=localhost
 ; port to connect to
 port=2555
 ;
-; timeout backend connection from pool
-;timeout=300
-;
-; max connections in pool
-;max_connections=1000
-;
 ; uncomment to enable TLS to the backend SMTP server
 ; enable_tls=1
 ;