Rspamd

Fast, free and open-source spam filtering system.

Rspamd 1.8.2 has been released

2018-11-19 00:00:00 +0100

We have released Rspamd 1.8.2 today.

There are no incompatible changes introduced with this version to our best knowledge. However, due to Bayes changes, you might see slightly different Bayes outcomes. rspamd_update module is now disabled by default as we are working on a better and safer solution that will be available in the next Rspamd version.

The most important features and fixes

  • Critical fixes in SURBL module

    SURBL module could insert absurd scores and skip group symbol limit in some cases.

  • Critical fixes in Bayes statistics

    Bayes algorithm has been changed significantly in this release:

    • If chi-squared method fails due to exp underflow, Rspamd will switch to a naive method
    • Tokens weighting has been reworked to match chi-squared model
    • OSB weights have been adjusted to discriminate more far tokens and increase weight for closer tokens
    • Reworked meta-tokens algorithm, it is now moved to Lua
    • Skip stop words in statistics
  • Fuzzy check rework

    In this version, we have moved selection algorithm from C to Lua with more flexibility about parts and data selection.

  • Critical fixes in Ratelimit module

    We have found and fixed various issues in Ratelimit plugin and restored both traditional and modern syntax of ratelimits. Presumably, all version prior this one are broken when dealing with ratelimits.

  • Major rework of all asynchronous rules and events

    In Rspamd 1.8.2, we have introduced new model of asynchronous rules processing with the following features:

    • More straightforward in terms of the control flow
    • It is possible to get better debugging info in case of issues (including the concrete line of code)
    • It is possible now to see the real execution time of rules and show slow rules including network waiting
    • New model is less complex than the previous one
  • Critical issue in ARC module

    We have fixed the issue in ARC module that could lead to around 11% of wrong signatures being produced due to an incorrect \0 handling in raw RSA signature.

  • Add support for encrypted cookies in Message-ID

    It is now possible to generate and check message-ids that require no storage and Rspamd even don’t need to observe outbound messages. However, it will be able to detect replies to our messages and get some more information if needed:

    We generate message id using nonce||aesencrypt(nonce, k, known_cookie) then we can just take a look into In-Reply-To header and apply read_nonce() + aesdecrypt(nonce, k) to compare result with known_cookie.

    Nonce length will be 16 bytes (32 hex encoded) and another 16 bytes could be used to encrypt secret cookie + some random thing derived from the message itself.

  • Added DWL support in the default configuration
  • Add support of words regexps
  • Allow to set custom limits for upstream lists
  • Detect orphaned parts and attach them to message
  • Support query arguments in controller’s custom commands
  • Write DKIM selector in dkim allow/reject symbols

Full list of the meaningful changes

  • [Conf] Add DWL support in the default configuration
  • [Conf] Disable rspamd_update by default (again)
  • [Conf] Fix configuration sample for ratelimit
  • [CritFix] Disable broken url tags by default
  • [CritFix] Fix \0 processing when doing RSA sign
  • [CritFix] Fix adding symbols to their primary groups
  • [Feature] Add rspamadm cookie utility
  • [Feature] Add specialised functions for generating encrypted cookies
  • [Feature] Add support of cookies in replies module
  • [Feature] Add support of words regexps
  • [Feature] Allow to add 3rd party clang plugins
  • [Feature] Allow to create lua regexps from glob or plain patterns
  • [Feature] Allow to set custom limits for upstream lists
  • [Feature] Detect orphaned parts and attach them to message
  • [Feature] Filter tokens in bayes
  • [Feature] Fold b= value when doing arc sealing
  • [Feature] Ignore cookies in the future and too old in the past
  • [Feature] Skip stop words in statistics
  • [Feature] Store stop words and allow to query them
  • [Feature] Support query arguments in controller’s custom commands
  • [Feature] Tune upstream limits in Rspamd proxy
  • [Feature] Use different callback symbols for different uribls
  • [Feature] Write DKIM selector in dkim allow/reject symbols
  • [Fix] Add obs_fws state support to eoh state machine
  • [Fix] Add sanity check when applying mime boundaries heuristic
  • [Fix] Antivirus - virus names with 0 were recognized as tables
  • [Fix] Disable headernames in bayes temporarily
  • [Fix] Do not allow syntax errors in include files…
  • [Fix] Do not allow to merge an object with an array (or vice versa)
  • [Fix] Don’t perform forged recipients check for missing recipients
  • [Fix] Fix DKIM based RBLs
  • [Fix] Fix actrie implementation (sync from upstream), fixed OOB read
  • [Fix] Fix explicit methods call in selectors
  • [Fix] Fix extraction of additional parts
  • [Fix] Fix finalization for internal plugins
  • [Fix] Fix override_defaults function
  • [Fix] Fix squeezed symbols when using settings
  • [Fix] Fix urls insertion in Clickhouse module
  • [Fix] Furhter fixes to ratelimits logic
  • [Fix] Ignore signatures when looking for boundaries
  • [Fix] Properly set learned count
  • [Fix] Really fix ratelimits configuration and work
  • [Fix] Remove ambigious format flag from printf
  • [Fix] Restore URLs exporting in ClickHouse plugin
  • [Fix] Rework bayes calculations…
  • [Fix] Switch from chi-square to naive for large Fisher value
  • [Fix] Treat normal password as enable password if there is no enable password
  • [Fix] Use proper syntax for making DNS requests
  • [Fix] Various fixes in embedded plugins
  • [Project] Change fuzzy check selection logic to lua_fuzzy library
  • [Project] Rework async events and symbols
  • [Project] Move all metatokens in Bayes to lua_stat from C
  • [WebUI] Add history rows per page control

Rspamd 1.8.1 has been released

2018-10-16 00:00:00 +0200

We have released Rspamd 1.8.1 today.

There are couple of the incompatibilities introduced, hence, please check the migration notes. These incompatibilities could affect almost any Rspamd installation with custom configuration, so please read the upgrade notes carefully.

The most important features and fixes

  • Critical fixes in DMARC module

    DMARC module could insert temporary failure symbol instead of strong rejection in certain cases. This has been fixed in 1.8.1. There are many other bugs fixed in this module since the whole check logic has been rewritten in accordance to RFC.

  • Fuzzy check

    Due to bug introduced in 1.8.0, there algorithm used to deterministically skip words in large text parts was not deterministic. It means that the exact words pipelines produced by different Rspamd instances might be different. It could affect if your words_limit was reached (default: words_decay = 200 words). Hence, for large text parts it was expected to have misses in fuzzy and in Bayes classification. Whilst bayes missing should not be significant, the fuzzy misses might be very severe and they might break fuzzy detection for large text parts.

    In 1.8.1, we have fixed this issue and, since we have already broken the compatibility with 1.7.9, we have decided to increase words_decay to 600. Please ensure that you don’t override this parameter anywhere (e.g. in local.d/options.inc, override.d/options.inc or any other override or local file) or your compatibility with Rspamd fuzzy storage would be lost for messages with more than words_decay threshold words.

  • Various language detection issues have been fixed
  • Experimental clustering plugin
  • Important fixes for the dynamic ratelimits
  • Fix options insertion
  • Plug memory leak in redis pool
  • Add check_violation feature to DKIM/ARC signing to avoid signing messages when there is an existing invalid DKIM signature
  • Add only unique elements to Clickhouse url arrays
  • Allow g+: and g-: composite atoms to include symbols with positive score and negative score
  • Allow dkim domains check in surbl module
  • Allow maps with HTTP auth using standard URL syntax
  • Allow to disable actions by users settings by setting them to null
  • Extend whitelisting options:
    • Allow per element whitelist/blacklist only behaviour
    • Introduce three types of lists:
      • Blacklists (bl)
      • Whitelists (wl)
      • Bidirectional lists (both)
  • Use heuristical verdict instead of the plain action in plugins to detect if a message is clearly spam, junk, ham or uncertain when there is not enough confidence despite of the action being set
  • Various Web Interface improvements and fixes driven by Alexander Moisseev

Full list of the meaningful changes

  • [CritFix] Fix options insertion
  • [CritFix] Fix words decay one more time (affects long messages)
  • [CritFix] Increase default words_decay
  • [CritFix] Plug memory leak in redis pool
  • [Feature] Add check_violation feature to DKIM/ARC signing
  • [Feature] Add only unique elements to Clickhouse url arrays
  • [Feature] Allow g+: and g-: composite atoms
  • [Feature] Allow dkim domains check in surbl
  • [Feature] Allow maps with HTTP auth
  • [Feature] Allow to disable actions by users settings
  • [Feature] Extend whitelisting options
  • [Feature] Store url object in images
  • [Feature] Use verdict instead of the plain action in plugins
  • [Fix] Allow to call fstring append with NULL string
  • [Fix] DCC - luacheck
  • [Fix] Do not load torch on each rspamadm invocation
  • [Fix] Fix boundaries detection and rework stop words algorithm
  • [Fix] Fix dependencies for DNS_SIGNED symbol
  • [Fix] Fix errors when dealing with dynamic rates/bursts in Ratelimit
  • [Fix] Fix groups mess
  • [Fix] Fix groups mess
  • [Fix] Fix parsing address with comments
  • [Fix] Fix resolving in DMARC reports
  • [Fix] Fix various issues with parsing of the received headers
  • [Fix] Fix watchers issue in lua_tcp when doing no resolving
  • [Fix] Plug memory leak in language detector (affects reloads)
  • [Fix] Remove one letter stop words
  • [Fix] Slashing: backport chunk logic from libucl
  • [Fix] Stop libevent from using cached time in rspamadm
  • [Fix] Try to fix watchers chaining
  • [Fix] Various fixes in redis sync interface
  • [Fix] ip_score - respect check_authed and check_local settings from config
  • [Project] Rework passthrough actions
  • [Project] Clustering module
  • [Rework] Always create result for a task
  • [Rework] Completely rewrite DMARC checks logic
  • [Rework] Rework and fix whitelist plugin
  • [WebUI] Add symbols sorting buttons
  • [WebUI] Change symbols order without updating history
  • [WebUI] Colorize symbols
  • [WebUI] Do not display password form when secure_ip is set
  • [WebUI] Fix symbol description tooltips display
  • [WebUI] History: add sorting by symbol score value

Rspamd 1.8.0 has been released

2018-09-24 00:00:00 +0200

We have released Rspamd 1.8.0 today.

There are couple of the incompatibilities introduced, hence, please check the migration notes, especially if you use clickhouse module or users settings.

The most important features and fixes

  • New selectors framework

    This framework allows to combine and process different data extracted from messages and use that in different plugins, such as multimap, reputation or ratelimits. It is also possible to use data extracted in Rspamd regular expressions.

  • Coroutines API support in Lua

    Now you can write code in a usual imperative manner but you still will not block any other tasks. Each potentially blocking operation creates a yielding-point. In turn, this means the code is suspended until the operation is done (just like blocking) and resumes only when there is some result. Meanwhile, other tasks are processed as usual.

  • Clickhouse optimization

    Rspamd now uses a flat table to optimize ClickHouse SQL requests. In fact, joins are not recommended by the ClickHouse developers as multiple joins have proven to be slow. Hence, Rspamd has moved all data to a single table. Schema migration is done automatically, however, please read the migration notes in case of any doubts. Old data is not migrated nor deleted automatically.

    There is now optional data retention support in the ClickHouse module. You can set retention policies for the data stored in Clickhouse to conform different regulations (e.g. GDPR).

  • Unicode processing improvements

    Rspamd now normalizes all unicode data using NFKC schema prior to processing. This helps to prevent “glyph” attacks used by some spammers nowadays. Unicode conversion has also been improved to continue on bad symbols instead of giving up and working with raw data.

  • Language detection improvements

    We have reworked the language detector to use stop-words and rely on unicode glyphs more extensively. As the result of this work, the speed of language detection has been increased significantly (by 10 times in some cases). The preciseness of the detection has also been improved.

  • Fixed various bugs in sesssions handling

    We have located and fixed various hidden issues caused by async rules chaining. It might cause inconsistencies in the dependencies processing, crashes in rare cases and other “bad things”.

  • Various Web Interface improvements and fixes

    There are multiple improvements and fixes in the Web Interface. In particular, the issues with cluster support and aggregation have been addressed.

  • New mailing lists for the project

    • Rspamd-Users: general purpose mailing list that will replace this group
    • Rspamd-Announce: read only list with low traffic that is intended for project announcements only, for example, new versions, or vulnerabilities disclosures

    Unfortunately, there is no automatic conversion from the Google groups to the new mailing lists, hence, you need to subscribe to those lists manually. We are sorry about the potential inconveniences caused by this transition.

    To subscribe to a list, click the list name at https://lists.rspamd.com/mailman/listinfo . The page that is displayed should contain all of the necessary subscription instructions for that list. You can always find all possible support channels here.

Full list of the meaningful changes

  • [Feature] Add arguments schemas to processors and extractors
  • [Feature] Add functional selectors library
  • [Feature] Add generic selector to reputation module
  • [Feature] Add more ratelimits: by digest, by attachments data, by filenames
  • [Feature] Add preliminary stop words detection support
  • [Feature] Add pure Lua debugm function
  • [Feature] Add schema validation for Redis settings
  • [Feature] Add selectors combine function
  • [Feature] Add some recursion protection to lua logger
  • [Feature] Add support for Lua API tracing
  • [Feature] Allow to apply schema to arguments
  • [Feature] Allow to get dkim signing data directly from HTTP headers
  • [Feature] Allow to reuse existing authentication results
  • [Feature] Cache selectors results in re runtime
  • [Feature] Implement new text tokenizer based on libicu
  • [Feature] Integrate selectors framework to multimap
  • [Feature] Relax FORGED_RECIPIENTS
  • [Feature] Support (almost) all html entities
  • [Feature] Support adding and deletion of recipients in the milter block
  • [Feature] Support gathering HTTP body from fragments in lua_http
  • [Feature] Support multi flag in regexp and glob maps
  • [Feature] Support selectors in ratelimit module
  • [Feature] Support selectors in settings
  • [Feature] Use khash in HTML parser
  • [Feature] Use pure Lua debugm function
  • [Fix] Add fail-safety for destroying sessions
  • [Fix] Allow to add result-less fake DNS records
  • [Fix] Another try to fix race conditions on config unload
  • [Fix] Call Lua callback on DNS timeouts
  • [Fix] Deprecate task:inc_dns_req as it is redundant
  • [Fix] Do not allow events deletions on cleanup
  • [Fix] Do not try to process skipped messages
  • [Fix] Fix HTTP requests with no body
  • [Fix] Fix another cleanup race condition
  • [Fix] Fix bug in processing of pcre regexps
  • [Fix] Fix byte array allocation in the pool
  • [Fix] Fix crashes on task cleanup
  • [Fix] Fix dynamic buckets in ratelimits
  • [Fix] Fix endless loop when waiting for Rspamd to stop
  • [Fix] Fix lua_util.str_split in case of delimiters set
  • [Fix] Fix more issues with watching of async events
  • [Fix] Fix stop words detection and loading logic
  • [Fix] Fix various corner cases for language detection
  • [Fix] Fix watchers in lua_tcp
  • [Fix] Fix words decay algorithm
  • [Fix] Implement watchers replacement to handle nested calls
  • [Fix] Save faked code into fake dns record
  • [Fix] Show the proper frame when using lua_util.debugm
  • [Fix] Use fake dns records in tests
  • [Fix] Use unicode replacements for HTML entities
  • [Fix] fixed “cannot find dependency on symbol 1” issue when using replaced symbols in spamassassin rules
  • [Fix] partition_id is not available in old versions of CH
  • [Project] Add implicit conversion logic to selectors
  • [Project] Add initial support for selectors in regexps
  • [Project] Add method concept
  • [Project] Further changes in unicode operations
  • [Project] Implement Clickhouse migrations
  • [Project] Implement implicit conversions to userdata
  • [Project] Implement insert method
  • [Project] Implement selectors registration for regular expressions
  • [Project] Implement selectors support in re_cache
  • [Project] Improve language detector: cleanup unused files, categorize
  • [Project] Migrate CH data to a fat table
  • [Project] Rework selectors logic
  • [Project] Start Clickhouse utilities library
  • [Project] Start unicode rework
  • [Project] coroutine threaded model for API calls: thread pool
  • [Rework] Move phishtank to a DNS based service
  • [Rework] Rework Clickhouse plugin to use the new API
  • [Rework] Rework language detector
  • [Rework] Rework utf content processing in text parts
  • [WebUI] Add progress bar for AJAX requests
  • [WebUI] Avoid errors table reinitialization
  • [WebUI] Avoid history table reinitialization
  • [WebUI] Avoid throughput summary table reinitialization
  • [WebUI] Destroy summary table on disconnect
  • [WebUI] Fix “auth” request URL
  • [WebUI] Fix disabling and hiding controls on page reload
  • [WebUI] Fix maps loading from neighbours
  • [WebUI] Fix symbols sorting by score
  • [WebUI] Fix tables destroying
  • [WebUI] Fix throughput data consolidation
  • [WebUI] Fix upload buttons disabling
  • [WebUI] Notify user on module loading failure
  • [WebUI] Update FooTable 3.1.4 -> 3.1.6