New boolean connection option is introduced - OPT_ENABLE_CLEARTEXT_PLUGIN. It's purpose is to enable libmysql cleartext plugin that is required since versions 5.5.27 and 5.6.7. Client cleartext plugin is required for PAM authentication.

lawrin · lawrin · commit 2c9c1fc40762 · 2013-03-20T14:28:52.000+02:00
The patch contains the testcase for the new option.

In the mysql_connection.cpp there have been 3 arrays introduced to map connection option name to the sql::mysql::MySQL_Connection_Options enum member and function template that makes mysql_options calls using those arrays.
Options divided into 3 arrays to enforce their correct option type.
Also options method of the MySQL_NativeConnectionWrapper class(and in the interface it implements) has been overloaded to accept int, bool and SQLString values.
diff --git a/CHANGES b/CHANGES
@@ -22,6 +22,11 @@
   51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 */
 
+GA  1.1.3 - 
+- Added boolean connection option OPT_ENABLE_CLEARTEXT_PLUGIN allowing to
+  enable cleartext libmysql plugin. That plugin is required for some
+  authentication methods, e.g. PAM. (Bug#16520952)
+
 GA  1.1.2 - 2013-01-16
 - Expired password support. Connection options
   OPT_CAN_HANDLE_EXPIRED_PASSWORDS(bool, application can deal with expired
@@ -35,6 +40,9 @@ GA  1.1.2 - 2013-01-16
   CLIENT_MULTI_STATEMENTS connection option still has to be selected.
   getUpdateCount will return data for the last executed statement.
 
+- ABI change - MySQL_Connection class object size changed. If you don't use
+  that class directly you shouldn't be affected by that.
+
 - Built against libmysql 5.6.10
 
 GA  1.1.1 - 2012-08-06
diff --git a/driver/mysql_connection.cpp b/driver/mysql_connection.cpp
@@ -204,7 +204,7 @@ static const String2IntMap flagsOptions[]=
 /* {{{ readFlag(::sql::SQLString, int= 0) -I- */
 /** Check if connection option pointed by map iterator defines a connection
     flag */
-static bool read_flag(ConnectOptionsMap::const_iterator &cit, int &flags)
+static bool read_connection_flag(ConnectOptionsMap::const_iterator &cit, int &flags)
 {
 	const bool * value;
 
@@ -225,9 +225,55 @@ static bool read_flag(ConnectOptionsMap::const_iterator &cit, int &flags)
 	}
 	return false;
 }
-
 /* }}} */
 
+/* Array for mapping of boolean connection options to mysql_options call */
+static const String2IntMap booleanOptions[]= 
+	{
+		{"OPT_REPORT_DATA_TRUNCATION",	MYSQL_REPORT_DATA_TRUNCATION},
+		{"OPT_ENABLE_CLEARTEXT_PLUGIN",	MYSQL_ENABLE_CLEARTEXT_PLUGIN}
+	};
+/* Array for mapping of integer connection options to mysql_options call */
+static const String2IntMap intOptions[]= 
+	{
+		{"OPT_CONNECT_TIMEOUT",	MYSQL_OPT_CONNECT_TIMEOUT},
+		{"OPT_READ_TIMEOUT",	MYSQL_OPT_READ_TIMEOUT},
+		{"OPT_WRITE_TIMEOUT",	MYSQL_OPT_WRITE_TIMEOUT}
+	};
+/* Array for mapping of string connection options to mysql_options call */
+static const String2IntMap stringOptions[]= 
+	{
+		{"preInit",	MYSQL_INIT_COMMAND}
+	};
+
+template<class T>
+bool process_connection_option(ConnectOptionsMap::const_iterator &option,
+								const String2IntMap options_map[],
+								size_t map_size,
+								boost::shared_ptr< NativeAPI::NativeConnectionWrapper > &proxy)
+{
+	const T * value;
+
+	for (unsigned int i = 0; i < map_size; ++i) {
+
+		if (!option->first.compare(options_map[i].key)) {
+
+			if (!(value = boost::get<T>(&option->second))) {
+				sql::SQLString err("Option ");
+				err.append(option->first).append(" is not of expected type"); 
+				throw sql::InvalidArgumentException(err); 
+			}
+			proxy->options(static_cast<sql::mysql::MySQL_Connection_Options>(options_map[i].value),
+							*value);
+
+			return true;
+		}
+	}
+
+	return false;
+}
+
+
 /*
   We support :
   - hostName
@@ -262,9 +308,17 @@ static bool read_flag(ConnectOptionsMap::const_iterator &cit, int &flags)
   - OPT_RECONNECT
   - OPT_CHARSET_NAME
   - OPT_REPORT_DATA_TRUNCATION
+  - OPT_CAN_HANDLE_EXPIRED_PASSWORDS
+  - OPT_ENABLE_CLEARTEXT_PLUGIN
+  - preInit
+  - postInit
+
+  To add new connection option that maps to a myql_options call, only add its
+  mapping to sql::mysql::MySQL_Connection_Options value to one of arrays above
+  - booleanOptions, intOptions, stringOptions. You might need to add new member
+  to the sql::mysql::MySQL_Connection_Options enum
 */
 
-
 /* {{{ MySQL_Connection::init() -I- */
 void MySQL_Connection::init(ConnectOptionsMap & properties)
 {
@@ -305,6 +359,8 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 		}
 	}
 
+#define PROCESS_CONN_OPTION(option_type, options_map) process_connection_option< option_type >(it, options_map, sizeof(options_map)/sizeof(String2IntMap), proxy)
+
 	for (it = properties.begin(); it != properties.end(); ++it) {
 		if (!it->first.compare("userName")) {
 			if ((p_s = boost::get< sql::SQLString >(&it->second))) {
@@ -431,24 +487,6 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 			} else {
 				throw sql::InvalidArgumentException("No bool value passed for metadataUseInfoSchema");
 			}
-		}else if (!it->first.compare("OPT_CONNECT_TIMEOUT")) {
-			if (!(p_i = boost::get< int >(&it->second))) {
-				throw sql::InvalidArgumentException("No long long value passed for OPT_CONNECT_TIMEOUT");
-			}
-			long l_tmp = static_cast<long>(*p_i);
-			proxy->options(MYSQL_OPT_CONNECT_TIMEOUT, (const char *) &l_tmp);
-		} else if (!it->first.compare("OPT_READ_TIMEOUT")) {
-			if (!(p_i = boost::get< int >(&it->second))) {
-				throw sql::InvalidArgumentException("No long long value passed for OPT_READ_TIMEOUT");
-			}
-			long l_tmp = static_cast<long>(*p_i);
-			proxy->options(MYSQL_OPT_READ_TIMEOUT, (const char *) &l_tmp);
-		} else if (!it->first.compare("OPT_WRITE_TIMEOUT")) {
-			if (!(p_i = boost::get< int >(&it->second))) {
-				throw sql::InvalidArgumentException("No long long value passed for OPT_WRITE_TIMEOUT");
-			}
-			long l_tmp = static_cast<long>(*p_i);
-			proxy->options(MYSQL_OPT_WRITE_TIMEOUT, (const char *) &l_tmp);
 		} else if (!it->first.compare("OPT_RECONNECT")) {
 			if (!(p_b = boost::get<bool>(&it->second))) {
 				throw sql::InvalidArgumentException("No bool value passed for OPT_RECONNECT");
@@ -460,11 +498,6 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 				throw sql::InvalidArgumentException("No SQLString value passed for OPT_CHARSET_NAME");
 			}
 			defaultCharset = *p_s;
-		} else if (!it->first.compare("OPT_REPORT_DATA_TRUNCATION")) {
-			if (!(p_b = boost::get< bool >(&it->second))) {
-				throw sql::InvalidArgumentException("No bool value passed for OPT_REPORT_DATA_TRUNCATION");
-			}
-			proxy->options(MYSQL_REPORT_DATA_TRUNCATION, (const char *) p_b);
 		} else if (!it->first.compare("OPT_NAMED_PIPE")) {
 			/* Not sure it is really needed */
 			uri.setProtocol(NativeAPI::PROTOCOL_PIPE);
@@ -484,26 +517,36 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 				/* We do not care here about server version */
 				proxy->options(MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS, (const char*)p_b);
 			}
-
-		} else if (!it->first.compare("preInit")) {
-			if ((p_s = boost::get< sql::SQLString >(&it->second))) {
-				proxy->options(MYSQL_INIT_COMMAND, p_s->c_str());
-			} else {
-				throw sql::InvalidArgumentException("No string value passed for preInit");
-			}
-		}else if (!it->first.compare("postInit")) {
+		} else if (!it->first.compare("postInit")) {
 			if ((p_s = boost::get< sql::SQLString >(&it->second))) {
 				postInit= *p_s;
 			} else {
 				throw sql::InvalidArgumentException("No string value passed for postInit");
 			}
-		} else if (read_flag(it, flags)) {
+
+		/* If you need to add new integer connection option that should result in
+		   calling mysql_optiong - add its mapping to the intOptions array
+		 */
+		} else if (PROCESS_CONN_OPTION(int, intOptions)) {
+			// Nothing to do here
+
+		/* For boolean coonection option - add mapping to booleanOptions array */
+		} else if (PROCESS_CONN_OPTION(bool, booleanOptions)) {
+			// Nothing to do here
+
+		/* For string coonection option - add mapping to stringOptions array */
+		} else if (PROCESS_CONN_OPTION(sql::SQLString, stringOptions)) {
+			// Nothing to do here
+		} else if (read_connection_flag(it, flags)) {
 			// Nothing to do here
 		} else {
 			// TODO: Shouldn't we really create a warning here? as soon as we are able to
 			//       create a warning
 		}
-	}
+        
+	} /* End of cycle on connection options map */
+
+#undef PROCESS_CONNSTR_OPTION
 
 	/* libmysql shouldn't think it is too smart */
 	if (tcpProtocol(uri) && !uri.Host().compare(util::LOCALHOST)) {
@@ -561,13 +604,12 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 			&& client_doesnt_support_exp_pwd) {
 
 			native_error= deCL_CANT_HANDLE_EXP_PWD;
-			error_message= "Your password has expired. Your instance of"
+			error_message= "Your password has expired, but your instance of"
 				" Connector/C++ is not linked against mysql client library that"
-				" allows to change it. resetting of an expired password. To"
-				" resolve this, you either need to change the password with"
-				" mysql client that can do it or rebuild your instance of"
-				" Connector/C++ against mysql client library that supports"
-				" resetting of an expired password.";
+				" allows to reset it. To resolve this you either need to change"
+				" the password with mysql client that is capable to do that,"
+				" or rebuild your instance of Connector/C++ against mysql client"
+				" library that supports resetting of an expired password.";
 		} else {
 			error_message= proxy->error();
 		}
diff --git a/driver/nativeapi/mysql_native_connection_wrapper.cpp b/driver/nativeapi/mysql_native_connection_wrapper.cpp
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
 
 The MySQL Connector/C++ is licensed under the terms of the GPLv2
 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
@@ -215,6 +215,35 @@ MySQL_NativeConnectionWrapper::options(::sql::mysql::MySQL_Connection_Options op
 /* }}} */
 
 
+/* {{{ MySQL_NativeConnectionWrapper::options(SQLString &) */
+int
+MySQL_NativeConnectionWrapper::options(::sql::mysql::MySQL_Connection_Options option,
+									   const ::sql::SQLString &str)
+{
+	return api->options(mysql, static_cast< mysql_option >(option), str.c_str());
+}
+/* }}} */
+
+
+/* {{{ MySQL_NativeConnectionWrapper::options(bool &) */
+int
+MySQL_NativeConnectionWrapper::options(::sql::mysql::MySQL_Connection_Options option,
+									   const bool &option_val)
+{
+	my_bool dummy= option_val ? '\1' : '\0';
+	return api->options(mysql, static_cast< mysql_option >(option), &dummy);
+}
+
+
+/* {{{ MySQL_NativeConnectionWrapper::options(int &) */
+int
+MySQL_NativeConnectionWrapper::options(::sql::mysql::MySQL_Connection_Options option,
+									   const int &option_val)
+{
+	return api->options(mysql, static_cast< mysql_option >(option), &option_val);
+}
+
+
 /* {{{ MySQL_NativeConnectionWrapper::query() */
 int
 MySQL_NativeConnectionWrapper::query(const SQLString & stmt_str)
diff --git a/driver/nativeapi/mysql_native_connection_wrapper.h b/driver/nativeapi/mysql_native_connection_wrapper.h
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
 
 The MySQL Connector/C++ is licensed under the terms of the GPLv2
 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
@@ -102,6 +102,10 @@ class MySQL_NativeConnectionWrapper : public NativeConnectionWrapper
 	int next_result();
 
 	int options(::sql::mysql::MySQL_Connection_Options, const void * );
+	int options(::sql::mysql::MySQL_Connection_Options,
+				const ::sql::SQLString &);
+	int options(::sql::mysql::MySQL_Connection_Options, const bool &);
+	int options(::sql::mysql::MySQL_Connection_Options, const int &);
 
 	int query(const ::sql::SQLString &);
 
diff --git a/driver/nativeapi/native_connection_wrapper.h b/driver/nativeapi/native_connection_wrapper.h
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
 
 The MySQL Connector/C++ is licensed under the terms of the GPLv2
 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
@@ -98,6 +98,12 @@ class NativeConnectionWrapper : public boost::noncopyable
 	virtual int next_result() = 0;
 
 	virtual int options(::sql::mysql::MySQL_Connection_Options, const void *) = 0;
+	virtual int options(::sql::mysql::MySQL_Connection_Options,
+						const ::sql::SQLString &) = 0;
+	virtual int options(::sql::mysql::MySQL_Connection_Options,
+						const bool &) = 0;
+	virtual int options(::sql::mysql::MySQL_Connection_Options,
+						const int &) = 0;
 
 	virtual int query(const SQLString &) = 0;
 
diff --git a/test/unit/bugs/bugs.cpp b/test/unit/bugs/bugs.cpp
@@ -270,7 +270,8 @@ void bugs::expired_pwd()
   {
     stmt->executeUpdate("DROP USER ccpp_expired_pwd");
   }
-  catch (sql::SQLException &) {
+  catch (sql::SQLException &)
+  {
     // Catching exception if user did not exist
   }
 
diff --git a/test/unit/classes/connection.cpp b/test/unit/classes/connection.cpp
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved.
 
 The MySQL Connector/C++ is licensed under the terms of the GPLv2
 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
@@ -2169,5 +2169,78 @@ void connection::loadSameLibraryTwice()
 }
 #endif
 
+
+/* Test of the OPT_ENABLE_CLEARTEXT_PLUGIN connection of the text
+   The test idea - we try to create fake PAM authorized user and try to connect
+   using that user first without, and then with the new option selected. In
+   first case the error has to be that cleartext plugin could not be loaded, and
+   in second case the error has to be different */
+void connection::enableClearTextAuth()
+{
+  int serverVersion= getMySQLVersion(con);
+  if ( serverVersion < 55027 || serverVersion > 56000 && serverVersion < 56007)
+  {
+    SKIP("The server does not support tested functionality(cleartext plugin enabling)");
+  }
+
+  try
+  {
+    stmt->executeUpdate("DROP USER 't_ct_user'@'%'");
+  }
+  catch (sql::SQLException &)
+  {
+    // Catching exception if user did not exist
+  }
+
+  try
+  {
+    stmt->executeUpdate("GRANT ALL ON 't_ct_plugin' TO 't_ct_user' IDENTIFIED WITH "
+                        "'authentication_pam'");
+  }
+  catch (sql::SQLException &)
+  {
+    SKIP("The authentication_pam plugin not loaded");
+  }
+
+  sql::ConnectOptionsMap opts;
+  testsuite::Connection c2;
+
+  opts["userName"]= sql::SQLString("t_ct_user");
+  opts["password"]= sql::SQLString("foo");
+
+  /* 
+    Expecting error CR_AUTH_PLUGIN_CANNOT_LOAD_ERROR 
+    without option ENABLE_CLEARTEXT_PLUGIN
+  */
+  try
+  {
+    c2.reset(getConnection(&opts));
+  }
+  catch (sql::SQLException &e)
+  {
+    /* We should have dropped the created user here if assertion fails -
+       TODO: Add sort of dropSchemaObject for created users in tearDown */
+    ASSERT_EQUALS(2059, e.getErrorCode()/*CR_AUTH_PLUGIN_CANNOT_LOAD_ERROR*/);
+  }  
+
+  /* 
+    Expecting error other then CR_AUTH_PLUGIN_CANNOT_LOAD_ERROR 
+    as option ENABLE_CLEARTEXT_PLUGIN is used
+  */
+  opts["OPT_ENABLE_CLEARTEXT_PLUGIN"]= true;
+
+  try
+  {
+    c2.reset(getConnection(&opts));
+  }
+  catch (sql::SQLException &e)
+  {
+    ASSERT(e.getErrorCode() != 2059);
+  }
+
+  stmt->executeUpdate("DROP USER 't_ct_user'@'%'");
+}
+
+
 } /* namespace connection */
 } /* namespace testsuite */
diff --git a/test/unit/classes/connection.h b/test/unit/classes/connection.h
diff --git a/test/unit/unit_fixture.cpp b/test/unit/unit_fixture.cpp

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,8 @@ void bugs::expired_pwd()`
`270`	`270`	`{`
`271`	`271`	`stmt->executeUpdate("DROP USER ccpp_expired_pwd");`
`272`	`272`	`}`
`273`		`- catch (sql::SQLException &) {`
	`273`	`+ catch (sql::SQLException &)`
	`274`	`+ {`
`274`	`275`	`// Catching exception if user did not exist`
`275`	`276`	`}`
`276`	`277`