Merge pull request vitessio#2717 from alainjobart/dialog

Refactoring dialog plugin code a bit.

Author: alainjobart

go/mysqlconn/auth_server.go

@@ -125,6 +125,30 @@ func scramblePassword(salt, password []byte) []byte {
 	return scramble
 }
 
+// Constants for the dialog plugin.
+const (
+	mysqlDialogMessage = "Enter password: "
+
+	// Dialog plugin is similar to clear text, but can respond to multiple
+	// prompts in a row. This is not yet implemented.
+	// Follow questions should be prepended with a `cmd` byte:
+	// 0x02 - ordinary question
+	// 0x03 - last question
+	// 0x04 - password question
+	// 0x05 - last password
+	mysqlDialogAskPassword = 0x04
+)
+
+// authServerDialogSwitchData is a helper method to return the data
+// needed in the AuthSwitchRequest packet for the dialog plugin
+// to ask for a password.
+func authServerDialogSwitchData() []byte {
+	result := make([]byte, len(mysqlDialogMessage)+2)
+	result[0] = mysqlDialogAskPassword
+	writeNullString(result, 1, mysqlDialogMessage)
+	return result
+}
+
 // AuthServerReadPacketString is a helper method to read a packet
 // as a null terminated string. It is used by the mysql_clear_password
 // and dialog plugins.
@@ -151,13 +175,6 @@ func AuthServerNegotiateClearOrDialog(c *Conn, method string) (string, error) {
 		return AuthServerReadPacketString(c)
 
 	case MysqlDialog:
-		// Dialog plugin is similar to clear text, but can respond to multiple
-		// prompts in a row. This is not yet implemented.
-		// Follow questions should be prepended with a `cmd` byte:
-		// 0x02 - ordinary question
-		// 0x03 - last question
-		// 0x04 - password question
-		// 0x05 - last password
 		return AuthServerReadPacketString(c)
 
 	default:

go/mysqlconn/constants.go

@@ -22,8 +22,7 @@ const (
 
 	// MysqlDialog uses the dialog plugin on the client side.
 	// It transmits data in the clear.
-	MysqlDialog        = "dialog"
-	MysqlDialogMessage = "Enter password: "
+	MysqlDialog = "dialog"
 )
 
 // Capability flags.
@@ -137,8 +136,6 @@ const (
 	// ComQuery is COM_QUERY.
 	ComQuery = 0x03
 
-	AskPassword = 0x04
-
 	// ComPing is COM_PING.
 	ComPing = 0x0e
 

go/mysqlconn/server.go

@@ -206,14 +206,11 @@ func (l *Listener) handle(conn net.Conn, connectionID uint32) {
 		}
 
 		// Switch our auth method to what the server wants.
-		// Dialog plugin expects an AskPassword prompt
+		// Dialog plugin expects an AskPassword prompt.
 		var data []byte
 		if authServerMethod == MysqlDialog {
-			data = make([]byte, len(MysqlDialogMessage)+2)
-			data[0] = AskPassword
-			writeNullString(data, 1, MysqlDialogMessage)
+			data = authServerDialogSwitchData()
 		}
-
 		if err := c.writeAuthSwitchRequest(authServerMethod, data); err != nil {
 			log.Errorf("Error write auth switch packet for client %v: %v", c.ConnectionID, err)
 			return

go/mysqlconn/server_test.go

@@ -262,7 +262,8 @@ func TestServer(t *testing.T) {
 	//	time.Sleep(60 * time.Minute)
 }
 
-// TestClearTextServer creates a Server that needs clear text passwords from the client.
+// TestClearTextServer creates a Server that needs clear text
+// passwords from the client.
 func TestClearTextServer(t *testing.T) {
 	// If the database we're using is MariaDB, the client
 	// is also the MariaDB client, that does support
@@ -355,6 +356,52 @@ func TestClearTextServer(t *testing.T) {
 	}
 }
 
+// TestDialogServer creates a Server that uses the dialog plugin on the client.
+func TestDialogServer(t *testing.T) {
+	th := &testHandler{}
+
+	authServer := NewAuthServerStatic()
+	authServer.Entries["user1"] = &AuthServerStaticEntry{
+		Password: "password1",
+		UserData: "userData1",
+	}
+	authServer.Method = MysqlDialog
+	l, err := NewListener("tcp", ":0", authServer, th)
+	if err != nil {
+		t.Fatalf("NewListener failed: %v", err)
+	}
+	l.AllowClearTextWithoutTLS = true
+	defer l.Close()
+	go func() {
+		l.Accept()
+	}()
+
+	host := l.Addr().(*net.TCPAddr).IP.String()
+	port := l.Addr().(*net.TCPAddr).Port
+
+	// Setup the right parameters.
+	params := &sqldb.ConnParams{
+		Host:  host,
+		Port:  port,
+		Uname: "user1",
+		Pass:  "password1",
+	}
+	sql := "select rows"
+	output, ok := runMysql(t, params, sql)
+	if strings.Contains(output, "No such file or directory") {
+		t.Logf("skipping dialog plugin tests, as the dialog plugin cannot be loaded: %v", err)
+		return
+	}
+	if !ok {
+		t.Fatalf("mysql failed: %v", output)
+	}
+	if !strings.Contains(output, "nice name") ||
+		!strings.Contains(output, "nicer name") ||
+		!strings.Contains(output, "2 rows in set") {
+		t.Errorf("Unexpected output for 'select rows': %v", output)
+	}
+}
+
 // TestTLSServer creates a Server with TLS support, then uses mysql
 // client to connect to it.
 func TestTLSServer(t *testing.T) {