frewsxcv / pto

IRC to Matrix bridge

Perpetually Talking Online

An IRC to Matrix bridge.

This is different from the existing appservice on matrix.org. This work in progress allows IRC users to join a matrix community. Its just a readme/vague requirements document right now but code is being hacked on! Its for the hackerspace community https://oob.systems/

The idea being that one could point irssi at an IRC "daemon" behind a .onion address, and have access to the channels that are local to a homeserver. Joining #the-oob would result in the user's matrix user joining #the-oob:oob.systems, if the IRCd is pointed to serve up the oob.systems namespace. Users can use SASL auth to login with their existing oob.systems matrix account.

It would be impossible to join channels outside the homeserver for simplicity of implementation, and really, this is about building a tight-knit community. One should still be able to talk with everyone who is in the channel, including users from outside the homeserver and handle various channel management tasks such as kicks, bans, topics, etc.

This provides a super low level interface to onboarding new users to an existing (or new!) Matrix community.

Building this sucker

You'll need the following ingredients:

• Rust >= 1.5.0: https://www.rust-lang.org/
• Cargo (any recent)

Once those two are installed, you can build PTO as follows:

$ cargo build

PTO can then be ran:

$ cargo run https://matrix.org/_matrix/client/api/v1/

Specify a different URL to use a different matrix server.

Or the appropriate binary named ./target/*/pto

Configuration

Currently configuration is limited to modifying hardcoded strings in various places. Thank you for getting this far though! I would absolutely love a patch <3

Usage

By default, PTO will listen on localhost:8001 for an IRC client to connect with an appropriate username and password. The username and password supplied through the IRC connection will be used to login to matrix.

TODO

This whole thing is intensely a work in progress. It doesn't even do anything useful right now like handling messages or even listing channels.

• Handle IRC protocol
• Login to matrix
• Handle matrix event polling without blocking IRC thread
• Translate basic IRC events to matrix events and vice-versa
• Create/join new channels through IRC
• Set channel topics
• PMs
• Support /list command
• Channel kicks/bans
• Support SSL listeners
• Send backlog on connect
• Throw all kinds of warrnings and red flags about non-ssl configurations
• Support logins that aren't at a given server
• Drop all the oob.systems specific cruft