Implement caching_sha2_password support.

Drake103 · Drake103 · commit bde7eff1503d · 2017-10-03T23:31:50.000+03:00
diff --git a/.ci/config/config.buffer.json b/.ci/config/config.buffer.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;Use Affected Rows=true;BufferResultSets=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.compression+ssl.json b/.ci/config/config.compression+ssl.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=ssltest;password=test;port=3306;database=mysqltest;ssl mode=required;use compression=true;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV",
       "CertificatesPath": "../../../../../.ci/server/certs"
diff --git a/.ci/config/config.compression.json b/.ci/config/config.compression.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;UseCompression=true;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.json b/.ci/config/config.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/config/config.ssl.json b/.ci/config/config.ssl.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=127.0.0.1;user id=ssltest;password=test;port=3306;database=mysqltest;ssl mode=required;certificate file=../../../../../.ci/server/certs/ssl-client.pfx;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV",
       "CertificatesPath": "../../../../../.ci/server/certs"
diff --git a/.ci/config/config.uds+ssl.json b/.ci/config/config.uds+ssl.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=./../../../../../.ci/mysqld/mysqld.sock;user id=ssltest;password=test;database=mysqltest;ssl mode=required;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV",
       "CertificatesPath": "../../../../../.ci/server/certs"
diff --git a/.ci/config/config.uds.json b/.ci/config/config.uds.json
@@ -3,7 +3,7 @@
       "ConnectionString": "server=./../../../../../.ci/run/mysql/mysqld.sock;user id=mysqltest;password='test;key=\"val';database=mysqltest;ssl mode=none;Use Affected Rows=true",
       "PasswordlessUser": "no_password",
       "SecondaryDatabase": "testdb2",
-      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",
+      "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",
       "MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",
       "MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV"
     }
diff --git a/.ci/docker-run.sh b/.ci/docker-run.sh
@@ -49,6 +49,11 @@ for i in `seq 1 30`; do
 		if [ $? -ne 0 ]; then continue; fi
 	fi
 
+	if [[ $FEATURES == *"CachingSha2Password"* ]]; then
+		docker exec -it $NAME bash -c 'mysql -uroot -ptest < /etc/mysql/conf.d/init_caching_sha2.sql' >/dev/null 2>&1
+		if [ $? -ne 0 ]; then continue; fi
+	fi
+
 	# exit if successful
 	docker exec -it $NAME mysql -ussltest -ptest \
 		--ssl-mode=REQUIRED \
diff --git a/.ci/server/init_caching_sha2.sql b/.ci/server/init_caching_sha2.sql
@@ -0,0 +1,2 @@
+CREATE USER 'caching-sha2-user'@'%' IDENTIFIED WITH caching_sha2_password BY 'Cach!ng-Sh@2-Pa55';
+GRANT ALL PRIVILEGES ON *.* TO 'caching-sha2-user'@'%';
diff --git a/.travis.yml b/.travis.yml
@@ -8,13 +8,13 @@ env:
     FEATURES=StoredProcedures
   - IMAGE=mysql:5.7
     NAME=mysql
-    FEATURES=Json,StoredProcedures,Sha256Password,LargePackets
+    FEATURES=Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password
   - IMAGE=mysql:8.0
     NAME=mysql
-    FEATURES=Json,StoredProcedures,Sha256Password,LargePackets
+    FEATURES=Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password
   - IMAGE=percona:5.7
     NAME=percona
-    FEATURES=Json,StoredProcedures,Sha256Password,OpenSsl,LargePackets
+    FEATURES=Json,StoredProcedures,Sha256Password,OpenSsl,LargePackets,CachingSha2Password
   - IMAGE=mariadb:10.2
     NAME=mariadb
     FEATURES=StoredProcedures,OpenSsl,LargePackets
diff --git a/appveyor.yml b/appveyor.yml
@@ -7,6 +7,7 @@ before_test:
 - cmd: |-
     "C:\Program Files\MySQL\MySQL Server 5.7\bin\mysql.exe" -u root --password=Password12! < .ci\server\init.sql
     "C:\Program Files\MySQL\MySQL Server 5.7\bin\mysql.exe" -u root --password=Password12! < .ci\server\init_sha256.sql
+    "C:\Program Files\MySQL\MySQL Server 5.7\bin\mysql.exe" -u root --password=Password12! < .ci\server\init_caching_sha2.sql
 test_script:
 - ps: .\.ci\test.ps1
 after_test:
diff --git a/src/MySqlConnector/Serialization/AuthenticationUtility.cs b/src/MySqlConnector/Serialization/AuthenticationUtility.cs
@@ -1,4 +1,5 @@
-﻿using System;
+using System;
+using System.Linq;
 using System.Security.Cryptography;
 using System.Text;
 
@@ -39,5 +40,35 @@ public static byte[] HashPassword(byte[] challenge, int offset, string password)
 		}
 
 		static readonly byte[] s_emptyArray = new byte[0];
+
+		public static byte[] CreateScrambleResponse(byte[] nonce, string password)
+		{
+			var scrambleResponse = string.IsNullOrEmpty(password)
+				? s_emptyArray
+				: HashPasswordWithNonce(nonce, password);
+
+			return scrambleResponse;
+		}
+
+		private static byte[] HashPasswordWithNonce(byte[] nonce, string password)
+		{
+			using (var sha256 = SHA256.Create())
+			{
+				var passwordBytes = Encoding.UTF8.GetBytes(password);
+				var hashedPassword = sha256.ComputeHash(passwordBytes);
+
+				var doubleHashedPassword = sha256.ComputeHash(hashedPassword);
+				var combined = new byte[doubleHashedPassword.Length + nonce.Length];
+
+				Buffer.BlockCopy(doubleHashedPassword, 0, combined, 0, doubleHashedPassword.Length);
+				Buffer.BlockCopy(nonce, 0, combined, doubleHashedPassword.Length, nonce.Length);
+
+				var xorBytes = sha256.ComputeHash(combined);
+				for (int i = 0; i < hashedPassword.Length; i++)
+					hashedPassword[i] ^= xorBytes[i];
+
+				return hashedPassword;
+			}
+		}
 	}
 }
diff --git a/src/MySqlConnector/Serialization/CachingSha2ServerResponsePayload.cs b/src/MySqlConnector/Serialization/CachingSha2ServerResponsePayload.cs
@@ -0,0 +1,32 @@
+namespace MySql.Data.Serialization
+{
+	internal class CachingSha2ServerResponsePayload
+	{
+		public const byte Signature = 0x01;
+
+		public const byte SuccessSignature = 0x03;
+
+		public const byte FullAuthRequiredSignature = 0x04;
+
+		private CachingSha2ServerResponsePayload(bool succeeded, bool fullAuthRequired)
+		{
+			Succeeded = succeeded;
+			FullAuthRequired = fullAuthRequired;
+		}
+
+		public bool Succeeded { get; }
+
+		public bool FullAuthRequired { get; }
+
+		public static CachingSha2ServerResponsePayload Create(PayloadData payload)
+		{
+			var reader = new ByteArrayReader(payload.ArraySegment);
+			reader.ReadByte(Signature);
+			var secondByte = reader.ReadByte();
+
+			return new CachingSha2ServerResponsePayload(
+				secondByte == SuccessSignature,
+				secondByte == FullAuthRequiredSignature);
+		}
+	}
+}
diff --git a/src/MySqlConnector/Serialization/MySqlSession.cs b/src/MySqlConnector/Serialization/MySqlSession.cs
diff --git a/tests/SideBySide/AppConfig.cs b/tests/SideBySide/AppConfig.cs
diff --git a/tests/SideBySide/Attributes.cs b/tests/SideBySide/Attributes.cs
diff --git a/tests/SideBySide/ConnectAsync.cs b/tests/SideBySide/ConnectAsync.cs
diff --git a/tests/SideBySide/ServerFeatures.cs b/tests/SideBySide/ServerFeatures.cs

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"ConnectionString": "server=127.0.0.1;user id=mysqltest;password='test;key=\"val';port=3306;database=mysqltest;ssl mode=none;Use Affected Rows=true;BufferResultSets=true",`
`4`	`4`	`"PasswordlessUser": "no_password",`
`5`	`5`	`"SecondaryDatabase": "testdb2",`
`6`		`- "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",`
	`6`	`+ "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",`
`7`	`7`	`"MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",`
`8`	`8`	`"MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV"`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"ConnectionString": "server=./../../../../../.ci/run/mysql/mysqld.sock;user id=mysqltest;password='test;key=\"val';database=mysqltest;ssl mode=none;Use Affected Rows=true",`
`4`	`4`	`"PasswordlessUser": "no_password",`
`5`	`5`	`"SecondaryDatabase": "testdb2",`
`6`		`- "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets",`
	`6`	`+ "SupportedFeatures": "Json,StoredProcedures,Sha256Password,LargePackets,CachingSha2Password",`
`7`	`7`	`"MySqlBulkLoaderLocalCsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.CSV",`
`8`	`8`	`"MySqlBulkLoaderLocalTsvFile": "../../../../TestData/LoadData_UTF8_BOM_Unix.TSV"`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+CREATE USER 'caching-sha2-user'@'%' IDENTIFIED WITH caching_sha2_password BY 'Cach!ng-Sh@2-Pa55';`
	`2`	`+GRANT ALL PRIVILEGES ON . TO 'caching-sha2-user'@'%';`