haraka-plugin-karma 2.1.6 → 2.1.8

package/CHANGELOG.md

@@ -4,9 +4,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 ### Unreleased
 
+### [2.1.8] - 2025-10-27
+
+- fix: use optional chaining in should_we_skip, fixes #63
+- reduce ASN details saved to results store
+- config: update plugin names
+
+### [2.1.7] - 2025-01-31
+
+- replace utils.in_array with [].includes
+- dep(eslint): upgrade to v9
+- doc(CONTRIBUTORS): updated
+
 ### [2.1.6] - 2024-11-08
 
-- fix missing error handler on redis client [#45](https://github.com/haraka/haraka-plugin-redis/issues/45)
+- fix missing error handler on redis client #61
 
 ### [2.1.5] - 2024-04-23
 
@@ -134,3 +146,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 [2.1.3]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.3
 [2.1.4]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.4
 [2.1.5]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.5
+[2.1.6]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.6
+[2.1.7]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.7
+[2.1.8]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.8

package/README.md

@@ -1,6 +1,5 @@
 [![Build Status][ci-img]][ci-url]
 [![Code Climate][clim-img]][clim-url]
-[![NPM][npm-img]][npm-url]
 
 # Karma - A heuristics based reputation engine for the Haraka MTA
 
@@ -200,5 +199,3 @@ Expect to use karma _with_ content filters.
 [cov-url]: https://codecov.io/github/haraka/haraka-plugin-karma
 [clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-karma/badges/gpa.svg
 [clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-karma
-[npm-img]: https://nodei.co/npm/haraka-plugin-karma.png
-[npm-url]: https://www.npmjs.com/package/haraka-plugin-karma

package/config/karma.ini

@@ -57,7 +57,7 @@ hooks=unrecognized_command,data,data_post,queue,queue_outbound
 ; karma captures and scores deny requests from other plugins, permitting finer
 ; control over connection handling. For plugins that should be able to reject
 ; the connection, add their name to the plugin list:
-plugins=send_email, tls, access, helo.checks, data.headers, rspamd, spamassassin, clamd, attachment, limit
+plugins=send_email, tls, access, helo.checks, headers, rspamd, spamassassin, clamd, attachment, limit
 
 ; hooks whose DENY rejections should be not be captured.
 hooks=rcpt, queue, queue_outbound
@@ -227,16 +227,16 @@ early_talker                     = -3
 104 = access    | pass | equals | rcpt_to.access.whitelist    | 8
 
 ; Scores for specific DNSBLs
-111 = dnsbl       | fail | equals | b.barracudacentral.org  | -7 | DNS Blacklist | Disinfect your host/network
-112 = dnsbl       | fail | equals | truncate.gbudb.net      | -5 | DNS Blacklist | Disinfect your host/network
-113 = dnsbl       | fail | equals | psbl.surriel.com        | -6 | DNS Blacklist | Disinfect your host/network
-114 = dnsbl       | fail | equals | bl.spamcop.net          | -3 | DNS Blacklist | Disinfect your host/network
-115 = dnsbl       | fail | equals | dnsbl-1.uceprotect.net  | -3 | DNS Blacklist | Disinfect your host/network
-116 = dnsbl       | fail | equals | zen.spamhaus.org        | -5 | DNS Blacklist | Disinfect your host/network
-117 = dnsbl       | fail | equals | xbl.spamhaus.org        | -6 | DNS Blacklist | Disinfect your host/network
-118 = dnsbl       | fail | equals | cbl.abuseat.org         | -5 | DNS Blacklist | Disinfect your host/network
-119 = dnsbl       | fail | equals | dnsbl.justspam.org      | -1 | DNS Blacklist | Disinfect your host/network
-120 = dnsbl       | fail | equals | dnsbl.sorbs.net         | -2 | DNS Blacklist | Clean up DNSBL listing
+111 = dns-list    | fail | equals | b.barracudacentral.org  | -7 | DNS Blacklist | Disinfect your host/network
+112 = dns-list    | fail | equals | truncate.gbudb.net      | -5 | DNS Blacklist | Disinfect your host/network
+113 = dns-list    | fail | equals | psbl.surriel.com        | -6 | DNS Blacklist | Disinfect your host/network
+114 = dns-list    | fail | equals | bl.spamcop.net          | -3 | DNS Blacklist | Disinfect your host/network
+115 = dns-list    | fail | equals | dnsbl-1.uceprotect.net  | -3 | DNS Blacklist | Disinfect your host/network
+116 = dns-list    | fail | equals | zen.spamhaus.org        | -5 | DNS Blacklist | Disinfect your host/network
+117 = dns-list    | fail | equals | xbl.spamhaus.org        | -6 | DNS Blacklist | Disinfect your host/network
+118 = dns-list    | fail | equals | cbl.abuseat.org         | -5 | DNS Blacklist | Disinfect your host/network
+119 = dns-list    | fail | equals | dnsbl.justspam.org      | -1 | DNS Blacklist | Disinfect your host/network
+120 = dns-list    | fail | equals | dnsbl.sorbs.net         | -2 | DNS Blacklist | Clean up DNSBL listing
 
 130 = helo.checks | fail | match | valid_hostname | -1  | HELO host invalid      | Use valid HELO hostname
 131 = helo.checks | pass | match | forward_dns    |  1  | HELO host has forward DNS

package/index.js

@@ -364,8 +364,8 @@ exports.tarpit_delay = function (score, connection, hook, k) {
 
   // detect roaming users based on MSA ports that require auth
   if (
-    utils.in_array(connection.local.port, [587, 465]) &&
-    utils.in_array(hook, ['ehlo', 'connect'])
+    [587, 465].includes(connection.local.port) &&
+    ['ehlo', 'connect'].includes(hook)
   ) {
     return this.tarpit_delay_msa(connection, delay, k)
   }
@@ -394,7 +394,7 @@ exports.tarpit_delay_msa = function (connection, delay, k) {
   // Reduce delay for good ASN history
   let asn = connection.results.get('asn')
   if (!asn) asn = connection.results.get('geoip')
-  if (asn && asn.asn && k.neighbors > 0) {
+  if (asn && asn.asn && asn.asn_score > 0) {
     connection.logdebug(this, `${trg} neighbors: ${delay}`)
     delay = delay - 2
   }
@@ -409,8 +409,8 @@ exports.tarpit_delay_msa = function (connection, delay, k) {
 }
 
 exports.should_we_skip = function (connection) {
-  if (connection.remote.is_private) return true
-  if (connection.notes.disable_karma) return true
+  if (connection.remote?.is_private) return true
+  if (connection.notes?.disable_karma) return true
   return false
 }
 
@@ -673,6 +673,19 @@ exports.hook_data_post = function (next, connection) {
 
   if (this.should_we_skip(connection)) return next()
 
+  /*
+  This should not be a default due to highly probability of false positives,
+  but I've found it extremely effective against a recent (most of 2024) spam
+  campaign that Gmail apparently has no interest in stopping.
+  if (connection.transaction.header.get_decoded('subject').match(/\p{Emoji}/gu)) {
+    connection.results.add(this, { msg: 'subject_contains_emoji' })
+    if (connection.transaction.mail_from.host === 'gmail.com') {
+      connection.results.incr(this, { score: -10 })
+      connection.results.add(this, { msg: 'emoji_from_gmail' })
+    }
+  }
+  */
+
   this.check_awards(connection) // update awards
 
   const results = connection.results.collate(this)
@@ -967,7 +980,6 @@ exports.check_asn = function (connection, asnkey) {
   if (!this.db) return
 
   const report_as = { name: this.name }
-
   if (this.cfg.asn.report_as) report_as.name = this.cfg.asn.report_as
 
   this.db
@@ -981,30 +993,24 @@ exports.check_asn = function (connection, asnkey) {
 
       this.db.hIncrBy(asnkey, 'connections', 1)
       const asn_score = parseInt(res.good || 0) - (res.bad || 0)
-      const asn_results = {
-        asn_score,
-        asn_connections: res.connections,
-        asn_good: res.good,
-        asn_bad: res.bad,
-        emit: true,
-      }
 
       if (asn_score) {
+        connection.results.add(report_as, { asn_score: asn_score })
         if (asn_score < -5) {
-          asn_results.fail = 'asn:history'
+          connection.results.add(report_as, { fail: 'asn:history' })
         } else if (asn_score > 5) {
-          asn_results.pass = 'asn:history'
+          connection.results.add(report_as, { pass: 'asn:history' })
         }
       }
 
       if (parseInt(res.bad) > 5 && parseInt(res.good) === 0) {
-        asn_results.fail = 'asn:all_bad'
+        connection.results.add(report_as, { fail: 'asn:all_bad' })
       }
       if (parseInt(res.good) > 5 && parseInt(res.bad) === 0) {
-        asn_results.pass = 'asn:all_good'
+        connection.results.add(report_as, { pass: 'asn:all_good' })
       }
 
-      connection.results.add(report_as, asn_results)
+      connection.results.add(report_as, { emit: true })
     })
     .catch((err) => {
       connection.results.add(this, { err })

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "haraka-plugin-karma",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "A heuristics scoring and reputation engine for SMTP connections",
   "main": "index.js",
   "files": [
     "CHANGELOG.md",
-    "config",
-    "test"
+    "config"
   ],
   "scripts": {
     "format": "npm run prettier:fix && npm run lint:fix",
-    "lint": "npx eslint@^8 *.js test",
-    "lint:fix": "npx eslint@^8 *.js test --fix",
+    "lint": "npx eslint@^9 *.js test",
+    "lint:fix": "npx eslint@^9 *.js test --fix",
     "prettier": "npx prettier . --check",
     "prettier:fix": "npx prettier . --write --log-level=warn",
-    "test": "npx mocha@^10",
+    "test": "npx mocha@^11",
     "versions": "npx dependency-version-checker check",
     "versions:fix": "npx dependency-version-checker update"
   },
@@ -39,7 +38,11 @@
     "redis": "^4.6.13"
   },
   "devDependencies": {
-    "@haraka/eslint-config": "^1.1.2",
+    "@haraka/eslint-config": "^2.0.2",
     "haraka-test-fixtures": "^1.3.4"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "semi": false
   }
 }

package/test/karma.js

@@ -1,913 +0,0 @@
-'use strict'
-
-const assert = require('assert')
-
-const Address = require('address-rfc2821').Address
-const fixtures = require('haraka-test-fixtures')
-const constants = require('haraka-constants')
-
-const stub = fixtures.stub.stub
-
-function _set_up(done) {
-  this.plugin = new fixtures.plugin('karma')
-
-  this.plugin.cfg = { main: {} }
-  this.plugin.deny_hooks = { connect: true }
-  this.plugin.tarpit_hooks = ['connect']
-
-  this.connection = fixtures.connection.createConnection({}, { notes: {} })
-  this.connection.init_transaction()
-
-  done()
-}
-
-describe('karma_init', function () {
-  beforeEach(function (done) {
-    this.plugin = new fixtures.plugin('karma')
-    done()
-  })
-
-  it('load_karma_ini', function (done) {
-    this.plugin.inherits('haraka-plugin-redis')
-    this.plugin.load_karma_ini()
-    assert.ok(this.plugin.cfg.asn)
-    assert.ok(this.plugin.deny_hooks)
-    done()
-  })
-})
-
-describe('results_init', function () {
-  beforeEach(_set_up)
-
-  it('init, pre', function (done) {
-    const r = this.connection.results.get('karma')
-    assert.equal(undefined, r)
-    done()
-  })
-
-  it('init, empty cfg', function (done) {
-    this.plugin.results_init(stub, this.connection)
-    const r = this.connection.results.get('karma')
-    assert.ok(r)
-    done()
-  })
-
-  it('init, cfg', function (done) {
-    this.plugin.cfg.awards = { test: 1 }
-    this.plugin.results_init(stub, this.connection)
-    const r = this.connection.results.get('karma')
-    assert.ok(r)
-    assert.ok(r.todo)
-    done()
-  })
-
-  it('init, skip', function (done) {
-    this.connection.remote.is_private = true
-    this.plugin.results_init(stub, this.connection)
-    const r = this.connection.results.get('karma')
-    assert.equal(undefined, r)
-    done()
-  })
-
-  it('init, private skip', function (done) {
-    this.connection.notes.disable_karma = true
-    this.plugin.results_init(stub, this.connection)
-    const r = this.connection.results.get('karma')
-    assert.equal(undefined, r)
-    done()
-  })
-})
-
-describe('assemble_note_obj', function () {
-  beforeEach(_set_up)
-
-  it('no auth fails', function (done) {
-    const obj = this.plugin.assemble_note_obj(
-      this.connection,
-      'notes.auth_fails',
-    )
-    assert.equal(undefined, obj)
-    done()
-  })
-
-  it('has auth fails', function (done) {
-    this.connection.notes.auth_fails = [1, 2]
-    const obj = this.plugin.assemble_note_obj(
-      this.connection,
-      'notes.auth_fails',
-    )
-    assert.deepEqual([1, 2], obj)
-    done()
-  })
-})
-
-describe('hook_deny', function () {
-  beforeEach(_set_up)
-
-  it('no params', function (done) {
-    const next = function (rc) {
-      assert.equal(constants.OK, rc, rc)
-      done()
-    }
-    this.plugin.hook_deny(next, this.connection, ['', '', '', ''])
-  })
-
-  it('pi_name=karma', function (done) {
-    const next = function (rc) {
-      assert.equal(undefined, rc)
-      done()
-    }
-    this.plugin.hook_deny(next, this.connection, ['', '', 'karma', ''])
-  })
-
-  it('pi_name=access', function (done) {
-    const next = function (rc) {
-      assert.equal(undefined, rc)
-      done()
-    }
-    this.plugin.deny_exclude_plugins = { access: true }
-    this.plugin.hook_deny(next, this.connection, ['', '', 'access', ''])
-  })
-
-  it('pi_hook=rcpt_to', function (done) {
-    const next = function (rc) {
-      assert.equal(undefined, rc)
-      done()
-    }
-    this.plugin.deny_exclude_hooks = { rcpt_to: true }
-    this.plugin.hook_deny(next, this.connection, [
-      '',
-      '',
-      '',
-      '',
-      '',
-      'rcpt_to',
-    ])
-  })
-
-  it('pi_hook=queue', function (done) {
-    const next = function (rc) {
-      assert.equal(undefined, rc)
-      done()
-    }
-    this.plugin.deny_exclude_hooks = { queue: true }
-    this.plugin.hook_deny(next, this.connection, ['', '', '', '', '', 'queue'])
-  })
-
-  it('denysoft', function (done) {
-    const next = function (rc) {
-      assert.equal(constants.OK, rc)
-      done()
-    }
-    this.plugin.hook_deny(next, this.connection, [
-      constants.DENYSOFT,
-      '',
-      '',
-      '',
-      '',
-      '',
-    ])
-  })
-})
-
-describe('get_award_location', function () {
-  beforeEach(_set_up)
-
-  it('relaying=false', function (done) {
-    this.connection.relaying = false
-    const r = this.plugin.get_award_location(this.connection, 'relaying')
-    assert.equal(false, r)
-    done()
-  })
-
-  it('relaying=true', function (done) {
-    this.connection.relaying = true
-    const r = this.plugin.get_award_location(this.connection, 'relaying')
-    assert.equal(true, r)
-    done()
-  })
-
-  it('notes.undef=2', function (done) {
-    const r = this.plugin.get_award_location(this.connection, 'notes.undef')
-    assert.equal(undefined, r)
-    done()
-  })
-
-  it('notes.tarpit=2', function (done) {
-    this.connection.notes = { tarpit: 2 }
-    const r = this.plugin.get_award_location(this.connection, 'notes.tarpit')
-    assert.equal(2, r)
-    done()
-  })
-
-  it('results.geoip', function (done) {
-    this.connection.results.add('geoip', { country: 'US' })
-    const r = this.plugin.get_award_location(this.connection, 'results.geoip')
-    // console.log(r);
-    assert.equal('US', r.country)
-    done()
-  })
-
-  it('results.karma', function (done) {
-    this.connection.results.add('karma', { score: -1 })
-    const r = this.plugin.get_award_location(this.connection, 'results.karma')
-    // console.log(r);
-    assert.equal(-1, r.score)
-    done()
-  })
-
-  it('results.karma, txn', function (done) {
-    // results should be found in conn or txn
-    this.connection.transaction.results.add('karma', { score: -1 })
-    const r = this.plugin.get_award_location(this.connection, 'results.karma')
-    // console.log(r);
-    assert.equal(-1, r.score)
-    done()
-  })
-
-  it('txn.results.karma', function (done) {
-    // these results shouldn't be found, b/c txn specified
-    this.connection.results.add('karma', { score: -1 })
-    const r = this.plugin.get_award_location(
-      this.connection,
-      'transaction.results.karma',
-    )
-    // console.log(r);
-    assert.equal(undefined, r)
-    done()
-  })
-
-  it('results.auth/auth_base', function (done) {
-    this.connection.results.add('auth/auth_base', { fail: 'PLAIN' })
-    const r = this.plugin.get_award_location(
-      this.connection,
-      'results.auth/auth_base',
-    )
-    assert.equal('PLAIN', r.fail[0])
-    done()
-  })
-})
-
-describe('get_award_condition', function () {
-  beforeEach(_set_up)
-  it('geoip.distance', function (done) {
-    assert.equal(
-      4000,
-      this.plugin.get_award_condition(
-        'results.geoip.distance@4000',
-        '-1 if gt',
-      ),
-    )
-    assert.equal(
-      4000,
-      this.plugin.get_award_condition(
-        'results.geoip.distance@uniq',
-        '-1 if gt 4000',
-      ),
-    )
-    done()
-  })
-
-  it('auth/auth_base', function (done) {
-    assert.equal(
-      'plain',
-      this.plugin.get_award_condition(
-        'results.auth/auth_base.fail@plain',
-        '-1 if in',
-      ),
-    )
-    done()
-  })
-})
-
-describe('check_awards', function () {
-  beforeEach(_set_up)
-
-  it('no results', function (done) {
-    const r = this.plugin.check_awards(this.connection)
-    assert.equal(undefined, r)
-    done()
-  })
-
-  it('no todo', function (done) {
-    this.connection.results.add('karma', { todo: {} })
-    const r = this.plugin.check_awards(this.connection)
-    assert.equal(undefined, r)
-    done()
-  })
-
-  it('geoip gt', function (done) {
-    // populate the karma result with a todo item
-    this.connection.results.add('karma', {
-      todo: { 'results.geoip.distance@4000': '-1 if gt 4000' },
-    })
-    // test a non-matching criteria
-    this.connection.results.add('geoip', { distance: 4000 })
-    // check awards
-    this.plugin.check_awards(this.connection)
-    assert.equal(undefined, this.connection.results.get('karma').fail[0])
-
-    // test a matching criteria
-    this.connection.results.add('geoip', { distance: 4001 })
-    // check awards
-    this.plugin.check_awards(this.connection)
-    // test that the award was applied
-    assert.equal('geoip.distance', this.connection.results.get('karma').fail[0])
-
-    done()
-  })
-
-  it('auth failure', function (done) {
-    this.connection.results.add('karma', {
-      todo: { 'results.auth/auth_base.fail@PLAIN': '-1 if in' },
-    })
-    this.connection.results.add('auth/auth_base', { fail: 'PLAIN' })
-    const r = this.plugin.check_awards(this.connection)
-    assert.equal(undefined, r)
-    assert.equal(
-      'auth/auth_base.fail',
-      this.connection.results.get('karma').fail[0],
-    )
-    done()
-  })
-
-  it('valid recipient', function (done) {
-    this.connection.results.add('karma', {
-      todo: { 'results.rcpt_to.qmd.pass@exist': '1 if in' },
-    })
-    this.connection.results.add('rcpt_to.qmd', { pass: 'exist' })
-    const r = this.plugin.check_awards(this.connection)
-    assert.equal(undefined, r)
-    assert.equal('qmd.pass', this.connection.results.get('karma').pass[0])
-    done()
-  })
-})
-
-describe('apply_tarpit', function () {
-  beforeEach(_set_up)
-
-  it('tarpit=false', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.apply_tarpit(this.connection, 'connect', 0, next)
-  })
-
-  it('tarpit=true, score=0', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.plugin.apply_tarpit(this.connection, 'connect', 0, next)
-  })
-
-  it('tarpit=true, score=1', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.plugin.apply_tarpit(this.connection, 'connect', 1, next)
-  })
-
-  it('tarpit=true, score=-1', function (done) {
-    const before = Date.now()
-    const next = function (rc, msg) {
-      assert.ok(Date.now() >= before + 1)
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.plugin.apply_tarpit(this.connection, 'connect', -1, next)
-  })
-
-  it('tarpit=true, score=-2, max=1', function (done) {
-    const before = Date.now()
-    const next = function (rc, msg) {
-      assert.ok(Date.now() >= before + 1)
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.plugin.apply_tarpit(this.connection, 'connect', -2, next)
-  })
-
-  it('tarpit=true, score=connect, max=1', function (done) {
-    const before = Date.now()
-    const next = function (rc, msg) {
-      assert.ok(Date.now() >= before + 1)
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.connection.results.add(this.plugin, { score: -2 })
-    this.plugin.apply_tarpit(this.connection, 'connect', -2, next)
-  })
-})
-
-describe('should_we_deny', function () {
-  beforeEach(_set_up)
-
-  it('no results', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.plugin.should_we_deny(next, this.connection, 'connect')
-  })
-
-  it('no score', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.connection.results.add(this.plugin, { test: 'blah' })
-    this.plugin.should_we_deny(next, this.connection, 'connect')
-  })
-
-  it('invalid score', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }
-    this.connection.results.add(this.plugin, { score: 'blah' })
-    this.plugin.should_we_deny(next, this.connection, 'connect')
-  })
-
-  it('valid score, okay', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }.bind(this)
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.connection.results.add(this.plugin, { score: -1 })
-    this.plugin.should_we_deny(next, this.connection, 'connect')
-  })
-
-  it('valid score, -6, deny_hook', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(constants.DENY, rc)
-      assert.ok(msg)
-      done()
-    }.bind(this)
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.plugin.deny_hooks = { connect: true }
-    this.connection.results.add(this.plugin, { score: -6 })
-    this.plugin.should_we_deny(next, this.connection, 'connect')
-  })
-
-  it('valid score, -6, pass_hook', function (done) {
-    const next = function (rc, msg) {
-      assert.equal(undefined, rc)
-      assert.equal(undefined, msg)
-      done()
-    }.bind(this)
-    this.plugin.cfg.tarpit = { max: 1, delay: 0 }
-    this.plugin.deny_hooks = { helo: true }
-    this.connection.results.add(this.plugin, { score: -6 })
-    this.plugin.should_we_deny(next, this.connection, 'connect')
-  })
-})
-
-describe('check_result_equal', function () {
-  beforeEach(_set_up)
-
-  it('equal match is scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'equals',
-      value: 'clean',
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_equal(['clean'], award, this.connection)
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('not equal match is not scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'equals',
-      value: 'dirty',
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_equal(['clean'], award, this.connection)
-    assert.equal(this.connection.results.store.karma, undefined)
-    done()
-  })
-})
-
-describe('check_result_gt', function () {
-  beforeEach(_set_up)
-
-  it('gt match is scored', function (done) {
-    const award = {
-      id: 5,
-      award: 3,
-      operator: 'gt',
-      value: 3,
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_gt([4], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 3)
-    assert.equal(this.connection.results.store.karma.awards[0], 5)
-    done()
-  })
-})
-
-describe('check_result_lt', function () {
-  beforeEach(_set_up)
-
-  it('lt match is scored', function (done) {
-    const award = {
-      id: 2,
-      award: 3,
-      operator: 'lt',
-      value: 5,
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_lt([4], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 3)
-    assert.equal(this.connection.results.store.karma.awards[0], 2)
-    done()
-  })
-
-  it('lt match not scored', function (done) {
-    const award = {
-      id: 3,
-      award: 3,
-      operator: 'lt',
-      value: 3,
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_lt([4], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma, undefined)
-    done()
-  })
-})
-
-describe('check_result_match', function () {
-  beforeEach(_set_up)
-
-  it('match pattern is scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'match',
-      value: 'phish',
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_match(['isphishing'], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('mismatch is not scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'match',
-      value: 'dirty',
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_match(['clean'], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma, undefined)
-    done()
-  })
-
-  it('FCrDNS match is scored', function (done) {
-    const award = {
-      id: 89,
-      award: 2,
-      operator: 'match',
-      value: 'google.com',
-      reason: 'testing',
-      resolution: 'never',
-    }
-    this.plugin.check_result_match(
-      ['mail-yk0-f182.google.com'],
-      award,
-      this.connection,
-    )
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 89)
-    done()
-  })
-})
-
-describe('check_result_length', function () {
-  beforeEach(_set_up)
-  it('eq pattern is scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'length',
-      value: 'eq 3',
-      reason: 'testing',
-      resolution: 'hah',
-    }
-    this.plugin.check_result_length(['3'], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('eq pattern is not scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'length',
-      value: 'eq 3',
-      reason: 'testing',
-      resolution: 'hah',
-    }
-    this.plugin.check_result_length(['4'], award, this.connection)
-    // console.log(this.connection.results.store.karma);
-    assert.deepEqual(this.connection.results.store.karma, undefined)
-    done()
-  })
-
-  it('gt pattern is scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'length',
-      value: 'gt 3',
-      reason: 'testing',
-      resolution: 'hah',
-    }
-    this.plugin.check_result_length(['5'], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('gt pattern is not scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'length',
-      value: 'gt 3',
-      reason: 'testing',
-      resolution: 'hah',
-    }
-    this.plugin.check_result_length(['3'], award, this.connection)
-    // console.log(this.connection.results.store.karma);
-    assert.deepEqual(this.connection.results.store.karma, undefined)
-    done()
-  })
-
-  it('lt pattern is scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'length',
-      value: 'lt 3',
-      reason: 'testing',
-      resolution: 'hah',
-    }
-    this.plugin.check_result_length(['2'], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('lt pattern is not scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'length',
-      value: 'lt 3',
-      reason: 'testing',
-      resolution: 'hah',
-    }
-    this.plugin.check_result_length(['3'], award, this.connection)
-    // console.log(this.connection.results.store.karma);
-    assert.deepEqual(this.connection.results.store.karma, undefined)
-    done()
-  })
-})
-
-describe('check_result_exists', function () {
-  beforeEach(_set_up)
-
-  it('exists pattern is scored', function (done) {
-    const award = {
-      id: 1,
-      award: 2,
-      operator: 'exists',
-      value: 'any',
-      reason: 'testing',
-      resolution: 'high five',
-    }
-    this.plugin.check_result_exists(['3'], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('not exists pattern is not scored', function (done) {
-    const award = {
-      id: 1,
-      award: 3,
-      operator: 'exists',
-      value: '',
-      reason: 'testing',
-      resolution: 'misses',
-    }
-    this.plugin.check_result_exists([], award, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma, undefined)
-    assert.equal(this.connection.results.store.karma, undefined)
-    done()
-  })
-})
-
-describe('check_result', function () {
-  beforeEach(_set_up)
-
-  it('geoip country is scored', function (done) {
-    this.plugin.cfg.result_awards = {
-      1: 'geoip | country | equals | CN | 2',
-    }
-    this.plugin.preparse_result_awards()
-    this.connection.results.add({ name: 'geoip' }, { country: 'CN' })
-    this.plugin.check_result(
-      this.connection,
-      '{"plugin":"geoip","result":{"country":"CN"}}',
-    )
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, 2)
-    assert.equal(this.connection.results.store.karma.awards[0], 1)
-    done()
-  })
-
-  it('dnsbl listing is scored', function (done) {
-    this.plugin.cfg.result_awards = {
-      2: 'dnsbl | fail | equals | dnsbl.sorbs.net | -5',
-    }
-    this.plugin.preparse_result_awards()
-    this.connection.results.add({ name: 'dnsbl' }, { fail: 'dnsbl.sorbs.net' })
-    this.plugin.check_result(
-      this.connection,
-      '{"plugin":"dnsbl","result":{"fail":"dnsbl.sorbs.net"}}',
-    )
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, -5)
-    assert.equal(this.connection.results.store.karma.awards[0], 2)
-    done()
-  })
-})
-
-describe('check_spammy_tld', function () {
-  beforeEach(_set_up)
-
-  it('spammy TLD is scored: top', function (done) {
-    this.plugin.cfg.spammy_tlds = { top: -3 }
-    const mfrom = new Address('spamy@er7diogt.rrnsale.top')
-    this.plugin.check_spammy_tld(mfrom, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, -3)
-    assert.equal(this.connection.results.store.karma.fail[0], 'spammy.TLD')
-    done()
-  })
-
-  it('spammy TLD is scored: rocks', function (done) {
-    this.plugin.cfg.spammy_tlds = { rocks: '-2' }
-    const mfrom = new Address('spamy@foo.rocks')
-    this.plugin.check_spammy_tld(mfrom, this.connection)
-    // console.log(this.connection.results.store);
-    assert.equal(this.connection.results.store.karma.score, -2)
-    assert.equal(this.connection.results.store.karma.fail[0], 'spammy.TLD')
-    done()
-  })
-})
-
-describe('tls', function () {
-  beforeEach(_set_up)
-
-  it('unconfigured TLS does nothing', function (done) {
-    this.connection.tls.enabled = true
-    const mfrom = new Address('spamy@er7diogt.rrnsale.top')
-    this.connection.current_line = 'MAIL FROM:<foo@test.com>'
-    this.plugin.hook_mail(
-      () => {
-        assert.equal(this.connection.results.store.karma, undefined)
-        done()
-      },
-      this.connection,
-      [mfrom],
-    )
-  })
-
-  it('TLS is scored', function (done) {
-    this.plugin.cfg.tls = { set: 2, unset: -4 }
-    this.connection.tls.enabled = true
-    const mfrom = new Address('spamy@er7diogt.rrnsale.top')
-    this.connection.current_line = 'MAIL FROM:<foo@test.com>'
-    this.plugin.hook_mail(
-      () => {
-        // console.log(this.connection.results.store);
-        assert.equal(this.connection.results.store.karma.score, 2)
-        done()
-      },
-      this.connection,
-      [mfrom],
-    )
-  })
-
-  it('no TLS is scored', function (done) {
-    this.plugin.cfg.tls = { set: 2, unset: -4 }
-    this.connection.tls.enabled = false
-    const mfrom = new Address('spamy@er7diogt.rrnsale.top')
-    this.connection.current_line = 'MAIL FROM:<foo@test.com>'
-    this.plugin.hook_mail(
-      () => {
-        // console.log(this.connection.results.store);
-        assert.equal(this.connection.results.store.karma.score, -4)
-        done()
-      },
-      this.connection,
-      [mfrom],
-    )
-  })
-})
-
-describe('skipping hooks', function () {
-  beforeEach(_set_up)
-
-  it('notes.disable_karma', function (done) {
-    function next(rc) {
-      assert.equal(undefined, rc)
-    }
-    function last(rc) {
-      assert.equal(undefined, rc)
-      done()
-    }
-    this.connection.notes.disable_karma = true
-
-    this.plugin.hook_deny(next, this.connection)
-    this.plugin.hook_connect(next, this.connection)
-    this.plugin.hook_ehlo(next, this.connection)
-    this.plugin.hook_vrfy(next, this.connection)
-    this.plugin.hook_noop(next, this.connection)
-    this.plugin.hook_data(next, this.connection)
-    this.plugin.hook_queue(next, this.connection)
-    this.plugin.hook_reset_transaction(next, this.connection)
-    this.plugin.hook_unrecognized_command(last, this.connection)
-  })
-
-  it('private skip', function (done) {
-    function next(rc) {
-      assert.equal(undefined, rc)
-    }
-    function last(rc) {
-      assert.equal(undefined, rc)
-      done()
-    }
-    this.connection.remote.is_private = true
-
-    this.plugin.hook_deny(next, this.connection)
-    this.plugin.hook_connect(next, this.connection)
-    this.plugin.hook_ehlo(next, this.connection)
-    this.plugin.hook_vrfy(next, this.connection)
-    this.plugin.hook_noop(next, this.connection)
-    this.plugin.hook_data(next, this.connection)
-    this.plugin.hook_queue(next, this.connection)
-    this.plugin.hook_reset_transaction(next, this.connection)
-    this.plugin.hook_unrecognized_command(last, this.connection)
-  })
-})