Merge pull request #5 from haraka/eslint-no-var

Eslint no var

.eslintrc.yaml

@@ -0,0 +1,21 @@
+env:
+  node: true
+  es6: true
+  mocha: true
+
+plugins: [ haraka ]
+
+extends: [ eslint:recommended, plugin:haraka/recommended ]
+
+root: true
+
+rules:
+  indent: [2, 2, { SwitchCase: 1 } ]
+
+globals:
+  OK: true
+  CONT: true
+  DENY: true
+  DENYSOFT: true
+  DENYDISCONNECT: true
+  DENYSOFTDISCONNECT: true

README.md

@@ -6,16 +6,15 @@
 
 # haraka-plugin-known-senders
 
-Increase the reputation of domains you send email to, simply by sending them email.
+Increase the reputation of domains you exchange email with by sending them email.
 
 ## Synopsis
 
 Known Senders is based on the premise that domains users send email to are domains they also want to receive email from. By maintaining lists of domains that local users send email to, a weak but helpful form of automatic whitelisting is obtained.
 
-
 ## How it works
 
-This plugin inspects outgoing emails and adds the destination domains to a known senders database. When emails arrive from those known senders, this plugin stores a result object with the passing domain(s) name.
+This plugin inspects outgoing emails and adds the destination domains to a known senders database. When emails arrive from those known sending domains, this plugin stores a result object with the passing domain(s) name.
 
 ### TL;DR
 

index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var tlds = require('haraka-tld');
+const tlds = require('haraka-tld');
 
 exports.register = function () {
-  var plugin = this;
+  const plugin = this;
   plugin.inherits('haraka-plugin-redis');
 
   plugin.load_sender_ini();
@@ -18,7 +18,7 @@ exports.register = function () {
 }
 
 exports.load_sender_ini = function () {
-  var plugin = this;
+  const plugin = this;
 
   plugin.cfg = plugin.config.get('known-senders.ini', function () {
     plugin.load_sender_ini();
@@ -37,7 +37,7 @@ exports.load_sender_ini = function () {
 */
 
 exports.update_sender = function (next, connection, params) {
-  var plugin = this;
+  const plugin = this;
   // queue_ok arguments: next, connection, msg
   // ok 1390590369 qp 634 (F82E2DD5-9238-41DC-BC95-9C3A02716AD2.1)
 
@@ -50,19 +50,19 @@ exports.update_sender = function (next, connection, params) {
   if (!connection) return errNext('no connection');
   if (!connection.transaction) return errNext('no transaction');
   if (!connection.relaying) return next();
-  var txn = connection.transaction;
+  const txn = connection.transaction;
 
-  var sender_od = plugin.get_sender_domain_by_txn(txn);
+  const sender_od = plugin.get_sender_domain_by_txn(txn);
   if (!sender_od) return errNext('no sender domain');
 
-  var rcpt_domains = plugin.get_recipient_domains_by_txn(txn);
+  const rcpt_domains = plugin.get_recipient_domains_by_txn(txn);
   if (rcpt_domains.length === 0) {
     return errNext('no rcpt ODs for ' + sender_od);
   }
 
   // within this function, the sender is a local domain
   // and the recipient is an external domain
-  var multi = plugin.db.multi();
+  const multi = plugin.db.multi();
   for (let i = 0; i < rcpt_domains.length; i++) {
     multi.hincrby(sender_od, rcpt_domains[i], 1);
   }
@@ -80,26 +80,26 @@ exports.update_sender = function (next, connection, params) {
 }
 
 exports.get_sender_domain_by_txn = function (txn) {
-  var plugin = this;
+  const plugin = this;
 
   if (!txn.mail_from) return;
   if (!txn.mail_from.host) return;
-  var sender_od = tlds.get_organizational_domain(txn.mail_from.host);
+  const sender_od = tlds.get_organizational_domain(txn.mail_from.host);
   if (txn.mail_from.host !== sender_od) {
     plugin.logdebug('sender: ' + txn.mail_from.host + ' -> ' + sender_od);
   }
   return sender_od;
 }
 
 exports.get_recipient_domains_by_txn = function (txn) {
-  var plugin = this;
+  const plugin = this;
 
-  var rcpt_domains = [];
+  const rcpt_domains = [];
   if (!txn.rcpt_to) return rcpt_domains;
 
   for (let i=0; i < txn.rcpt_to.length; i++) {
     if (!txn.rcpt_to[i].host) continue;
-    var rcpt_od = tlds.get_organizational_domain(txn.rcpt_to[i].host);
+    const rcpt_od = tlds.get_organizational_domain(txn.rcpt_to[i].host);
     if (txn.rcpt_to[i].host !== rcpt_od) {
       plugin.loginfo('rcpt: ' + txn.rcpt_to[i].host + ' -> ' + rcpt_od);
     }
@@ -123,12 +123,12 @@ exports.get_recipient_domains_by_txn = function (txn) {
 
 // early checks, on the mail hook
 exports.is_authenticated = function (next, connection, params) {
-  var plugin = this;
+  const plugin = this;
 
   // only validate inbound messages
   if (connection.relaying) return next();
 
-  var sender_od = plugin.get_sender_domain_by_txn(connection.transaction);
+  const sender_od = plugin.get_sender_domain_by_txn(connection.transaction);
 
   if (plugin.has_fcrdns_match(sender_od, connection)) {
     connection.logdebug(plugin, '+fcrdns: ' + sender_od);
@@ -140,38 +140,44 @@ exports.is_authenticated = function (next, connection, params) {
   }
 
   // Maybe: TLS verified domain?
+  if (connection.tls.verified) {
+    // TODO: get the CN and Subject Alternative Names of the cert
+    // then look for match with sender_od
+    connection.logdebug(plugin, '+tls: ' + sender_od);
+    // return next(null, null, sender_od);
+  }
 
   return next();
 }
 
 exports.get_validated_sender_od = function (connection) {
-  var plugin = this;
+  const plugin = this;
   if (!connection) return;
   if (!connection.transaction) return;
-  var txn_res = connection.transaction.results.get(plugin.name);
+  const txn_res = connection.transaction.results.get(plugin.name);
   if (!txn_res) return;
   return txn_res.sender;
 }
 
 exports.get_rcpt_ods = function (connection) {
-  var plugin = this;
+  const plugin = this;
   if (!connection) return [];
   if (!connection.transaction) return [];
 
-  var txn_r = connection.transaction.results.get(plugin.name);
+  const txn_r = connection.transaction.results.get(plugin.name);
   if (!txn_r) return [];
 
   return txn_r.rcpt_ods;
 }
 
 function already_matched (connection) {
-  var res = connection.transaction.results.get(this);
+  const res = connection.transaction.results.get(this);
   if (!res) return false;
   return (res.pass && res.pass.length) ? true : false;
 }
 
 exports.check_recipient = function (next, connection, rcpt) {
-  var plugin = this;
+  const plugin = this;
   // rcpt is a valid local email address. Some rcpt_to.* plugin has
   // accepted it.
 
@@ -186,13 +192,13 @@ exports.check_recipient = function (next, connection, rcpt) {
   if (!rcpt.host) return errNext('rcpt.host unset?');
 
   // reduce the host portion of the email address to an OD
-  var rcpt_od = tlds.get_organizational_domain(rcpt.host);
+  const rcpt_od = tlds.get_organizational_domain(rcpt.host);
   if (!rcpt_od) return errNext('no rcpt od for ' + rcpt.host);
 
   connection.transaction.results.push(plugin, { rcpt_ods: rcpt_od });
 
   // if no validated sender domain, there's nothing to do...yet
-  var sender_od = plugin.get_validated_sender_od(connection);
+  const sender_od = plugin.get_validated_sender_od(connection);
   if (!sender_od) return next();
 
   // The sender OD is validated, check Redis for a match
@@ -210,10 +216,10 @@ exports.check_recipient = function (next, connection, rcpt) {
 }
 
 exports.is_dkim_authenticated = function (next, connection) {
-  var plugin = this;
+  const plugin = this;
   if (connection.relaying) return next();
 
-  var rcpt_ods = [];
+  let rcpt_ods = [];
 
   function errNext (err) {
     connection.logerror(plugin, 'is_dkim_authenticated: ' + err);
@@ -222,20 +228,20 @@ exports.is_dkim_authenticated = function (next, connection) {
 
   if (already_matched(connection)) return errNext('already matched');
 
-  var sender_od = plugin.get_validated_sender_od(connection);
+  const sender_od = plugin.get_validated_sender_od(connection);
   if (!sender_od) return errNext('no sender_od');
 
   rcpt_ods = plugin.get_rcpt_ods(connection);
   if (!rcpt_ods || ! rcpt_ods.length) return errNext('no rcpt_ods');
 
-  var dkim = connection.transaction.results.get('dkim_verify');
+  const dkim = connection.transaction.results.get('dkim_verify');
   if (!dkim) return next();
   if (!dkim.pass || !dkim.pass.length) return errNext('no dkim pass');
 
-  var multi = plugin.db.multi();
+  const multi = plugin.db.multi();
 
   for (let i = 0; i < dkim.pass.length; i++) {
-    var dkim_od = tlds.get_organizational_domain(dkim.pass[i]);
+    const dkim_od = tlds.get_organizational_domain(dkim.pass[i]);
     if (dkim_od === sender_od) {
       connection.transaction.results.add(plugin, { sender: sender_od, auth: 'dkim' });
       for (let j = 0; j < rcpt_ods.length; j++) {
@@ -264,17 +270,17 @@ exports.is_dkim_authenticated = function (next, connection) {
 }
 
 exports.has_fcrdns_match = function (sender_od, connection) {
-  var plugin = this;
-  var fcrdns = connection.results.get('fcrdns');
+  const plugin = this;
+  const fcrdns = connection.results.get('fcrdns');
   if (!fcrdns) return false;
   if (!fcrdns.fcrdns) return false;
 
   connection.logdebug(plugin, fcrdns.fcrdns);
 
-  var mail_host = fcrdns.fcrdns;
+  let mail_host = fcrdns.fcrdns;
   if (Array.isArray(mail_host)) mail_host = fcrdns.fcrdns[0];
 
-  var fcrdns_od = tlds.get_organizational_domain(mail_host);
+  const fcrdns_od = tlds.get_organizational_domain(mail_host);
   if (fcrdns_od !== sender_od) return false;
 
   connection.transaction.results.add(plugin, {
@@ -284,9 +290,9 @@ exports.has_fcrdns_match = function (sender_od, connection) {
 }
 
 exports.has_spf_match = function (sender_od, connection) {
-  var plugin = this;
+  const plugin = this;
 
-  var spf = connection.results.get('spf');
+  let spf = connection.results.get('spf');
   if (spf && spf.domain && spf.result === 'Pass') {
     // scope=helo (HELO/EHLO)
     if (tlds.get_organizational_domain(spf.domain) === sender_od) {