testmatrix 0.2.1__tar.gz → 0.2.3__tar.gz

{testmatrix-0.2.1 → testmatrix-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testmatrix
-Version: 0.2.1
+Version: 0.2.3
 Summary: A matrix server sanity tester
 Author-email: Sebastian Spaeth <Sebastian@SSpaeth.de>
 License-Expression: AGPL-3.0-or-later

{testmatrix-0.2.1 → testmatrix-0.2.3}/src/testmatrix/__init__.py

@@ -5,7 +5,7 @@
 from .matrixserver import MatrixServer
 from .jwtauth import JWTAuth
 
-__version__ = "0.2.1"
+__version__ = "0.2.3"
 __all__ = ["MatrixServer", "JWTAuth"]
 
 # User Agent and possibly other required headers that we need for all requests

{testmatrix-0.2.1 → testmatrix-0.2.3}/src/testmatrix/jwtauth.py

@@ -38,17 +38,14 @@ class JWTAuth:
                 s = f"𐄂 DNS Error resolving host {self.baseurl}"
                 logging.error(s)
         else:
-            logging.debug("  JWTauth healtz url: %s", self.loganon(self.baseurl))
             if r.status_code == 404:
-                logging.warning("𐄂 jwtauth healthz endpoint does not exist at %s (404)",
+                logging.info(" jwtauth healthz endpoint does not exist at %s (404)",
                                 self.loganon(url))
             elif r.status_code != 200:
-                logging.error("𐄂 jwtauth healthz http error %s",
+                logging.warn(" jwtauth healthz http error %s",
                               r.status_code)
             else:
                 #status code 200, all is well!
-                if not "Access-Control-Allow-Origin" in r.headers:
-                    logging.debug("  jwt healthz has no CORS header (that is OK")
                 logging.info("✔ JWTauth healthz responds")
                 return True
         return False

{testmatrix-0.2.1 → testmatrix-0.2.3}/src/testmatrix/matrixserver.py

@@ -65,9 +65,12 @@ class MatrixServer:
 
     def parse_livekit_json(self, livekit_json: Optional[list]) \
             -> Optional[bool]:
-        """Parses client well-known livekit parts and initiates self.livekits
+        """Parses livekit json parts and initiates self.livekits
+        It works both with the client well-known and the
+        /_matrix/client/v1/rtc/transports endpoint.
 
-        Returns True (success), False (no Livekit) or None (Error)"""
+        Returns True (success), False (no Livekit) or None (Error)
+        """
         self.livekits = []
         if livekit_json is None:
             self.livekits = None
@@ -86,8 +89,6 @@ class MatrixServer:
                 continue
             anon: bool = (self.args is not None) and self.args.anonymize
             self.livekits.append(JWTAuth(livekit["livekit_service_url"], anon))
-            logging.debug("  Adding livekit service URL: %s",
-                          livekit["livekit_service_url"])
         return len(self.livekits) > 0
 
     def get_server_baseurl(self) -> Optional[str]:
@@ -122,14 +123,18 @@ class MatrixServer:
                     logging.error("𐄂 Server well-known error %s", str(e))
         except requests.exceptions.JSONDecodeError as e:
             if self.diagnostics:
-                logging.error("𐄂 Server well known is no valid json")
+                logging.error("𐄂 Server well-known is no valid json")
         else:
-            self.federation_baseurl = "https://" + wellknown_server["m.server"]
-            if self.diagnostics:
-                logging.debug("  Federation url: %s",
-                              self.loganon(self.federation_baseurl,
-                                           self.servername))
-                logging.info("✔ Server well-known exists")
+            if not "m.server" in wellknown_server:
+                logging.warning("𐄂 Server well-known does not contain information about server!")
+            else:
+                self.federation_baseurl = \
+                    "https://" + wellknown_server["m.server"]
+                if self.diagnostics:
+                    logging.debug("  Federation url: %s",
+                                  self.loganon(self.federation_baseurl,
+                                               self.servername))
+                    logging.info("✔ Server well-known exists")
 
         # use default address in case of failed well-known
         if not self.federation_baseurl:
@@ -217,7 +222,9 @@ class MatrixServer:
         # Retrieve array of livekit instances or None
         livekit_json = wellknown_client.get("org.matrix.msc4143.rtc_foci",
                                             None)
-        self.parse_livekit_json(livekit_json)
+        livekit_detected = self.parse_livekit_json(livekit_json)
+        if livekit_detected:
+            logging.debug("  Livekit detected via client .well-known (deprecated)")
         return self.client_baseurl
 
     def get_server_version(self) -> str:
@@ -324,6 +331,64 @@ class MatrixServer:
             logging.info("𐄂 Client API endpoint problem (no versions document)")
         return res
 
+    def test_oauth_metadata(self) -> bool:
+        """Tests if /_matrix/client/v1/auth_metadata
+        This is part of the 1.15 spec."""
+        res = True # Success result
+        try:
+            url = f"{self.client_baseurl}/_matrix/client/v1/auth_metadata"
+            r = requests.get(url, headers = req_headers)
+            r.raise_for_status() # raise e.g. on 404
+            if self.diagnostics and not "Access-Control-Allow-Origin" in r.headers:
+                logging.error("𐄂 Client version endpoint has no CORS header")
+            elif self.diagnostics and r.headers["Access-Control-Allow-Origin"] != "*":
+                logging.error("𐄂 Client version endpoint has no proper CORS header: '%s'", r.headers["Access-Control-Allow-Origin"])
+        except requests.exceptions.HTTPError as e:
+            res = False
+            logging.info("  Server oauth metadata endpoint failed (spec 1.15)")
+        else:
+            logging.debug("✔ Server oauth metadata endpoint exists")
+        return res
+
+    def test_rtc_endpoint_msc4195(self) -> bool:
+        """returns true if unstable rtc/transports returns info"""
+        res:bool = False # result
+        if self.args is None or self.args.token is None:
+            logging.info("  RTC Transport endpoint skipped, no auth token")
+            return False
+        try:
+            # TODO: once stable, use /_matrix/client/v1/rtc/transports
+            url = f"{self.client_baseurl}/_matrix/client/unstable/org.matrix.msc4143/rtc/transports"
+            headers = {"Authorization": f"Bearer {self.args.token}"}
+            headers.update(req_headers)
+            r = requests.get(url, headers = headers)
+            r.raise_for_status() # raise e.g. on 404
+            rtc_transports = r.json()
+            res = True
+        except requests.exceptions.HTTPError as e:
+            if e.response.status_code == 404:
+                logging.info("𐄂 RTC Transport (unstable) returns (404)")
+            elif e.response.status_code == 401:
+                logging.warning("𐄂 RTC Transport discovery needs authentication (use a token) (401)")
+            else:
+                logging.error("𐄂 RTC transport endpoints returns error %s", str(e))
+            res = False
+        except requests.exceptions.JSONDecodeError as e:
+            if self.diagnostics:
+                logging.error("𐄂 RTC transport response is no valid json")
+            res = False
+        if res:
+            rtc_transports = rtc_transports.get("rtc_transports", None)
+            livekit_detected = self.parse_livekit_json(rtc_transports)
+            if livekit_detected:
+                logging.debug("✔ Livekit detected via RTC transport endpoint")
+            else:
+                logging.warn("𐄂 RTC transport endpoints exists but no livekit detected")
+        elif self.diagnostics:
+            logging.info("𐄂 RTC transport endpoint problem")
+        return res
+
+
     def test_qrcode_login(self) -> bool:
         """Returns true if QRcode login is setup (msc4108)"""
         res:bool = False # qrcode has been setup
@@ -489,7 +554,7 @@ class MatrixServer:
             r.raise_for_status() # raise e.g. on 403
         except requests.exceptions.HTTPError as e:
             if r is not None and r.status_code != 403:
-                logging.warning("𐄂 Direct open registration might not be forbidden!")
+                logging.warning("𐄂 Direct open registration might not be forbidden (returned %d)!", r.status_code)
                 res = False
         # Next test for guest access
         try:
@@ -502,8 +567,7 @@ class MatrixServer:
         except requests.exceptions.HTTPError as e:
             pass
         if r is not None and r.status_code != 403:
-            logging.warning("𐄂 Guest access might not be forbidden (returned %d)!",
-                            r.status_code)
+            logging.warning("𐄂 Guest access might not be forbidden (returned %d)!", r.status_code)
             res = False
         if res:
             logging.debug("✔ Direct registration and guest access forbidden per se 👍")
@@ -518,6 +582,8 @@ class MatrixServer:
         self.test_server_keys()
         self.get_server_version()
         self.test_client_endpoint()
+        self.test_oauth_metadata()
+        self.test_rtc_endpoint_msc4195()
         if self.diagnostics:
             self.test_qrcode_login()
             self.test_room_directory()

{testmatrix-0.2.1 → testmatrix-0.2.3}/src/testmatrix/utils.py

@@ -5,7 +5,8 @@
 from typing import Optional
 import re
 # User Agent and possibly other required headers that we need for all requests
-req_headers = {"User-Agent": "Mozilla/5.0 (Linux; x64)"}
+req_headers = {"User-Agent": "Mozilla/5.0 (Linux; x64)",
+               "Origin": "https://localhost"}
 DOMAIN = re.compile(r"(?P<prefix>https://.*?)\w*\.\w{2,}(?P<URL>/)",
                     re.IGNORECASE)
 

{testmatrix-0.2.1 → testmatrix-0.2.3}/testmatrix.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testmatrix
-Version: 0.2.1
+Version: 0.2.3
 Summary: A matrix server sanity tester
 Author-email: Sebastian Spaeth <Sebastian@SSpaeth.de>
 License-Expression: AGPL-3.0-or-later