Haraka 2.8.28 → 3.0.1

package/plugins/dnsbl.js

@@ -1,85 +1,81 @@
 // dnsbl plugin
 
 exports.register = function () {
-    const plugin = this;
-    plugin.inherits('dns_list_base');
+    this.inherits('dns_list_base');
 
-    plugin.load_config();
+    this.load_config();
 
-    if (plugin.cfg.main.periodic_checks) {
-        plugin.check_zones(plugin.cfg.main.periodic_checks);
+    if (this.cfg.main.periodic_checks) {
+        this.check_zones(this.cfg.main.periodic_checks);
     }
 
-    if (plugin.cfg.main.search === 'all') {
-        plugin.register_hook('connect',  'connect_multi');
+    if (this.cfg.main.search === 'all') {
+        this.register_hook('connect',  'connect_multi');
     }
     else {
-        plugin.register_hook('connect',  'connect_first');
+        this.register_hook('connect',  'connect_first');
     }
 }
 
 exports.load_config = function () {
-    const plugin = this;
 
-    plugin.cfg = plugin.config.get('dnsbl.ini', {
+    this.cfg = this.config.get('dnsbl.ini', {
         booleans: ['+main.reject', '-main.enable_stats'],
     }, () => {
-        plugin.load_config();
+        this.load_config();
     });
 
-    if (plugin.cfg.main.enable_stats && !plugin.enable_stats) {
-        plugin.loginfo('stats reporting enabled');
-        plugin.enable_stats = true;
+    if (this.cfg.main.enable_stats && !this.enable_stats) {
+        this.loginfo('stats reporting enabled');
+        this.enable_stats = true;
     }
-    if (!plugin.cfg.main.enable_stats && plugin.enable_stats) {
-        plugin.loginfo('stats reporting disabled');
-        plugin.enable_stats = false;
+    if (!this.cfg.main.enable_stats && this.enable_stats) {
+        this.loginfo('stats reporting disabled');
+        this.enable_stats = false;
     }
 
-    if (plugin.cfg.main.stats_redis_host &&
-        plugin.cfg.main.stats_redis_host !== plugin.redis_host) {
-        plugin.redis_host = plugin.cfg.main.stats_redis_host;
-        plugin.loginfo(`set stats redis host to: ${plugin.redis_host}`);
+    if (this.cfg.main.stats_redis_host &&
+        this.cfg.main.stats_redis_host !== this.redis_host) {
+        this.redis_host = this.cfg.main.stats_redis_host;
+        this.loginfo(`set stats redis host to: ${this.redis_host}`);
     }
 
-    plugin.get_uniq_zones();
+    this.get_uniq_zones();
 }
 
 exports.get_uniq_zones = function () {
-    const plugin = this;
-    plugin.zones = [];
+    this.zones = [];
 
     const unique_zones = {};
 
     // Compatibility with old plugin
-    const legacy_zones = plugin.config.get('dnsbl.zones', 'list');
-    for (let i=0; i < legacy_zones.length; i++) {
-        unique_zones[legacy_zones[i]] = true;
+    const legacy_zones = this.config.get('dnsbl.zones', 'list');
+    for (const legacyZone of legacy_zones) {
+        unique_zones[legacyZone] = true;
     }
 
-    if (plugin.cfg.main.zones) {
-        const new_zones = plugin.cfg.main.zones.split(/[\s,;]+/);
-        for (let h=0; h < new_zones.length; h++) {
-            unique_zones[new_zones[h]] = true;
+    if (this.cfg.main.zones) {
+        const new_zones = this.cfg.main.zones.split(/[\s,;]+/);
+        for (const newZone of new_zones) {
+            unique_zones[newZone] = true;
         }
     }
 
-    for (const key in unique_zones) { plugin.zones.push(key); }
-    return plugin.zones;
+    for (const key in unique_zones) { this.zones.push(key); }
+    return this.zones;
 }
 
 exports.should_skip = function (connection) {
-    const plugin = this;
 
     if (!connection) { return true; }
 
     if (connection.remote.is_private) {
-        connection.logdebug(plugin, `skip private: ${connection.remote.ip}`);
+        connection.logdebug(this, `skip private: ${connection.remote.ip}`);
         return true;
     }
 
-    if (!plugin.zones || !plugin.zones.length) {
-        connection.logerror(plugin, "no zones");
+    if (!this.zones || !this.zones.length) {
+        connection.logerror(this, "no zones");
         return true;
     }
 
@@ -112,21 +108,20 @@ exports.connect_first = function (next, connection) {
 }
 
 exports.connect_multi = function (next, connection) {
-    const plugin = this;
     const remote_ip = connection.remote.ip;
 
-    if (plugin.should_skip(connection)) { return next(); }
+    if (this.should_skip(connection)) { return next(); }
 
     const hits = [];
     function get_deny_msg () {
         return `host [${remote_ip}] is blacklisted by ${hits.join(', ')}`;
     }
 
-    plugin.multi(remote_ip, plugin.zones, (err, zone, a, pending) => {
+    this.multi(remote_ip, this.zones, (err, zone, a, pending) => {
         if (err) {
-            connection.results.add(plugin, {err: err.message});
+            connection.results.add(this, {err: err.message});
             if (pending) return;
-            if (plugin.cfg.main.reject && hits.length) {
+            if (this.cfg.main.reject && hits.length) {
                 return next(DENY, get_deny_msg());
             }
             return next();
@@ -134,16 +129,16 @@ exports.connect_multi = function (next, connection) {
 
         if (a) {
             hits.push(zone);
-            connection.results.add(plugin, {fail: zone});
+            connection.results.add(this, {fail: zone});
         }
         else {
-            if (zone) connection.results.add(plugin, {pass: zone});
+            if (zone) connection.results.add(this, {pass: zone});
         }
 
         if (pending) return;
-        connection.results.add(plugin, {emit: true});
+        connection.results.add(this, {emit: true});
 
-        if (plugin.cfg.main.reject && hits.length) {
+        if (this.cfg.main.reject && hits.length) {
             return next(DENY, get_deny_msg());
         }
         return next();

package/plugins/dnswl.js

@@ -2,59 +2,56 @@
 // dnswl plugin
 
 exports.register = function () {
-    const plugin = this;
-    plugin.inherits('dns_list_base');
+    this.inherits('dns_list_base');
 
-    plugin.load_dnswl_ini();
+    this.load_dnswl_ini();
 
     // IMPORTANT: don't run this on hook_rcpt otherwise we're an open relay...
     ['ehlo','helo','mail'].forEach(hook => {
-        plugin.register_hook(hook, 'check_dnswl');
+        this.register_hook(hook, 'check_dnswl');
     });
 }
 
 exports.load_dnswl_ini = function () {
-    const plugin = this;
-    plugin.cfg = plugin.config.get('dnswl.ini', () => {
-        plugin.load_dnswl_ini();
+    this.cfg = this.config.get('dnswl.ini', () => {
+        this.load_dnswl_ini();
     });
 
-    if (plugin.cfg.main.enable_stats) {
-        plugin.logdebug('stats reporting enabled');
-        plugin.enable_stats = true;
+    if (this.cfg.main.enable_stats) {
+        this.logdebug('stats reporting enabled');
+        this.enable_stats = true;
     }
 
-    if (plugin.cfg.main.stats_redis_host) {
-        plugin.redis_host = plugin.cfg.main.stats_redis_host;
-        plugin.logdebug(`set stats redis host to: ${plugin.redis_host}`);
+    if (this.cfg.main.stats_redis_host) {
+        this.redis_host = this.cfg.main.stats_redis_host;
+        this.logdebug(`set stats redis host to: ${this.redis_host}`);
     }
 
-    plugin.zones = [];
+    this.zones = [];
     // Compatibility with old-plugin
-    plugin.zones = plugin.zones.concat(
-        plugin.config.get('dnswl.zones', 'list')
+    this.zones = this.zones.concat(
+        this.config.get('dnswl.zones', 'list')
     );
-    if (plugin.cfg.main.zones) {
-        plugin.zones = plugin.zones.concat(
-            plugin.cfg.main.zones.replace(/\s+/g,'').split(/[;,]/));
+    if (this.cfg.main.zones) {
+        this.zones = this.zones.concat(
+            this.cfg.main.zones.replace(/\s+/g,'').split(/[;,]/));
     }
 
-    if (plugin.cfg.main.periodic_checks) {
-        plugin.check_zones(plugin.cfg.main.periodic_checks);
+    if (this.cfg.main.periodic_checks) {
+        this.check_zones(this.cfg.main.periodic_checks);
     }
 }
 
 exports.check_dnswl = (next, connection) => connection.notes.dnswl ? next(OK) : next()
 
 exports.hook_connect = function (next, connection) {
-    const plugin = this;
-    if (!plugin.zones || !plugin.zones.length) {
-        connection.logerror(plugin, 'no zones');
+    if (!this.zones || !this.zones.length) {
+        connection.logerror(this, 'no zones');
         return next();
     }
-    plugin.first(connection.remote.ip, plugin.zones, (err, zone, a) => {
+    this.first(connection.remote.ip, this.zones, (err, zone, a) => {
         if (!a) return next();
-        connection.loginfo(plugin, `${connection.remote.ip} is whitelisted by ${zone}: ${a}`);
+        connection.loginfo(this, `${connection.remote.ip} is whitelisted by ${zone}: ${a}`);
         connection.notes.dnswl = true;
         return next(OK);
     });

package/plugins/early_talker.js

@@ -1,38 +1,36 @@
 // This plugin checks for clients that talk before we sent a response
 
 const ipaddr = require('ipaddr.js');
-const isIPv6 = require('net').isIPv6;
+const { isIPv6 } = require('net');
 
 exports.register = function () {
-    const plugin = this;
-    plugin.load_config();
-    plugin.register_hook('connect_init', 'early_talker');
-    plugin.register_hook('data',         'early_talker');
+    this.load_config();
+    this.register_hook('connect_init', 'early_talker');
+    this.register_hook('data',         'early_talker');
 }
 
 exports.load_config = function () {
-    const plugin = this;
 
-    plugin.cfg = plugin.config.get('early_talker.ini', {
+    this.cfg = this.config.get('early_talker.ini', {
         booleans: [
             '+main.reject'
         ]
     },
     () => {
-        plugin.load_config();
+        this.load_config();
     });
 
     // Generate a white list of IP addresses
-    plugin.whitelist = plugin.load_ip_list(Object.keys(plugin.cfg.ip_whitelist));
+    this.whitelist = this.load_ip_list(Object.keys(this.cfg.ip_whitelist));
 
-    if (plugin.cfg.main && plugin.cfg.main.pause) {
-        plugin.pause = plugin.cfg.main.pause * 1000;
+    if (this.cfg.main?.pause) {
+        this.pause = this.cfg.main.pause * 1000;
         return;
     }
 
     // config/early_talker.pause is in milliseconds
-    plugin.pause = plugin.config.get('early_talker.pause', () => {
-        plugin.load_config();
+    this.pause = this.config.get('early_talker.pause', () => {
+        this.load_config();
     });
 }
 
@@ -52,7 +50,7 @@ exports.early_talker = function (next, connection) {
         return next(DENYDISCONNECT, "You talk too soon");
     }
 
-    let pause = plugin.pause;
+    let { pause } = plugin;
     if (plugin.hook === 'connect_init') {
         const elapsed = (Date.now() - connection.start_time);
         if (elapsed > plugin.pause) {
@@ -73,15 +71,14 @@ exports.early_talker = function (next, connection) {
  * @return {Boolean}         True if is whitelisted
  */
 exports.ip_in_list = function (ip) {
-    const plugin = this;
 
-    if (!plugin.whitelist) return false;
+    if (!this.whitelist) return false;
 
     const ipobj = ipaddr.parse(ip);
 
-    for (let i = 0; i < plugin.whitelist.length; i++) {
+    for (const element of this.whitelist) {
         try {
-            if (ipobj.match(plugin.whitelist[i])) {
+            if (ipobj.match(element)) {
                 return true;
             }
         }
@@ -101,9 +98,9 @@ exports.ip_in_list = function (ip) {
 exports.load_ip_list = list => {
     const whitelist = [];
 
-    for (let i = 0; i < list.length; i++) {
+    for (const element of list) {
         try {
-            let addr = list[i];
+            let addr = element;
             if (addr.match(/\/\d+$/)) {
                 addr = ipaddr.parseCIDR(addr);
             }
@@ -120,37 +117,36 @@ exports.load_ip_list = list => {
 }
 
 exports.should_check = function (connection) {
-    const plugin = this;
     // Skip delays for privileged senders
 
     if (connection.notes.auth_user) {
-        connection.results.add(plugin, { skip: 'authed'});
+        connection.results.add(this, { skip: 'authed'});
         return false;
     }
 
     if (connection.relaying) {
-        connection.results.add(plugin, { skip: 'relay'});
+        connection.results.add(this, { skip: 'relay'});
         return false;
     }
 
-    if (plugin.ip_in_list(connection.remote.ip)) {
-        connection.results.add(plugin, { skip: 'whitelist' });
+    if (this.ip_in_list(connection.remote.ip)) {
+        connection.results.add(this, { skip: 'whitelist' });
         return false;
     }
 
     const karma = connection.results.get('karma');
     if (karma && karma.good > 0) {
-        connection.results.add(plugin, { skip: '+karma' });
+        connection.results.add(this, { skip: '+karma' });
         return false;
     }
 
     if (connection.remote.is_local) {
-        connection.results.add(plugin, { skip: 'local_ip'});
+        connection.results.add(this, { skip: 'local_ip'});
         return false;
     }
 
     if (connection.remote.is_private) {
-        connection.results.add(plugin, { skip: 'private_ip'});
+        connection.results.add(this, { skip: 'private_ip'});
         return false;
     }
 

package/plugins/esets.js

@@ -5,17 +5,16 @@ const virus_re = new RegExp('virus="([^"]+)"');
 
 exports.hook_data_post = function (next, connection) {
     const plugin = this;
-    const txn = connection.transaction;
     const cfg = this.config.get('esets.ini');
 
     // Write message to temporary file
     const tmpdir = cfg.main.tmpdir || '/tmp';
-    const tmpfile = `${tmpdir}/${txn.uuid}.esets`;
+    const tmpfile = `${tmpdir}/${connection?.transaction?.uuid}.esets`;
     const ws = fs.createWriteStream(tmpfile);
 
     ws.once('error', err => {
         connection.logerror(plugin, `Error writing temporary file: ${err.message}`);
-        return next();
+        next();
     });
 
     let start_time;
@@ -32,17 +31,15 @@ exports.hook_data_post = function (next, connection) {
         [stdout, stderr].forEach(channel => {
             if (channel) {
                 const lines = channel.split('\n');
-                for (let i=0; i<lines.length; i++) {
-                    if (lines[i]) connection.logdebug(plugin, `recv: ${lines[i]}`);
+                for (const line of lines) {
+                    if (line) connection.logdebug(plugin, `recv: ${line}`);
                 }
             }
         });
 
         // Get virus name
-        let virus;
-        if ((virus = virus_re.exec(stdout))) {
-            virus = virus[1];
-        }
+        let virus = virus_re.exec(stdout)
+        if (virus) virus = virus[1];
 
         // Log a summary
         const exit_code = parseInt((error) ? error.code : 0)
@@ -60,7 +57,7 @@ exports.hook_data_post = function (next, connection) {
                 return next(DENYSOFT, 'Virus scanner error');
             }
         }
-        return next();
+        next();
     }
 
     ws.once('close', () => {
@@ -70,5 +67,5 @@ exports.hook_data_post = function (next, connection) {
             wsOnClose);
     });
 
-    txn.message_stream.pipe(ws, { line_endings: '\r\n' });
+    connection.transaction.message_stream.pipe(ws, { line_endings: '\r\n' });
 }