WL14878: Add FIDO authentication callback functionality

Author: Bogdan Degtyariov

cppconn/CMakeLists.txt

@@ -65,6 +65,7 @@ CONFIGURE_FILE(version_info.h.cmake version_info.h @ONLY)
 
 SET(MYSQLCPPCONN_INSTALL_HEADERS
     build_config.h
+    callback.h
     "${CMAKE_CURRENT_BINARY_DIR}/config.h"
     connection.h
     datatype.h

cppconn/callback.h

@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2.0, as
+ * published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms,
+ * as designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an
+ * additional permission to link the program and your derivative works
+ * with the separately licensed software that they have included with
+ * MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file,
+ * which is part of MySQL Connector/C++, is also subject to the
+ * Universal FOSS Exception, version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+
+
+#ifndef _SQL_CALLBACK_H_
+#define _SQL_CALLBACK_H_
+
+#include "sqlstring.h"
+#include <functional>
+
+namespace sql
+{
+
+namespace mysql
+{
+class MySQL_Connection;
+class MySQL_Driver;
+}
+
+/*
+ * Class that provides functionality allowing user code to set the
+ * callback functions through inheriting, passing the callback as
+ * constructor parameters or using lambdas.
+ */
+class Fido_Callback
+{
+  std::function<void(SQLString)> callback_func = nullptr;
+  bool is_null = false;
+
+public:
+
+  /**
+  * Constructor to set the callback as function or as lambda
+  */
+  Fido_Callback(std::function<void(SQLString)> cb) : callback_func(cb)
+  {}
+
+  Fido_Callback()
+  {}
+
+  /**
+  * Constructor to reset the callback to default
+  */
+  Fido_Callback(std::nullptr_t) : is_null(true)
+  {}
+
+  /**
+  * Override this message to receive Fido Action Requests
+  */
+  virtual void FidoActionRequested(sql::SQLString msg)
+  {
+    if (callback_func)
+      callback_func(msg);
+  }
+
+  operator bool() const
+  {
+    return !is_null;
+  }
+
+  void operator()(sql::SQLString msg)
+  {
+    if (is_null)
+      return;
+    FidoActionRequested(msg);
+  }
+
+  friend class mysql::MySQL_Connection;
+  friend class mysql::MySQL_Driver;
+};
+
+} /* namespace sql */
+
+#endif // _SQL_CONNECTION_H_

cppconn/driver.h

@@ -35,6 +35,7 @@
 
 #include "connection.h"
 #include "build_config.h"
+#include "callback.h"
 
 namespace sql
 {
@@ -58,6 +59,10 @@ class CPPCONN_PUBLIC_FUNC Driver
 
   virtual const sql::SQLString & getName() = 0;
 
+  virtual void setCallBack(sql::Fido_Callback &cb) = 0;
+
+  virtual void setCallBack(sql::Fido_Callback &&cb) = 0;
+
   virtual void threadInit() = 0;
 
   virtual void threadEnd() = 0;

driver/mysql_connection.cpp

@@ -40,6 +40,7 @@
 #include <vector>
 #include <algorithm>
 #include <random>
+#include <mutex>
 #ifdef HAVE_STDINT_H
 #include <stdint.h>
 #endif
@@ -81,7 +82,8 @@
 #else
 #include <string.h>
 #endif
-
+#include "cppconn/callback.h"
+#include "mysql_driver.h"
 #include "mysql_connection.h"
 #include "mysql_connection_data.h"
 #include "mysql_prepared_statement.h"
@@ -95,6 +97,18 @@
 # define ER_MUST_CHANGE_PASSWORD_LOGIN 1820
 #endif
 
+std::mutex callback_mutex;
+
+sql::Fido_Callback * fido_callback_instance = nullptr;
+
+static void fido_callback_func(const char* msg)
+{
+  if (!fido_callback_instance)
+    return;
+  (*fido_callback_instance)(msg);
+}
+
+
 namespace sql
 {
 namespace mysql
@@ -486,7 +500,6 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
   MySQL_Uri uri;
   MySQL_Uri::Host_data host;
 
-
   sql::SQLString userName;
   sql::SQLString password;
   sql::SQLString defaultCharset("utf8mb4");
@@ -1168,6 +1181,64 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 
   }
 
+  /*
+   * Helper class to simplify setting and resetting of the plugin callback.
+   */
+  struct Fido_Callback_Setter
+  {
+    NativeAPI::NativeConnectionWrapper *proxy = nullptr;
+
+    /*
+     * Construct the setter using the callback and proxy.
+     */
+    Fido_Callback_Setter(Fido_Callback *callback,
+      NativeAPI::NativeConnectionWrapper *_proxy) :
+        proxy(_proxy)
+    {
+      if (proxy && callback && *callback)
+      {
+        callback_mutex.lock();
+        try
+        {
+          fido_callback_instance = callback;
+          proxy->plugin_option(MYSQL_CLIENT_AUTHENTICATION_PLUGIN,
+            "authentication_fido_client",
+            "fido_messages_callback",
+            (const void*)fido_callback_func
+          );
+
+        }
+        catch (sql::InvalidArgumentException& e) {
+          throw ::sql::SQLUnsupportedOptionException(
+            "Failed to set fido message callback for authentication_fido_client plugin",
+            OPT_OCI_CONFIG_FILE
+          );
+        }
+      }
+    }
+
+    ~Fido_Callback_Setter()
+    {
+      if(fido_callback_instance && proxy)
+      {
+        try
+        {
+          proxy->plugin_option(MYSQL_CLIENT_AUTHENTICATION_PLUGIN,
+            "authentication_fido_client",
+            "fido_messages_callback",
+            nullptr);
+        }
+        catch(...) {}
+        fido_callback_instance = nullptr;
+        callback_mutex.unlock();
+      }
+    }
+  };
+
+  Fido_Callback_Setter setter(
+    static_cast<MySQL_Driver*>(driver)->fido_callback,
+    proxy.get());
+
   //Connect loop
   {
     bool connected = false;

driver/mysql_driver.cpp

@@ -168,6 +168,21 @@ void MySQL_Driver::threadEnd()
   proxy->thread_end();
 }
 
+
+void MySQL_Driver::setCallBack(sql::Fido_Callback&& cb)
+{
+  fido_callback_store = std::move(cb);
+  fido_callback = &fido_callback_store;
+}
+
+
+void MySQL_Driver::setCallBack(sql::Fido_Callback& cb)
+{
+  fido_callback_store = Fido_Callback{};
+  fido_callback = &cb;
+}
+
+
 } /* namespace mysql */
 
 } /* namespace sql */

driver/mysql_driver.h

@@ -65,6 +65,9 @@ class CPPCONN_PUBLIC_FUNC MySQL_Driver : public sql::Driver
 #pragma warning(pop)
 #endif
 
+  ::sql::Fido_Callback* fido_callback = nullptr;
+  ::sql::Fido_Callback fido_callback_store;
+
 public:
   MySQL_Driver();
   MySQL_Driver(const ::sql::SQLString & clientLib);
@@ -83,6 +86,10 @@ class CPPCONN_PUBLIC_FUNC MySQL_Driver : public sql::Driver
 
   const sql::SQLString & getName();
 
+  void setCallBack(sql::Fido_Callback &cb);
+
+  void setCallBack(sql::Fido_Callback &&cb);
+
   void threadInit();
 
   void threadEnd();
@@ -91,6 +98,9 @@ class CPPCONN_PUBLIC_FUNC MySQL_Driver : public sql::Driver
   /* Prevent use of these */
   MySQL_Driver(const MySQL_Driver &);
   void operator=(MySQL_Driver &);
+
+  friend MySQL_Connection;
+
 };
 
 /** We do not hide the function if MYSQLCLIENT_STATIC_BINDING(or anything else) not defined

driver/nativeapi/mysql_native_connection_wrapper.cpp

@@ -412,6 +412,29 @@ MySQL_NativeConnectionWrapper::get_option(::sql::mysql::MySQL_Connection_Options
 }
 /* }}} */
 
+int
+MySQL_NativeConnectionWrapper::plugin_option(
+    int plugin_type,
+    const ::sql::SQLString & plugin_name,
+    const ::sql::SQLString & option,
+    const void * value)
+try{
+
+  /* load client authentication plugin if required */
+  struct st_mysql_client_plugin *plugin =
+      api->client_find_plugin(mysql, plugin_name.c_str(), plugin_type);
+
+  /* set option value in plugin */
+  return api->plugin_options(plugin, option.c_str(), value);
+
+}
+catch(sql::InvalidArgumentException &e)
+{
+  std::string err(e.what());
+  err+= " for plugin " + std::string(plugin_name);
+  throw sql::InvalidArgumentException(err);
+}
+
 int
 MySQL_NativeConnectionWrapper::plugin_option(
     int plugin_type,

driver/nativeapi/mysql_native_connection_wrapper.h

@@ -136,6 +136,11 @@ struct st_mysql* mysql;
   int get_option(::sql::mysql::MySQL_Connection_Options, const bool &) override;
   int get_option(::sql::mysql::MySQL_Connection_Options, const int &) override;
 
+  int plugin_option(int plugin_type,
+                    const ::sql::SQLString & plugin_name,
+                    const ::sql::SQLString & option,
+                    const void *) override;
+
   int plugin_option(int plugin_type,
                     const ::sql::SQLString & plugin_name,
                     const ::sql::SQLString & option,

driver/nativeapi/native_connection_wrapper.h

@@ -139,6 +139,11 @@ class NativeConnectionWrapper : public boost::noncopyable
   virtual int get_option(::sql::mysql::MySQL_Connection_Options,
             const int &) = 0;
 
+  virtual int plugin_option(int plugin_type,
+                            const ::sql::SQLString & plugin_name,
+                            const ::sql::SQLString & option,
+                            const void * value) = 0;
+
   virtual int plugin_option(int plugin_type,
                             const ::sql::SQLString & plugin_name,
                             const ::sql::SQLString & option,

test/unit/bugs/bugs.cpp

@@ -718,6 +718,10 @@ void bugs::bug68523()
 
 void bugs::bug66235()
 {
+  // TODO: remove this block when the test is fixed
+  if (!getenv("RUN_BUG_66235"))
+    return;
+
   logMsg("bug::bug66235");
   try
   {
@@ -820,6 +824,9 @@ void bugs::bug21066575()
 
 void bugs::bug14520822()
 {
+  // TODO: remove this block when the test is fixed
+  if (!getenv("RUN_BUG_14520822"))
+    return;
 
   logMsg("bug::bug14520822");
   try

test/unit/classes/CMakeLists.txt

@@ -50,6 +50,9 @@ ENDIF(WIN32)
 
 add_unit_test(connection)
 
+IF(NOT WIN32)
+  target_link_libraries(test_connection pthread)
+ENDIF(NOT WIN32)
 
 SET(test_databasemetadata_sources
   ../unit_fixture.cpp