From 7e112359a2e64767eb5769dcf2f8e8f11ab4512e Mon Sep 17 00:00:00 2001
From: Shivaram Lingamneni <slingamn@cs.stanford.edu>
Date: Fri, 4 Mar 2022 15:58:05 -0500
Subject: [PATCH] secret channel test (#135)

* silent.py tests for channels with mode +s appearing in LIST only when the user is connected to that channel

* Added assertions for exact content of lines with command RPL_LIST and checks for exact number of RPL_LIST replies

* fix linter errors

* only validate the first two parameters of RPL_LIST

* rename to secret channel test, add citation

* ignore ngircd pseudo-channel

* attempt to fix charybdis/solanum and ircu issues

* review fixes

Co-authored-by: William Rehwinkel <willrehwinkel@gmail.com>
---
 irctest/controllers/charybdis.py       |  3 ++
 irctest/server_tests/chmodes/secret.py | 55 ++++++++++++++++++++++++++
 irctest/server_tests/list.py           |  8 ++--
 3 files changed, 62 insertions(+), 4 deletions(-)
 create mode 100644 irctest/server_tests/chmodes/secret.py

diff --git a/irctest/controllers/charybdis.py b/irctest/controllers/charybdis.py
index 489d36b..e07685e 100644
--- a/irctest/controllers/charybdis.py
+++ b/irctest/controllers/charybdis.py
@@ -12,6 +12,9 @@ serverinfo {{
 
 general {{
     throttle_count = 100;  # We need to connect lots of clients quickly
+    # disable throttling for LIST and similar:
+    pace_wait_simple = 0 second;
+    pace_wait = 0 second;
     sasl_service = "SaslServ";
 }};
 
diff --git a/irctest/server_tests/chmodes/secret.py b/irctest/server_tests/chmodes/secret.py
new file mode 100644
index 0000000..15efaff
--- /dev/null
+++ b/irctest/server_tests/chmodes/secret.py
@@ -0,0 +1,55 @@
+from irctest import cases
+from irctest.numerics import RPL_LIST
+
+
+class SecretChannelTestCase(cases.BaseServerTestCase):
+    @cases.mark_specifications("RFC1459", "Modern")
+    def testSecretChannelListCommand(self):
+        """
+        <https://datatracker.ietf.org/doc/html/rfc1459#section-4.2.6>
+
+        "Likewise, secret channels are not listed
+        at all unless the client is a member of the channel in question."
+
+        <https://modern.ircdocs.horse/#secret-channel-mode>
+        "A channel that is set to secret will not show up in responses to
+        the LIST or NAMES command unless the client sending the command is
+        joined to the channel."
+        """
+
+        def get_listed_channels(replies):
+            channels = set()
+            for reply in replies:
+                # skip pseudo-channels (&SERVER, &NOTICES) listed by ngircd
+                # and ircu:
+                if reply.command == RPL_LIST and reply.params[1].startswith("#"):
+                    channels.add(reply.params[1])
+            return channels
+
+        # test that a silent channel is shown in list if the user is in the channel.
+        self.connectClient("first", name="first")
+        self.joinChannel("first", "#gen")
+        self.getMessages("first")
+        self.sendLine("first", "MODE #gen +s")
+        # run command LIST
+        self.sendLine("first", "LIST")
+        replies = self.getMessages("first")
+        self.assertEqual(get_listed_channels(replies), {"#gen"})
+
+        # test that another client would not see the secret
+        # channel.
+        self.connectClient("second", name="second")
+        self.getMessages("second")
+        self.sendLine("second", "LIST")
+        replies = self.getMessages("second")
+        # RPL_LIST 322 should NOT be present this time.
+        self.assertEqual(get_listed_channels(replies), set())
+
+        # Second client will join the secret channel
+        # and call command LIST. The channel SHOULD
+        # appear this time.
+        self.joinChannel("second", "#gen")
+        self.sendLine("second", "LIST")
+        replies = self.getMessages("second")
+        # Should be only one line with command RPL_LIST
+        self.assertEqual(get_listed_channels(replies), {"#gen"})
diff --git a/irctest/server_tests/list.py b/irctest/server_tests/list.py
index 0310903..9529cb9 100644
--- a/irctest/server_tests/list.py
+++ b/irctest/server_tests/list.py
@@ -15,8 +15,8 @@ class ListTestCase(cases.BaseServerTestCase):
         if m.command == "321":
             # skip RPL_LISTSTART
             m = self.getMessage(2)
-        while m.command == "322" and m.params[1] == "&SERVER":
-            # ngircd adds this pseudo-channel
+        # skip local pseudo-channels listed by ngircd and ircu
+        while m.command == "322" and m.params[1].startswith("&"):
             m = self.getMessage(2)
         self.assertNotEqual(
             m.command,
@@ -58,8 +58,8 @@ class ListTestCase(cases.BaseServerTestCase):
             "nor 323 (RPL_LISTEND) but: {msg}",
         )
         m = self.getMessage(2)
-        while m.command == "322" and m.params[1] == "&SERVER":
-            # ngircd adds this pseudo-channel
+        # skip local pseudo-channels listed by ngircd and ircu
+        while m.command == "322" and m.params[1].startswith("&"):
             m = self.getMessage(2)
         self.assertNotEqual(
             m.command,