matrix-appservice-purple

General purpose puppeting bridges using libpurple

This bridge is in very active development currently and intended mainly for experimentation and evaluation purposes.

Installing

Dependencies

For node-purple to compile correctly, you will need (for Debian):

build-essential
libuv1

You can install this on Ubuntu/Debian using sudo apt install build-essential libuv1.

Instructions for other distributions will come soon.

Installing & Configuring

npm install # Install dependencies
npm run build # Build files
cp config.sample.yaml config.yaml
# ... Set the domain name, homeserver url, and then review the rest of the config
sed -i  "s/domain: \"localhost\"/domain: \"$YOUR_MATRIX_DOMAIN\"/g" config.yaml

Usage

Generate a registration file

npm run genreg -- -u http://localhost:9555 # Set listener url here.

Starting

Run the start script below, note that the application can be started without it by running npm run start -- -p 9555.

start.sh

Binding purple accounts to a Matrix User

The bridge won't do much unless it has accounts to bind. Due to the infancy of the bridge, we still use ~/.purple/accounts.xml for the location of all the accounts. Our advice is to create the accounts you want to use on your local machine with Pidgin, and then copy the accounts.xml file to the bridge (where you should be copying the file to /$BRIDGE_USER/.purple/accounts.xml).

Once you have started the bridge, you can instruct it to bind by starting a conversation with the bridge user and sending accounts add-existing $PROTOCOL $USERNAME where the protocol and username are given in the accounts.xml file.

You should also run accounts enable $PROTOCOL $USERNAME to enable the account for the bridge, and then it should connect automatically.

Bridging XMPP room

Connect to your matrix server and open a chat with @_purple_bot:$YOUR_MATRIX_DOMAIN.

accounts add-existing prpl-jabber $USERNAME@$XMPP_SERVER/$CLIENT_NAME
accounts enable prpl-jabber $USERNAME@$XMPP_SERVER/$CLIENT_NAME
accounts
join xmpp $ROOM $XMPP_SERVER

Help

My bridge crashed with a segfault

The node-purple rewrite is still not quite bugfree and we are working hard to iron out the kinks in it. We ask that you report if certain purple plugins cause more crashes, or if anything in particular lead up to it.

TLS certificates missing

If you're having issues connecting, consider enabling debug in config.yaml

purple:
  enableDebug: true

Restart the appservice using start.sh.

(12:36:54) nss: subject=CN=jabber.ccc.de issuer=CN=Let's Encrypt Authority X3,O=Let's Encrypt,C=US
(12:36:54) nss: subject=CN=Let's Encrypt Authority X3,O=Let's Encrypt,C=US issuer=CN=DST Root CA X3,O=Digital Signature Trust Co.
(12:36:54) nss: partial certificate chain
(12:36:54) certificate/x509/tls_cached: Starting verify for jabber.ccc.de
(12:36:54) certificate/x509/tls_cached: Checking for cached cert...
(12:36:54) certificate/x509/tls_cached: ...Not in cache
(12:36:54) certificate/x509/ca: Couldn't open location '/usr/local/share/purple/ca-certs'
(12:36:54) certificate/x509/ca: Lazy init completed.
(12:36:54) nss: CERT 1. CN=Let's Encrypt Authority X3,O=Let's Encrypt,C=US [Certificate Authority]:
(12:36:54) nss:   ERROR -8179: SEC_ERROR_UNKNOWN_ISSUER


If you're seeing issues like the ones above, consider installing the correct TLS certificates.
In my case the Let's Encrypt certificates.

mkdir -p /usr/local/share/purple/ca-certs cd /usr/local/share/purple/ca-certs wget https://letsencrypt.org/certs/isrgrootx1.pem wget https://letsencrypt.org/certs/letsencryptauthorityx3.pem wget https://letsencrypt.org/certs/lets-encrypt-x3-cross-signed.pem

robertfoss/matrix-appservice-purple