Add support for custom homeserver URLs (#85)

This can be used to connect to proxies like Pantalaimon or for servers whose automatic discovery is broken

Author: progval

README.md

@@ -78,11 +78,18 @@ Two notes on this screenshot:
   * no SSL/TLS
   * SASL username: your full matrix ID (`user:homeserver.example.org`)
   * SASL password: your matrix password
+  * (Optional / advanced configuration) If you cannot use homeserver URL discovery, configure `homeserver-url=https://homeserver.example.org` as your IRC client's GECOS/"real name"
 
 See below for extra instructions to work with web clients.
 
 See `INSTALL.md` for a more production-oriented guide.
 
+## End-to-end encryption
+
+Matrix2051 does not support Matrix's end-to-end encryption (E2EE), but can optionally be used with [Pantalaimon](https://github.com/matrix-org/pantalaimon).
+
+To do so, setup Pantalaimon locally, and configure `homeserverurl=http://localhost:8009` as your IRC client's GECOS/"real name".
+
 ## Architecture
 
 * `matrix2051.exs` starts M51.Application, which starts M51.Supervisor, which

lib/irc/handler.ex

@@ -187,7 +187,6 @@ defmodule M51.IrcConn.Handler do
       state = M51.IrcConn.Supervisor.state(sup_pid)
 
       M51.IrcConn.State.set_nick(state, nick)
-      M51.IrcConn.State.set_gecos(state, gecos)
 
       case user_id do
         # all good
@@ -355,6 +354,8 @@ defmodule M51.IrcConn.Handler do
         nil
 
       {"USER", [_, _, _, gecos | _]} ->
+        state = M51.IrcConn.Supervisor.state(sup_pid)
+        M51.IrcConn.State.set_gecos(state, gecos)
         {:user, gecos}
 
       {"USER", _} ->
@@ -428,6 +429,7 @@ defmodule M51.IrcConn.Handler do
 
         # TODO: support multi-line AUTHENTICATE
 
+        state = M51.IrcConn.Supervisor.state(sup_pid)
         matrix_client = M51.IrcConn.Supervisor.matrix_client(sup_pid)
 
         case M51.MatrixClient.Client.user_id(matrix_client) do
@@ -440,11 +442,23 @@ defmodule M51.IrcConn.Handler do
                       {:ok, {local_name, hostname}} ->
                         user_id = authcid
 
+                        # Keep deprecated alias "plaintextproxy" that was used back when
+                        # this was only meant to be used with Pantalaimon
+                        proxy =
+                          case Regex.named_captures(
+                                 ~R((plaintextproxy|homeserver-url\)=(?<url>https?://\S*\)),
+                                 M51.IrcConn.State.gecos(state)  || ""
+                               ) do
+                            nil -> nil
+                            %{"url" => url} -> url
+                          end
+
                         case M51.MatrixClient.Client.connect(
                                matrix_client,
                                local_name,
                                hostname,
-                               passwd
+                               passwd,
+                               proxy
                              ) do
                           {:ok} ->
                             # RPL_LOGGEDIN

lib/matrix_client/client.ex

@@ -66,14 +66,14 @@ defmodule M51.MatrixClient.Client do
   end
 
   @impl true
-  def handle_call({:connect, local_name, hostname, password}, _from, state) do
+  def handle_call({:connect, local_name, hostname, password, proxy}, _from, state) do
     case state do
       %M51.MatrixClient.Client{
         state: :initial_state,
         irc_pid: irc_pid
       } ->
         httpoison = M51.Config.httpoison()
-        base_url = get_base_url(hostname)
+        base_url = proxy || get_base_url(hostname)
 
         # Check the server supports password login
         url = base_url <> "/_matrix/client/r0/login"
@@ -545,8 +545,8 @@ defmodule M51.MatrixClient.Client do
     end
   end
 
-  def connect(pid, local_name, hostname, password) do
-    GenServer.call(pid, {:connect, local_name, hostname, password}, @timeout)
+  def connect(pid, local_name, hostname, password, proxy \\ nil) do
+    GenServer.call(pid, {:connect, local_name, hostname, password, proxy}, @timeout)
   end
 
   def raw_client(pid) do

test/matrix_client/client_test.exs

@@ -117,7 +117,7 @@ defmodule M51.MatrixClient.ClientTest do
     client = start_supervised!({M51.MatrixClient.Client, {sup_pid, [httpoison: MockHTTPoison]}})
 
     assert {:error, :unknown, message} =
-             GenServer.call(client, {:connect, "user", "example.org", "p4ssw0rd"})
+             GenServer.call(client, {:connect, "user", "example.org", "p4ssw0rd", nil})
 
     assert Regex.match?(~r/Could not reach the Matrix homeserver for example.org.*/, message)
 
@@ -188,7 +188,7 @@ defmodule M51.MatrixClient.ClientTest do
 
     client = start_supervised!({M51.MatrixClient.Client, {sup_pid, [httpoison: MockHTTPoison]}})
 
-    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd"}) == {:ok}
+    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd", nil}) == {:ok}
 
     assert GenServer.call(client, {:dump_state}) ==
              %M51.MatrixClient.Client{
@@ -274,7 +274,7 @@ defmodule M51.MatrixClient.ClientTest do
 
     client = start_supervised!({M51.MatrixClient.Client, {sup_pid, [httpoison: MockHTTPoison]}})
 
-    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd"}) == {:ok}
+    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd", nil}) == {:ok}
 
     assert GenServer.call(client, {:dump_state}) ==
              %M51.MatrixClient.Client{
@@ -330,7 +330,7 @@ defmodule M51.MatrixClient.ClientTest do
 
     client = start_supervised!({M51.MatrixClient.Client, {sup_pid, [httpoison: MockHTTPoison]}})
 
-    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd"}) ==
+    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd", nil}) ==
              {:error, :no_password_flow, "No password flow"}
 
     assert GenServer.call(client, {:dump_state}) ==
@@ -398,7 +398,7 @@ defmodule M51.MatrixClient.ClientTest do
 
     client = start_supervised!({M51.MatrixClient.Client, {sup_pid, [httpoison: MockHTTPoison]}})
 
-    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd"}) ==
+    assert GenServer.call(client, {:connect, "user", "matrix.example.org", "p4ssw0rd", nil}) ==
              {:error, :denied, "Invalid password"}
 
     assert GenServer.call(client, {:dump_state}) ==

test/test_helper.exs

@@ -96,7 +96,7 @@ defmodule MockMatrixClient do
   end
 
   @impl true
-  def handle_call({:connect, local_name, hostname, password}, _from, state) do
+  def handle_call({:connect, local_name, hostname, password, nil}, _from, state) do
     case {hostname, password} do
       {"i-hate-passwords.example.org", _} ->
         {:reply, {:error, :no_password_flow, "No password flow"}, state}