WL#16458: JDBC: Bundle authentication plugins in connector packages

Author: rsomla1

jdbc/cmake/DepFindMySQL.cmake

@@ -492,15 +492,18 @@ function(use_mysql_config)
 
   _mysql_conf(MYSQL_INCLUDE_DIR --variable=pkgincludedir)
   _mysql_conf(MYSQL_LIB_DIR     --variable=pkglibdir)
-  _mysql_conf(MYSQL_PLUGIN_DIR     --variable=plugindir)
 
   file(TO_CMAKE_PATH "${MYSQL_INCLUDE_DIR}" MYSQL_INCLUDE_DIR)
   file(TO_CMAKE_PATH "${MYSQL_LIB_DIR}" MYSQL_LIB_DIR)
-  file(TO_CMAKE_PATH "${MYSQL_PLUGIN_DIR}" MYSQL_PLUGIN_DIR)
 
   set(MYSQL_INCLUDE_DIR "${MYSQL_INCLUDE_DIR}" PARENT_SCOPE)
   set(MYSQL_LIB_DIR "${MYSQL_LIB_DIR}" PARENT_SCOPE)
-  set(MYSQL_PLUGIN_DIR "${MYSQL_PLUGIN_DIR}" PARENT_SCOPE)
+
+  if(NOT MYSQL_PLUGIN_DIR)
+    _mysql_conf(MYSQL_PLUGIN_DIR --variable=plugindir)
+    file(TO_CMAKE_PATH "${MYSQL_PLUGIN_DIR}" MYSQL_PLUGIN_DIR)
+    set(MYSQL_PLUGIN_DIR "${MYSQL_PLUGIN_DIR}" PARENT_SCOPE)
+  endif()
 
   # client library version (note: it will be cleaned up in get_version())
 

jdbc/driver/CMakeLists.txt

@@ -193,6 +193,11 @@ IF(WIN32)
 ENDIF(WIN32)
 
 
+if(DEFINED DEFAULT_PLUGIN_DIR)
+  add_compile_definitions(DEFAULT_PLUGIN_DIR="${DEFAULT_PLUGIN_DIR}")
+endif()
+
+
 #-----------------
 
 add_library(jdbc STATIC ${MYSQLCPPCONN_SOURCES})

jdbc/driver/mysql_connection.cpp

@@ -99,6 +99,13 @@
 bool oci_plugin_is_loaded = false;
 
 
+#ifdef DEFAULT_PLUGIN_DIR
+std::string default_plugin_dir(DEFAULT_PLUGIN_DIR);
+#else
+std::string default_plugin_dir;
+#endif
+
+
 namespace sql
 {
 namespace mysql
@@ -783,21 +790,10 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
         throw sql::InvalidArgumentException("Wrong type passed for pluginDir expected sql::SQLString");
       }
     }
-#if(_WIN32 && CONCPP_BUILD_SHARED)
-    else {
-      /*
-        Note: For DLL in Windows we will try to set the plugin directory
-        based on driver_dll_path.
-      */
-      plugin_dir = driver_dll_path;
-#ifdef _DEBUG
-      // Debug dll is placed inside debug subdirectory
-      plugin_dir.append("..\\");
-#endif
-      plugin_dir.append("plugin");
+    else if(!default_plugin_dir.empty()) {
+      plugin_dir = default_plugin_dir;
       p_s = &plugin_dir;
     }
-#endif
 
     if (p_s) {
       proxy->options(sql::mysql::MYSQL_PLUGIN_DIR, *p_s);

jdbc/driver/mysql_connection.h

@@ -39,6 +39,7 @@
 #if(_WIN32 && CONCPP_BUILD_SHARED)
 extern std::string driver_dll_path;
 #endif
+extern std::string default_plugin_dir;
 
 namespace sql
 {

jdbc/driver/mysql_driver.cpp

@@ -271,6 +271,19 @@ BOOL WINAPI DllMain(
   GetModuleFileNameA(hmodule, _driver_dll_path, sizeof(_driver_dll_path));
   driver_dll_path = _driver_dll_path;
   driver_dll_path = driver_dll_path.substr(0, driver_dll_path.find_last_of('\\') + 1);
+
+  /*
+    Note: For DLL in Windows we will try to set the plugin directory
+    based on driver_dll_path.
+  */
+
+  default_plugin_dir = driver_dll_path;
+#ifdef _DEBUG
+  // Debug dll is placed inside debug subdirectory
+  default_plugin_dir.append("..\\");
+#endif
+  default_plugin_dir.append("plugin");
+
   return true;
 }
 #endif

packaging/deb-in/CMakeLists.txt

@@ -100,14 +100,12 @@ IF (DEB_PRODUCT STREQUAL "commercial")
   SET (DEB_LICENSENAME "Commercial")
   SET (DEB_VERSION "+commercial-1")
   SET (DEB_SERVERPRODUCT "commercial")
-  SET (JDBC_RECOMMENDS_AND_SUGGESTS "Recommends: mysql-commercial-client-plugins")
 ELSE()
   SET (DEB_COPYRIGHT_UPSTREAMNAME "MySQL ${MYSQL_BASE_VERSION}")
   SET (DEB_PRODUCTNAME "")
   SET (DEB_LICENSENAME "GPL")
   SET (DEB_VERSION "-1")
   SET (DEB_SERVERPRODUCT "community")
-  SET (JDBC_RECOMMENDS_AND_SUGGESTS "Suggests: mysql-community-client-plugins")
 ENDIF()
 
 # All files are configured and copied to the debian/ directory, which is used
@@ -148,4 +146,3 @@ endforeach()
 EXECUTE_PROCESS(
   COMMAND chmod +x ${CMAKE_BINARY_DIR}/debian/rules
 )
-

packaging/deb-in/control.in

@@ -4,7 +4,7 @@ Section: database
 Priority: optional
 Standards-Version: 3.9.8
 Homepage: https://dev.mysql.com/doc/connector-cpp/en/
-Build-Depends: cmake, debhelper (>= 10), libboost-dev, libmysqlclient-dev, libssl-dev
+Build-Depends: cmake, debhelper (>= 10), libboost-dev, libmysqlclient-dev, libssl-dev, chrpath
 
 Package: libmysqlcppconnx@ABI_VERSION_MAJOR@
 Architecture: any
@@ -22,7 +22,7 @@ Section: libs
 Pre-Depends: ${misc:Pre-Depends}
 Multi-Arch: same
 Depends: ${shlibs:Depends}, ${misc:Depends}
-@JDBC_RECOMMENDS_AND_SUGGESTS@
+Suggests: libkrb5-3, libsasl2-2, libgssapi-krb5-2, libfido2-1, libssl3
 Description: MySQL Driver for C++ which mimics the JDBC 4.0 API
  This MySQL Driver for C++ mimics the JDBC 4.0 API.
 

packaging/deb-in/jdbc.install.in

@@ -23,6 +23,9 @@
 
 usr/lib/*/libmysqlcppconn.so.@JDBC_ABI_VERSION_MAJOR@*
 
+# Plugins
+usr/lib/*/mysql/libmysqlcppconn@JDBC_ABI_VERSION_MAJOR@/plugin/
+
 # Build info
 /usr/INFO_SRC /usr/share/doc/@PACKAGE_BASE_NAME@
 /usr/INFO_BIN /usr/share/doc/@PACKAGE_BASE_NAME@

packaging/deb-in/rules.in

@@ -31,6 +31,7 @@ export CFLAGS=
 export CXXFLAGS=
 
 export LIB_DIR = /usr/lib/$(DEB_HOST_MULTIARCH)
+export PLUGIN_DIR = $(LIB_DIR)/mysql/libmysqlcppconn@JDBC_ABI_VERSION_MAJOR@/plugin
 
 export CMAKE_OPTS= \
 		-DCMAKE_BUILD_TYPE=RelWithDebInfo \
@@ -39,7 +40,9 @@ export CMAKE_OPTS= \
 		-DINSTALL_DOC_DIR=./usr \
 		-DWITH_JDBC=ON \
 		-DMYSQLCLIENT_STATIC_LINKING=ON \
+		-DDEFAULT_PLUGIN_DIR=$(PLUGIN_DIR) \
 		-DWITH_SSL=system \
+		-DBUNDLE_DEPENDENCIES=ON \
 		@DEB_CMAKE_EXTRAS@
 
 override_dh_auto_configure:
@@ -84,11 +87,23 @@ override_dh_auto_install:
 	rm debian/tmp/mysql-concpp-config.cmake
 	rm debian/tmp/mysql-concpp-config-version.cmake
 
-	touch $@
+	install -d -m 0755 debian/tmp/.$(PLUGIN_DIR)
+	mv -v debian/tmp/.$(LIB_DIR)/plugin/* debian/tmp/.$(PLUGIN_DIR)/
+	# Note: Remove custom RPATH in plugins -- we want them to use OS-wide dependencies
+	chrpath --delete debian/tmp/.$(PLUGIN_DIR)/*
+	rm -rf debian/tmp/.$(LIB_DIR)/plugin
+	rm -rf debian/tmp/.$(LIB_DIR)/private
+	# touch $@
 
 override_dh_installinit:
 	@echo "RULES.$@"
 	touch $@
 
 override_dh_install:
 	dh_install --fail-missing
+
+
+# Note: Exclude plugins from calculating package dependencies
+
+override_dh_shlibdeps:
+	dh_shlibdeps -Xmysql_native_password -Xauthentication_

packaging/mysql-connector-c++.spec.in

@@ -57,6 +57,9 @@
 
 %global source_date_epoch_from_changelog 0
 
+%global lib_base_name  libmysqlcppconnx@ABI_VERSION_MAJOR@
+%global lib_base_name_jdbc libmysqlcppconn@JDBC_ABI_VERSION_MAJOR@
+
 ###############################################
 # Package specifications
 ###############################################
@@ -90,8 +93,9 @@ A C++ interface for communicating with MySQL servers.
 
 %package        jdbc
 Summary:        MySQL Driver for C++ which mimics the JDBC 4.0 API
-Provides:       libmysqlcppconn@JDBC_ABI_VERSION_MAJOR@ = %{version}-%{release}
-Obsoletes:      libmysqlcppconn@JDBC_ABI_VERSION_MAJOR@ < %{version}-%{release}
+Provides:       %{lib_base_name_jdbc} = %{version}-%{release}
+Suggests:       krb5-libs, cyrus-sasl-lib, libfido2
+Obsoletes:      %{lib_base_name_jdbc} < %{version}-%{release}
 Obsoletes:      mysql-connector-c++%{?product_suffix}-jdbc < %{version}-%{release}
 Obsoletes:      mysql-connector-c++-jdbc < %{version}-%{release}
 %description    jdbc
@@ -121,6 +125,8 @@ to develop MySQL client applications in C++.
 SRC=`pwd`
 cd ${RPM_BUILD_DIR}
 
+%global plugin_dir %{_libdir}/mysql/%{lib_base_name_jdbc}/plugin
+
 %{?gcc_toolset:source /opt/rh/%{gcc_toolset}/enable}
 
 %if 0%{?with_tests:1} && 0%{?with_gtest:1}
@@ -133,7 +139,7 @@ cd ${RPM_BUILD_DIR}
 # Note: use relative paths for CMAKE_INSTALL_XXX options
 
 %global __cmake_cmd cmake%{?el6:3}%{?el7:3}
-%global __cmake_common_opts -DCMAKE_BUILD_TYPE=RelWithDebInfo  -DCMAKE_INSTALL_LIBDIR=.%{_libdir} -DCMAKE_INSTALL_INCLUDEDIR=.%{_includedir}/mysql-cppconn -DWITH_SSL=system -DWITH_JDBC=1 -DMYSQLCLIENT_STATIC_LINKING=1 %{?mysql_opt} %{__cmake_test_opts} -DDEBUG_PREFIX_MAP=OFF
+%global __cmake_common_opts -DCMAKE_BUILD_TYPE=RelWithDebInfo  -DCMAKE_INSTALL_LIBDIR=.%{_libdir} -DCMAKE_INSTALL_INCLUDEDIR=.%{_includedir}/mysql-cppconn -DWITH_SSL=system -DDEFAULT_PLUGIN_DIR=%{plugin_dir} -DWITH_JDBC=1 -DMYSQLCLIENT_STATIC_LINKING=1 -DBUNDLE_DEPENDENCIES=1 %{?mysql_opt} %{__cmake_test_opts} -DDEBUG_PREFIX_MAP=OFF
 %global __cmake_config %{__cmake_cmd} %{__cmake_common_opts} %{__cmake_explicit_opts}
 
 rm -rf build-static && mkdir build-static
@@ -165,6 +171,11 @@ mkdir -p %{buildroot}%{_libdir}/cmake/mysql-concpp/
 install -D -m 0644 %{buildroot}/*.cmake %{buildroot}%{_libdir}/cmake/mysql-concpp/
 rm %{buildroot}/*.cmake
 
+# Bundled plugins
+mkdir -p %{buildroot}%{plugin_dir}
+mv -v %{buildroot}%{_libdir}/plugin/*  %{buildroot}%{plugin_dir}
+rm -rf %{buildroot}%{_libdir}/{plugin,private}
+
 
 %post -p /sbin/ldconfig
 
@@ -193,6 +204,7 @@ rm %{buildroot}/*.cmake
 %doc LICENSE.txt
 %doc README.txt ../build-dynamic/INFO_SRC ../build-dynamic/INFO_BIN
 %{_libdir}/libmysqlcppconn.so.@JDBC_ABI_VERSION_MAJOR@*
+%{plugin_dir}
 
 %files devel
 %doc LICENSE.txt
@@ -213,6 +225,9 @@ rm %{buildroot}/*.cmake
 
 %changelog
 
+* Fri Aug 09 2024 Rafal Somla <[email protected]> - 9.1.0-1
+- Bundle authentication plugins in the -jdbc package (WL#16458)
+
 * Thu Jul 11 2024 Rafal Somla <[email protected]> - 9.1.0-1
 - Fixed provides/obsoletes information
 - Updates to configure/build/install logic