BUG26179150: Check for invalid connection options

amitab · amitab · commit 0379c69560ac · 2017-06-02T20:11:34.000+05:30
The session is successfully established when using invalid options. This is
prone to accidental wrong usage.

This patch will not allow usage of invalid connection option and will throw
a ProgrammingError.

Tests have been added for regression.
diff --git a/lib/mysqlx/__init__.py b/lib/mysqlx/__init__.py
@@ -47,6 +47,8 @@
 _SPLIT = re.compile(r',(?![^\(\)]*\))')
 _PRIORITY = re.compile(r'^\(address=(.+),priority=(\d+)\)$', re.VERBOSE)
 ssl_opts = ["ssl-cert", "ssl-ca", "ssl-key", "ssl-crl"]
+sess_opts = ssl_opts + ["user", "password", "schema", "host", "port",
+                        "routers", "socket", "ssl-mode"]
 
 def _parse_address_list(path):
     """Parses a list of host, port pairs
@@ -135,18 +137,27 @@ def _validate_settings(settings):
     Args:
         settings: dict containing connection settings.
     """
+    invalid_opts = set(settings.keys()).difference(sess_opts)
+    if invalid_opts:
+        raise ProgrammingError("Invalid options: {0}."
+                               "".format(", ".join(invalid_opts)))
+
     if "routers" in settings:
         for router in settings["routers"]:
             _validate_hosts(router)
     elif "host" in settings:
         _validate_hosts(settings)
 
-    if "ssl-mode" in settings and settings["ssl-mode"] not in SSLMode:
-        raise InterfaceError("Invalid SSL Mode '{0}'."
-                             "".format(settings["ssl-mode"]))
-    elif settings.get("ssl-mode") == SSLMode.DISABLED and \
-        any(key in settings for key in ssl_opts):
-        raise InterfaceError("SSL options used with ssl-mode 'disabled'.")
+    if "ssl-mode" in settings:
+        try:
+            settings["ssl-mode"] = settings["ssl-mode"].lower()
+            SSLMode.index(settings["ssl-mode"])
+        except (AttributeError, ValueError):
+            raise InterfaceError("Invalid SSL Mode '{0}'."
+                                 "".format(settings["ssl-mode"]))
+        if settings["ssl-mode"] == SSLMode.DISABLED and \
+            any(key in settings for key in ssl_opts):
+            raise InterfaceError("SSL options used with ssl-mode 'disabled'.")
 
     if "ssl-crl" in settings and not "ssl-ca" in settings:
         raise InterfaceError("CA Certificate not provided.")
diff --git a/tests/test_mysqlx_connection.py b/tests/test_mysqlx_connection.py
@@ -231,6 +231,24 @@ def test___init__(self):
         except InterfaceError as err:
             self.assertEqual(4001, err.errno)
 
+        # Invalid option with URI
+        uri = "mysqlx://{0}:{1}@{2}:{3}?invalid=option" \
+              "".format(user, password, host, port)
+        self.assertRaises(ProgrammingError, mysqlx.get_session, uri)
+
+        # Invalid option with dict
+        config = {
+            "user": user,
+            "password": password,
+            "host": host,
+            "port": port,
+            "invalid": "option"
+        }
+        self.assertRaises(ProgrammingError, mysqlx.get_session, config)
+
+        # Invalid option with kwargs
+        self.assertRaises(ProgrammingError, mysqlx.get_session, **config)
+
     @unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 15), "--mysqlx-socket option tests not available for this MySQL version")
     def test_mysqlx_socket(self):
         # Connect with unix socket
