heisenbridge

Note: This release is not yet available on PyPI. If using a bare metal install, you can update directly from GitHub using pip install --upgrade heisenbridge@git+https://github.com/hifi/[email protected]. Docker images are available normally.

Authenticated media

Matrix v1.11 deprecated the old way of downloading media without authentication, which Heisenbridge was relying on when bridging media. This release adds a proxy into the bridge which allows unauthenticated access to media that has been sent over the bridge. Support for old way of bridging media has also been removed completely, which means a Matrix v1.11 compatible homeserver is required (Synapse v1.111 or higher, matrix-media-repo v1.3.5 or higher).

To set it up, configure your reverse proxy to pass /_heisenbridge/media/* to heisenbridge, then set heisenbridge -> media_url in the registration file with the public URL that the reverse proxy handles. Optionally, you can run another heisenbridge instance with the --media-proxy flag to have it in a separate process. When doing so, point the reverse proxy at that second process, not the main process.

The unauthenticated links generated by Heisenbridge will have a checksum to prevent accessing media that hasn't been sent over the bridge. By default, the checksum uses the hs_token as the HMAC secret. Optionally, you can set heisenbridge -> media_key in the registration to use a custom key.

Other changes

• Filter out empty user IDs in status command (@Christoph-D in https://github.com/hifi/heisenbridge/pull/286)
• Added setting to insert username prefix on all lines of a multi-line message (@russss in https://github.com/hifi/heisenbridge/pull/276)
• Added note to help that shell escaping may be required for some commands (@hades in https://github.com/hifi/heisenbridge/pull/271)
• Added option to disable reactions (@9p4 in https://github.com/hifi/heisenbridge/pull/275)

• Accept elliptic curve keys in the CERTFP command (thanks @viiru-)
• Include ! in the mode list, fixes weird modes breaking nicks (thanks @gsora)
• Add support for away-notify cap, fixes crashes for unexpected AWAY commands
• Bump Mautrix max version to v0.20.x
• Drop Python 3.8 support (because of Mautrix)

• Read default port and listen address from config url (@BtbN)
• Improvements to pillifying IRC nicks, again
• Fixes for AUTOQUERY not always working correctly
• Allow anyone to use STATUS command to get their own status
• Filter control characters only for plumbs so people can send garbage to IRC if they wish from Matrix
• Support for converting IRC color codes to Matrix (@tjaderxyz)
• Fixed compose docker Synapse configuration for registration
• Improved Python 3.10 compatibliy (@BtbN)
• Hidden room to hide joins using restricted rooms join rule (@BtbN)

Enabling hidden room functionality additionally requires either re-joining channels or having them already at v9 and using the UPGRADE command.

• Make MAXLINES and PASTEBIN option available to every room & global defaults (thanks @BtbN)
• Fix 'NoneType' is not iterable error (thanks @BtbN)
• Upgrade to Mautrix 0.16

Not much to see here. A small contribution release which is always a nice thing when people come around and help 🤗.

• Fixed retry behavior on startup to wait for HS startup
• Ignore TAGMSG messages from IRC server
• Fixed HTML messages not working as commands
• Fixed room aliases in messages dropping the message completely
• Upgrade to Mautrix 0.15

This release also breaks support for homeservers not supporting the "v3" API path so if you run Synapse 1.47 or older the bridge will not start.

• RELAYMSG sending support 🚀
• Allow forwarding all IRC noise to network room
• Support ZNC self-message caps ✅
• Support CHGHOST caps (prevents leave+join on host change) ✅
• Fix owner auto-registration (regression) 🐛
• Upgrade to Mautrix 0.14 ⬆️

Not a breaking change but the caps support will cause connections to networks that ignore CAP requests take a few seconds longer unless you remove all the default caps for said network and it will never try requesting them again.

Mautrix 0.14 upgrade bumps the minimum version as well so packages beware.

• Spaces support 🌃
• Proper SASL external with CertFP with mechanism override option (see notes)
• Disconnect and cleanup from networks that have no rooms open ♻️
• Reply (and reject) DM requests to ghosts with QUERY command ↪️
• Try to keep IRC users in the room at all costs if they are on the IRC channel
• Prevent accidental namespace changes to cause mayhem
• Conduit support was broken in 1.8.x but fixed again in 1.9.0, sorry

Upgrade warning: CertFP SASL has been updated to do SASL external flow by default. If you are upgrading and have used CertFP with OFTC you need to run SASL --mechanism=none for it to connect again.

• Use correct field for fresh plumb displaynames (v1.8.0 regression)
• Allow unplumbing from network room

• Finally convert from homegrown Matrix API stuff to Mautrix (badly)
• Bump Mautrix requirement to 0.12
• Sort NAMES reply nicks
• Fix assumption of all IRC replies to have arguments

Note to packagers: required Mautrix bump, Python 3.7 is no longer tested but 3.10 is.

• Fix compat with Synapse 1.47.0

This is a critical fix for anyone upgrading Synapse. No other changes.

• Implement "best effort" basic IRC moderation in plumbed rooms if bot has ops on IRC
• Allow configuring topic sync for plumbs (IRC<->Matrix or one way)
• Allow using forward slash (/) as MXID separator for IRC ghosts
• Bump max mautrix version to <0.12

The separator for IRC ghosts can now be changed to forward slash (/) from the default underscore (_). This happens by modifying the regex in the registration file. Only do this for new installations and it will cause all IRC users to duplicate in rooms who you can't remove and probably other bad side effects as well. The default may be changed in the future.