FreeBSD 12 — py37-matrix-synapse — multiple vulnerabilities (8 CVEs) — patch and remediation guide

📖 ~4 min read  •  Source: FreeBSD VuXML

VuXML topic: py-matrix-synapse — unbounded recursion in urlpreview

Related CVEs: CVE-2019-5885 CVE-2020-26257 CVE-2020-26891 CVE-2021-29471 CVE-2021-39163 CVE-2021-39164 CVE-2021-41281 CVE-2022-31052

Upstream summary: Matrix developers report: This release fixes a vulnerability with Synapse's URL preview feature. URL previews of some web pages can lead to unbounded recursion, causing the request to either fail, or in some cases crash the running Synapse process. Note that: Homeservers with the url_preview_enabled configuration option set to false (the default value) are unaffected. Instances with the enable_media_repo configuration option set to false are also unaffected, as this also disa

Table of contents

1. Symptom & Impact
2. Environment & Reproduction
3. Root Cause Analysis
4. Quick Triage
5. Step-by-Step Diagnosis
6. Solution – Primary Fix
7. Solution – Alternative Approaches
8. Verification & Acceptance Criteria
9. Rollback Plan
10. Prevention & Hardening
11. Related Errors & Cross-Refs
12. References & Further Reading

Symptom & Impact

On FreeBSD 12 hosts running py37-matrix-synapse, the vulnerable code is started by something else – a web or application server, or an on-demand supervisor such as inetd, xinetd or a socket-activated helper – rather than by a service of its own. Patching replaces the files on disk immediately, but a long-running parent that has already loaded them (PHP-FPM workers, an application server, a persistent worker pool) keeps serving the old code until it is recycled. Connection-per-process supervisors pick the fix up on the next connection, so the exposure window differs sharply between the two and is worth confirming rather than assuming. py37-matrix-synapse is started by a hosting server or an on-demand supervisor rather than by a unit of its own, so restart whatever launches it – not py37-matrix-synapse.

Environment & Reproduction

Reproduction targets FreeBSD 12. Confirm release, installed package, and capture baseline state:

freebsd-version -kru
uname -a
pkg info py37-matrix-synapse
pkg query "%n-%v" py37-matrix-synapse
pkg audit -F
service -e

Exercise the workload that uses py37-matrix-synapse while collecting:

tail -200 /var/log/messages
dmesg -a | tail -200
tail -200 /var/log/pkg.log

Root Cause Analysis

Root cause is tracked at FreeBSD VuXML. The FreeBSD ports security team shipped a corrective py37-matrix-synapse port revision; hosts on an outdated build remain exposed. Correlate package logs with system logs and kernel state to isolate the change that triggered the failure mode:

tail -500 /var/log/pkg.log
tail -500 /var/log/messages
sysctl kern.lastpid
sysctl kern.osreldate     # numeric __FreeBSD_version, e.g. 1400097

Quick Triage

Run these checks on FreeBSD 12 to confirm the failure mode and current state of py37-matrix-synapse:

pkg version -v py37-matrix-synapse                # installed vs available version
pkg audit py37-matrix-synapse                     # advisory match for this package
tail -100 /var/log/messages
dmesg -a | tail -100
kldstat                              # kernel module state (for kernel/driver pkgs)
pfctl -sr 2>/dev/null || ipfw list   # only if pf/ipfw is enabled
# e.g. bind918→named, php83→php-fpm), check it:
pkg query '%Fp' py37-matrix-synapse | sed -n 's|.*/etc/rc\.d/||p'  # FreeBSD: the REAL service name(s) = basename of the rc.d script (bind918 -> named, postgresql16-server -> postgresql, apache24 -> apache24)
pkg query '%b' py37-matrix-synapse  # FreeBSD: shared libraries PROVIDED by py37-matrix-synapse. Non-empty here + no rc.d script = it is a library: patch it, then restart its consumers

Step-by-Step Diagnosis

1. List enabled services (only relevant if the package provides one).

   service -e

2. Follow live logs.

   tail -F /var/log/messages
   dmesg

3. Validate firewall rules (skip if neither pf nor ipfw is enabled).

   pfctl -sr -v 2>/dev/null || ipfw show

4. Check package integrity for py37-matrix-synapse.

   pkg check -B py37-matrix-synapse
   pkg check -d py37-matrix-synapse    # verify shared-library deps

5. Reinstall py37-matrix-synapse if integrity check fails.

   pkg install -fy py37-matrix-synapse

6. Correlate findings with /var/log/pkg.log and FreeBSD VuXML to pin the commit that introduced the regression.

Solution – Primary Fix

Install the corrective py37-matrix-synapse port revision referenced by FreeBSD VuXML:

sudo pkg update
sudo pkg upgrade py37-matrix-synapse              # or: sudo pkg upgrade -y for the whole system
pkg audit py37-matrix-synapse                    # confirm no remaining advisory for this package

For ports-tree builders (FreeBSD 13.x and earlier used portsnap; on FreeBSD 14+ the ports tree is fetched with Git):

# FreeBSD 14+ (portsnap was removed):
sudo pkg install -y git-lite
sudo git clone --depth 1 https://git.FreeBSD.org/ports.git /usr/ports
# FreeBSD 13.x and earlier:
# sudo portsnap fetch update
cd /usr/ports/<category>/py37-matrix-synapse
sudo make deinstall reinstall clean

Reboot only if the package ships a kernel module or replaces a shared library used by long-running daemons.

Solution – Alternative Approaches

If the primary fix is not viable, choose from these alternatives:

• Lock the package until the fix is vetted:

  sudo pkg lock py37-matrix-synapse

• Downgrade to a known-good revision. pkg install pkgname-VERSION is not a real downgrade syntax — fetch a specific build instead:

  # 1. Discover available versions across configured repos:
  pkg search -e py37-matrix-synapse
  pkg rquery -r FreeBSD-quarterly '%n-%v' py37-matrix-synapse
  # 2. Install from a specific saved .pkg file:
  sudo pkg add -f /path/to/py37-matrix-synapse-<older-version>.pkg
  # 3. Or switch the host repo to the quarterly branch (see snippet below) and:
  sudo pkg upgrade -fr FreeBSD-quarterly py37-matrix-synapse

• Switch the pkg repository between quarterly and latest by editing /usr/local/etc/pkg/repos/FreeBSD.conf:

  FreeBSD: {
    url: "pkg+https://pkg.FreeBSD.org/${ABI}/quarterly",
    mirror_type: "srv",
    signature_type: "fingerprints",
    fingerprints: "/usr/share/keys/pkg",
    enabled: yes
  }

• Isolate the affected service in a jail with stricter firewall rules:

  iocage create -n py37-matrix-synapse-jail -r 12.4-RELEASE
  iocage set allow_raw_sockets=0 py37-matrix-synapse-jail
  # or with Bastille:
  bastille create py37-matrix-synapse-jail 12.4-RELEASE 10.0.0.10

• Replace the service with a vendored static build for the period between exposure detection and full rollout.

Verification & Acceptance Criteria

All of these should pass after the fix:

pkg info py37-matrix-synapse                # shows the expected fixed version
pkg audit py37-matrix-synapse               # no advisory for this package (exit code 0)
tail -50 /var/log/messages   # no new errors after upgrade
# If py37-matrix-synapse ships a service, confirm it is running under its rc.d name:

The conditions described in the advisory must no longer be reported for py37-matrix-synapse across two consecutive runs.

Rollback Plan

Capture state before any change (only ZFS root has boot environments — UFS hosts skip bectl):

pkg query "%n-%v" > /root/pkg-pre.txt
# ZFS-on-root only:
sudo bectl create pre-py37-matrix-synapse-patch

To revert if the upgrade is bad, reinstall the previously saved .pkg file:

sudo pkg add -f /var/cache/pkg/py37-matrix-synapse-<previous-version>.pkg
# Or activate the pre-patch boot environment and reboot (ZFS-on-root only):
sudo bectl activate pre-py37-matrix-synapse-patch
sudo shutdown -r now

For kernel/loader changes on a UFS host, boot the previous kernel from the loader prompt (press 3 at the menu, then boot kernel.old).

Prevention & Hardening

Prevent recurrence on FreeBSD 12 hosts running py37-matrix-synapse:

• Enable the daily security pkg audit in /etc/periodic.conf:

  daily_status_security_pkgaudit_enable="YES"

• Subscribe to freebsd-security-notifications at lists.freebsd.org.

• Mirror through a local pkg repository managed by poudriere:

  poudriere jail -c -j 12amd64 -v 12.4-RELEASE
  poudriere ports -c -p default
  poudriere bulk -j 12amd64 -p default <category>/py37-matrix-synapse

• Version-pin sensitive packages:

  sudo pkg lock py37-matrix-synapse

• Take an automatic ZFS boot-environment snapshot before every upgrade (ZFS root only):

  sudo bectl create pre-upgrade-$(date +%Y%m%d)

• Monitor file integrity (create a baseline, verify against it later):

  # Create a baseline (use -c; target /usr/local/etc, /etc, /boot — NOT /):
  sudo mtree -c -K sha256digest -p /usr/local/etc > /var/db/usr-local-etc.mtree
  sudo mtree -c -K sha256digest -p /etc          > /var/db/etc.mtree
  # Verify later:
  sudo mtree -p /usr/local/etc < /var/db/usr-local-etc.mtree
  # Or with AIDE for a richer ruleset:
  sudo pkg install -y aide && sudo aide --init && sudo aide --check

• Harden jails with allow.* tunables in /etc/jail.conf:

  py37-matrix-synapse_jail {
    allow.raw_sockets = 0;
    allow.sysvipc    = 0;
    allow.mount      = 0;
    allow.chflags    = 0;
  }

Related Errors & Cross-Refs

Issues that commonly surface alongside a py37-matrix-synapse update: pkg lock contention, mismatched ABI after kernel/userland skew, pf rule drift, and stale shared-library references after upgrade. Triage with:

freebsd-version -kru
uname -K
pkg check -d
pfctl -sr

View all freebsd-12 tutorials on the Tutorials Hub →

Browse all common problems & solutions on the Tutorials Hub.

References & Further Reading

Primary reference: FreeBSD VuXML. Useful manual pages on FreeBSD 12:

man pkg
man freebsd-update
man pfctl
man ipfw
man bectl
man periodic.conf

Other resources: the FreeBSD Handbook, the FreeBSD Security Advisories at security.freebsd.org, and the /usr/ports/UPDATING file for port-specific notes implicated in this advisory.