From a74f49532efe22ec62e58b748d231b1ca7b612bc Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Wed, 7 Aug 2024 16:24:07 +0300 Subject: [PATCH] Remove separate signalv2 config, update gmessages to v2 --- bridgeconfig/bridgeconfig.go | 1 + bridgeconfig/bridgev2.tpl.yaml | 102 +++++++++- bridgeconfig/gmessages.tpl.yaml | 318 +++----------------------------- bridgeconfig/signal.tpl.yaml | 285 ++-------------------------- bridgeconfig/signalv2.tpl.yaml | 24 --- cmd/bbctl/bridgeutil.go | 2 - cmd/bbctl/config.go | 6 - cmd/bbctl/run.go | 19 +- 8 files changed, 146 insertions(+), 611 deletions(-) delete mode 100644 bridgeconfig/signalv2.tpl.yaml diff --git a/bridgeconfig/bridgeconfig.go b/bridgeconfig/bridgeconfig.go index c8e5a37..643c981 100644 --- a/bridgeconfig/bridgeconfig.go +++ b/bridgeconfig/bridgeconfig.go @@ -15,6 +15,7 @@ type BridgeV2Name struct { CommandPrefix string BridgeTypeName string BridgeTypeIcon string + DefaultPickleKey string } type Params struct { diff --git a/bridgeconfig/bridgev2.tpl.yaml b/bridgeconfig/bridgev2.tpl.yaml index f06429c..fc06104 100644 --- a/bridgeconfig/bridgev2.tpl.yaml +++ b/bridgeconfig/bridgev2.tpl.yaml @@ -7,6 +7,33 @@ bridge: # Should the bridge create a space for each login containing the rooms that account is in? personal_filtering_spaces: true + # What should be done to portal rooms when a user logs out or is logged out? + # Permitted values: + # nothing - Do nothing, let the user stay in the portals + # kick - Remove the user from the portal rooms, but don't delete them + # unbridge - Remove all ghosts in the room and disassociate it from the remote chat + # delete - Remove all ghosts and users from the room (i.e. delete it) + cleanup_on_logout: + # Should cleanup on logout be enabled at all? + enabled: true + # Settings for manual logouts (explicitly initiated by the Matrix user) + manual: + # Action for private portals which will never be shared with other Matrix users. + private: delete + # Action for portals with a relay user configured. + relayed: delete + # Action for portals which may be shared, but don't currently have any other Matrix users. + shared_no_users: delete + # Action for portals which have other logged-in Matrix users. + shared_has_users: delete + # Settings for credentials being invalidated (initiated by the remote network, possibly through user action). + # Keys have the same meanings as in the manual section. + bad_credentials: + private: nothing + relayed: nothing + shared_no_users: nothing + shared_has_users: nothing + # Settings for relay mode relay: # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any @@ -150,6 +177,79 @@ provisioning: # Enable debug API at /debug with provisioning authentication. debug_endpoints: true +# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks). +# These settings control whether the bridge will provide such public media access. +public_media: + # Should public media be enabled at all? + # The public_address field under the appservice section MUST be set when enabling public media. + enabled: false + # A key for signing public media URLs. + # If set to "generate", a random key will be generated. + signing_key: {{ .ProvisioningSecret }} + # Number of seconds that public media URLs are valid for. + # If set to 0, URLs will never expire. + expiry: 0 + # Length of hash to use for public media URLs. Must be between 0 and 32. + hash_length: 32 + +# Settings for converting remote media to custom mxc:// URIs instead of reuploading. +# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html +direct_media: + # Should custom mxc:// URIs be used instead of reuploading media? + enabled: false + # The server name to use for the custom mxc:// URIs. + # This server name will effectively be a real Matrix server, it just won't implement anything other than media. + # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge. + server_name: discord-media.example.com + # Optionally a custom .well-known response. This defaults to `server_name:443` + well_known_response: + # Optionally specify a custom prefix for the media ID part of the MXC URI. + media_id_prefix: + # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916 + # media download redirects if the requester supports it. Optionally, you can force redirects + # and not allow proxying at all by setting this to false. + # This option does nothing if the remote network does not support media downloads over HTTP. + allow_proxy: true + # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file. + # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them. + server_key: ed25519 AAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA + +# Settings for backfilling messages. +# Note that the exact way settings are applied depends on the network connector. +# See https://docs.mau.fi/bridges/general/backfill.html for more details. +backfill: + # Whether to do backfilling at all. + enabled: true + # Maximum number of messages to backfill in empty rooms. + max_initial_messages: 50 + # Maximum number of missed messages to backfill after bridge restarts. + max_catchup_messages: 500 + # If a backfilled chat is older than this number of hours, + # mark it as read even if it's unread on the remote network. + unread_hours_threshold: 720 + # Settings for backfilling threads within other backfills. + threads: + # Maximum number of messages to backfill in a new thread. + max_initial_messages: 50 + # Settings for the backwards backfill queue. This only applies when connecting to + # Beeper as standard Matrix servers don't support inserting messages into history. + queue: + # Should the backfill queue be enabled? + enabled: true + # Number of messages to backfill in one batch. + batch_size: 50 + # Delay between batches in seconds. + batch_delay: 20 + # Maximum number of batches to backfill per portal. + # If set to -1, all available messages will be backfilled. + max_batches: 0 + # Optional network-specific overrides for max batches. + # Interpretation of this field depends on the network connector. + max_batches_override: + channel: 10 + dm: -1 + group_dm: -1 + # Settings for enabling double puppeting double_puppet: # Servers to always allow double puppeting from. @@ -183,7 +283,7 @@ encryption: allow_key_sharing: true # Pickle key for encrypting encryption keys in the bridge database. # If set to generate, a random key will be generated. - pickle_key: bbctl + pickle_key: {{ or .Params.pickle_key .DefaultPickleKey "bbctl" }} # Options for deleting megolm sessions from the bridge. delete_keys: # Beeper-specific: delete outbound sessions when hungryserv confirms diff --git a/bridgeconfig/gmessages.tpl.yaml b/bridgeconfig/gmessages.tpl.yaml index 9ffccdb..12ef56a 100644 --- a/bridgeconfig/gmessages.tpl.yaml +++ b/bridgeconfig/gmessages.tpl.yaml @@ -1,301 +1,27 @@ -# Homeserver details. -homeserver: - # The address that this appservice can use to connect to the homeserver. - address: {{ .HungryAddress }} - # The domain of the homeserver (also known as server_name, used for MXIDs, etc). - domain: beeper.local - - # What software is the homeserver running? - # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here. - software: hungry - # The URL to push real-time bridge status to. - # If set, the bridge will make POST requests to this URL whenever a user's google messages connection state changes. - # The bridge will use the appservice as_token to authorize requests. - status_endpoint: null - # Endpoint for reporting per-message status. - message_send_checkpoint_endpoint: null - # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246? - async_media: false - - # Should the bridge use a websocket for connecting to the homeserver? - # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy, - # mautrix-asmux (deprecated), and hungryserv (proprietary). - websocket: {{ .Websocket }} - # How often should the websocket be pinged? Pinging will be disabled if this is zero. - ping_interval_seconds: 180 - -# Application service host/registration related details. -# Changing these values requires regeneration of the registration. -appservice: - # The address that the homeserver can use to connect to this appservice. - address: null - - # The hostname and port where this appservice should listen. - hostname: {{ if .Websocket }}null{{ else }}{{ .ListenAddr }}{{ end }} - port: {{ if .Websocket }}null{{ else }}{{ .ListenPort }}{{ end }} - - # Database config. - database: - # The database type. "sqlite3-fk-wal" and "postgres" are supported. - type: sqlite3-fk-wal - # The database URI. - # SQLite: A raw file path is supported, but `file:?_txlock=immediate` is recommended. - # https://github.com/mattn/go-sqlite3#connection-string - # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable - # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql - uri: file:{{.DatabasePrefix}}mautrix-gmessages.db?_txlock=immediate - # Maximum number of connections. Mostly relevant for Postgres. - max_open_conns: 5 - max_idle_conns: 2 - # Maximum connection idle time and lifetime before they're closed. Disabled if null. - # Parsed with https://pkg.go.dev/time#ParseDuration - max_conn_idle_time: null - max_conn_lifetime: null - - # The unique ID of this appservice. - id: {{ .AppserviceID }} - # Appservice bot details. - bot: - # Username of the appservice bot. - username: {{ .BridgeName }}bot - # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty - # to leave display name/avatar as-is. - displayname: Google Messages bridge bot - avatar: mxc://maunium.net/yGOdcrJcwqARZqdzbfuxfhzb - - # Whether or not to receive ephemeral events via appservice transactions. - # Requires MSC2409 support (i.e. Synapse 1.22+). - ephemeral_events: true - - # Should incoming events be handled asynchronously? - # This may be necessary for large public instances with lots of messages going through. - # However, messages will not be guaranteed to be bridged in the same order they were sent in. - async_transactions: false - - # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. - as_token: {{ .ASToken }} - hs_token: {{ .HSToken }} - -# Segment API key to track some events, like provisioning API login and encryption errors. -segment_key: null -# Optional user_id to use when sending Segment events. If null, defaults to using mxID. -segment_user_id: null - -# Prometheus config. -metrics: - # Enable prometheus metrics? - enabled: false - # IP and port where the metrics listener should be. The path is always /metrics - listen: 127.0.0.1:8001 - -google_messages: - # OS name to tell the phone. This is the name that shows up in the paired devices list. - os: {{ or .Params.device_name "Beeper (self-hosted)" }} - # Browser type to tell the phone. This decides which icon is shown. - # Valid types: OTHER, CHROME, FIREFOX, SAFARI, OPERA, IE, EDGE - browser: OTHER - # Device type to tell the phone. This also affects the icon, as well as how many sessions are allowed simultaneously. - # One web, two tablets and one PWA should be able to connect at the same time. - # Valid types: WEB, TABLET, PWA - device: TABLET - - # Should the bridge aggressively set itself as the active device if the user opens Google Messages in a browser? - # If this is disabled, the user must manually use the `set-active` command to reactivate the bridge. - aggressive_reconnect: false - -# Bridge config -bridge: - # Localpart template of MXIDs for SMS users. - username_template: {{ .BridgeName }}_{{ "{{.}}" }} +# Network-specific config options +network: # Displayname template for SMS users. displayname_template: {{ `"{{or .FullName .PhoneNumber}}"` }} - # Should the bridge create a space for each logged-in user and add bridged rooms to it? - personal_filtering_spaces: true - # Should the bridge send a read receipt from the bridge bot when a message has been sent to the phone? - delivery_receipts: false - # Whether the bridge should send the message status as a custom com.beeper.message_send_status event. - message_status_events: true - # Whether the bridge should send error notices via m.notice events when a message fails to bridge. - message_error_notices: false - - portal_message_buffer: 128 - - # Should the bridge update the m.direct account data event when double puppeting is enabled. - # Note that updating the m.direct event is not atomic (except with mautrix-asmux) - # and is therefore prone to race conditions. - sync_direct_chat_list: false + # Settings for how the bridge appears to the phone. + device_meta: + # OS name to tell the phone. This is the name that shows up in the paired devices list. + os: Beeper (self-hosted) + # Browser type to tell the phone. This decides which icon is shown. + # Valid types: OTHER, CHROME, FIREFOX, SAFARI, OPERA, IE, EDGE + browser: OTHER + # Device type to tell the phone. This also affects the icon, as well as how many sessions are allowed simultaneously. + # One web, two tablets and one PWA should be able to connect at the same time. + # Valid types: WEB, TABLET, PWA + type: TABLET + # Should the bridge aggressively set itself as the active device if the user opens Google Messages in a browser? + # If this is disabled, the user must manually use the `set-active` command to reactivate the bridge. + aggressive_reconnect: true # Number of chats to sync when connecting to Google Messages. initial_chat_sync_count: 25 - # Backfill settings - backfill: - # Number of messages to backfill in new chats. - initial_limit: 50 - # Number of messages to backfill on startup if the last message ID in the chat sync doesn't match the last bridged message. - missed_limit: 100 - - # Servers to always allow double puppeting from - double_puppet_server_map: - {{ .BeeperDomain }}: {{ .HungryAddress }} - # Allow using double puppeting from any server with a valid client .well-known file. - double_puppet_allow_discovery: false - # Shared secrets for https://github.com/devture/matrix-synapse-shared-secret-auth - # - # If set, double puppeting will be enabled automatically for local users - # instead of users having to find an access token and run `login-matrix` - # manually. - login_shared_secret_map: - {{ .BeeperDomain }}: "as_token:{{ .ASToken }}" - - # Whether to explicitly set the avatar and room name for private chat portal rooms. - # If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms. - # If set to `always`, all DM rooms will have explicit names and avatars set. - # If set to `never`, DM rooms will never have names and avatars set. - private_chat_portal_meta: default - # Should Matrix m.notice-type messages be bridged? - bridge_notices: true - # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run. - # This field will automatically be changed back to false after it, except if the config file is not writable. - resend_bridge_info: false - # When using double puppeting, should muted chats be muted in Matrix? - mute_bridging: false - # When using double puppeting, should archived chats be moved to a specific tag in Matrix? - # This can be set to a tag (e.g. m.lowpriority), or null to disable. - archive_tag: null - # Same as above, but for pinned chats. The favorite tag is called m.favourite - pinned_tag: m.favourite - # Should mute status and tags only be bridged when the portal room is created? - tag_only_on_create: true - # Whether or not created rooms should have federation enabled. - # If false, created portal rooms will never be federated. - federate_rooms: false - # Should the bridge never send alerts to the bridge management room? - # These are mostly things like the user being logged out. - disable_bridge_alerts: true - # Send captions in the same message as images. This will send data compatible with both MSC2530 and MSC3552. - # This is currently not supported in most clients. - caption_in_message: true - # Send galleries as a single event? This is not an MSC (yet). - beeper_galleries: false - - # The prefix for commands. Only required in non-management rooms. - command_prefix: "!gm" - - # Messages sent upon joining a management room. - # Markdown is supported. The defaults are listed below. - management_room_text: - # Sent when joining a room. - welcome: "Hello, I'm a Google Messages bridge bot." - # Sent when joining a management room and the user is already logged in. - welcome_connected: "Use `help` for help." - # Sent when joining a management room and the user is not logged in. - welcome_unconnected: "Use `help` for help or `login` to log in." - # Optional extra text sent when joining a management room. - additional_help: "" - - # End-to-bridge encryption support options. - # - # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info. - encryption: - # Allow encryption, work in group chat rooms with e2ee enabled - allow: true - # Default to encryption, force-enable encryption in all portals the bridge creates - # This will cause the bridge bot to be in private chats for the encryption to work properly. - default: true - # Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data. - appservice: true - # Require encryption, drop any unencrypted messages. - require: true - # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. - # You must use a client that supports requesting keys from other users to use this feature. - allow_key_sharing: true - # Options for deleting megolm sessions from the bridge. - delete_keys: - # Beeper-specific: delete outbound sessions when hungryserv confirms - # that the user has uploaded the key to key backup. - delete_outbound_on_ack: true - # Don't store outbound sessions in the inbound table. - dont_store_outbound: false - # Ratchet megolm sessions forward after decrypting messages. - ratchet_on_decrypt: true - # Delete fully used keys (index >= max_messages) after decrypting messages. - delete_fully_used_on_decrypt: true - # Delete previous megolm sessions from same device when receiving a new one. - delete_prev_on_new_session: true - # Delete megolm sessions received from a device when the device is deleted. - delete_on_device_delete: true - # Periodically delete megolm sessions when 2x max_age has passed since receiving the session. - periodically_delete_expired: true - # Delete inbound megolm sessions that don't have the received_at field used for - # automatic ratcheting and expired session deletion. This is meant as a migration - # to delete old keys prior to the bridge update. - delete_outdated_inbound: false - # What level of device verification should be required from users? - # - # Valid levels: - # unverified - Send keys to all device in the room. - # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys. - # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes). - # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot. - # Note that creating user signatures from the bridge bot is not currently possible. - # verified - Require manual per-device verification - # (currently only possible by modifying the `trust` column in the `crypto_device` database table). - verification_levels: - # Minimum level for which the bridge should send keys to when bridging messages from SMS to Matrix. - receive: cross-signed-tofu - # Minimum level that the bridge should accept for incoming Matrix messages. - send: cross-signed-tofu - # Minimum level that the bridge should require for accepting key requests. - share: cross-signed-tofu - # Options for Megolm room key rotation. These options allow you to - # configure the m.room.encryption event content. See: - # https://spec.matrix.org/v1.3/client-server-api/#mroomencryption for - # more information about that event. - rotation: - # Enable custom Megolm room key rotation settings. Note that these - # settings will only apply to rooms created after this option is - # set. - enable_custom: true - # The maximum number of milliseconds a session should be used - # before changing it. The Matrix spec recommends 604800000 (a week) - # as the default. - milliseconds: 2592000000 - # The maximum number of messages that should be sent with a given a - # session before changing it. The Matrix spec recommends 100 as the - # default. - messages: 10000 - - # Disable rotating keys when a user's devices change? - # You should not enable this option unless you understand all the implications. - disable_device_change_key_rotation: true - - # Settings for provisioning API - provisioning: - # Prefix for the provisioning API paths. - prefix: /_matrix/provision - # Shared secret for authentication. If set to "generate", a random secret will be generated, - # or if set to "disable", the provisioning API will be disabled. - shared_secret: {{ .ProvisioningSecret }} - - # Permissions for using the bridge. - # Permitted values: - # user - Access to use the bridge to link their own Google Messages on android. - # admin - User level and some additional administration tools - # Permitted keys: - # * - All Matrix users - # domain - All users on that homeserver - # mxid - Specific user - permissions: - "{{ .UserID }}": admin -# Logging config. See https://github.com/tulir/zeroconfig for details. -logging: - min_level: debug - writers: - - type: stdout - format: pretty-colored - - type: file - format: json - filename: ./logs/mautrix-gmessages.log - max_size: 100 - max_backups: 10 - compress: false +{{ setfield . "CommandPrefix" "!gm" -}} +{{ setfield . "DatabaseFileName" "mautrix-gmessages" -}} +{{ setfield . "BridgeTypeName" "Google Messages" -}} +{{ setfield . "BridgeTypeIcon" "mxc://maunium.net/yGOdcrJcwqARZqdzbfuxfhzb" -}} +{{ setfield . "DefaultPickleKey" "go.mau.fi/mautrix-gmessages" -}} +{{ template "bridgev2.tpl.yaml" . }} diff --git a/bridgeconfig/signal.tpl.yaml b/bridgeconfig/signal.tpl.yaml index 90c71c9..9b223f2 100644 --- a/bridgeconfig/signal.tpl.yaml +++ b/bridgeconfig/signal.tpl.yaml @@ -1,278 +1,25 @@ -# Homeserver details. -homeserver: - # The address that this appservice can use to connect to the homeserver. - address: {{ .HungryAddress }} - # The domain of the homeserver (also known as server_name, used for MXIDs, etc). - domain: beeper.local - - # What software is the homeserver running? - # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here. - software: hungry - # The URL to push real-time bridge status to. - # If set, the bridge will make POST requests to this URL whenever a user's discord connection state changes. - # The bridge will use the appservice as_token to authorize requests. - status_endpoint: null - # Endpoint for reporting per-message status. - message_send_checkpoint_endpoint: null - # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246? - async_media: true - - # Should the bridge use a websocket for connecting to the homeserver? - # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy, - # mautrix-asmux (deprecated), and hungryserv (proprietary). - websocket: {{ .Websocket }} - # How often should the websocket be pinged? Pinging will be disabled if this is zero. - ping_interval_seconds: 180 - -# Application service host/registration related details. -# Changing these values requires regeneration of the registration. -appservice: - # The address that the homeserver can use to connect to this appservice. - address: null - - # The hostname and port where this appservice should listen. - hostname: {{ if .Websocket }}null{{ else }}{{ .ListenAddr }}{{ end }} - port: {{ if .Websocket }}null{{ else }}{{ .ListenPort }}{{ end }} - - # Database config. - database: - # The database type. "sqlite3-fk-wal" and "postgres" are supported. - type: sqlite3-fk-wal - # The database URI. - # SQLite: A raw file path is supported, but `file:?_txlock=immediate` is recommended. - # https://github.com/mattn/go-sqlite3#connection-string - # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable - # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql - uri: file:{{.DatabasePrefix}}mautrix-signal.db?_txlock=immediate - # Maximum number of connections. Mostly relevant for Postgres. - max_open_conns: 5 - max_idle_conns: 2 - # Maximum connection idle time and lifetime before they're closed. Disabled if null. - # Parsed with https://pkg.go.dev/time#ParseDuration - max_conn_idle_time: null - max_conn_lifetime: null - - # The unique ID of this appservice. - id: {{ .AppserviceID }} - # Appservice bot details. - bot: - # Username of the appservice bot. - username: {{ .BridgeName }}bot - # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty - # to leave display name/avatar as-is. - displayname: Signal bridge bot - avatar: mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp - - # Whether or not to receive ephemeral events via appservice transactions. - # Requires MSC2409 support (i.e. Synapse 1.22+). - ephemeral_events: true - - # Should incoming events be handled asynchronously? - # This may be necessary for large public instances with lots of messages going through. - # However, messages will not be guaranteed to be bridged in the same order they were sent in. - async_transactions: false - - # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. - as_token: {{ .ASToken }} - hs_token: {{ .HSToken }} - -# Prometheus config. -metrics: - # Enable prometheus metrics? - enabled: false - # IP and port where the metrics listener should be. The path is always /metrics - listen: 127.0.0.1:8000 - -signal: - # Default device name that shows up in the Signal app. - device_name: {{ or .Params.device_name "Beeper (self-hosted)" }} - -# Bridge config -bridge: - # Localpart template of MXIDs for Signal users. - username_template: {{ .BridgeName }}_{{ "{{.}}" }} - # Displayname template for Signal users. This is also used as the room name in DMs if private_chat_portal_meta is enabled. +# Network-specific config options +network: + # Displayname template for Signal users. displayname_template: {{ `'{{or .ContactName .ProfileName .PhoneNumber "Unknown user" }}'` }} - # Whether to explicitly set the avatar and room name for private chat portal rooms. - # If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms. - # If set to `always`, all DM rooms will have explicit names and avatars set. - # If set to `never`, DM rooms will never have names and avatars set. - private_chat_portal_meta: default # Should avatars from the user's contact list be used? This is not safe on multi-user instances. use_contact_avatars: true # Should the bridge sync ghost user info even if profile fetching fails? This is not safe on multi-user instances. use_outdated_profiles: true # Should the Signal user's phone number be included in the room topic in private chat portal rooms? number_in_topic: true + # Default device name that shows up in the Signal app. + device_name: {{ or .Params.device_name "Beeper (self-hosted, v2)" }} # Avatar image for the Note to Self room. note_to_self_avatar: mxc://maunium.net/REBIVrqjZwmaWpssCZpBlmlL - - portal_message_buffer: 128 - - # Should the bridge create a space for each logged-in user and add bridged rooms to it? - # Users who logged in before turning this on should run `!signal sync-space` to create and fill the space for the first time. - personal_filtering_spaces: true - # Should Matrix m.notice-type messages be bridged? - bridge_notices: true - # Should the bridge send a read receipt from the bridge bot when a message has been sent to Signal? - delivery_receipts: false - # Whether the bridge should send the message status as a custom com.beeper.message_send_status event. - message_status_events: true - # Whether the bridge should send error notices via m.notice events when a message fails to bridge. - message_error_notices: false - # Should the bridge update the m.direct account data event when double puppeting is enabled. - # Note that updating the m.direct event is not atomic (except with mautrix-asmux) - # and is therefore prone to race conditions. - sync_direct_chat_list: false - # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run. - # This field will automatically be changed back to false after it, except if the config file is not writable. - resend_bridge_info: false - # Send captions in the same message as images. This will send data compatible with both MSC2530. - # This is currently not supported in most clients. - caption_in_message: true - # Servers to always allow double puppeting from - double_puppet_server_map: - {{ .BeeperDomain }}: {{ .HungryAddress }} - # Allow using double puppeting from any server with a valid client .well-known file. - double_puppet_allow_discovery: false - # Shared secrets for https://github.com/devture/matrix-synapse-shared-secret-auth - # - # If set, double puppeting will be enabled automatically for local users - # instead of users having to find an access token and run `login-matrix` - # manually. - login_shared_secret_map: - {{ .BeeperDomain }}: "as_token:{{ .ASToken }}" - - # Maximum time for handling Matrix events. Duration strings formatted for https://pkg.go.dev/time#ParseDuration - # Null means there's no enforced timeout. - message_handling_timeout: - # Send an error message after this timeout, but keep waiting for the response until the deadline. - # This is counted from the origin_server_ts, so the warning time is consistent regardless of the source of delay. - # If the message is older than this when it reaches the bridge, the message won't be handled at all. - error_after: null - # Drop messages after this timeout. They may still go through if the message got sent to the servers. - # This is counted from the time the bridge starts handling the message. - deadline: 120s - - # The prefix for commands. Only required in non-management rooms. - command_prefix: '!signal' - # Messages sent upon joining a management room. - # Markdown is supported. The defaults are listed below. - management_room_text: - # Sent when joining a room. - welcome: "Hello, I'm a Signal bridge bot." - # Sent when joining a management room and the user is already logged in. - welcome_connected: "Use `help` for help." - # Sent when joining a management room and the user is not logged in. - welcome_unconnected: "Use `help` for help or `login` to log in." - # Optional extra text sent when joining a management room. - additional_help: "" - - # End-to-bridge encryption support options. - # - # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info. - encryption: - # Allow encryption, work in group chat rooms with e2ee enabled - allow: true - # Default to encryption, force-enable encryption in all portals the bridge creates - # This will cause the bridge bot to be in private chats for the encryption to work properly. - default: true - # Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data. - appservice: true - # Require encryption, drop any unencrypted messages. - require: true - # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. - # You must use a client that supports requesting keys from other users to use this feature. - allow_key_sharing: true - # Options for deleting megolm sessions from the bridge. - delete_keys: - # Beeper-specific: delete outbound sessions when hungryserv confirms - # that the user has uploaded the key to key backup. - delete_outbound_on_ack: true - # Don't store outbound sessions in the inbound table. - dont_store_outbound: false - # Ratchet megolm sessions forward after decrypting messages. - ratchet_on_decrypt: true - # Delete fully used keys (index >= max_messages) after decrypting messages. - delete_fully_used_on_decrypt: true - # Delete previous megolm sessions from same device when receiving a new one. - delete_prev_on_new_session: true - # Delete megolm sessions received from a device when the device is deleted. - delete_on_device_delete: true - # Periodically delete megolm sessions when 2x max_age has passed since receiving the session. - periodically_delete_expired: true - # Delete inbound megolm sessions that don't have the received_at field used for - # automatic ratcheting and expired session deletion. This is meant as a migration - # to delete old keys prior to the bridge update. - delete_outdated_inbound: false - # What level of device verification should be required from users? - # - # Valid levels: - # unverified - Send keys to all device in the room. - # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys. - # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes). - # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot. - # Note that creating user signatures from the bridge bot is not currently possible. - # verified - Require manual per-device verification - # (currently only possible by modifying the `trust` column in the `crypto_device` database table). - verification_levels: - # Minimum level for which the bridge should send keys to when bridging messages from Signal to Matrix. - receive: cross-signed-tofu - # Minimum level that the bridge should accept for incoming Matrix messages. - send: cross-signed-tofu - # Minimum level that the bridge should require for accepting key requests. - share: cross-signed-tofu - # Options for Megolm room key rotation. These options allow you to - # configure the m.room.encryption event content. See: - # https://spec.matrix.org/v1.3/client-server-api/#mroomencryption for - # more information about that event. - rotation: - # Enable custom Megolm room key rotation settings. Note that these - # settings will only apply to rooms created after this option is - # set. - enable_custom: true - # The maximum number of milliseconds a session should be used - # before changing it. The Matrix spec recommends 604800000 (a week) - # as the default. - milliseconds: 2592000000 - # The maximum number of messages that should be sent with a given a - # session before changing it. The Matrix spec recommends 100 as the - # default. - messages: 10000 - - # Disable rotating keys when a user's devices change? - # You should not enable this option unless you understand all the implications. - disable_device_change_key_rotation: true - - # Settings for provisioning API - provisioning: - # Prefix for the provisioning API paths. - prefix: /_matrix/provision - # Shared secret for authentication. If set to "generate", a random secret will be generated, - # or if set to "disable", the provisioning API will be disabled. - shared_secret: {{ .ProvisioningSecret }} - - # Permissions for using the bridge. - # Permitted values: - # relay - Talk through the relaybot (if enabled), no access otherwise - # user - Access to use the bridge to chat with a Signal account. - # admin - User level and some additional administration tools - # Permitted keys: - # * - All Matrix users - # domain - All users on that homeserver - # mxid - Specific user - permissions: - "{{ .UserID }}": admin - -# Logging config. See https://github.com/tulir/zeroconfig for details. -logging: - min_level: debug - writers: - - type: stdout - format: pretty-colored - - type: file - format: json - filename: ./logs/mautrix-signal.log - max_size: 100 - max_backups: 10 - compress: false + # Format for generating URLs from location messages for sending to Signal. + # Google Maps: 'https://www.google.com/maps/place/%[1]s,%[2]s' + # OpenStreetMap: 'https://www.openstreetmap.org/?mlat=%[1]s&mlon=%[2]s' + location_format: 'https://www.google.com/maps/place/%[1]s,%[2]s' + +{{ setfield . "CommandPrefix" "!signal" -}} +{{ setfield . "DatabaseFileName" "mautrix-signal" -}} +{{ setfield . "BridgeTypeName" "Signal" -}} +{{ setfield . "BridgeTypeIcon" "mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp" -}} +{{ setfield . "DefaultPickleKey" "mautrix.bridge.e2ee" -}} +{{ template "bridgev2.tpl.yaml" . }} diff --git a/bridgeconfig/signalv2.tpl.yaml b/bridgeconfig/signalv2.tpl.yaml deleted file mode 100644 index ba94a43..0000000 --- a/bridgeconfig/signalv2.tpl.yaml +++ /dev/null @@ -1,24 +0,0 @@ -# Network-specific config options -network: - # Displayname template for Signal users. - displayname_template: {{ `'{{or .ContactName .ProfileName .PhoneNumber "Unknown user" }}'` }} - # Should avatars from the user's contact list be used? This is not safe on multi-user instances. - use_contact_avatars: true - # Should the bridge sync ghost user info even if profile fetching fails? This is not safe on multi-user instances. - use_outdated_profiles: true - # Should the Signal user's phone number be included in the room topic in private chat portal rooms? - number_in_topic: true - # Default device name that shows up in the Signal app. - device_name: {{ or .Params.device_name "Beeper (self-hosted, v2)" }} - # Avatar image for the Note to Self room. - note_to_self_avatar: mxc://maunium.net/REBIVrqjZwmaWpssCZpBlmlL - # Format for generating URLs from location messages for sending to Signal. - # Google Maps: 'https://www.google.com/maps/place/%[1]s,%[2]s' - # OpenStreetMap: 'https://www.openstreetmap.org/?mlat=%[1]s&mlon=%[2]s' - location_format: 'https://www.google.com/maps/place/%[1]s,%[2]s' - -{{ setfield . "CommandPrefix" "!signal" -}} -{{ setfield . "DatabaseFileName" "mautrix-signal" -}} -{{ setfield . "BridgeTypeName" "Signal" -}} -{{ setfield . "BridgeTypeIcon" "mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp" -}} -{{ template "bridgev2.tpl.yaml" . }} diff --git a/cmd/bbctl/bridgeutil.go b/cmd/bbctl/bridgeutil.go index bc53fb2..db64252 100644 --- a/cmd/bbctl/bridgeutil.go +++ b/cmd/bbctl/bridgeutil.go @@ -27,7 +27,6 @@ var officialBridges = []bridgeTypeToNames{ {"imessagego", []string{"imessagego"}}, {"imessage", []string{"imessage"}}, {"linkedin", []string{"linkedin"}}, - {"signalv2", []string{"signalv2"}}, {"signal", []string{"signal"}}, {"slack", []string{"slack"}}, {"telegram", []string{"telegram"}}, @@ -46,7 +45,6 @@ var websocketBridges = map[string]bool{ "imessage": true, "imessagego": true, "signal": true, - "signalv2": true, "bridgev2": true, "meta": true, } diff --git a/cmd/bbctl/config.go b/cmd/bbctl/config.go index c776ac5..df27e68 100644 --- a/cmd/bbctl/config.go +++ b/cmd/bbctl/config.go @@ -219,7 +219,6 @@ var bridgeIPSuffix = map[string]string{ "googlechat": "20", "twitter": "27", "signal": "28", - "signalv2": "28", "discord": "34", "slack": "35", "gmessages": "36", @@ -356,11 +355,6 @@ func generateBridgeConfig(ctx *cli.Context) error { startupCommand += " -c " + outputPath } installInstructions = fmt.Sprintf("https://docs.mau.fi/bridges/go/setup.html?bridge=%s#installation", cfg.BridgeType) - case "signalv2": - startupCommand = fmt.Sprintf("mautrix-%s-v2", strings.TrimSuffix(cfg.BridgeType, "v2")) - if outputPath != "config.yaml" && outputPath != "" { - startupCommand += " -c " + outputPath - } case "imessagego": startupCommand = "beeper-imessage" if outputPath != "config.yaml" && outputPath != "" { diff --git a/cmd/bbctl/run.go b/cmd/bbctl/run.go index 46cdd2a..543fc93 100644 --- a/cmd/bbctl/run.go +++ b/cmd/bbctl/run.go @@ -317,19 +317,12 @@ func runBridge(ctx *cli.Context) error { var bridgeArgs []string var needsWebsocketProxy bool switch cfg.BridgeType { - case "imessage", "imessagego", "whatsapp", "discord", "slack", "gmessages", "signal", "signalv2", "meta": + case "imessage", "imessagego", "whatsapp", "discord", "slack", "gmessages", "signal", "meta": binaryName := fmt.Sprintf("mautrix-%s", cfg.BridgeType) - v2 := false + ciV2 := false switch cfg.BridgeType { - case "slack": - v2 = true - } - if strings.HasSuffix(cfg.BridgeType, "v2") { - binaryName = fmt.Sprintf("mautrix-%s", strings.TrimSuffix(cfg.BridgeType, "v2")) - if cfg.BridgeType == "signalv2" { - binaryName += "-v2" - } - v2 = true + case "gmessages": + ciV2 = true } if cfg.BridgeType == "imessagego" { binaryName = "beeper-imessage" @@ -338,7 +331,7 @@ func runBridge(ctx *cli.Context) error { if localDev && overrideBridgeCmd == "" { bridgeCmd = filepath.Join(bridgeDir, binaryName) buildScript := "./build.sh" - if v2 { + if ciV2 { buildScript = "./build-v2.sh" } log.Printf("Compiling [cyan]%s[reset] with %s", binaryName, buildScript) @@ -354,7 +347,7 @@ func runBridge(ctx *cli.Context) error { return fmt.Errorf("failed to compile bridge: %w", err) } } else if overrideBridgeCmd == "" { - err = updateGoBridge(ctx.Context, bridgeCmd, cfg.BridgeType, v2, ctx.Bool("no-update")) + err = updateGoBridge(ctx.Context, bridgeCmd, cfg.BridgeType, ciV2, ctx.Bool("no-update")) if errors.Is(err, gitlab.ErrNotBuiltInCI) { return UserError{fmt.Sprintf("Binaries for %s are not built in the CI. Use --compile to tell bbctl to build the bridge locally.", binaryName)} } else if err != nil {