haraka-plugin-karma 2.1.2 → 2.1.4

package/{Changes.md → CHANGELOG.md}

@@ -1,120 +1,126 @@
+# Changelog
 
-#### N.N.N - YYYY-MM-DD
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
+### Unreleased
+
+### [2.1.4] - 2024-04-06
+
+- eslint: reduce config to depending on @haraka
+- package.json: added scripts
+- doc(CHANGELOG): ordered urls
+- doc(Changes) -> CHANGELOG
+- prettier & eslint configs
+- chore: populate package.json [files]
+
+### [2.1.3] - 2023-12-12
+
+- ci: use shared configs
+- style(es6): replace for..i with for...of
+- deps(\*): bump versions to latest
 
 ### [2.1.2] - 2023-12-11
 
 - config: update several plugin names
 - style(es6): refer to plugin as 'this'
 
-
 ### [2.1.1] - 2023-08-22
 
 - fix: check_result unexpected return #50
 
-
 ### [2.1.0] - 2022-11-29
 
 - fix: in disconnect, call redis_unsub after skip check
 - dep(redis): 4 -> 4.1
 - dep(pi-redis): 2 -> 2.0.5
 
-
-#### 2.0.4 - 2022-05-28
+#### [2.0.4] - 2022-05-28
 
 - use .release as submodule
 
-
-#### 2.0.3 - 2022-05-28
+#### [2.0.3] - 2022-05-28
 
 - fix: depend directly on redis
 - fix: update redis command names for v4 compatibility
 - fix: update redis commands to be async
 
-
-#### 2.0.1 - 2022-05-27
+#### [2.0.1] - 2022-05-27
 
 - chore(ci): depend on shared GHA workflows
 
-
-#### 2.0.0 - 2022-03-29
+#### [2.0.0] - 2022-03-29
 
 - remove lots of plugin=this
 - remove unnecessary braces and trailing ;
 - some promises.
 
-
 #### 1.0.14 - 2022-02-14
 
 - try to unsubscribe in case connection is marked to skip during transaction
 
-
 #### 1.0.13 - 2019-04-23
 
 - add 'exists' pattern
 
-
 #### 1.0.12 - 2019-03-08
 
 - don't interfere with STARTLS and AUTH when karma is listed above those plugins in config/plugins
 
-
 #### 1.0.11 - 2017-10-25
 
 - private addresses and flagged connections exemption
 
-
 #### 1.0.10 - 2017-08-30
 
 - add TLS awards #19
 
-
 #### 1.0.9 - 2017-07-29
 
 - splash on some es6
 - add AppVeyor CI testing
 
-
 #### 1.0.8 - 2017-06-26
 
 - revert #9, it breaks current Haraka deployments
 
-
 #### 1.0.7 - 2017-06-16
 
 - update for eslint 4 compat
 - Add results_redis_publish=true for haraka-results changes #9
 
-
 #### 1.0.6 - 2017-05-04
 
 - emit error if redis plugin didn't create connection
 
-
 #### 1.0.5 - 2017-02-06
 
 - move merge_redis_ini into load_karma_ini, so it also gets applied
   after a karma.ini change
 - skip redis operations when no connection exists
 
-
 #### 1.0.4 - 2017-01-29
 
 - use the new haraka-plugin-redis
 - remove exceptions for soft denials. This makes denial time simpler.
 - rules updates
 
-
 #### 1.0.3 - 2017-01-27
 
 - add rule #280 for known-senders
 - add support for 'length' type, with eq, gt, and lt operators
 - use shared haraka-eslint
 
-
 #### 1.0.2 - 2017-01-24
 
 - use redis.merge_redis_ini()
-[2.1.0]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.1.0
-[2.1.1]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.1.1
-[2.1.2]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.1.2
+
+[2.0.0]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.0.0
+[2.0.1]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.0.1
+[2.0.2]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.0.2
+[2.0.3]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.0.3
+[2.0.4]: https://github.com/haraka/haraka-plugin-karma/releases/tag/2.0.4
+[2.1.0]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.0
+[2.1.1]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.1
+[2.1.2]: https://github.com/haraka/haraka-plugin-karma/releases/tag/v2.1.2
+[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

package/README.md

@@ -18,7 +18,6 @@ One challenge for mail filtering is that filters (or plugins, in Haraka's case)
 
 In order to score a plugins results, plugins must save their results to the [Result Store][results-url]. Karma will see that and apply the awards specified in `karma.ini`.
 
-
 ## How Karma Works
 
 Karma takes a holistic view of **connections**. During the connection, karma collects these results and applies the [result_awards](#awards) defined in `karma.ini`. Once a connection/message exceeds the threshold.negative score (default: -8), karma rejects it at the next [deny]hook.
@@ -32,14 +31,12 @@ The scoring mechanism is not dissimilar to [SpamAssassin][sa-url], but Karma has
     * Access to raw SMTP commands (data + formatting inspection)
     * Can reject connections before DATA (save lots of bandwidth)
 
-Karma is not a replacement for content filters. Karma focuses on the quality of the **connection**. Content filters (bayes\*) focus on the content of the **message**. Karma works best *with* content filters.
-
+Karma is not a replacement for content filters. Karma focuses on the quality of the **connection**. Content filters (bayes\*) focus on the content of the **message**. Karma works best _with_ content filters.
 
 # CONFIG
 
 See config/karma.ini for options and inline documentation.
 
-
 ## <a name="awards"></a>AWARDS
 
 Karma allows the site administrator to control how much weight to assign to
@@ -50,7 +47,6 @@ Karma begins scoring the connection when the first packet arrives. The IP reputa
 
 Karma performs checks early and often, maximizing the penality it can exact upon bad mailers.
 
-
 ## <a name="penalties"></a>Penalties
 
 ### Deny / Reject
@@ -61,7 +57,7 @@ When connections become worse than [thresholds]negative, they are denied during
 
 Karma history is computed as the number of good - bad connections.
 
-When each connection ends, *karma* records the result. When a sufficient history has been built for an IP or ASN, future connections from that address(es) will get a positive or negative karma award.
+When each connection ends, _karma_ records the result. When a sufficient history has been built for an IP or ASN, future connections from that address(es) will get a positive or negative karma award.
 
 The reward is purposefully small, to permit good senders in bad neighborhoods to still send.
 
@@ -98,21 +94,20 @@ When using `karma`, do not use Haraka's `tarpit` plugin.
 
 Connection data that karma considers:
 
-* [IP Reputation](#IP_Reputation)
-* [ASN reputation](#Neighbor_Reputation)
-* DENY events by other plugins
-* envelope sender from a spammy TLD
-* [malformed envelope addresses](#malformed_env)
-* [unrecognized SMTP commands](#unrecognized)
-* matching *env from* and *env to* name (rare in ham, frequent in spam)
+- [IP Reputation](#IP_Reputation)
+- [ASN reputation](#Neighbor_Reputation)
+- DENY events by other plugins
+- envelope sender from a spammy TLD
+- [malformed envelope addresses](#malformed_env)
+- [unrecognized SMTP commands](#unrecognized)
+- matching _env from_ and _env to_ name (rare in ham, frequent in spam)
 
 The data from these tests are helpful but the real power of karma is [scoring
 the results](#awards) of other plugins. See karma.ini for a rich set of examples.
 
-
 ### <a name="IP_Reputation"></a>IP Reputation
 
-Karma records the number of good, bad, and total connections.  The results
+Karma records the number of good, bad, and total connections. The results
 are accessible to other plugins as well.
 
     var karma = connection.results.get('karma');
@@ -142,14 +137,14 @@ connections from each ASN.
 
 ASNs with less than 5 karma points in either direction are ignored.
 
-#### report\_as
+#### report_as
 
 Store the ASN results as another plugin. Example: I set `report_as=asn`, so that karma history for an ASN is reported with the ASN plugin data. A practical consequence of changing report_as is that the award location in karma.ini would need to change from:
 
     NNN karma | pass | equals | asn_all_good |  2
     NNN karma | fail | equals | asn_all_bad  | -3
 
-to: 
+to:
 
     NNN asn | pass | equals | asn_all_good |  2
     NNN asn | fail | equals | asn_all_bad  | -3
@@ -158,7 +153,6 @@ to:
 
 Very old versions of Outlook Express and some malware senders don't bother complying with the RFC (5321, 2821, 821) address format. Karma checks the envelope from and to addresses for a common RFC ignorant pattern that is highly correlated with malware.
 
-
 ### <a name="unrecognized"></a>Unrecognized SMTP verbs/commands
 
 Certain bruteforce password hacking tools have a pre-programmed SMTP path
@@ -190,9 +184,7 @@ Karma plugin is disabled for all private IP addresses according to RFC1918. Opti
 
 Karma is most effective at filtering mail delivered by bots and rogue servers.
 Spam delivered by servers with good reputations normally pass karma's checks.
-Expect to use karma *with* content filters.
-
-
+Expect to use karma _with_ content filters.
 
 [p0f-url]: /manual/plugins/connect.p0f.html
 [geoip-url]: https://github.com/haraka/haraka-plugin-geoip